kaplay-plugin-text
    Preparing search index...

    Interface StyledTextComp

    The styledText component.

    interface StyledTextComp {
        add?: () => void;
        destroy?: () => void;
        draw?: () => void;
        drawInspect?: () => void;
        fixedUpdate?: () => void;
        height: number;
        id: "styledText";
        inspect?: () => string | null;
        require?: string[];
        text: string;
        update?: () => void;
        width: number;
        renderArea(): Rect;
        setStyle(opt: Partial<StyledTextCompOpt>): void;
    }

    Hierarchy

    • Comp
      • StyledTextComp
    Index
    add? destroy? draw? drawInspect? fixedUpdate? height id inspect? require? text update? width
    renderArea setStyle
    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.

    height: number
    id: "styledText"

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

    inspect?: () => string | null

    Debug info for inspect mode.

    require?: string[]

    What other comps this comp depends on.

    text

    text: string
    update?: () => void

    Event that runs every frame.

    width: number

    Settings
    Member Visibility

    On This Page
    Properties
    Methods