Table of Contents

Class AttributeAttachableToEntity

Namespace
Vintagestory.GameContent
Assembly
VSEssentials.dll

A set of properties that make a collectible attachable to an entity Open in GitHub

[DocumentAsJson]
public class AttributeAttachableToEntity
Inheritance
AttributeAttachableToEntity

Fields

CategoryCode (Required)

Allows this collectible to be attached to slot with specified category code

[DocumentAsJson("Required", "", false)]
public string CategoryCode { get; set; }

Field Value

string

AttachedShape (Recommended) (Default: None)

The shape used when this collectible is attached. If not set, the shape of the collectible is used

[DocumentAsJson("Recommended", "None", false)]
public CompositeShape? AttachedShape { get; set; }

Field Value

CompositeShape

AttachedShapeBySlotCode (Recommended) (Default: None)

The shape used when this collectible is attached to specific slot

[DocumentAsJson("Recommended", "None", false)]
public OrderedDictionary<string, CompositeShape>? AttachedShapeBySlotCode { get; set; }

Field Value

OrderedDictionary<string, CompositeShape>

AttachedShapeByVariant (Recommended) (Default: None)

[DocumentAsJson("Recommended", "None", false)]
public OrderedDictionary<string, CompositeShape>? AttachedShapeByVariant { get; set; }

Field Value

OrderedDictionary<string, CompositeShape>

AttachedShapeByVariantBySlotCode (Recommended) (Default: None)

[DocumentAsJson("Recommended", "None", false)]
public OrderedDictionary<string, OrderedDictionary<string, CompositeShape>>? AttachedShapeByVariantBySlotCode { get; set; }

Field Value

OrderedDictionary<string, OrderedDictionary<string, CompositeShape>>

AttachedTextures (Recommended) (Default: None)

The textures used when this collectible is attached. Takes priority over collectible textures.

[DocumentAsJson("Recommended", "None", false)]
public Dictionary<string, CompositeTexture>? AttachedTextures { get; set; }

Field Value

Dictionary<string, CompositeTexture>

AttachedTexturesBySlotCode (Recommended) (Default: None)

The textures used when this collectible is attached to specific slot. Takes priority over collectible textures.

[DocumentAsJson("Recommended", "None", false)]
public OrderedDictionary<string, Dictionary<string, CompositeTexture>>? AttachedTexturesBySlotCode { get; set; }

Field Value

OrderedDictionary<string, Dictionary<string, CompositeTexture>>

AttachedTexturesByVariant (Recommended) (Default: None)

The textures used when this collectible is attached by shape variant. Takes priority over collectible textures.

[DocumentAsJson("Recommended", "None", false)]
public Dictionary<string, Dictionary<string, CompositeTexture>>? AttachedTexturesByVariant { get; set; }

Field Value

Dictionary<string, Dictionary<string, CompositeTexture>>

AttachedTexturesByVariantBySlotCode (Recommended) (Default: None)

[DocumentAsJson("Recommended", "None", false)]
public Dictionary<string, Dictionary<string, Dictionary<string, CompositeTexture>>>? AttachedTexturesByVariantBySlotCode { get; set; }

Field Value

Dictionary<string, Dictionary<string, Dictionary<string, CompositeTexture>>>

TexturePrefixCode (Recommended) (Default: None)

Unique key for this attachable to make sure it is rendered correctly

[DocumentAsJson("Recommended", "None", false)]
public string? TexturePrefixCode { get; set; }

Field Value

string

DisableElements (Optional) (Default: None)

The shape elements that should not be rendered

[DocumentAsJson("Optional", "None", false)]
public string[]? DisableElements { get; set; }

Field Value

string[]

KeepElements (Optional) (Default: None)

The shape elements that should still be rendered even if they are covered by DisableElements

[DocumentAsJson("Optional", "None", false)]
public string[]? KeepElements { get; set; }

Field Value

string[]

RequiresBehindSlots (Optional) (Default: 0)

Occupy additional space behind this slot

[DocumentAsJson("Optional", "0", false)]
public int RequiresBehindSlots { get; set; }

Field Value

int