Started on documenting the methods for the API
This commit is contained in:
parent
72746f5b4e
commit
3b64f457bd
@ -28,22 +28,63 @@ import java.util.List;
|
|||||||
|
|
||||||
public interface FPlayer extends EconomyParticipator {
|
public interface FPlayer extends EconomyParticipator {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Used to know if stealth is toggled on or off
|
||||||
|
*
|
||||||
|
* @return if stealth mode is on or not.
|
||||||
|
*/
|
||||||
boolean isStealthEnabled();
|
boolean isStealthEnabled();
|
||||||
|
|
||||||
void setStealth(boolean isStealthEnabled);
|
/**
|
||||||
|
* Toggles the stealth of the FPlayer depending on the parameter
|
||||||
|
*
|
||||||
|
* @param stealthToggle
|
||||||
|
*/
|
||||||
|
void setStealth(boolean stealthToggle);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the kills and deaths of a player.
|
||||||
|
*/
|
||||||
void login();
|
void login();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Caches the kills and deaths of a player.
|
||||||
|
*/
|
||||||
void logout();
|
void logout();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* gets the faction of a FPlayer.
|
||||||
|
*
|
||||||
|
* @return Faction of the FPlayer.
|
||||||
|
*/
|
||||||
Faction getFaction();
|
Faction getFaction();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the faction of the FPlayer
|
||||||
|
*
|
||||||
|
* @param faction
|
||||||
|
*/
|
||||||
void setFaction(Faction faction);
|
void setFaction(Faction faction);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the faction ID of the player.
|
||||||
|
*
|
||||||
|
* @return FactionsID string
|
||||||
|
*/
|
||||||
String getFactionId();
|
String getFactionId();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if a player has a faction
|
||||||
|
*
|
||||||
|
* @return boolean
|
||||||
|
*/
|
||||||
boolean hasFaction();
|
boolean hasFaction();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets autoleave status
|
||||||
|
*
|
||||||
|
* @return boolean of the autoleave
|
||||||
|
*/
|
||||||
boolean willAutoLeave();
|
boolean willAutoLeave();
|
||||||
|
|
||||||
void setAutoLeave(boolean autoLeave);
|
void setAutoLeave(boolean autoLeave);
|
||||||
|
Loading…
Reference in New Issue
Block a user