ezEngine  Release 25.03
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< ezWorldUpdatePhasem_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_uiGranularity = 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_uiGranularity

ezUInt16 ezWorldModule::UpdateFunctionDesc::m_uiGranularity = 0

The granularity in which batch updates should happen during the asynchronous phase. Has to be 0 for synchronous functions.


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