---
generated_by: gdlink-build
generated_at: 2026-06-23T12:34:28Z
do_not_edit: true
title: Cursor
brick_type: executor
tier: Basic
generated: true
---

# Cursor

**Category:** Executor
**Tier:** Basic

## Purpose

Controls the runtime cursor graphic, visibility, confinement/capture behavior, and simple frame-path cursor animation.

## Visual Reference

```{raw} html
<div class="illustration-container"><div class="illustration-box"><div class="box-header">As added to your scene</div><img src="https://gdlink.solventech.ca/guide/assets/images/bricks/cursor_executor.png" alt="Cursor brick as it appears in the GDLink editor" loading="lazy" style="max-width:100%;height:auto;display:block;margin:0 auto;border-radius:8px;" /></div></div>
```

## Runtime Behavior

- `Default + visible=true` -> `Input.MOUSE_MODE_VISIBLE`
- `Default + visible=false` -> `Input.MOUSE_MODE_HIDDEN`
- `Screen Locked + visible=true` -> `Input.MOUSE_MODE_CONFINED`
- `Screen Locked + visible=false` -> `Input.MOUSE_MODE_CONFINED_HIDDEN`
- `Center Locked` -> `Input.MOUSE_MODE_CAPTURED`

```{raw} html
<div class="illustration-container">
        <div class="illustration-box">
            <div class="box-header">Generated UI Mockup — showing expanded properties</div>
            <div class="real-node brick-executor">
                <div class="real-header">
                    <div class="real-title"><span class="brick-icon-fallback"></span> <span>Cursor</span></div>
                    <div class="real-controls"><div class="real-checkbox"></div><div class="real-btn">-</div><div class="real-btn">x</div></div>
                </div>
                <div class="real-inner-panel"><div class="real-row name-row" style="position:relative;"><span class="real-label">Name:</span><div class="real-input" style="color:#666; font-style:italic;">Label this brick...</div><div class="real-port" style="left:-15px;"></div></div><div class="real-row"><span class="real-label">Mode:</span><div class="real-input-dropdown">Always</div></div><div class="real-row"><span class="real-label">Scope:</span><div class="real-input-dropdown">Local</div></div><div class="real-row"><span class="real-label" style="width: auto; padding-right:8px;">Prefix:</span><div class="real-input" style="justify-content:space-between; padding:4px 8px;"><span>cursor</span><div class="real-input-dropdown-btn" style="padding:2px 6px;">v</div></div></div><div class="real-row"><span class="real-label">Move Thresh:</span><div class="real-inline-input" style="border-bottom: 1px solid #2f333b;"><span>1.0</span></div><div class="real-val-btn" style="margin-left:4px;">v</div></div><div class="real-inline-row" style="margin-top:4px;"><div class="real-inline-btn" style="background:#2f5c2f;">Write X/Y</div><div class="real-inline-btn" style="background:#2f5c2f;">World 2D</div><div class="real-inline-btn" style="background:#2f343d;">Verbose</div></div></div>
            </div>
        </div>
    </div>
```

## Properties

| Property | Type | Default | Notes |
|---|---|---|---|
| Mode | option | Always | When cursor position should trigger the listener. |
| Scope | option | Local | Where cursor variables are written. |
| Variable | variable_name | cursor_position | Vector2 variable that receives current screen/viewport cursor position. |
| X Var | variable_name |  | Variable that receives cursor screen X when components are enabled |
| Y Var | variable_name |  | Variable that receives cursor screen Y when components are enabled |
| World2D Var | variable_name |  | Variable that receives cursor 2D world position |
| Prefix | string | cursor | Compatibility fallback when explicit output variables are empty |
| Move Thresh | float | 1.0 | [Moved] Minimum cursor delta before this listener fires. |
| Write X/Y | bool | True | Also write {prefix}_x and {prefix}_y. |
| World 2D | bool | True | Also write {prefix}_world_2d using the viewport canvas transform. |
| Verbose | bool | False | Native debug output; controlled by the ladybug header button. |