AthenaShared.interfaces.wheelMenu.IWheelOptionExt ​

shared/interfaces/wheelMenu.IWheelOptionExt

Used to describe a wheel menu option.

Interface

IWheelOption

Hierarchy ​

• IWheelOption

  ↳ IWheelOptionExt

Properties ​

bgImage ​

• Optional bgImage: string

Image based on asset path. Example: '/assets/icons/bullpuprifle.png'

Inherited from ​

IWheelOption.bgImage

Defined in ​

shared/interfaces/wheelMenu.ts:93

callback ​

• Optional callback: (...args: any[]) => void

Type declaration ​

A callback that will only work on client-side.

Parameters ​

Returns ​

void

Defined in ​

shared/interfaces/wheelMenu.ts:102

color ​

• Optional color: string

A plain text color for the icon and text color.

ie. red, green, yellow, etc.

Inherited from ​

IWheelOption.color

Defined in ​

shared/interfaces/wheelMenu.ts:33

data ​

• Optional data: any[]

Any data that you want to pass through a callback or an event.

Inherited from ​

IWheelOption.data

Defined in ​

shared/interfaces/wheelMenu.ts:75

doNotClose ​

• Optional doNotClose: boolean

Do not close the wheel menu after executing this option.

Inherited from ​

IWheelOption.doNotClose

Defined in ​

shared/interfaces/wheelMenu.ts:51

emitClient ​

• Optional emitClient: string

From the client, emit a client event through alt.emit

Inherited from ​

IWheelOption.emitClient

Defined in ​

shared/interfaces/wheelMenu.ts:67

emitServer ​

• Optional emitServer: string

From the client, call a specific server event through alt.emitServer

Inherited from ​

IWheelOption.emitServer

Defined in ​

shared/interfaces/wheelMenu.ts:59

icon ​

• Optional icon: string

An icon from the icons page in the pages.

ie. icon-home

Inherited from ​

IWheelOption.icon

Defined in ​

shared/interfaces/wheelMenu.ts:43

image ​

• Optional image: string

Image based on asset path. Example: '/assets/icons/bullpuprifle.png'

Inherited from ​

IWheelOption.image

Defined in ​

shared/interfaces/wheelMenu.ts:84

name ​

• name: string

The name of this option.

Inherited from ​

IWheelOption.name

Defined in ​

shared/interfaces/wheelMenu.ts:14

uid ​

• Optional uid: string

A unique identifier for this option.

If not specified one will automatically be created.

Inherited from ​

IWheelOption.uid

Defined in ​

shared/interfaces/wheelMenu.ts:23