Scripting API

Scripting API

ClipFrame

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

One frame of a clip file: the image a sprite shows from a time on, and the slice of it.

public readonly record struct ClipFrame

Constructors

ClipFrame

public ClipFrame(float Time, string Image, AssetGuid Guid, ulong? Slice)

One frame of a clip file: the image a sprite shows from a time on, and the slice of it.

Parameters

  • Time: When it is shown from, in seconds from the clip's start.
  • Image: The image, by its path under the asset root.
  • Guid: The image's identity, which finds it where it has moved; AssetGuid.None where it is not known.
  • Slice: The slice of it, by its identity; null for the whole image.

Properties

Time

public float Time { get; init; }

When it is shown from, in seconds from the clip's start.

Image

public string Image { get; init; }

The image, by its path under the asset root.

Guid

public AssetGuid Guid { get; init; }

The image's identity, which finds it where it has moved; AssetGuid.None where it is not known.

Slice

public ulong? Slice { get; init; }

The slice of it, by its identity; null for the whole image.