Skip to content

Clarify ignoring joypads on unfocused application via project settings #11680

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

Open
Nintorch wants to merge 2 commits into
base: master
Choose a base branch
from
+3 −38
Open

Clarify ignoring joypads on unfocused application via project settings #11680

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6bac36
Clarify ignoring joypads on unfocused application
Nintorch Jan 26, 2026
10e500f
Small grammar fix on controllers tutorial page
Nintorch Jan 26, 2026
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
41 changes: 3 additions & 38 deletions tutorials/inputs/controllers_gamepads_joysticks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,51 +222,16 @@ with the help of a :ref:`class_Timer` node.
Window focus
~~~~~~~~~~~~

Unlike keyboard input, controller inputs can be seen by **all** windows on the
Unlike keyboard input, controller inputs can by default be seen by **all** windows on the
operating system, including unfocused windows.

While this is useful for
`third-party split screen functionality <https://nucleus-coop.github.io/>`__,
it can also have adverse effects. Players may accidentally send controller inputs
to the running project while interacting with another window.

If you wish to ignore events when the project window isn't focused, you will
need to create an :ref:`autoload <doc_singletons_autoload>` called ``Focus``
with the following script and use it to check all your inputs:

::

# Focus.gd
extends Node

var focused := true

func _notification(what: int) -> void:
match what:
NOTIFICATION_APPLICATION_FOCUS_OUT:
focused = false
NOTIFICATION_APPLICATION_FOCUS_IN:
focused = true


func input_is_action_pressed(action: StringName) -> bool:
if focused:
return Input.is_action_pressed(action)

return false


func event_is_action_pressed(event: InputEvent, action: StringName) -> bool:
if focused:
return event.is_action_pressed(action)

return false

Then, instead of using ``Input.is_action_pressed(action)``, use
``Focus.input_is_action_pressed(action)`` where ``action`` is the name of
the input action. Also, instead of using ``event.is_action_pressed(action)``,
use ``Focus.event_is_action_pressed(event, action)`` where ``event`` is an
InputEvent reference and ``action`` is the name of the input action.
If you wish to ignore controller input events when the project isn't focused,
set :ref:`ProjectSettings.input_devices/config/ignore_joypad_on_unfocused_application<class_ProjectSettings_property_input_devices/config/ignore_joypad_on_unfocused_application>` to ``true``.

Power saving prevention
~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading