For use in scripts to signal a custom event that some game event has occurred. More...

Inheritance diagram for xiiMsgGenericEvent:

Public Member Functions
	XII_DECLARE_MESSAGE_TYPE (xiiMsgGenericEvent, xiiEventMessage)

Public Member Functions inherited from xiiEventMessage
	XII_DECLARE_MESSAGE_TYPE (xiiEventMessage, xiiMessage)

XII_ALWAYS_INLINE void	FillFromSenderComponent (const xiiComponent *pSenderComponent)

Public Member Functions inherited from xiiMessage
virtual xiiInt32	GetSortingKey () const
	Derived message types can override this method to influence sorting order. Smaller keys are processed first.

XII_ALWAYS_INLINE xiiMessageId	GetId () const
	Returns the id for this message type.

XII_ALWAYS_INLINE xiiUInt16	GetSize () const
	Returns the size in byte of this message.

XII_ALWAYS_INLINE xiiUInt64	GetHash () const
	Calculates a hash of the message.

virtual void	Serialize (xiiStreamWriter &ref_stream) const
	Implement this for efficient transmission across process boundaries (e.g. network transfer etc.)

virtual void	Deserialize (xiiStreamReader &ref_stream, xiiUInt8 uiTypeVersion)

Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const

bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.

template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Public Attributes
xiiHashedString	m_sMessage
	A custom string to identify the intent.

xiiVariant	m_Value

Public Attributes inherited from xiiEventMessage
xiiGameObjectHandle	m_hSenderObject

xiiComponentHandle	m_hSenderComponent

Additional Inherited Members
Static Public Member Functions inherited from xiiMessage
static void	PackageForTransfer (const xiiMessage &msg, xiiStreamWriter &ref_stream)
	Writes msg to stream in such a way that ReplicatePackedMessage() can restore it even in another process.

static xiiUniquePtr< xiiMessage >	ReplicatePackedMessage (xiiStreamReader &ref_stream)
	Restores a message that was written by PackageForTransfer()

Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Protected Member Functions inherited from xiiMessage
	xiiMessage (size_t messageSize)

Static Protected Member Functions inherited from xiiMessage
static XII_ALWAYS_INLINE xiiMessageId	GetNextMsgId ()

Protected Attributes inherited from xiiMessage
xiiMessageId	m_Id

xiiUInt16	m_uiSize

Static Protected Attributes inherited from xiiMessage
static xiiMessageId	s_NextMsgId = 0

Detailed Description

For use in scripts to signal a custom event that some game event has occurred.

This is a simple message for simple use cases. Create custom messages for more elaborate cases where a string is not sufficient information.

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

Public Member Functions