Class LemonUI::Sound

ClassList > LemonUI > Sound

Contains information for a Game Sound that is played at specific times.

Public Properties

Type	Name
property string??	File The name of the sound file.
property int	Id The ID of the sound, if is being played.
property string??	Set The Set where the sound is located.

Public Functions

Type	Name
void	PlayFrontend () Plays the sound for the local Player.
void	PlayFrontend (bool release) Plays the sound for the local Player.
void	Release () Releases the Sound ID.
	Sound (string set, string file) Creates a new Sound class with the specifiedSound Set and File.
void	Stop () Stops the audio from playing.

Public Properties Documentation

property File

string?? LemonUI.Sound.File;

property Id

int LemonUI.Sound.Id;

property Set

string?? LemonUI.Sound.Set;

Public Functions Documentation

function PlayFrontend [1/2]

void LemonUI::Sound::PlayFrontend () 

function PlayFrontend [2/2]

Plays the sound for the local Player.

inline void LemonUI::Sound::PlayFrontend (
    bool release
) 

Parameters:

• release If the sound ID should be automatically released.

function Release

inline void LemonUI::Sound::Release () 

function Sound

Creates a new Sound class with the specifiedSound Set and File.

inline LemonUI::Sound::Sound (
    string set,
    string file
) 

Parameters:

• set The Set where the sound is located.
• file The name of the sound file.

function Stop

inline void LemonUI::Sound::Stop () 

---

The documentation for this class was generated from the following file repos/LemonUI/LemonUI/Sound.cs