VariableHeightConfig
Hierarchy
- ExtendedItemConfig<VariableHeightOption>
- VariableHeightConfig
Index
Properties
optionalAllowEffect
Archetype
The archetype of the extended item config
optionalBaselineProperty
To-be initialized properties independent of the selected item module(s). Relevant if there are properties that are (near) exclusively managed by ExtendedItemConfig.ScriptHooks functions.
optionalChatSetting
The chat message setting for the item. This can be provided to allow finer-grained chatroom message keys for the item.
optionalChatTags
An array of the chat message tags that should be included in the item's chatroom messages.
optionalCopyConfig
The group name and asset name of a configuration to copy - useful if multiple items share the same config
Type declaration
AssetName: string
optionalGroupName?: AssetGroupName
DialogPrefix
A record containing various dialog keys used by the extended item screen
Type declaration
optionalChat?: string | ExtendedItemChatCallback<VariableHeightOption>
The dialogue prefix that will be used for each of the item's chatroom messages
optionalHeader?: string | ExtendedItemHeaderCallback<VariableHeightData>
The dialogue prefix for the player prompt that is displayed on each module's menu screen
optionalOption?: string
The dialogue prefix for the name of each option
optionalDictionary
Contains custom dictionary entries in the event that the base ones do not suffice.
DrawData
An interface with element-specific drawing data for a given screen.
optionalDrawImages
A boolean indicating whether or not images should be drawn for the option and/or module selection screen.
optionalGetHeightFunction
The function that handles finding the current variable height setting
Type declaration
Parameters
property: ItemProperties
Returns number
MaxHeight
The highest Y co-ordinate that can be set
MinHeight
The lowest Y co-ordinate that can be set
optionalName
The unique name for this (sub)-screen used for the automatic construction of ItemProperties.TypeRecord keys. Names should be short.
If not explicitly specified defaults to the name of ExtendedItemData.parentOption for sub screens and the name of the archetype in case of the (outer-most) super screen.
optionalScriptHooks
A recond containing functions that are run on load, click, draw, exit, and validate, with the original archetype function
and parameters passed on to them. If undefined, these are ignored.
Note that scripthook functions must be loaded before Female3DCGExtended.js in index.html.
optionalSetHeightFunction
The function that handles applying the height setting to the character
Type declaration
Parameters
property: ItemProperties
height: number
maxHeight: number
minHeight: number
Returns void
A list with extra to-be allowed effect names. Should only defined when there are effects that are exclusively managed by script hooks and thus cannot be extracted from the normal extended item options.