hoa_input::GameInput Class Reference

Processes and manages all user input events. More...

#include <input.h>

Inheritance diagram for hoa_input::GameInput:

[legend]Collaboration diagram for hoa_input::GameInput:

[legend]List of all members.

Public Member Functions

bool AnyKeyPress ()

Checks if any keyboard key or joystick button is pressed.

bool AnyKeyRelease ()

Checks if any keyboard key or joystick button is released.

void EventHandler ()

Examines the SDL queue for all user input events and calls appropriate sub-functions.

bool RestoreDefaultJoyButtons ()

Loads the default joystick settings from the lua file and sets them back.

bool RestoreDefaultKeys ()

Loads the default key settings from the lua file and sets them back.

bool SingletonInitialize ()

A method for the inheriting class to implement, which initializes the class.

void TogglePause ()

~GameInput ()

Input press member access functions

Returns:: True if the input event key/button has just been pressed

bool CancelPress ()

bool ConfirmPress ()

bool DownPress ()

bool LeftPress ()

bool LeftSelectPress ()

bool MenuPress ()

bool RightPress ()

bool RightSelectPress ()

bool SwapPress ()

bool UpPress ()

Input release member access functions

Returns:: True if the input event key/button has just been released

bool CancelRelease ()

bool ConfirmRelease ()

bool DownRelease ()

bool LeftRelease ()

bool LeftSelectRelease ()

bool MenuRelease ()

bool RightRelease ()

bool RightSelectRelease ()

bool SwapRelease ()

bool UpRelease ()

Input state member access functions

Returns:: True if the input event key/button is being held down

bool CancelState ()

bool ConfirmState ()

bool DownState ()

bool LeftSelectState ()

bool LeftState ()

bool MenuState ()

bool RightSelectState ()

bool RightState ()

bool SwapState ()

bool UpState ()

Currently set joystick buttons' access functions

Returns:: Joystick button number for the action

int32 GetCancelJoy () const

int32 GetConfirmJoy () const

int32 GetLeftSelectJoy () const

int32 GetMenuJoy () const

int32 GetPauseJoy () const

int32 GetRightSelectJoy () const

int32 GetSwapJoy () const

Returns currently set keys' virtual key codes (SDLKeys)

Returns:: Integer according to the currently set key

int32 GetCancelKey () const

int32 GetConfirmKey () const

int32 GetDownKey () const

int32 GetLeftKey () const

int32 GetLeftSelectKey () const

int32 GetMenuKey () const

int32 GetPauseKey () const

int32 GetRightKey () const

int32 GetRightSelectKey () const

int32 GetSwapKey () const

int32 GetUpKey () const

Currently set key names' access functions

Returns:: Name of the key in char* format

std::string GetCancelKeyName () const

std::string GetConfirmKeyName () const

std::string GetDownKeyName () const

std::string GetLeftKeyName () const

std::string GetLeftSelectKeyName () const

std::string GetMenuKeyName () const

std::string GetPauseKeyName () const

std::string GetRightKeyName () const

std::string GetRightSelectKeyName () const

std::string GetSwapKeyName () const

std::string GetUpKeyName () const

Sets new joystick buttons

Parameters:

key

New button for the action

void SetCancelJoy (uint8 button)

void SetConfirmJoy (uint8 button)

void SetLeftSelectJoy (uint8 button)

void SetMenuJoy (uint8 button)

void SetPauseJoy (uint8 button)

void SetRightSelectJoy (uint8 button)

void SetSwapJoy (uint8 button)

Sets new keymappings

Parameters:

key

New key for the action

void SetCancelKey (const SDLKey &key)

void SetConfirmKey (const SDLKey &key)

void SetDownKey (const SDLKey &key)

void SetLeftKey (const SDLKey &key)

void SetLeftSelectKey (const SDLKey &key)

void SetMenuKey (const SDLKey &key)

void SetPauseKey (const SDLKey &key)

void SetRightKey (const SDLKey &key)

void SetRightSelectKey (const SDLKey &key)

void SetSwapKey (const SDLKey &key)

void SetUpKey (const SDLKey &key)

Private Member Functions

void _JoystickEventHandler (SDL_Event &js_event)

Processes all joystick input event.

void _KeyEventHandler (SDL_KeyboardEvent &key_event)

Processes all keyboard input event.

void _SetNewJoyButton (uint8 &old_button, uint8 new_button)

Sets a new joystick button over an older one. If the same button is used elsewhere, the older one is removed.

void _SetNewKey (SDLKey &old_key, SDLKey new_key)

Sets a new key over an older one. If the same key is used elsewhere, the older one is removed.

GameInput ()

Private Attributes

bool _any_key_press

Any key (or joystick button) pressed.

bool _any_key_release

Any key released.

private_input::JoystickState

_joystick

Holds the current user-defined joystick settings.

private_input::KeyState

_key

Holds the current user-defined key settings.

Input Press Members

Retain whether an input key/button was just pressed

bool _cancel_press

bool _confirm_press

bool _down_press

bool _left_press

bool _left_select_press

bool _menu_press

bool _right_press

bool _right_select_press

bool _swap_press

bool _up_press

