Grid Placement
Development ⚠️ GridPlacement 6.0 (GECS) is in active development. This is the GDScript ECS architecture.

CursorComponent

AUTO-GENERATED (GDScript) API entry

AUTO-GENERATED FILE — DO NOT EDIT MANUALLY

Source: components/ui/cursor_component.gd

Version: 6.0

class_name: CursorComponent extends: Component

Signals

(none)

Exports

  • cursor_type: CursorType = CursorType.DEFAULT
    • Custom cursor texture
    • Custom cursor hotspot
    • Cursor modes for different states
  • custom_cursor_texture: Texture2D
    • Custom cursor hotspot
    • Cursor modes for different states
  • custom_hotspot: Vector2 = Vector2.ZERO
    • Cursor modes for different states
  • cursor_mode: CursorMode = CursorMode.NORMAL
    • Auto-switch cursors based on context
    • Cursor animation settings
    • Mode to cursor type mapping
    • Initialize cursor changer with data
  • auto_switch: bool = true
    • Cursor animation settings
    • Mode to cursor type mapping
    • Initialize cursor changer with data
  • enable_animation: bool = false
    • Mode to cursor type mapping
    • Initialize cursor changer with data
  • animation_speed: float = 1.0
    • Mode to cursor type mapping
    • Initialize cursor changer with data
  • mode_cursor_mapping: Dictionary = {}
    • Initialize cursor changer with data

Methods

  • _init(data: Dictionary = {}) -> void
  • _setup_default_mappings -> void
  • set_cursor_mode(mode: CursorMode) -> void
  • set_cursor_type(type: CursorType) -> void
  • set_custom_cursor(texture: Texture2D, hotspot: Vector2 = Vector2.ZERO) -> void
  • _update_cursor_type -> void
  • _apply_cursor -> void
  • set_mode_cursor_mapping(mode: CursorMode, cursor: CursorType) -> void
  • remove_mode_cursor_mapping(mode: CursorMode) -> void
  • get_cursor_for_mode(mode: CursorMode) -> CursorType
  • set_auto_switch(enabled: bool) -> void
  • set_animation_enabled(enabled: bool) -> void
  • reset_to_default -> void
  • is_using_custom_cursor -> bool
  • validate -> Array
  • to_string -> String