ezEngine Release 26.3
Loading...
Searching...
No Matches
ezMsgDeleteGameObject Struct Reference

Message to request deletion of a game object and optionally its empty parent objects. More...

#include <DeleteObjectMessage.h>

Inheritance diagram for ezMsgDeleteGameObject:

Public Member Functions

 EZ_DECLARE_MESSAGE_TYPE (ezMsgDeleteGameObject, ezMessage)
 
- 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 ezRTTIGetDynamicRTTI () 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

bool m_bDeleteEmptyParents = true
 If set to true, any parent/ancestor that has no other children or components will also be deleted.
 
bool m_bCancel = false
 This is used by ezOnComponentFinishedAction to orchestrate when an object shall really be deleted.
 

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< ezMessageReplicatePackedMessage (ezStreamReader &inout_stream)
 Restores a message that was written by PackageForTransfer()
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 
- 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

Message to request deletion of a game object and optionally its empty parent objects.

When sent to a game object, this message will cause it to be deleted. Can also clean up empty parent objects in the hierarchy and provides cancellation capability for components that need to orchestrate the deletion timing.


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