Class HeldSounds

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

Defines a set of sounds for a collectible object.

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.

public AssetLocation Attack

Field Value

AssetLocation

Equip (Optional) (Default: None)

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

public AssetLocation Equip

Field Value

AssetLocation

Idle (Optional) (Default: None)

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

public AssetLocation Idle

Field Value

AssetLocation

InvPickup (Optional) (Default: "player/clayformhi")

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

public AssetLocation InvPickup

Field Value

AssetLocation

InvPlace (Optional) (Default: "player/clayform")

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

public AssetLocation InvPlace

Field Value

AssetLocation

Unequip (Optional) (Default: None)

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

public AssetLocation Unequip

Field Value

AssetLocation