Scripting API
Scripting API
BusEffect
Record in Abyss.Core, from Abyss.Core.
One effect on a bus of the mix: its kind, whether it is on, and its settings in its kind's order.
public record BusEffectConstructors
BusEffect
public BusEffect(BusEffectKind kind)A new effect of kind, on, every setting where it starts.
Parameters
kind
Properties
Kind
public BusEffectKind Kind { get; }What kind it is.
On
public bool On { get; init; }Whether it is on; one off is turned dry.
Type
public BusEffectType Type { get; }Its kind, with its names and settings.
Values
public IReadOnlyList<float> Values { get; }Its settings, in its kind's order.
Methods
Get
public float? Get(BusEffectValue value)Its setting value, or null for one its kind has not.
Parameters
value
With
public BusEffect With(BusEffectValue value, float amount)It with its setting value at amount, kept to its range; itself for a setting its kind has not, or no number.
Parameters
valueamount
Equals
public bool Equals(BusEffect? other)Whether two are the same effect: one kind, both on or off, every setting the same.
Parameters
other
GetHashCode
public override int GetHashCode()