C# Class ACR_ServerCommunicator.GUIResynchronizer

This object manages GUI element resynchronization for players that enter the server from a server to server portal.

Show file Open project: ALandFarAway/ALFA-Base-Resources

Public Methods

Method	Description
HandleGUIResync ( int SourceServerId, string ResyncCommand, ACR_ServerCommunicator Script ) : int	This method is called when a cross-server chat select resynchronization request is received. Its purpose is to scan the player list to check whether the argument player is online, and to activate chat select GUI resynchronization if appropriate, else to queue the resynchronization until the player does log in.
OnClientEnter ( uint PCObject, ACR_ServerCommunicator Script ) : void	This method is called when the ClientEnter event fires for a player. Its purpose is to check whether the player has a pending resync request, and, if so, to execute the resync operation.
SendGUIStateToServer ( PlayerState State, GameServer Server, ACR_ServerCommunicator Script ) : void	This method is called when a portal transition has been committed to send a player to a remote server.

Private Methods

Method	Description
ResynchronizePlayerState ( ResyncState ResyncInfo, uint PCObject, ACR_ServerCommunicator Script, int Tries ) : void	This method is called to resynchronize the GUI state of a player that executed a server to server portal, if the player is in an area.

Method Details

HandleGUIResync() public static method

This method is called when a cross-server chat select resynchronization request is received. Its purpose is to scan the player list to check whether the argument player is online, and to activate chat select GUI resynchronization if appropriate, else to queue the resynchronization until the player does log in.

public static HandleGUIResync ( int SourceServerId, string ResyncCommand, ACR_ServerCommunicator Script ) : int
SourceServerId	int	Supplies the server id of the server /// that requested the GUI resynchronization.
ResyncCommand	string	Supplies the GUI resynchronizer command /// line as generated by SendGUIStateToServer().
Script	ACR_ServerCommunicator	Supplies the current script object.
return	int

OnClientEnter() public static method

This method is called when the ClientEnter event fires for a player. Its purpose is to check whether the player has a pending resync request, and, if so, to execute the resync operation.

public static OnClientEnter ( uint PCObject, ACR_ServerCommunicator Script ) : void
PCObject	uint
Script	ACR_ServerCommunicator	Supplies the script object.
return	void

SendGUIStateToServer() public static method

This method is called when a portal transition has been committed to send a player to a remote server.

public static SendGUIStateToServer ( PlayerState State, GameServer Server, ACR_ServerCommunicator Script ) : void
State	PlayerState	Supplies the local state for the player that is /// committed to a portal transition. ///
Server	GameServer	Supplies the destination server for the portal /// event.
Script	ACR_ServerCommunicator	Supplies the script object.
return	void