Scripting API
Scripting API
ClipSettings
Record in Abyss.Core, from Abyss.Core.
How a model's clips are imported, beside how its meshes are: whether they are at all, which of them loop, and the events, curves and sync markers on each. A setting of each clip, by its name, as the model's inspector edits it.
public record ClipSettingsRemarks
Kept in the model's sidecar with its other settings, in its import block: "importAnimation": false where its clips are left out, "loop", the names of those that loop, and "events", "curves" and "markers", each clip's by its name. Nothing at all for the defaults — every clip imported, each played once, with nothing on it — so a model nobody has configured has the sidecar it always had.
Not one of ImportSettings' numbers, which cross into the engine as a struct of sixteen of them: a list of names cannot. It crosses as the JSON ClipSettings.ToJson writes, which the engine's import reads beside them.
Constructors
ClipSettings
public ClipSettings(bool Import, IReadOnlyList<string> Looped)How a model's clips are imported, beside how its meshes are: whether they are at all, which of them loop, and the events, curves and sync markers on each. A setting of each clip, by its name, as the model's inspector edits it.
Parameters
Import: Whether its clips are imported. Its skins are either way: a skin is how its meshes are drawn.Looped: The names of the clips that loop, in order; every other plays once.
Kept in the model's sidecar with its other settings, in its import block: "importAnimation": false where its clips are left out, "loop", the names of those that loop, and "events", "curves" and "markers", each clip's by its name. Nothing at all for the defaults — every clip imported, each played once, with nothing on it — so a model nobody has configured has the sidecar it always had.
Not one of ImportSettings' numbers, which cross into the engine as a struct of sixteen of them: a list of names cannot. It crosses as the JSON ClipSettings.ToJson writes, which the engine's import reads beside them.
Properties
Import
public bool Import { get; init; }Whether its clips are imported. Its skins are either way: a skin is how its meshes are drawn.
Looped
public IReadOnlyList<string> Looped { get; init; }The names of the clips that loop, in order; every other plays once.
Default
public static ClipSettings Default { get; }Every clip imported, each to play once: what a model nobody configured has.
Events
public IReadOnlyDictionary<string, IReadOnlyList<ClipEvent>> Events { get; init; }The events on each clip that has any, by its name, each list in the order of its times.
Curves
public IReadOnlyDictionary<string, IReadOnlyList<ClipCurve>> Curves { get; init; }The curves on each clip that has any, by its name.
Markers
public IReadOnlyDictionary<string, IReadOnlyList<ClipMarker>> Markers { get; init; }The sync markers on each clip that has any, by its name, each list in the order of its times.
Skeleton
public AssetGuid Skeleton { get; init; }The model whose skeleton these clips are for, by its identity, where they are another's — an animation exported on its own beside its model — or none for the file's own: what the clips' picture plays them on, and whose bones the Inspector lists theirs against. The editor's alone, kept in the sidecar as "skeleton": the import never reads it, and an animator plays a clip on whatever skeleton it is over, its bones found by their names.
SaysNothing
public bool SaysNothing { get; }Whether these are the defaults.
Methods
MarkersOf
public IReadOnlyList<ClipMarker> MarkersOf(string clip)The sync markers on a clip, by its name, in the order of their times; none for a clip with none.
Parameters
clip
WithMarkers
public ClipSettings WithMarkers(string clip, IEnumerable<ClipMarker> markers)These settings with a clip's sync markers as given, put in the order of their times; none takes the clip's away.
Parameters
clip: The clip, by its name.markers: Its markers.
CurvesOf
public IReadOnlyList<ClipCurve> CurvesOf(string clip)The curves on a clip, by its name; none for a clip with none.
Parameters
clip
WithCurves
public ClipSettings WithCurves(string clip, IEnumerable<ClipCurve> curves)These settings with a clip's curves as given; none takes the clip's away.
Parameters
clip: The clip, by its name.curves: Its curves, each with its keys in the order of their times.
EventsOf
public IReadOnlyList<ClipEvent> EventsOf(string clip)The events on a clip, by its name, in the order of their times; none for a clip with none.
Parameters
clip
WithEvents
public ClipSettings WithEvents(string clip, IEnumerable<ClipEvent> events)These settings with a clip's events as given, put in the order of their times; none takes the clip's away.
Parameters
clip: The clip, by its name.events: Its events.
Loops
public bool Loops(string clip)Whether a clip loops, by its name.
Parameters
clip
WithLoop
public ClipSettings WithLoop(string clip, bool loops)These settings with a clip looping, or not.
Parameters
clip: The clip, by its name.loops: Whether it loops.
ToJson
public string? ToJson()What the engine's import reads: null for the defaults. The skeleton is the editor's, and left out.
Equals
public bool Equals(ClipSettings? other)Whether two say the same, lists and events and all.
Parameters
other
GetHashCode
public override int GetHashCode()