Merge remote-tracking branch 'refs/remotes/upstream/master'

# Conflicts:
#	src/main/kotlin/world/player/item/banking/regularBank/openBank.kts

Author: hydrozoa-yt

src/main/java/io/luna/game/model/Entity.java

@@ -8,6 +8,7 @@
 import io.luna.game.model.mob.Mob;
 import io.luna.game.model.mob.MobList;
 import io.luna.game.model.mob.Player;
+import io.luna.game.model.mob.attr.AttributeMap;
 import io.luna.game.plugin.PluginManager;
 import io.luna.game.GameService;
 import org.apache.logging.log4j.LogManager;
@@ -24,7 +25,7 @@
  * @author lare96
  */
 public abstract class Entity {
-// todo interactable conditions
+
     /**
      * A {@link Comparator} that sorts {@link Entity} types by closest to furthest distance from the base entity.
      */
@@ -95,6 +96,11 @@ public int compare(Entity o1, Entity o2) {
      */
     protected volatile ChunkRepository chunkRepository;
 
+    /**
+     * The attribute map.
+     */
+    private AttributeMap attributes;
+
     /**
      * Creates a new {@link Entity}.
      *
@@ -312,6 +318,17 @@ private void removeCurrentChunk() {
         }
     }
 
+    /**
+     * @return The attribute map.
+     */
+    public final AttributeMap getAttributes() {
+        if(attributes == null) {
+            // Lazy initialization is necessary, otherwise way too much memory will be used.
+            attributes = new AttributeMap();
+        }
+        return attributes;
+    }
+
     /**
      * @return The context instance.
      */

src/main/java/io/luna/game/model/mob/Mob.java

@@ -9,7 +9,6 @@
 import io.luna.game.model.Position;
 import io.luna.game.model.mob.MobDeathTask.NpcDeathTask;
 import io.luna.game.model.mob.MobDeathTask.PlayerDeathTask;
-import io.luna.game.model.mob.attr.AttributeMap;
 import io.luna.game.model.mob.block.Animation;
 import io.luna.game.model.mob.block.Graphic;
 import io.luna.game.model.mob.block.Hit;
@@ -33,11 +32,6 @@
  */
 public abstract class Mob extends Entity {
 
-    /**
-     * The attribute map.
-     */
-    protected final AttributeMap attributes = new AttributeMap();
-
     /**
      * The update flag set.
      */
@@ -555,13 +549,6 @@ public void onTeleport(Position newPosition) {
 
     }
 
-    /**
-     * @return The attribute map.
-     */
-    public final AttributeMap getAttributes() {
-        return attributes;
-    }
-
     /**
      * @return The update flag set.
      */

src/main/java/io/luna/game/model/mob/WalkingQueue.java

@@ -10,17 +10,13 @@
 import io.luna.game.model.collision.CollisionManager;
 import io.luna.game.model.path.AStarPathfindingAlgorithm;
 import io.luna.game.model.path.EuclideanHeuristic;
+import io.luna.game.model.path.PathfindingAlgorithm;
 import io.luna.game.model.path.SimplePathfindingAlgorithm;
 import io.luna.util.RandomUtils;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
-import java.util.ArrayDeque;
-import java.util.Arrays;
-import java.util.Deque;
-import java.util.Objects;
-import java.util.Optional;
-import java.util.Queue;
+import java.util.*;
 
 /**
  * A model representing an implementation of the walking queue.
@@ -124,16 +120,7 @@ public int getY() {
      * The collision manager.
      */
     private final CollisionManager collisionManager;
-
-    /**
-     * The simple pathfinder.
-     */
-    private final SimplePathfindingAlgorithm simplePathfinder;
-
-    /**
-     * The A* pathfinder.
-     */
-    private final AStarPathfindingAlgorithm astarPathfinder;
+    private final PathfindingAlgorithm pathfindingAlgorithm;
 
     /**
      * The mob.
@@ -163,8 +150,11 @@ public int getY() {
     public WalkingQueue(Mob mob) {
         this.mob = mob;
         collisionManager = mob.getWorld().getCollisionManager();
-        simplePathfinder = new SimplePathfindingAlgorithm(collisionManager);
-        astarPathfinder = new AStarPathfindingAlgorithm(collisionManager, new EuclideanHeuristic());
+        if (mob instanceof Player) {
+            this.pathfindingAlgorithm = new AStarPathfindingAlgorithm(collisionManager, new EuclideanHeuristic());
+        } else {
+            this.pathfindingAlgorithm = new SimplePathfindingAlgorithm(collisionManager);
+        }
     }
 
     /**
@@ -265,7 +255,7 @@ public void walk(Position destination) {
      */
     public void walkUntilReached(Entity target) {
         Deque<Step> newPath = new ArrayDeque<>();
-        Deque<Position> path = astarPathfinder.find(mob.getPosition(), target.getPosition());
+        Deque<Position> path = pathfindingAlgorithm.find(mob.getPosition(), target.getPosition());
         Position lastPosition = mob.getPosition();
         for (; ; ) {
             Position nextPosition = path.poll();
@@ -507,8 +497,7 @@ private void incrementRunEnergy() {
      * @return The path.
      */
     private Deque<Step> findPath(Position target) {
-        Deque<Position> positionPath = mob.getType() == EntityType.PLAYER ? astarPathfinder.find(mob.getPosition(), target) :
-                simplePathfinder.find(mob.getPosition(), target);
+        Deque<Position> positionPath = pathfindingAlgorithm.find(mob.getPosition(), target);
         Deque<Step> stepPath = new ArrayDeque<>(positionPath.size());
         for (; ; ) {
             // TODO remove step class?

src/main/java/io/luna/game/model/mob/attr/AttributeMap.java

@@ -34,7 +34,7 @@ public final class AttributeMap {
     /**
      * A map that holds attribute key and value pairs.
      */
-    private final Map<Attribute<?>, Object> attributes = new IdentityHashMap<>(64);
+    private final Map<Attribute<?>, Object> attributes = new IdentityHashMap<>(12);
 
     /**
      * The last accessed key.

src/main/java/io/luna/game/model/path/PathfindingAlgorithm.java

@@ -15,7 +15,7 @@
  *
  * @author Major
  */
-abstract class PathfindingAlgorithm {
+public abstract class PathfindingAlgorithm {
 
     //todo concurrency for long paths?
     protected final CollisionManager collisionManager;

src/main/kotlin/api/attr/AttributeDelegate.kt

@@ -1,5 +1,6 @@
 package api.attr
 
+import io.luna.game.model.Entity
 import io.luna.game.model.mob.Player
 import io.luna.game.model.mob.attr.Attribute
 import kotlin.reflect.KProperty
@@ -14,14 +15,14 @@ class AttributeDelegate<T : Any?>(val attr: Attribute<T>) {
     /**
      * Retrieve the attribute value.
      */
-    operator fun getValue(player: Player, property: KProperty<*>): T =
-        player.attributes[attr]
+    operator fun getValue(entity: Entity, property: KProperty<*>): T =
+        entity.attributes[attr]
 
     /**
      * Set the attribute value.
      */
-    operator fun setValue(player: Player, property: KProperty<*>, value: T) {
-        player.attributes[attr] = value
+    operator fun setValue(entity: Entity, property: KProperty<*>, value: T) {
+        entity.attributes[attr] = value
     }
 
     /**

src/main/kotlin/api/attr/AttributeExtensionFunctions.kt

@@ -1,17 +1,18 @@
 package api.attr
 
+import io.luna.game.model.Entity
 import io.luna.game.model.mob.Player
 import io.luna.game.model.mob.attr.Attribute
 import kotlin.reflect.KProperty
 
 /**
  * An extension property that adds a getter delegate to [Attribute].
  */
-operator fun <T> Attribute<T>.getValue(plr: Player, property: KProperty<*>): T = plr.attributes[this]
+operator fun <T> Attribute<T>.getValue(entity: Entity, property: KProperty<*>): T = entity.attributes[this]
 
 /**
  * An extension property that adds a setter delegate to [Attribute].
  */
-operator fun <T> Attribute<T>.setValue(plr: Player, property: KProperty<*>, value: T) {
-    plr.attributes[this] = value
+operator fun <T> Attribute<T>.setValue(entity: Entity, property: KProperty<*>, value: T) {
+    entity.attributes[this] = value
 }

src/main/kotlin/world/player/item/banking/regularBank/Banking.kt

@@ -1,12 +1,18 @@
 package world.player.item.banking.regularBank
 
 import api.predef.*
+import io.luna.game.model.def.*
 
 /**
  * Holds utility functions related to banking.
  */
 object Banking {
 
+    /**
+     * ID of the default banker npc.
+     */
+    val DEFAULT_BANKER: Int = 494
+
     /**
      * The mutable set of banking objects.
      */
@@ -17,6 +23,16 @@ object Banking {
      */
     val bankingObjects: Set<Int> = loadObjects
 
+    /**
+     * Mutable set of banking npc ids.
+     */
+    private val loadBankingNpcs = mutableSetOf<Int>()
+
+    /**
+     * Immutable set of banker npc ids.
+     */
+    val bankingNpcs: Set<Int> = loadBankingNpcs
+
     /**
      * Loads all banking objects based on definitions from the cache.
      */
@@ -30,4 +46,13 @@ object Banking {
             }
         }
     }
+
+    /**
+     * Loads all banking npcs based on definitions from the cache.
+     */
+    internal fun loadBankingNpcs() {
+        NpcDefinition.ALL
+            .filter { npcDefinition -> npcDefinition?.name?.contains("Banker", ignoreCase = true) ?: false }
+            .forEach({ npcDefinition -> loadBankingNpcs.add(npcDefinition.id)})
+    }
 }

src/main/kotlin/world/player/item/banking/regularBank/openBank.kts

@@ -2,32 +2,28 @@ package world.player.item.banking.regularBank
 
 import api.predef.*
 import io.luna.game.event.impl.ServerStateChangedEvent.ServerLaunchEvent
-import io.luna.game.model.def.NpcDefinition
 import io.luna.game.model.mob.*
 
-val DEFAULT_BANKER = 494
-
-val bankerIds = mutableListOf<Int>()
-
 on(ServerLaunchEvent::class) {
-    // Find all banker npcs and store their ids
-    NpcDefinition.ALL
-        .filter { npcDefinition -> npcDefinition?.name?.contains("Banker", ignoreCase = true) ?: false }
-        .forEach({ npcDefinition -> bankerIds.add(npcDefinition.id)})
+    // Load all banking npcs and make them initialize dialogue
+    Banking.loadBankingNpcs()
+    for (id in Banking.bankingNpcs) {
+        npc1(id, {bankerDialogue(plr, id)})
+    }
 
     // Load all banking objects, make them open the bank.
     Banking.loadBankingObjects()
     for (id in Banking.bankingObjects) {
         object1(id) {
             val npc: Npc? = plr.localNpcs.firstOrNull { npc ->
                 npc.position.isWithinDistance(gameObject.position, 1)
-                && bankerIds.contains(npc.id)
+                && Banking.bankingNpcs.contains(npc.id)
             }
 
             if (npc != null) {
                 bankerDialogue(plr, npc.id)
             } else {
-                bankerDialogue(plr, DEFAULT_BANKER) // use default banker when no npc nearby
+                bankerDialogue(plr, Banking.DEFAULT_BANKER) // use default banker when no npc nearby
             }
         }
         if (objectDef(id).actions.contains("Use-quickly")) {

src/main/kotlin/world/player/skill/Skills.kt

@@ -0,0 +1,36 @@
+package world.player.skill
+
+import api.predef.*
+import kotlin.math.floor
+
+/**
+ * A utility class containing functions related to skills.
+ */
+object Skills {
+
+
+    /* https://github.com/luna-rs/luna/issues/422#issuecomment-2980912667 */
+
+    /**
+     * Calculates if an action is successful based on the [low] and [high] rates.
+     * [level] is the effective current level in the skill to check. This takes into account any
+     * bonuses.
+     * [maxLevel] is the maximum level in the skill. This is 99 for all skills in OSRS/317.
+     */
+    fun success(low: Int, high: Int, level: Int, maxLevel: Int = 99): Boolean {
+        val rate = successRate(low, high, level, maxLevel)
+        return rate > rand().nextDouble()
+    }
+
+    /**
+     * Calculates the success rate for an action from the [low] and [high] rates.
+     * [level] is the effective current level in the skill to check. This takes into account any
+     * bonuses.
+     * [maxLevel] is the maximum level in the skill. This is 99 for all skills in OSRS/317.
+     */
+    fun successRate(low: Int, high: Int, level: Int, maxLevel: Int = 99): Double {
+        val lowRate = (low * (maxLevel - level)) / (maxLevel - 1.0)
+        val highRate = (high * (level - 1)) / (maxLevel - 1.0)
+        return (1.0 + floor(lowRate + highRate + 0.5)) / 256.0
+    }
+}