Class YMap

Hierarchy

YMap

Index

Constructors

constructor

Methods

Constructors

constructor

new YMap(): YMap

Returns YMap

Methods

Static addObjectMarker

addObjectMarker(targetObject: YEntity | YLogic | YGroup, id: string, image: YImage | YCustomImage, backgroundColor: YColor, visibleByDefault: boolean): YMapMarker

Creates a new map marker object as a child to the target object.

Parameters
- targetObject: YEntity | YLogic | YGroup
- id: string
- image: YImage | YCustomImage
- backgroundColor: YColor
- visibleByDefault: boolean
Returns YMapMarker

Static addWorldMarker

addWorldMarker(position: YVector3, id: string, image: YImage | YCustomImage, backgroundColor: YColor, visibleByDefault: boolean): YMapMarker

Creates a new unbound map marker object placed on target world coordinates.

Parameters
- position: YVector3
- id: string
- image: YImage | YCustomImage
- backgroundColor: YColor
- visibleByDefault: boolean
Returns YMapMarker

Static getObjectMarker

getObjectMarker(targetObject: YEntity | YLogic | YGroup, id: string): YMapMarker

Returns a map marker object of the target parent object by it's unique ID.

Parameters
- targetObject: YEntity | YLogic | YGroup
- id: string
Returns YMapMarker

Static getObjectMarkers

getObjectMarkers(targetObject: YEntity | YLogic | YGroup): YMapMarker[]

Returns a list of map markers associated with the target parent object.

Parameters
- targetObject: YEntity | YLogic | YGroup
Returns YMapMarker[]

Static getWorldMarker

getWorldMarker(id: string): YMapMarker

Returns a world map marker object of the unique ID.

Parameters
- id: string
Returns YMapMarker

Static getWorldMarkers

getWorldMarkers(): YMapMarker[]

Returns a list of world map markers.

Returns YMapMarker[]

Static removeMarker

removeMarker(marker: YMapMarker): void

Removes the target map marker object.

Parameters
- marker: YMapMarker
Returns void

Generated using TypeDoc