Binding of RoR::Sound; a single sound sample positioned in 3D space (spatial audio). More...

#include <SoundClass.h>

Public Member Functions
void	setPitch (float pitch)

void	setGain (float gain)

void	setPosition (vector3 pos)

void	setVelocity (vector3 vel)

void	setLoop (bool loop)

void	setEnabled (bool e)

void	play ()

void	stop ()

bool	getEnabled ()

bool	isPlaying ()

float	getAudibility ()

float	getGain ()

float	getPitch ()

bool	getLoop ()

int	getCurrentHardwareIndex ()
	this value is changed dynamically, depending on whether the input is played or not. More...

uint	getBuffer ()

vector3	getPosition ()

vector3	getVelocity ()

int	getSourceIndex ()
	must not be changed during the lifetime of this object. More...

void	setPitch (float pitch)

void	setGain (float gain)

void	setPosition (vector3 pos)

void	setVelocity (vector3 vel)

void	setLoop (bool loop)

void	setEnabled (bool e)

void	play ()

void	stop ()

bool	getEnabled ()

bool	isPlaying ()

float	getAudibility ()

float	getGain ()

float	getPitch ()

bool	getLoop ()

int	getCurrentHardwareIndex ()
	this value is changed dynamically, depending on whether the input is played or not. More...

uint	getBuffer ()

vector3	getPosition ()

vector3	getVelocity ()

int	getSourceIndex ()
	must not be changed during the lifetime of this object. More...

Detailed Description

Binding of RoR::Sound; a single sound sample positioned in 3D space (spatial audio).

Note: To create the object, use GameScriptClass::createSoundFromResource()

Definition at line 17 of file SoundClass.h.

Member Function Documentation

◆ getAudibility() [1/2]

float Script2Game::SoundClass::getAudibility ( )

◆ getAudibility() [2/2]

float Script2Game::SoundClass::getAudibility ( )

◆ getBuffer() [1/2]

uint Script2Game::SoundClass::getBuffer ( )

◆ getBuffer() [2/2]

uint Script2Game::SoundClass::getBuffer ( )

◆ getCurrentHardwareIndex() [1/2]

int Script2Game::SoundClass::getCurrentHardwareIndex ( )

this value is changed dynamically, depending on whether the input is played or not.

◆ getCurrentHardwareIndex() [2/2]

int Script2Game::SoundClass::getCurrentHardwareIndex ( )

this value is changed dynamically, depending on whether the input is played or not.

◆ getEnabled() [1/2]

bool Script2Game::SoundClass::getEnabled ( )

◆ getEnabled() [2/2]

bool Script2Game::SoundClass::getEnabled ( )

◆ getGain() [1/2]

float Script2Game::SoundClass::getGain ( )

◆ getGain() [2/2]

float Script2Game::SoundClass::getGain ( )

◆ getLoop() [1/2]

bool Script2Game::SoundClass::getLoop ( )

◆ getLoop() [2/2]

bool Script2Game::SoundClass::getLoop ( )

◆ getPitch() [1/2]

float Script2Game::SoundClass::getPitch ( )

◆ getPitch() [2/2]

float Script2Game::SoundClass::getPitch ( )

◆ getPosition() [1/2]

vector3 Script2Game::SoundClass::getPosition ( )

◆ getPosition() [2/2]

vector3 Script2Game::SoundClass::getPosition ( )

◆ getSourceIndex() [1/2]

int Script2Game::SoundClass::getSourceIndex ( )

must not be changed during the lifetime of this object.

◆ getSourceIndex() [2/2]

int Script2Game::SoundClass::getSourceIndex ( )

must not be changed during the lifetime of this object.

◆ getVelocity() [1/2]

vector3 Script2Game::SoundClass::getVelocity ( )

◆ getVelocity() [2/2]

vector3 Script2Game::SoundClass::getVelocity ( )

◆ isPlaying() [1/2]

bool Script2Game::SoundClass::isPlaying ( )

◆ isPlaying() [2/2]

bool Script2Game::SoundClass::isPlaying ( )

◆ play() [1/2]

void Script2Game::SoundClass::play ( )

◆ play() [2/2]

void Script2Game::SoundClass::play ( )

◆ setEnabled() [1/2]

void Script2Game::SoundClass::setEnabled ( bool e )

◆ setEnabled() [2/2]