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

Inheritance diagram for ezMsgGenericEvent:

[legend]

Public Member Functions
	EZ_DECLARE_MESSAGE_TYPE (ezMsgGenericEvent, ezEventMessage)

Public Member Functions inherited from ezEventMessage
	EZ_DECLARE_MESSAGE_TYPE (ezEventMessage, ezMessage)

EZ_ALWAYS_INLINE void	FillFromSenderComponent (const ezComponent *pSenderComponent)

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

EZ_ALWAYS_INLINE ezMessageId	GetId () const
	Returns the id for this message type.

EZ_ALWAYS_INLINE ezUInt16	GetSize () const
	Returns the size in byte of this message.

EZ_ALWAYS_INLINE ezUInt64	GetHash () const
	Calculates a hash of the message.

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

virtual void	Deserialize (ezStreamReader &inout_stream, ezUInt8 uiTypeVersion)

Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () const

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

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

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

ezVariant	m_Value

Public Attributes inherited from ezEventMessage
ezGameObjectHandle	m_hSenderObject

ezComponentHandle	m_hSenderComponent

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

static ezUniquePtr< ezMessage >	ReplicatePackedMessage (ezStreamReader &inout_stream)
	Restores a message that was written by PackageForTransfer()

Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Protected Member Functions inherited from ezMessage
	ezMessage (size_t messageSize)

Static Protected Member Functions inherited from ezMessage
static EZ_ALWAYS_INLINE ezMessageId	GetNextMsgId ()

Protected Attributes inherited from ezMessage
ezMessageId	m_Id

ezUInt16	m_uiSize

Static Protected Attributes inherited from ezMessage
static ezMessageId	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