com.gmail.louis1234567890987654321.teams

Class Team

java.lang.Object

com.gmail.louis1234567890987654321.teams.Team

public class Team
extends java.lang.Object

Author:

louis1234567890987654321@gmail.com

Constructor Summary

Constructors

Constructor and Description
Team()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMember(org.bukkit.entity.Player p) Adds a member to the team
void	broadcast(java.lang.String rawMsg) Broadcasts a message to all online members in the team.
void	disband() Disbands the team.
org.bukkit.Location	getHome() Gets the location of /team home A != null check is recommended to check if a home exists.
short	getKills() Returns the number of kills.
java.lang.String	getName() Returns the name of the team.
org.bukkit.inventory.Inventory	getVault() Gets and returns the team's vault
void	giveItemToAllMembersOnline(org.bukkit.inventory.ItemStack s) Gives an item to all online members
boolean	hasInvited(org.bukkit.entity.Player p) Checks if a player has been invited.
void	invite(org.bukkit.entity.Player p) Invites a player to a team.
void	promote(Member m) Demotes the moderator now and promotes the member specified is in the team
void	removeMember(Member m) Removes a member from the team If the member is the moderator of the team, the whole team gets DISBANDED!
void	sethome(org.bukkit.Location l) Sets the location for /team home or getHome() The home can be unset by using sethome(null)
void	setKills(short kills) Sets the new number kills to the assigned number.

Methods inherited from class java.lang.Object

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

Constructor Detail

Team

public Team()

Method Detail

getName

public java.lang.String getName()

Returns the name of the team.

Returns:

The name of the team.

addMember

public void addMember(org.bukkit.entity.Player p)

Adds a member to the team

Parameters:

m - Member to be added in the team

Throws:

java.lang.NullPointerException - When the member is null

java.lang.IllegalArgumentException - When the member already has a team

See Also:

removeMember(Member)

removeMember

public void removeMember(Member m)

Removes a member from the team If the member is the moderator of the team, the whole team gets DISBANDED!

Parameters:

m - Member to be removed

Throws:

java.lang.IllegalArgumentException - When the member is not in the team

java.lang.NullPointerException - When m==null

See Also:

addMember(Member)

promote

public void promote(Member m)

Demotes the moderator now and promotes the member specified is in the team

Parameters:

m - Member to be promoted

Throws:

java.lang.IllegalArgumentException - When the member is not in the team or the member is a moderator

java.lang.NullPointerException - When m==null

invite

public void invite(org.bukkit.entity.Player p)

Invites a player to a team. The player that has been invited before will be de-invited. Use invite(null) to cancel all invitations.

Parameters:

p - The player to be invited.

See Also:

hasInvited(Player)

hasInvited

public boolean hasInvited(org.bukkit.entity.Player p)

Checks if a player has been invited.

Parameters:

p - The player to be checked

Returns:

If the player is invited, the method returns true.

See Also:

invite(Player)

disband

public void disband()

Disbands the team. The team will be removed from the list of teams

sethome

public void sethome(org.bukkit.Location l)

Sets the location for /team home or getHome() The home can be unset by using sethome(null)

Parameters:

l - The location of the new home.

See Also:

getHome()

getHome

public org.bukkit.Location getHome()

Gets the location of /team home A != null check is recommended to check if a home exists.

Returns:

The location of /team home

See Also:

sethome(Location)

giveItemToAllMembersOnline

public void giveItemToAllMembersOnline(org.bukkit.inventory.ItemStack s)

Gives an item to all online members

Parameters:

s - The item to be given.

Throws:

java.lang.IllegalArgumentException - When the passed item is null

broadcast

public void broadcast(java.lang.String rawMsg)

Broadcasts a message to all online members in the team.

Parameters:

rawMsg - The message that will be broadcasted.

Throws:

java.lang.NullPointerException - When the message is null

getKills

public short getKills()

Returns the number of kills.

Returns:

The number of kills.

See Also:

setKills(short)

setKills

public void setKills(short kills)

Sets the new number kills to the assigned number.

Parameters:

kills - The new number of kills

See Also:

getKills()

getVault

public org.bukkit.inventory.Inventory getVault()

Gets and returns the team's vault

Returns:

The team's vault