Table of Contents

Class SoundScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from Sound.psc.

public static class SoundScript
Inheritance
SoundScript
Inherited Members

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

GetDescriptor(PapyrusScript<Sound>)

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC

public static Task<SoundDescriptor?> GetDescriptor(this PapyrusScript<Sound> self)

Parameters

self PapyrusScript<Sound>

Returns

Task<SoundDescriptor?>

Play(PapyrusScript<Sound>, IObjectReference)

Play this sound base object from the specified source

[Obsolete("Uses the Papyrus virtual machine. Prefer Sound.Play(BSAudioManager, IObjectReference).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> Play(this PapyrusScript<Sound> self, IObjectReference akSource)

Parameters

self PapyrusScript<Sound>
akSource IObjectReference

Returns

Task<int>

PlayAndWait(PapyrusScript<Sound>, IObjectReference)

Play this sound from the specified source, and wait for it to finish

[Obsolete("Uses the Papyrus virtual machine. Prefer Sound.PlayAndWait(BSAudioManager, IUtility, IObjectReference, CancellationToken).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> PlayAndWait(this PapyrusScript<Sound> self, IObjectReference akSource)

Parameters

self PapyrusScript<Sound>
akSource IObjectReference

Returns

Task<bool>

SetInstanceVolume(int, float)

Set the volume of a given playback instance of a sound. Clamped between 0 and 1.

public static Task SetInstanceVolume(int aiPlaybackInstance, float afVolume)

Parameters

aiPlaybackInstance int
afVolume float

Returns

Task

StopInstance(int)

Stops a given playback instance of a sound

public static Task StopInstance(int aiPlaybackInstance)

Parameters

aiPlaybackInstance int

Returns

Task