eu.wauz.wauzcore.players

Class WauzPlayerGuild

java.lang.Object

eu.wauz.wauzcore.players.WauzPlayerGuild

public class WauzPlayerGuild
extends java.lang.Object

A player guild loaded from a config file. Also contains static methods for managing all guilds.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	adminUuidString The uuid of the guild leader.
private java.util.List<java.lang.String>	applicantUuidStrings The uuids of guild applicants.
private java.lang.String	guildDescription The description of the guild.
private static java.util.Map<java.lang.String,WauzPlayerGuild>	guildMap All guilds by uuid.
private java.lang.String	guildName The name of the guild.
private static java.util.Map<java.lang.String,WauzPlayerGuild>	guildNameMap All guilds by name.
private org.bukkit.inventory.ItemStack	guildTabard The tabard / banner of the guild.
private java.lang.String	guildUuidString The uuid of the guild.
private java.util.List<java.lang.String>	memberUuidStrings The uuids of all guild members.
private java.util.List<java.lang.String>	officerUuidStrings The uuids of the guild officers.
private int	upgradeAdditionalSlots How many additional slots are available.

Constructor Summary

Constructors

Constructor and Description
WauzPlayerGuild(java.lang.String guildUuidString) Creates a guild object from a config file with given uuid.
WauzPlayerGuild(java.lang.String guildUuidString, java.lang.String adminUuidString, java.lang.String guildName) Creates an entirely new guild and saves it to a config file.

Method Summary

Modifier and Type	Method and Description
void	addApplicant(java.lang.String applicantUuidString) Adds an guild applicant to the list.
void	addPlayer(org.bukkit.OfflinePlayer player) Adds a player to the guild and announces it to all online members.
static boolean	applyForGuild(org.bukkit.entity.Player player, java.lang.String guildName) Sends a guild application.
static boolean	createGuild(org.bukkit.entity.Player leader, java.lang.String guildName) Creates a new guild.
void	demoteToMember(org.bukkit.entity.Player player, org.bukkit.OfflinePlayer member) Demotes an officer to a member and announces it to all online members.
static boolean	doShareGuild(org.bukkit.OfflinePlayer player1, org.bukkit.OfflinePlayer player2, boolean allowSame) Checks if the given players share the same guild.
java.lang.String	getAdminUuidString()
java.util.List<java.lang.String>	getApplicantUuidStrings()
int	getApplicationCount() Gets the count of all guild applicants.
static WauzPlayerGuild	getGuild(java.lang.String uuid) Finds a guild by uuid.
static WauzPlayerGuild	getGuildByName(java.lang.String guildName) Finds a guild by name.
java.lang.String	getGuildDescription()
java.lang.String	getGuildName()
static java.util.List<java.lang.String>	getGuildNames()
static java.util.List<WauzPlayerGuild>	getGuilds()
org.bukkit.inventory.ItemStack	getGuildTabard()
java.lang.String	getGuildUuidString()
int	getMaxMemberAmount()
int	getMemberAmount()
java.util.List<java.lang.String>	getMemberUuidStrings()
java.util.List<java.lang.String>	getOfficerUuidStrings()
int	getUpgradeAdditionalSlots()
java.util.List<java.lang.String>	getWrappedGuildDescription()
static void	init() Loads all guilds from the config files.
boolean	isEmpty()
boolean	isFull()
boolean	isGuildAdmin(org.bukkit.OfflinePlayer player) Checks if a player is the guild leader.
boolean	isGuildMember(org.bukkit.OfflinePlayer player) Checks if a player is a guild member.
boolean	isGuildOfficer(org.bukkit.OfflinePlayer player) Checks if a player is a guild officer.
static boolean	isNameTaken(java.lang.String guildName) Checks if a guild name is already taken.
void	kickMember(org.bukkit.entity.Player player, org.bukkit.OfflinePlayer member) Kicks a member out of the guild and announces it to all online members.
void	promoteToLeader(org.bukkit.entity.Player player, org.bukkit.OfflinePlayer member) Promotes an officer to the leader and announces it to all online members.
void	promoteToOfficer(org.bukkit.entity.Player player, org.bukkit.OfflinePlayer member) Promotes a member to an officer and announces it to all online members.
void	removeApplicant(java.lang.String applicantUuidString) Removes an guild applicant from the list.
void	removePlayer(org.bukkit.OfflinePlayer player) Removes a player from the guild and announces it to all online members.
void	sendMessageToGuildMembers(java.lang.String message) Sends a message to all online guild members.
void	setAdminUuidString(java.lang.String adminUuidString)
void	setApplicantUuidStrings(java.util.List<java.lang.String> applicantUuidStrings)
void	setGuildDescription(org.bukkit.entity.Player player, java.lang.String guildDescription)
void	setGuildName(java.lang.String guildName)
void	setGuildTabard(org.bukkit.entity.Player player, org.bukkit.inventory.ItemStack guildTabard)
void	setGuildUuidString(java.lang.String guildUuidString)
void	setMemberUuidStrings(java.util.List<java.lang.String> memberUuidStrings)
void	setOfficerUuidStrings(java.util.List<java.lang.String> officerUuidStrings)
void	setUpgradeAdditionalSlots(int upgradeAdditionalSlots)
void	updateApplications() Checks if all applications are still valid and updates the config correspondingly.

Methods inherited from class java.lang.Object

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

Field Detail

guildMap

private static java.util.Map<java.lang.String,WauzPlayerGuild> guildMap

All guilds by uuid.

guildNameMap

private static java.util.Map<java.lang.String,WauzPlayerGuild> guildNameMap

All guilds by name.

guildUuidString

private java.lang.String guildUuidString

The uuid of the guild.

adminUuidString

private java.lang.String adminUuidString

The uuid of the guild leader.

officerUuidStrings

private java.util.List<java.lang.String> officerUuidStrings

The uuids of the guild officers.

memberUuidStrings

private java.util.List<java.lang.String> memberUuidStrings

The uuids of all guild members.

applicantUuidStrings

private java.util.List<java.lang.String> applicantUuidStrings

The uuids of guild applicants.

guildName

private java.lang.String guildName

The name of the guild.

guildDescription

private java.lang.String guildDescription

The description of the guild.

guildTabard

private org.bukkit.inventory.ItemStack guildTabard

The tabard / banner of the guild.

upgradeAdditionalSlots

private int upgradeAdditionalSlots

How many additional slots are available.

Constructor Detail

WauzPlayerGuild

public WauzPlayerGuild(java.lang.String guildUuidString)

Creates a guild object from a config file with given uuid.

Parameters:

guildUuidString - The uuid of the guild.

WauzPlayerGuild

public WauzPlayerGuild(java.lang.String guildUuidString,
                       java.lang.String adminUuidString,
                       java.lang.String guildName)

Creates an entirely new guild and saves it to a config file.

Parameters:

guildUuidString - The uuid of the guild.

adminUuidString - The uuid of the guild leader.

guildName - The name of the guild.

Method Detail

init

public static void init()

Loads all guilds from the config files.

See Also:

GuildConfigurator.getGuildUuidList()

getGuilds

public static java.util.List<WauzPlayerGuild> getGuilds()

Returns:

A shuffled list of all guilds.

getGuildNames

public static java.util.List<java.lang.String> getGuildNames()

Returns:

A shuffled list of all guild names.

getGuild

public static WauzPlayerGuild getGuild(java.lang.String uuid)

Finds a guild by uuid.

Parameters:

uuid - The uuid of the guild.

Returns:

The requested guild.

getGuildByName

public static WauzPlayerGuild getGuildByName(java.lang.String guildName)

Finds a guild by name.

Parameters:

guildName - The name of the guild.

Returns:

The requested guild.

doShareGuild

public static boolean doShareGuild(org.bukkit.OfflinePlayer player1,
                                   org.bukkit.OfflinePlayer player2,
                                   boolean allowSame)

Checks if the given players share the same guild.

Parameters:

player1 - The first player.

player2 - The other player.

allowSame - If it counts, when the players are equal.

Returns:

If the players are in the same guild.

createGuild

public static boolean createGuild(org.bukkit.entity.Player leader,
                                  java.lang.String guildName)

Creates a new guild. The leader must be in a MMORPG world and cannot already be in a guild. 300 Tokens are required for the guild creation.

Parameters:

leader - The leader of the new guild.

guildName - A guild name, that does not already exists, between 1 and 42 chars.

Returns:

If the guild creation command had valid syntax.

applyForGuild

public static boolean applyForGuild(org.bukkit.entity.Player player,
                                    java.lang.String guildName)

Sends a guild application. The player must be in a MMORPG world and cannot already be in a guild. All online guild members will receive a notification.

Parameters:

player - The player that wants to join a guild.

guildName - The name of the guild.

Returns:

If the guild apply command had valid syntax.

isNameTaken

public static boolean isNameTaken(java.lang.String guildName)

Checks if a guild name is already taken.

Parameters:

guildName - The name of the guild.

Returns:

If it is taken.

getGuildUuidString

public java.lang.String getGuildUuidString()

Returns:

The uuid of the guild.

setGuildUuidString

public void setGuildUuidString(java.lang.String guildUuidString)

Parameters:

guildUuidString - The new uuid of the guild.

getAdminUuidString

public java.lang.String getAdminUuidString()

Returns:

The uuid of the guild leader.

setAdminUuidString

public void setAdminUuidString(java.lang.String adminUuidString)

Parameters:

adminUuidString - The new uuid of the guild leader.

isGuildAdmin

public boolean isGuildAdmin(org.bukkit.OfflinePlayer player)

Checks if a player is the guild leader.

Parameters:

player - A member of the guild.

Returns:

If they are the leader.

getOfficerUuidStrings

public java.util.List<java.lang.String> getOfficerUuidStrings()

Returns:

The uuids of the guild officers.

setOfficerUuidStrings

public void setOfficerUuidStrings(java.util.List<java.lang.String> officerUuidStrings)

Parameters:

officerUuidStrings - The new uuids of the guild officers.

isGuildOfficer

public boolean isGuildOfficer(org.bukkit.OfflinePlayer player)

Checks if a player is a guild officer.

Parameters:

player - A member of the guild.

Returns:

If they are an officer.

getMemberUuidStrings

public java.util.List<java.lang.String> getMemberUuidStrings()

Returns:

The uuids of the normal guild members.

setMemberUuidStrings

public void setMemberUuidStrings(java.util.List<java.lang.String> memberUuidStrings)

Parameters:

memberUuidStrings - The new uuids of the normal guild members.

isGuildMember

public boolean isGuildMember(org.bukkit.OfflinePlayer player)

Checks if a player is a guild member.

Parameters:

player - A potential member of the guild.

Returns:

If they are a member.

sendMessageToGuildMembers

public void sendMessageToGuildMembers(java.lang.String message)

Sends a message to all online guild members.

Parameters:

message - The content of the message.

getMemberAmount

public int getMemberAmount()

Returns:

The current amount of guild members.

getMaxMemberAmount

public int getMaxMemberAmount()

Returns:

The maximum amount of guild members.

isFull

public boolean isFull()

Returns:

If the guild is full.

isEmpty

public boolean isEmpty()

Returns:

If the guild is empty.

addPlayer

public void addPlayer(org.bukkit.OfflinePlayer player)

Adds a player to the guild and announces it to all online members.

Parameters:

player - The player to add.

removePlayer

public void removePlayer(org.bukkit.OfflinePlayer player)

Removes a player from the guild and announces it to all online members. May cause the change of the leader or the deletion of the guild.

Parameters:

player - The player to remove.

demoteToMember

public void demoteToMember(org.bukkit.entity.Player player,
                           org.bukkit.OfflinePlayer member)

Demotes an officer to a member and announces it to all online members.

Parameters:

player - The player that is demoting.

member - The member to demote.

promoteToOfficer

public void promoteToOfficer(org.bukkit.entity.Player player,
                             org.bukkit.OfflinePlayer member)

Promotes a member to an officer and announces it to all online members.

Parameters:

player - The player that is promoting.

member - The member to promote.

kickMember

public void kickMember(org.bukkit.entity.Player player,
                       org.bukkit.OfflinePlayer member)

Kicks a member out of the guild and announces it to all online members.

Parameters:

player - The player that is kicking.

member - The player that gets kicked.

promoteToLeader

public void promoteToLeader(org.bukkit.entity.Player player,
                            org.bukkit.OfflinePlayer member)

Promotes an officer to the leader and announces it to all online members.

Parameters:

player - The player that is promoting.

member - The member to promote.

getApplicantUuidStrings

public java.util.List<java.lang.String> getApplicantUuidStrings()

Returns:

The uuids of guild applicants.

See Also:

updateApplications()

setApplicantUuidStrings

public void setApplicantUuidStrings(java.util.List<java.lang.String> applicantUuidStrings)

Parameters:

applicantUuidStrings - The new uuids of guild applicants.

See Also:

updateApplications()

addApplicant

public void addApplicant(java.lang.String applicantUuidString)

Adds an guild applicant to the list.

Parameters:

applicantUuidString - The uuid of the applicant to add.

See Also:

updateApplications()

removeApplicant

public void removeApplicant(java.lang.String applicantUuidString)

Removes an guild applicant from the list.

Parameters:

applicantUuidString - The uuid of the applicant to remove.

See Also:

updateApplications()

getApplicationCount

public int getApplicationCount()

Gets the count of all guild applicants.

Returns:

The count of applicants

See Also:

updateApplications()

updateApplications

public void updateApplications()

Checks if all applications are still valid and updates the config correspondingly.

getGuildName

public java.lang.String getGuildName()

Returns:

The name of the guild.

setGuildName

public void setGuildName(java.lang.String guildName)

Parameters:

guildName - The new name of the guild.

getGuildDescription

public java.lang.String getGuildDescription()

Returns:

The description of the guild.

getWrappedGuildDescription

public java.util.List<java.lang.String> getWrappedGuildDescription()

Returns:

The wrapped description of the guild.

setGuildDescription

public void setGuildDescription(org.bukkit.entity.Player player,
                                java.lang.String guildDescription)

Parameters:

player - The player who updated the description.

guildDescription - The new description of the guild.

getGuildTabard

public org.bukkit.inventory.ItemStack getGuildTabard()

Returns:

The tabard / banner of the guild.

setGuildTabard

public void setGuildTabard(org.bukkit.entity.Player player,
                           org.bukkit.inventory.ItemStack guildTabard)

Parameters:

player - The player who updated the tabard.

guildTabard - The new tabard / banner of the guild.

getUpgradeAdditionalSlots

public int getUpgradeAdditionalSlots()

Returns:

How many additional slots are available.

setUpgradeAdditionalSlots

public void setUpgradeAdditionalSlots(int upgradeAdditionalSlots)

Parameters:

upgradeAdditionalSlots - How many additional slots are now available.