Skip to content

StateMachineOptions

Defined in: StateMachine.ts:54

How a machine is set up beyond its states.

readonly optional events?: string

Defined in: StateMachine.ts:65

Publish this machine’s events on its entity under <events>:changed, <events>:entered and <events>:exited, so other components and the scene can listen for them like any entity event. Pick a name for what the machine tracks, such as "mode" or "stance". Entity events dispatch by name, so two machines on one entity need different names.

Left out, the events stay on the machine and reach only StateMachine.on.

Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/core.md.