Input Release Members

Retain whether an input key/button was just released

bool _cancel_release

bool _confirm_release

bool _down_release

bool _left_release

bool _left_select_release

bool _menu_release

bool _right_release

bool _right_select_release

bool _swap_release

bool _up_release

Input State Members

Retain whether an input key/button is currently being held down

bool _cancel_state

bool _confirm_state

bool _down_state

bool _left_select_state

bool _left_state

bool _menu_state

bool _right_select_state

bool _right_state

bool _swap_state

bool _up_state

First Joystick Axis Motion

Retains whether a joystick axis event has already occured or not

bool _joyaxis_x_first

bool _joyaxis_y_first

Friends

class hoa_utils::Singleton< GameInput >

Detailed Description

Processes and manages all user input events.

***************************************************************************

The way this class operates is by first retaining the user-defined keyboard and joystick settings. The EventHandler() function is called once every iteration of the main game loop to process all events that have accumulated in the SDL input queue. Three boolean varaiables for each type of input event are maintained to represent the state of each input:

state :: for when a key/button is being held down
press :: for when a key/button was previously untouched, but has since been pressed
release :: for when a key/button was previously held down, but has since been released

The names of the primary game input events and their purposes are listed below:

up :: Moves a cursor/sprite upwards
down :: Moves a cursor/sprite downwards
left :: Moves a cursor/sprite left
right :: Moves a cursor/sprite right
confirm :: Confirms a menu selection or command
cancel :: Cancels a menu selection or command
menu :: Opens up a menu
swap :: Used for swapping selected items or characters
left_select :: Selecting multiple items or friendlys
right_select :: Selecting multiple items or foes
pause :: Pauses the game

There are also other events and meta-key combination events that are handled within this class itself:

Ctrl+F :: toggles the game between running in windowed and full screen mode
Ctrl+Q :: brings up the quit menu/quits the game
Ctrl+S :: saves a screenshot of the current screen
Quit Event :: same as Ctrl+Q, this happens when the user tries to close the game window

Note:

This class is a singleton.

Pause and quit events are handled automatically in this class, so there are no means available for you to detect nor handle the. However, you can determine what happens to the audio on a pause or quit event (see the file settings.h for information on that).

Keep in mind that these events are not mutually exclusive (an up press and a down press may be registered at the same time). This class does not attempt to give one event precedence over the other, except in the case of pause and quit events. Therefore, your code you should deal with the problem of not having mutual exclusive events directly.

Because this class will be used quite often to check the status of the various booleans, encapsulation has been used so that one can't accidentally change the value of one of the members and introduce hard-to-find bugs in the code. (eg. `if (up_state = true)` instead of `if (up_state == true)`.

In the end, all you really need to know about this class are the member access functions in the public section of this class (its not that hard).

Definition at line 202 of file input.h.

Constructor & Destructor Documentation

hoa_input::GameInput::GameInput ( ) [private]

hoa_input::GameInput::~GameInput ( )

Definition at line 106 of file input.cpp.

References _joystick, hoa_input::INPUT_DEBUG, and hoa_input::private_input::JoystickState::js.

Member Function Documentation

void hoa_input::GameInput::_JoystickEventHandler ( SDL_Event & js_event ) [private]

Processes all joystick input event.

Parameters:

js_event

The event to process

Definition at line 653 of file input.cpp.

Referenced by EventHandler().

Here is the call graph for this function:

void hoa_input::GameInput::_KeyEventHandler ( SDL_KeyboardEvent & key_event ) [private]

Processes all keyboard input event.

Parameters:

key_event

The event to process

Definition at line 456 of file input.cpp.

References _any_key_press, _any_key_release, _cancel_press, _cancel_release, _cancel_state, _confirm_press, _confirm_release, _confirm_state, _down_press, _down_release, _down_state, _key, _left_press, _left_release, _left_select_press, _left_select_release, _left_select_state, _left_state, _menu_press, _menu_release, _menu_state, _right_press, _right_release, _right_select_press, _right_select_release, _right_select_state, _right_state, _swap_press, _swap_release, _swap_state, _up_press, _up_release, _up_state, hoa_video::GameVideo::ApplySettings(), hoa_input::private_input::KeyState::cancel, hoa_input::private_input::KeyState::confirm, hoa_video::GameVideo::DEBUG_NextTexSheet(), hoa_input::private_input::KeyState::down, hoa_system::GameSystem::ExitGame(), hoa_mode_manager::GameModeManager::GetGameType(), hoa_input::INPUT_DEBUG, hoa_input::private_input::KeyState::left, hoa_input::private_input::KeyState::left_select, hoa_video::GameVideo::MakeScreenshot(), hoa_input::private_input::KeyState::menu, hoa_mode_manager::MODE_MANAGER_BOOT_MODE, hoa_mode_manager::MODE_MANAGER_QUIT_MODE, hoa_mode_manager::ModeManager, hoa_input::private_input::KeyState::pause, hoa_mode_manager::GameModeManager::Pop(), hoa_mode_manager::GameModeManager::Push(), hoa_input::private_input::KeyState::right, hoa_input::private_input::KeyState::right_select, hoa_input::private_input::KeyState::swap, hoa_system::SystemManager, hoa_input::TEMP_HandlePause(), hoa_video::GameVideo::ToggleAdvancedDisplay(), hoa_video::GameVideo::ToggleFPS(), hoa_video::GameVideo::ToggleFullscreen(), TogglePause(), hoa_input::private_input::KeyState::up, and hoa_video::VideoManager.

