Class ClothingItemDefinition
Represents a clothing item definition that can be worn by the player. Extends StorableItemDefinition with clothing-specific properties.
[Obsolete("Use S1API.Items.Clothing.ClothingItemDefinition instead")]
public sealed class ClothingItemDefinition : StorableItemDefinition- Inheritance
-
ClothingItemDefinition
- Inherited Members
- Extension Methods
Remarks
Use CreateBuilder() to create new clothing items, or CloneFrom(string) to create variants of existing items.
Properties
ApplicationType
How this clothing item is applied to the avatar.
public ClothingApplicationType ApplicationType { get; set; }Property Value
ClothingAssetPath
The asset path to the clothing prefab or layer in Resources.
public string ClothingAssetPath { get; set; }Property Value
Colorable
Whether this clothing item can be colored by the player.
public bool Colorable { get; set; }Property Value
DefaultColor
The default color for this clothing item.
public ClothingColor DefaultColor { get; set; }Property Value
Slot
The clothing slot this item occupies.
public ClothingSlot Slot { get; set; }Property Value
SlotsToBlock
List of clothing slots this item blocks when equipped.
public List<ClothingSlot> SlotsToBlock { get; set; }Property Value
Methods
CreateInstance(ClothingColor)
Creates a clothing instance from this definition with the specified color.
public ClothingItemInstance CreateInstance(ClothingColor color)Parameters
colorClothingColorThe clothing color to apply to the created instance.
Returns
- ClothingItemInstance
A clothing instance using the specified color.
CreateInstance(int)
Creates a clothing instance from this definition using the default color.
public override ItemInstance CreateInstance(int quantity = 1)Parameters
quantityintThe quantity to apply to the created clothing instance.
Returns
- ItemInstance
A clothing item instance using this definition's default color.
CreateInstance(int, ClothingColor)
Creates a clothing instance from this definition with the specified quantity and color.
public ClothingItemInstance CreateInstance(int quantity, ClothingColor color)Parameters
quantityintThe quantity to apply to the created clothing instance.
colorClothingColorThe clothing color to apply to the created instance.
Returns
- ClothingItemInstance
A clothing instance using the specified quantity and color.