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

Volume

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

public float Volume { get; set; }

Property Value

float

Methods

Clone()

Creates a deep copy of this Sound instance.

public virtual Sound Clone()

Returns

Sound

The new copy of the Sound.

CloneFromTo(Sound, Sound)

Copies all members declared by Sound from one instance to another.

protected static void CloneFromTo(Sound from, Sound to)

Parameters

from Sound

to Sound

ShouldSerializeShift()

Used for XML serialization.

public bool ShouldSerializeShift()

Returns

bool

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