IsMapMarkerVisible - ObjectReference

From Creation Kit
Jump to: navigation, search

Member of: ObjectReference Script

Checks if this map marker is visible to the player.

Syntax

bool Function IsMapMarkerVisible() native

Parameters

None.

Return Value

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

Examples

; 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

  • 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