IsMapMarkerVisible - ObjectReference

From the CreationKit Wiki
Revision as of 08:02, 28 May 2018 by imported>Rasikko (→‎Notes: explanation on checking for map marker 'discovery'.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Member of: ObjectReference Script

Checks if this map marker is visible to the player.

Syntax[edit | edit source]

bool Function IsMapMarkerVisible() native

Parameters[edit | edit source]

None.

Return Value[edit | edit source]

True if map marker is visible to player. False otherwise.

Examples[edit | edit source]

; Is the Riverwood map marker visible to the player?
bool isMarkerVisible = RiverwoodMarkerObjectRef.IsMapMarkerVisible()


; Is this location discovered?
Bool Function IsLocationDiscovered(ObjectReference akMapMarker)
; Returns true if the location's map marker is visible and
; can be fast traveled to, indicating it has been discovered.

if (akMapMarker.IsMapMarkerVisible() == TRUE && akMapMarker.CanFastTravelToMarker() == TRUE)
    return true
else
    return false
endif
EndFunction

Notes[edit | edit source]

  • This function only returns if the map marker is visible or not. If you want to know if a location is visible and already discovered, use GetMapMarkerVisible.
  • Checking if a location is discovered, requires both this and CanFastTravelToMarker - ObjectReference. If you wish to avoid a scripted method, the above will suffice.

See Also[edit | edit source]