Polyphase Game Engine
Loading...
Searching...
No Matches
PlayerInputSystem.h
Go to the documentation of this file.
1#pragma once
2
3#include "InputTypes.h"
4#include "PolyphaseAPI.h"
5
6// Native addons can query input actions (Get / IsActionActive / WasActionJustActivated /
7// WasActionJustDeactivated / GetActions are exported); test this before using them.
8#define POLYPHASE_PLAYER_INPUT_EXPORTED 1
9
10#include <string>
11#include <vector>
12#include <unordered_map>
13#include <stdint.h>
14
15enum class InputSourceType : uint8_t
16{
22};
23
24enum class InputDeviceKind : uint8_t
25{
27 Mouse,
28 Gamepad,
29
30 Count
31};
32
34{
36 int32_t gamepadIndex = -1; // valid only when kind == Gamepad
37 GamepadType gamepadType = GamepadType::Standard; // valid only when kind == Gamepad
38};
39
40enum class AxisDirection : uint8_t
41{
44 Full
45};
46
47enum class TriggerMode : uint8_t
48{
50 Hold,
53};
54
66
74
76{
77 bool isActive = false;
78 bool wasJustActivated = false;
79 bool wasJustDeactivated = false;
80 float value = 0.0f;
81
82 // Internal tracking
83 bool rawDown = false;
84 bool prevRawDown = false;
85 float holdTimer = 0.0f;
86 bool holdTriggered = false;
87 int32_t pressCount = 0;
88 float multiPressTimer = 0.0f;
89};
90
92{
93 std::string name;
94 std::string category;
95 std::vector<InputActionBinding> bindings;
98};
99
101{
102public:
103
104 static void Create();
105 static void Destroy();
107
108 void Update(float deltaTime);
109
110 // Registration
111 void RegisterAction(const std::string& category, const std::string& name,
113 void UnregisterAction(const std::string& category, const std::string& name);
114 void AddBinding(const std::string& category, const std::string& name,
115 const InputActionBinding& binding);
116 void ClearBindings(const std::string& category, const std::string& name);
117 void SetTrigger(const std::string& category, const std::string& name,
118 const InputActionTrigger& trigger);
119
120 // Queries (playerIndex: -1 = any, 0-3 = specific gamepad/pointer)
121 POLYPHASE_API bool IsActionActive(const std::string& category, const std::string& name, int32_t playerIndex = -1) const;
122 POLYPHASE_API bool WasActionJustActivated(const std::string& category, const std::string& name, int32_t playerIndex = -1) const;
123 POLYPHASE_API bool WasActionJustDeactivated(const std::string& category, const std::string& name, int32_t playerIndex = -1) const;
124 float GetActionValue(const std::string& category, const std::string& name, int32_t playerIndex = -1) const;
125
126 // Connected players
127 int32_t GetPlayersConnected() const;
128
129 // Bulk access (for editor/debugger)
130 POLYPHASE_API const std::vector<InputAction>& GetActions() const;
131 InputAction* FindAction(const std::string& category, const std::string& name);
132 const InputAction* FindAction(const std::string& category, const std::string& name) const;
133
134 // Serialization
135 void SaveProjectActions();
136 void LoadProjectActions();
137
138 // Replace the in-memory action set wholesale (used by the editor when
139 // opening a specific InputActionsAsset). Rebuilds the lookup table.
140 void SetActions(const std::vector<InputAction>& actions);
141
142 // Enable/disable
143 void SetEnabled(bool enabled);
144 bool IsEnabled() const;
145
146 // Last-active input device. Updated each Update() based on edge-triggered
147 // input. Consumers (e.g. InputPromptResolver) compare GetDeviceChangeFrame()
148 // against a cached epoch to know when to re-resolve.
149 //
150 // If a forced device is set via SetForcedDevice(), GetLastActiveDevice
151 // returns the forced descriptor instead of the auto-detected one. The
152 // change-frame counter bumps whenever the forced device is set, changed,
153 // or cleared, so InputPromptResolver flushes its cache and every widget
154 // immediately reflects the override.
156 uint32_t GetDeviceChangeFrame() const;
157
158 // Editor-only force-device override. Used by the InputPromptMapInspector's
159 // Test Device combobox so an artist can preview "what does the Gamepad.A
160 // prompt look like on DualSense?" without unplugging real controllers.
161 // Pass nullptr (or call ClearForcedDevice) to resume real auto-detection.
162 void SetForcedDevice(const InputDeviceDescriptor& device);
163 void ClearForcedDevice();
164 bool HasForcedDevice() const;
165
166 // Editor capture modal mute gate. While disabled, Update() still tracks the
167 // last-active device and clears per-frame edge flags, but action evaluation
168 // is skipped so a captured key doesn't also fire a registered game action.
169 void SetActionEvaluationEnabled(bool enabled);
170 bool AreInputActionsActive() const;
171
172private:
173
174 static PlayerInputSystem* sInstance;
175
177
178 bool PollBindingDown(const InputActionBinding& binding, int32_t playerIndex = -1) const;
179 float PollBindingValue(const InputActionBinding& binding, int32_t playerIndex = -1) const;
180 bool PollActionRawDown(const InputAction& action, int32_t playerIndex = -1) const;
181 float PollActionRawValue(const InputAction& action, int32_t playerIndex = -1) const;
182 bool CheckModifiers(const InputActionBinding& binding) const;
183 void EvaluateTrigger(InputAction& action, float deltaTime);
184
185 std::string MakeKey(const std::string& category, const std::string& name) const;
186 bool LoadFromJsonFile(const std::string& filePath);
187 void RebuildLookup();
188
189 void UpdateLastActiveDevice();
190
191 std::vector<InputAction> mActions;
192 std::unordered_map<std::string, size_t> mActionLookup;
193 bool mEnabled = true;
194 bool mActionEvaluationEnabled = true;
195
196 InputDeviceDescriptor mLastActiveDevice;
197 uint32_t mDeviceChangeFrame = 0;
198 uint32_t mFrameCounter = 0;
199
200 InputDeviceDescriptor mForcedDevice;
201 bool mHasForcedDevice = false;
202};
bool Update()
Definition Engine.cpp:1023
GamepadType
Definition InputTypes.h:27
InputDeviceKind
Definition PlayerInputSystem.h:25
AxisDirection
Definition PlayerInputSystem.h:41
InputSourceType
Definition PlayerInputSystem.h:16
TriggerMode
Definition PlayerInputSystem.h:48
Export macros for Polyphase Engine symbols.
#define POLYPHASE_API
Definition PolyphaseAPI.h:31
Definition PlayerInputSystem.h:101
void SetEnabled(bool enabled)
Definition PlayerInputSystem.cpp:702
void SetActions(const std::vector< InputAction > &actions)
Definition PlayerInputSystem.cpp:807
void RegisterAction(const std::string &category, const std::string &name, TriggerMode mode=TriggerMode::SinglePress)
Definition PlayerInputSystem.cpp:553
void ClearForcedDevice()
Definition PlayerInputSystem.cpp:476
bool AreInputActionsActive() const
Definition PlayerInputSystem.cpp:495
void SetForcedDevice(const InputDeviceDescriptor &device)
Definition PlayerInputSystem.cpp:461
void SetTrigger(const std::string &category, const std::string &name, const InputActionTrigger &trigger)
Definition PlayerInputSystem.cpp:602
void UnregisterAction(const std::string &category, const std::string &name)
Definition PlayerInputSystem.cpp:571
void AddBinding(const std::string &category, const std::string &name, const InputActionBinding &binding)
Definition PlayerInputSystem.cpp:583
bool HasForcedDevice() const
Definition PlayerInputSystem.cpp:485
const InputDeviceDescriptor & GetLastActiveDevice() const
Definition PlayerInputSystem.cpp:451
void LoadProjectActions()
Definition PlayerInputSystem.cpp:838
POLYPHASE_API bool WasActionJustActivated(const std::string &category, const std::string &name, int32_t playerIndex=-1) const
Definition PlayerInputSystem.cpp:626
int32_t GetPlayersConnected() const
Definition PlayerInputSystem.cpp:664
POLYPHASE_API bool IsActionActive(const std::string &category, const std::string &name, int32_t playerIndex=-1) const
Definition PlayerInputSystem.cpp:614
bool IsEnabled() const
Definition PlayerInputSystem.cpp:703
void SaveProjectActions()
Definition PlayerInputSystem.cpp:813
void ClearBindings(const std::string &category, const std::string &name)
Definition PlayerInputSystem.cpp:593
POLYPHASE_API bool WasActionJustDeactivated(const std::string &category, const std::string &name, int32_t playerIndex=-1) const
Definition PlayerInputSystem.cpp:642
uint32_t GetDeviceChangeFrame() const
Definition PlayerInputSystem.cpp:456
InputAction * FindAction(const std::string &category, const std::string &name)
Definition PlayerInputSystem.cpp:682
POLYPHASE_API const std::vector< InputAction > & GetActions() const
Definition PlayerInputSystem.cpp:677
float GetActionValue(const std::string &category, const std::string &name, int32_t playerIndex=-1) const
Definition PlayerInputSystem.cpp:653
void SetActionEvaluationEnabled(bool enabled)
Definition PlayerInputSystem.cpp:490
static void Create()
Definition PlayerInputSystem.cpp:23
static void Destroy()
Definition PlayerInputSystem.cpp:29
static POLYPHASE_API PlayerInputSystem * Get()
Definition PlayerInputSystem.cpp:38
Definition PlayerInputSystem.h:56
AxisDirection axisDirection
Definition PlayerInputSystem.h:59
InputSourceType sourceType
Definition PlayerInputSystem.h:57
float axisThreshold
Definition PlayerInputSystem.h:60
bool requireCtrl
Definition PlayerInputSystem.h:62
bool requireAlt
Definition PlayerInputSystem.h:64
bool requireShift
Definition PlayerInputSystem.h:63
int32_t code
Definition PlayerInputSystem.h:58
int32_t gamepadIndex
Definition PlayerInputSystem.h:61
Definition PlayerInputSystem.h:76
bool isActive
Definition PlayerInputSystem.h:77
int32_t pressCount
Definition PlayerInputSystem.h:87
bool holdTriggered
Definition PlayerInputSystem.h:86
float holdTimer
Definition PlayerInputSystem.h:85
bool wasJustActivated
Definition PlayerInputSystem.h:78
bool wasJustDeactivated
Definition PlayerInputSystem.h:79
float value
Definition PlayerInputSystem.h:80
float multiPressTimer
Definition PlayerInputSystem.h:88
bool prevRawDown
Definition PlayerInputSystem.h:84
bool rawDown
Definition PlayerInputSystem.h:83
Definition PlayerInputSystem.h:68
float multiPressWindow
Definition PlayerInputSystem.h:72
TriggerMode mode
Definition PlayerInputSystem.h:69
int32_t multiPressCount
Definition PlayerInputSystem.h:71
float holdDuration
Definition PlayerInputSystem.h:70
Definition PlayerInputSystem.h:92
std::vector< InputActionBinding > bindings
Definition PlayerInputSystem.h:95
InputActionState state
Definition PlayerInputSystem.h:97
InputActionTrigger trigger
Definition PlayerInputSystem.h:96
std::string name
Definition PlayerInputSystem.h:93
std::string category
Definition PlayerInputSystem.h:94
Definition PlayerInputSystem.h:34
GamepadType gamepadType
Definition PlayerInputSystem.h:37
InputDeviceKind kind
Definition PlayerInputSystem.h:35
int32_t gamepadIndex
Definition PlayerInputSystem.h:36