Interface ISoundEffect

Namespace

Obsidian.API

Assembly

Obsidian.API.dll

public interface ISoundEffect

Properties

EntityId

The entity id that the sound originated from.

int? EntityId { get; init; }

Property Value

int?

Remarks

Null if SoundPosition has a value.

FixedRange

The fixed range of the sound.

float? FixedRange { get; init; }

Property Value

float?

Pitch

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.

long Seed { get; init; }

Property Value

long

SoundCategory

The category that this sound will be played from.

SoundCategory SoundCategory { get; init; }

Property Value

SoundCategory

SoundId

string SoundId { get; init; }

Property Value

string

SoundPosition

The position of where the sound originated from.

SoundPosition? SoundPosition { get; init; }

Property Value

SoundPosition?

Remarks

Null if EntityId has a value.

Volume

float Volume { get; init; }

Property Value

float

Remarks

Must be a value between 0.0 and 1.0