Interface RenderFactoryFunctions

interface RenderFactoryFunctions {
    actionPacket: (item: string, override?: CommonObjectInput) => any;
    clone: (item?: RenderFactoryInputs) => RenderInstance;
    get: (item: string) => any;
    halt: () => void;
    importPacket: (
        item: string | string[],
        override?: CommonObjectInput,
    ) => any;
    isRunning: () => boolean;
    kill: (item?: any) => void;
    run: () => void;
    saveAsPacket: (item?: boolean | RenderSaveInputs) => string;
    set: (item?: RenderFactoryInputs) => RenderInstance;
    setDelta: (item?: RenderFactoryDeltaInputs) => RenderInstance;
    updateHook: (hook: string, func?: DefaultInputFunction) => void;
}

Hierarchy (View Summary)

BaseMixinFunctions
- RenderFactoryFunctions
  - RenderInstance

Index

Properties

actionPacket clone get halt importPacket isRunning kill run saveAsPacket set setDelta updateHook

Properties

actionPacket

actionPacket: (item: string, override?: CommonObjectInput) => any

clone

clone: (item?: RenderFactoryInputs) => RenderInstance

get

get: (item: string) => any

halt

halt: () => void

importPacket

importPacket: (item: string | string[], override?: CommonObjectInput) => any

isRunning

isRunning: () => boolean

kill

kill: (item?: any) => void

run

run: () => void

saveAsPacket

saveAsPacket: (item?: boolean | RenderSaveInputs) => string

set

set: (item?: RenderFactoryInputs) => RenderInstance

setDelta

setDelta: (item?: RenderFactoryDeltaInputs) => RenderInstance

updateHook

updateHook: (hook: string, func?: DefaultInputFunction) => void

Replace one of the Render cycle hook functions.

Type Declaration

- (hook: string, func?: DefaultInputFunction): void
- Parameters
  - hook: string
    The hook name to replace; for example commence, afterClear, afterCompile, afterShow, or error.
  - Optionalfunc: DefaultInputFunction
    The function to assign to that hook. Pass undefined to clear a previously assigned hook.
  Returns void