Struct SoundInstance

Namespace

SkyrimForge.Game

Assembly

SkyrimForge.Game.dll

A playback the game started, which Sound's Play and ObjectReference's PlaySoundFile return.

public readonly struct SoundInstance : IEquatable<SoundInstance>

Implements

IEquatable<SoundInstance>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Properties

Id

The game's ID of the playback, which Papyrus's Sound.Play returns as an int.

public uint Id { get; }

Property Value

uint

Methods

Equals(SoundInstance)

public bool Equals(SoundInstance other)

Parameters

other SoundInstance

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

SetVolume(float)

Sets the playback's volume, as Papyrus's Sound.SetInstanceVolume does.

public void SetVolume(float volume)

Parameters

volume float

The volume, from 0 to 1.

Remarks

Call on the game's thread.

Stop()

Stops the playback, as Papyrus's Sound.StopInstance does.

public void Stop()

Remarks

Call on the game's thread.

ToString()

public override string ToString()

Returns

string

Operators

operator ==(SoundInstance, SoundInstance)

public static bool operator ==(SoundInstance left, SoundInstance right)

Parameters

left SoundInstance

right SoundInstance

Returns

bool

operator !=(SoundInstance, SoundInstance)

public static bool operator !=(SoundInstance left, SoundInstance right)

Parameters

left SoundInstance

right SoundInstance

Returns

bool