VibratingItemConfig

An object defining all of the required configuration for registering a vibrator item

Hierarchy

• ExtendedItemConfig<VibratingItemOption>
  • VibratingItemConfig

Index

Properties

• AllowEffect
• Archetype
• BaselineProperty
• ChatSetting
• ChatTags
• CopyConfig
• DialogPrefix
• Dictionary
• DrawData
• DrawImages
• Name
• Options
• ScriptHooks

Properties

optionalAllowEffect

AllowEffect?: EffectName[]

Inherited from ExtendedItemConfig.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

Archetype: vibrating

Overrides ExtendedItemConfig.Archetype

The archetype of the extended item config

optionalBaselineProperty

BaselineProperty?: Item

Inherited from ExtendedItemConfig.BaselineProperty

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

ChatSetting?: default

Overrides ExtendedItemConfig.ChatSetting

The chat message setting for the item. This can be provided to allow finer-grained chatroom message keys for the item.

optionalChatTags

ChatTags?: CommonChatTags[]

Inherited from ExtendedItemConfig.ChatTags

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

optionalCopyConfig

CopyConfig?: { AssetName: string; GroupName?: AssetGroupName }

Inherited from ExtendedItemConfig.CopyConfig

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

optionalDialogPrefix

DialogPrefix?: { Chat?: string | ExtendedItemChatCallback<VibratingItemOption>; Header?: string | ExtendedItemHeaderCallback<VibratingItemData>; Option?: string }

Overrides ExtendedItemConfig.DialogPrefix

The optional text configuration for the item. Custom text keys can be configured within this object

---

Type declaration

• optionalChat?: string | ExtendedItemChatCallback<VibratingItemOption>

  The dialogue prefix that will be used for each of the item's chatroom messages

• optionalHeader?: string | ExtendedItemHeaderCallback<VibratingItemData>

  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

Dictionary?: ExtendedItemDictionaryCallback<VibratingItemOption>[]

Inherited from ExtendedItemConfig.Dictionary

Contains custom dictionary entries in the event that the base ones do not suffice.

optionalDrawData

DrawData?: ExtendedItemConfigDrawData<Partial<Vibrating>>

Overrides ExtendedItemConfig.DrawData

An interface with element-specific drawing data for a given screen.

optionalDrawImages

DrawImages?: false

Overrides ExtendedItemConfig.DrawImages

A boolean indicating whether or not images should be drawn for the option and/or module selection screen.

optionalName

Name?: string

Inherited from ExtendedItemConfig.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.

optionalOptions

Options?: VibratorModeSet[]

The list of vibrator mode sets that are available on this item

optionalScriptHooks

ScriptHooks?: ExtendedItemCapsScriptHooksStruct<VibratingItemData, VibratingItemOption>

Overrides ExtendedItemConfig.ScriptHooks

A record 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.