Skip to content
On this page

AthenaClient.menus.object

Type Aliases

ObjectMenuInjection

Ƭ ObjectMenuInjection: (existingObject: player, options: IWheelOptionExt[]) => IWheelOptionExt[]

Type declaration

Usage

AthenaClient.menus.object.(existingObject, options): IWheelOptionExt[]

Parameters
NameType
existingObjectplayer
optionsIWheelOptionExt[]
Returns

IWheelOptionExt[]

Defined in

client/menus/object.ts:8

Functions

addInjection

Usage

AthenaClient.menus.object.addInjection(callback): void

Allows the current Menu Options to be modified. Meaning, a callback that will modify existing options, or append new options to the menu. Must always return the original wheel menu options + your changes.

Static

Parameters

NameType
callbackObjectMenuInjection

Returns

void

Defined in

client/menus/object.ts:25


disable

Usage

AthenaClient.menus.object.disable(): void

Disable the Object Wheel Menu

Export

Returns

void

Defined in

client/menus/object.ts:98


open

Usage

AthenaClient.menus.object.open(object): void

Opens the wheel menu against a target object created with the server-side object api

Static

Parameters

NameType
objectCreatedObject

Returns

void

Defined in

client/menus/object.ts:45


override

Usage

AthenaClient.menus.object.override(functionName, callback): any

Parameters

NameType
functionName"addInjection"
callback(callback: ObjectMenuInjection) => void

Returns

any

Defined in

client/menus/object.ts:109

Usage

AthenaClient.menus.object.override(functionName, callback): any

Parameters

NameType
functionName"open"
callback(object: CreatedObject) => void

Returns

any

Defined in

client/menus/object.ts:110

Created by Stuyk | Est. 2020