Resource Sound
(NOTE) Settings and Sounds for playing audio files.
Properties
Attenuator : soundattenuator
If a SoundAttenuator resource is selected, it will be applied to reduce the sound's volume with distance when played through a SoundEmitter. If DefaultNoAttenuation is selected on the SoundCue and a different SoundAttenuator is selected on the SoundEmitter, the SoundEmitter's settings will be applied. If DefaultNoAttenuation is selected on both the sound will not be attenuated.
var Attenuator : SoundAttenuator
BeatsPerMinute : real
The speed of the music, using beats per minute.
var BeatsPerMinute : Real
Decibels : real
The volume adjustment, in decibels, that will be applied to the sound when it plays. A value of 0 does nothing, 6 will double the sound's volume, -6 will halve it. The Decibels property is linked to the Volume property (changing one will change the other).
var Decibels : Real
DecibelVariation : real
Sets how much the Decibels will be randomized every time the SoundCue plays. If Decibels is 0, and DecibelVariation is 4, the volume adjustment will be chosen randomly between -4 and 4.
var DecibelVariation : Real
Pitch : real
This property affects both the pitch and speed of the sound played by the SoundCue. A value of 0 will do nothing, 1 will raise the pitch by an octave and speed up the sound,.
var Pitch : Real
PitchVariation : real
Sets how much the pitch will be randomized every time the SoundCue plays. If Pitch is 0, and PitchVariation is 0.3, the pitch of the sound will be chosen randomly between -0.3 and 0.3.
var PitchVariation : Real
PlayMode : SoundPlayMode
If Single is chosen the SoundInstance created by the SoundCue will be played once and will stop when it reaches its EndTime. If Looping is chosen the SoundInstance will play continuously until either it is stopped or its Looping property is set to false.
var PlayMode : SoundPlayMode
SelectMode : SoundSelectMode
If Random is chosen the SoundCue will randomly choose which SoundEntry to play. If Sequential is chosen it will play the SoundEntries in order.
var SelectMode : SoundSelectMode
Semitones : real
This property, specified in semitones (or half-steps), affects both the pitch and speed of the sound played by the SoundCue. A value of 0 will do nothing, 12 will raise the pitch by an octave and speed up the sound, and -12 will lower the sound by an octave and slow it down. The Semitones property is linked to the Pitch property (changing one will change the other).
var Semitones : Real
SemitoneVariation : real
Sets how much the pitch will be randomized every time the SoundCue plays. If Semitones is 0, and SemitoneVariation is 5, the pitch of the sound will be chosen randomly between -5 and 5.
var SemitoneVariation : Real
ShowMusicOptions : boolean
If true, the music options will be shown. If false, they will be hidden.
var ShowMusicOptions : Boolean
Sounds : sounds
var Sounds : Sounds
SoundTags : soundtags
var SoundTags : SoundTags
TimeSigBeats : real
The top number of the music's time signature (beats per measure).
var TimeSigBeats : Real
TimeSigValue : real
The bottom number of the music's time signature (which type of note has the beat).
var TimeSigValue : Real
UseDecibelVariation : boolean
If false, the VolumeVariation value will be used to randomize the volume. If true, the DecibelVariation field will be shown and will be used for randomization.
var UseDecibelVariation : Boolean
UseSemitoneVariation : boolean
If false, the PitchVariation value will be used to randomize the volume. If true, the SemitoneVariation field will be shown and will be used for randomization.
var UseSemitoneVariation : Boolean
Volume : real
The volume adjustment that will be applied to the sound when it plays. A value of 1 does nothing, 2 will double the sound's volume, 0.5 will halve it. The Volume property is linked to the Decibels property (changing one will change the other).
var Volume : Real
VolumeVariation : real
Sets how much the Volume will be randomized every time the SoundCue plays. If Volume is 1, and VolumeVariation is 0.5, the volume adjustment will be chosen randomly between 0.5 and 1.5.
var VolumeVariation : Real
Methods
AddSoundEntry : Void
Adds a new SoundEntry to this SoundCue. |Name|Type|Description| |---|---|---| |sound|sound| | |weight|real| |
function AddSoundEntry(sound : Sound, weight : Real)
AddSoundTagEntry : Void
Adds a new SoundTagEntry to this SoundCue. |Name|Type|Description| |---|---|---| |soundTag|soundtag| |
function AddSoundTagEntry(soundTag : SoundTag)
PlayCueOnNode : soundinstance
Plays this SoundCue using a specified SoundNode as the output and returns the resulting SoundInstance. |Name|Type|Description| |---|---|---| |outputNode|soundnode| | |startPaused|boolean| |
function PlayCueOnNode(outputNode : SoundNode, startPaused : Boolean) : SoundInstance
Preview : Void
Name Type Description function Preview()
StopPreview : Void
Name Type Description function StopPreview()