Scripting API

Scripting API

PlayingClip

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

One clip an animator plays, as World.AnimatorOf says it.

public readonly record struct PlayingClip

Constructors

PlayingClip

public PlayingClip(ClipId Clip, float Time, float Duration, float Weight, bool Main, bool Loops, bool Finished)

One clip an animator plays, as World.AnimatorOf says it.

Parameters

  • Clip: The clip.
  • Time: How far into it it is, in seconds, within one time round.
  • Duration: How long it is, in seconds; zero until it has landed.
  • Weight: How much of what is drawn it is: 1 alone, less while it is faded in or out.
  • Main: Whether it is the clip last played, which any other is fading out from.
  • Loops: Whether it loops.
  • Finished: Whether it played once and is done.

Properties

Clip

public ClipId Clip { get; init; }

The clip.

Time

public float Time { get; init; }

How far into it it is, in seconds, within one time round.

Duration

public float Duration { get; init; }

How long it is, in seconds; zero until it has landed.

Weight

public float Weight { get; init; }

How much of what is drawn it is: 1 alone, less while it is faded in or out.

Main

public bool Main { get; init; }

Whether it is the clip last played, which any other is fading out from.

Loops

public bool Loops { get; init; }

Whether it loops.

Finished

public bool Finished { get; init; }

Whether it played once and is done.