Class OverlayInfo

Overlay info class

This class should not be instantiated directly.

Hierarchy

GemAutoreleaseObject
- OverlayInfo

Index

Constructors

Accessors

categories image img name pointerId uid

Methods

getCategory hasCategories registerAutoReleaseObject init

Constructors

`Protected`constructor

new OverlayInfo(pointerId: number): OverlayInfo
Parameters
- pointerId: number
Returns OverlayInfo
Overrides GemAutoreleaseObject.constructor
- Defined in core/overlays.ts:175

Accessors

categories

get categories(): OverlayCategory[]
Get the overlay categories.

Returns OverlayCategory[]
List of overlay categories

Throws
An exception if it fails
- Defined in core/overlays.ts:196

image

get image(): Uint8Array<ArrayBufferLike> | null
Get the image of the overlay

Returns Uint8Array<ArrayBufferLike> | null
The image as Uint8Array if available, null otherwise

Throws
An exception if it fails
- Defined in core/overlays.ts:224

img

get img(): Img
Get the Img object of the overlay

Returns Img
The Img object

Throws
An exception if it fails
- Defined in core/overlays.ts:235

name

get name(): string
Get the name of the overlay

Returns string
The overlay name

Throws
An exception if it fails
- Defined in core/overlays.ts:247

pointerId

get pointerId(): number
Returns number
- Defined in core/overlays.ts:186

uid

get uid(): number
Get the unique ID of the overlay

Returns number
The overlay ID

Throws
An exception if it fails
- Defined in core/overlays.ts:259

Methods

getCategory

getCategory(categId: number): OverlayCategory | null
Get the overlay category by ID
Parameters
- categId: number
  The category ID
Returns OverlayCategory | null
The category if found, null otherwise

Throws
An exception if it fails
- Defined in core/overlays.ts:209

hasCategories

hasCategories(categId: number): boolean
Check if a category has subcategories
Parameters
- categId: number
  The category ID
Returns boolean
True if the category has subcategories, false otherwise

Throws
An exception if it fails
- Defined in core/overlays.ts:272

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:24

`Static`init

init(id: number): OverlayInfo
Internal
Parameters
- id: number
Returns OverlayInfo
- Defined in core/overlays.ts:182