Handle Location changes from server to superclient. More...
#include <npcmessages.h>
Public Types | |
| enum | Command { LOCATION_ADJUSTED, LOCATION_CREATED, LOCATION_DELETED, LOCATION_INSERTED, LOCATION_RADIUS, LOCATION_RENAME, LOCATION_SET_FLAG, LOCATION_TYPE_ADD, LOCATION_TYPE_REMOVE } |
Public Member Functions | |
| PSF_DECLARE_MSG_FACTORY () | |
| psLocationMessage (Command command, const Location *location) | |
| Generic message to do a command where input is a Location. More... | |
| psLocationMessage (Command command, const LocationType *locationType) | |
| Generic message to do a command where input is a Location type. More... | |
| psLocationMessage (Command command, const csString &name) | |
| Generic message to do a command where input is a string. More... | |
| psLocationMessage (MsgEntry *message) | |
| Crack incoming psMessageBytes struct for inbound use. More... | |
| virtual csString | ToString (NetBase::AccessPointers *accessPointers) |
| Convert 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 | |
| Command | command |
| bool | enable |
| Enable or disable flags. More... | |
| csString | flags |
| String with flags. More... | |
| uint32_t | id |
| ID of the location/location type. More... | |
| csString | name |
| Name. More... | |
| csVector3 | position |
| The position for new or adjusted elements. More... | |
| uint32_t | prevID |
| ID of previous point in a region. More... | |
| float | radius |
| The radius. More... | |
| float | rotationAngle |
| The rotation angle for this element. More... | |
| iSector * | sector |
| The sector for new or adjusted elements. More... | |
| csString | typeName |
| Type name. More... | |
| Public Attributes inherited from psMessageCracker | |
| int | filterNumber |
| csRef< MsgEntry > | msg |
| bool | valid |
Additional Inherited Members | |
| Static Public Attributes inherited from psMessageCracker | |
| static MsgHandler * | msghandler |
Detailed Description
Handle Location changes from server to superclient.
Definition at line 580 of file npcmessages.h.
Member Enumeration Documentation
| Enumerator | |
|---|---|
| LOCATION_ADJUSTED | |
| LOCATION_CREATED | |
| LOCATION_DELETED | |
| LOCATION_INSERTED | |
| LOCATION_RADIUS | |
| LOCATION_RENAME | |
| LOCATION_SET_FLAG | |
| LOCATION_TYPE_ADD | |
| LOCATION_TYPE_REMOVE | |
Definition at line 584 of file npcmessages.h.
Constructor & Destructor Documentation
Generic message to do a command where input is a Location.
| psLocationMessage::psLocationMessage | ( | Command | command, |
| const LocationType * | locationType | ||
| ) |
Generic message to do a command where input is a Location type.
| psLocationMessage::psLocationMessage | ( | Command | command, |
| const csString & | name | ||
| ) |
Generic message to do a command where input is a string.
| psLocationMessage::psLocationMessage | ( | MsgEntry * | message | ) |
Crack incoming psMessageBytes struct for inbound use.
Member Function Documentation
| psLocationMessage::PSF_DECLARE_MSG_FACTORY | ( | ) |
|
virtual |
Convert the message into human readable string.
- Parameters
-
accessPointers A struct to a number of access pointers.
- Returns
- Return a human readable string for the message.
Implements psMessageCracker.
Member Data Documentation
| Command psLocationMessage::command |
Definition at line 597 of file npcmessages.h.
| bool psLocationMessage::enable |
Enable or disable flags.
Definition at line 601 of file npcmessages.h.
| csString psLocationMessage::flags |
String with flags.
Definition at line 604 of file npcmessages.h.
| uint32_t psLocationMessage::id |
ID of the location/location type.
Definition at line 598 of file npcmessages.h.
| csString psLocationMessage::name |
Name.
Definition at line 606 of file npcmessages.h.
| csVector3 psLocationMessage::position |
The position for new or adjusted elements.
Definition at line 599 of file npcmessages.h.
| uint32_t psLocationMessage::prevID |
ID of previous point in a region.
Definition at line 607 of file npcmessages.h.
| float psLocationMessage::radius |
The radius.
Definition at line 602 of file npcmessages.h.
| float psLocationMessage::rotationAngle |
The rotation angle for this element.
Definition at line 603 of file npcmessages.h.
| iSector* psLocationMessage::sector |
The sector for new or adjusted elements.
Definition at line 600 of file npcmessages.h.
| csString psLocationMessage::typeName |
Type name.
Definition at line 605 of file npcmessages.h.
The documentation for this class was generated from the following file:
- common/net/npcmessages.h
