CursorInputSettings

AUTO-GENERATED FILE – DO NOT EDIT MANUALLY

This page documents the supported public API surface only. Private, internal, benchmark, test, and implementation-detail types are intentionally omitted.

Declaration

1

public partial class CursorInputSettings : Resource

Summary

Resource that defines input action names for cursor movement. Can be configured per-scene or project-wide.

Metadata

Namespace: GridPlacement.Godot.Cursor

Source File: cs/Godot/addons/GridPlacement/Services/Cursor/CursorInputSettings.cs

Assembly: GridPlacement.Godot

Type: class

Inherits

• Resource

Constructors

CursorInputSettings

1

public CursorInputSettings()

Creates a default cursor input settings.

CursorInputSettings

1
2
3
4
5
6
7
8

public CursorInputSettings(
    StringName upAction,
    StringName downAction,
    StringName leftAction,
    StringName rightAction,
    StringName? confirmAction = null,
    StringName? cancelAction = null
)

Creates cursor input settings with custom action names.

Properties

UpAction

1

public StringName UpAction { get; set; }

Input action for moving the cursor up.

DownAction

1

public StringName DownAction { get; set; }

Input action for moving the cursor down.

LeftAction

1

public StringName LeftAction { get; set; }

Input action for moving the cursor left.

RightAction

1

public StringName RightAction { get; set; }

Input action for moving the cursor right.

ConfirmAction

1

public StringName ConfirmAction { get; set; }

Input action for confirming/clicking at cursor position.

CancelAction

1

public StringName CancelAction { get; set; }

Input action for canceling/back at cursor position.

EnableMouseInput

1

public bool EnableMouseInput { get; set; }

Whether to enable mouse/touch input for cursor movement.

EnableDirectionalInput

1

public bool EnableDirectionalInput { get; set; }

Whether to enable keyboard/gamepad directional input.

GridCellSize

1

public Vector2I GridCellSize { get; set; }

The grid cell size for snapping cursor to grid.

RepeatDelay

1

public float RepeatDelay { get; set; }

Delay in seconds between repeated cursor movements when holding a direction.

InitialRepeatDelay

1

public float InitialRepeatDelay { get; set; }

Initial delay before repeating starts when holding a direction.

Default

1

public static CursorInputSettings Default { get; }

Gets the default settings using Godot’s built-in UI actions.

CursorDirActions

1

public static CursorInputSettings CursorDirActions { get; }

Gets settings using custom cursor_dir actions.