Clarify is_action_pressed() for multiple assigned buttons by KoBeWi · Pull Request #30890 · godotengine/godot

KoBeWi · 2019-07-28T13:38:11Z

Supposed to resolve #30888

bojidar-bg · 2019-07-28T17:31:53Z

Would it be better to change the implementation of is_action_pressed to not release until all bound buttons are released?

Xrayez · 2019-07-29T06:38:29Z

Would it be better to change the implementation of is_action_pressed to not release until all bound buttons are released?

It would make such behavior in alignment according to my previous observations in other PR #30792 (comment). If people want the behavior described here, they could use is_action_just_pressed variant to achieve this?

akien-mga · 2019-07-29T22:07:46Z

I'll merge this for now as it properly describes the current behavior. Might be worth opening an issue to further discuss @bojidar-bg's proposal.

akien-mga · 2019-07-29T22:07:52Z

Thanks!

henriiquecampos · 2019-10-16T18:05:51Z

For anyone that reaches here and want this ~~expected~~ behavior for Input.is_action_pressed the work around I found for that is:

Add this to an AutoLoad

static func is_pressed(action):
	var is_pressed = false
	for event in InputMap.get_action_list(action):
		if event is InputEventKey:
			is_pressed = Input.is_key_pressed(event.scancode)
		elif event is InputEventJoypadButton:
			is_pressed = Input.is_joy_button_pressed(event.device, event.button_index)
		elif event is InputEventMouseButton:
			is_pressed = Input.is_mouse_button_pressed(event.button_index)
		elif event is InputEventJoypadMotion:
			is_pressed = Input.get_action_strength(action)
                #add more elif to treat the type accordingly
		else:
			continue
		
		if is_pressed:
			break
	return is_pressed

This allows an ActionNotifier to be pressed as long as one of the events that build up its action is still pressed, check godotengine/godot/pull/30890 for more

akien-mga · 2019-11-08T14:25:58Z

Cherry-picked for 3.1.2.

jitspoe · 2020-12-20T09:27:11Z

For anyone that reaches here and want this ~~expected~~ behavior for Input.is_action_pressed the work around I found for that is:

Add this to an AutoLoad

static func is_pressed(action):
	var is_pressed = false
	for event in InputMap.get_action_list(action):
		if event is InputEventKey:
			is_pressed = Input.is_key_pressed(event.scancode)
		elif event is InputEventJoypadButton:
			is_pressed = Input.is_joy_button_pressed(event.device, event.button_index)
		elif event is InputEventMouseButton:
			is_pressed = Input.is_mouse_button_pressed(event.button_index)
		elif event is InputEventJoypadMotion:
			is_pressed = Input.get_action_strength(action)
                #add more elif to treat the type accordingly
		else:
			continue
		
		if is_pressed:
			break
	return is_pressed

That seems like a good solution. Would be nice to have at the engine level to reduce script complexity.

Calinou · 2020-12-20T20:37:39Z

@jitspoe This should be discussed in a proposal 🙂

jitspoe · 2021-05-06T02:14:28Z

For anyone that reaches here and want this ~~expected~~ behavior for Input.is_action_pressed the work around I found for that is:

Add this to an AutoLoad

static func is_pressed(action):
	var is_pressed = false
	for event in InputMap.get_action_list(action):
		if event is InputEventKey:
			is_pressed = Input.is_key_pressed(event.scancode)
		elif event is InputEventJoypadButton:
			is_pressed = Input.is_joy_button_pressed(event.device, event.button_index)
		elif event is InputEventMouseButton:
			is_pressed = Input.is_mouse_button_pressed(event.button_index)
		elif event is InputEventJoypadMotion:
			is_pressed = Input.get_action_strength(action)
                #add more elif to treat the type accordingly
		else:
			continue
		
		if is_pressed:
			break
	return is_pressed

I've extended this a bit to properly check the input axis values (since get_action_strength fails when another key is pressed and released) and add radial deadzones (so diagonal controls work better), in case this is useful to anyone:

