Class EntranceLocations

Stores locations & access types for entrances to landmarks.

This class should not be instantiated directly. Instead, use the Landmark.entrances getter to obtain an instance.

Hierarchy

GemAutoreleaseObject
- EntranceLocations

Index

Constructors

Accessors

Methods

addEntranceLocation dispose getCoordinates getType registerAutoReleaseObject

Constructors

constructor

new EntranceLocations(id: number, mapId: number): EntranceLocations
Internal
Parameters
- id: number
  The pointer ID
- mapId: number
  The map ID
Returns EntranceLocations
Overrides GemAutoreleaseObject.constructor
- Defined in core/entrancelocations.ts:64

Accessors

count

get count(): number
Get the entrances count.

Returns number
The number of entrances
- Defined in core/entrancelocations.ts:75

id

get id(): number
Returns number
- Defined in core/entrancelocations.ts:56

mapId

get mapId(): number
Returns number
- Defined in core/entrancelocations.ts:57

Methods

addEntranceLocation

addEntranceLocation(
coordinates: Coordinates,
type: EntranceLocationType,
): boolean
Add new entrance location.
Parameters
- coordinates: Coordinates
  Coordinates of the entrance location
- type: EntranceLocationType
  Type of the entrance location
Returns boolean
true if the entrance location was added successfully, false otherwise
- Defined in core/entrancelocations.ts:120

dispose

dispose(): void
Dispose the entrance locations object

Returns void
- Defined in core/entrancelocations.ts:133

getCoordinates

getCoordinates(index: number): Coordinates
Get the coordinates specified by index.
Parameters
- index: number
  Index of entrance location
Returns Coordinates
Coordinates of the entrance location specified by index
- Defined in core/entrancelocations.ts:89

getType

getType(index: number): EntranceLocationType
Get the entrance type specified by index.
Parameters
- index: number
  Index of entrance location
Returns EntranceLocationType
Type of the entrance location specified by index
- Defined in core/entrancelocations.ts:104

`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:14