 |
ezEngine Release 26.3
|
|
ezEngine Release 26.3
|
#include <ScriptWorldModule.h>
Classes | |
| struct | FunctionContext |
| Context information for scheduled script functions. More... | |
Public Member Functions | |
| ezScriptWorldModule (ezWorld *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 ezWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted). | |
| void | AddUpdateFunctionToSchedule (const ezAbstractFunctionProperty *pFunction, void *pInstance, ezTime updateInterval, bool bOnlyWhenSimulating) |
| Schedules a script function to be called at regular intervals. | |
| void | RemoveUpdateFunctionToSchedule (const ezAbstractFunctionProperty *pFunction, void *pInstance) |
| Removes a previously scheduled script function from the scheduler. | |
| ezExpressionVM & | GetSharedExpressionVM () |
Coroutine Functions | |
| ezScriptCoroutineHandle | CreateCoroutine (const ezRTTI *pCoroutineType, ezStringView sName, ezScriptInstance &inout_instance, ezScriptCoroutineCreationMode::Enum creationMode, ezScriptCoroutine *&out_pCoroutine) |
| void | StartCoroutine (ezScriptCoroutineHandle hCoroutine, ezArrayPtr< ezVariant > arguments) |
| void | StopAndDeleteCoroutine (ezScriptCoroutineHandle hCoroutine) |
| void | StopAndDeleteCoroutine (ezStringView sName, ezScriptInstance *pInstance) |
| Stops and deletes all coroutines with the given name on the specified instance. | |
| void | StopAndDeleteAllCoroutines (ezScriptInstance *pInstance) |
| Stops and deletes all coroutines on the specified instance. | |
| bool | IsCoroutineFinished (ezScriptCoroutineHandle hCoroutine) const |
| Returns whether the coroutine has finished or been stopped. | |
 Public Member Functions inherited from ezWorldModule | |
| 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. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ezNoBase | |
| static const ezRTTI * | GetStaticRTTI () |
| Protected Types inherited from ezWorldModule | |
| using | UpdateFunction = ezDelegate< void(const UpdateContext &)> |
| Update function delegate. | |
| Protected Member Functions inherited from ezWorldModule | |
| 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 | 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 ezWorldModule | |
| ezWorld * | m_pWorld |
World module responsible for script execution and coroutine management.
Handles the execution of script functions, manages script coroutines, and provides scheduling for script update functions. This module ensures scripts are properly integrated with the world update cycle.
| ezScriptCoroutineHandle ezScriptWorldModule::CreateCoroutine | ( | const ezRTTI * | pCoroutineType, |
| ezStringView | sName, | ||
| ezScriptInstance & | inout_instance, | ||
| ezScriptCoroutineCreationMode::Enum | creationMode, | ||
| ezScriptCoroutine *& | out_pCoroutine | ||
| ) |
Creates a new coroutine of the specified type with the given name.
Returns an invalid handle if the creationMode prevents creating a new coroutine and there is already a coroutine running with the same name on the given instance.
|
inline |
Returns a shared expression VM for custom script implementations.
The VM is NOT thread safe - only execute one expression at a time.
|
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 ezWorldModule.
| void ezScriptWorldModule::StartCoroutine | ( | ezScriptCoroutineHandle | hCoroutine, |
| ezArrayPtr< ezVariant > | arguments | ||
| ) |
Starts the coroutine with the given arguments.
Calls the Start() function and then UpdateAndSchedule() once on the coroutine object.
| void ezScriptWorldModule::StopAndDeleteCoroutine | ( | ezScriptCoroutineHandle | hCoroutine | ) |
Stops and deletes the coroutine.
Calls the Stop() function and deletes the coroutine on the next update cycle.
|
overridevirtual |
Called by ezWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).
Reimplemented from ezWorldModule.
1.9.8