GDF.Sounds Class Referentie

De class waarmee je geluiden kan afspelen of loopen. Meer...

Public Members
void	gdf_Update ()

Static Public Members
static void	Preload (params string[] filenames)
	Laad geluiden alvast in, zodat ze later direct (zonder vertraging) kunnen worden afgespeeld.
static void	RemoveSoundLoop (string name)
	Stop en verwijder een soundloop.
static void	AddSoundLoop (string systemName, string filename, float volume=1)
	Voeg een soundloop toe.
static void	AddSoundLoop (string filename, float volume=1)
	Voeg een soundloop toe.
static void	AddSoundLoop (string systemName, string filename, Instance player, Instance listener, float maxDistance=25)
	Voeg een soundloop toe die automatisch minder luid wordt als het luisterend voorwerp zich verder weg beweegt.
static void	AddSoundLoop (string filename, Instance player, Instance listener, float maxDistance=25)
	Voeg een soundloop toe die automatisch minder luid wordt als het luisterend voorwerp zich verder weg beweegt.
static void	AddSoundLoop (string systemName, string filename, Type nearestPlayer, Instance listener, float maxDistance=25)
	Voeg een soundloop toe die automatisch luider wordt als er een voorwerp van een opgegeven type in de buurt komt.
static void	AddSoundLoop (string filename, Type nearestPlayer, Instance listener, float maxDistance=25)
	Voeg een soundloop toe die automatisch luider wordt als er een voorwerp van een opgegeven type in de buurt komt.
static void	Play (string filename, float volume=1)
	Speelt direct een geluid af.
static void	Play (string systemname, string filename, float volume=1)
	Speelt direct een geluid af, en geef deze een naam waarmee hij later nog te bewerken is.
static void	StopSound (string systemname)
static void	PauseSound (string systemname, bool isPaused)
static void	SetVolume (string systemname, float volume)
static void	RemoveSound (string systemname)
static bool	SoundIsFinished (string systemname)
static void	Play (string filename, Vector3 origin, Vector3 listener, float maxDistanceToInstance=25)
	Speel direct een geluid af op een bepaalde plek.
static void	SetSoundLoopBaseVolume (string name, float volume)
	Stel het basisvolume van een soundloop in.
static void	FadeOutSoundLoop (string name, int frames)
	Laat een soundloop uitfaden.
static void	FadeInSoundLoop (string name, int frames)
	Laat een soundloop infaden.
static bool	SoundLoopExists (string name)
	Bestaat er een soundloop met de opgegeven naam?

Static Public Attributen
static string	SoundsFolder = "Data/Sounds/"
	De plaats waar de geluidsbestanden staan.

Protected Members
	Sounds ()

Properties
static Sounds	gdf_Player [get]

Gedetailleerde Beschrijving

De class waarmee je geluiden kan afspelen of loopen.

Constructor & Destructor Documentatie

Sounds()

GDF.Sounds.Sounds ( )

protected

Documentatie van functie members

AddSoundLoop() [1/6]

void GDF.Sounds.AddSoundLoop ( string filename, float volume = 1 )

static

Voeg een soundloop toe.

Parameters

filename	De bestandsnaam
volume	Het volume, standaard 1

AddSoundLoop() [2/6]

void GDF.Sounds.AddSoundLoop ( string filename, Instance player, Instance listener, float maxDistance = 25 )

static

Voeg een soundloop toe die automatisch minder luid wordt als het luisterend voorwerp zich verder weg beweegt.

Parameters

filename	De bestandsnaam
player	Het voorwerp dat het geluid afspeelt
listener	Het voorwerp dat naar het geluid luistert
maxDistance	De maximale hoorafstand van het geluid

AddSoundLoop() [3/6]

void GDF.Sounds.AddSoundLoop ( string filename, Type nearestPlayer, Instance listener, float maxDistance = 25 )

static

Voeg een soundloop toe die automatisch luider wordt als er een voorwerp van een opgegeven type in de buurt komt.

Parameters

filename	De bestandsnaam
nearestPlayer	Het type voorwerp dat afspeelt
listener	Het luisterende voorwerp
maxDistance	De maximale hoorafstand van het geluid

AddSoundLoop() [4/6]

void GDF.Sounds.AddSoundLoop ( string systemName, string filename, float volume = 1 )

static

Voeg een soundloop toe.

Parameters

filename	De bestandsnaam
systemName	De systeemnaam waarmee je de soundloop later nog kan bewerken
volume	Het volume, standaard 1

AddSoundLoop() [5/6]

