Singleton responsible for managing the sound engine. More...

#include <sound.hpp>

Static Public Member Functions
static LIBERAPI DLUT::DLReferenceCountPtr< CSFD4SoundIns >	play_system_sound (char sound_type, int sound_id)
	Play a 2d system wwise sound.

static LIBERAPI DLUT::DLReferenceCountPtr< CSFD4SoundIns >	play_character_sound (char sound_type, int sound_id, ChrIns &chr, int dummypoly=-1, bool follows_origin=true)
	Play a wwise sound from a character.

Detailed Description

Singleton responsible for managing the sound engine.

Member Function Documentation

static LIBERAPI DLUT::DLReferenceCountPtr< CSFD4SoundIns > from::CS::CSSound::play_character_sound	(	char	sound_type,
		int	sound_id,
		ChrIns &	chr,
		int	dummypoly = `-1`,
		bool	follows_origin = `true`
	)

static

Play a wwise sound from a character.

Parameters

sound_type	The single letter prefix of a sound name, possible values: 'a', 'c', 'f', 'o', 'p', 's', 'm', 'v', 'x', 'b', 'i', 'y', 'z', 'e', 'g', 'd'
sound_id	the nine digit decimal sound id
chr	the character that will emit the sound
dummypoly	the dummypoly id to emit the sound from
follows_origin	whether the sound will follow the emitter

Returns: DLUT::DLReferenceCountPtr<CSFD4SoundIns> a pointer to a reference counted sound object

static LIBERAPI DLUT::DLReferenceCountPtr< CSFD4SoundIns > from::CS::CSSound::play_system_sound	(	char	sound_type,
		int	sound_id
	)

static

Play a 2d system wwise sound.

Parameters

sound_type	the single letter prefix of a sound name, possible values: 'a', 'c', 'f', 'o', 'p', 's', 'm', 'v', 'x', 'b', 'i', 'y', 'z', 'e', 'g', 'd'
sound_id	the nine digit decimal sound id

Returns: DLUT::DLReferenceCountPtr<CSFD4SoundIns> a pointer to a reference counted sound object

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