Scripting API

Scripting API

AnimatorState

Record in Abyss.Core, from Abyss.Core.

What an animator plays: each clip, the one last played first.

public record AnimatorState

Constructors

AnimatorState

public AnimatorState(IReadOnlyList<PlayingClip> Clips)

What an animator plays: each clip, the one last played first.

Parameters

  • Clips: Each clip it plays, the one last played first; none when it plays nothing.

Properties

Clips

public IReadOnlyList<PlayingClip> Clips { get; init; }

Each clip it plays, the one last played first; none when it plays nothing.

Main

public PlayingClip? Main { get; }

The clip last played, which is what it plays once any fade is done; null for none.

Clip

public ClipId Clip { get; }

The clip last played, or ClipId.None.

Time

public float Time { get; }

How far into the clip last played it is, in seconds; zero for none.

Finished

public bool Finished { get; }

Whether the clip last played played once and is done; false for none.

Idle

public bool Idle { get; }

Whether it plays nothing.

Methods

Plays

public bool Plays(ClipId clip)

Whether it plays a clip, as the clip last played or one fading out.

Parameters

  • clip