IEntityEventHandler

C++
struct IEntityEventHandler {
  enum EventValueType {
    Bool,
    Int,
    Float,
    Vector,
    Entity,
    String
  };
  enum EventType {
    Input,
    Output
  };
  struct SEventInfo {
    const char* name;
    EventType type;
    EventValueType valueType;
    const char* description;
  };
};
File

IEntityClass.h

IEntityEventHandler::EventType Enumeration
C++
enum EventType {
  Input,
  Output
};
File

IEntityClass.h

IEntityEventHandler::EventValueType Enumeration
C++
enum EventValueType {
  Bool,
  Int,
  Float,
  Vector,
  Entity,
  String
};
File

IEntityClass.h

Description

Events info for this entity class.

IEntityEventHandler::SEventInfo Structure
C++
struct SEventInfo {
  const char* name;
  EventType type;
  EventValueType valueType;
  const char* description;
};
File

IEntityClass.h

Members
Members
Description
const char* name;
Name of event.
EventType type;
Input or Output event.
EventValueType valueType;
Type of event value.
const char* description;
Description of the event.
IEntityEventHandler::~IEntityEventHandler Destructor
C++
IEntityEventHandler::GetEventCount Method
C++
virtual int GetEventCount() const = 0;
Returns

Return Number of events.

Description

Returns number of events for this entity.

See Also
IEntityEventHandler::GetEventInfo Method
C++
virtual bool GetEventInfo(int index, SEventInfo& info) const = 0;
Parameters
Parameters
Description
nIndex
Index of the event to retrieve, must be in 0 to GetEventCount()-1 range.
Returns

Specified event description in SEventInfo structure.

Description

Retrieve information about events of the entity.

See Also
IEntityEventHandler::GetMemoryUsage Method
C++
virtual void GetMemoryUsage(ICrySizer * pSizer) const;
IEntityEventHandler::LoadEntityXMLEvents Method
C++
virtual void LoadEntityXMLEvents(IEntity* entity, const XmlNodeRef& xml) = 0;
Description

Load event info into the entity.

IEntityEventHandler::RefreshEvents Method
C++
virtual void RefreshEvents() = 0;
Description

Refresh the class' event info.

IEntityEventHandler::SendEvent Method
C++
virtual void SendEvent(IEntity* entity, const char* eventName) = 0;
Parameters
Parameters
Description
IEntity* entity
The entity to send the event to.
const char* eventName
Name of the event to send.
Description

Send the specified event to the entity.