Collaboration diagram for com.runehive.content.clanchannel.channel.ClanManagement:

Public Member Functions
boolean	equals (Object obj)
void	setEnterRank (ClanRank rank)
	Sets the enter rank.
void	setManageRank (ClanRank rank)
	Sets the management rank.
void	setTalkRank (ClanRank rank)
	Sets the talk rank.
void	showBanned (Player player)
void	toggleLootshare ()

Public Attributes
boolean	locked
	The locked state of the clan.
String	name
	The clan display name.
String	password = ""
	The clan password.

Package Functions
boolean	canEnter (ClanMember member)
boolean	canManage (ClanMember member)
boolean	canTalk (ClanMember member)
	ClanManagement (ClanChannel channel)
String	getEnter ()
String	getManage ()
String	getRank (int index)
String	getTalk ()
void	loadRanks (JsonObject object)
void	saveRanks (JsonObject object)

Package Attributes
String	color = "<col=ffffff>"
String	forum = ""
	The clan forum link.
boolean	lootshare
	The lootshare state of the clan.
String	slogan = ""
	The clan slogan.
String	tag = ""
	The clan tag.

Static Package Attributes
static final int	ENTER_RANK_INDEX = 0
	Clan rank indices.
static final int	MANAGE_RANK_INDEX = 2
static final int	TALK_RANK_INDEX = 1

Private Attributes
final ClanChannel	channel
	The channel to manage.
ClanRank[]	ranks = new ClanRank[SIZE]
	An array of ranks.

Static Private Attributes
static final int	SIZE = 4
	The amount of privilage options.

Detailed Description

Definition at line 16 of file ClanManagement.java.

Constructor & Destructor Documentation

◆ ClanManagement()

com.runehive.content.clanchannel.channel.ClanManagement.ClanManagement ( ClanChannel channel )

package

Definition at line 56 of file ClanManagement.java.

                                        {
        this.channel = channel;
        ranks[ENTER_RANK_INDEX] = ClanRank.MEMBER;
        ranks[TALK_RANK_INDEX] = ClanRank.MEMBER;
        ranks[MANAGE_RANK_INDEX] = ClanRank.LEADER;
    }

References channel, ENTER_RANK_INDEX, com.runehive.content.clanchannel.ClanRank.LEADER, MANAGE_RANK_INDEX, com.runehive.content.clanchannel.ClanRank.MEMBER, ranks, and TALK_RANK_INDEX.

Referenced by equals().

Here is the caller graph for this function:

Member Function Documentation

◆ canEnter()

boolean com.runehive.content.clanchannel.channel.ClanManagement.canEnter ( ClanMember member )

package

Definition at line 96 of file ClanManagement.java.

                                        {
        return member.rank.greaterThanEqual(ranks[ENTER_RANK_INDEX]);
    }

References ENTER_RANK_INDEX, com.runehive.content.clanchannel.ClanRank.greaterThanEqual(), com.runehive.content.clanchannel.ClanMember.rank, and ranks.

Here is the call graph for this function:

◆ canManage()

boolean com.runehive.content.clanchannel.channel.ClanManagement.canManage ( ClanMember member )

package

Definition at line 104 of file ClanManagement.java.

                                         {
        return member.rank.greaterThanEqual(ranks[MANAGE_RANK_INDEX]);
    }

References com.runehive.content.clanchannel.ClanRank.greaterThanEqual(), MANAGE_RANK_INDEX, com.runehive.content.clanchannel.ClanMember.rank, and ranks.

Here is the call graph for this function:

◆ canTalk()

boolean com.runehive.content.clanchannel.channel.ClanManagement.canTalk ( ClanMember member )

package

Definition at line 100 of file ClanManagement.java.

                                       {
        return member.rank.greaterThanEqual(ranks[TALK_RANK_INDEX]);
    }

References com.runehive.content.clanchannel.ClanRank.greaterThanEqual(), com.runehive.content.clanchannel.ClanMember.rank, ranks, and TALK_RANK_INDEX.

Here is the call graph for this function:

◆ equals()

boolean com.runehive.content.clanchannel.channel.ClanManagement.equals ( Object obj )

Definition at line 144 of file ClanManagement.java.

                                      {
        if (obj == this) return true;
        if (obj instanceof ClanManagement) {
            ClanManagement other = (ClanManagement) obj;
            return Objects.equals(name, other.name)
                && Objects.equals(slogan, other.slogan)
                && Objects.equals(forum, other.forum)
                && Objects.equals(tag, other.tag)
                && Objects.equals(locked, other.locked)
                && Objects.equals(lootshare, other.lootshare)
                && Arrays.equals(ranks, other.ranks);
        }
        return false;
    }

References ClanManagement(), forum, locked, lootshare, name, ranks, slogan, and tag.

Here is the call graph for this function:

◆ getEnter()

