Rename clan chat to friends chat

This commit is contained in:
Adam
2020-06-15 14:39:01 -04:00
parent 1f9bcfc9a7
commit 84611f0db8
56 changed files with 511 additions and 511 deletions

View File

@@ -69,11 +69,11 @@ public enum ChatMessageType
*/
MODPRIVATECHAT(7),
/**
* A message received in clan chat.
* A message received in friends chat.
*/
FRIENDSCHAT(9),
/**
* A message received with information about the current clan chat.
* A message received with information about the current friends chat.
*/
FRIENDSCHATNOTIFICATION(11),
/**
@@ -133,7 +133,7 @@ public enum ChatMessageType
*/
CHALREQ_TRADE(103),
/**
* A message received when someone sends a clan challenge offer.
* A message received when someone sends a friends chat challenge offer.
*/
CHALREQ_FRIENDSCHAT(104),
/**

View File

@@ -1152,12 +1152,12 @@ public interface Client extends GameEngine
boolean isFriended(String name, boolean mustBeLoggedIn);
/**
* Retrieve the clan member manager
* Retrieve the friends chat manager
*
* @return
*/
@Nullable
ClanMemberManager getClanMemberManager();
FriendsChatManager getFriendsChatManager();
/**
* Retrieve the nameable container containing friends
@@ -1466,11 +1466,11 @@ public interface Client extends GameEngine
void setFriendsHidden(boolean state);
/**
* Sets whether or not clan mates are hidden.
* Sets whether or not friends chat members are hidden.
*
* @param state the new clan mates hidden state
* @param state the new friends chat member hidden state
*/
void setClanMatesHidden(boolean state);
void setFriendsChatMembersHidden(boolean state);
/**
* Sets whether the local player is hidden.

View File

@@ -24,19 +24,19 @@
*/
package net.runelite.api;
public interface ClanMemberManager extends NameableContainer<ClanMember>
public interface FriendsChatManager extends NameableContainer<FriendsChatMember>
{
/**
* Gets the clan owner of the currently joined clan chat
* Gets the owner of the currently joined friends chat
*
* @return
*/
String getClanOwner();
String getOwner();
/**
* Gets the clan chat name of the currently joined clan chat
* Gets the name of the currently joined friends chat
*
* @return
*/
String getClanChatName();
String getName();
}

View File

@@ -25,9 +25,9 @@
package net.runelite.api;
/**
* Represents a clan member.
* Represents a friends chat member.
*/
public interface ClanMember extends ChatPlayer
public interface FriendsChatMember extends ChatPlayer
{
/**
* Gets the world the member is in.
@@ -37,9 +37,9 @@ public interface ClanMember extends ChatPlayer
int getWorld();
/**
* Gets the rank of the clan member.
* Gets the rank of the friends chat member.
*
* @return the rank
*/
ClanMemberRank getRank();
FriendsChatRank getRank();
}

View File

@@ -30,14 +30,14 @@ import lombok.AllArgsConstructor;
import lombok.Getter;
/**
* An enumeration of ranks of clan members.
* An enumeration of ranks of friends chat members.
*/
@AllArgsConstructor
@Getter
public enum ClanMemberRank
public enum FriendsChatRank
{
/**
* Not in a clan.
* Not ranked.
*/
UNRANKED(-1),
/**
@@ -77,30 +77,30 @@ public enum ClanMemberRank
*/
JMOD(127);
private static final Map<Integer, ClanMemberRank> RANKS = new HashMap<>();
private static final Map<Integer, FriendsChatRank> RANKS = new HashMap<>();
static
{
for (final ClanMemberRank clanMemberRank : ClanMemberRank.values())
for (final FriendsChatRank friendsChatRank : FriendsChatRank.values())
{
RANKS.put(clanMemberRank.value, clanMemberRank);
RANKS.put(friendsChatRank.value, friendsChatRank);
}
}
/**
* Utility method that maps the rank value to its respective
* {@link ClanMemberRank} value.
* {@link FriendsChatRank} value.
*
* @param rank the rank value
* @return rank type
*/
public static ClanMemberRank valueOf(int rank)
public static FriendsChatRank valueOf(int rank)
{
return RANKS.get(rank);
}
/**
* The value of the clan rank.
* The value of the rank.
*/
private final int value;
}

View File