Referenced by EventHandler().

Here is the call graph for this function:

void hoa_input::GameInput::_SetNewJoyButton	(	uint8 &	old_button,
		uint8	new_button
	)			`[private]`

Sets a new joystick button over an older one. If the same button is used elsewhere, the older one is removed.

Parameters:

	old_button	to be replaced (_joystick.confirm for example)
	new_button	button to replace the old value

Definition at line 860 of file input.cpp.

References _joystick, hoa_input::private_input::JoystickState::cancel, hoa_input::private_input::JoystickState::confirm, hoa_input::private_input::JoystickState::left_select, hoa_input::private_input::JoystickState::menu, hoa_input::private_input::JoystickState::pause, hoa_input::private_input::JoystickState::right_select, and hoa_input::private_input::JoystickState::swap.

Referenced by SetCancelJoy(), SetConfirmJoy(), SetLeftSelectJoy(), SetMenuJoy(), SetPauseJoy(), SetRightSelectJoy(), and SetSwapJoy().

void hoa_input::GameInput::_SetNewKey	(	SDLKey &	old_key,
		SDLKey	new_key
	)			`[private]`

Sets a new key over an older one. If the same key is used elsewhere, the older one is removed.

Parameters:

	old_key	key to be replaced (_key.up for example)
	new_key	key to replace the old value

Definition at line 786 of file input.cpp.

Referenced by SetCancelKey(), SetConfirmKey(), SetDownKey(), SetLeftKey(), SetLeftSelectKey(), SetMenuKey(), SetPauseKey(), SetRightKey(), SetRightSelectKey(), SetSwapKey(), and SetUpKey().

bool hoa_input::GameInput::AnyKeyPress ( )

Checks if any keyboard key or joystick button is pressed.

Returns:: True if any key/button is pressed

Definition at line 248 of file input.cpp.

References _any_key_press.

Referenced by hoa_boot::BootMode::Update().

bool hoa_input::GameInput::AnyKeyRelease ( )

Checks if any keyboard key or joystick button is released.

Returns:: True if any key/button is released

Definition at line 254 of file input.cpp.

References _any_key_release.

bool hoa_input::GameInput::CancelPress ( ) [inline]

Definition at line 374 of file input.h.

References _cancel_press.

Referenced by hoa_battle::private_battle::ActionWindow::_UpdateActionInformation(), hoa_battle::private_battle::ActionWindow::_UpdateActionSelection(), hoa_battle::BattleMode::_UpdateAttackPointSelection(), hoa_battle::private_battle::ActionWindow::_UpdateTargetSelection(), hoa_battle::BattleMode::_UpdateTargetSelection(), hoa_shop::private_shop::ConfirmWindow::Update(), hoa_shop::private_shop::ObjectSellListWindow::Update(), hoa_shop::private_shop::ObjectListWindow::Update(), hoa_shop::private_shop::ShopActionWindow::Update(), hoa_scene::SceneMode::Update(), hoa_quit::QuitMode::Update(), hoa_menu::private_menu::EquipWindow::Update(), hoa_menu::private_menu::SkillsWindow::Update(), hoa_menu::private_menu::StatusWindow::Update(), hoa_menu::private_menu::InventoryWindow::Update(), hoa_menu::MenuMode::Update(), and hoa_boot::BootMode::Update().

bool hoa_input::GameInput::CancelRelease ( ) [inline]

Definition at line 400 of file input.h.

References _cancel_release.

bool hoa_input::GameInput::CancelState ( ) [inline]

Definition at line 348 of file input.h.

References _cancel_state.

bool hoa_input::GameInput::ConfirmPress ( ) [inline]

Definition at line 372 of file input.h.

References _confirm_press.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_battle::private_battle::ActionWindow::_UpdateActionCategory(), hoa_battle::private_battle::ActionWindow::_UpdateActionSelection(), hoa_battle::BattleMode::_UpdateAttackPointSelection(), hoa_battle::BattleMode::_UpdateCharacterSelection(), hoa_battle::BattleMode::_UpdateTargetSelection(), hoa_shop::private_shop::ConfirmWindow::Update(), hoa_shop::private_shop::ObjectSellListWindow::Update(), hoa_shop::private_shop::ObjectListWindow::Update(), hoa_shop::private_shop::ShopActionWindow::Update(), hoa_scene::SceneMode::Update(), hoa_quit::QuitMode::Update(), hoa_menu::private_menu::EquipWindow::Update(), hoa_menu::private_menu::SkillsWindow::Update(), hoa_menu::private_menu::InventoryWindow::Update(), hoa_menu::MenuMode::Update(), hoa_map::private_map::DialogueManager::Update(), hoa_boot::BootMode::Update(), and hoa_battle::private_battle::FinishWindow::Update().

