kaplay-layout
    Preparing search index...

    Interface FlexNodeComp

    base flex container component interface

    interface FlexNodeComp {
        add?: () => void;
        destroy?: () => void;
        draw?: () => void;
        drawInspect?: () => void;
        fixedUpdate?: () => void;
        id?: string;
        inspect?: () => string | null;
        layout: FlexboxStyle;
        require?: string[];
        update?: () => void;
        addLayoutNode(index?: number): void;
        calculateLayout(): void;
        dropLayoutNode(): void;
        getComputedLayout(): {
            bottom: number;
            height: number;
            left: number;
            right: number;
            top: number;
            width: number;
        };
        getComputedMargin(): {
            bottom: number;
            left: number;
            right: number;
            top: number;
        };
        getComputedOffset(): Vec2;
        getComputedPadding(): {
            bottom: number;
            left: number;
            right: number;
            top: number;
        };
        getComputedSize(): { height: number; width: number };
        insertChild(child: Node, index?: number): void;
        markDirty(): void;
        onLayoutShift(handler: () => void): KEventController;
        setMeasureFn(measureFn: MeasureFunction): void;
        updateLayout(): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Methods

    addLayoutNode calculateLayout dropLayoutNode getComputedLayout getComputedMargin getComputedOffset getComputedPadding getComputedSize insertChild markDirty onLayoutShift setMeasureFn 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: FlexboxStyle

    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

    • Returns {
          bottom: number;
          height: number;
          left: number;
          right: number;
          top: number;
          width: number;
      }

    • Returns { bottom: number; left: number; right: number; top: number }

    • Returns { bottom: number; left: number; right: number; top: number }

    • Returns { height: number; width: number }

    • insert a child Yoga node. called automatically when a child game object is added.

      Parameters

      • child: Node
      • Optionalindex: number

        index to insert the object into. defaults to appending.

      Returns void

    • tell yoga to re calculate the object size using its measure function.

      Returns void

    • fires when the object is moved from a layout calculation.

      the object's real size and position may or may not be updated because you are expected to handle them yourself or use helper functions. use getComputedLayout or similar functions instead.

      Parameters

      • handler: () => void

      Returns KEventController

    Settings

    Member Visibility

    On This Page

    Properties
    Methods