Skip to main content

ModularItemOption

Extended item option subtype for modular items

Hierarchy

Index

Properties

Properties

optionalAllowActivity

AllowActivity?: ActivityName[]

A list of activities enabled by that module

optionalAllowLock

AllowLock?: boolean

Whether the option permits locking - if not set, defaults to the AllowLock property of the parent asset

optionalAllowSelfSelect

AllowSelfSelect?: boolean

Whether or not this option can be selected by the wearer

optionalArchetypeData

ArchetypeData?: AssetArchetypeData

The extended item data of the subscreen associated with this option (if any)

optionalBlock

Block?: AssetGroupItemName[]

A list of groups that this option blocks - defaults to []

optionalBondageLevel

BondageLevel?: number

The required bondage skill level for this option

optionalChangeWhenLocked

ChangeWhenLocked?: boolean

Whether or not it should be possible to change from this option to another option while the item is locked (if set to false, the player must be able to unlock the item to change its type) - defaults to true

optionalCustomBlindBackground

CustomBlindBackground?: string

A custom background for this option that overrides the default

optionalDifficulty

Difficulty?: number

The additional difficulty associated with this option - defaults to 0

optionalEffect

Effect?: EffectName[]

Whether that option applies effects

optionalExpression

Expression?: ExpressionTrigger[]

Trigger this expression when changing to this option

FIXME: Currently broken!

optionalHasSubscreen

HasSubscreen?: boolean

Whether or not the option should open a subscreen in the extended item menu

optionalHeightModifier

HeightModifier?: number

Whether that option moves the character up

optionalHide

Hide?: AssetGroupName[]

A list of groups that this option hides - defaults to []

optionalHideItem

HideItem?: string[]

A list of items that this option hides

Index

Index: number

The option's (automatically assigned) index within the parent module

ModuleName

ModuleName: string

The option's (automatically assigned) parent module name

Name

Name: `${string}${number}`

The name of the option; automatically set to ModularItemModule.Key + the option's index

OptionType

OptionType: ModularItemOption

A unique (automatically assigned) identifier of the struct type

optionalOverrideHeight

OverrideHeight?: AssetOverrideHeight

Override height, uses the highest priority of all modules

ParentData

ParentData: ModularItemData

optionalPrerequisite

Prerequisite?: AssetPrerequisite | AssetPrerequisite[]

The required prerequisites that must be met before this option can be selected

optionalPrerequisiteBuyGroup

PrerequisiteBuyGroup?: string

A buy group to check for that option to be available

Property

Property: ItemProperties & Pick<Required<ItemProperties>, TypeRecord>

optionalSelfBondageLevel

SelfBondageLevel?: number

The required self-bondage skill level for this option when using it on oneself

optionalSetPose

SetPose?: AssetPoseName

Whether the option forces a given pose

Page Options