player
Adds a player with a specific unique identifier to the player list of this instance. This will increase the active player count and add the identifier to the Kubernetes resource eventually. The player will be guaranteed to be part of the player list of this instance, unless this instance is already full. The returned value is guaranteed to match the value set within the SDK, even if the value was not yet synchronized with the Kubernetes resource.
If the capacity of this instance has already been reached and the player cannot be added to the player list because of this reason, an internal exception will be thrown and no result will be returned for this method.
The specific player tracking APIs of the AgonesSdk will eventually be superseded by the arbitrary Counts and Lists that cover a broader use-case and offer similar interfaces for tracking.
Return
Whether this player was previously missing from the player list of this instance and the capacity has not yet been reached and whether the player could therefore be successfully added to the list.
Parameters
The unique identifier of the player that should be added to the player list of this instance.
See also
Throws
If null is supplied as the player identifier and therefore no player can be derived from it.