res://addons/w4gd/game_server/agones_client.gd
Inherits: RefCounted
A client for the Agones API.
Description
This is primarily used internally. The most common interactions with Agones will be handled automatically by calling methods on res://addons/w4gd/game_server/game_server_sdk.gd. However, this can be used directly for advanced use-cases that aren't exposed there.
Methods
allocate ( ) |
|
alpha_is_player_connected ( String player_id ) |
|
alpha_player_connect ( String player_id ) |
|
alpha_player_disconnect ( String player_id ) |
|
alpha_set_player_capacity ( int count ) |
|
get_game_server ( ) |
|
health ( ) |
|
ready ( ) |
|
reserve ( int seconds ) |
|
set_annotation ( String key, String value ) |
|
set_label ( String key, String value ) |
|
shutdown ( ) |
|
Method Descriptions
res://addons/w4gd/game_server/agones_client.gd:Result allocate ( )
Manually marks this game server as "Allocated". Usually, Agones will mark game servers as "Allocated", but this allows for workflows where the dedicated server will mark itself as "Allocated".
res://addons/w4gd/game_server/agones_client.gd:Result alpha_get_connected_players ( )
Gets list of connected players as stored in Agones. This function is considered Alpha within the Agones SDK, and so come with a number of caveats as described here: https://agones.dev/site/docs/guides/feature-stages/#alpha
res://addons/w4gd/game_server/agones_client.gd:Result alpha_get_player_capacity ( )
Gets the player capacity for this game server as stored in Agones. This function is considered Alpha within the Agones SDK, and so come with a number of caveats as described here: https://agones.dev/site/docs/guides/feature-stages/#alpha
res://addons/w4gd/game_server/agones_client.gd:Result alpha_get_player_count ( )
Gets the player count for this game server as tracked in Agones. This function is considered Alpha within the Agones SDK, and so come with a number of caveats as described here: https://agones.dev/site/docs/guides/feature-stages/#alpha
res://addons/w4gd/game_server/agones_client.gd:Result alpha_is_player_connected ( String player_id )
Checks if the given player is connected per Agones. This function is considered Alpha within the Agones SDK, and so come with a number of caveats as described here: https://agones.dev/site/docs/guides/feature-stages/#alpha
res://addons/w4gd/game_server/agones_client.gd:Result alpha_player_connect ( String player_id )
Tells Agones that the given player has connected. This function is considered Alpha within the Agones SDK, and so come with a number of caveats as described here: https://agones.dev/site/docs/guides/feature-stages/#alpha
res://addons/w4gd/game_server/agones_client.gd:Result alpha_player_disconnect ( String player_id )
Tells Agones that the given player has disconnected. This function is considered Alpha within the Agones SDK, and so come with a number of caveats as described here: https://agones.dev/site/docs/guides/feature-stages/#alpha
res://addons/w4gd/game_server/agones_client.gd:Result alpha_set_player_capacity ( int count )
Changes the player capacity for this game server as stored in Agones. This function is considered Alpha within the Agones SDK, and so come with a number of caveats as described here: https://agones.dev/site/docs/guides/feature-stages/#alpha
res://addons/w4gd/game_server/agones_client.gd:Result get_game_server ( )
Gets the Agones configuration for this game server.
res://addons/w4gd/game_server/agones_client.gd:Result health ( )
Sends a "heartbeat" to Agones to declare that this game server is healthy.
res://addons/w4gd/game_server/agones_client.gd:Result ready ( )
Lets Agones know that this game server is ready to accept connections.
res://addons/w4gd/game_server/agones_client.gd:Result reserve ( int seconds )
Moves the game server into a "Reserved" state for the given number of seconds.
res://addons/w4gd/game_server/agones_client.gd:Result set_annotation ( String key, String value )
Sets an annotation on the Agones configuration for this game server.
res://addons/w4gd/game_server/agones_client.gd:Result set_label ( String key, String value )
Sets a label on the Agones configuration for this game server.
res://addons/w4gd/game_server/agones_client.gd:Result shutdown ( )
Requests that Agones shutdown this game server.
res://addons/w4gd/game_server/agones_client.gd:Watcher watch_game_server ( )
Creates a watcher to receive realtime updates to the Agones configuration for this game server.