Show / Hide Table of Contents

Class WorldSound

Represents a sound played at a certain location in the world

Inheritance
Object
Element
Sound
WorldSound
Inherited Members
Sound.Bpm
Sound.BufferLength
Sound.Effects
Sound.Length
Sound.LevelData
Sound.MetaTags
Sound.Pan
Sound.TrackPosition
Sound.Properties
Sound.Speed
Sound.Volume
Sound.Paused
Sound.GetFftData(Int32, Int32)
Sound.Destroy()
Sound.GetSfxStatus(SoundContainer)
Sound.OnBeat
Sound.OnMetaChanged
Sound.OnDownloadFinished
Sound.OnStart
Sound.OnStop
Sound.OnStream
Element.element
Element.Root
Element.MTAElement
Element.Type
Element.ID
Element.Exists
Element.ChildCount
Element.Parent
Element.CallPropagationEnabled
Element.SetData(String, Object, Boolean)
Element.GetData(String, Boolean)
Element.TryGetData(String, Object, Boolean)
Element.GetData<T>(String, Boolean)
Element.TryGetData<T>(String, T, Boolean)
Element.GetChild(Int32)
Element.GetChildren(String)
Element.GetByID(String, Int32)
Element.ListenForEvent(String, Boolean, String)
Element.HandleEvent(String, MtaElement, Object, Object, Object, Object, Object, Object, Object, Object)
Element.OnDestroy
Object.Equals(Object)
Object.Equals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Object.ReferenceEquals(Object, Object)
Object.ToString()
Namespace: Slipe.Client.Sounds
Assembly: SlipeClient.dll
Syntax
public class WorldSound : Sound

Constructors

| Improve this Doc View Source

WorldSound(ExtraStations, Int32, Vector3, Boolean)

Create an extra GTA radio station sound at a 3D position in the world

Declaration
public WorldSound(ExtraStations station, int trackId, Vector3 position, bool looped = false)
Parameters
Type Name Description
ExtraStations station
Int32 trackId
Vector3 position
Boolean looped
| Improve this Doc View Source

WorldSound(RadioStation, Int32, Vector3, Boolean)

Create a GTA radio station sound at a 3D position in the world

Declaration
public WorldSound(RadioStation station, int trackId, Vector3 position, bool looped = false)
Parameters
Type Name Description
RadioStation station
Int32 trackId
Vector3 position
Boolean looped
| Improve this Doc View Source

WorldSound(SoundContainer, Int32, Int32, Vector3, Boolean)

Create a GTA Sfx at a 3D position in the world

Declaration
public WorldSound(SoundContainer container, int bankId, int soundId, Vector3 position, bool looped = false)
Parameters
Type Name Description
SoundContainer container
Int32 bankId
Int32 soundId
Vector3 position
Boolean looped
| Improve this Doc View Source

WorldSound(String, Vector3, Boolean, Boolean)

Create a sound in the world at a certain position

Declaration
public WorldSound(string pathOrUrl, Vector3 position, bool looped = false, bool throttled = true)
Parameters
Type Name Description
String pathOrUrl
Vector3 position
Boolean looped
Boolean throttled

Properties

| Improve this Doc View Source

Dimension

Gets and sets the dimension of this element

Declaration
public int Dimension { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

IsAttached

Get if this attachable is attached to a ToAttachable

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

MaxDistance

Get and set the max distance at which this sound stops

Declaration
public int MaxDistance { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

MinDistance

Get and set the minimal distance at which the sound stops getting louder

Declaration
public int MinDistance { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

PanningEnabled

Get and set if this sound pans (hearing it closer to the left or right side of the speakers due to the camera position).

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

Position

Gets and sets the position of the element

Declaration
public Vector3 Position { get; set; }
Property Value
Type Description
Vector3
| Improve this Doc View Source

ToAttached

Get the toAttached to which this attachable is attached

Declaration
public PhysicalElement ToAttached { get; }
Property Value
Type Description
PhysicalElement

Methods

| Improve this Doc View Source

AttachTo(PhysicalElement)

Attach this attachable to a Physical Element without any offset

Declaration
public void AttachTo(PhysicalElement toElement)
Parameters
Type Name Description
PhysicalElement toElement
| Improve this Doc View Source

AttachTo(PhysicalElement, Vector3)

Attach this attachable to a Physical Element with an offset

Declaration
public void AttachTo(PhysicalElement toElement, Vector3 offset)
Parameters
Type Name Description
PhysicalElement toElement
Vector3 offset
| Improve this Doc View Source

Detach()

Detach this attachable

Declaration
public void Detach()
  • Improve this Doc
  • View Source
Back to top Generated by DocFX