Skip to main content

VariableHeightOption

Extended item option subtype for variable height items

Hierarchy

Index

Properties

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?: null

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

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

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

Name

Name: newOption | previousOption

The name of the type - used for the preview icon and the translation key in the CSV

OptionType

OptionType: VariableHeightOption

A unique identifier of the struct type. Its value must be automatically assigned if it's an archetypical extended item option. If it's not, e.g. for a custom script hook button that does not alter the item's state, then its value must be set "ExtendedItemOption".

ParentData

ParentData: VariableHeightData

The extended item data associated with this option

optionalPrerequisite

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: Pick<Required<ItemProperties>, OverrideHeight>

The Property object to be applied when this option is used

optionalSelfBondageLevel

SelfBondageLevel?: number

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