Client

Guide to use the script more advanced

Exports are used to sync the zone script with the addon script

IsInZone

Check if the player is inside the zone

Return:

  • Boolean:

    • true: the player inside the zone

    • false: the player outside the zone

Usage
exports["highqez_AFKzone"]:IsInZone()

IsInSafeZone

Works if EnableSafeZoneUI= true

Check if the player is inside the Safe zone

Return:

  • Boolean:

    • true: the player is inside the Safe zone

    • false: the player is outside the Safe zone

Usage
exports["highqez_AFKzone"]:IsInSafeZone()

IsInAFKZone

Works if EnableAFKZoneUI = true

Check if the player is inside the AFK zone

Return:

  • Boolean:

    • true: the player is inside the AFK zone

    • false: the player is outside the AFK zone

Usage
exports["highqez_AFKzone"]:IsInAFKZone()

GetZoneName

Obtain the current zone name

Return:

  • String:

    • zonename: the name of the zone player is inside

  • Boolean:

    • false: the player is outside the zone

Usage
exports["highqez_AFKzone"]:GetZoneName()

Last updated

Was this helpful?