AudioSourceInfo

Celestial Body Schema / Definitions / AudioSourceInfo

Schema Type: JSON Type: object

No Description Found

# audio

Type: string

The audio to use. Can be a path to a .wav/.ogg/.mp3 file, or taken from the AudioClip list.

---

# minDistance

Type: number

At this distance the sound is at its loudest.

---

# maxDistance

Type: number Default: 5

The sound will drop off by this distance (Note: for signals, this only effects when it is heard aloud and not via the signalscope).

---

# volume

Type: number Default: 0.5

How loud the sound will play

---

# position

Type: MVector3

Position of the object

See Definitions/MVector3

---

# isRelativeToParent

Type: boolean

Whether the positional and rotational coordinates are relative to parent instead of the root planet object.

---

# parentPath

Type: string

The relative path from the planet to the parent of this object. Optional (will default to the planet's root sector).

---

# sectorPath

Type: string

The relative path from the planet to the sector that this object will be linked to. The special value "auto" will use the most specific sector in the parent path. Optional (will default to the planet's root sector).

---

# rename

Type: string

An optional rename of this object

---

# track

Type: NHAudioMixerTrackName Default: environment

The audio track of this audio source.
Most of the time you'll use environment (the default) for sound effects and music for music.

See Definitions/NHAudioMixerTrackName