Skip to main content

CraftingItem

A struct with an items crafting-related information.

@see

Index

Properties

Color

Color: string

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

Description

Description: string

The custom item description.

optionalDisabled

Disabled?: boolean

Whether the crafting item is elligble 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).

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

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

optionalMemberName

MemberName?: string

The name of the crafter.

optionalMemberNumber

MemberNumber?: number

The member ID of the crafter.

Name

Name: string

The name of the crafted item.

optionalOverridePriority

OverridePriority?: number

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

@deprecated

Private

Private: boolean

Whether the crafted item should be private or not.

Property

The crafted item propery.

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

optionalTypeRecord

TypeRecord?: TypeRecord

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

@see