Skip to main content

TypedItemData

An object containing typed item configuration for an asset. Contains all of the necessary information for the item's load, draw & click handlers.

Hierarchy

Index

Properties

allowEffect

allowEffect: readonly EffectName[]

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

archetype: typed

The archetype of the extended item data

asset

asset: Asset

The asset reference

baselineProperty

baselineProperty: Item

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. Defaults to TypedItemChatSetting.TO_ONLY

chatTags

chatTags: CommonChatTags[]

An array of the chat message tags that should be included in the item's chatroom messages.

dialogPrefix

dialogPrefix: { chat: string | ExtendedItemChatCallback<TypedItemOption>; header: string | ExtendedItemHeaderCallback<TypedItemData>; npc: string | ExtendedItemNPCCallback<TypedItemOption>; option: string }

A record containing various dialog keys used by the extended item screen


Type declaration

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

dynamicAssetsFunctionPrefix: string

The common prefix used for all dynamic asset hook functions for the asset

functionPrefix

functionPrefix: string

The common prefix used for all extended item functions associated with the asset

key

key: string

A key uniquely identifying the asset

name

name: string

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.

options

options: TypedItemOption[]

The list of extended item options available for the item

parentOption

parentOption: null

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, validate and publishaction, 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.