Planeshift
psCombatEventMessage Class Reference

Messages sent from server to client containing each detailed combat event. More...

#include <messages.h>

Public Types

enum  {
  COMBAT_DODGE, COMBAT_BLOCK, COMBAT_DAMAGE, COMBAT_MISS,
  COMBAT_OUTOFRANGE, COMBAT_DEATH, COMBAT_DAMAGE_NEARLY_DEAD
}
 

Public Member Functions

 psCombatEventMessage (uint32_t clientnum, int event_type, EID attacker, EID target, int target_location, float damage, int attack_anim, int defense_anim)
 Create psMessageBytes struct for outbound use. More...
 
 psCombatEventMessage (MsgEntry *message)
 Crack incoming psMessageBytes struct for inbound use. More...
 
 PSF_DECLARE_MSG_FACTORY ()
 
void SetClientNum (int cnum)
 
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

int attack_anim
 
EID attacker_id
 
float damage
 
int defense_anim
 
int event_type
 
EID target_id
 
int target_location
 
- 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

Messages sent from server to client containing each detailed combat event.

Definition at line 2699 of file messages.h.

Member Enumeration Documentation

anonymous enum
Enumerator
COMBAT_DODGE 
COMBAT_BLOCK 
COMBAT_DAMAGE 
COMBAT_MISS 
COMBAT_OUTOFRANGE 
COMBAT_DEATH 
COMBAT_DAMAGE_NEARLY_DEAD 

Definition at line 2709 of file messages.h.

Constructor & Destructor Documentation

psCombatEventMessage::psCombatEventMessage ( uint32_t  clientnum,
int  event_type,
EID  attacker,
EID  target,
int  target_location,
float  damage,
int  attack_anim,
int  defense_anim 
)

Create psMessageBytes struct for outbound use.

psCombatEventMessage::psCombatEventMessage ( MsgEntry *  message)

Crack incoming psMessageBytes struct for inbound use.

Member Function Documentation

psCombatEventMessage::PSF_DECLARE_MSG_FACTORY ( )
void psCombatEventMessage::SetClientNum ( int  cnum)
virtual csString psCombatEventMessage::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

int psCombatEventMessage::attack_anim

Definition at line 2707 of file messages.h.

EID psCombatEventMessage::attacker_id

Definition at line 2703 of file messages.h.

float psCombatEventMessage::damage

Definition at line 2706 of file messages.h.

int psCombatEventMessage::defense_anim

Definition at line 2708 of file messages.h.

int psCombatEventMessage::event_type

Definition at line 2702 of file messages.h.

EID psCombatEventMessage::target_id

Definition at line 2704 of file messages.h.

int psCombatEventMessage::target_location

Definition at line 2705 of file messages.h.


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