@@ -58,7 +58,7 @@ public interface MessageNode extends Node
void setName(String name);
/**
* Gets the sender of the message (ie. clan name).
* Gets the sender of the message (ie. friends chat name).
*
* @return the message sender
*/

View File

@@ -57,12 +57,12 @@ public interface Player extends Actor
int getTeam();
/**
* Checks whether this player is a member of the same clan as
* Checks whether this player is a member of the same friends chat
* the local player.
*
* @return true if the player is a clan member, false otherwise
* @return true if the player is a friends chat member, false otherwise
*/
boolean isClanMember();
boolean isFriendsChatMember();
/**
* Checks whether this player is a friend of the local player.

View File

@@ -196,13 +196,13 @@ public final class ScriptID
public static final int XPDROP_DISABLED = 2091;
/**
* Attempts to kick the specified player from the Clan Chat
* Attempts to kick the specified player from the friends chat
* <ul>
* <li>String Players in-game name</li>
* </ul>
*/
@ScriptArguments(string = 1)
public static final int CLAN_SEND_KICK = 215;
public static final int FRIENDS_CHAT_SEND_KICK = 215;
/**
* Builds the items kept on death widget
@@ -211,10 +211,10 @@ public final class ScriptID
public static final int DEATH_KEEP_BUILD = 1601;
/**
* Builds the widget that holds all of the players inside a clan chat
* Builds the widget that holds all of the players inside a friends chat
*/
@ScriptArguments(integer = 15)
public static final int CLAN_CHAT_CHANNEL_BUILD = 1658;
public static final int FRIENDS_CHAT_CHANNEL_REBUILD = 1658;
/**
* Builds the widget for making an offer in Grand Exchange

View File

@@ -776,7 +776,7 @@ public final class SpriteID
public static final int RS2_TAB_EQUIPMENT = 778;
public static final int RS2_TAB_PRAYER = 779;
public static final int TAB_MAGIC = 780;
public static final int RS2_TAB_CLAN_CHAT = 781;
public static final int RS2_TAB_FRIENDS_CHAT = 781;
public static final int TAB_FRIENDS = 782;
public static final int TAB_IGNORES = 783;
public static final int RS2_TAB_LOGOUT = 784;
@@ -888,7 +888,7 @@ public final class SpriteID
public static final int TAB_EQUIPMENT = 901;
public static final int TAB_PRAYER = 902;
public static final int UNUSED_TAB_MAGIC_903 = 903;
public static final int TAB_CLAN_CHAT = 904;
public static final int TAB_FRIENDS_CHAT = 904;
public static final int TAB_LOGOUT = 907;
public static final int TAB_OPTIONS = 908;
public static final int TAB_EMOTES = 909;
@@ -977,15 +977,15 @@ public final class SpriteID
public static final int STASH_UNITS_SLANTED_TAB_EDGE_LEFT_HOVERED = 1001;
public static final int STASH_UNITS_SLANTED_TAB_MIDDLE_HOVERED = 1002;
public static final int STASH_UNITS_SLANTED_TAB_EDGE_RIGHT_HOVERED = 1003;
public static final int CLAN_CHAT_RANK_SMILEY_FRIEND = 1004;
public static final int CLAN_CHAT_RANK_CROWN_JAGEX_MODERATOR = 1005;
public static final int CLAN_CHAT_RANK_KEY_CHANNEL_OWNER = 1006;
public static final int CLAN_CHAT_RANK_GOLD_STAR_GENERAL = 1007;
public static final int CLAN_CHAT_RANK_SILVER_STAR_CAPTAIN = 1008;
public static final int CLAN_CHAT_RANK_BRONZE_STAR_LIEUTENANT = 1009;
public static final int CLAN_CHAT_RANK_TRIPLE_CHEVRON_SERGEANT = 1010;
public static final int CLAN_CHAT_RANK_DOUBLE_CHEVRON_CORPORAL = 1011;
public static final int CLAN_CHAT_RANK_SINGLE_CHEVRON_RECRUIT = 1012;
public static final int FRIENDS_CHAT_RANK_SMILEY_FRIEND = 1004;
public static final int FRIENDS_CHAT_RANK_CROWN_JAGEX_MODERATOR = 1005;
public static final int FRIENDS_CHAT_RANK_KEY_CHANNEL_OWNER = 1006;
public static final int FRIENDS_CHAT_RANK_GOLD_STAR_GENERAL = 1007;
public static final int FRIENDS_CHAT_RANK_SILVER_STAR_CAPTAIN = 1008;
public static final int FRIENDS_CHAT_RANK_BRONZE_STAR_LIEUTENANT = 1009;
public static final int FRIENDS_CHAT_RANK_TRIPLE_CHEVRON_SERGEANT = 1010;
public static final int FRIENDS_CHAT_RANK_DOUBLE_CHEVRON_CORPORAL = 1011;
public static final int FRIENDS_CHAT_RANK_SINGLE_CHEVRON_RECRUIT = 1012;
public static final int UNKNOWN_BUTTON_METAL_CORNERS = 1013;
public static final int UNKNOWN_BUTTON_METAL_CORNERS_HOVERED = 1014;
public static final int UNKNOWN_SLANTED_TAB_LONG = 1015;
@@ -1017,7 +1017,7 @@ public final class SpriteID
public static final int BANK_DEPOSIT_INVENTORY = 1041;
public static final int BANK_DEPOSIT_EQUIPMENT = 1042;
public static final int BANK_SEARCH = 1043;
public static final int MINIMAP_MARKER_PURPLE_PLAYER_CLAN_CHAT = 1044;
public static final int MINIMAP_MARKER_PURPLE_PLAYER_FRIENDS_CHAT = 1044;
public static final int OPTIONS_PROFANITY_FILTER = 1045;
public static final int PLAYER_KILLER_SKULL_1046 = 1046;
public static final int PLAYER_KILLING_DISABLED_OVERLAY = 1047;

View File

@@ -41,7 +41,7 @@ public enum VarClientStr
CHATBOX_TYPED_TEXT(335),
INPUT_TEXT(359),
PRIVATE_MESSAGE_TARGET(360),
RECENT_CLAN_CHAT(362);
RECENT_FRIENDS_CHAT(362);
private final int index;
}

View File

@@ -57,11 +57,11 @@ public enum VarPlayer
/**
* The ID of the party. This Var is only set in the raid bank area and the raid lobby
*
* This gets set to -1 when the raid starts. This is first set when the first player of the clan forms a party
* This gets set to -1 when the raid starts. This is first set when the first player of the friends chat forms a party
* on the recruiting board and it changes again when the first person actually enters the raid.
*
* -1 : Not in a party or in the middle of an ongoing raid
* Anything else : This means that your clan has a raid party being formed and has not started yet
* Anything else : This means that your friends chat has a raid party being formed and has not started yet
*/
IN_RAID_PARTY(1427),