bool hoa_input::GameInput::ConfirmRelease ( ) [inline]

Definition at line 398 of file input.h.

References _confirm_release.

bool hoa_input::GameInput::ConfirmState ( ) [inline]

Definition at line 346 of file input.h.

References _confirm_state.

bool hoa_input::GameInput::DownPress ( ) [inline]

Definition at line 366 of file input.h.

References _down_press.

Referenced by hoa_battle::private_battle::ActionWindow::_UpdateActionSelection(), hoa_battle::BattleMode::_UpdateAttackPointSelection(), hoa_battle::BattleMode::_UpdateCharacterSelection(), hoa_battle::private_battle::ActionWindow::_UpdateTargetSelection(), hoa_battle::BattleMode::_UpdateTargetSelection(), hoa_shop::private_shop::ObjectSellListWindow::Update(), hoa_shop::private_shop::ObjectListWindow::Update(), hoa_shop::private_shop::ShopActionWindow::Update(), hoa_menu::private_menu::EquipWindow::Update(), hoa_menu::private_menu::SkillsWindow::Update(), hoa_menu::private_menu::StatusWindow::Update(), hoa_menu::private_menu::InventoryWindow::Update(), and hoa_boot::BootMode::Update().

bool hoa_input::GameInput::DownRelease ( ) [inline]

Definition at line 392 of file input.h.

References _down_release.

bool hoa_input::GameInput::DownState ( ) [inline]

Definition at line 340 of file input.h.

References _down_state.

Referenced by hoa_map::MapMode::_HandleInputExplore().

void hoa_input::GameInput::EventHandler ( )

Examines the SDL queue for all user input events and calls appropriate sub-functions.

This function handles all the meta keyboard events (events when a modifier key like Ctrl or Alt is held down) and all miscellaneous user input events (like clicking on the window button to quit the game). Any keyboard or joystick events that occur are passed to the KeyEventHandler() and JoystickEventHandler() functions.

Note:: EventHandler() should only be called in the main game loop. Do not call it anywhere else.

Definition at line 278 of file input.cpp.

References _any_key_press, _any_key_release, _cancel_press, _cancel_release, _confirm_press, _confirm_release, _down_press, _down_release, _down_state, _joyaxis_x_first, _joyaxis_y_first, _joystick, _JoystickEventHandler(), _KeyEventHandler(), _left_press, _left_release, _left_select_press, _left_select_release, _left_state, _menu_press, _menu_release, _right_press, _right_release, _right_select_press, _right_select_release, _right_state, _swap_press, _swap_release, _up_press, _up_release, _up_state, hoa_system::GameSystem::ExitGame(), hoa_mode_manager::GameModeManager::GetGameType(), hoa_input::private_input::JOYAXIS_THRESHOLD, hoa_input::private_input::JoystickState::js, hoa_mode_manager::MODE_MANAGER_BOOT_MODE, hoa_mode_manager::MODE_MANAGER_QUIT_MODE, hoa_mode_manager::ModeManager, hoa_mode_manager::GameModeManager::Push(), hoa_system::SystemManager, hoa_input::TEMP_HandlePause(), hoa_input::private_input::JoystickState::x_current_peak, hoa_input::private_input::JoystickState::x_previous_peak, hoa_input::private_input::JoystickState::y_current_peak, and hoa_input::private_input::JoystickState::y_previous_peak.

Referenced by hoa_battle::BattleMode::_ShutDown(), and main().

Here is the call graph for this function:

int32 hoa_input::GameInput::GetCancelJoy ( ) const [inline]

Definition at line 434 of file input.h.

References _joystick, and hoa_input::private_input::JoystickState::cancel.

Referenced by hoa_boot::BootMode::_SaveSettingsFile(), and hoa_boot::BootMode::_UpdateJoySettings().

int32 hoa_input::GameInput::GetCancelKey ( ) const [inline]

Definition at line 481 of file input.h.

References _key, and hoa_input::private_input::KeyState::cancel.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetCancelKeyName ( ) const [inline]

Definition at line 421 of file input.h.

References _key, and hoa_input::private_input::KeyState::cancel.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetConfirmJoy ( ) const [inline]

Definition at line 433 of file input.h.

References _joystick, and hoa_input::private_input::JoystickState::confirm.

Referenced by hoa_boot::BootMode::_SaveSettingsFile(), and hoa_boot::BootMode::_UpdateJoySettings().

int32 hoa_input::GameInput::GetConfirmKey ( ) const [inline]

Definition at line 480 of file input.h.

References _key, and hoa_input::private_input::KeyState::confirm.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetConfirmKeyName ( ) const [inline]

Definition at line 420 of file input.h.

References _key, and hoa_input::private_input::KeyState::confirm.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetDownKey ( ) const [inline]

Definition at line 477 of file input.h.

References _key, and hoa_input::private_input::KeyState::down.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetDownKeyName ( ) const [inline]

Definition at line 417 of file input.h.

References _key, and hoa_input::private_input::KeyState::down.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetLeftKey ( ) const [inline]

Definition at line 478 of file input.h.

References _key, and hoa_input::private_input::KeyState::left.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetLeftKeyName ( ) const [inline]

