Handler for SFX/Menu sounds - Must be stored into its own static for the sounds to persist! More...

Inheritance diagram for pdiext::MSoundEffect:

Public Member Functions
	MSoundEffect (String path_to_sgd)
	Constructs a MSoundEffect from the provided sgd file. More...

void	play (String code)

Array< String >	getEffectCodeList ()
	Returns all the available sound codes from all the MSoundEffect instances. More...

Public Member Functions inherited from System::Object
	Object ()
	constructor taking no param More...

Bool	isInstanceOf (Class classType)
	Returns whether an object is of a specific class/type. More...

Object	getDeepCopy ()
	Gets a deep copy of this object. More...

void	setDeepCopy (Object obj)
	Unk. More...

String	dump ()
	Dumps all info about an object. More...

Object	getObjectAttribute (string path)

void	setObjectAttribute (string path, Object value)

Bool	hasPrimitiveInterface ()
	Returns whether this object has a primitive interface. More...

Bool	toBool ()
	Casts this object to Bool. More...

Byte	toByte ()
	Casts this object to Byte. More...

Short	toShort ()
	Casts this object to Short. More...

Int	toInt ()
	Casts this object to Int. More...

Long	toLong ()
	Casts this object to Long. More...

UByte	toUByte ()
	Casts this object to UByte. More...

UShort	toUShort ()
	Casts this object to UShort. More...

UInt	toUInt ()
	Casts this object to UInt. More...

ULong	toULong ()
	Casts this object to ULong. More...

Float	toFloat ()
	Casts this object to Float. More...

Double	toDouble ()
	Casts this object to Double. More...

String	toString ()
	Casts this object to String. More...

Symbol	toSymbol ()
	Casts this object to Symbol. More...

Bool	hasArrayInterface ()
	Returns whether this object has an Array interface. More...

Int	getArrayCount ()
	Gets the Array item count for this object. More...

void	setArrayCount ()
	Sets the Array item count for this object. More...

Object	getArrayElement (Object arg0)
	Gets an Array item for this object. More...

void	setArrayElement (Object arg0, Object arg1)
	Sets the Array item for this object. More...

Bool	hasMapInterface ()
	Returns whether this object has a Map interface. More...

int	getMapCount ()
	Returns the count of items in the map. More...

void	setMapElement (Object arg0, Object arg1)
	Returns whether the Map has a specific object key. Bool hasMapElement(Object arg0);. More...

Object	getMapElement (Object arg0)
	Gets a Map element by key. More...

void	hasGeneratorInterface ()
	Returns whether this object has a generator interface. More...

Iterator	generator ()
	Returns generator (?) More...

void	hasIteratorInterface ()
	Returns whether this object has an iterator. More...

Iterator	iterator ()
	Gets the iterator for this object. More...

void	hasVariableInterface ()
	Returns whether this object is a variable. More...

void	hasFunctionInterface ()
	Returns whether this object has a function interface. More...

Object	call ()
	Calls this object as a function. More...

Bool	hasByteDataInterface ()
	Returns whether this object has a byte data interface. More...

Int	getByteDataCount ()
	Returns the ByteData size for this object. More...

void	setByteDataCount (Int count)
	Sets the ByteData size for this object. More...

Int	getByteDataCapacity ()
	Returns the ByteData capacity for this object. More...

void	setByteDataCapacity (Int capacity)
	Sets the ByteData capacity for this object. More...

ByteData	getByteData ()
	Gets the underlaying ByteData. More...

void	setByteData (ByteData bytedata)
	Sets the underlaying ByteData. More...

void	hasObjectSelectorInterface ()
	Returns whether this object has an object selector interface. More...

void	self ()
	Gets the get for this object if it has a get interface. More...

void	getArchiveTree ()

void	setArchiveTree ()

ByteData	serialize ()
	Serializes this object. More...

void	deserialize (ByteData serializedData)
	Deserializes this object. More...

void	defined (Object obj)
	Returns whether a certain object is defined within this object. More...

Array	find_all (FunctionObject func)
	Finds all the elements in this object that matches the predicates. More...

void	each_all (FunctionObject func)
	Applies callback to all elements in this object. More...

Array	map_all (FunctionObject< Object > func)
	Maps all the elements in this object. More...

Bool	operator!= ()
	Returns whether this object is not equal to another. More...

Bool	operator== ()
	Returns whether this object is equal to another. More...

Public Attributes
Float	default_volume

Public Attributes inherited from System::Object
Int	rc_size
	Getter-only. Reference counter size of this object. More...

Object	rc_class
	Getter-only. Type name of the object. More...

Int	rc_count
	Getter-only. Reference count of this object. More...

Int	weak_count
	Getter-only. Weak reference count of this object. More...

Class	class_id
	Class (type) object for this object. More...

Detailed Description

Handler for SFX/Menu sounds - Must be stored into its own static for the sounds to persist!

This is effectively a holder, once the MSoundEffect is created, entries are added into the global code list

static module main
{
    static gtcMenuSoundHolder = pdiext::MSoundEffect("sound_gt/se/gtcmenu.sgd");
}
 
main::sound.play("gtc_back");
return main::sound.getEffectCodeList();

To override some codes with others, use the following code

main::sound.code_map["cursor"] = "gtc_change";
main::sound.code_map["cancel"] = "gtc_back";
main::sound.code_map["ok"] = "gtc_ok";

Definition at line 24 of file MSoundEffect.cpp.

Constructor & Destructor Documentation

◆ MSoundEffect()

pdiext::MSoundEffect::MSoundEffect ( String path_to_sgd )

inline

Constructs a MSoundEffect from the provided sgd file.

Definition at line 29 of file MSoundEffect.cpp.

Member Function Documentation

◆ getEffectCodeList()

Array< String > pdiext::MSoundEffect::getEffectCodeList ( )

Returns all the available sound codes from all the MSoundEffect instances.

i.e "cancel", "chat_trans", "ok", etc...

◆ play()

void pdiext::MSoundEffect::play ( String code )

Member Data Documentation

◆ default_volume

Float pdiext::MSoundEffect::default_volume

Definition at line 32 of file MSoundEffect.cpp.

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

headers/pdiext/Sound/MSoundEffect.cpp

Public Member Functions

Public Attributes