Struct AudioEventOptions

Namespace

BSGameLib.Game.Audio

Assembly

BSGameLib.Game.dll

Overrides for one PostEvent(string, AudioEventOptions?) call. Null fields keep the event's own values.

public readonly struct AudioEventOptions

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

AudioEventOptions(float?, int?, bool)

Creates options for one post. Null arguments keep the event's own values.

public AudioEventOptions(float? volume = null, int? fadeInMilliseconds = null, bool skipIntro = false)

Parameters

volume float?

fadeInMilliseconds int?

skipIntro bool

Properties

FadeInMilliseconds

How long this post takes to fade in, replacing the event's own FadeInMilliseconds. For music, the track playing before fades out over the same time, so the two crossfade.

public int? FadeInMilliseconds { get; }

Property Value

int?

SkipIntro

Starts music at its body, leaving out its IntroAsset: music coming back after an interruption, such as a map's after a battle. Ignored for an event without an intro.

public bool SkipIntro { get; }

Property Value

bool

Volume

The volume for this post, from 0 to 1, in place of the event's Volume.

public float? Volume { get; }

Property Value

float?