Skip to main content

CraftingItem

An object representing unparsed crafting-related information, including properties for pre-configuring items.

Hierarchy

See more at DialogInventoryItem.Craft

Index

Properties

Properties

Color

Color: string

The comma-separated color(s) of the item.

inheritedDescription

Description: string

The custom item description.

optionalDifficultyFactor

DifficultyFactor?: number

A tighten-/loosen-specific modifier to-be added to the base difficulty[1] of the item

[1] The sum of the asset difficulty, Bondage skill modifier and crafted property Secure/Loose modifiers.

optionalDisabled

Disabled?: boolean

Whether the crafting item is eligible for use. Only relevant if the player is the craft's owner but do they not own the underlying item (e.g. due to an inventory wipe).

inheritedEffects

Effects: Partial<Record<CraftingPropertyType, number>>

The crafted item effects mapped to their effect strength.

Item

Item: string

The name of the item; see Asset.Name.

ItemProperty

ItemProperty: ItemProperties

A record with a select few (optional) extra item properties:

Lock

Lock: | AssetLockType

The name of the lock or, if absent, an empty string.

optionalinheritedMemberName

MemberName?: string

The name of the crafter.

optionalinheritedMemberNumber

MemberNumber?: number

The member ID of the crafter.

inheritedName

Name: string

The name of the crafted item.

optionalOverridePriority

OverridePriority?: number

An integer (or null) representing the item layering priority; see ItemProperties.OverridePriority.

Deprecated - - superseded by CraftingItem.ItemProperty

Partial

Partial: false = undefined | true

Whether the craft belongs to an equipped item. A value of false implies that the object is a full CraftingItem.

inheritedPrivate

Private: boolean

Whether the crafted item should be private or not.

optionalinheritedProperty

Property?: CraftingPropertyType

The crafted item effect.

Deprecated - superseded by CraftingItem.Effects

optionalType

Type?: string

The type of the crafted item; only relevant for extended items and should be an empty string otherwise.

Deprecated - superseded by CraftingItem.TypeRecord. Old type strings can be convert to records via ExtendedItemTypeToRecord.

See more at ItemProperties.Type

optionalTypeRecord

TypeRecord?: TypeRecord

A record for extended items mapping screen names to option indices.

See more at ItemProperties.TypeRecord

Page Options