Skip to main content

NoArchItemData

Abstract extended item data interface that all archetypical item data interfaces must implement. Archetypes are free to demand any appropriate subtype for a given property.

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: noarch

The archetype of the extended item data

asset

asset: Asset

The asset reference

baselineProperty

baselineProperty: ItemProperties

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

chatSetting: default

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

chatTags: CommonChatTags[]

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

dialogPrefix

dialogPrefix: { chat?: string | ExtendedItemChatCallback<NoArchItemOption>; header: string | ExtendedItemHeaderCallback<NoArchItemData>; option?: string }

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


Type declaration

  • optionalchat?: string | ExtendedItemChatCallback<NoArchItemOption>

    The prefix used for dialog keys representing the item's chatroom messages when its type is changed

  • header: string | ExtendedItemHeaderCallback<NoArchItemData>

    The dialog key for the item's load text (usually a prompt to select the type)

  • optionaloption?: string

    The prefix used for dialog keys representing the display names of the item's types

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.

parentOption

parentOption: ExtendedItemOption

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.