Skip to main content

ExtendedItemScriptHookCallbacks

Namespace with item-specific script hooks used for constructing typical extended items functions.

See more at ExtendedItemCallbacks

Index

Type Aliases

Type Aliases

AfterDraw

AfterDraw<DataType, PersistentData>: ExtendedItemScriptHookCallback<DataType, [drawData: DynamicDrawingData<PersistentData>]>

Callback for extended item AfterDraw functions. Relevant for assets that define Asset.DynamicAfterDraw.

Type parameters

The items extended item data

The function (if any) that is normally called when an archetypical item reaches this point

The dynamic draw data

BeforeDraw

BeforeDraw<DataType, PersistentData>: ExtendedItemScriptHookCallback<DataType, [drawData: DynamicDrawingData<PersistentData>], DynamicBeforeDrawOverrides>

Callback for extended item BeforeDraw functions. Relevant for assets that define Asset.DynamicBeforeDraw.

Type parameters

The items extended item data

The function (if any) that is normally called when an archetypical item reaches this point

The dynamic draw data

A record with any and all to-be overriden draw data

Click

Click<DataType>: ExtendedItemScriptHookCallbackNoNull<DataType, []>

Callback for extended item Click script hooks. Click functions are responsible for managing any mouse clicks within the extended item menu.

Type parameters

The items extended item data

The function that is normally called when an archetypical item reaches this point

Draw

Draw<DataType>: ExtendedItemScriptHookCallbackNoNull<DataType, []>

Callback for extended item Draw script hooks. Draw functions are responsible for drawing any UI elements within the extended item menu.

Type parameters

The items extended item data

The function that is normally called when an archetypical item reaches this point

Exit

Exit<DataType>: ExtendedItemScriptHookCallback<DataType, []>

Callback for extended item Exit script hooks. Exit functions are responsible for cleaning up any UI elements when closing the extended item menu.

Type parameters

The items extended item data

The function (if any) that is normally called when an archetypical item reaches this point

Init

Init<DataType>: ExtendedItemScriptHookCallbackNoNull<DataType, [C: Character, item: Item, push: boolean, refresh: boolean], boolean>

Callback for extended item Init script hooks. Init functions are responsible for setting the initial properties of an extended item.

Type parameters

The items extended item data

The function (if any) that is normally called when an archetypical item reaches this point

The character that has the item equipped

The item in question

Whether to push to changes to the server

Whether to refresh the character. This should generally be true, with custom script hooks being a potential exception.

Whether the items properties were actually updated or not

Load

Load<DataType>: ExtendedItemScriptHookCallbackNoNull<DataType, []>

Callback for extended item Load script hooks. Load functions are responsible for setting up the UI when initially opening the extended item menu.

Type parameters

The items extended item data

The function that is normally called when an archetypical item reaches this point

PublishAction

PublishAction<DataType, OptionType>: ExtendedItemScriptHookCallback<DataType, [C: Character, item: Item, newOption: OptionType, previousOption: OptionType]>

Callback for extended item PublishAction script hooks. PublishAction functions are responsible for reporting any changes to an item's properties via a chat message.

Type parameters

The items extended item data

The function (if any) that is normally called when an archetypical item reaches this point

The character that has the item equipped

The item in question

The newly selected extended item option

The previously selected extended item option

ScriptDraw

ScriptDraw<DataType, PersistentData>: ExtendedItemScriptHookCallback<DataType, [drawData: DynamicScriptCallbackData<PersistentData>]>

Callback for extended item ScriptDraw functions. Relevant for assets that define Asset.DynamicScriptDraw.

Type parameters

The items extended item data

The function (if any) that is normally called when an archetypical item reaches this point

The dynamic draw data

SetOption

SetOption<DataType, OptionType>: ExtendedItemScriptHookCallback<DataType, [C: Character, item: Item, newOption: OptionType, previousOption: OptionType, push: boolean, refresh: boolean]>

Callback for extended item SetOption functions.

Type parameters

The items extended item data

The function that is normally called when an archetypical item reaches this point

The character that has the item equipped

The item in question

The newly selected extended item option

The previously selected extended item option

Whether to push to changes to the server

Whether to refresh the character. This should generally be true, with custom script hooks being a potential exception.

Validate

Validate<DataType, OptionType>: ExtendedItemScriptHookCallback<DataType, [C: Character, item: Item, newOption: OptionType, previousOption: OptionType, permitExisting?: boolean], string>

Callback for extended item Validate script hooks. Validate functions are responsible for validating any change in an item's properties.

Type parameters

The items extended item data

The function (if any) that is normally called when an archetypical item reaches this point

The character that has the item equipped

The item in question

The newly selected extended item option

The previously selected extended item option

Determines whether the validation should allow the new option and previous option to be identical. Defaults to false.

A non-empty message string if the item failed validation, or an empty string otherwise

Page Options