Class Sound

Namespace

AlphaFramework.World.Components

Assembly

AlphaFramework.World.dll

Makes an EntityBase<TCoordinates, TTemplate> emit a positioned 3D sound.

public class Sound : ICloneable

Inheritance

object

Sound

Implements

ICloneable

Extension Methods

SoundComponentPresentation.ToPresentation(Sound, Engine)

Properties

Attenuation

Factors describing the attenuation of sound intensity over distance.

public Attenuation Attenuation { get; set; }

Property Value

Attenuation

Filename

The filename of the sound file to play.

public string? Filename { get; set; }

Property Value

string

Shift

A positional offset relative to the entity's origin.

public Vector3 Shift { get; set; }

Property Value

Vector3

ShiftSpecified

Indicates whether Shift has been set to a non-default value.

[Browsable(false)]
public bool ShiftSpecified { get; set; }

Property Value

bool

Volume

The playback volume as a factor (0 = silent, 1 = normal).

public float Volume { get; set; }

Property Value

float

Methods

Clone()

Creates a shallow copy of this Sound

public Sound Clone()

Returns

Sound

The cloned Sound.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

See Also

Sound