SetCleared - Location

Member of: Location Script

Flags or unflags this location as cleared.

Syntax

Function SetCleared(bool abCleared = true) native

Parameters

• abCleared: Whether to set or clear the cleared flag.
  • Default: True

Return Value

None.

Examples

; Flag the house as cleared
HouseProperty.SetCleared()

; Unflag the house as cleared
HouseProperty.SetCleared(false)

Notes

• SetCleared does not update the 'Dungeons Cleared' misc stat. When using SetCleared, make sure to follow it with a call to IncrementStat if appropriate.

See Also

• Location Script
• IsCleared - Location
• HasEverBeenCleared - Location