game / pragma.multiplayer / MultiplayerService /
MultiplayerService #
internal class MultiplayerService(pragmaNode: PragmaNode, instanceId: <ERROR CLASS>, partyClient: PartyClient = PartyClient(), routingCache: MultiplayerCache = MultiplayerCache()) : DistributedService, ConfigHandler<MultiplayerConfig>
The MultiplayerService is intended to handle the routing mismatch between players and their various multiplayer states.
Underlying systems like PartyService have their endpoints routed based on their entity id (in this case PartyId). Player clients may lose track of their entity ids due to disconnect or desyncing, making it difficult to rely on the client as a source of truth.
This service is responsible for caching and receiving cache updates on various multiplayer states, so it can provide a consistent routing mechanism and act as the source of truth for the client.
Constructors #
MultiplayerService | fun MultiplayerService(pragmaNode: PragmaNode, instanceId: <ERROR CLASS>, partyClient: PartyClient = PartyClient(), routingCache: MultiplayerCache = MultiplayerCache()) |
Functions #
Name | Summary |
---|---|
Retrieves latest party state. Used to synchronize the client to the platform. | |
Leaves a party, via a service to service call. | |
Removes the cached party id for a given player. | |
Retrieves latest party state. Used to synchronize the client to the platform. | |
Adds or modifies the cached routing value for a given player. |