Definition at line 418 of file input.h.

References _key, and hoa_input::private_input::KeyState::left.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetLeftSelectJoy ( ) const [inline]

Definition at line 437 of file input.h.

References _joystick, and hoa_input::private_input::JoystickState::left_select.

Referenced by hoa_boot::BootMode::_SaveSettingsFile(), and hoa_boot::BootMode::_UpdateJoySettings().

int32 hoa_input::GameInput::GetLeftSelectKey ( ) const [inline]

Definition at line 484 of file input.h.

References _key, and hoa_input::private_input::KeyState::left_select.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetLeftSelectKeyName ( ) const [inline]

Definition at line 424 of file input.h.

References _key, and hoa_input::private_input::KeyState::left_select.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetMenuJoy ( ) const [inline]

Definition at line 435 of file input.h.

References _joystick, and hoa_input::private_input::JoystickState::menu.

Referenced by hoa_boot::BootMode::_SaveSettingsFile(), and hoa_boot::BootMode::_UpdateJoySettings().

int32 hoa_input::GameInput::GetMenuKey ( ) const [inline]

Definition at line 482 of file input.h.

References _key, and hoa_input::private_input::KeyState::menu.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetMenuKeyName ( ) const [inline]

Definition at line 422 of file input.h.

References _key, and hoa_input::private_input::KeyState::menu.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetPauseJoy ( ) const [inline]

Definition at line 439 of file input.h.

References _joystick, and hoa_input::private_input::JoystickState::pause.

Referenced by hoa_boot::BootMode::_SaveSettingsFile(), and hoa_boot::BootMode::_UpdateJoySettings().

int32 hoa_input::GameInput::GetPauseKey ( ) const [inline]

Definition at line 486 of file input.h.

References _key, and hoa_input::private_input::KeyState::pause.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetPauseKeyName ( ) const [inline]

Definition at line 426 of file input.h.

References _key, and hoa_input::private_input::KeyState::pause.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetRightKey ( ) const [inline]

Definition at line 479 of file input.h.

References _key, and hoa_input::private_input::KeyState::right.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetRightKeyName ( ) const [inline]

Definition at line 419 of file input.h.

References _key, and hoa_input::private_input::KeyState::right.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetRightSelectJoy ( ) const [inline]

Definition at line 438 of file input.h.

References _joystick, and hoa_input::private_input::JoystickState::right_select.

Referenced by hoa_boot::BootMode::_SaveSettingsFile(), and hoa_boot::BootMode::_UpdateJoySettings().

int32 hoa_input::GameInput::GetRightSelectKey ( ) const [inline]

Definition at line 485 of file input.h.

References _key, and hoa_input::private_input::KeyState::right_select.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetRightSelectKeyName ( ) const [inline]

Definition at line 425 of file input.h.

References _key, and hoa_input::private_input::KeyState::right_select.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetSwapJoy ( ) const [inline]

Definition at line 436 of file input.h.

References _joystick, and hoa_input::private_input::JoystickState::swap.

Referenced by hoa_boot::BootMode::_SaveSettingsFile(), and hoa_boot::BootMode::_UpdateJoySettings().

int32 hoa_input::GameInput::GetSwapKey ( ) const [inline]

Definition at line 483 of file input.h.

References _key, and hoa_input::private_input::KeyState::swap.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetSwapKeyName ( ) const [inline]

Definition at line 423 of file input.h.

References _key, and hoa_input::private_input::KeyState::swap.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

int32 hoa_input::GameInput::GetUpKey ( ) const [inline]

Definition at line 476 of file input.h.

References _key, and hoa_input::private_input::KeyState::up.

Referenced by hoa_boot::BootMode::_SaveSettingsFile().

std::string hoa_input::GameInput::GetUpKeyName ( ) const [inline]

Definition at line 416 of file input.h.

References _key, and hoa_input::private_input::KeyState::up.

Referenced by hoa_boot::BootMode::_UpdateKeySettings().

bool hoa_input::GameInput::LeftPress ( ) [inline]

Definition at line 368 of file input.h.

References _left_press.

Referenced by hoa_battle::private_battle::ActionWindow::_UpdateActionCategory(), hoa_battle::BattleMode::_UpdateAttackPointSelection(), hoa_battle::BattleMode::_UpdateCharacterSelection(), hoa_battle::private_battle::ActionWindow::_UpdateTargetSelection(), hoa_battle::BattleMode::_UpdateTargetSelection(), hoa_shop::private_shop::ConfirmWindow::Update(), hoa_shop::private_shop::ObjectSellListWindow::Update(), hoa_shop::private_shop::ObjectListWindow::Update(), hoa_quit::QuitMode::Update(), hoa_menu::private_menu::EquipWindow::Update(), hoa_menu::private_menu::SkillsWindow::Update(), hoa_menu::private_menu::InventoryWindow::Update(), hoa_menu::MenuMode::Update(), and hoa_boot::BootMode::Update().

bool hoa_input::GameInput::LeftRelease ( ) [inline]

Definition at line 394 of file input.h.

References _left_release.

bool hoa_input::GameInput::LeftSelectPress ( ) [inline]

Definition at line 380 of file input.h.

