C# Class FSO.Client.Network.UIPacketHandlers

Contains all the packethandlers in the game that are based on an interaction with the UI. I.E. a packet received because the user clicked on a UINetworkButton that sent a packet.

Show file Open project: RHY3756547/FreeSO Class Usage Examples

Public Methods

Method	Description
OnCharacterCreationProgress ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : CharacterCreationStatus	Received CharacterCreation packet from LoginServer.
OnCharacterCreationStatus ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : CharacterCreationStatus	Received CharacterCreation packet from CityServer.
OnCharacterInfoResponse ( GonzoNet.ProcessedPacket Packet, NetworkClient Client ) : void	LoginServer sent information about the player's characters.
OnCharacterRetirement ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : string	Received from the LoginServer in response to a RETIRE_CHARACTER packet.
OnCityInfoResponse ( GonzoNet.ProcessedPacket Packet ) : void
OnCityServerOffline ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : void	A city server went offline!
OnCityToken ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : void	Received from the LoginServer in response to a CITY_TOKEN_REQUEST packet.
OnCityTokenResponse ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : CityTransferStatus	Received from the CityServer in response to a CITY_TOKEN packet.
OnInvalidVersionResponse ( NetworkClient &Client, GonzoNet.ProcessedPacket Packet ) : void
OnLoginFailResponse ( NetworkClient &Client, GonzoNet.ProcessedPacket Packet ) : void	Occurs when the client was not authenticated by the loginserver. Called by UILoginDialog.cs.
OnLoginNotify ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : void	Occurs when the client has been sucessfully authenticated by the loginserver. Called by UILoginDialog.cs.
OnLoginNotifyCity ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : void	Received initial packet from CityServer.
OnLoginSuccessResponse ( NetworkClient &Client, ProcessedPacket Packet ) : void
OnLotCostResponse ( NetworkClient Client, ProcessedPacket Packet ) : LotTileEntry
OnLotPurchaseFailed ( NetworkClient Client, ProcessedPacket Packet ) : void
OnLotPurchaseSuccessful ( NetworkClient Client, ProcessedPacket Packet ) : int	Lot purchase was successful.
OnNewCityServer ( NetworkClient Client, ProcessedPacket Packet ) : void	New city server came online!
OnNewTimeOfDay ( NetworkClient Client, ProcessedPacket Packet ) : DateTime
OnPlayerJoinedSession ( NetworkClient Client, ProcessedPacket Packet ) : LotTileEntry	A player joined a session (game) in progress.
OnPlayerLeftSession ( NetworkClient Client, ProcessedPacket Packet ) : void	A player left a session (game) in progress.
OnPlayerReceivedLetter ( NetworkClient Client, ProcessedPacket Packet ) : void	Received a letter from another player in a session.
OnVMPacket ( NetworkClient Client, ProcessedPacket Packet ) : void	Reroute to a VM, eventually these will be ID'd

Method Details

OnCharacterCreationProgress() public static method

Received CharacterCreation packet from LoginServer.

public static OnCharacterCreationProgress ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : CharacterCreationStatus
Client	GonzoNet.NetworkClient
Packet	GonzoNet.ProcessedPacket
return	CharacterCreationStatus

OnCharacterCreationStatus() public static method

Received CharacterCreation packet from CityServer.

public static OnCharacterCreationStatus ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : CharacterCreationStatus
Client	GonzoNet.NetworkClient
Packet	GonzoNet.ProcessedPacket
return	CharacterCreationStatus

OnCharacterInfoResponse() public static method

LoginServer sent information about the player's characters.

public static OnCharacterInfoResponse ( GonzoNet.ProcessedPacket Packet, NetworkClient Client ) : void
Packet	GonzoNet.ProcessedPacket	The packet that was received.
Client	GonzoNet.NetworkClient
return	void

OnCharacterRetirement() public static method

Received from the LoginServer in response to a RETIRE_CHARACTER packet.

public static OnCharacterRetirement ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : string
Client	GonzoNet.NetworkClient
Packet	GonzoNet.ProcessedPacket
return	string

OnCityInfoResponse() public static method

public static OnCityInfoResponse ( GonzoNet.ProcessedPacket Packet ) : void
Packet	GonzoNet.ProcessedPacket
return	void

OnCityServerOffline() public static method

A city server went offline!

