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

Inheritance diagram for plMsgGenericEvent:

[legend]

Public Member Functions
	PL_DECLARE_MESSAGE_TYPE (plMsgGenericEvent, plEventMessage)

Public Member Functions inherited from plEventMessage
	PL_DECLARE_MESSAGE_TYPE (plEventMessage, plMessage)

PL_ALWAYS_INLINE void	FillFromSenderComponent (const plComponent *pSenderComponent)

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

PL_ALWAYS_INLINE plMessageId	GetId () const
	Returns the id for this message type.

PL_ALWAYS_INLINE plUInt16	GetSize () const
	Returns the size in byte of this message.

PL_ALWAYS_INLINE plUInt64	GetHash () const
	Calculates a hash of the message.

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

virtual void	Deserialize (plStreamReader &inout_stream, plUInt8 uiTypeVersion)

Public Member Functions inherited from plReflectedClass
virtual const plRTTI *	GetDynamicRTTI () const

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

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

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

plVariant	m_Value

Public Attributes inherited from plEventMessage
plGameObjectHandle	m_hSenderObject

plComponentHandle	m_hSenderComponent

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

static plUniquePtr< plMessage >	ReplicatePackedMessage (plStreamReader &inout_stream)
	Restores a message that was written by PackageForTransfer()

Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()

Protected Member Functions inherited from plMessage
	plMessage (size_t messageSize)

Static Protected Member Functions inherited from plMessage
static PL_ALWAYS_INLINE plMessageId	GetNextMsgId ()

Protected Attributes inherited from plMessage
plMessageId	m_Id

plUInt16	m_uiSize

Static Protected Attributes inherited from plMessage
static plMessageId	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