String com.runehive.content.clanchannel.channel.ClanManagement.getEnter ( )

package

Definition at line 84 of file ClanManagement.java.

                      {
        return ranks[ENTER_RANK_INDEX].getName();
    }

References ENTER_RANK_INDEX, and ranks.

◆ getManage()

String com.runehive.content.clanchannel.channel.ClanManagement.getManage ( )

package

Definition at line 92 of file ClanManagement.java.

                       {
        return ranks[MANAGE_RANK_INDEX].getName();
    }

References MANAGE_RANK_INDEX, and ranks.

◆ getRank()

String com.runehive.content.clanchannel.channel.ClanManagement.getRank ( int index )

package

Definition at line 80 of file ClanManagement.java.

                              {
        return ranks[index].getString();
    }

References ranks.

◆ getTalk()

String com.runehive.content.clanchannel.channel.ClanManagement.getTalk ( )

package

Definition at line 88 of file ClanManagement.java.

                     {
        return ranks[TALK_RANK_INDEX].getName();
    }

References ranks, and TALK_RANK_INDEX.

◆ loadRanks()

void com.runehive.content.clanchannel.channel.ClanManagement.loadRanks ( JsonObject object )

package

Definition at line 108 of file ClanManagement.java.

                                      {
        ranks[ENTER_RANK_INDEX] = ClanRank.valueOf(object.get("enter-rank").getAsString());
        ranks[TALK_RANK_INDEX] = ClanRank.valueOf(object.get("talk-rank").getAsString());
        ranks[MANAGE_RANK_INDEX] = ClanRank.valueOf(object.get("manage-rank").getAsString());
    }

References ENTER_RANK_INDEX, MANAGE_RANK_INDEX, ranks, and TALK_RANK_INDEX.

◆ saveRanks()

void com.runehive.content.clanchannel.channel.ClanManagement.saveRanks ( JsonObject object )

package

Definition at line 114 of file ClanManagement.java.

                                      {
        object.addProperty("enter-rank", ranks[ENTER_RANK_INDEX].name());
        object.addProperty("talk-rank", ranks[TALK_RANK_INDEX].name());
        object.addProperty("manage-rank", ranks[MANAGE_RANK_INDEX].name());
    }

References ENTER_RANK_INDEX, MANAGE_RANK_INDEX, name, ranks, and TALK_RANK_INDEX.

◆ setEnterRank()

void com.runehive.content.clanchannel.channel.ClanManagement.setEnterRank ( ClanRank rank )

Sets the enter rank.

Definition at line 64 of file ClanManagement.java.

                                            {
        ranks[ENTER_RANK_INDEX] = rank;
        channel.message("The required rank to enter has changed to " + rank.getName() + ".");
    }

References channel, ENTER_RANK_INDEX, com.runehive.content.clanchannel.ClanRank.getName(), and ranks.

Here is the call graph for this function:

◆ setManageRank()

void com.runehive.content.clanchannel.channel.ClanManagement.setManageRank ( ClanRank rank )

Sets the management rank.

Definition at line 76 of file ClanManagement.java.

                                             {
        ranks[MANAGE_RANK_INDEX] = rank;
    }

References MANAGE_RANK_INDEX, and ranks.

◆ setTalkRank()

void com.runehive.content.clanchannel.channel.ClanManagement.setTalkRank ( ClanRank rank )

Sets the talk rank.

Definition at line 70 of file ClanManagement.java.

                                           {
        ranks[TALK_RANK_INDEX] = rank;
        channel.message("The required rank to talk has changed to " + rank.getName() + ".");
    }

References channel, com.runehive.content.clanchannel.ClanRank.getName(), ranks, and TALK_RANK_INDEX.

Here is the call graph for this function:

◆ showBanned()

void com.runehive.content.clanchannel.channel.ClanManagement.showBanned ( Player player )

Definition at line 120 of file ClanManagement.java.

                                          {
        if (channel.bannedMembers.isEmpty()) {
            player.send(new SendMessage("You have no banned members in your clan."));
            return;
        }
        int string = 51311;
        int size = channel.bannedMembers.size() < 10 ? 10 : channel.bannedMembers.size();
        for (int index = 0; index < size; index++) {
            boolean valid = index < channel.bannedMembers.size();
            Optional<String> banned = valid ? Optional.of(channel.bannedMembers.get(index)) : Optional.empty();
            player.send(new SendString(banned.orElse(""), string));
            player.send(new SendTooltip(valid ? "Unban " + channel.bannedMembers.get(index) : "", string));
            string++;
        }
        player.send(new SendScrollbar(51310, size * 23));
        player.interfaceManager.open(51300);
    }

References channel, com.runehive.game.world.entity.mob.player.Player.interfaceManager, com.runehive.game.world.entity.mob.player.InterfaceManager.open(), and com.runehive.game.world.entity.mob.player.Player.send().

