Class HeldSounds

Namespace

Vintagestory.API.Common

Assembly

VintagestoryAPI.dll

Defines a set of sounds for a collectible object.

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"
	}
},

Fields

Attack

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

public AssetLocation Attack

Field Value

AssetLocation

Equip

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

public AssetLocation Equip

Field Value

AssetLocation

Idle

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

public AssetLocation Idle

Field Value

AssetLocation

InvPickUpDefault

public static AssetLocation InvPickUpDefault

Field Value

AssetLocation

InvPickup

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

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

public AssetLocation InvPlace

Field Value

AssetLocation

InvPlaceDefault

public static AssetLocation InvPlaceDefault

Field Value

AssetLocation

Unequip

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

public AssetLocation Unequip

Field Value

AssetLocation

Methods

Clone()

Clones the held sounds.

public HeldSounds Clone()

Returns

HeldSounds

OnDeserializedMethod(StreamingContext)

[OnDeserialized]
public void OnDeserializedMethod(StreamingContext context)

Parameters

context StreamingContext