AttachmentDefinition

class HorseMod.AttachmentDefinition

Defines an attachment item with its associated slots and extra data if needed.

unequipBehavior: HorseMod.EquipBehavior?

Unequip timed action behavior.

model: string?

Model script ID to show when attached. Suffixes are used to define different states (e.g. reins during movement).

hidden: boolean?

Hide the item in menus. [not fully tested]

containerBehavior: HorseMod.ContainerBehavior?

Container behavior component.

equipBehavior: HorseMod.EquipBehavior?

Equip timed action behavior component.

lightBehavior: HorseMod.LightBehavior?

Light behavior component.

notReachableFromMount: boolean?

Whenever the player can reach from mount this attachment, always considered reachable by default. Notably used for containers.

notEquipableWithRider: boolean?

Whenever this attachment can be equipped when the horse has a rider. Defaults to true.

requirements: {allOf: HorseMod.AttachmentSlot[], oneOf: HorseMod.AttachmentSlot[]}?

List of attachment slots with equipment that this item requires to be equipped.