func is_pressed(action : String):
	var is_pressed := false
	for event in InputMap.get_action_list(action):
		if event is InputEventKey:
			is_pressed = Input.is_key_pressed(event.scancode)
		elif event is InputEventJoypadButton:
			is_pressed = Input.is_joy_button_pressed(event.device, event.button_index)
		elif event is InputEventMouseButton:
			is_pressed = Input.is_mouse_button_pressed(event.button_index)
		elif event is InputEventJoypadMotion:
			var axis : int = event.axis
			var axis_sign := sign(event.axis_value)
			var axis_val := Input.get_joy_axis(ControllerDevice, event.axis)# * axis_sign
			var axis_positive := axis_val * axis_sign
			var perpendicular_axis_val := 0.0
			if (axis == JOY_ANALOG_LX):
				perpendicular_axis_val = Input.get_joy_axis(ControllerDevice, JOY_ANALOG_LY)
			elif (axis == JOY_ANALOG_LY):
				perpendicular_axis_val = Input.get_joy_axis(ControllerDevice, JOY_ANALOG_LX)
			elif (axis == JOY_ANALOG_RX):
				perpendicular_axis_val = Input.get_joy_axis(ControllerDevice, JOY_ANALOG_RY)
			elif (axis == JOY_ANALOG_RY):
				perpendicular_axis_val = Input.get_joy_axis(ControllerDevice, JOY_ANALOG_RX)
			var value_2d := Vector2(axis_val, perpendicular_axis_val)
			var length := value_2d.length()
			if (length > ControllerDeadzone):
				var deadzone := (value_2d.normalized() * ControllerDeadzone).x  # Circular deadzone
				var wedge_deadzone := 0.4142135623730950488016887242097 * abs(perpendicular_axis_val) # 1 / tan(3/4 90 degrees).  The slope of 1/8 of a circle
				if (wedge_deadzone > deadzone):
					deadzone = wedge_deadzone
				if (axis_positive > deadzone):
					is_pressed = true
		else:
			continue
		if is_pressed:
			break
	return is_pressed

Note: Can't be a static function anymore (unless the deadzone value and controller ID are passed in).

sicienss · 2021-12-11T21:05:23Z

Thank you for this workaround.

I believe this should be the intended functionality in Godot, rather than what is currently there.

Just consider the common use case of creating an action for "move_right", which devs will typically poll with Input.get_action_pressed("move_right").

On Godot's current way of doing things, if player accidentally touches d-pad right when primarily using analog stick right, or vice versa, the polling of the method is bound to return false, and suddenly player has no input until they release and repress.

Calinou · 2021-12-11T21:06:02Z

On Godot's current way of doing things, if player accidentally touches d-pad right when primarily using analog stick right, or vice versa, the polling of the method is bound to return false, and suddenly player has no input until they release and repress.

This should be addressed by #47599 if it's merged.

afk-mario · 2022-09-16T19:09:56Z

For anyone that reaches here and want this ~~expected~~ behavior for Input.is_action_pressed the work around I found for that is:
Add this to an AutoLoad

static func is_pressed(action):
	var is_pressed = false
	for event in InputMap.get_action_list(action):
		if event is InputEventKey:
			is_pressed = Input.is_key_pressed(event.scancode)
		elif event is InputEventJoypadButton:
			is_pressed = Input.is_joy_button_pressed(event.device, event.button_index)
		elif event is InputEventMouseButton:
			is_pressed = Input.is_mouse_button_pressed(event.button_index)
		elif event is InputEventJoypadMotion:
			is_pressed = Input.get_action_strength(action)
                #add more elif to treat the type accordingly
		else:
			continue
		
		if is_pressed:
			break
	return is_pressed

I've extended this a bit to properly check the input axis values (since get_action_strength fails when another key is pressed and released) and add radial deadzones (so diagonal controls work better), in case this is useful to anyone:

