Constructor
new AmbientSoundData(data, documentopt)
- See:
-
- BaseAmbientSound
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
_id |
string | The _id which uniquely identifies this AmbientSound document |
||
x |
number |
0
|
The x-coordinate position of the origin of the sound. |
|
y |
number |
0
|
The y-coordinate position of the origin of the sound. |
|
radius |
number |
0
|
The radius of the emitted sound. |
|
path |
string | The audio file path that is played by this sound |
||
repeat |
boolean |
<optional> |
false
|
Does this sound loop? |
volume |
number |
<optional> |
0.5
|
The audio volume of the sound, from 0 to 1 |
walls |
boolean |
true
|
Whether or not this sound source is constrained by Walls. |
|
easing |
boolean |
true
|
Whether to adjust the volume of the sound heard by the listener based on how close the listener is to the center of the sound source. |
|
hidden |
boolean |
false
|
Is the sound source currently hidden? |
|
darkness |
DarknessActivation | Darkness activation configuration data. |
||
flags |
object |
<optional> |
{}
|
An object of optional key/value flags |
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
data |
object | Initial data used to construct the data object |
|
document |
BaseAmbientSound |
<optional> |
The document to which this data object belongs |
Extends
- DocumentData