2018-09-23 20:42:52 -06:00
|
|
|
package com.esophose.playerparticles.command;
|
|
|
|
|
2018-10-05 21:01:28 -06:00
|
|
|
import java.text.MessageFormat;
|
2018-09-26 02:07:46 -06:00
|
|
|
import java.util.List;
|
|
|
|
|
2018-09-29 17:27:37 -06:00
|
|
|
import com.esophose.playerparticles.manager.LangManager;
|
|
|
|
import com.esophose.playerparticles.manager.LangManager.Lang;
|
2018-09-23 20:42:52 -06:00
|
|
|
import com.esophose.playerparticles.particles.PPlayer;
|
|
|
|
|
2018-10-05 21:01:28 -06:00
|
|
|
import net.md_5.bungee.api.ChatColor;
|
|
|
|
|
2018-09-23 20:42:52 -06:00
|
|
|
public interface CommandModule {
|
|
|
|
|
2018-09-27 18:58:05 -06:00
|
|
|
/**
|
|
|
|
* Called when this command gets executed
|
|
|
|
*
|
|
|
|
* @param pplayer The PPlayer who executed this command
|
|
|
|
* @param args The arguments to this command
|
|
|
|
*/
|
|
|
|
public void onCommandExecute(PPlayer pplayer, String[] args);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Called when a player tries to tab complete this command
|
|
|
|
*
|
|
|
|
* @param pplayer The PPlayer who is tab completing this command
|
|
|
|
* @param args Arguments typed so far
|
2018-10-07 16:51:03 -06:00
|
|
|
* @return A list of possible argument values
|
2018-09-27 18:58:05 -06:00
|
|
|
*/
|
|
|
|
public List<String> onTabComplete(PPlayer pplayer, String[] args);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the name of this command
|
|
|
|
*
|
|
|
|
* @return The name of this command
|
|
|
|
*/
|
|
|
|
public String getName();
|
|
|
|
|
|
|
|
/**
|
2018-09-29 17:27:37 -06:00
|
|
|
* Gets the Lang description of this command
|
2018-09-27 18:58:05 -06:00
|
|
|
*
|
|
|
|
* @return The description of this command
|
|
|
|
*/
|
2018-09-29 17:27:37 -06:00
|
|
|
public Lang getDescription();
|
2018-09-27 18:58:05 -06:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets any arguments this command has
|
|
|
|
*
|
|
|
|
* @return The arguments this command has
|
|
|
|
*/
|
|
|
|
public String getArguments();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* True if this command requires the player to have any effects
|
|
|
|
*
|
|
|
|
* @return If the player must have effects to use this command
|
|
|
|
*/
|
|
|
|
public boolean requiresEffects();
|
2018-09-29 17:27:37 -06:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Displays a command's usage to the player
|
|
|
|
*
|
|
|
|
* @param pplayer The PPlayer to display the command usage to
|
|
|
|
* @param command The command to display usage for
|
|
|
|
*/
|
|
|
|
public static void printUsage(PPlayer pplayer, CommandModule command) {
|
2018-10-05 21:01:28 -06:00
|
|
|
Object[] args = new Object[] { command.getName(), command.getArguments() };
|
|
|
|
LangManager.sendCustomMessage(pplayer, new MessageFormat(ChatColor.YELLOW + "/pp {0} {1}").format(args));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Displays a command's usage (with its description) to the player
|
|
|
|
*
|
|
|
|
* @param pplayer The PPlayer to display the command usage to
|
|
|
|
* @param command The command to display usage for
|
|
|
|
*/
|
|
|
|
public static void printUsageWithDescription(PPlayer pplayer, CommandModule command) {
|
|
|
|
if (command.getArguments().length() == 0) {
|
|
|
|
Object[] args = new Object[] { command.getName(), LangManager.getText(command.getDescription()) };
|
|
|
|
LangManager.sendCustomMessage(pplayer, new MessageFormat(ChatColor.YELLOW + "/pp {0} - {1}").format(args));
|
|
|
|
} else {
|
|
|
|
Object[] args = new Object[] { command.getName(), command.getArguments(), LangManager.getText(command.getDescription()) };
|
|
|
|
LangManager.sendCustomMessage(pplayer, new MessageFormat(ChatColor.YELLOW + "/pp {0} {1} - {2}").format(args));
|
|
|
|
}
|
2018-09-29 17:27:37 -06:00
|
|
|
}
|
2018-09-27 18:58:05 -06:00
|
|
|
|
2018-09-23 20:42:52 -06:00
|
|
|
}
|