Input on Godot 4 レシピ

Input Actions

Mon, 01 Jan 0001 00:00:00 +0000

Tip

This article is being updated from Godot 3 to Godot 4.

Problem

You want to understand Godot’s “input action” system.

Solution

Let’s say you’re making a top-down character and you write code using InputActionKey that uses the arrow keys for movement. You’ll quickly find that many players prefer to use “WASD” style controls. You can go back into your code and add the additional key checks, but this would result in duplicated/redundant code.

Mouse Input

Mon, 01 Jan 0001 00:00:00 +0000

Problem

You want to detect mouse input.

Solution

InputEventMouse is the base class for mouse events. It contains position and global_position properties. Inheriting from it are two classes: InputEventMouseButton and InputEventMouseMotion.

Note

You can assign mouse button events in the InputMap, so you can use them with is_action_pressed().

`InputEventMouseButton`

@GlobalScope.ButtonList contains a list of BUTTON_* constants for each possible button, which will be reported in the event’s button_index property. Note that the scrollwheel also counts as a button - two buttons, to be precise, with both BUTTON_WHEEL_UP and BUTTON_WHEEL_DOWN being separate events.

Adding Input Actions in code

Mon, 01 Jan 0001 00:00:00 +0000

Problem

You need to add actions to the InputMap at runtime.

Solution

Typically, you’ll add actions to the InputMap via Project Settings, as shown in Recipe: Input Actions. However, you may find yourself needing to add one or more actions directly in a script. The InputMap singleton has methods to help you do this.

Here’s an example that would add a new action called “attack” using the space key:

func _ready():
 InputMap.add_action("attack")
 var ev = InputEventKey.new()
 ev.keycode = KEY_SPACE
 InputMap.action_add_event("attack", ev)

If you also wanted to add the left mouse button to the same action:

Capturing the Mouse

Mon, 01 Jan 0001 00:00:00 +0000

Problem

You want to hide the mouse cursor and keep the mouse from leaving the game window. This is common in many 3D games (and some 2D ones).

Solution

You can set the mouse state using Input.mouse_mode. There are four possible mouse modes:

MOUSE_MODE_VISIBLE: The mouse is visible and can move freely into and out of the window. This is the default state.
MOUSE_MODE_HIDDEN: The mouse cursor is invisible, but the mouse can still move outside the window.

Customizing the Mouse Cursor

Mon, 01 Jan 0001 00:00:00 +0000

Tip

This article is being updated from Godot 3 to Godot 4.

Problem

You want to use a custom mouse cursor.

Solution

Setting the mouse cursor is done with Input.set_custom_mouse_cursor(). All you need is a texture to use. The texture must be no larger than 256x256 pixels in size.

For example, to use the following image:

And set its hotspot to the center:

Mouse: Drag-select multiple units

Mon, 01 Jan 0001 00:00:00 +0000

Problem

You want to click-and-drag to select multiple units, RTS style.

Solution

Realtime strategy (RTS) games often require giving orders to many units at once. A typical style of selecting multiple units is to click-and-drag a box around them. Once the units are selected, clicking on the map commands them to move.

Here’s an example of what we’re going for:

Unit setup

To test this out, we’ll need some basic RTS-style units. They are set up to move towards a target and to avoid running into each other. We won’t go into too much detail on them in this tutorial. The unit script is commented if you’d like to use it as a base for creating your own RTS units. See below for a link to download the project.