Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Implement input action duration #36460

Closed
wants to merge 1 commit into from
Closed

Implement input action duration #36460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions core/input/input.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ void Input::_bind_methods() {
ClassDB::bind_method(D_METHOD("is_action_just_pressed", "action"), &Input::is_action_just_pressed);
ClassDB::bind_method(D_METHOD("is_action_just_released", "action"), &Input::is_action_just_released);
ClassDB::bind_method(D_METHOD("get_action_strength", "action"), &Input::get_action_strength);
ClassDB::bind_method(D_METHOD("get_action_duration", "action"), &Input::get_action_duration);
ClassDB::bind_method(D_METHOD("add_joy_mapping", "mapping", "update_existing"), &Input::add_joy_mapping, DEFVAL(false));
ClassDB::bind_method(D_METHOD("remove_joy_mapping", "guid"), &Input::remove_joy_mapping);
ClassDB::bind_method(D_METHOD("joy_connection_changed", "device", "connected", "name", "guid"), &Input::joy_connection_changed);
Expand Down Expand Up @@ -326,6 +327,13 @@ float Input::get_action_strength(const StringName &p_action) const {
return E->get().strength;
}

float Input::get_action_duration(const StringName &p_action) const {
const Map<StringName, Action>::Element *E = action_state.find(p_action);
if (!E)
return 0.0f;
return (OS::get_singleton()->get_ticks_usec() - E->get().timestamp) / 1000000.0f;
}

float Input::get_joy_axis(int p_device, int p_axis) const {
_THREAD_SAFE_METHOD_
int c = _combine_device(p_axis, p_device);
Expand Down Expand Up @@ -602,6 +610,7 @@ void Input::_parse_input_event_impl(const Ref<InputEvent> &p_event, bool p_is_em
Action action;
action.physics_frame = Engine::get_singleton()->get_physics_frames();
action.idle_frame = Engine::get_singleton()->get_idle_frames();
action.timestamp = OS::get_singleton()->get_ticks_usec();
action.pressed = p_event->is_action_pressed(E->key());
action.strength = 0.f;
action_state[E->key()] = action;
Expand Down
2 changes: 2 additions & 0 deletions core/input/input.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ class Input : public Object {
struct Action {
uint64_t physics_frame;
uint64_t idle_frame;
uint64_t timestamp;
bool pressed;
float strength;
};
Expand Down Expand Up @@ -266,6 +267,7 @@ class Input : public Object {
bool is_action_just_pressed(const StringName &p_action) const;
bool is_action_just_released(const StringName &p_action) const;
float get_action_strength(const StringName &p_action) const;
float get_action_duration(const StringName &p_action) const;

float get_joy_axis(int p_device, int p_axis) const;
String get_joy_name(int p_idx);
Expand Down
21 changes: 21 additions & 0 deletions doc/classes/Input.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,27 @@
Note this method returns an empty [Vector3] when running from the editor even when your device has an accelerometer. You must export your project to a supported device to read values from the accelerometer.
</description>
</method>
<method name="get_action_duration" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="action" type="StringName">
</argument>
<description>
Returns the time in seconds for how long the given action has been pressed or kept in the released state. It means that the time resets to [code]0.0[/code] whenever the action's [code]pressed[/code] state is changed. Use [method is_action_pressed] to distinguish between pressed and released durations.
[b]Note:[/b] if the action has not been pressed nor released during the game at all, the method returns [code]0.0[/code] instead.
Example usage of implementing weapon charging mechanics:
[codeblock]
const CHARGE_TIME = 1.0
var shooting = false

func _physics_process(_delta):
if Input.is_action_pressed("shoot"):
shooting = Input.get_action_duration("shoot") >= CHARGE_TIME
else:
shooting = false
[/codeblock]
</description>
</method>
<method name="get_action_strength" qualifiers="const">
<return type="float">
</return>
Expand Down