plWorldModule::UpdateFunctionDesc Struct Reference

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

#include <WorldModule.h>

Classes
struct	Phase

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

Public Attributes
UpdateFunction	m_Function
	Delegate to the actual update function.
plHashedString	m_sFunctionName
plHybridArray< plHashedString, 4 >	m_DependsOn
plEnum< Phase >	m_Phase
bool	m_bOnlyUpdateWhenSimulating = false
	The update function is only called when the world simulation is enabled.
plUInt16	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

plHybridArray<plHashedString, 4> plWorldModule::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_Phase

plEnum<Phase> plWorldModule::UpdateFunctionDesc::m_Phase

The update phase in which this update function should be called. See plWorld for a description on the different phases.

m_sFunctionName

plHashedString plWorldModule::UpdateFunctionDesc::m_sFunctionName

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

m_uiGranularity

plUInt16 plWorldModule::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:

• Code/Engine/Core/World/WorldModule.h