Scripting API

Scripting API

StateRun

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

One state of an animator's layer, as it runs it.

public readonly record struct StateRun

Constructors

StateRun

public StateRun(float Weight, bool Holds, bool Plays, bool Waits, bool Broken)

One state of an animator's layer, as it runs it.

Parameters

  • Weight: How much of what is drawn its clip, or its blend space, is.
  • Holds: Its condition held on the last frame run.
  • Plays: It is the state its layer plays.
  • Waits: It plays, and another is wanted that it may not be left for yet.
  • Broken: Its condition cannot be run, or its blend space placed: a mistake in it, or a field the world does not have.

Properties

Weight

public float Weight { get; init; }

How much of what is drawn its clip, or its blend space, is.

Holds

public bool Holds { get; init; }

Its condition held on the last frame run.

Plays

public bool Plays { get; init; }

It is the state its layer plays.

Waits

public bool Waits { get; init; }

It plays, and another is wanted that it may not be left for yet.

Broken

public bool Broken { get; init; }

Its condition cannot be run, or its blend space placed: a mistake in it, or a field the world does not have.

Shares

public IReadOnlyList<float> Shares { get; init; }

Each of its blend space's points' share of the mix where its fields are now, in order; none for a state that plays a clip.

At

public Vector2 At { get; init; }

Where its blend space's fields are now: along its first, and its second on a plane.