ReadonlyplanThe name of the plan to queue.
Optional ReadonlycausesAn array containing entity IDs for arbitrary actions that the host application has indicated as causes for the plan being queued. If the plan ultimately directly causes any actions to be performed, these will be attributed as the causes of those actions.
See the documentation for AttemptActionArgs for examples of design patterns enabled by this parameter.
Note: The runtime will confirm that each entry here is in fact the entity ID for some action, and it will also deduplicate the given causes automatically.
Optional ReadonlyprecastPartial or complete role bindings to use when targeting the plan.
If there are any required role slots that have not been precast here, the role caster will attempt to fill them, and targeting will fail if they cannot be filled. Likewise, the role caster will also attempt to fill any unfilled optional role slots.
Optional ReadonlyurgentWhether to queue the plan urgently.
If this flag is set, the planner will immediately target the plan upon queueing it. If this initial
targeting succeeds, the plan will be launched immediately and then greedily executed to the degree
possible, up to potential resolution. This matches the behavior that occurs when a reaction queues
a plan (or plan selector) with a truthy urgent value.
If the flag is not set, the planner will queue the plan immediately, but will not attempt to target it until the next tickPlanner.
Note: This should always be true when present.
Arguments parameterizing a request to force queueing of a specific plan, potentially urgently.
Note: No initiator is specified here because, unlike actions, plans are executed globally without regard to any single character. Indeed, plans can orchestrate actions that will be initiated by distinct characters. This is why queued plans live in a global plan queue (stored in the VivInternalState), as opposed to character-specific queues (as with queued actions).
Remarks
These are the effective arguments to queuePlan.