Description

Binding of RoR::SoundScriptTemplate; a customizable sound effect.

Remarks: Defined using soundscript file format, see https://docs.rigsofrods.org/vehicle-creation/fileformat-soundscript/.

Definition at line 16 of file SoundScriptTemplateClass.h.

Public Member Functions
int	getNumSounds ()

string	getSoundName (int)

float	getSoundPitch (int)

Data Fields
string	name

string	file_name

string	group_name

bool	base_template

bool	has_start_sound

bool	has_stop_sound

bool	unpitchable

float	gain_multiplier

float	gain_offset

float	gain_square

ModulationSources gain_source float	pitch_multiplier

float	pitch_offset

float	pitch_square

ModulationSources pitch_source string	start_sound_name

float	start_sound_pitch

string	stop_sound_name

float	stop_sound_pitch

SoundTriggers	trigger_source

Member Function Documentation

◆ getNumSounds()

int Script2Game::SoundScriptTemplateClass::getNumSounds ( )

◆ getSoundName()

string Script2Game::SoundScriptTemplateClass::getSoundName ( int )

◆ getSoundPitch()

float Script2Game::SoundScriptTemplateClass::getSoundPitch ( int )

Field Documentation

◆ base_template

bool Script2Game::SoundScriptTemplateClass::base_template

This template is from the base game, not from a mod.

Definition at line 30 of file SoundScriptTemplateClass.h.

◆ file_name

string Script2Game::SoundScriptTemplateClass::file_name

Definition at line 24 of file SoundScriptTemplateClass.h.

◆ gain_multiplier

float Script2Game::SoundScriptTemplateClass::gain_multiplier

Definition at line 35 of file SoundScriptTemplateClass.h.

◆ gain_offset

float Script2Game::SoundScriptTemplateClass::gain_offset

Definition at line 36 of file SoundScriptTemplateClass.h.

◆ gain_square

float Script2Game::SoundScriptTemplateClass::gain_square

Definition at line 37 of file SoundScriptTemplateClass.h.

◆ group_name

string Script2Game::SoundScriptTemplateClass::group_name

Definition at line 25 of file SoundScriptTemplateClass.h.

◆ has_start_sound

bool Script2Game::SoundScriptTemplateClass::has_start_sound

Definition at line 31 of file SoundScriptTemplateClass.h.

◆ has_stop_sound

bool Script2Game::SoundScriptTemplateClass::has_stop_sound

Definition at line 32 of file SoundScriptTemplateClass.h.

◆ name

string Script2Game::SoundScriptTemplateClass::name

Definition at line 23 of file SoundScriptTemplateClass.h.

◆ pitch_multiplier

ModulationSources gain_source float Script2Game::SoundScriptTemplateClass::pitch_multiplier

Definition at line 40 of file SoundScriptTemplateClass.h.

◆ pitch_offset

float Script2Game::SoundScriptTemplateClass::pitch_offset

Definition at line 41 of file SoundScriptTemplateClass.h.

◆ pitch_square

float Script2Game::SoundScriptTemplateClass::pitch_square

Definition at line 42 of file SoundScriptTemplateClass.h.

◆ start_sound_name

ModulationSources pitch_source string Script2Game::SoundScriptTemplateClass::start_sound_name

Definition at line 45 of file SoundScriptTemplateClass.h.

◆ start_sound_pitch

float Script2Game::SoundScriptTemplateClass::start_sound_pitch

Definition at line 46 of file SoundScriptTemplateClass.h.

◆ stop_sound_name

string Script2Game::SoundScriptTemplateClass::stop_sound_name

Definition at line 47 of file SoundScriptTemplateClass.h.

◆ stop_sound_pitch

float Script2Game::SoundScriptTemplateClass::stop_sound_pitch

Definition at line 48 of file SoundScriptTemplateClass.h.

◆ trigger_source

SoundTriggers Script2Game::SoundScriptTemplateClass::trigger_source

Definition at line 50 of file SoundScriptTemplateClass.h.

◆ unpitchable

bool Script2Game::SoundScriptTemplateClass::unpitchable

Definition at line 33 of file SoundScriptTemplateClass.h.

The documentation for this class was generated from the following file:

doc/angelscript/Script2Game/SoundScriptTemplateClass.h