Preparing search index...

    TextStylePresets is a utility component designed to standardize and easily apply consistent text styles (including font size and optionally font weight) to a Text component based on a selected "ranking" (such as Title1, Headline, Body, etc.) and a preset "distance" (Near or Far) that accounts for different viewing contexts in AR experiences.

    The component uses a predefined mapping from ranking and distance to font settings, ensuring design consistency throughout the UI.

    Intended usage: Attach to a SceneObject that already contains a Text component above this component. Select the desired ranking and distance using the inspector properties to instantly update styling to match design guidelines.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    api: Record<string, any>

    Generic object accessible by other instances of ScriptComponent. Use this object to store references to properties and methods that need to be accessible from other ScriptComponents.

    This property is no longer needed, you can use a reference to the ScriptComponent, including 'script', directly

    enabled: boolean

    If disabled, the Component will stop enacting its behavior.

    true
    
    isBeingDestroyed: boolean

    Returns true if this Component is currently being destroyed. Becomes true as soon as destruction begins via Component#destroy or destruction of its owning SceneObject, before any OnDestroyEvent callbacks fire.

    Lens Scripting Version 364

    if (!script.isBeingDestroyed) {
    // Component is still fully alive
    }
    isEnabledInHierarchy: boolean

    Returns true if this Component, its SceneObject, and all of that SceneObjects parents are enabled.

    name: string
    sceneObject: SceneObject

    The SceneObject this component is on.

    uniqueIdentifier: string

    Lens Scripting Version 176

    updateOrder: number

    The relative execution order of this script's lifecycle callbacks (onStart, onUpdate, onLateUpdate, etc.) among all scripts in the Lens. Scripts with a smaller updateOrder run before scripts with a larger updateOrder. Reflects the updateOrder set on the attached ScriptAsset. Defaults to 0.

    updateOrder only orders scripts relative to each other; it does not affect ordering relative to non-script engine Components.

    Lens Scripting Version 367

    if (script.updateOrder < 0) {
    // This script runs before scripts at the default updateOrder.
    }
    updatePriority: number

    Accessors

    • get distance(): Distance

      get current viewing distance

      Returns Distance

    • set distance(value: Distance): void

      set current viewing distance

      Parameters

      Returns void

    • get ranking(): Ranking

      get current text ranking

      Returns Ranking

    • set ranking(value: Ranking): void

      set current text ranking

      Parameters

      Returns void

    Methods

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Type Parameters

      Parameters

      • this: T

      Returns TypeName<InstanceType<T>>

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns void

    • Returns the current distance style ("near" or "far") selected for the text.

      Returns void