Hilo3d API - v2.0.0-alpha.3
    Preparing search index...

    Interface Text2DParameters

    interface Text2DParameters {
        anchorX?: number;
        anchorY?: number;
        anim?: Animation | null;
        animationId?: string;
        autoUpdateChildWorldMatrix?: boolean;
        autoUpdateWorldMatrix?: boolean;
        castShadows?: boolean;
        frameRate?: number;
        jointName?: string;
        layer?: number;
        loop?: boolean;
        name?: string;
        needCallChildUpdate?: boolean;
        onlySyncQuaternion?: boolean;
        onUpdate?: ((deltaTime: number) => void) | null;
        parent?: Node | null;
        pivotX?: number;
        pivotY?: number;
        pivotZ?: number;
        pointerChildren?: boolean;
        pointerEnabled?: boolean;
        receiveShadows?: boolean;
        renderOrder?: number;
        rotationX?: number;
        rotationY?: number;
        rotationZ?: number;
        scaleX?: number;
        scaleY?: number;
        scaleZ?: number;
        sortingLayer?: number;
        style?: Text2DStyle;
        text?: string;
        tint?: Color;
        up?: Vector3;
        useHandCursor?: boolean;
        userData?: unknown;
        visible?: boolean;
        x?: number;
        y?: number;
        z?: number;
        zIndex?: number;
    }

    Hierarchy

    • Omit<
          SpriteParameters,
          | "texture"
          | "frame"
          | "frames"
          | "material"
          | "width"
          | "height"
          | "autoPlay",
      >
      • Text2DParameters
    Index
    anchorX? anchorY? anim? animationId? autoUpdateChildWorldMatrix? autoUpdateWorldMatrix? castShadows? frameRate? jointName? layer? loop? name? needCallChildUpdate? onlySyncQuaternion? onUpdate? parent? pivotX? pivotY? pivotZ? pointerChildren? pointerEnabled? receiveShadows? renderOrder? rotationX? rotationY? rotationZ? scaleX? scaleY? scaleZ? sortingLayer? style? text? tint? up? useHandCursor? userData? visible? x? y? z? zIndex?
    anchorX?: number

    Horizontal anchor in normalized local coordinates. Defaults to the visual center (0.5).

    anchorY?: number

    Vertical anchor in normalized local coordinates. Defaults to the visual center (0.5).

    anim?: Animation | null
    animationId?: string
    autoUpdateChildWorldMatrix?: boolean
    autoUpdateWorldMatrix?: boolean
    castShadows?: boolean
    frameRate?: number

    Default animation rate when frames do not carry an explicit duration.

    jointName?: string
    layer?: number

    Scene-layer bit mask. A node is renderable when at least one bit overlaps the active camera's visibility mask.

    loop?: boolean

    Whether sequence playback wraps at the end.

    name?: string
    needCallChildUpdate?: boolean
    onlySyncQuaternion?: boolean
    onUpdate?: ((deltaTime: number) => void) | null
    parent?: Node | null
    pivotX?: number
    pivotY?: number
    pivotZ?: number
    pointerChildren?: boolean
    pointerEnabled?: boolean
    receiveShadows?: boolean
    renderOrder?: number
    rotationX?: number
    rotationY?: number
    rotationZ?: number
    scaleX?: number
    scaleY?: number
    scaleZ?: number
    sortingLayer?: number

    Coarse 2D display layer. Higher values render later.

    This is independent from layer, which is a camera-visibility bit mask.

    style?: Text2DStyle

    Optionaltext

    text?: string
    tint?: Color

    Per-instance color multiplier.

    up?: Vector3
    useHandCursor?: boolean
    userData?: unknown
    visible?: boolean
    x?: number
    y?: number
    z?: number
    zIndex?: number

    Fine 2D display order within sortingLayer. Higher values render later.

    Settings
    Member Visibility

    On This Page
    Properties