Here is the call graph for this function:

◆ toggleLootshare()

void com.runehive.content.clanchannel.channel.ClanManagement.toggleLootshare ( )

Definition at line 138 of file ClanManagement.java.

                                  {
        lootshare = !lootshare;
        channel.message("Lootshare has been toggled " + (lootshare ? "on!" : "off!"));
    }

References channel, and lootshare.

Member Data Documentation

◆ channel

final ClanChannel com.runehive.content.clanchannel.channel.ClanManagement.channel

private

The channel to manage.

Definition at line 54 of file ClanManagement.java.

Referenced by ClanManagement(), setEnterRank(), setTalkRank(), showBanned(), and toggleLootshare().

◆ color

String com.runehive.content.clanchannel.channel.ClanManagement.color = "<col=ffffff>"

package

Definition at line 45 of file ClanManagement.java.

◆ ENTER_RANK_INDEX

final int com.runehive.content.clanchannel.channel.ClanManagement.ENTER_RANK_INDEX = 0

staticpackage

Clan rank indices.

Definition at line 20 of file ClanManagement.java.

Referenced by canEnter(), ClanManagement(), getEnter(), loadRanks(), saveRanks(), and setEnterRank().

◆ forum

String com.runehive.content.clanchannel.channel.ClanManagement.forum = ""

package

The clan forum link.

Definition at line 40 of file ClanManagement.java.

Referenced by equals().

◆ locked

boolean com.runehive.content.clanchannel.channel.ClanManagement.locked

The locked state of the clan.

Definition at line 48 of file ClanManagement.java.

Referenced by equals().

◆ lootshare

boolean com.runehive.content.clanchannel.channel.ClanManagement.lootshare

package

The lootshare state of the clan.

Definition at line 51 of file ClanManagement.java.

Referenced by equals(), and toggleLootshare().

◆ MANAGE_RANK_INDEX

final int com.runehive.content.clanchannel.channel.ClanManagement.MANAGE_RANK_INDEX = 2

staticpackage

Definition at line 22 of file ClanManagement.java.

Referenced by canManage(), ClanManagement(), getManage(), loadRanks(), saveRanks(), and setManageRank().

◆ name

String com.runehive.content.clanchannel.channel.ClanManagement.name

The clan display name.

Definition at line 31 of file ClanManagement.java.

Referenced by com.runehive.content.clanchannel.channel.ClanChannel.compareTo(), equals(), and saveRanks().

◆ password

String com.runehive.content.clanchannel.channel.ClanManagement.password = ""

The clan password.

Definition at line 34 of file ClanManagement.java.

◆ ranks

ClanRank [] com.runehive.content.clanchannel.channel.ClanManagement.ranks = new ClanRank[SIZE]

private

An array of ranks.

Definition at line 28 of file ClanManagement.java.

Referenced by canEnter(), canManage(), canTalk(), ClanManagement(), equals(), getEnter(), getManage(), getRank(), getTalk(), loadRanks(), saveRanks(), setEnterRank(), setManageRank(), and setTalkRank().

◆ SIZE

final int com.runehive.content.clanchannel.channel.ClanManagement.SIZE = 4

staticprivate

The amount of privilage options.

Definition at line 25 of file ClanManagement.java.

◆ slogan

String com.runehive.content.clanchannel.channel.ClanManagement.slogan = ""

package

The clan slogan.

Definition at line 37 of file ClanManagement.java.

Referenced by equals().

◆ tag

String com.runehive.content.clanchannel.channel.ClanManagement.tag = ""

package

The clan tag.

Definition at line 43 of file ClanManagement.java.

Referenced by equals().

◆ TALK_RANK_INDEX

final int com.runehive.content.clanchannel.channel.ClanManagement.TALK_RANK_INDEX = 1

staticpackage

Definition at line 21 of file ClanManagement.java.

Referenced by canTalk(), ClanManagement(), getTalk(), loadRanks(), saveRanks(), and setTalkRank().

The documentation for this class was generated from the following file:

java/com/runehive/content/clanchannel/channel/ClanManagement.java

Public Member Functions

Public Attributes

Package Functions

Package Attributes

Static Package Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ClanManagement()

Member Function Documentation

◆ canEnter()

◆ canManage()

◆ canTalk()

◆ equals()

◆ getEnter()

◆ getManage()

◆ getRank()

◆ getTalk()

◆ loadRanks()

◆ saveRanks()

◆ setEnterRank()

◆ setManageRank()

◆ setTalkRank()

◆ showBanned()

◆ toggleLootshare()

Member Data Documentation

◆ channel

◆ color

◆ ENTER_RANK_INDEX

◆ forum

◆ locked

◆ lootshare

◆ MANAGE_RANK_INDEX

◆ name

◆ password

◆ ranks

◆ SIZE

◆ slogan

◆ tag

◆ TALK_RANK_INDEX