plWorldModule Class Reference

Inheritance diagram for plWorldModule:

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

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

Protected Types
using	UpdateFunction = plDelegate<void(const UpdateContext&)>
	Update function delegate.

Protected Member Functions
	plWorldModule (plWorld *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.
plAllocator *	GetAllocator ()
	Returns the allocator used by the world.
plInternal::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 plWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).

Protected Attributes
plWorld *	m_pWorld

Friends
class	plWorld
class	plInternal::WorldData
class	plMemoryUtils

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

Member Function Documentation

Deinitialize()

virtual void plWorldModule::Deinitialize ( )

inlineprotectedvirtual

This method is called before the destructor. A derived type can override this method to do deinitialization work.

Reimplemented in plAiNavMeshWorldModule, plAudioTriggerComponentManager, plBakedProbesComponentManager, plBakedProbesWorldModule, plCameraComponentManager, plDetourCrowdWorldModule, plFmodEventComponentManager, plInstancedMeshComponentManager, plJoltVisColMeshComponentManager, plJoltWorldModule, plKrautTreeComponentManager, plParticleWorldModule, plProcPlacementComponentManager, plProcVertexColorComponentManager, plRcAgentComponentManager, plRecastWorldModule, and plTypeScriptComponentManager.

Initialize()

virtual void plWorldModule::Initialize ( )

inlineprotectedvirtual

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.

Reimplemented in plAiNavMeshWorldModule, plAnimatedMeshComponentManager, plAreaDamageComponentManager, plAudioSystemComponentManager< T >, plAudioTriggerComponentManager, plAudioWorldModule, plBakedProbesComponentManager, plBakedProbesWorldModule, plCameraComponentManager, plClothSheetComponentManager, plComponentManagerSimple< ComponentType, UpdateType, StorageType >, plDecalComponentManager, plDetourCrowdAgentComponentManager, plDetourCrowdWorldModule, plFakeRopeComponentManager, plFmodEventComponentManager, plFmodListenerComponentManager, plHeightfieldComponentManager, plInstancedMeshComponentManager, plJoltClothSheetComponentManager, plJoltRagdollComponentManager, plJoltRopeComponentManager, plJoltVisColMeshComponentManager, plJoltWorldModule, plKrautTreeComponentManager, plLineToComponentManager, plParticleComponentManager, plParticleWorldModule, plPathComponentManager, plPostProcessingComponentManager, plPrefabReferenceComponentManager, plProcPlacementComponentManager, plProcVertexColorComponentManager, plRaycastComponentManager, plRcAgentComponentManager, plRcNavMeshComponentManager, plRecastWorldModule, plScriptWorldModule, plSensorWorldModule, plSkeletonPoseComponentManager, plStateMachineComponentManager, and plTypeScriptComponentManager.

OnSimulationStarted()

virtual void plWorldModule::OnSimulationStarted ( )

inlineprotectedvirtual

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.

Reimplemented in plJoltWorldModule, and plTypeScriptComponentManager.

WorldClear()

virtual void plWorldModule::WorldClear ( )

inlineprotectedvirtual

Called by plWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).

Reimplemented in plParticleWorldModule, and plScriptWorldModule.

---

The documentation for this class was generated from the following files:

• Code/Engine/Core/World/WorldModule.h
• Code/Engine/Core/World/Implementation/WorldModule.cpp
• Code/Engine/Core/World/Implementation/WorldModule_inl.h