C# Class ACR_ServerCommunicator.PlayerState

This object maintains extended state internal to the server communicator with respect to a player. It maintains data that is local to this server instance; the data is created at client enter, and removed at client leave. N.B. This state is intended for use by script code on the main thread.

Show file Open project: ALandFarAway/ALFA-Base-Resources Class Usage Examples

Public Methods

Method	Description
PlayerState ( uint ObjectId, ACR_ServerCommunicator Communicator ) : System	Construct a new PlayerState object.
UpdateChatSelectGUIHeaders ( ) : void	This method updates the chat select GUI headers if the player had the GUI active. It is called after the count of players displayed has changed. N.B. This routine is assumed to be called in-thread-context on the main thread.

Private Methods

Method	Description
UpgradeLegacySettings ( ) : void	Convert legacy database settings to their new format.

Method Details

PlayerState() public method

Construct a new PlayerState object.

public PlayerState ( uint ObjectId, ACR_ServerCommunicator Communicator ) : System
ObjectId	uint	Supplies the NWScript object id of the PC /// object.
Communicator	ACR_ServerCommunicator	Supplies the server communicator /// instance that the PlayerState object is bound to.
return	System

UpdateChatSelectGUIHeaders() public method

This method updates the chat select GUI headers if the player had the GUI active. It is called after the count of players displayed has changed. N.B. This routine is assumed to be called in-thread-context on the main thread.

public UpdateChatSelectGUIHeaders ( ) : void
return	void