public static OnCityServerOffline ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : void
Client	GonzoNet.NetworkClient
Packet	GonzoNet.ProcessedPacket
return	void

OnCityToken() public static method

Received from the LoginServer in response to a CITY_TOKEN_REQUEST packet.

public static OnCityToken ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : void
Client	GonzoNet.NetworkClient
Packet	GonzoNet.ProcessedPacket
return	void

OnCityTokenResponse() public static method

Received from the CityServer in response to a CITY_TOKEN packet.

public static OnCityTokenResponse ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : CityTransferStatus
Client	GonzoNet.NetworkClient
Packet	GonzoNet.ProcessedPacket
return	CityTransferStatus

OnInvalidVersionResponse() public static method

public static OnInvalidVersionResponse ( NetworkClient &Client, GonzoNet.ProcessedPacket Packet ) : void
Client	GonzoNet.NetworkClient
Packet	GonzoNet.ProcessedPacket
return	void

OnLoginFailResponse() public static method

Occurs when the client was not authenticated by the loginserver. Called by UILoginDialog.cs.

public static OnLoginFailResponse ( NetworkClient &Client, GonzoNet.ProcessedPacket Packet ) : void
Client	GonzoNet.NetworkClient	The client that received the packet.
Packet	GonzoNet.ProcessedPacket	The packet that was received.
return	void

OnLoginNotify() public static method

Occurs when the client has been sucessfully authenticated by the loginserver. Called by UILoginDialog.cs.

public static OnLoginNotify ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : void
Client	GonzoNet.NetworkClient	The client that received the packet.
Packet	GonzoNet.ProcessedPacket	The packet that was received.
return	void

OnLoginNotifyCity() public static method

Received initial packet from CityServer.

public static OnLoginNotifyCity ( NetworkClient Client, GonzoNet.ProcessedPacket Packet ) : void
Client	GonzoNet.NetworkClient
Packet	GonzoNet.ProcessedPacket
return	void

OnLoginSuccessResponse() public static method

public static OnLoginSuccessResponse ( NetworkClient &Client, ProcessedPacket Packet ) : void
Client	NetworkClient
Packet	ProcessedPacket
return	void

OnLotCostResponse() public static method

public static OnLotCostResponse ( NetworkClient Client, ProcessedPacket Packet ) : LotTileEntry
Client	NetworkClient
Packet	ProcessedPacket
return	LotTileEntry

OnLotPurchaseFailed() public static method

public static OnLotPurchaseFailed ( NetworkClient Client, ProcessedPacket Packet ) : void
Client	NetworkClient
Packet	ProcessedPacket
return	void

OnLotPurchaseSuccessful() public static method

Lot purchase was successful.

public static OnLotPurchaseSuccessful ( NetworkClient Client, ProcessedPacket Packet ) : int
Client	NetworkClient
Packet	ProcessedPacket
return	int

OnNewCityServer() public static method

New city server came online!

public static OnNewCityServer ( NetworkClient Client, ProcessedPacket Packet ) : void
Client	NetworkClient
Packet	ProcessedPacket
return	void

OnNewTimeOfDay() public static method

public static OnNewTimeOfDay ( NetworkClient Client, ProcessedPacket Packet ) : DateTime
Client	NetworkClient
Packet	ProcessedPacket
return	DateTime

OnPlayerJoinedSession() public static method

A player joined a session (game) in progress.

public static OnPlayerJoinedSession ( NetworkClient Client, ProcessedPacket Packet ) : LotTileEntry
Client	NetworkClient
Packet	ProcessedPacket
return	LotTileEntry

OnPlayerLeftSession() public static method

A player left a session (game) in progress.

public static OnPlayerLeftSession ( NetworkClient Client, ProcessedPacket Packet ) : void
Client	NetworkClient
Packet	ProcessedPacket
return	void

OnPlayerReceivedLetter() public static method

Received a letter from another player in a session.

public static OnPlayerReceivedLetter ( NetworkClient Client, ProcessedPacket Packet ) : void
Client	NetworkClient
Packet	ProcessedPacket
return	void

OnVMPacket() public static method

Reroute to a VM, eventually these will be ID'd

public static OnVMPacket ( NetworkClient Client, ProcessedPacket Packet ) : void
Client	NetworkClient
Packet	ProcessedPacket
return	void