Scripting API
Scripting API
BusEffectField
Record in Abyss.Core, from Abyss.Core.
One setting of a kind of bus effect, as the engine describes it.
public record BusEffectFieldConstructors
BusEffectField
public BusEffectField(BusEffectValue Value, string Key, string Name, float Least, float Most, float Start, string Unit, bool Log, IReadOnlyList<string> Choices, IReadOnlyList<string> ChoiceKeys)One setting of a kind of bus effect, as the engine describes it.
Parameters
Value: Which setting it is.Key: Whatsettings/audio.jsoncalls it:cutoff.Name: What the inspector calls it:Cutoff.Least: The least it goes.Most: The most it goes.Start: Where a new effect starts.Unit:Hz,ms,dB,%for a share shown as a percentage,:1for a ratio, or empty.Log: Whether a slider moves through it as a logarithm, as through a frequency or a time.Choices: For one of a few, what each is called, by its number; empty otherwise.ChoiceKeys: Whatsettings/audio.jsoncalls each ofChoices.
Properties
Value
public BusEffectValue Value { get; init; }Which setting it is.
Key
public string Key { get; init; }What settings/audio.json calls it: cutoff.
Name
public string Name { get; init; }What the inspector calls it: Cutoff.
Least
public float Least { get; init; }The least it goes.
Most
public float Most { get; init; }The most it goes.
Start
public float Start { get; init; }Where a new effect starts.
Unit
public string Unit { get; init; }Hz, ms, dB, % for a share shown as a percentage, :1 for a ratio, or empty.
Log
public bool Log { get; init; }Whether a slider moves through it as a logarithm, as through a frequency or a time.
Choices
public IReadOnlyList<string> Choices { get; init; }For one of a few, what each is called, by its number; empty otherwise.
ChoiceKeys
public IReadOnlyList<string> ChoiceKeys { get; init; }What settings/audio.json calls each of Choices.
IsChoice
public bool IsChoice { get; }Whether it is one of a few rather than a number.
Methods
Held
public float? Held(float amount)amount kept to its range, and to a whole one for a choice; null for no number.
Parameters
amount
