Scripting API

Scripting API

BusEffectType

Record in Abyss.Core, from Abyss.Core.

A kind of bus effect, its names and its settings, as the engine describes it.

public record BusEffectType

Constructors

BusEffectType

public BusEffectType(BusEffectKind Kind, string Key, string Name, IReadOnlyList<BusEffectField> Fields)

A kind of bus effect, its names and its settings, as the engine describes it.

Parameters

  • Kind: Which it is.
  • Key: What settings/audio.json calls it: lowPass.
  • Name: What the editor calls it: Low Pass.
  • Fields: Its settings, in the order the inspector shows them.

Properties

Kind

public BusEffectKind Kind { get; init; }

Which it is.

Key

public string Key { get; init; }

What settings/audio.json calls it: lowPass.

Name

public string Name { get; init; }

What the editor calls it: Low Pass.

Fields

public IReadOnlyList<BusEffectField> Fields { get; init; }

Its settings, in the order the inspector shows them.

Methods

IndexOf

public int IndexOf(BusEffectValue value)

Where its setting value is among its fields, or -1 for one it has not.

Parameters

  • value