MouseInputStatus

MouseInputStatus

Holds the last mouse input gate/projection snapshot for grid-based input systems. Provides typed properties.

Project: GridPlacement v6.0
Layer: Core
Source: Core/Systems/Input/MouseInputStatus.cs
Namespace: GridBuilding.Core.Systems.Input
Kind: class

Parsing Method: AST-based (Roslyn) - NOT regex

⚠️ IMPORTANT: This documentation was generated using AST parsing, not regex.

Properties

Allowed

Whether mouse input was allowed through the gate.

World

World position of the mouse.

Method

Projection method used (int value from ProjectionMethod).

ProjectionMethodName

String name of the projection method.

Screen

Screen position of the mouse.

Methods

SetFromValues

Set values from individual parameters.

Returns: void

Parameters:

  • bool allowed
  • CoreVector2 world
  • int method
  • string methodName
  • CoreVector2 screen

CreateAllowed

Create a status indicating input was allowed.

Returns: MouseInputStatus

Parameters:

  • CoreVector2 world
  • int method
  • string methodName
  • CoreVector2 screen

CreateBlocked

Create a status indicating input was blocked.

Returns: MouseInputStatus

Parameters:

  • CoreVector2 world
  • int method
  • string methodName
  • CoreVector2 screen

CreateDefault

Create a default status (blocked).

Returns: MouseInputStatus

ToString

Convert to string representation.

Returns: string