void GDF.Sounds.AddSoundLoop ( string systemName, string filename, Instance player, Instance listener, float maxDistance = 25 )

static

Voeg een soundloop toe die automatisch minder luid wordt als het luisterend voorwerp zich verder weg beweegt.

Parameters

filename	De bestandsnaam
systemName	De systeemnaam waarmee je de soundloop later nog kan bewerken.
player	Het voorwerp dat het geluid afspeelt
listener	Het voorwerp dat naar het geluid luistert
maxDistance	De maximale hoorafstand van het geluid

AddSoundLoop() [6/6]

void GDF.Sounds.AddSoundLoop ( string systemName, string filename, Type nearestPlayer, Instance listener, float maxDistance = 25 )

static

Voeg een soundloop toe die automatisch luider wordt als er een voorwerp van een opgegeven type in de buurt komt.

Parameters

filename	De bestandsnaam
systemName	De systeemnaam
nearestPlayer	Het type voorwerp dat afspeelt
listener	Het luisterende voorwerp
maxDistance	De maximale hoorafstand van het geluid

FadeInSoundLoop()

void GDF.Sounds.FadeInSoundLoop ( string name, int frames )

static

Laat een soundloop infaden.

Parameters

name	De systeemnaam van de soundloop
frames	Het aantal frames waarna het geluid volledig is ingefaded

FadeOutSoundLoop()

void GDF.Sounds.FadeOutSoundLoop ( string name, int frames )

static

Laat een soundloop uitfaden.

Parameters

name	De systeemnaam van de soundloop
frames	Het aantal frames waarna het geluid niet meer te horen is

gdf_Update()

void GDF.Sounds.gdf_Update

(

)

PauseSound()

void GDF.Sounds.PauseSound ( string systemname, bool isPaused )

static

Play() [1/3]

void GDF.Sounds.Play ( string filename, float volume = 1 )

static

Speelt direct een geluid af.

Play() [2/3]

void GDF.Sounds.Play ( string filename, Vector3 origin, Vector3 listener, float maxDistanceToInstance = 25 )

static

Speel direct een geluid af op een bepaalde plek.

Het geluid is zachter naarmate deze plek verder weg is van de afspeelpositie.

Parameters

filename	De bestandsnaam
origin	De positie waar het geluid wordt afgespeeld
listener	De positie waar op er naar het geluid wordt geluisterd
maxDistanceToInstance	De maximale hoorafstand van het geluid

Play() [3/3]

void GDF.Sounds.Play ( string systemname, string filename, float volume = 1 )

static

Speelt direct een geluid af, en geef deze een naam waarmee hij later nog te bewerken is.

Preload()

void GDF.Sounds.Preload ( params string[] filenames )

static

Laad geluiden alvast in, zodat ze later direct (zonder vertraging) kunnen worden afgespeeld.

Vooral handig voor lange muziekbestanden (.ogg), die bij het laden worden uitgepakt. Mag ook vóór Game.Run worden aangeroepen; het laden gebeurt dan zodra het spel start.

Parameters

filenames

De bestandsnamen (in de map Data/Sounds/)

RemoveSound()

void GDF.Sounds.RemoveSound ( string systemname )

static

RemoveSoundLoop()

void GDF.Sounds.RemoveSoundLoop ( string name )

static

Stop en verwijder een soundloop.

Parameters

name	De systeemnaam van de soundloop

SetSoundLoopBaseVolume()

void GDF.Sounds.SetSoundLoopBaseVolume ( string name, float volume )

static

Stel het basisvolume van een soundloop in.

///

Parameters

name	De systeemnaam van de soundloop
volume	Het volume tussen 0 en 1

SetVolume()

void GDF.Sounds.SetVolume ( string systemname, float volume )

static

SoundIsFinished()

bool GDF.Sounds.SoundIsFinished ( string systemname )

static

SoundLoopExists()

bool GDF.Sounds.SoundLoopExists ( string name )

static

Bestaat er een soundloop met de opgegeven naam?

Parameters

name

Retourneert

StopSound()

void GDF.Sounds.StopSound ( string systemname )

static

Documentatie van data members

SoundsFolder

string GDF.Sounds.SoundsFolder = "Data/Sounds/"

static

De plaats waar de geluidsbestanden staan.

Standaard: Data/Sounds/

Property Documentatie

gdf_Player

Sounds GDF.Sounds.gdf_Player

staticget

---

De documentatie voor deze klasse is gegenereerd op basis van het volgende bestand:

• src/Sounds.cs