V5 DocsAthenaClient.menus.object ​
Type Aliases ​
ObjectMenuInjection ​
Ƭ ObjectMenuInjection: (existingObject: player, options: IWheelOptionExt[]) => IWheelOptionExt[]
Type declaration ​
Usage
AthenaClient.menus.object.(existingObject, options): IWheelOptionExt[]
Parameters ​
| Name | Type |
|---|---|
existingObject | player |
options | IWheelOptionExt[] |
Returns ​
Defined in ​
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 ​
| Name | Type |
|---|---|
callback | ObjectMenuInjection |
Returns ​
void
Defined in ​
disable ​
Usage
AthenaClient.menus.object.disable(): void
Disable the Object Wheel Menu
Export
Returns ​
void
Defined in ​
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 ​
| Name | Type |
|---|---|
object | CreatedObject |
Returns ​
void
Defined in ​
override ​
Usage
AthenaClient.menus.object.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "addInjection" |
callback | (callback: ObjectMenuInjection) => void |
Returns ​
any
Defined in ​
Usage
AthenaClient.menus.object.override(functionName, callback): any
Parameters ​
| Name | Type |
|---|---|
functionName | "open" |
callback | (object: CreatedObject) => void |
Returns ​
any