Scripting API

Scripting API

Sound

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

A sound a game asked for, by the number it was given: what it is asked to stop, pause, resume or change, and asked whether it still plays. Plain data, so a component can keep one.

public readonly record struct Sound

Constructors

Sound

public Sound(ulong Id)

A sound a game asked for, by the number it was given: what it is asked to stop, pause, resume or change, and asked whether it still plays. Plain data, so a component can keep one.

Parameters

  • Id: The engine's number for it; zero is none.

Properties

Id

public ulong Id { get; init; }

The engine's number for it; zero is none.

None

public static Sound None { get; }

No sound.

IsNone

public bool IsNone { get; }

Whether this names no sound.