script_sound.cpp File Reference

#include "stratagus.h"
#include "sound.h"
#include "player.h"
#include "script.h"
#include "sound_server.h"

Functions
script_sound.cpp - The sound ccl functions.
static int	CclSoundForName (lua_State *l)
static CSound *	CclGetSound (lua_State *l)
static int	CclMakeSound (lua_State *l)
static int	CclMakeSoundGroup (lua_State *l)
static int	CclMapSound (lua_State *l)
static int	CclPlaySound (lua_State *l)
static void	SetSoundConfigRace (lua_State *l, int j, SoundConfig soundConfigs[])
static int	CclDefineGameSounds (lua_State *l)
static int	CclSetGlobalSoundRange (lua_State *l)
static int	CclSetSoundRange (lua_State *l)
void	SoundCclRegister ()
	register ccl features More...

Function Documentation

CclDefineGameSounds()

static int CclDefineGameSounds ( lua_State *  l )

static

Glue between c and scheme. Allows to specify some global game sounds in a ccl file.

Parameters

l	Lua state.

CclGetSound()

static CSound* CclGetSound ( lua_State *  l )

static

Get a Game Sound Id from either a lua sound id or a sound name

Parameters

l	Lua state.

Returns

The C sound id.

CclMakeSound()

static int CclMakeSound ( lua_State *  l )

static

Create a sound.

Glue between c and scheme. This function asks the sound system to register a sound under a given name, with an associated list of files (the list can be replaced by only one file).

Parameters

l	Lua state.

Returns

the sound id of the created sound

CclMakeSoundGroup()

static int CclMakeSoundGroup ( lua_State *  l )

static

Glue between c and scheme. This function asks the sound system to build a special sound group.

Parameters

l	Lua state.

Returns

The sound id of the created sound

CclMapSound()

static int CclMapSound ( lua_State *  l )

static

Glue between c and scheme. Ask to the sound system to remap a sound id to a given name.

Parameters

l	Lua state.

Returns

the sound object

CclPlaySound()

static int CclPlaySound ( lua_State *  l )

static

Description

Ask the sound system to play the specified sound.

Parameters

l	Lua state.

Example:

PlaySound("rescue (orc)")

CclSetGlobalSoundRange()

static int CclSetGlobalSoundRange ( lua_State *  l )

static

Description

Set the cut off distance.

Parameters

l	Lua state.

Example:

SetGlobalSoundRange(200)

CclSetSoundRange()

static int CclSetSoundRange ( lua_State *  l )

static

Set the range of a given sound.

Parameters

l	Lua state.

CclSoundForName()

static int CclSoundForName ( lua_State *  l )

static

Glue between c and scheme. Ask the sound system to associate a sound id to a sound name.

Parameters

l	Lua state.

SetSoundConfigRace()

static void SetSoundConfigRace ( lua_State *  l, int  j, SoundConfig  soundConfigs[]  )

static

SoundCclRegister()

void SoundCclRegister

(

)

register ccl features

Register CCL features for sound.