Show / Hide Table of Contents

Class AmbientSoundComponent

Inheritance
System.Object
AmbientSoundComponent
Implements
Robust.Shared.ComponentTrees.IComponentTreeEntry<AmbientSoundComponent>
Namespace: Content.Shared.Audio
Assembly: Content.Shared.dll
Syntax
public sealed class AmbientSoundComponent : Component, IComponentTreeEntry<AmbientSoundComponent>

Fields

| Improve this Doc View Source

Range

How far away this ambient sound can potentially be heard.

Declaration
public float Range
Field Value
Type Description
System.Single
| Improve this Doc View Source

Sound

Declaration
public SoundSpecifier Sound
Field Value
Type Description
Robust.Shared.Audio.SoundSpecifier
| Improve this Doc View Source

Volume

Applies this volume to the sound being played.

Declaration
public float Volume
Field Value
Type Description
System.Single

Properties

| Improve this Doc View Source

AddToTree

Declaration
public bool AddToTree { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Enabled

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

RangeVector

Declaration
public Vector2 RangeVector { get; }
Property Value
Type Description
Vector2
| Improve this Doc View Source

Tree

Declaration
public DynamicTree<ComponentTreeEntry<AmbientSoundComponent>> Tree { get; set; }
Property Value
Type Description
Robust.Shared.Physics.DynamicTree<Robust.Shared.Physics.ComponentTreeEntry<AmbientSoundComponent>>
| Improve this Doc View Source

TreeUid

Declaration
public EntityUid? TreeUid { get; set; }
Property Value
Type Description
System.Nullable<EntityUid>
| Improve this Doc View Source

TreeUpdateQueued

Declaration
public bool TreeUpdateQueued { get; set; }
Property Value
Type Description
System.Boolean

Implements

Robust.Shared.ComponentTrees.IComponentTreeEntry<TComp>
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