Difference between revisions of "IsCleared - Location"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Terra Nova2
m
imported>Terra Nova2
Line 25: Line 25:


== Notes ==
== Notes ==
*This function checks if the dungeon is [b]currently[/b] cleared, as in the moment you clear it, this function will return true. For dungeons that have respawned, this will return false until the boss is killed again, regardless if the dungeon has already been marked as cleared in an earlier run.
*This function checks if the dungeon is '''currently''' cleared, as in the moment you clear it, this function will return true. For dungeons that have respawned, this will return false until the boss is killed again, regardless if the dungeon has already been marked as cleared in an earlier run.


== See Also ==
== See Also ==
*[[Location Script]]
*[[Location Script]]

Revision as of 11:14, 27 November 2014

Member of: Location Script

Returns if this location is flagged as cleared or not.

Syntax

bool Function IsCleared() native

Parameters

None.

Return Value

Whether this location is flagged as cleared or not.

Examples

; Is this location cleared?
if (MyHouseProperty.IsCleared())
  Debug.Trace("My house is cleared")
endIf

Notes

  • This function checks if the dungeon is currently cleared, as in the moment you clear it, this function will return true. For dungeons that have respawned, this will return false until the boss is killed again, regardless if the dungeon has already been marked as cleared in an earlier run.

See Also