CeresEngine::ButtonOnceInputAction Class Reference

#include <CeresEngine/Input/Action.hpp>

Inheritance diagram for CeresEngine::ButtonOnceInputAction:

Public Member Functions
	ButtonOnceInputAction (ButtonSet buttons, ModifierButton modifiers=ModifierButton::None) noexcept
	Creates a new button action.
	ButtonOnceInputAction (Button button, ModifierButton modifiers=ModifierButton::None) noexcept
	Creates a new button action.
void	update (const InputState &state) final
	Updates the action with the given input state.
Public Member Functions inherited from CeresEngine::InputAction
virtual	~InputAction ()=default
	Defaulted virtual destructor.
	operator bool () const noexcept
	A bool conversion operator.

Private Attributes
ButtonSet	buttons
	The buttons that must be pressed to activate the action.
ModifierButton	modifiers
	The modifiers that must be pressed with the keys to activate the action.
bool	pressed = false
	A flag that indicates if the button was pressed on the last update.

Additional Inherited Members
Public Attributes inherited from CeresEngine::InputAction
bool	value = false
	The action state.
Protected Member Functions inherited from CeresEngine::InputAction
void	updateValue (bool value)
	Updates the action value.

Constructor & Destructor Documentation

ButtonOnceInputAction() [1/2]

CeresEngine::ButtonOnceInputAction::ButtonOnceInputAction ( ButtonSet  buttons, ModifierButton  modifiers = ModifierButton::None  )

explicitnoexcept

Creates a new button action.

Parameters

buttons	The buttons that must be pressed to activate the action
modifiers	The modifiers that must be pressed with the keys to activate the action

ButtonOnceInputAction() [2/2]

CeresEngine::ButtonOnceInputAction::ButtonOnceInputAction ( Button  button, ModifierButton  modifiers = ModifierButton::None  )

explicitnoexcept

Creates a new button action.

Parameters

button	The button that must be pressed to activate the action
modifiers	The modifiers that must be pressed with the key to activate the action

Member Function Documentation

update()

void CeresEngine::ButtonOnceInputAction::update ( const InputState &  state )

finalvirtual

Updates the action with the given input state.

Parameters

state

The input state to update the action with

Implements CeresEngine::InputAction.

Member Data Documentation

buttons

ButtonSet CeresEngine::ButtonOnceInputAction::buttons

private

The buttons that must be pressed to activate the action.

modifiers

ModifierButton CeresEngine::ButtonOnceInputAction::modifiers

private

The modifiers that must be pressed with the keys to activate the action.

pressed

bool CeresEngine::ButtonOnceInputAction::pressed = false

private

A flag that indicates if the button was pressed on the last update.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Input/Action.hpp