Class YMapMarker

Hierarchy

YMapMarker

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new YMapMarker(): YMapMarker

Returns YMapMarker

Accessors

background

get background(): YImage | YCustomImage
set background(value: YImage | YCustomImage): any

Allows to get/set background image of the map marker.

Returns YImage | YCustomImage
Allows to get/set background image of the map marker.

Parameters
- value: YImage | YCustomImage
Returns any

backgroundColor

get backgroundColor(): YColor
set backgroundColor(value: YColor): any

Allows to get/set background image color of the map marker.

Returns YColor
Allows to get/set background image color of the map marker.

Parameters
- value: YColor
Returns any

image

get image(): YImage | YCustomImage
set image(value: YImage | YCustomImage): any

Allows to get/set foreground image of the map marker.

Returns YImage | YCustomImage
Allows to get/set foreground image of the map marker.

Parameters
- value: YImage | YCustomImage
Returns any

imageColor

get imageColor(): YColor
set imageColor(value: YColor): any

Allows to get/set foreground image color of the map marker.

Returns YColor
Allows to get/set foreground image color of the map marker.

Parameters
- value: YColor
Returns any

imageRelativeScale

get imageRelativeScale(): number
set imageRelativeScale(value: number): any

Allows to get/set the relative size of the foreground image to the overall scale of the map marker.

Returns number
Allows to get/set the relative size of the foreground image to the overall scale of the map marker.

Parameters
- value: number
Returns any

inFogOfWar

get inFogOfWar(): YMapMarkerInFOW
set inFogOfWar(value: YMapMarkerInFOW): any

Allows to get/set fog of war behaviour of the map marker.

Returns YMapMarkerInFOW
Allows to get/set fog of war behaviour of the map marker.

Parameters
- value: YMapMarkerInFOW
Returns any

position

get position(): YVector3
set position(value: YVector3): any

Allows to get/set the position of the world map marker.

Returns YVector3
Allows to get/set the position of the world map marker.

Parameters
- value: YVector3
Returns any

positionOffset

get positionOffset(): YVector3
set positionOffset(value: YVector3): any

Allows to get/set the offset position of the object map marker from it's parent object.

Returns YVector3
Allows to get/set the offset position of the object map marker from it's parent object.

Parameters
- value: YVector3
Returns any

priority

get priority(): number
set priority(value: number): any

Allows to get/set priority of the map marker. Determines which map marker draws over which, when overlapping.

Returns number
Allows to get/set priority of the map marker. Determines which map marker draws over which, when overlapping.

Parameters
- value: number
Returns any

rotateWithObject

get rotateWithObject(): boolean
set rotateWithObject(value: boolean): any

Allows to get/set whether the object map marker rotates in the same direction in Y axis as it's parent object.

Returns boolean
Allows to get/set whether the object map marker rotates in the same direction in Y axis as it's parent object.

Parameters
- value: boolean
Returns any

scale

get scale(): number
set scale(value: number): any

Allows to get/set the scale of the map marker.

Returns number
Allows to get/set the scale of the map marker.

Parameters
- value: number
Returns any

scaleWithZoom

get scaleWithZoom(): boolean
set scaleWithZoom(value: boolean): any

Allows to get/set whether the map marker remains the same size on map zoom or not.

Returns boolean
Allows to get/set whether the map marker remains the same size on map zoom or not.

Parameters
- value: boolean
Returns any

shadow

get shadow(): boolean
set shadow(value: boolean): any

Allows to get/set whether the background image of the map marker casts shadow on the map.

Returns boolean
Allows to get/set whether the background image of the map marker casts shadow on the map.

Parameters
- value: boolean
Returns any

tooltip

get tooltip(): string
set tooltip(value: string): any

Allows to get/set the tooltip text of the map marker.

Returns string
Allows to get/set the tooltip text of the map marker.

Parameters
- value: string
Returns any

Methods

isVisible

isVisible(player: YCharacter): boolean

Allows to get whether the map marker is visible to target player.

Parameters
- player: YCharacter
Returns boolean

setVisible

setVisible(player: YCharacter, visible: boolean): void

Allows to set whether the map marker is visible to target player.

Parameters
- player: YCharacter
- visible: boolean
Returns void

Generated using TypeDoc