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

Examples

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

Fields

Attack (Optional) (Default: None)

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 (Optional) (Default: None)

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 (Optional) (Default: None)

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

InvPickup (Optional) (Default: player/clayformhi)

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 (Optional) (Default: player/clayform)

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

Unequip (Optional) (Default: None)

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