kaplay-layout
    Preparing search index...

    Interface StaticComp

    base flex object component interface.

    components implementing this don't necessary need to be able to contain other flex objects.

    ContainerComp

    interface StaticComp {
        add?: () => void;
        destroy?: () => void;
        draw?: () => void;
        drawInspect?: () => void;
        fixedUpdate?: () => void;
        id?: string;
        inspect?: () => string | null;
        layout: StaticFlexboxStyle;
        require?: string[];
        update?: () => void;
        addLayoutNode(index?: number): void;
        dropLayoutNode(): void;
        updateLayout(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    add? destroy? draw? drawInspect? fixedUpdate? id? inspect? layout require? update?

    Methods

    addLayoutNode dropLayoutNode updateLayout

    Properties

    add?: () => void

    Event that runs when host game obj is added to scene.

    destroy?: () => void

    Event that runs when obj is removed from scene.

    draw?: () => void

    Event that runs every frame after update.

    drawInspect?: () => void

    Draw debug info in inspect mode

    v3000.0

    fixedUpdate?: () => void

    Event that runs at a fixed frame rate.

    id?: string

    Component ID (if left out won't be treated as a comp).

    inspect?: () => string | null

    Debug info for inspect mode.

    layout: StaticFlexboxStyle

    flexbox CSS properties.

    require?: string[]

    What other comps this comp depends on.

    update?: () => void

    Event that runs every frame.

    Methods

    • insert the object into its parent layout tree (if it has one). called automatically when the object is added.

      Parameters

      • Optionalindex: number

        index to insert the object into. defaults to appending.

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods