xiiScriptWorldModule Class Reference

Inheritance diagram for xiiScriptWorldModule:

Classes
struct	FunctionContext

Public Member Functions
	xiiScriptWorldModule (xiiWorld *pWorld)
virtual void	Initialize () override
	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	WorldClear () override
	Called by xiiWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).
void	AddUpdateFunctionToSchedule (const xiiAbstractFunctionProperty *pFunction, void *pInstance, xiiTime updateInterval, bool bOnlyWhenSimulating)
void	RemoveUpdateFunctionToSchedule (const xiiAbstractFunctionProperty *pFunction, void *pInstance)
xiiExpressionVM &	GetSharedExpressionVM ()
	Returns a expression vm that can be used in custom script implementations. Make sure to only execute one expression at a time, the VM is NOT thread safe.
Coroutine Functions
xiiScriptCoroutineHandle	CreateCoroutine (const xiiRTTI *pCoroutineType, xiiStringView sName, xiiScriptInstance &inout_instance, xiiScriptCoroutineCreationMode::Enum creationMode, xiiScriptCoroutine *&out_pCoroutine)
	Creates a new coroutine of pCoroutineType with the given name. If the creationMode prevents creating a new coroutine, this function will return an invalid handle and a nullptr in out_pCoroutine if there is already a coroutine running with the same name on the given instance.
void	StartCoroutine (xiiScriptCoroutineHandle hCoroutine, xiiArrayPtr< xiiVariant > arguments)
	Starts the coroutine with the given arguments. This will call the Start() function and then UpdateAndSchedule() once on the coroutine object.
void	StopAndDeleteCoroutine (xiiScriptCoroutineHandle hCoroutine)
	Stops and deletes the coroutine. This will call the Stop() function and will delete the coroutine on next update of the script world module.
void	StopAndDeleteCoroutine (xiiStringView sName, xiiScriptInstance *pInstance)
	Stops and deletes all coroutines with the given name on pInstance.
void	StopAndDeleteAllCoroutines (xiiScriptInstance *pInstance)
	Stops and deletes all coroutines on pInstance.
bool	IsCoroutineFinished (xiiScriptCoroutineHandle hCoroutine) const
	Returns whether the coroutine has already finished or has been stopped.
Public Member Functions inherited from xiiWorldModule
xiiWorld *	GetWorld ()
	Returns the corresponding world to this module.
const xiiWorld *	GetWorld () const
	Returns the corresponding world to this module.
xiiUInt32	GetWorldIndex () const
	Same as GetWorld()->GetIndex(). Needed to break circular include dependencies.
Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI *	GetDynamicRTTI () const
bool	IsInstanceOf (const xiiRTTI *pType) const
	Returns whether the type of this instance is of the given type or derived from it.
template<typename T>
XII_ALWAYS_INLINE bool	IsInstanceOf () const
	Returns whether the type of this instance is of the given type or derived from it.

Additional Inherited Members
Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()
Protected Types inherited from xiiWorldModule
using	UpdateFunction = xiiDelegate<void(const UpdateContext&)>
	Update function delegate.
Protected Member Functions inherited from xiiWorldModule
	xiiWorldModule (xiiWorld *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.
xiiAllocatorBase *	GetAllocator ()
	Returns the allocator used by the world.
xiiInternal::WorldLargeBlockAllocator *	GetBlockAllocator ()
	Returns the block allocator used by the world.
bool	GetWorldSimulationEnabled () const
	Returns whether the world simulation is enabled.
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.
Protected Attributes inherited from xiiWorldModule
xiiWorld *	m_pWorld

Member Function Documentation

Initialize()

void xiiScriptWorldModule::Initialize ( )

overridevirtual

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 from xiiWorldModule.

WorldClear()

void xiiScriptWorldModule::WorldClear ( )

overridevirtual

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

Reimplemented from xiiWorldModule.

---

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

• /home/runner/work/XII/XII/Source/Engine/Core/Scripting/ScriptWorldModule.h
• /home/runner/work/XII/XII/Source/Engine/Core/Scripting/Implementation/ScriptWorldModule.cpp