Product media placeholder
Replace this area with a screenshot or short walkthrough video during the media sweep.
This API table is generated from the runtime and loader TypeScript source. It is meant for lookup; the runtime loading guide explains the recommended lifecycle.
Runtime source src/fmtion/RuntimeLoader.tsLoader source src/fmtion/FmtionLoader.tsRuntime result fields 31Load result fields 61
Loader methods
| Owner | Method | Source |
|---|---|---|
| RuntimeLoader | load() | Class method detected from source. |
| FmtionLoader | getInputDispatch() | Class method detected from source. |
| FmtionLoader | if() | Class method detected from source. |
| FmtionLoader | load() | Class method detected from source. |
| FmtionLoader | restoreSnapshot() | Class method detected from source. |
| FmtionLoader | save() | Class method detected from source. |
| FmtionLoader | snapshot() | Class method detected from source. |
Runtime load result
| Field | Required | Signature |
|---|---|---|
canvas | optional | CanvasLoadResult |
parameters | optional | any |
play | required | () => void |
pause | required | () => void |
getString | required | (path: string) => string |
setString | required | (path: string, value: string) => void |
getEnum | required | (path: string) => string |
setEnum | required | (path: string, value: string) => void |
getEnumValues | required | (path: string) => string[] | undefined |
getColor | required | (path: string) => string |
setColor | required | (path: string, value: string) => void |
onPropertyChange | required | (path: string, callback: (value: boolean | number | string) => void) => () => void |
dataTable | required | (id: string) => DataTable | undefined |
dataTables | required | () => DataTable[] |
dataRecord | required | (dataTableId: string) => DataRecord | undefined |
createRecord | required | (dataTableId: string, recordId?: string, values?: Record<string, any>, options?: { bind?: boolean }) => DataRecord | undefined |
bindRecord | required | (record: DataRecord, prefix?: string) => void |
on | required | (eventName: string, callback: (event: { name: string; time: number; data?: Record<string, unknown> }) => void) => void |
off | required | (eventName: string, callback: (event: { name: string; time: number; data?: Record<string, unknown> }) => void) => void |
once | required | (eventName: string, callback: (event: { name: string; time: number; data?: Record<string, unknown> }) => void) => void |
getSkeletons | required | () => Skeleton[] |
getSkeleton | required | (id: string) => Skeleton | null |
getStateMachines | required | () => StateMachineFacade[] |
getStateMachine | required | (id: string) => StateMachineFacade | null |
setDebugOverlay | required | (visible: boolean) => void |
metadata | required | { |
name | required | string |
hasCanvas | required | boolean |
hasParameters | required | boolean |
hasDataTables | required | boolean |
dispose | required | () => void |
Canvas load result
| Field | Required | Signature |
|---|
Additional load result fields
| Field | Required | Signature |
|---|---|---|
canvas | optional | CanvasLoadResult |
video | optional | VideoLoadResult |
parameters | optional | any |
assets | optional | LoadedAssets |
sprites | optional | DomSprite[] |
getString | required | (path: string) => string |
getEnum | required | (path: string) => string |
getEnumValues | required | (path: string) => string[] | undefined |
getColor | required | (path: string) => string |
onPropertyChange | required | (path: string, callback: (value: boolean | number | string) => void) => () => void |
dataTable | required | (id: string) => DataTable | undefined |
dataTables | required | () => DataTable[] |
dataRecord | required | (dataTableId: string) => DataRecord | undefined |
createRecord | required | (dataTableId: string, recordId?: string, values?: Record<string, any>, options?: { bind?: boolean }) => DataRecord | undefined |
bindRecord | required | (record: DataRecord, prefix?: string) => void |
getListItems | required | (dataTableId: string, listField: string) => ReadonlyArray<DataRecord> |
addListItem | required | (dataTableId: string, listField: string, values?: Record<string, any>, index?: number) => DataRecord | undefined |
removeListItem | required | (dataTableId: string, listField: string, index: number) => DataRecord | undefined |
moveListItem | required | (dataTableId: string, listField: string, fromIndex: number, toIndex: number) => void |
getListCount | required | (dataTableId: string, listField: string) => number |
setImage | required | (dataTableId: string, propertyName: string, url: string) => void |
getImage | required | (dataTableId: string, propertyName: string) => string |
on | required | (eventName: string, callback: (event: { name: string; time: number; data?: Record<string, unknown> }) => void) => void |
off | required | (eventName: string, callback: (event: { name: string; time: number; data?: Record<string, unknown> }) => void) => void |
once | required | (eventName: string, callback: (event: { name: string; time: number; data?: Record<string, unknown> }) => void) => void |
getSkeletons | required | () => Skeleton[] |
getSkeleton | required | (id: string) => Skeleton | null |
getStateMachines | required | () => StateMachineFacade[] |
getStateMachine | required | (id: string) => StateMachineFacade | null |
getSMFacade | required | (id: string) => import('../canvas/animation/StateMachineFacade').StateMachineFacade | null |
getSMFacades | required | () => import('../canvas/animation/StateMachineFacade').StateMachineFacade[] |
getObjectPoseBundleNode | required | () => import('../core/GraphNode').BaseGraphNode | null |
getInputDispatch | required | () => import('../input').InputDispatch | null |
setDebugOverlay | required | (visible: boolean) => void |
exportCanvasGraph | required | () => import('../core/GraphNode').SerializedGraphNode[] |
exportDomGraph | required | () => import('../core/GraphNode').SerializedGraphNode[] |
replayDomGraph | required | (selector?: string) => void |
metadata | required | { |
name | required | string |
hasDom | required | boolean |