IsCleared - Location

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.
• A location is cleared whenever all enemies that have a "Boss" LocationRefType assigned to them is killed.

See Also

• Location Script