OSRS Plugin API
    Preparing search index...

    Namespace ClientState

    This section applies to the current state of the old school runescape client and functions that help you get that information. With these functions you can get access to what account the current user has, where their stats are currently at, how far away they are from leveling up, as well as the current tick (frame) of the game and information about various items.

    Lets say you want to create a plugin that helps track how far away a player is from leveling up. Using ClientState functions you can get their current level for any stat, such as strength, with a request for the stat’s base level (getStatBaseLevel). You can also find the effective level of that stat (getStatEffectiveLevel), and see how much experience is needed until the player’s next level up (getStatRemainingXPUntilLevel).

    You also have access to other client information. You can find out if the client is currently logged into a server (isLoggedIn) and what the current tick is at (getTickCount). Using these you can have your plugin track how long a player has been logged in and playing the game, allowing you to do all kinds of cool things.

    The variety of ClientState functions can allow your plugin to interact with the runescape client and a player's progress in a variety of useful ways.

    Enumerations

    ProfileType
    Stats

    Functions

    getIntegerVarc
    getProfileType
    getStatBaseLevel
    getStatEffectiveLevel
    getStatRemainingXPUntilLevel
    getStatXP
    getStringVarc
    getTickCount
    getVarbit
    getVarp
    isLoggedIn