Editor Scripting API
    Preparing search index...

    Class FaceMesh

    A native asset that provides a 3D mesh of the user's face. Import with Editor.Model.AssetManager#createNativeAsset. Learn more in the Face Mesh guide.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    cacheFile earGeometryEnabled expressionMultiplier externalMesh externalMeshMapUV externalScale eyeCornerGeometryEnabled eyeGeometryEnabled faceGeometryEnabled faceIndex fileMeta id meta mouthGeometryEnabled name skullGeometryEnabled type

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    cacheFile: Path

    Path to the cached asset file.

    earGeometryEnabled: boolean

    Enable ear geometry rendering.

    expressionMultiplier: number

    Scale factor applied to facial expressions.

    externalMesh: FileMesh

    Custom mesh to replace the default face mesh.

    externalMeshMapUV: VertexAttribute

    UV vertex attribute mapping for the external mesh.

    externalScale: number

    Scale factor for the external mesh.

    eyeCornerGeometryEnabled: boolean

    Enable eye corner geometry rendering.

    eyeGeometryEnabled: boolean

    Enable eye geometry rendering.

    faceGeometryEnabled: boolean

    Enable face geometry rendering.

    faceIndex: number

    Index of the tracked face this mesh represents.

    fileMeta: Editor.Model.AssetImportMetadata

    Import metadata for the asset.

    id: Uuid

    The unique id of the entity.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    mouthGeometryEnabled: boolean

    Enable mouth geometry rendering.

    name: string

    The name of the asset.

    skullGeometryEnabled: boolean

    Enable skull geometry rendering.

    type: string

    The entity's type.

    Methods

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods