eu.wauz.wauzcore.players

Class WauzPlayerGroup

java.lang.Object

eu.wauz.wauzcore.players.WauzPlayerGroup

public class WauzPlayerGroup
extends java.lang.Object

A player group to save session scoped group information.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.lang.String	adminUuidString The uuid of the leader.
(package private) java.lang.String	groupDescription The description of the group.
(package private) java.lang.String	groupPassword The password of the group,
(package private) java.lang.String	groupUuidString The uuid of the group.
(package private) java.util.List<org.bukkit.entity.Player>	players The players inside the group.
(package private) java.lang.String	wauzMode The mode of this group's world.

Constructor Summary

Constructors

Constructor and Description
WauzPlayerGroup(org.bukkit.entity.Player leader) Creates a new group with given leader.

Method Summary

Modifier and Type	Method and Description
void	addPlayer(org.bukkit.entity.Player player) Adds a new player and announces it to the group members.
java.lang.String	getAdminUuidString()
java.lang.String	getGroupDescription()
java.lang.String	getGroupPassword()
java.lang.String	getGroupUuidString()
int	getPlayerAmount()
java.util.List<org.bukkit.entity.Player>	getPlayers()
java.lang.String	getWauzMode()
java.util.List<java.lang.String>	getWrappedGroupDescription()
boolean	isEmpty()
boolean	isFull()
boolean	isGroupAdmin(org.bukkit.entity.Player player)
boolean	isPasswordProtected()
void	removePlayer(org.bukkit.entity.Player player) Removes a player and announces it to the group members.
void	setAdminUuidString(java.lang.String adminUuidString)
void	setGroupDescription(org.bukkit.entity.Player player, java.lang.String groupDescription)
void	setGroupPassword(java.lang.String groupPassword)
void	setGroupUuidString(java.lang.String groupUuidString)
void	setPlayers(java.util.List<org.bukkit.entity.Player> players)
void	setWauzMode(java.lang.String wauzMode)

Methods inherited from class java.lang.Object

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

Field Detail

groupUuidString

java.lang.String groupUuidString

The uuid of the group.

adminUuidString

java.lang.String adminUuidString

The uuid of the leader.

wauzMode

java.lang.String wauzMode

The mode of this group's world.

players

java.util.List<org.bukkit.entity.Player> players

The players inside the group.

groupPassword

java.lang.String groupPassword

The password of the group,

groupDescription

java.lang.String groupDescription

The description of the group.

Constructor Detail

WauzPlayerGroup

public WauzPlayerGroup(org.bukkit.entity.Player leader)

Creates a new group with given leader.

Parameters:

leader - The leader of the group.

Method Detail

getGroupUuidString

public java.lang.String getGroupUuidString()

Returns:

The uuid of the group.

setGroupUuidString

public void setGroupUuidString(java.lang.String groupUuidString)

Parameters:

groupUuidString - The new uuid of the group.

getAdminUuidString

public java.lang.String getAdminUuidString()

Returns:

The uuid of the leader.

setAdminUuidString

public void setAdminUuidString(java.lang.String adminUuidString)

Parameters:

adminUuidString - The new uuid of the leader.

isGroupAdmin

public boolean isGroupAdmin(org.bukkit.entity.Player player)

Parameters:

player - A group member.

Returns:

If the given member is the leader.

getWauzMode

public java.lang.String getWauzMode()

Returns:

The mode of this group's world.

setWauzMode

public void setWauzMode(java.lang.String wauzMode)

Parameters:

wauzMode - The new mode of this group's world.

getPlayers

public java.util.List<org.bukkit.entity.Player> getPlayers()

Returns:

The players inside the group.

setPlayers

public void setPlayers(java.util.List<org.bukkit.entity.Player> players)

Parameters:

players - The new players inside the group.

getPlayerAmount

public int getPlayerAmount()

Returns:

The amount of players inside the group.

isFull

public boolean isFull()

Returns:

If the group has 5 or more members.

isEmpty

public boolean isEmpty()

Returns:

If the group has 0 members.

addPlayer

public void addPlayer(org.bukkit.entity.Player player)

Adds a new player and announces it to the group members.

Parameters:

player - The player to add.

removePlayer

public void removePlayer(org.bukkit.entity.Player player)

Removes a player and announces it to the group members. Unregisters the group or changes leader, if necessary.

Parameters:

player - The player to remove.

getGroupPassword

public java.lang.String getGroupPassword()

Returns:

The password of the group.

setGroupPassword

public void setGroupPassword(java.lang.String groupPassword)

Parameters:

groupPassword - The new password of the group.

isPasswordProtected

public boolean isPasswordProtected()

Returns:

If the group is password protected.

getGroupDescription

public java.lang.String getGroupDescription()

Returns:

The description of the group.

getWrappedGroupDescription

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

Returns:

The wrapped description of the group.

setGroupDescription

public void setGroupDescription(org.bukkit.entity.Player player,
                                java.lang.String groupDescription)

Parameters:

player - The player that changed the description.

groupDescription - The new description of the group.