Scripting API

Scripting API

AudioClipId

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

The id of a sound clip the engine loaded. See MeshId.

public readonly record struct AudioClipId

Remarks

A clip is a file of the project's — WAV, OGG Vorbis, MP3 or FLAC — or its entry in a pack, played by WorldAudio.Play and its kin, as often as asked and all at once if asked.

Constructors

AudioClipId

public AudioClipId(ulong Value)

The id of a sound clip the engine loaded. See MeshId.

Parameters

  • Value: The engine's id.

A clip is a file of the project's — WAV, OGG Vorbis, MP3 or FLAC — or its entry in a pack, played by WorldAudio.Play and its kin, as often as asked and all at once if asked.

Properties

Value

public ulong Value { get; init; }

The engine's id.

None

public static AudioClipId None { get; }

No clip.

IsNone

public bool IsNone { get; }

Whether this names no clip.

Methods

ToString

public override string ToString()

The id as a person reads it: sound clip 3.