ModularItemData
Hierarchy
- ExtendedItemData<ModularItemOption>
- ModularItemData
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 item's chatroom message setting. Determines the level of granularity for chatroom messages when the item's module values change.
chatTags
An array of the chat message tags that should be included in the item's chatroom messages.
clickFunctions
A lookup for the click functions for each of the item's modules
currentModule
Name of currently active module
dialogPrefix
A record containing various dialog keys used by the extended item screen
Type declaration
chat: string | ExtendedItemChatCallback<ModularItemOption>
The dialogue prefix that will be used for each of the item's chatroom messages
header: string | ExtendedItemHeaderCallback<ModularItemData>
The dialogue prefix for the player prompt that is displayed on each module's menu screen
module: string
The dialogue prefix for the name of each module
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
A lookup for the draw data for each of the item's modules
drawFunctions
A lookup for the draw functions for each of the item's modules
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
key
A key uniquely identifying the asset
modules
The module definitions for the modular item
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.
pages
A lookup for the current page in the extended item menu for each of the item's modules
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.
typeCount
The total number of types permitted by the item
An object containing modular item configuration for an asset. Contains all of the necessary information for the item's load, draw & click handlers.