ezEngine  Release 25.03
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
ezWorldModule Class Reference
Inheritance diagram for ezWorldModule:
Inheritance graph
[legend]

Classes

struct  UpdateContext
 
struct  UpdateFunctionDesc
 Description of an update function that can be registered at the world. More...
 

Public Member Functions

ezWorld * GetWorld ()
 Returns the corresponding world to this module.
 
const ezWorld * GetWorld () const
 Returns the corresponding world to this module.
 
ezUInt32 GetWorldIndex () const
 Same as GetWorld()->GetIndex(). Needed to break circular include dependencies.
 
- 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.
 

Protected Types

using UpdateFunction = ezDelegate< void(const UpdateContext &)>
 Update function delegate.
 

Protected Member Functions

 ezWorldModule (ezWorld *pWorld)
 
void RegisterUpdateFunction (const UpdateFunctionDesc &desc)
 Registers the given update function at the world.
 
void DeregisterUpdateFunction (const UpdateFunctionDesc &desc)
 De-registers the given update function from the world. Note that only the m_Function and the m_Phase of the description have to be valid for de-registration.
 
ezAllocator * GetAllocator ()
 Returns the allocator used by the world.
 
ezInternal::WorldLargeBlockAllocator * GetBlockAllocator ()
 Returns the block allocator used by the world.
 
bool GetWorldSimulationEnabled () const
 Returns whether the world simulation is enabled.
 
virtual void Initialize ()
 This method is called after the constructor. A derived type can override this method to do initialization work. Typically this is the method where updates function are registered.
 
virtual void Deinitialize ()
 This method is called before the destructor. A derived type can override this method to do deinitialization work.
 
virtual void OnSimulationStarted ()
 This method is called at the start of the next world update when the world is simulated. This method will be called after the initialization method.
 
virtual void WorldClear ()
 Called by ezWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).
 

Protected Attributes

ezWorld * m_pWorld
 

Friends

class ezWorld
 
class ezInternal::WorldData
 
class ezMemoryUtils
 

Additional Inherited Members

- Static Public Member Functions inherited from ezNoBase
static const ezRTTI * GetStaticRTTI ()
 
The documentation for this class was generated from the following files: