ModularItemModuleConfig

A (partially parsed) object describing a single module for a modular item.

Index

Properties

• AllowSelfSelect
• DrawData
• DrawImages
• Key
• Name
• OptionType
• Options

Properties

optionalAllowSelfSelect

AllowSelfSelect?: boolean

Whether or not this module can be selected by the wearer

optionalDrawData

DrawData?: ExtendedItemConfigDrawData<Partial<Modular>>

optionalDrawImages

DrawImages?: boolean

A boolean indicating whether or not images should be drawn within this particular module.

Key

Key: string

The unique key for this module - this is used as a prefix to designate option names. Each options in the module will be named with the module's key, followed by the index of the option within the module's Options array. Keys should be alphabetical only (a-z, A-Z)

Name

Name: string

The name of this module - this is usually a human-readable string describing what the module represents (e.g. Straps). It is used for display text keys, and should be unique across all of the modules for the item.

optionalOptionType

OptionType?: ModularItemModule

A unique (automatically assigned) identifier of the struct type

Options

Options: ModularItemOptionConfig[]

The list of option definitions that can be chosen within this module.