class SoundscapeTrigger

in global :: Sandbox

Plays a soundscape when the listener enters the trigger area.


public SoundscapeTrigger.TriggerType Type { get; set; }

Determines when/where the soundscape can be heard.

public MixerHandle TargetMixer { get; set; }

Ths mixer that the soundscape will play on.

public bool StayActiveOnExit { get; set; }

When true the soundscape will keep playing after exiting the area, and will only stop playing once another soundscape takes over.

public float Radius { get; set; }

The radius of the Soundscape when is set to .

public Vector3 BoxSize { get; set; }

The size of the Soundscape when is set to .

public bool TestListenerPosition( Vector3 position )

Return true if they should hear this soundscape when in this position

public IEnumerable<T> GetComponents( bool includeDisabled = False )

😔 No documentation found.

public T GetComponentInChildren( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public Vector3 LocalScale { get; set; }

😔 No documentation found.

public IEnumerable<T> GetComponentsInParent( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public T GetComponentInParent( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public Guid Id { get; }

😔 No documentation found.

public Transform LocalTransform { get; set; }

😔 No documentation found.

public Vector3 LocalPosition { get; set; }

😔 No documentation found.

public Rotation LocalRotation { get; set; }

😔 No documentation found.

public IEnumerable<T> GetComponentsInChildren( bool includeDisabled = False, bool includeSelf = True )

😔 No documentation found.

public GameObject.NetworkAccessor Network { get; }

😔 No documentation found.

public T GetOrAddComponent( bool startEnabled = True )

😔 No documentation found.

public JsonNode Serialize( GameObject.SerializeOptions options = null )

😔 No documentation found.

public T GetComponent( bool includeDisabled = False )

😔 No documentation found.

public void DeserializeImmediately( JsonObject node )

😔 No documentation found.

public int ComponentVersion { get; }

😔 No documentation found.

public Transform WorldTransform { get; set; }

😔 No documentation found.

public Vector3 WorldPosition { get; set; }

😔 No documentation found.

public Rotation WorldRotation { get; set; }

😔 No documentation found.

public Vector3 WorldScale { get; set; }

😔 No documentation found.

public Type GetType( )

😔 No documentation found.

public string ToString( )

😔 No documentation found.

public bool Equals( object obj )

😔 No documentation found.

public bool IsProxy { get; }

😔 No documentation found.

public void Deserialize( JsonObject node )

😔 No documentation found.

public SoundscapeTrigger( )

😔 No documentation found.

public DebugOverlaySystem DebugOverlay { get; }

😔 No documentation found.

public Soundscape Soundscape { get; set; }

😔 No documentation found.

public float Volume { get; set; }

😔 No documentation found.

public bool Playing { get; }

😔 No documentation found.

public Scene Scene { get; }

😔 No documentation found.

public GameTransform Transform { get; }

😔 No documentation found.

public GameObject GameObject { get; }

😔 No documentation found.

public ComponentList Components { get; }

😔 No documentation found.

public bool Enabled { get; set; }

😔 No documentation found.

public bool Active { get; }

😔 No documentation found.

public bool IsValid { get; }

😔 No documentation found.

public Action OnComponentEnabled { get; set; }

😔 No documentation found.

public Action OnComponentStart { get; set; }

😔 No documentation found.

public Action OnComponentUpdate { get; set; }

😔 No documentation found.

public Action OnComponentFixedUpdate { get; set; }

😔 No documentation found.

public Action OnComponentDisabled { get; set; }

😔 No documentation found.

public Action OnComponentDestroy { get; set; }

😔 No documentation found.

public void Destroy( )

😔 No documentation found.

public void DestroyGameObject( )

😔 No documentation found.

public void Reset( )

😔 No documentation found.

public void EditLog( string name, object source )

😔 No documentation found.

public ITagSet Tags { get; }

😔 No documentation found.

public void Invoke( float secondsDelay, Action action, CancellationToken ct = null )

😔 No documentation found.

public int GetHashCode( )

😔 No documentation found.

public T AddComponent( bool startEnabled = True )

😔 No documentation found.

public ComponentFlags Flags { get; set; }

😔 No documentation found.