Scripting API

Scripting API

Fired<T>

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

One event of type T a clip fired on an animator as it passed it: what a system reads with SystemContext.Events, and a flow awaits with GameCode.AnimationEvent.

public readonly record struct Fired<T> where T : unmanaged

Type parameters

Constructors

Fired

public Fired(ulong Animator, ClipId Clip, float Time, float Weight, T Event)

One event of type T a clip fired on an animator as it passed it: what a system reads with SystemContext.Events, and a flow awaits with GameCode.AnimationEvent.

Parameters

  • Animator: The animator: the entity with an Animator, a model's instance's root.
  • Clip: The clip that fired it.
  • Time: Its time on the clip, in seconds.
  • Weight: How much of what is drawn the clip was: 1 alone.
  • Event: The struct, its fields as the clip's timeline set them.

Properties

Animator

public ulong Animator { get; init; }

The animator: the entity with an Animator, a model's instance's root.

Clip

public ClipId Clip { get; init; }

The clip that fired it.

Time

public float Time { get; init; }

Its time on the clip, in seconds.

Weight

public float Weight { get; init; }

How much of what is drawn the clip was: 1 alone.

Event

public T Event { get; init; }

The struct, its fields as the clip's timeline set them.