func is_pressed(action : String):
	var is_pressed := false
	for event in InputMap.get_action_list(action):
		if event is InputEventKey:
			is_pressed = Input.is_key_pressed(event.scancode)
		elif event is InputEventJoypadButton:
			is_pressed = Input.is_joy_button_pressed(event.device, event.button_index)
		elif event is InputEventMouseButton:
			is_pressed = Input.is_mouse_button_pressed(event.button_index)
		elif event is InputEventJoypadMotion:
			var axis : int = event.axis
			var axis_sign := sign(event.axis_value)
			var axis_val := Input.get_joy_axis(ControllerDevice, event.axis)# * axis_sign
			var axis_positive := axis_val * axis_sign
			var perpendicular_axis_val := 0.0
			if (axis == JOY_ANALOG_LX):
				perpendicular_axis_val = Input.get_joy_axis(ControllerDevice, JOY_ANALOG_LY)
			elif (axis == JOY_ANALOG_LY):
				perpendicular_axis_val = Input.get_joy_axis(ControllerDevice, JOY_ANALOG_LX)
			elif (axis == JOY_ANALOG_RX):
				perpendicular_axis_val = Input.get_joy_axis(ControllerDevice, JOY_ANALOG_RY)
			elif (axis == JOY_ANALOG_RY):
				perpendicular_axis_val = Input.get_joy_axis(ControllerDevice, JOY_ANALOG_RX)
			var value_2d := Vector2(axis_val, perpendicular_axis_val)
			var length := value_2d.length()
			if (length > ControllerDeadzone):
				var deadzone := (value_2d.normalized() * ControllerDeadzone).x  # Circular deadzone
				var wedge_deadzone := 0.4142135623730950488016887242097 * abs(perpendicular_axis_val) # 1 / tan(3/4 90 degrees).  The slope of 1/8 of a circle
				if (wedge_deadzone > deadzone):
					deadzone = wedge_deadzone
				if (axis_positive > deadzone):
					is_pressed = true
		else:
			continue
		if is_pressed:
			break
	return is_pressed

Note: Can't be a static function anymore (unless the deadzone value and controller ID are passed in).

For some reason this didn't work with my keyboard but I added the physical_scancode and it worked

...
if event is InputEventKey:
    is_pressed = Input.is_key_pressed(event.scancode) or Input.is_key_pressed(event.physical_scancode)
...

Benpaste · 2022-09-27T15:29:32Z

Hey, I'm trying to use this extended is_pressed() function, but Godot complains about ControllerDevice not being defined.
Could anyone provide some assistance/explanation?

Clarify is_action_pressed() for multiple assigned buttons

7e329a7

KoBeWi requested a review from a team as a code owner July 28, 2019 13:38

akien-mga added documentation enhancement labels Jul 29, 2019

akien-mga added this to the 3.2 milestone Jul 29, 2019

akien-mga added the cherrypick:3.1 label Jul 29, 2019

akien-mga merged commit 14e3d29 into godotengine:master Jul 29, 2019

KoBeWi deleted the how_to_action branch July 29, 2019 22:32

akien-mga removed the cherrypick:3.1 label Nov 8, 2019

madmiraal mentioned this pull request Feb 21, 2021

Movement doesn't work as expected when mapping keys and axes to the same action #45628

Closed

madmiraal mentioned this pull request Apr 3, 2021

Correctly support multiple events mapped to a single action #47599

Closed

jitspoe mentioned this pull request May 7, 2021

Input.is_action_pressed() inconsistent for multiple key bindings #30888

Closed

Sauermann mentioned this pull request Aug 21, 2023

Fix action state when multiple events are assigned #80859

Merged

Uh oh!

Conversation

KoBeWi commented Jul 28, 2019

Uh oh!

bojidar-bg commented Jul 28, 2019

Uh oh!

Xrayez commented Jul 29, 2019

Uh oh!

akien-mga commented Jul 29, 2019

Uh oh!

akien-mga commented Jul 29, 2019

Uh oh!

henriiquecampos commented Oct 16, 2019 • edited by Calinou Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akien-mga commented Nov 8, 2019

Uh oh!

jitspoe commented Dec 20, 2020 • edited by Calinou Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Calinou commented Dec 20, 2020

Uh oh!

jitspoe commented May 6, 2021 • edited by Calinou Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sicienss commented Dec 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Calinou commented Dec 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

afk-mario commented Sep 16, 2022

Uh oh!

Benpaste commented Sep 27, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

henriiquecampos commented Oct 16, 2019 •

edited by Calinou

Loading

jitspoe commented Dec 20, 2020 •

edited by Calinou

Loading

jitspoe commented May 6, 2021 •

edited by Calinou

Loading

sicienss commented Dec 11, 2021 •

edited

Loading

Calinou commented Dec 11, 2021 •

edited

Loading