Returns the player's current rest state


See also Player information functions.

Signature:

state, name, multiplier = GetRestState()

Returns:

  • state - Number identiying the current rest state (number)

    • 1 - Rested
    • 2 - Normal
    • 3 - Tired - used in locales with account play time limits
    • 4 - Unhealthy - used in locales with account play time limits

  • name - Localized text describing the player's current rest state (string)

  • multiplier - Multiplier for experience points earned from kills (number)