Difference between revisions of "IsCleared - Location"
Jump to navigation
Jump to search
imported>Terra Nova2 |
TwilightSky (talk | contribs) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 25: | Line 25: | ||
== Notes == | == 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. | ||
*A location is cleared whenever all enemies that have a "Boss" [[LocationRefType]] assigned to them is killed. | |||
== See Also == | == See Also == | ||
*[[Location Script]] | *[[Location Script]] | ||
Latest revision as of 13:35, 11 July 2023
Member of: Location Script
Returns if this location is flagged as cleared or not.
Syntax[edit | edit source]
bool Function IsCleared() nativeParameters[edit | edit source]
None.
Return Value[edit | edit source]
Whether this location is flagged as cleared or not.
Examples[edit | edit source]
; Is this location cleared?
if (MyHouseProperty.IsCleared())
Debug.Trace("My house is cleared")
endIfNotes[edit | edit source]
- 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.
- A location is cleared whenever all enemies that have a "Boss" LocationRefType assigned to them is killed.