References _left_select_press.

bool hoa_input::GameInput::LeftSelectRelease ( ) [inline]

Definition at line 406 of file input.h.

References _left_select_release.

bool hoa_input::GameInput::LeftSelectState ( ) [inline]

Definition at line 354 of file input.h.

References _left_select_state.

bool hoa_input::GameInput::LeftState ( ) [inline]

Definition at line 342 of file input.h.

References _left_state.

Referenced by hoa_map::MapMode::_HandleInputExplore().

bool hoa_input::GameInput::MenuPress ( ) [inline]

Definition at line 376 of file input.h.

References _menu_press.

Referenced by hoa_map::MapMode::_HandleInputExplore(), hoa_battle::private_battle::ActionWindow::_UpdateActionInformation(), and hoa_battle::private_battle::ActionWindow::_UpdateActionSelection().

bool hoa_input::GameInput::MenuRelease ( ) [inline]

Definition at line 402 of file input.h.

References _menu_release.

bool hoa_input::GameInput::MenuState ( ) [inline]

Definition at line 350 of file input.h.

References _menu_state.

bool hoa_input::GameInput::RestoreDefaultJoyButtons ( )

Loads the default joystick settings from the lua file and sets them back.

Returns:: Returns false if the settings file couldn't be read

Definition at line 220 of file input.cpp.

References _joystick, hoa_input::private_input::JoystickState::cancel, hoa_script::ReadScriptDescriptor::CloseFile(), hoa_script::ReadScriptDescriptor::CloseTable(), hoa_input::private_input::JoystickState::confirm, hoa_input::private_input::JoystickState::left_select, hoa_input::private_input::JoystickState::menu, hoa_script::ReadScriptDescriptor::OpenFile(), hoa_script::ReadScriptDescriptor::OpenTable(), hoa_input::private_input::JoystickState::pause, hoa_script::ReadScriptDescriptor::ReadInt(), hoa_input::private_input::JoystickState::right_select, and hoa_input::private_input::JoystickState::swap.

Referenced by hoa_boot::BootMode::_OnRestoreDefaultJoyButtons().

Here is the call graph for this function:

bool hoa_input::GameInput::RestoreDefaultKeys ( )

Loads the default key settings from the lua file and sets them back.

Returns:: Returns false if the settings file couldn't be read

Definition at line 189 of file input.cpp.

Referenced by hoa_boot::BootMode::_OnRestoreDefaultKeys().

Here is the call graph for this function:

bool hoa_input::GameInput::RightPress ( ) [inline]

Definition at line 370 of file input.h.

References _right_press.

bool hoa_input::GameInput::RightRelease ( ) [inline]

Definition at line 396 of file input.h.

References _right_release.

bool hoa_input::GameInput::RightSelectPress ( ) [inline]

Definition at line 382 of file input.h.

References _right_select_press.

bool hoa_input::GameInput::RightSelectRelease ( ) [inline]

Definition at line 408 of file input.h.

References _right_select_release.

bool hoa_input::GameInput::RightSelectState ( ) [inline]

Definition at line 356 of file input.h.

References _right_select_state.

bool hoa_input::GameInput::RightState ( ) [inline]

Definition at line 344 of file input.h.

References _right_state.

Referenced by hoa_map::MapMode::_HandleInputExplore().

void hoa_input::GameInput::SetCancelJoy ( uint8 button ) [inline]

Definition at line 464 of file input.h.

References _joystick, _SetNewJoyButton(), and hoa_input::private_input::JoystickState::cancel.

Referenced by hoa_boot::BootMode::_RedefineCancelJoy().

Here is the call graph for this function:

void hoa_input::GameInput::SetCancelKey ( const SDLKey & key ) [inline]

Definition at line 451 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::cancel.

Referenced by hoa_boot::BootMode::_RedefineCancelKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetConfirmJoy ( uint8 button ) [inline]

Definition at line 463 of file input.h.

References _joystick, _SetNewJoyButton(), and hoa_input::private_input::JoystickState::confirm.

Referenced by hoa_boot::BootMode::_RedefineConfirmJoy().

Here is the call graph for this function:

void hoa_input::GameInput::SetConfirmKey ( const SDLKey & key ) [inline]

Definition at line 450 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::confirm.

Referenced by hoa_boot::BootMode::_RedefineConfirmKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetDownKey ( const SDLKey & key ) [inline]

Definition at line 447 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::down.

Referenced by hoa_boot::BootMode::_RedefineDownKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetLeftKey ( const SDLKey & key ) [inline]

Definition at line 448 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::left.

Referenced by hoa_boot::BootMode::_RedefineLeftKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetLeftSelectJoy ( uint8 button ) [inline]

Definition at line 467 of file input.h.

References _joystick, _SetNewJoyButton(), and hoa_input::private_input::JoystickState::left_select.

Referenced by hoa_boot::BootMode::_RedefineLeftSelectJoy().

Here is the call graph for this function:

void hoa_input::GameInput::SetLeftSelectKey ( const SDLKey & key ) [inline]

Definition at line 454 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::left_select.

Referenced by hoa_boot::BootMode::_RedefineLeftSelectKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetMenuJoy ( uint8 button ) [inline]

