2018-09-23 20:42:52 -06:00
|
|
|
package com.esophose.playerparticles.command;
|
|
|
|
|
2018-09-26 02:07:46 -06:00
|
|
|
import java.util.List;
|
|
|
|
|
2018-09-23 20:42:52 -06:00
|
|
|
import com.esophose.playerparticles.particles.PPlayer;
|
|
|
|
|
|
|
|
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
|
|
|
|
*/
|
|
|
|
public List<String> onTabComplete(PPlayer pplayer, String[] args);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the name of this command
|
|
|
|
*
|
|
|
|
* @return The name of this command
|
|
|
|
*/
|
|
|
|
public String getName();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the description of this command
|
|
|
|
*
|
|
|
|
* @return The description of this command
|
|
|
|
*/
|
|
|
|
public String getDescription();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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-23 20:42:52 -06:00
|
|
|
}
|