Utopia::StateContainer< StateType, Update::async > Class Template Reference

State Container specialization for async states. More...

#include <state.hh>

Public Types
using	State = StateType
	Type of state.

Public Member Functions
	StateContainer (const State state)
	Construct state container with specific state.
State &	state ()
	Return reference to state.
const State &	state () const
	Return const reference to state.

Static Public Member Functions
static constexpr bool	is_sync ()
	Export implementation type.

Private Attributes
State	_state

Detailed Description

template<typename StateType>
class Utopia::StateContainer< StateType, Update::async >

State Container specialization for async states.

Warning

Using this specialization is discouraged because it determines the type of update used in apply_rule(). See Rules on Entities for details.

Member Typedef Documentation

State

template<typename StateType >

using Utopia::StateContainer< StateType, Update::async >::State = StateType

Type of state.

Constructor & Destructor Documentation

StateContainer()

template<typename StateType >

Utopia::StateContainer< StateType, Update::async >::StateContainer ( const State  state )

inline

Construct state container with specific state.

                                      :
        _state(state)
    { }

Member Function Documentation

is_sync()

template<typename StateType >

static constexpr bool Utopia::StateContainer< StateType, Update::async >::is_sync ( )

inlinestaticconstexpr

Export implementation type.

{ return false; }

state() [1/2]

template<typename StateType >

State & Utopia::StateContainer< StateType, Update::async >::state ( )

inline

Return reference to state.

{ return _state; }

state() [2/2]

template<typename StateType >

const State & Utopia::StateContainer< StateType, Update::async >::state ( ) const

inline

Return const reference to state.

{ return _state; } 

Member Data Documentation

_state

template<typename StateType >

State Utopia::StateContainer< StateType, Update::async >::_state

private

---

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

• include/utopia/core/state.hh