refactor: create FriendsList and convert client to use it

Author: Jameskmonger

src/main/java/org/runejs/client/Game.java

@@ -4,6 +4,7 @@
 import org.runejs.client.cache.CacheArchive;
 import org.runejs.client.cache.CacheFileChannel;
 import org.runejs.client.cache.cs.ClientScript;
+import org.runejs.client.chat.FriendList;
 import org.runejs.client.chat.SocialList;
 import org.runejs.client.frame.*;
 import org.runejs.client.frame.console.Console;
@@ -75,6 +76,8 @@ public class Game {
      */
     public static final CutsceneCamera cutsceneCamera = new CutsceneCamera();
 
+    public static FriendList friendList;
+
     public static final SocialList ignoreList = new SocialList(100);
 
     public static int anInt784 = 0;
@@ -676,7 +679,11 @@ public static void setConfigToDefaults() {
             }
         }
         MovedStatics.interactiveObjectTemporaryNodeCache = new LinkedList();
-        Player.friendsCount = 0;
+
+        // friends list size depends on membership status
+        int friendsListSize = MovedStatics.anInt1049 == 1 ? 200 : 100;
+        Game.friendList = new FriendList(200, friendsListSize);
+
         Player.friendListStatus = 0;
         GameInterface.resetInterface(ChatBox.dialogueId);
         ChatBox.dialogueId = -1;

src/main/java/org/runejs/client/MovedStatics.java

@@ -2972,8 +2972,11 @@ else if(i < 101)
                 i--;
             else
                 i -= 101;
