ICursorService

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 interface ICursorService

Summary

Provides access to the current cursor position in grid coordinates.

Metadata

Namespace: GridPlacement.Core.Services.Targeting

Source File: cs/Core/Services/Targeting/ICursorService.cs

Assembly: GridPlacement.Core

Type: interface

Properties

Revision

1

public abstract long Revision { get; }

Gets a monotonically increasing revision number that changes whenever the cursor state changes.

CurrentGridPosition

1

public abstract CoreVector2I CurrentGridPosition { get; }

Gets the current grid position of the cursor.

Methods

TrySetGridPosition

1

bool TrySetGridPosition(CoreVector2I newPosition)

Attempts to set the current grid position.

Parameters

NameDescription
newPositionThe new grid position.

Returns

true if the position changed; otherwise false.

Events

GridPositionChanged

1

public abstract event Action<CoreVector2I>? GridPositionChanged

Raised when the grid position changes.