zCVobSound

Emits a sound defined by a script instance in a given radius. The sound playback can be activated by sending an OnTrigger event to the VObject and sending an OnUntrigger event disables the sound playback.

Class members

Class member overview

sndVolume

The volume of the sound effect in percent (0-100).

sndMode

Determines how the sound effect is played.

Accepted values:

• LOOPING — The sound effect is repeated endlessly
• ONCE — The sound plays once
• RANDOM — The sound effect is repeated endlessly with a random delay between repetitions

sndRandDelay

The average delay between repetitions in seconds if sndMode is RANDOM.

sndRandDelayVar

The maximum deviation of the random delay between repetitions if sndMode is RANDOM. The resulting delay will be a value between sndRandDelay ± sndRandDelayVar.

sndStartOn

Whether to start the sound when loading the world.

Accepted values:

• TRUE — Start the sound when the world is loaded
• FALSE — Only start the sound in response to an OnTrigger event

sndAmbient3D

Determines whether the sound is an omnidirectional ambient sound. It will change volume depending on the distance to this VObject, but it won't sound as if this VObject is emitting the effect.

Accepted values:

• TRUE — Emit an ambient sound effect
• FALSE — Emit a directional sound effect

sndObstruction

Whether to dampen the sound when there is no direct path from the VObject to the listener.

Accepted values:

• TRUE — The sound is dampened by obstructions
• FALSE — The sound is not dampened

sndConeAngle

When set to a value other than 0, determines a cone in front of the VObject in which the sound can be heard. To listeners outside of that cone, the sound is not heard. Only values between 0 and 360 are valid.

sndVolType

Determines the type of volume used to check whether the sound can be heard.

Accepted values:

• SV_SPHERE — The sound the be heard in a sphere around this VObject.
• SV_ELLIPSOID — The sound can be heard within an ellipsoid defined by the VObject's bounding box.

sndRadius

The radius in which the sound can be heard.

sndName

The name of the script instance describing the sound.

soundIsRunning

Unknown.

soundAllowedToRun

Unknown.