Definition at line 465 of file input.h.

References _joystick, _SetNewJoyButton(), and hoa_input::private_input::JoystickState::menu.

Referenced by hoa_boot::BootMode::_RedefineMenuJoy().

Here is the call graph for this function:

void hoa_input::GameInput::SetMenuKey ( const SDLKey & key ) [inline]

Definition at line 452 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::menu.

Referenced by hoa_boot::BootMode::_RedefineMenuKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetPauseJoy ( uint8 button ) [inline]

Definition at line 469 of file input.h.

References _joystick, _SetNewJoyButton(), and hoa_input::private_input::JoystickState::pause.

Referenced by hoa_boot::BootMode::_RedefinePauseJoy().

Here is the call graph for this function:

void hoa_input::GameInput::SetPauseKey ( const SDLKey & key ) [inline]

Definition at line 456 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::pause.

Referenced by hoa_boot::BootMode::_RedefinePauseKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetRightKey ( const SDLKey & key ) [inline]

Definition at line 449 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::right.

Referenced by hoa_boot::BootMode::_RedefineRightKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetRightSelectJoy ( uint8 button ) [inline]

Definition at line 468 of file input.h.

References _joystick, _SetNewJoyButton(), and hoa_input::private_input::JoystickState::right_select.

Referenced by hoa_boot::BootMode::_RedefineRightSelectJoy().

Here is the call graph for this function:

void hoa_input::GameInput::SetRightSelectKey ( const SDLKey & key ) [inline]

Definition at line 455 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::right_select.

Referenced by hoa_boot::BootMode::_RedefineRightSelectKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetSwapJoy ( uint8 button ) [inline]

Definition at line 466 of file input.h.

References _joystick, _SetNewJoyButton(), and hoa_input::private_input::JoystickState::swap.

Referenced by hoa_boot::BootMode::_RedefineSwapJoy().

Here is the call graph for this function:

void hoa_input::GameInput::SetSwapKey ( const SDLKey & key ) [inline]

Definition at line 453 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::swap.

Referenced by hoa_boot::BootMode::_RedefineSwapKey().

Here is the call graph for this function:

void hoa_input::GameInput::SetUpKey ( const SDLKey & key ) [inline]

Definition at line 446 of file input.h.

References _key, _SetNewKey(), and hoa_input::private_input::KeyState::up.

Referenced by hoa_boot::BootMode::_RedefineUpKey().

Here is the call graph for this function:

bool hoa_input::GameInput::SingletonInitialize ( ) [virtual]

A method for the inheriting class to implement, which initializes the class.

Returns:: True if initialization was successful, false if it was not

Implements hoa_utils::Singleton< T >.

Definition at line 116 of file input.cpp.

Referenced by InitializeEngine().

Here is the call graph for this function:

bool hoa_input::GameInput::SwapPress ( ) [inline]

Definition at line 378 of file input.h.

References _swap_press.

bool hoa_input::GameInput::SwapRelease ( ) [inline]

Definition at line 404 of file input.h.

References _swap_release.

bool hoa_input::GameInput::SwapState ( ) [inline]

Definition at line 352 of file input.h.

References _swap_state.

Referenced by hoa_battle::private_battle::BattleCharacterActor::DrawStatus().

void hoa_input::GameInput::TogglePause ( )

Definition at line 260 of file input.cpp.

References hoa_mode_manager::GameModeManager::GetGameType(), hoa_mode_manager::MODE_MANAGER_PAUSE_MODE, hoa_mode_manager::ModeManager, hoa_mode_manager::GameModeManager::Pop(), hoa_mode_manager::GameModeManager::Push(), and hoa_input::TEMP_HandlePause().

Referenced by _KeyEventHandler().

Here is the call graph for this function:

bool hoa_input::GameInput::UpPress ( ) [inline]

Definition at line 364 of file input.h.

References _up_press.

bool hoa_input::GameInput::UpRelease ( ) [inline]

Definition at line 390 of file input.h.

References _up_release.

bool hoa_input::GameInput::UpState ( ) [inline]

Definition at line 338 of file input.h.

References _up_state.

Referenced by hoa_map::MapMode::_HandleInputExplore().

Friends And Related Function Documentation

friend class hoa_utils::Singleton< GameInput > [friend]

Definition at line 203 of file input.h.

Member Data Documentation

bool hoa_input::GameInput::_any_key_press [private]

Any key (or joystick button) pressed.

Definition at line 216 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), AnyKeyPress(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_any_key_release [private]

Any key released.

Definition at line 219 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), AnyKeyRelease(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_cancel_press [private]

Definition at line 246 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), CancelPress(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_cancel_release [private]

Definition at line 262 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), CancelRelease(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_cancel_state [private]

Definition at line 230 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), CancelState(), and GameInput().

bool hoa_input::GameInput::_confirm_press [private]

Definition at line 245 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), ConfirmPress(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_confirm_release [private]

Definition at line 261 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), ConfirmRelease(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_confirm_state [private]

Definition at line 229 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), ConfirmState(), and GameInput().

bool hoa_input::GameInput::_down_press [private]