-            addActionRow(English.remove, 0, 0, 0, ActionRowType.REMOVE_FRIEND.getId(), Native.white + Player.friendUsernames[i]);
-            addActionRow(English.message, 0, 0, 0, ActionRowType.MESSAGE_FRIEND.getId(), Native.white + Player.friendUsernames[i]);
+
+            String username = Game.friendList.getPlayerUsername(i);
+
+            addActionRow(English.remove, 0, 0, 0, ActionRowType.REMOVE_FRIEND.getId(), Native.white + username);
+            addActionRow(English.message, 0, 0, 0, ActionRowType.MESSAGE_FRIEND.getId(), Native.white + username);
             return true;
         }
         if(i >= 401 && i <= 500) {

src/main/java/org/runejs/client/cache/media/gameInterface/GameInterface.java

@@ -335,7 +335,7 @@ public static void updateGameInterface(GameInterface gameInterface) {
                 gameInterface.actionType = 0;
                 gameInterface.disabledText = English.pleaseWait;
             } else {
-                int fCount = Player.friendsCount;
+                int fCount = Game.friendList.getCount();
                 if(type > 700)
                     type -= 601;
                 else
@@ -346,7 +346,7 @@ public static void updateGameInterface(GameInterface gameInterface) {
                     gameInterface.disabledText = "";
                     gameInterface.actionType = 0;
                 } else {
-                    gameInterface.disabledText = Player.friendUsernames[type];
+                    gameInterface.disabledText = Game.friendList.getPlayerUsername(type);
                     gameInterface.actionType = 1;
                 }
             }
@@ -355,30 +355,31 @@ public static void updateGameInterface(GameInterface gameInterface) {
                 type -= 101;
             else
                 type -= 701;
-            int count = Player.friendsCount;
+            int count = Game.friendList.getCount();
             if(Player.friendListStatus != 2)
                 count = 0;
             if(type >= count) {
                 gameInterface.disabledText = "";
                 gameInterface.actionType = 0;
             } else {
-                if(Player.friendWorlds[type] == 0) {
+                int world = Game.friendList.getPlayerWorld(type);
+                if(world == 0) {
                     gameInterface.disabledText = Native.red + English.offline;
-                } else if(Player.friendWorlds[type] < 5000) {
-                    if(Player.friendWorlds[type] == Player.worldId) {
-                        gameInterface.disabledText = Native.green + English.world + Player.friendWorlds[type];
+                } else if(world < 5000) {
+                    if(world == Player.worldId) {
+                        gameInterface.disabledText = Native.green + English.world + world;
                     } else {
-                        gameInterface.disabledText = Native.yellow + English.world + Player.friendWorlds[type];
+                        gameInterface.disabledText = Native.yellow + English.world + world;
                     }
-                } else if(Player.worldId == Player.friendWorlds[type]) {
-                    gameInterface.disabledText = Native.green + English.classic + (-5000 + Player.friendWorlds[type]);
+                } else if(Player.worldId == world) {
+                    gameInterface.disabledText = Native.green + English.classic + (-5000 + world);
                 } else {
-                    gameInterface.disabledText = Native.yellow + English.classic + (Player.friendWorlds[type] + -5000);
+                    gameInterface.disabledText = Native.yellow + English.classic + (world + -5000);
                 }
                 gameInterface.actionType = 1;
             }
         } else if(type == 203) {
-            int count = Player.friendsCount;
+            int count = Game.friendList.getCount();
             if(Player.friendListStatus != 2)
                 count = 0;
             gameInterface.scrollHeight = 20 + 15 * count;
@@ -949,21 +950,17 @@ public static void processMenuActions(int arg1) {
                     int i_18_ = class1.indexOf(Native.white);
                     if(i_18_ != -1) {
                         long l = TextUtils.nameToLong(class1.substring(i_18_ + 5).trim());
-                        int i_19_ = -1;
-                        for(int i_20_ = 0; i_20_ < Player.friendsCount; i_20_++) {
-                            if(Player.friends[i_20_] == l) {
-                                i_19_ = i_20_;
-                                break;
-                            }
-                        }
-                        if(i_19_ != -1 && Player.friendWorlds[i_19_] > 0) {
+
+                        int i_19_ = Game.friendList.getPlayerIndex(l);
+
+                        if(i_19_ != -1 && Game.friendList.getPlayerWorld(i_19_) > 0) {
                             anInt876 = 3;
                             ChatBox.redrawChatbox = true;
                             ChatBox.inputType = 0;
                             ChatBox.chatMessage = "";
                             ChatBox.messagePromptRaised = true;
-                            sendingMessageTo = Player.friends[i_19_];
-                            Native.enterPlayerNameHeader = English.prefixEnterMessageToSendTo + Player.friendUsernames[i_19_];
+                            sendingMessageTo = l;
+                            Native.enterPlayerNameHeader = English.prefixEnterMessageToSendTo + Game.friendList.getPlayerUsername(i_19_);
                         }
                     }
                 }
@@ -1855,21 +1852,12 @@ public static void runClientScriptsForInterface(int minY, int arg1, int scrollWi
 
     public static void removeFriend(long nameAsLong) {
         if (nameAsLong != 0) {
-            int i = 0;
-            for (/**/; Player.friendsCount > i; i++) {
-                if (Player.friends[i] == nameAsLong) {
-                    Player.friendsCount--;
-                    redrawTabArea = true;
-                    for (int i_13_ = i; i_13_ < Player.friendsCount; i_13_++) {
-                        Player.friendUsernames[i_13_] = Player.friendUsernames[1 + i_13_];
-                        Player.friendWorlds[i_13_] = Player.friendWorlds[i_13_ + 1];
-                        Player.friends[i_13_] = Player.friends[1 + i_13_];
-                    }
 
-                    OutgoingPackets.sendMessage(
-                        new ModifySocialListOutboundMessage(nameAsLong, ModifySocialListOutboundMessage.SocialList.FRIEND, ModifySocialListOutboundMessage.SocialListAction.REMOVE));
-                    break;
-                }
+            if (Game.friendList.removePlayer(nameAsLong) != -1) {
+                redrawTabArea = true;
+
+                OutgoingPackets.sendMessage(
+                    new ModifySocialListOutboundMessage(nameAsLong, ModifySocialListOutboundMessage.SocialList.FRIEND, ModifySocialListOutboundMessage.SocialListAction.REMOVE));
             }
         }
     }
@@ -1917,7 +1905,7 @@ public static void manageTextInputs() {
                         long l = MovedStatics.nameToLong(ChatBox.chatMessage);
                         addFriend(l);
                     }
-                    if(anInt876 == 2 && Player.friendsCount > 0) {
+                    if(anInt876 == 2 && !Game.friendList.isEmpty()) {
                         long l = MovedStatics.nameToLong(ChatBox.chatMessage);
                         removeFriend(l);
                     }
@@ -2096,25 +2084,21 @@ public static void manageTextInputs() {
 
     private static void addFriend(long name) {
         if(name != 0L) {
-            if(Player.friendsCount >= 100 && MovedStatics.anInt1049 != 1 || Player.friendsCount >= 200) {
+            if(Game.friendList.isFull()) {
                 ChatBox.addChatMessage("", English.friendsListIsFull, 0);
             } else {
                 String username = TextUtils.formatName(TextUtils.longToName(name));
-                for(int i = 0; Player.friendsCount > i; i++) {
-                    if(Player.friends[i] == name) {
-                        ChatBox.addChatMessage("", username + English.isAlreadyOnYourFriendList, 0);
-                        return;
-                    }
+                if(Game.friendList.containsPlayer(name)) {
+                    ChatBox.addChatMessage("", username + English.isAlreadyOnYourFriendList, 0);
+                    return;
                 }
                 if (Game.ignoreList.containsPlayer(name)) {
                     ChatBox.addChatMessage("", English.pleaseRemove + username + English.suffixFromYourIgnoreListFirst, 0);
                     return;
                 }
                 if(!username.equals(Player.localPlayer.playerName)) {
-                    Player.friendUsernames[Player.friendsCount] = username;
-                    Player.friends[Player.friendsCount] = name;
-                    Player.friendWorlds[Player.friendsCount] = 0;
-                    Player.friendsCount++;
+                    Game.friendList.addPlayer(name);
+
                     redrawTabArea = true;
 
                     OutgoingPackets.sendMessage(
@@ -2143,11 +2127,9 @@ private static void addIgnore(long arg1) {
                     ChatBox.addChatMessage("", class1 + English.suffixIsAlreadyOnYourIgnoreList, 0);
                     return;
                 }
-                for(int i = 0; Player.friendsCount > i; i++) {
-                    if(Player.friends[i] == arg1) {
-                        ChatBox.addChatMessage("", English.pleaseRemove + class1 + English.fromYourFriendListFirst, 0);
-                        return;
-                    }
+                if(Game.friendList.containsPlayer(arg1)) {
+                    ChatBox.addChatMessage("", English.pleaseRemove + class1 + English.fromYourFriendListFirst, 0);
+                    return;
                 }
                 if(!class1.equals(Player.localPlayer.playerName)) {
                     Game.ignoreList.addPlayer(arg1);

src/main/java/org/runejs/client/chat/FriendList.java

@@ -0,0 +1,154 @@
+package org.runejs.client.chat;
+
+import org.runejs.client.cache.media.gameInterface.GameInterface;
+import org.runejs.client.media.renderable.actor.Player;
+import org.runejs.client.util.TextUtils;
+
+/**
+ * A {@link SocialList} that contains a list of friends.
+ */
+public class FriendList extends SocialList {
+    /**
+     * The usernames of the players in this list.
+     */
+    private String[] playerUsernames;
+
+    /**
+     * The worlds of the players in this list.
+     */
+    private int[] playerWorlds;
+
+    /**
+     * The maximum amount of players that can be added to this list.
+     * 
+     * This is different from {@link #getSize()} because players can be added from
+     * the server, even if the list is "full" for the player to add more.
+     */
+    private int limit;
+
+    /**
+     * Creates a new friend list with the specified size.
+     *
+     * @param size The size of the list.
+     */
+    public FriendList(int size, int limit) {
+
+        super(size);
+        this.limit = limit;
+
+        this.playerUsernames = new String[size];
+        this.playerWorlds = new int[size];
+    }
+
+    @Override
+    public int removePlayer(long p) {
+        int index = super.removePlayer(p);
+
+        if (index == -1) {
+            return -1;
+        }
+
+        for (int i = index; i < this.count; i++) {
+            this.playerUsernames[i] = this.playerUsernames[i + 1];
+            this.playerWorlds[i] = this.playerWorlds[i + 1];
+        }
+
+        return index;
+    }
+
+    @Override
+    public void addPlayer(long p) {
+        super.addPlayer(p);
+
+        this.playerWorlds[this.count - 1] = 0;
+        this.playerUsernames[this.count - 1] = TextUtils.formatName(TextUtils.longToName(p));
+    }
+
+    @Override
+    public boolean isFull() {
+        return this.count >= this.limit;
+    }
+
+    /**
+     * Adds a player to this list.
+     * @param p The player to add.
+     * @param username The username of the player.
+     * @param world The world of the player.
+     */
+    public void addPlayer(long p, String username, int world) {
+        int newIndex = this.count;
+        this.players[newIndex] = p;
+        this.playerUsernames[newIndex] = username;
+        this.playerWorlds[newIndex] = world;
+        this.count++;
+    }
+
+    /**
+     * Gets the username of the player at the specified index.
+     * @param index The index of the player.
+     * @return The username of the player.
+     */
+    public String getPlayerUsername(int index) {
+        return this.playerUsernames[index];
+    }
+
+    /**
+     * Gets the world of the player at the specified index.
+     * @param index The index of the player.
+     * @return The world of the player.
+     */
+    public int getPlayerWorld(int index) {
+        return this.playerWorlds[index];
+    }
+
+    /**
+     * Checks if this list contains the specified player.
+     * @param username The username of the player.
+     * @return {@code true} if this list contains the player, otherwise {@code false}.
+     */
+    public boolean containsPlayerUsername(String username) {
+        for (int i = 0; i < this.count; i++) {
+            if (username.equalsIgnoreCase(this.playerUsernames[i]))
+                return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Set the world of the player at the specified index.
+     * @param index The index of the player.
+     * @param world The world of the player.
+     */
+    public void setPlayerWorld(int index, int world) {
+        this.playerWorlds[index] = world;
+    }
+    
+    /**
+     * Sorts the list:
+     * - putting players in the same world as the player at the top,
+     * - then other online players,
+     * - then offline players.
+     */
+    public void sort() {
+        boolean bool = false;
+        while(!bool) {
+            bool = true;
+            for(int i = 0; this.count - 1 > i; i++) {
+                if(Player.worldId != this.playerWorlds[i] && this.playerWorlds[1 + i] == Player.worldId || this.playerWorlds[i] == 0 && this.playerWorlds[i + 1] != 0) {
+                    bool = false;
+                    int world = this.playerWorlds[i];
+                    this.playerWorlds[i] = this.playerWorlds[i + 1];
+                    this.playerWorlds[1 + i] = world;
+                    String name = this.playerUsernames[i];
+                    this.playerUsernames[i] = this.playerUsernames[1 + i];
+                    this.playerUsernames[1 + i] = name;
+                    long hash = this.players[i];
+                    this.players[i] = this.players[i + 1];
+                    this.players[1 + i] = hash;
+                    GameInterface.redrawTabArea = true;
+                }
+            }
+        }
+    }
+}

src/main/java/org/runejs/client/chat/SocialList.java

@@ -7,12 +7,12 @@ public class SocialList {
     /**
      * The players in this list.
      */
-    private long[] players;
+    protected long[] players;
 
     /**
      * The amount of players currently in this list.
      */
-    private int count = 0;
+    protected int count = 0;
 
     /**
      * Creates a new social list with the specified size.
@@ -89,7 +89,7 @@ public int removePlayer(long p) {
      * @param p The player to get the index of.
      * @return The index of the specified player, or {@code -1} if the player was not in this list.
      */
-    private int getPlayerIndex(long p) {
+    public int getPlayerIndex(long p) {
         for (int i = 0; i < this.count; i++) {
             if (this.players[i] == p) {
                 return i;