1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/* Command.h
Copyright (c) 2015 by Michael Zahniser
Endless Sky is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.
Endless Sky is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
*/
#pragma once
#include <cstdint>
#include <filesystem>
#include <string>
class DataNode;
// Class mapping key presses to specific commands / actions. The player can
// change the mappings for most of these keys in the preferences panel.
// A single Command object can represent multiple individual commands, e.g.
// everything the AI wants a ship to do, or all keys the player is holding down.
class Command {
public:
// Empty command:
static const Command NONE;
// Main menu:
static const Command MENU;
// Ship controls:
static const Command FORWARD;
static const Command LEFT;
static const Command RIGHT;
static const Command AUTOSTEER;
static const Command BACK;
static const Command MOUSE_TURNING_HOLD;
static const Command AIM_TURRET_HOLD;
static const Command PRIMARY;
static const Command TURRET_TRACKING;
static const Command SECONDARY;
static const Command SELECT;
static const Command LAND;
static const Command BOARD;
static const Command HAIL;
static const Command SCAN;
static const Command JUMP;
static const Command FLEET_JUMP;
static const Command TARGET;
static const Command NEAREST;
static const Command NEAREST_ASTEROID;
static const Command DEPLOY;
static const Command AFTERBURNER;
static const Command CLOAK;
// UI controls:
static const Command MAP;
static const Command INFO;
static const Command MESSAGE_LOG;
static const Command FULLSCREEN;
static const Command FASTFORWARD;
static const Command HELP;
static const Command PAUSE;
// Escort commands:
static const Command FIGHT;
static const Command HOLD_FIRE;
static const Command GATHER;
static const Command HOLD_POSITION;
static const Command AMMO;
static const Command HARVEST;
// This command is given in combination with JUMP or LAND and tells a ship
// not to jump or land yet even if it is in position to do so. It can be
// given from the AI when a ship is waiting for its parent. It can also be
// given from the player/input engine when the player is preparing his/her
// fleet for jumping or to indicate that the player is switching landing
// targets. (There is no explicit key mapped to this command.)
static const Command WAIT;
// This command from the AI tells a ship that if possible, it should apply
// less than its full thrust in order to come to a complete stop.
static const Command STOP;
// Modifier command, usually triggered by shift-key. Changes behavior of
// other commands like NEAREST, TARGET, HAIL and BOARD.
static const Command SHIFT;
public:
// In the given text, replace any instances of command names (in angle
// brackets) with key names (in quotes).
static std::string ReplaceNamesWithKeys(const std::string &text);
public:
Command() = default;
// Create a command representing whatever command is mapped to the given
// keycode (if any).
explicit Command(int keycode);
// Read the current keyboard state and set this object to reflect it.
void ReadKeyboard();
// Load or save the keyboard preferences.
static void LoadSettings(const std::filesystem::path &path);
static void SaveSettings(const std::filesystem::path &path);
static void SetKey(Command command, int keycode);
// Get the description or keycode name for this command. If this command is
// a combination of more than one command, an empty string is returned.
const std::string &Description() const;
const std::string &KeyName() const;
bool HasBinding() const;
bool HasConflict() const;
// Load this command from an input file (for testing or scripted missions).
void Load(const DataNode &node);
// Reset this to an empty command.
void Clear();
// Clear, set, or check the given bits. This ignores the turn field.
void Clear(Command command);
void Set(Command command);
bool Has(Command command) const;
// Get the commands that are set in this and in the given command.
Command And(Command command) const;
// Get the commands that are set in this and not in the given command.
Command AndNot(Command command) const;
// Get or set the turn amount. The amount must be between -1 and 1, but it
// can be a fractional value to allow finer control.
void SetTurn(double amount);
double Turn() const;
// Check if any bits are set in this command (including a nonzero turn).
explicit operator bool() const;
bool operator!() const;
// This operator is just provided to allow commands to be used in a map.
bool operator<(const Command &command) const;
// Get the commands that are set in either of these commands.
Command operator|(const Command &command) const;
Command &operator|=(const Command &command);
private:
explicit Command(uint64_t state);
Command(uint64_t state, const std::string &text);
private:
// The key commands are stored in a single bitmask with
// 64 bits for key commands.
uint64_t state = 0;
// Turning amount is stored as a separate double to allow fractional values.
double turn = 0.;
};
|
