VariableHeightData
Hierarchy
- ExtendedItemData<VariableHeightOption>
- VariableHeightData
Index
Properties
allowEffect
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.
archetype
The archetype of the extended item data
asset
The asset reference
baselineProperty
To-be initialized properties independent of the selected item module(s). Relevant if there are properties that are (near) exclusively managed by ExtendedItemData.scriptHooks functions.
chatSetting
The chat message setting for the item. This can be provided to allow
finer-grained chatroom message keys for the item.
Archetypes must use the "default" literal string as default value.
chatTags
An array of the chat message tags that should be included in the item's chatroom messages.
dialogPrefix
A record containing various dialog keys used by the extended item screen
Type declaration
chat: string | ExtendedItemChatCallback<VariableHeightOption>
The prefix used for dialog keys representing the item's chatroom messages when its type is changed
header: string | ExtendedItemHeaderCallback<VariableHeightData>
The dialog key for the item's load text (usually a prompt to select the type)
option: string
The dialogue prefix for the name of each option
dictionary
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.
dynamicAssetsFunctionPrefix
The common prefix used for all dynamic asset hook functions for the asset
functionPrefix
The common prefix used for all extended item functions associated with the asset
getHeight
The function that handles finding the current variable height setting
key
A key uniquely identifying the asset
maxHeight
The highest Y co-ordinate that can be set
minHeight
The lowest Y co-ordinate that can be set
name
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.
parentOption
The extended item option of the super screen that this archetype was initialized from (if any)
scriptHooks
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.
setHeight
The function that handles applying the height setting to the character
An object containing typed item configuration for an asset. Contains all of the necessary information for the item's load, draw & click handlers.