Scripting API

Scripting API

ClipId

Record struct in Abyss.Core, from Abyss.Core.

The id of a model's clip the engine loaded. See MeshId.

public readonly record struct ClipId

Remarks

A clip is a piece of its model, named after the model's path, as a mesh is: models/fox.gltf#Walk. It is played on an entity with an animator — a model's prefab has one at its root wherever the model has clips or a skin — by World.Play or CommandBuffer.Play.

Constructors

ClipId

public ClipId(ulong Value)

The id of a model's clip the engine loaded. See MeshId.

Parameters

  • Value: The engine's id.

A clip is a piece of its model, named after the model's path, as a mesh is: models/fox.gltf#Walk. It is played on an entity with an animator — a model's prefab has one at its root wherever the model has clips or a skin — by World.Play or CommandBuffer.Play.

Properties

Value

public ulong Value { get; init; }

The engine's id.

None

public static ClipId None { get; }

No clip.

IsNone

public bool IsNone { get; }

Whether this names no clip.

Methods

ToString

public override string ToString()

The id as a person reads it: clip 3.