public class Sandbox.Soundscape : Sandbox.GameResource
A soundscape is used for environmental ambiance of a map by playing a set of random sounds at given intervals.
Related Guides
Broader workflow and conceptual references connected to this API.
s&box provides several ways to play sounds in code. You can fire-and-forget a sound at a world position, control it via a SoundHandle, attach it to a GameObject, or use scene components entirely.
s&box has a full audio system including 2D/3D sound playback, voice chat, positional audio, an audio effects pipeline, and lip sync support.
Constructors
Showing 1 constructors
public Soundscape()
No results match this filter.
Methods
Showing 1 methods
protected virtual Sandbox.Bitmap CreateAssetTypeIcon(int width, int height)
No results match this filter.
Properties
Showing 3 properties
public System.Collections.Generic.List`1<Sandbox.Soundscape.LoopedSound> Sandbox.Soundscape.LoopedSounds { get; set; }
Sounds that are played constantly on a loop.
public RangedFloat Sandbox.Soundscape.MasterVolume { get; set; }
All sound volumes in this soundscape will be scaled by this value.
public System.Collections.Generic.List`1<Sandbox.Soundscape.StingSound> Sandbox.Soundscape.StingSounds { get; set; }
Sounds that are played at intervals.
No results match this filter.
Metadata
| Field | Value |
|---|---|
| Namespace | Sandbox |
| Type | class |
| Assembly | Sandbox.Engine |
| Doc ID | T:Sandbox.Soundscape |