useGameboardSystemActions
useGameboardSystemActions():
object
Defined in: src/react/react.ts:456
Bind system tick actions for running movement, patrol, and quest systems.
Returns
Section titled “Returns”dispatchActorTargetCommand
Section titled “dispatchActorTargetCommand”dispatchActorTargetCommand: (
options,commandOptions) =>DispatchGameboardActorTargetCommandResult
Select an actor target, then execute its planned command.
Parameters
Section titled “Parameters”options
Section titled “options”GameboardActorTargetCommandOptions
commandOptions?
Section titled “commandOptions?”DispatchGameboardInteractionCommandOptions = {}
Returns
Section titled “Returns”DispatchGameboardActorTargetCommandResult
dispatchCommand
Section titled “dispatchCommand”dispatchCommand: (
commandOrTarget,options) =>DispatchGameboardInteractionCommandResult
Execute one command and emit dispatch event records.
Parameters
Section titled “Parameters”commandOrTarget
Section titled “commandOrTarget”GameboardInteractionCommandInput
options?
Section titled “options?”DispatchGameboardInteractionCommandOptions = {}
Returns
Section titled “Returns”DispatchGameboardInteractionCommandResult
interact
Section titled “interact”interact: (
commandOrTarget,options) =>RunGameboardInteractionResult
Dispatch a command and optionally tick systems.
Parameters
Section titled “Parameters”commandOrTarget
Section titled “commandOrTarget”GameboardInteractionCommandInput
options?
Section titled “options?”RunGameboardInteractionOptions = {}
Returns
Section titled “Returns”interactActorTarget
Section titled “interactActorTarget”interactActorTarget: (
options,interactionOptions) =>RunGameboardActorTargetInteractionResult
Target an actor, dispatch the command, and optionally tick systems.
Parameters
Section titled “Parameters”options
Section titled “options”GameboardActorTargetCommandOptions
interactionOptions?
Section titled “interactionOptions?”RunGameboardInteractionOptions = {}
Returns
Section titled “Returns”RunGameboardActorTargetInteractionResult
run: (
options) =>RunGameboardSystemsResult
Run enabled patrol, movement, and quest systems for one tick.
Parameters
Section titled “Parameters”options?
Section titled “options?”RunGameboardSystemsOptions = {}