useGameboardCommandActions
useGameboardCommandActions():
object
Defined in: src/react/react.ts:448
Bind higher-level command actions shared by UI, AI, and test flows.
Returns
Section titled “Returns”execute
Section titled “execute”execute: (
commandOrTarget,options) =>GameboardInteractionCommandExecution
Execute a command with optional host-game handlers.
Parameters
Section titled “Parameters”commandOrTarget
Section titled “commandOrTarget”GameboardInteractionCommandInput
options?
Section titled “options?”GameboardInteractionCommandExecutionOptions = {}
Returns
Section titled “Returns”GameboardInteractionCommandExecution
plan: (
target,options) =>GameboardInteractionCommand
Plan a command from a renderer or gameplay target.
Parameters
Section titled “Parameters”target
Section titled “target”GameboardInteractionTargetInput
options?
Section titled “options?”GameboardInteractionCommandOptions = {}
Returns
Section titled “Returns”preview
Section titled “preview”preview: (
commandOrTarget,options) =>GameboardInteractionCommandPreview
Preview a command without mutating state.
Parameters
Section titled “Parameters”commandOrTarget
Section titled “commandOrTarget”GameboardInteractionCommandInput
options?
Section titled “options?”GameboardInteractionCommandPreviewOptions = {}
Returns
Section titled “Returns”GameboardInteractionCommandPreview
targetCommand
Section titled “targetCommand”targetCommand: (
options) =>GameboardActorTargetCommandPlan
Select an actor target and plan a command against it.
Parameters
Section titled “Parameters”options
Section titled “options”GameboardActorTargetCommandOptions