Definition at line 242 of file input.h.

Referenced by _KeyEventHandler(), DownPress(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_down_release [private]

Definition at line 258 of file input.h.

Referenced by _KeyEventHandler(), DownRelease(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_down_state [private]

Definition at line 226 of file input.h.

Referenced by _KeyEventHandler(), DownState(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_joyaxis_x_first [private]

Definition at line 273 of file input.h.

Referenced by _JoystickEventHandler(), EventHandler(), and GameInput().

bool hoa_input::GameInput::_joyaxis_y_first [private]

Definition at line 274 of file input.h.

Referenced by _JoystickEventHandler(), EventHandler(), and GameInput().

private_input::JoystickState hoa_input::GameInput::_joystick [private]

Holds the current user-defined joystick settings.

Definition at line 212 of file input.h.

Referenced by _JoystickEventHandler(), _SetNewJoyButton(), EventHandler(), GameInput(), GetCancelJoy(), GetConfirmJoy(), GetLeftSelectJoy(), GetMenuJoy(), GetPauseJoy(), GetRightSelectJoy(), GetSwapJoy(), RestoreDefaultJoyButtons(), SetCancelJoy(), SetConfirmJoy(), SetLeftSelectJoy(), SetMenuJoy(), SetPauseJoy(), SetRightSelectJoy(), SetSwapJoy(), SingletonInitialize(), and ~GameInput().

private_input::KeyState hoa_input::GameInput::_key [private]

Holds the current user-defined key settings.

Definition at line 209 of file input.h.

Referenced by _KeyEventHandler(), _SetNewKey(), GetCancelKey(), GetCancelKeyName(), GetConfirmKey(), GetConfirmKeyName(), GetDownKey(), GetDownKeyName(), GetLeftKey(), GetLeftKeyName(), GetLeftSelectKey(), GetLeftSelectKeyName(), GetMenuKey(), GetMenuKeyName(), GetPauseKey(), GetPauseKeyName(), GetRightKey(), GetRightKeyName(), GetRightSelectKey(), GetRightSelectKeyName(), GetSwapKey(), GetSwapKeyName(), GetUpKey(), GetUpKeyName(), RestoreDefaultKeys(), SetCancelKey(), SetConfirmKey(), SetDownKey(), SetLeftKey(), SetLeftSelectKey(), SetMenuKey(), SetPauseKey(), SetRightKey(), SetRightSelectKey(), SetSwapKey(), SetUpKey(), and SingletonInitialize().

bool hoa_input::GameInput::_left_press [private]

Definition at line 243 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and LeftPress().

bool hoa_input::GameInput::_left_release [private]

Definition at line 259 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and LeftRelease().

bool hoa_input::GameInput::_left_select_press [private]

Definition at line 249 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), EventHandler(), GameInput(), and LeftSelectPress().

bool hoa_input::GameInput::_left_select_release [private]

Definition at line 265 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), EventHandler(), GameInput(), and LeftSelectRelease().

bool hoa_input::GameInput::_left_select_state [private]

Definition at line 233 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), GameInput(), and LeftSelectState().

bool hoa_input::GameInput::_left_state [private]

Definition at line 227 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and LeftState().

bool hoa_input::GameInput::_menu_press [private]

Definition at line 247 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), EventHandler(), GameInput(), and MenuPress().

bool hoa_input::GameInput::_menu_release [private]

Definition at line 263 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), EventHandler(), GameInput(), and MenuRelease().

bool hoa_input::GameInput::_menu_state [private]

Definition at line 231 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), GameInput(), and MenuState().

bool hoa_input::GameInput::_right_press [private]

Definition at line 244 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and RightPress().

bool hoa_input::GameInput::_right_release [private]

Definition at line 260 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and RightRelease().

bool hoa_input::GameInput::_right_select_press [private]

Definition at line 250 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), EventHandler(), GameInput(), and RightSelectPress().

bool hoa_input::GameInput::_right_select_release [private]

Definition at line 266 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), EventHandler(), GameInput(), and RightSelectRelease().

bool hoa_input::GameInput::_right_select_state [private]

Definition at line 234 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), GameInput(), and RightSelectState().

bool hoa_input::GameInput::_right_state [private]

Definition at line 228 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and RightState().

bool hoa_input::GameInput::_swap_press [private]

Definition at line 248 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), EventHandler(), GameInput(), and SwapPress().

bool hoa_input::GameInput::_swap_release [private]

Definition at line 264 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), EventHandler(), GameInput(), and SwapRelease().

bool hoa_input::GameInput::_swap_state [private]

Definition at line 232 of file input.h.

Referenced by _JoystickEventHandler(), _KeyEventHandler(), GameInput(), and SwapState().

bool hoa_input::GameInput::_up_press [private]

Definition at line 241 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and UpPress().

bool hoa_input::GameInput::_up_release [private]

Definition at line 257 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and UpRelease().

bool hoa_input::GameInput::_up_state [private]

Definition at line 225 of file input.h.

Referenced by _KeyEventHandler(), EventHandler(), GameInput(), and UpState().

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

Generated on Fri Jul 6 23:14:34 2007 for Hero of Allacrost by

1.5.1