ezWorldModule::UpdateFunctionDesc Struct Reference

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

#include <WorldModule.h>

Public Member Functions
	UpdateFunctionDesc (const UpdateFunction &function, ezStringView sFunctionName)

Public Attributes
UpdateFunction	m_Function
	Delegate to the actual update function.
ezHashedString	m_sFunctionName
ezHybridArray< ezHashedString, 4 >	m_DependsOn
ezEnum< ezWorldUpdatePhase >	m_Phase
	The update phase in which this update function should be called. See ezWorld for a description on the different phases.
bool	m_bOnlyUpdateWhenSimulating = false
	The update function is only called when the world simulation is enabled.
ezUInt16	m_uiAsyncPhaseBatchSize = 0
float	m_fPriority = 0.0f
	Higher priority (higher number) means that this function is called earlier than a function with lower priority.

Detailed Description

Description of an update function that can be registered at the world.

Member Data Documentation

m_DependsOn

ezHybridArray<ezHashedString, 4> ezWorldModule::UpdateFunctionDesc::m_DependsOn

Array of other functions on which this function depends on. This function will be called after all its dependencies have been called.

m_sFunctionName

ezHashedString ezWorldModule::UpdateFunctionDesc::m_sFunctionName

Name of the function. Use the EZ_CREATE_MODULE_UPDATE_FUNCTION_DESC macro to create a description with the correct name.

m_uiAsyncPhaseBatchSize

ezUInt16 ezWorldModule::UpdateFunctionDesc::m_uiAsyncPhaseBatchSize = 0

0 means m_Function is called once per frame, to update all components, but still in parallel with other world modules. >0 means m_Function is called multiple times (in parallel) with batches of roughly this size.

---

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

• /home/runner/work/ezEngine/ezEngine/Code/Engine/Core/World/WorldModule.h