Simple systems for performing batch locks and unlocks on all controllable entities. More...

Public Member Functions
	Controllable (Systems &owner)
	Construct a new Controllable systems. More...

bool	setEntityLocked (bl::ecs::Entity entity, bool locked, bool preserve=true)
	Set the give entity to be locked or unlocked. More...

bool	resetEntityLock (bl::ecs::Entity entity)
	Resets the given entity's lock state to the last remembered value. More...

void	setAllLocks (bool locked, bool preserve=true)
	Sets the lock state for all controllable entities. More...

void	resetAllLocks ()
	Resets all controllable entity locks to the last stored state. More...

Detailed Description

Simple systems for performing batch locks and unlocks on all controllable entities.

Definition at line 19 of file Controllable.hpp.

Constructor & Destructor Documentation

core::system::Controllable::Controllable ( Systems & owner )

Construct a new Controllable systems.

Parameters

owner The primary systems object

Definition at line 10 of file Controllable.cpp.

void core::system::Controllable::resetAllLocks ( )

Resets all controllable entity locks to the last stored state.

Definition at line 40 of file Controllable.cpp.

bool core::system::Controllable::resetEntityLock ( bl::ecs::Entity entity )

Resets the given entity's lock state to the last remembered value.

Parameters

entity The entity to reset

Definition at line 26 of file Controllable.cpp.

void core::system::Controllable::setAllLocks	(	bool	locked,
		bool	preserve = `true`
	)

Sets the lock state for all controllable entities.

Parameters

locked	True to lock, false to unlock
preserve	True to remember previous lock state, false to ignore

Definition at line 35 of file Controllable.cpp.

bool core::system::Controllable::setEntityLocked	(	bl::ecs::Entity	entity,
		bool	locked,
		bool	preserve = `true`
	)

Set the give entity to be locked or unlocked.

Parameters

entity	The entity to change the state of
locked	True to lock, false to unlock
preserve	True to preserve previous lock state, false to forget

Definition at line 13 of file Controllable.cpp.

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