DefaultEngineStateTransitionGuards Class

Declaration

class helios::engine::runtime::enginestate::rules::guards::DefaultEngineStateTransitionGuards { ... }

Public Static Functions Index

static bool	isPlatformInitialized (helios::engine::runtime::world::UpdateContext &updateContext, const StateTransitionRequest< EngineState > transitionRequest)
	Guard that checks if a current context component is available. More...
static bool	isRuntimeInfrastructureReady (helios::engine::runtime::world::UpdateContext &updateContext, const StateTransitionRequest< EngineState > transitionRequest)
	Guard that checks if the runtime infrastructure is available. More...

Definition at line 26 of file DefaultEngineStateTransitionGuards.ixx.

Public Static Functions

isPlatformInitialized()

bool helios::engine::runtime::enginestate::rules::guards::DefaultEngineStateTransitionGuards::isPlatformInitialized (helios::engine::runtime::world::UpdateContext & updateContext, const StateTransitionRequest< EngineState > transitionRequest)

inline static

Guard that checks if a current context component is available.

Parameters

updateContext	The current frame's update context.
transitionRequest	The requested state transition.

Returns

True if an entity with a CurrentContext exists.

Definition at line 38 of file DefaultEngineStateTransitionGuards.ixx.

38 static bool isPlatformInitialized(

39 helios::engine::runtime::world::UpdateContext& updateContext,

40 const StateTransitionRequest<EngineState> transitionRequest

41 ) {

42 return updateContext.runtimeEnvironment().isInitialized();

43 }

Reference helios::engine::runtime::registerComponents.

isRuntimeInfrastructureReady()

bool helios::engine::runtime::enginestate::rules::guards::DefaultEngineStateTransitionGuards::isRuntimeInfrastructureReady (helios::engine::runtime::world::UpdateContext & updateContext, const StateTransitionRequest< EngineState > transitionRequest)

inline static

Guard that checks if the runtime infrastructure is available.

Parameters

updateContext	The current frame's update context.
transitionRequest	The requested state transition.

Returns

True if the infrastructure can be considered in a ready-state.

Definition at line 53 of file DefaultEngineStateTransitionGuards.ixx.

53 static bool isRuntimeInfrastructureReady(

54 helios::engine::runtime::world::UpdateContext& updateContext,

55 const StateTransitionRequest<EngineState> transitionRequest

56 ) {

57 return updateContext.runtimeEnvironment().isRuntimeInfrastructureReady();

58 }

Reference helios::engine::runtime::registerComponents.

---

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

• DefaultEngineStateTransitionGuards.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.