Package com.kraken.api.simulation.snapshot

Class SimulationPlayerSnapshot

  • public final class SimulationPlayerSnapshot
extends java.lang.Object
    Immutable player metadata included in a simulation snapshot.

    • Constructor Summary

      Constructors 
      Constructor Description
      SimulationPlayerSnapshot​(net.runelite.api.coords.WorldPoint worldPoint, int hitpoints, int maxHitpoints, net.runelite.api.Prayer activeProtectionPrayer, java.util.Map<java.lang.Integer,​java.lang.Integer> inventoryItemQuantities, java.util.Set<java.lang.Integer> equippedItemIds)
      Creates immutable player combat/action metadata used by simulation actions.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static SimulationPlayerSnapshot empty​(net.runelite.api.coords.WorldPoint worldPoint)
      Creates an empty player snapshot with no inventory items or equipped item ids.
      net.runelite.api.coords.WorldPoint getWorldPoint()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SimulationPlayerSnapshot

        public SimulationPlayerSnapshot​(net.runelite.api.coords.WorldPoint worldPoint,
                                int hitpoints,
                                int maxHitpoints,
                                net.runelite.api.Prayer activeProtectionPrayer,
                                java.util.Map<java.lang.Integer,​java.lang.Integer> inventoryItemQuantities,
                                java.util.Set<java.lang.Integer> equippedItemIds)
        Creates immutable player combat/action metadata used by simulation actions.
        Parameters:
        worldPoint - player world point at capture time.
        hitpoints - player hitpoints at capture time.
        maxHitpoints - player max hitpoints at capture time.
        activeProtectionPrayer - active overhead protection prayer at capture time.
        inventoryItemQuantities - stack size by item id for inventory items.
        equippedItemIds - equipped item ids.

    • Method Detail

      • empty

        public static SimulationPlayerSnapshot empty​(net.runelite.api.coords.WorldPoint worldPoint)
        Creates an empty player snapshot with no inventory items or equipped item ids.
        Parameters:
        worldPoint - The world point of the player.
        Returns:
        default player snapshot when no explicit metadata is provided.

      • getWorldPoint

        public net.runelite.api.coords.WorldPoint getWorldPoint()
        Returns:
        unpacked player world point.