View File

@@ -62,8 +62,8 @@ public class ChatMessage
/**
* The sender of the message.
* <p>
* This field is only used for clan messages and refers to the
* current name of the clan chat the client is in.
* This field is only used for friends chat messages and refers to the
* current name of the friends chat the client is in.
*/
private String sender;
/**

View File

@@ -27,13 +27,13 @@ package net.runelite.api.events;
import lombok.Value;
/**
* An event where the client has joined or left a clan chat.
* An event where the client has joined or left a friends chat.
*/
@Value
public class ClanChanged
public class FriendsChatChanged
{
/**
* Whether or not the client is now in a clan chat.
* Whether or not the client is now in a friends chat.
*/
private boolean joined;
}

View File

@@ -25,13 +25,13 @@
package net.runelite.api.events;
import lombok.Value;
import net.runelite.api.ClanMember;
import net.runelite.api.FriendsChatMember;
@Value
public class ClanMemberJoined
public class FriendsChatMemberJoined
{
/**
* The ClanMember that joined
* The member that joined
*/
private ClanMember member;
private FriendsChatMember member;
}

View File

@@ -25,13 +25,13 @@
package net.runelite.api.events;
import lombok.Value;
import net.runelite.api.ClanMember;
import net.runelite.api.FriendsChatMember;
@Value
public class ClanMemberLeft
public class FriendsChatMemberLeft
{
/**
* The ClanMember that left
* The member that left
*/
private ClanMember member;
private FriendsChatMember member;
}

View File

