Class Skills

java.lang.Object
privbot.hooks.Skills

public final class Skills extends Object
Skill levels and experience: ctx.skills.

The int reads (boosted(net.runelite.api.Skill), realLevel(net.runelite.api.Skill)) answer 0 when they cannot read, and on Impact, Elorin and SpawnPK a raw client read can answer a placeholder 99. Decisions use the observed reads: observedBoosted(net.runelite.api.Skill), observedReal(net.runelite.api.Skill), xp(net.runelite.api.Skill) (all Observed), or observedLevel(net.runelite.api.Skill, boolean) (nullable).

  • Constructor Details

    • Skills

      public Skills(net.runelite.api.Client client)
      Without an adapter: every read goes through the RuneLite client.
      Parameters:
      client - the client
  • Method Details

    • observedLevel

      public Integer observedLevel(net.runelite.api.Skill skill, boolean boosted)
      Nullable observation for decisions that must distinguish missing skill data from zero: null when the level cannot be read or has not arrived from the server yet. On Impact, Elorin and SpawnPK a raw client read can answer a placeholder level; this method never returns one.
    • fromDisplayName

      public static net.runelite.api.Skill fromDisplayName(String name)
      Parameters:
      name - an in-game skill name ("Attack", "hitpoints", "Hit points"), case-insensitive
      Returns:
      the skill, or null for an unknown name
    • getHitpoints

      public int getHitpoints()
      Returns:
      current (boosted) hitpoints; 0 when unreadable
    • boosted

      public int boosted(net.runelite.api.Skill skill)
      Parameters:
      skill - the skill
      Returns:
      the current level; 0 when unreadable (see observedBoosted(Skill))
    • boosted

      public int boosted(String skillName)
      Parameters:
      skillName - the skill's in-game name
      Returns:
      the current level; 0 for an unknown name (logged) or when unreadable
    • realLevel

      public int realLevel(net.runelite.api.Skill skill)
      Parameters:
      skill - the skill
      Returns:
      the base level; 0 when unreadable (see observedReal(Skill))
    • realLevel

      public int realLevel(String skillName)
      Parameters:
      skillName - the skill's in-game name
      Returns:
      the base level; 0 for an unknown name (logged) or when unreadable
    • observedReal

      public Observed<Integer> observedReal(net.runelite.api.Skill skill)
      The base (real) level as an Observed: UNREADABLE when this client's skill levels cannot be read or have not arrived from the server yet, never a placeholder 99 or a 0.
      Parameters:
      skill - the skill
      Returns:
      the real level
    • observedReal

      public Observed<Integer> observedReal(String skillName)
      observedReal(Skill) by in-game name ("Attack", "Hitpoints").
      Parameters:
      skillName - the skill's in-game name
      Returns:
      the real level; UNREADABLE for an unknown name
    • observedBoosted

      public Observed<Integer> observedBoosted(net.runelite.api.Skill skill)
      The current (boosted or drained) level as an Observed; UNREADABLE as for observedReal(Skill).
      Parameters:
      skill - the skill
      Returns:
      the boosted level
    • observedBoosted

      public Observed<Integer> observedBoosted(String skillName)
      observedBoosted(Skill) by in-game name.
      Parameters:
      skillName - the skill's in-game name
      Returns:
      the boosted level; UNREADABLE for an unknown name
    • xp

      public Observed<Integer> xp(net.runelite.api.Skill skill)
      Experience in skill. UNREADABLE when this client's experience cannot be read, or while it is still all zeros (not received from the server: Hitpoints alone starts at 1,154 XP). On RuneLite-API servers this is client.getSkillExperience, once the real level has arrived.
      Parameters:
      skill - the skill
      Returns:
      the experience
    • xp

      public Observed<Integer> xp(String skillName)
      xp(Skill) by in-game name.
      Parameters:
      skillName - the skill's in-game name
      Returns:
      the experience; UNREADABLE for an unknown name