Profectus / game/boards/board / SetupActionsOptions
Interface: SetupActionsOptions<T> ​
An object that configures how to setup a list of actions using setupActions.
Type Parameters ​
• T extends NodePosition
Properties ​
actions ​
actions:
NodeMaybeRefOrGetter
<T
, (position
) =>Renderable
[], []>
The list of actions to display. Actions are arbitrary JSX elements.
Defined in ​
profectus/src/game/boards/board.tsx:357
arcLength? ​
optional
arcLength:NodeMaybeRefOrGetter
<T
,number
, []>
The arc length to place between actions, in radians.
Defined in ​
profectus/src/game/boards/board.tsx:361
distance ​
distance:
NodeMaybeRefOrGetter
<T
,number
, []>
The distance from the node to place the actions.
Defined in ​
profectus/src/game/boards/board.tsx:359
node ​
node:
MaybeRefOrGetter
<undefined
|T
>
The node to display actions upon, or undefined when the actions should be hidden.
Defined in ​
profectus/src/game/boards/board.tsx:353
shouldShowActions? ​
optional
shouldShowActions:NodeMaybeRefOrGetter
<T
,boolean
, []>
Whether or not to currently display the actions.