Serious Sam's Bogus Detour  2016/06/09
Engine documentation
Classes
Input

Classes

class  ButtonState
 The state of a button in a single update tick. More...
 
class  TextInputControlEvent
 Event called for text input. More...
 
class  GameInput
 Button states for game input. More...
 
class  MenuInput
 Button states for menu input. More...
 
class  ControlMapBinding
 A binding in a ControlMap that attaches to an action. More...
 
class  ControlMap
 A list of controls for a single player. More...
 
class  ControlBindings
 The root object for setting and getting bindings and actions. More...
 

Detailed Description


Class Documentation

class ButtonState

The state of a button in a single update tick.

Class Members
int32 Delta
bool Down
bool Pressed
bool Released
class TextInputControlEvent

Event called for text input.

Class Members
TextInputControlEventType evt
bool select
utf8string text
class GameInput

Button states for game input.

Public Member Functions

int32 GetTextInputCount ()
 
TextInputControlEventGetTextInput (int32 index)
 

Public Attributes

ButtonState Attack
 
ButtonState Reload
 
ButtonState Dash
 
ButtonState Use
 
ButtonState Netricsa
 
ButtonState Weapon1
 
ButtonState Weapon2
 
ButtonState Weapon3
 
ButtonState Weapon4
 
ButtonState Weapon5
 
ButtonState Weapon6
 
ButtonState Weapon7
 
ButtonState Weapon8
 
ButtonState NextWeapon
 
ButtonState PreviousWeapon
 
ButtonState ChangeWeapon
 
vec2 MoveDir
 
vec2 AimDir
 
vec2 MousePos
 
vec2 MousePosReal
 
bool MouseIsLocked
 
int32 MouseWheelDelta
 
bool UsingGamepad
 
bool UsingMouseLook
 

Member Function Documentation

TextInputControlEvent* GameInput::GetTextInput ( int32  index)
int32 GameInput::GetTextInputCount ( )

Member Data Documentation

vec2 GameInput::AimDir
ButtonState GameInput::Attack
ButtonState GameInput::ChangeWeapon
ButtonState GameInput::Dash
bool GameInput::MouseIsLocked
vec2 GameInput::MousePos
vec2 GameInput::MousePosReal
int32 GameInput::MouseWheelDelta
vec2 GameInput::MoveDir
ButtonState GameInput::Netricsa
ButtonState GameInput::NextWeapon
ButtonState GameInput::PreviousWeapon
ButtonState GameInput::Reload
ButtonState GameInput::Use
bool GameInput::UsingGamepad
bool GameInput::UsingMouseLook
ButtonState GameInput::Weapon1
ButtonState GameInput::Weapon2
ButtonState GameInput::Weapon3
ButtonState GameInput::Weapon4
ButtonState GameInput::Weapon5
ButtonState GameInput::Weapon6
ButtonState GameInput::Weapon7
ButtonState GameInput::Weapon8
class MenuInput

Button states for menu input.

Class Members
ButtonState ChatAll
ButtonState ChatTeam
ButtonState Down
ButtonState Forward
ButtonState Left
vec2 MouseMove
ButtonState Right
ButtonState Up
class ControlMapBinding

A binding in a ControlMap that attaches to an action.

Class Members
string Action
string ID
class ControlMap

A list of controls for a single player.

Public Member Functions

bool get_SteamController ()
 
uint64 get_Handle ()
 
array< ControlMapBinding * > * GetBindings ()
 
array< ControlMapBinding * > * GetStaging ()
 
void Clear ()
 
void Remove (ControlMapBinding *bind)
 
void Add (ControllerType type, int32 key, const string &action)
 
void ClearStaging ()
 
void RemoveStaging (ControlMapBinding *bind)
 
void AddStaging (ControllerType type, int32 key, const string &action)
 
void BeginStaging ()
 
void CommitStaging ()
 
void Defaults ()
 

Public Attributes

string ID
 
int32 Index
 
bool UseMouseLook
 
bool Gamepad
 
bool Joystick
 

Member Function Documentation

void ControlMap::Add ( ControllerType  type,
int32  key,
const string action 
)
void ControlMap::AddStaging ( ControllerType  type,
int32  key,
const string action 
)
void ControlMap::BeginStaging ( )
void ControlMap::Clear ( )
void ControlMap::ClearStaging ( )
void ControlMap::CommitStaging ( )
void ControlMap::Defaults ( )
uint64 ControlMap::get_Handle ( )
bool ControlMap::get_SteamController ( )
array<ControlMapBinding*>* ControlMap::GetBindings ( )
array<ControlMapBinding*>* ControlMap::GetStaging ( )
void ControlMap::Remove ( ControlMapBinding bind)
void ControlMap::RemoveStaging ( ControlMapBinding bind)

Member Data Documentation

bool ControlMap::Gamepad
string ControlMap::ID
int32 ControlMap::Index
bool ControlMap::Joystick
bool ControlMap::UseMouseLook
class ControlBindings

The root object for setting and getting bindings and actions.

Public Member Functions

void Save ()
 
ControlMapGetMap (const string &id)
 
array< ControlMap * > * GetMaps ()
 
void ExpectTextInput ()
 
void StopExpectTextInput ()
 
void ExpectInput ()
 
array< string > * GetAvailableActions ()
 

Member Function Documentation

void ControlBindings::ExpectInput ( )
void ControlBindings::ExpectTextInput ( )
array<string>* ControlBindings::GetAvailableActions ( )
ControlMap* ControlBindings::GetMap ( const string id)
array<ControlMap*>* ControlBindings::GetMaps ( )
void ControlBindings::Save ( )
void ControlBindings::StopExpectTextInput ( )