Editor Scripting API

    Interface ComponentNameMap

    interface ComponentNameMap {
        Animation: Animation;
        AnimationMixer: AnimationMixer;
        AnimationPlayer: AnimationPlayer;
        AudioChainComponent: AudioEffectComponent;
        AudioComponent: AudioComponent;
        AudioEffectComponent: AudioEffectComponent;
        AudioListenerComponent: AudioListenerComponent;
        AudioPlayer: AudioComponent;
        BaseMeshVisual: BaseMeshVisual;
        BlurNoiseEstimation: BlurNoiseEstimation;
        Camera: Camera;
        Canvas: Canvas;
        ClearDepth: ClearDepth;
        ClearScreen: ClearDepth;
        ClothVisual: ClothVisual;
        ColliderComponent: ColliderComponent;
        ColocatedTrackingComponent: ColocatedTrackingComponent;
        "Component.Animation": Animation;
        "Component.AnimationMixer": AnimationMixer;
        "Component.AnimationPlayer": AnimationPlayer;
        "Component.AudioChainComponent": AudioEffectComponent;
        "Component.AudioComponent": AudioComponent;
        "Component.AudioEffectComponent": AudioEffectComponent;
        "Component.AudioListenerComponent": AudioListenerComponent;
        "Component.AudioPlayer": AudioComponent;
        "Component.BaseMeshVisual": BaseMeshVisual;
        "Component.BlurNoiseEstimation": BlurNoiseEstimation;
        "Component.Camera": Camera;
        "Component.Canvas": Canvas;
        "Component.ClearDepth": ClearDepth;
        "Component.ClearScreen": ClearDepth;
        "Component.ClothVisual": ClothVisual;
        "Component.ColliderComponent": ColliderComponent;
        "Component.ColocatedTrackingComponent": ColocatedTrackingComponent;
        "Component.DepthSetter": DepthSetter;
        "Component.DeviceLocationTrackingComponent": DeviceLocationTrackingComponent;
        "Component.DeviceTracking": DeviceTracking;
        "Component.EyeColorVisual": EyeColorVisual;
        "Component.FaceInsetVisual": FaceInsetVisual;
        "Component.FaceMaskVisual": FaceMaskVisual;
        "Component.FaceStretchVisual": FaceStretchVisual;
        "Component.FaceSubVisual": FaceMaskVisual;
        "Component.GaussianSplattingVisual": GaussianSplattingVisual;
        "Component.HairSimulationColliderComponent": ColliderComponent;
        "Component.HairVisual": HairVisual;
        "Component.Head": Head;
        "Component.Hints": HintsComponent;
        "Component.HintsComponent": HintsComponent;
        "Component.Image": Image;
        "Component.InteractionComponent": InteractionComponent;
        "Component.LightSource": LightSource;
        "Component.LiquifyVisual": LiquifyVisual;
        "Component.LocatedAtComponent": LocatedAtComponent;
        "Component.LookAtComponent": LookAtComponent;
        "Component.ManipulateComponent": ManipulateComponent;
        "Component.MarkerTrackingComponent": MarkerTrackingComponent;
        "Component.MaskingComponent": MaskingComponent;
        "Component.MaterialMeshVisual": MaterialMeshVisual;
        "Component.MeshVisual": RenderMeshVisual;
        "Component.MLComponent": MLComponent;
        "Component.ObjectTracker2D": ObjectTracking;
        "Component.ObjectTracking": ObjectTracking;
        "Component.ObjectTracking3D": ObjectTracking3D;
        "Component.PinToMeshComponent": PinToMeshComponent;
        "Component.PostEffectVisual": PostEffectVisual;
        "Component.RectangleSetter": RectangleSetter;
        "Component.RenderMeshVisual": RenderMeshVisual;
        "Component.RetouchVisual": RetouchVisual;
        "Component.ScreenRegionComponent": ScreenRegionComponent;
        "Component.ScreenTransform": ScreenTransform;
        "Component.Script": ScriptComponent;
        "Component.ScriptComponent": ScriptComponent;
        "Component.Skin": Skin;
        "Component.SplineComponent": SplineComponent;
        "Component.SpriteAligner": SpriteAligner;
        "Component.SpriteVisualV2": Image;
        "Component.Text": Text;
        "Component.Text3D": Text3D;
        "Component.Touch": InteractionComponent;
        "Component.TouchComponent": InteractionComponent;
        "Component.TrackedPointComponent": TrackedPointComponent;
        "Component.VertexCache": VertexCache;
        "Component.VFXComponent": VFXComponent;
        "Component.Visual": Visual;
        "Component.WorldTracking": DeviceTracking;
        DepthSetter: DepthSetter;
        DeviceLocationTrackingComponent: DeviceLocationTrackingComponent;
        DeviceTracking: DeviceTracking;
        EyeColorVisual: EyeColorVisual;
        FaceInsetVisual: FaceInsetVisual;
        FaceMaskVisual: FaceMaskVisual;
        FaceStretchVisual: FaceStretchVisual;
        FaceSubVisual: FaceMaskVisual;
        GaussianSplattingVisual: GaussianSplattingVisual;
        HairSimulationColliderComponent: ColliderComponent;
        HairVisual: HairVisual;
        Head: Head;
        Hints: HintsComponent;
        HintsComponent: HintsComponent;
        Image: Image;
        InteractionComponent: InteractionComponent;
        LightSource: LightSource;
        LiquifyVisual: LiquifyVisual;
        LocatedAtComponent: LocatedAtComponent;
        LookAtComponent: LookAtComponent;
        ManipulateComponent: ManipulateComponent;
        MarkerTrackingComponent: MarkerTrackingComponent;
        MaskingComponent: MaskingComponent;
        MaterialMeshVisual: MaterialMeshVisual;
        MeshVisual: RenderMeshVisual;
        MLComponent: MLComponent;
        ObjectTracker2D: ObjectTracking;
        ObjectTracking: ObjectTracking;
        ObjectTracking3D: ObjectTracking3D;
        "Physics.BodyComponent": BodyComponent;
        "Physics.ColliderComponent": ColliderComponent;
        "Physics.ConstraintComponent": ConstraintComponent;
        "Physics.WorldComponent": WorldComponent;
        PinToMeshComponent: PinToMeshComponent;
        PostEffectVisual: PostEffectVisual;
        RectangleSetter: RectangleSetter;
        RenderMeshVisual: RenderMeshVisual;
        RetouchVisual: RetouchVisual;
        ScreenRegionComponent: ScreenRegionComponent;
        ScreenTransform: ScreenTransform;
        Script: ScriptComponent;
        ScriptComponent: ScriptComponent;
        Skin: Skin;
        SplineComponent: SplineComponent;
        SpriteAligner: SpriteAligner;
        SpriteVisualV2: Image;
        Text: Text;
        Text3D: Text3D;
        Touch: InteractionComponent;
        TouchComponent: InteractionComponent;
        TrackedPointComponent: TrackedPointComponent;
        VertexCache: VertexCache;
        VFXComponent: VFXComponent;
        Visual: Visual;
        WorldTracking: DeviceTracking;
    }
    Index

    Properties

    Animation AnimationMixer AnimationPlayer AudioChainComponent AudioComponent AudioEffectComponent AudioListenerComponent AudioPlayer BaseMeshVisual BlurNoiseEstimation Camera Canvas ClearDepth ClearScreen ClothVisual ColliderComponent ColocatedTrackingComponent Component.Animation Component.AnimationMixer Component.AnimationPlayer Component.AudioChainComponent Component.AudioComponent Component.AudioEffectComponent Component.AudioListenerComponent Component.AudioPlayer Component.BaseMeshVisual Component.BlurNoiseEstimation Component.Camera Component.Canvas Component.ClearDepth Component.ClearScreen Component.ClothVisual Component.ColliderComponent Component.ColocatedTrackingComponent Component.DepthSetter Component.DeviceLocationTrackingComponent Component.DeviceTracking Component.EyeColorVisual Component.FaceInsetVisual Component.FaceMaskVisual Component.FaceStretchVisual Component.FaceSubVisual Component.GaussianSplattingVisual Component.HairSimulationColliderComponent Component.HairVisual Component.Head Component.Hints Component.HintsComponent Component.Image Component.InteractionComponent Component.LightSource Component.LiquifyVisual Component.LocatedAtComponent Component.LookAtComponent Component.ManipulateComponent Component.MarkerTrackingComponent Component.MaskingComponent Component.MaterialMeshVisual Component.MeshVisual Component.MLComponent Component.ObjectTracker2D Component.ObjectTracking Component.ObjectTracking3D Component.PinToMeshComponent Component.PostEffectVisual Component.RectangleSetter Component.RenderMeshVisual Component.RetouchVisual Component.ScreenRegionComponent Component.ScreenTransform Component.Script Component.ScriptComponent Component.Skin Component.SplineComponent Component.SpriteAligner Component.SpriteVisualV2 Component.Text Component.Text3D Component.Touch Component.TouchComponent Component.TrackedPointComponent Component.VertexCache Component.VFXComponent Component.Visual Component.WorldTracking DepthSetter DeviceLocationTrackingComponent DeviceTracking EyeColorVisual FaceInsetVisual FaceMaskVisual FaceStretchVisual FaceSubVisual GaussianSplattingVisual HairSimulationColliderComponent HairVisual Head Hints HintsComponent Image InteractionComponent LightSource LiquifyVisual LocatedAtComponent LookAtComponent ManipulateComponent MarkerTrackingComponent MaskingComponent MaterialMeshVisual MeshVisual MLComponent ObjectTracker2D ObjectTracking ObjectTracking3D Physics.BodyComponent Physics.ColliderComponent Physics.ConstraintComponent Physics.WorldComponent PinToMeshComponent PostEffectVisual RectangleSetter RenderMeshVisual RetouchVisual ScreenRegionComponent ScreenTransform Script ScriptComponent Skin SplineComponent SpriteAligner SpriteVisualV2 Text Text3D Touch TouchComponent TrackedPointComponent VertexCache VFXComponent Visual WorldTracking

    Properties

    Animation: Animation
    AnimationMixer: AnimationMixer
    AnimationPlayer: AnimationPlayer
    AudioChainComponent: AudioEffectComponent
    AudioComponent: AudioComponent
    AudioEffectComponent: AudioEffectComponent
    AudioListenerComponent: AudioListenerComponent
    AudioPlayer: AudioComponent
    BaseMeshVisual: BaseMeshVisual
    BlurNoiseEstimation: BlurNoiseEstimation
    Camera: Camera
    Canvas: Canvas
    ClearDepth: ClearDepth
    ClearScreen: ClearDepth
    ClothVisual: ClothVisual
    ColliderComponent: ColliderComponent
    ColocatedTrackingComponent: ColocatedTrackingComponent
    "Component.Animation": Animation
    "Component.AnimationMixer": AnimationMixer
    "Component.AnimationPlayer": AnimationPlayer
    "Component.AudioChainComponent": AudioEffectComponent
    "Component.AudioComponent": AudioComponent
    "Component.AudioEffectComponent": AudioEffectComponent
    "Component.AudioListenerComponent": AudioListenerComponent
    "Component.AudioPlayer": AudioComponent
    "Component.BaseMeshVisual": BaseMeshVisual
    "Component.BlurNoiseEstimation": BlurNoiseEstimation
    "Component.Camera": Camera
    "Component.Canvas": Canvas
    "Component.ClearDepth": ClearDepth
    "Component.ClearScreen": ClearDepth
    "Component.ClothVisual": ClothVisual
    "Component.ColliderComponent": ColliderComponent
    "Component.ColocatedTrackingComponent": ColocatedTrackingComponent
    "Component.DepthSetter": DepthSetter
    "Component.DeviceLocationTrackingComponent": DeviceLocationTrackingComponent
    "Component.DeviceTracking": DeviceTracking
    "Component.EyeColorVisual": EyeColorVisual
    "Component.FaceInsetVisual": FaceInsetVisual
    "Component.FaceMaskVisual": FaceMaskVisual
    "Component.FaceStretchVisual": FaceStretchVisual
    "Component.FaceSubVisual": FaceMaskVisual
    "Component.GaussianSplattingVisual": GaussianSplattingVisual
    "Component.HairSimulationColliderComponent": ColliderComponent
    "Component.HairVisual": HairVisual
    "Component.Head": Head
    "Component.Hints": HintsComponent
    "Component.HintsComponent": HintsComponent
    "Component.Image": Image
    "Component.InteractionComponent": InteractionComponent
    "Component.LightSource": LightSource
    "Component.LiquifyVisual": LiquifyVisual
    "Component.LocatedAtComponent": LocatedAtComponent
    "Component.LookAtComponent": LookAtComponent
    "Component.ManipulateComponent": ManipulateComponent
    "Component.MarkerTrackingComponent": MarkerTrackingComponent
    "Component.MaskingComponent": MaskingComponent
    "Component.MaterialMeshVisual": MaterialMeshVisual
    "Component.MeshVisual": RenderMeshVisual
    "Component.MLComponent": MLComponent
    "Component.ObjectTracker2D": ObjectTracking
    "Component.ObjectTracking": ObjectTracking
    "Component.ObjectTracking3D": ObjectTracking3D
    "Component.PinToMeshComponent": PinToMeshComponent
    "Component.PostEffectVisual": PostEffectVisual
    "Component.RectangleSetter": RectangleSetter
    "Component.RenderMeshVisual": RenderMeshVisual
    "Component.RetouchVisual": RetouchVisual
    "Component.ScreenRegionComponent": ScreenRegionComponent
    "Component.ScreenTransform": ScreenTransform
    "Component.Script": ScriptComponent
    "Component.ScriptComponent": ScriptComponent
    "Component.Skin": Skin
    "Component.SplineComponent": SplineComponent
    "Component.SpriteAligner": SpriteAligner
    "Component.SpriteVisualV2": Image
    "Component.Text": Text
    "Component.Text3D": Text3D
    "Component.Touch": InteractionComponent
    "Component.TouchComponent": InteractionComponent
    "Component.TrackedPointComponent": TrackedPointComponent
    "Component.VertexCache": VertexCache
    "Component.VFXComponent": VFXComponent
    "Component.Visual": Visual
    "Component.WorldTracking": DeviceTracking
    DepthSetter: DepthSetter
    DeviceLocationTrackingComponent: DeviceLocationTrackingComponent
    DeviceTracking: DeviceTracking
    EyeColorVisual: EyeColorVisual
    FaceInsetVisual: FaceInsetVisual
    FaceMaskVisual: FaceMaskVisual
    FaceStretchVisual: FaceStretchVisual
    FaceSubVisual: FaceMaskVisual
    GaussianSplattingVisual: GaussianSplattingVisual
    HairSimulationColliderComponent: ColliderComponent
    HairVisual: HairVisual
    Head: Head
    Hints: HintsComponent
    HintsComponent: HintsComponent
    Image: Image
    InteractionComponent: InteractionComponent
    LightSource: LightSource
    LiquifyVisual: LiquifyVisual
    LocatedAtComponent: LocatedAtComponent
    LookAtComponent: LookAtComponent
    ManipulateComponent: ManipulateComponent
    MarkerTrackingComponent: MarkerTrackingComponent
    MaskingComponent: MaskingComponent
    MaterialMeshVisual: MaterialMeshVisual
    MeshVisual: RenderMeshVisual
    MLComponent: MLComponent
    ObjectTracker2D: ObjectTracking
    ObjectTracking: ObjectTracking
    ObjectTracking3D: ObjectTracking3D
    "Physics.BodyComponent": BodyComponent
    "Physics.ColliderComponent": ColliderComponent
    "Physics.ConstraintComponent": ConstraintComponent
    "Physics.WorldComponent": WorldComponent
    PinToMeshComponent: PinToMeshComponent
    PostEffectVisual: PostEffectVisual
    RectangleSetter: RectangleSetter
    RenderMeshVisual: RenderMeshVisual
    RetouchVisual: RetouchVisual
    ScreenRegionComponent: ScreenRegionComponent
    ScreenTransform: ScreenTransform
    Script: ScriptComponent
    ScriptComponent: ScriptComponent
    Skin: Skin
    SplineComponent: SplineComponent
    SpriteAligner: SpriteAligner
    SpriteVisualV2: Image
    Text: Text
    Text3D: Text3D
    Touch: InteractionComponent
    TouchComponent: InteractionComponent
    TrackedPointComponent: TrackedPointComponent
    VertexCache: VertexCache
    VFXComponent: VFXComponent
    Visual: Visual
    WorldTracking: DeviceTracking
    MMNEPVFCICPMFPCPTTAAATR