@@ -57,7 +57,7 @@ public class WidgetID
public static final int ACHIEVEMENT_DIARY_GROUP_ID = 259;
public static final int PEST_CONTROL_BOAT_GROUP_ID = 407;
public static final int PEST_CONTROL_GROUP_ID = 408;
public static final int CLAN_CHAT_GROUP_ID = 7;
public static final int FRIENDS_CHAT_GROUP_ID = 7;
public static final int MINIMAP_GROUP_ID = 160;
public static final int LOGIN_CLICK_TO_PLAY_GROUP_ID = 378;
public static final int CLUE_SCROLL_GROUP_ID = 203;
@@ -239,7 +239,7 @@ public class WidgetID
static final int PREVIOUS_NAME_HOLDER = 16;
}
static class ClanChat
static class FriendsChat
{
static final int TITLE = 1;
static final int NAME = 4;
@@ -361,14 +361,14 @@ public class WidgetID
{
static final int MINIMAP = 3;
static final int MINIMAP_DRAW_AREA = 8;
static final int CLAN_CHAT_TAB = 33;
static final int FRIENDS_CHAT_TAB = 33;
static final int FRIENDS_TAB = 35;
static final int IGNORES_TAB = 34;
static final int LOGOUT_TAB = 36;
static final int OPTIONS_TAB = 37;
static final int EMOTES_TAB = 38;
static final int MUSIC_TAB = 39;
static final int CLAN_CHAT_ICON = 40;
static final int FRIENDS_CHAT_ICON = 40;
static final int FRIENDS_ICON = 42;
static final int IGNORES_ICON = 41;
static final int LOGOUT_ICON = 43;
@@ -397,14 +397,14 @@ public class WidgetID
static class ResizableViewport
{
static final int CLAN_CHAT_TAB = 37;
static final int FRIENDS_CHAT_TAB = 37;
static final int FRIENDS_TAB = 39;
static final int IGNORES_TAB = 38;
static final int LOGOUT_TAB = 40;
static final int OPTIONS_TAB = 41;
static final int EMOTES_TAB = 42;
static final int MUSIC_TAB = 43;
static final int CLAN_CHAT_ICON = 44;
static final int FRIENDS_CHAT_ICON = 44;
static final int FRIENDS_ICON = 46;
static final int IGNORES_ICON = 45;
static final int LOGOUT_ICON = 47;

View File

@@ -46,7 +46,7 @@ public enum WidgetInfo
INVENTORY(WidgetID.INVENTORY_GROUP_ID, 0),
FRIENDS_LIST(WidgetID.FRIENDS_LIST_GROUP_ID, 0),
IGNORE_LIST(WidgetID.IGNORE_LIST_GROUP_ID, 0),
CLAN_CHAT(WidgetID.CLAN_CHAT_GROUP_ID, 0),
FRIENDS_CHAT(WidgetID.FRIENDS_CHAT_GROUP_ID, 0),
RAIDING_PARTY(WidgetID.RAIDING_PARTY_GROUP_ID, 0),
WORLD_MAP_VIEW(WidgetID.WORLD_MAP_GROUP_ID, WidgetID.WorldMap.MAPVIEW),
@@ -125,10 +125,10 @@ public enum WidgetInfo
EXPLORERS_RING_ALCH_INVENTORY(WidgetID.EXPLORERS_RING_ALCH_GROUP_ID, WidgetID.ExplorersRing.INVENTORY),
CLAN_CHAT_TITLE(WidgetID.CLAN_CHAT_GROUP_ID, WidgetID.ClanChat.TITLE),
CLAN_CHAT_NAME(WidgetID.CLAN_CHAT_GROUP_ID, WidgetID.ClanChat.NAME),
CLAN_CHAT_OWNER(WidgetID.CLAN_CHAT_GROUP_ID, WidgetID.ClanChat.OWNER),
CLAN_CHAT_LIST(WidgetID.CLAN_CHAT_GROUP_ID, WidgetID.ClanChat.LIST),
FRIENDS_CHAT_TITLE(WidgetID.FRIENDS_CHAT_GROUP_ID, WidgetID.FriendsChat.TITLE),
FRIENDS_CHAT_NAME(WidgetID.FRIENDS_CHAT_GROUP_ID, WidgetID.FriendsChat.NAME),
FRIENDS_CHAT_OWNER(WidgetID.FRIENDS_CHAT_GROUP_ID, WidgetID.FriendsChat.OWNER),
FRIENDS_CHAT_LIST(WidgetID.FRIENDS_CHAT_GROUP_ID, WidgetID.FriendsChat.LIST),
BANK_CONTAINER(WidgetID.BANK_GROUP_ID, WidgetID.Bank.BANK_CONTAINER),
BANK_SEARCH_BUTTON_BACKGROUND(WidgetID.BANK_GROUP_ID, WidgetID.Bank.SEARCH_BUTTON_BACKGROUND),
@@ -198,7 +198,7 @@ public enum WidgetInfo
FIXED_VIEWPORT_EQUIPMENT_TAB(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.EQUIPMENT_TAB),
FIXED_VIEWPORT_PRAYER_TAB(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.PRAYER_TAB),
FIXED_VIEWPORT_MAGIC_TAB(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.MAGIC_TAB),
FIXED_VIEWPORT_CLAN_CHAT_TAB(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.CLAN_CHAT_TAB),
FIXED_VIEWPORT_FRIENDS_CHAT_TAB(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.FRIENDS_CHAT_TAB),
FIXED_VIEWPORT_FRIENDS_TAB(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.FRIENDS_TAB),
FIXED_VIEWPORT_IGNORES_TAB(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.IGNORES_TAB),
FIXED_VIEWPORT_LOGOUT_TAB(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.LOGOUT_TAB),
@@ -212,7 +212,7 @@ public enum WidgetInfo
FIXED_VIEWPORT_EQUIPMENT_ICON(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.EQUIPMENT_ICON),
FIXED_VIEWPORT_PRAYER_ICON(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.PRAYER_ICON),
FIXED_VIEWPORT_MAGIC_ICON(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.MAGIC_ICON),
FIXED_VIEWPORT_CLAN_CHAT_ICON(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.CLAN_CHAT_ICON),
FIXED_VIEWPORT_FRIENDS_CHAT_ICON(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.FRIENDS_CHAT_ICON),
FIXED_VIEWPORT_FRIENDS_ICON(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.FRIENDS_ICON),
FIXED_VIEWPORT_IGNORES_ICON(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.IGNORES_ICON),
FIXED_VIEWPORT_LOGOUT_ICON(WidgetID.FIXED_VIEWPORT_GROUP_ID, WidgetID.FixedViewport.LOGOUT_ICON),
@@ -243,7 +243,7 @@ public enum WidgetInfo
RESIZABLE_VIEWPORT_EQUIPMENT_TAB(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.EQUIPMENT_TAB),
RESIZABLE_VIEWPORT_PRAYER_TAB(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.PRAYER_TAB),
RESIZABLE_VIEWPORT_MAGIC_TAB(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.MAGIC_TAB),
RESIZABLE_VIEWPORT_CLAN_CHAT_TAB(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.CLAN_CHAT_TAB),
RESIZABLE_VIEWPORT_FRIENDS_CHAT_TAB(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.FRIENDS_CHAT_TAB),
RESIZABLE_VIEWPORT_FRIENDS_TAB(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.FRIENDS_TAB),
RESIZABLE_VIEWPORT_IGNORES_TAB(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.IGNORES_TAB),
RESIZABLE_VIEWPORT_LOGOUT_TAB(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.LOGOUT_TAB),
@@ -257,7 +257,7 @@ public enum WidgetInfo
RESIZABLE_VIEWPORT_EQUIPMENT_ICON(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.EQUIPMENT_ICON),
RESIZABLE_VIEWPORT_PRAYER_ICON(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.PRAYER_ICON),
RESIZABLE_VIEWPORT_MAGIC_ICON(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.MAGIC_ICON),
RESIZABLE_VIEWPORT_CLAN_CHAT_ICON(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.CLAN_CHAT_ICON),
RESIZABLE_VIEWPORT_FRIENDS_CHAT_ICON(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.FRIENDS_CHAT_ICON),
RESIZABLE_VIEWPORT_FRIENDS_ICON(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.FRIENDS_ICON),
RESIZABLE_VIEWPORT_IGNORES_ICON(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.IGNORES_ICON),
RESIZABLE_VIEWPORT_LOGOUT_ICON(WidgetID.RESIZABLE_VIEWPORT_OLD_SCHOOL_BOX_GROUP_ID, WidgetID.ResizableViewport.LOGOUT_ICON),