Skip to content

SusBattleGrid

SusBattleGrid

Tactical battle grid — cell and token layers, pan & zoom, PC/phone layout modes, click/long-press/context/double-click events for cells and tokens.

Package

SusGame · HUD (commercial)

Open in Playground

SusGame · HUD

Props

NameTypeDefault
WidthProp<int>10v-model
HeightProp<int>8v-model
LayoutProp<string>"pc"v-model
CompactProp<string>"auto"v-model
ZoomProp<float>1fv-model
IsPanningProp<bool>falsev-model
InteractiveProp<bool>truev-model
AutoFocusActiveProp<bool>truev-model

Slots

No slots.

Events

NameFieldPayload
CellClickedOnCellClickedint, int
TokenClickedOnTokenClickedstring
CellLongPressedOnCellLongPressedint, int
TokenLongPressedOnTokenLongPressedstring
CellContextOnCellContextint, int
TokenContextOnTokenContextstring
TokenDoubleClickedOnTokenDoubleClickedstring
CursorMovedOnCursorMovedint, int
PanChangedOnPanChangedfloat, float
ZoomChangedOnZoomChangedfloat

Style hooks

USS class contract — override appearance without touching C#. States toggle via these classes:

  • sus-battle--compact
  • sus-battle--compact-h
  • sus-battle-grid
  • sus-battle-grid__board
  • sus-battle-grid__cell-layer
  • sus-battle-grid__overlay-layer
  • sus-battle-grid__token-layer
  • sus-battle-grid__viewport
  • sus-battle-grid--layout-pc
  • sus-battle-grid--layout-phone-landscape
  • sus-battle-grid--layout-phone-portrait
  • sus-battle-grid--panning

Usage

xml
<sus:SusBattleGrid />