Table of Contents

Class SoundEvent

Namespace
TaleWorlds.Engine
Assembly
TaleWorlds.Engine.dll
public class SoundEvent
Inheritance
SoundEvent
Inherited Members

Properties

IsValid

public bool IsValid { get; }

Property Value

bool

Methods

CreateEvent(int, Scene)

public static SoundEvent CreateEvent(int soundCodeId, Scene scene)

Parameters

soundCodeId int
scene Scene

Returns

SoundEvent

CreateEventFromExternalFile(string, string, Scene)

public static SoundEvent CreateEventFromExternalFile(string programmerEventName, string soundFilePath, Scene scene)

Parameters

programmerEventName string
soundFilePath string
scene Scene

Returns

SoundEvent

CreateEventFromSoundBuffer(string, byte[], Scene)

public static SoundEvent CreateEventFromSoundBuffer(string eventId, byte[] soundData, Scene scene)

Parameters

eventId string
soundData byte[]
scene Scene

Returns

SoundEvent

CreateEventFromString(string, Scene)

public static SoundEvent CreateEventFromString(string eventId, Scene scene)

Parameters

eventId string
scene Scene

Returns

SoundEvent

GetEventIdFromString(string)

public static int GetEventIdFromString(string name)

Parameters

name string

Returns

int

GetEventMinMaxDistance()

public Vec3 GetEventMinMaxDistance()

Returns

Vec3

GetSoundId()

public int GetSoundId()

Returns

int

GetTotalEventCount()

public static int GetTotalEventCount()

Returns

int

IsNullSoundEvent()

public bool IsNullSoundEvent()

Returns

bool

IsPaused()

public bool IsPaused()

Returns

bool

IsPlaying()

public bool IsPlaying()

Returns

bool

Pause()

public void Pause()

Play()

public bool Play()

Returns

bool

PlayExtraEvent(string)

public void PlayExtraEvent(string eventName)

Parameters

eventName string

PlayInPosition(Vec3)

public bool PlayInPosition(Vec3 position)

Parameters

position Vec3

Returns

bool

PlaySound2D(int)

public static bool PlaySound2D(int soundCodeId)

Parameters

soundCodeId int

Returns

bool

PlaySound2D(string)

public static bool PlaySound2D(string soundName)

Parameters

soundName string

Returns

bool

Release()

public void Release()

Resume()

public void Resume()

SetEventMinMaxDistance(Vec3)

public void SetEventMinMaxDistance(Vec3 newRadius)

Parameters

newRadius Vec3

SetParameter(int, float)

public void SetParameter(int parameterIndex, float value)

Parameters

parameterIndex int
value float

SetParameter(string, float)

public void SetParameter(string parameterName, float value)

Parameters

parameterName string
value float

SetPosition(Vec3)

public void SetPosition(Vec3 vec)

Parameters

vec Vec3

SetSwitch(string, string)

public void SetSwitch(string switchGroupName, string newSwitchStateName)

Parameters

switchGroupName string
newSwitchStateName string

SetVelocity(Vec3)

public void SetVelocity(Vec3 vec)

Parameters

vec Vec3

Stop()

public void Stop()

TriggerCue()

public void TriggerCue()

This page was last modified at 09/01/2024 16:12:00 +00:00 (UTC).