JamClient
Inherits: CanvasLayer < Node < Object
A CanvasLayer that provides client-specific multiplayer capabilities as the child of a JamConnect Node
Properties
|
||
|
||
|
||
|
||
|
||
Methods
void |
_init ( ) |
void |
_ready ( ) |
void |
_setup_test_gjwt ( ) |
void |
|
persist_gjwt ( ) |
|
void |
client_start ( ) |
void |
client_session_request ( String host, int port, String token ) |
void |
leave_game ( ) |
void |
|
void |
|
void |
_on_client_authenticating ( int peer_id ) |
void |
_on_auth ( int peer_id, PackedByteArray _data ) |
void |
|
void |
|
void |
|
void |
_on_player_joined ( int peer_id, String username ) |
void |
_on_player_left ( int peer_id, String _username ) |
Signals
fetching_test_gjwt ( bool busy )
There is currently no description for this signal. Please help us by contributing one!
Property Descriptions
JamClientUI client_ui
The client UI used to configure and initiate sessions
String current_client_token
The client token for the active session. The token is used to verify identity with the server.
Dictionary peer_usernames = {}
A dictionary mapping peer id ints to username Strings
int test_client_number = 1
void @test_client_number_setter ( int value )
There is currently no description for this property. Please help us by contributing one!
String session_id = ""
There is currently no description for this property. Please help us by contributing one!
bool gjwt_fetch_busy = false
void @gjwt_fetch_busy_setter ( bool value )
There is currently no description for this property. Please help us by contributing one!
JamJwt jwt = new()
The Game JWT for this client - used to authenticate with the Jam Launch API
JamClientApi api
Interface for calling the Jam Launch session API
ClientKeys keys
Helper object for acquiring a Game JWT for authentication
JamConnect _jc
JamConnect @_jc_getter ( )
There is currently no description for this property. Please help us by contributing one!
Method Descriptions
void _init ( )
There is currently no description for this method. Please help us by contributing one!
void _ready ( )
There is currently no description for this method. Please help us by contributing one!
void _setup_test_gjwt ( )
There is currently no description for this method. Please help us by contributing one!
void set_gjwt ( String gjwt )
There is currently no description for this method. Please help us by contributing one!
bool persist_gjwt ( )
Persists the GJWT so that it can be retrieved in the next run
void client_start ( )
Configures and starts client functionality
void client_session_request ( String host, int port, String token )
Initiates a connection to a provisioned server
void leave_game ( )
Elegantly leaves the game by disconnecting from the server and notifying the Jam Launch API
void _on_client_connect_fail ( )
There is currently no description for this method. Please help us by contributing one!
void _on_client_authentication_failed ( )
There is currently no description for this method. Please help us by contributing one!
void _on_client_authenticating ( int peer_id )
There is currently no description for this method. Please help us by contributing one!
void _on_auth ( int peer_id, PackedByteArray _data )
There is currently no description for this method. Please help us by contributing one!
void _on_client_connect ( )
There is currently no description for this method. Please help us by contributing one!
void _on_server_disconnect ( )
There is currently no description for this method. Please help us by contributing one!
void _on_game_init_finalized ( )
There is currently no description for this method. Please help us by contributing one!
void _on_player_joined ( int peer_id, String username )
There is currently no description for this method. Please help us by contributing one!
void _on_player_left ( int peer_id, String _username )
There is currently no description for this method. Please help us by contributing one!