Planeshift
psGUITargetUpdateMessage Class Reference

GUI Target Update This class is used to notify the client that data it is showing in the GUI target window has changed serverside, and should be refreshed. More...

#include <messages.h>

Public Member Functions

 PSF_DECLARE_MSG_FACTORY ()
 
 psGUITargetUpdateMessage (uint32_t clientNum, EID targetID)
 Constucts a new GUI Target Update message to go on the network. More...
 
 psGUITargetUpdateMessage (MsgEntry *message)
 
virtual csString ToString (NetBase::AccessPointers *accessPointers)
 Converts the message into human readable string. More...
 
- Public Member Functions inherited from psMessageCracker
void FireEvent ()
 Publishes the message to the local program. More...
 
virtual csString GetMessageTypeName () const =0
 Gets the name of the message type. More...
 
void Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
 Multicasts the message to all current connections. More...
 
 psMessageCracker ()
 
void SendMessage ()
 Sends the message to the client/server. More...
 
virtual ~psMessageCracker ()
 

Public Attributes

uint32_t clientNum
 
EID targetID
 
- Public Attributes inherited from psMessageCracker
int filterNumber
 
csRef< MsgEntrymsg
 
bool valid
 

Additional Inherited Members

- Static Public Attributes inherited from psMessageCracker
static MsgHandlermsghandler
 

Detailed Description

GUI Target Update This class is used to notify the client that data it is showing in the GUI target window has changed serverside, and should be refreshed.

Definition at line 2554 of file messages.h.

Constructor & Destructor Documentation

psGUITargetUpdateMessage::psGUITargetUpdateMessage ( uint32_t  clientNum,
EID  targetID 
)

Constucts a new GUI Target Update message to go on the network.

This will build any of the GUI target update messages.

Parameters
clientNumClient destination.
targetIDName of the new target to display.
psGUITargetUpdateMessage::psGUITargetUpdateMessage ( MsgEntry message)

Member Function Documentation

psGUITargetUpdateMessage::PSF_DECLARE_MSG_FACTORY ( )
virtual csString psGUITargetUpdateMessage::ToString ( NetBase::AccessPointers accessPointers)
virtual

Converts the message into human readable string.

Parameters
accessPointersA struct to a number of access pointers.
Returns
Return a human readable string for the message.

Implements psMessageCracker.

Member Data Documentation

uint32_t psGUITargetUpdateMessage::clientNum

Definition at line 2578 of file messages.h.

EID psGUITargetUpdateMessage::targetID

Definition at line 2579 of file messages.h.


The documentation for this class was generated from the following file: