Class HeldSounds

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

Defines a set of sounds for a collectible object. Open in GitHub

[DocumentAsJson]
public class HeldSounds

Inheritance

object

HeldSounds

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectHandleExtensions.ToGcHandle(object)

ObjectHandleExtensions.ToIntPtr(object)

Examples

"heldSoundsbyType": {
	"*-lit-*": {
		"idle": "held/torch-idle",
		"equip": "held/torch-equip",
		"unequip": "held/torch-unequip",
		"attack": "held/torch-attack"
	}
},

Constructors

HeldSounds()

public HeldSounds()

Fields

Attack

The path to a sound played when this item is used to attack.

[DocumentAsJson("Optional", "None", false)]
[JsonConverter(typeof(SoundAttributeConverter), new object[] { false })]
public SoundAttributes Attack

Field Value

SoundAttributes

Equip

The path to a sound played when this item is equipped.

[DocumentAsJson("Optional", "None", false)]
[JsonConverter(typeof(SoundAttributeConverter), new object[] { false })]
public SoundAttributes Equip

Field Value

SoundAttributes

Idle

The path to a sound played when this item is being held.

[DocumentAsJson("Optional", "None", false)]
[JsonConverter(typeof(SoundAttributeConverter), new object[] { false })]
public SoundAttributes Idle

Field Value

SoundAttributes

InvPickUpDefault

public static SoundAttributes InvPickUpDefault

Field Value

SoundAttributes

InvPickup

The path to a sound played when this item is picked up in the inventory using the mouse.

[DocumentAsJson("Optional", "player/clayformhi", false)]
[JsonConverter(typeof(SoundAttributeConverter), new object[] { false })]
public SoundAttributes InvPickup

Field Value

SoundAttributes

InvPlace

The path to a sound played when this item is placed in the inventory using the mouse.

[DocumentAsJson("Optional", "player/clayform", false)]
[JsonConverter(typeof(SoundAttributeConverter), new object[] { false })]
public SoundAttributes InvPlace

Field Value

SoundAttributes

InvPlaceDefault

public static SoundAttributes InvPlaceDefault

Field Value

SoundAttributes

SemirandomPitchDefault

public static NatFloat SemirandomPitchDefault

Field Value

NatFloat

ToolBreak

public static AssetLocation ToolBreak

Field Value

AssetLocation

Unequip

The path to a sound played when this item is unequipped.

[DocumentAsJson("Optional", "None", false)]
[JsonConverter(typeof(SoundAttributeConverter), new object[] { false })]
public SoundAttributes Unequip

Field Value

SoundAttributes

Methods

Clone()

Clones the held sounds.

public HeldSounds Clone()

Returns

HeldSounds