Class SoundEffect

Namespace

Obsidian.API

Assembly

Obsidian.API.dll

public sealed class SoundEffect : ISoundEffect

Inheritance

object

SoundEffect

Implements

ISoundEffect

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

EntityId

The entity id that the sound originated from.

public int? EntityId { get; init; }

Property Value

int?

Remarks

Null if SoundPosition has a value.

FixedRange

The fixed range of the sound.

public float? FixedRange { get; init; }

Property Value

float?

Pitch

public required float Pitch { get; init; }

Property Value

float

Remarks

Must be a value between 0.5 and 2.0

Seed

Seed used to pick sound variant.

public required long Seed { get; init; }

Property Value

long

SoundCategory

The category that this sound will be played from.

public required SoundCategory SoundCategory { get; init; }

Property Value

SoundCategory

SoundId

public required string SoundId { get; init; }

Property Value

string

SoundName

public string? SoundName { get; init; }

Property Value

string

SoundPosition

The position of where the sound originated from.

public SoundPosition? SoundPosition { get; init; }

Property Value

SoundPosition?

Remarks

Null if EntityId has a value.

Volume

public required float Volume { get; init; }

Property Value

float

Remarks

Must be a value between 0.0 and 1.0