Nymph Game Engine
Chaiscript based Game Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Game::AnimationTriggerEvent< StateType > Class Template Reference

Class for animation trigger event. More...

#include <animation_trigger_event.hpp>

Inheritance diagram for Game::AnimationTriggerEvent< StateType >:
Events::Event

Public Member Functions

 AnimationTriggerEvent (const StateType &state)
 AnimationTriggerEvent constructor. More...
 
StateType getState () const noexcept
 Gets the state. More...
 
- Public Member Functions inherited from Events::Event
 Event (const EventType &type)
 Event constructor. More...
 
EventType getEventType () const
 Gets the event type. More...
 

Static Public Member Functions

static std::shared_ptr
< AnimationTriggerEvent
< StateType > > 
create (const StateType &state)
 Factory function. More...
 

Detailed Description

template<typename StateType>
class Game::AnimationTriggerEvent< StateType >

Class for animation trigger event.

Constructor & Destructor Documentation

template<typename StateType >
Game::AnimationTriggerEvent< StateType >::AnimationTriggerEvent ( const StateType &  state)
inline

AnimationTriggerEvent constructor.

Parameters
[in]stateThe state that the animation will change to

Member Function Documentation

template<typename StateType >
static std::shared_ptr<AnimationTriggerEvent<StateType> > Game::AnimationTriggerEvent< StateType >::create ( const StateType &  state)
inlinestatic

Factory function.

Parameters
[in]stateThe state
Returns
Shared pointer to a new AnimationTriggerEvent
template<typename StateType >
StateType Game::AnimationTriggerEvent< StateType >::getState ( ) const
inlinenoexcept

Gets the state.

Returns
The state.

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