in_game_controls_layout Class Reference

The layout for the controls in the game. More...

#include <in_game_controls_layout.h>

Public Member Functions
	in_game_controls_layout (const screen_rect &r=screen_rect(screen_coordinate(0, 0), screen_coordinate(64 *3, 64 *7)))
const screen_rect &	get_background () const noexcept
	The background.
const screen_rect &	get_action_key_symbol (const action_number &n) const noexcept
	The symbol for the key of that action.
const screen_rect &	get_action_key_text (const action_number &n) const noexcept
	The text of what that action does.

Detailed Description

The layout for the controls in the game.

+--------------+
|     +---+    |
|     |Up |    |
| +---+---+---+|
| |Lft|Dwn|Rgt||
| +---+---+---+|
+---+----------+
|AK1|Text1     |
+---+----------+
|AK2|Text2     |
+---+----------+
|AK3|Text3     |
+---+----------+
|AK4|Text4     |
+---+----------+

Constructor & Destructor Documentation

in_game_controls_layout()

in_game_controls_layout::in_game_controls_layout

(

const screen_rect &

r = screen_rect(screen_coordinate(0, 0), screen_coordinate(64 * 3, 64 * 7))

)

Member Function Documentation

get_action_key_symbol()

const screen_rect & in_game_controls_layout::get_action_key_symbol ( const action_number &  n ) const

noexcept

The symbol for the key of that action.

For example, the symbol for the key Q or LMB.

The AK1 in this image:

+---+----------+
|AK1|Text1     |
+---+----------+

get_action_key_text()

const screen_rect & in_game_controls_layout::get_action_key_text ( const action_number &  n ) const

noexcept

The text of what that action does.

For example 'select', 'attack', etc.

The Text1 in this image:

+---+----------+
|AK1|Text1     |
+---+----------+

get_background()

const screen_rect & in_game_controls_layout::get_background ( ) const

inlinenoexcept

The background.

---

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

• include/in_game_controls_layout.h
• src/in_game_controls_layout.cpp