Syntax

	Copy Code
dict GetSoundDesc( int SoundIndex );

Parameters

SoundIndex

Type: int

The index of the sound.

Returns

Returns a dict with a description of a sound. The map has the following items:

Name	Type	Description
AllowShapeChange	bool	true to allow the sound to change the shape, false if not.
Event	string	The name of the event in the sound bank.
Forward_yaw	float	The yaw direction of the sound in radian.
Forward_pitch	float	The pitch direction of the sound in radian.
InitialPlay	bool	true to play the sound with start, false if not.
Movement_x	float	The current sound movement in m on x-axis.
Movement_y	float	The current sound movement in m on y-axis.
Movement_z	float	The current sound movement in m on z-axis.
Name	string	The name of the sound.
NumProperties	int	The count of sound properties.
OrigPosition_x	float	The original position relative to object in m on x-axis.
OrigPosition_y	float	The original position relative to object in m on y-axis.
OrigPosition_z	float	The original position relative to object in m on z-axis.
Position_x	float	The position in m on x-axis.
Position_y	float	The position in m on y-axis.
Position_z	float	The position in m on z-axis.
ShapeChangeRadius	float	If the sound is allowed to change, the range within the sound is looking for a matching new position.
ShapeChangeSpeed	float	If the sound is allowed to change, the speed the sound is moving towards the new location.
ShapeChangeTimes_min	float	If the sound is allowed to change, the minimum wait time the sound is looking for a new location.
ShapeChangeTimes_max	float	If the sound is allowed to change, the maximum wait time the sound is looking for a new location.
UpDirection_x	float	The up-direction in m on x-axis.
UpDirection_y	float	The up-direction in m on y-axis.
UpDirection_z	float	The up-direction in m on z-axis.

Returns an empty dict if the sound was not found.