Package com.booksaw.betterTeams.commands.presets

Class TeamSubCommand

java.lang.Object

com.booksaw.betterTeams.commands.SubCommand

com.booksaw.betterTeams.commands.presets.TeamSubCommand

Direct Known Subclasses:

AllyChatCommand, AllyCommand, AnchorCommand, BalCommand, BanCommand, ChatCommand, ChestClaimCommand, ChestRemoveallCommand, ChestRemoveCommand, ColorCommand, DelHome, DelwarpCommand, DemoteCommand, DepositCommand, DescriptionCommand, DisbandCommand, EchestCommand, HomeCommand, InviteCommand, KickCommand, LeaveCommand, NameCommand, NeutralCommand, OpenCommand, PromoteCommand, PvpCommand, RankupCommand, SetAnchorCommand, SethomeCommand, SetOwnerCommand, SetWarpCommand, TagCommand, TitleCommand, UnbanCommand, WarpCommand, WarpsCommand, WithdrawCommand

public abstract class TeamSubCommand
extends SubCommand

This class can be extended for any sub commands which require players to be in a team

Author:

booksaw

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TeamSubCommand.TeamPlayerResult

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	checkRank

Constructor Summary

Constructors

Constructor	Description
TeamSubCommand()

Method Summary

Modifier and Type	Method	Description
protected CommandResponse	checkRank(@NotNull TeamPlayer player, PlayerRank rank)
CommandResponse	checkRank(TeamPlayer player)
abstract PlayerRank	getDefaultRank()
protected @Nullable Team	getMyTeam(org.bukkit.command.CommandSender sender)
PlayerRank	getRequiredRank()
protected TeamSubCommand.TeamPlayerResult	getTeamPlayer(Team team, String name)
boolean	needPlayer()	Used to check if the commandSender needs to be a player, defaults to false
abstract CommandResponse	onCommand(TeamPlayer player, String label, String[] args, Team team)	This method is run if the player is in a team
CommandResponse	onCommand(org.bukkit.command.CommandSender sender, String label, String[] args)	This method is called whenever the sub command is run, return the message (+ chat color if it should not be the default chat color)
void	setRequiredRank(PlayerRank requiredRank)

Methods inherited from class com.booksaw.betterTeams.commands.SubCommand

addMetaStringList, addPlayerStringList, addTeamStringList, addTeamStringList, checkAsync, getArgMessage, getArguments, getCommand, getCommandAndArgMessage, getHelp, getHelpMessage, getMaximumArguments, getMinimumArguments, getNode, onTabComplete, runAsync

Methods inherited from class java.lang.Object

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

Field Details

checkRank

protected boolean checkRank

Constructor Details

TeamSubCommand

public TeamSubCommand()

Method Details

getMyTeam

@Nullable
protected @Nullable Team getMyTeam(org.bukkit.command.CommandSender sender)

onCommand

public CommandResponse onCommand(org.bukkit.command.CommandSender sender,
 String label,
 String[] args)

Description copied from class: SubCommand

This method is called whenever the sub command is run, return the message (+ chat color if it should not be the default chat color)

The return value should be the value of the message to be sent to the user, for more complicated messaging systems return null

Specified by:

onCommand in class SubCommand

Parameters:

sender - the person who called the command

label - the label of the initial command (useful for help files)

args - the arguments of the sub command (starting at args[0], as the sub command itself will be removed)

Returns:

the message

onCommand

public abstract CommandResponse onCommand(TeamPlayer player,
 String label,
 String[] args,
 Team team)

This method is run if the player is in a team

Parameters:

player - the player who is in a team

label - the label for the command

args - the arguments for the command

team - the team that the player is in

Returns:

the message reference to send to the user

needPlayer

public boolean needPlayer()

Description copied from class: SubCommand

Used to check if the commandSender needs to be a player, defaults to false

Overrides:

needPlayer in class SubCommand

Returns:

if the commandSender needs to be a player

getDefaultRank

public abstract PlayerRank getDefaultRank()

Returns:

the rank that the player has to be by default for this command

checkRank

public CommandResponse checkRank(TeamPlayer player)

checkRank

protected CommandResponse checkRank(@NotNull
 @NotNull TeamPlayer player,
 PlayerRank rank)

getTeamPlayer

protected TeamSubCommand.TeamPlayerResult getTeamPlayer(Team team,
 String name)

setRequiredRank

public void setRequiredRank(PlayerRank requiredRank)

getRequiredRank

public PlayerRank getRequiredRank()