Rx3/Factions
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add some parameter descriptions

Browse Source 
there are more to come
This commit is contained in:
Magnus Ulf 2019-02-01 09:14:04 +01:00
parent 1b0f2d29f8
commit 1e20892392
21 changed files with 35 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/com/massivecraft/factions/cmd/CmdFactionsCreate.java
View File

@ -26,7 +26,7 @@ public class CmdFactionsCreate extends FactionsCommand
this.addAliases("new");
// Parameters
this.addParameter(TypeFactionNameStrict.get(), "name");
this.addParameter(TypeFactionNameStrict.get(), "name").setDesc("the name of your new faction");
// Requirements
this.addRequirements(ReqHasntFaction.get());

2
src/com/massivecraft/factions/cmd/CmdFactionsDescription.java
View File

@ -17,7 +17,7 @@ public class CmdFactionsDescription extends FactionsCommand
public CmdFactionsDescription()
{
// Parameters
this.addParameter(TypeString.get(), "desc", true);
this.addParameter(TypeString.get(), "desc", true).setDesc("the new faction desciption");
// Requirements
this.addRequirements(ReqHasFaction.get());

4
src/com/massivecraft/factions/cmd/CmdFactionsDocumentationWarps.java
View File

@ -30,11 +30,11 @@ public class CmdFactionsDocumentationWarps extends FactionsCommandDocumentation
if (MConf.get().warpsMax < 0)
{
msgDoc("There is no limit to how many warps a faction can have.");
msgDoc("There is <h>no limit <i>to how many warps a faction can have.");
}
else
{
msgDoc("There is no limit to how many warps a faction can have.");
msgDoc("A faction can only have <h>%d <i>warps.", MConf.get().warpsMax);
}
if (MConf.get().warpsMustBeInClaimedTerritory)

2
src/com/massivecraft/factions/cmd/CmdFactionsFaction.java
View File

@ -22,7 +22,7 @@ public class CmdFactionsFaction extends FactionsCommand
public CmdFactionsFaction()
{
// Aliases
this.addAliases("f", "show", "who");
this.addAliases("f", "show", "who").setDesc("the faction to show info about");
// Parameters
this.addParameter(TypeFaction.get(), "faction", "you");

6
src/com/massivecraft/factions/cmd/CmdFactionsFlagSet.java
View File

@ -18,9 +18,9 @@ public class CmdFactionsFlagSet extends FactionsCommand
public CmdFactionsFlagSet()
{
// Parameters
this.addParameter(TypeMFlag.get(), "flag");
this.addParameter(TypeBooleanYes.get(), "yes/no");
this.addParameter(TypeFaction.get(), "faction", "you");
this.addParameter(TypeMFlag.get(), "flag").setDesc("the faction flag to set a value for");
this.addParameter(TypeBooleanYes.get(), "yes/no").setDesc("should the flag be on or off?");
this.addParameter(TypeFaction.get(), "faction", "you").setDesc("the faction to set the flag for (per default your own)");
}
// -------------------------------------------- //

2
src/com/massivecraft/factions/cmd/CmdFactionsFlagShow.java
View File

@ -20,7 +20,7 @@ public class CmdFactionsFlagShow extends FactionsCommand
public CmdFactionsFlagShow()
{
// Parameters
this.addParameter(TypeFaction.get(), "faction", "you");
this.addParameter(TypeFaction.get(), "faction", "you").setDesc("the faction to show flags for");
this.addParameter(Parameter.getPage());
}

2
src/com/massivecraft/factions/cmd/CmdFactionsInviteAdd.java
View File

@ -23,7 +23,7 @@ public class CmdFactionsInviteAdd extends FactionsCommand
public CmdFactionsInviteAdd()
{
// Parameters
this.addParameter(TypeSet.get(TypeMPlayer.get()), "players", true);
this.addParameter(TypeSet.get(TypeMPlayer.get()), "players", true).setDesc("the player to invite");
}
// -------------------------------------------- //

2
src/com/massivecraft/factions/cmd/CmdFactionsInviteList.java
View File

@ -32,7 +32,7 @@ public class CmdFactionsInviteList extends FactionsCommand
{
// Parameters
this.addParameter(Parameter.getPage());
this.addParameter(TypeFaction.get(), "faction", "you");
this.addParameter(TypeFaction.get(), "faction", "you").setDesc("the faction to list invites for");
}
// -------------------------------------------- //

2
src/com/massivecraft/factions/cmd/CmdFactionsInviteRemove.java
View File

@ -23,7 +23,7 @@ public class CmdFactionsInviteRemove extends FactionsCommand
public CmdFactionsInviteRemove()
{
// Parameters
this.addParameter(TypeSet.get(TypeMPlayer.get()), "players/all", true);
this.addParameter(TypeSet.get(TypeMPlayer.get()), "players/all", true).setDesc("the player to deinvite");
}
// -------------------------------------------- //

4
src/com/massivecraft/factions/cmd/CmdFactionsJoin.java
View File

@ -24,8 +24,8 @@ public class CmdFactionsJoin extends FactionsCommand
public CmdFactionsJoin()
{
// Parameters
this.addParameter(TypeFaction.get(), "faction");
this.addParameter(TypeMPlayer.get(), "player", "you");
this.addParameter(TypeFaction.get(), "faction").setDesc("the faction to join");
this.addParameter(TypeMPlayer.get(), "player", "you").setDesc("the player that should join tje faction (for admins only)");
}
// -------------------------------------------- //

2
src/com/massivecraft/factions/cmd/CmdFactionsKick.java
View File

@ -22,7 +22,7 @@ public class CmdFactionsKick extends FactionsCommand
public CmdFactionsKick()
{
// Parameters
this.addParameter(TypeMPlayer.get(), "player");
this.addParameter(TypeMPlayer.get(), "player").setDesc("the player to kick");
}
// -------------------------------------------- //

2
src/com/massivecraft/factions/cmd/CmdFactionsMap.java
View File

@ -15,7 +15,7 @@ public class CmdFactionsMap extends FactionsCommand
public CmdFactionsMap()
{
// Parameters
this.addParameter(TypeBooleanYes.get(), "on/off", "once");
this.addParameter(TypeBooleanYes.get(), "on/off", "once").setDesc("set to yes to get an auto updating map\nset to no to disable");
// Requirements
this.addRequirements(RequirementIsPlayer.get());

2
src/com/massivecraft/factions/cmd/CmdFactionsMoneyBalance.java
View File

@ -16,7 +16,7 @@ public class CmdFactionsMoneyBalance extends FactionsCommand
public CmdFactionsMoneyBalance()
{
// Parameters
this.addParameter(TypeFaction.get(), "faction", "you");
this.addParameter(TypeFaction.get(), "faction", "you").setDesc("the faction whose balance to check");
// Requirements
this.addRequirements(ReqBankCommandsEnabled.get());

4
src/com/massivecraft/factions/cmd/CmdFactionsMoneyDeposit.java
View File

@ -21,8 +21,8 @@ public class CmdFactionsMoneyDeposit extends FactionsCommand
public CmdFactionsMoneyDeposit()
{
// Parameters
this.addParameter(TypeDouble.get(), "amount");
this.addParameter(TypeFaction.get(), "faction", "you");
this.addParameter(TypeDouble.get(), "amount").setDesc("the amount of money to deposit");
this.addParameter(TypeFaction.get(), "faction", "you").setDesc("the faction to deposit money to");
// Requirements
this.addRequirements(ReqBankCommandsEnabled.get());

6
src/com/massivecraft/factions/cmd/CmdFactionsMoneyTransferFf.java
View File

@ -29,9 +29,9 @@ public class CmdFactionsMoneyTransferFf extends FactionsCommand
this.addAliases("ff");
// Parameters
this.addParameter(TypeDouble.get(), "amount");
this.addParameter(TypeFaction.get(), "faction");
this.addParameter(TypeFaction.get(), "faction");
this.addParameter(TypeDouble.get(), "amount").setDesc("the amount of money to transfer");
this.addParameter(TypeFaction.get(), "faction").setDesc("the faction to transfer money from");
this.addParameter(TypeFaction.get(), "faction").setDesc("the faction to transfer money to");
// Requirements
this.addRequirements(RequirementHasPerm.get(Perm.MONEY_F2F));

6
src/com/massivecraft/factions/cmd/CmdFactionsMoneyTransferFp.java
View File

@ -31,9 +31,9 @@ public class CmdFactionsMoneyTransferFp extends FactionsCommand
this.addAliases("fp");
// Parameters
this.addParameter(TypeDouble.get(), "amount");
this.addParameter(TypeFaction.get(), "faction");
this.addParameter(TypeMPlayer.get(), "player");
this.addParameter(TypeDouble.get(), "amount").setDesc("the amount of money to transfer");
this.addParameter(TypeFaction.get(), "faction").setDesc("the faction to transfer money from");
this.addParameter(TypeMPlayer.get(), "player").setDesc("the player to transfer money to");
// Requirements
this.addRequirements(RequirementHasPerm.get(Perm.MONEY_F2P));

6
src/com/massivecraft/factions/cmd/CmdFactionsMoneyTransferPf.java
View File

@ -31,9 +31,9 @@ public class CmdFactionsMoneyTransferPf extends FactionsCommand
this.addAliases("pf");
// Parameters
this.addParameter(TypeDouble.get(), "amount");
this.addParameter(TypeMPlayer.get(), "player");
this.addParameter(TypeFaction.get(), "faction");
this.addParameter(TypeDouble.get(), "amount").setDesc("the amount of money to transfer");
this.addParameter(TypeMPlayer.get(), "player").setDesc("the player to transfer money from");
this.addParameter(TypeFaction.get(), "faction").setDesc("the faction to transfer money to");
// Requirements
this.addRequirements(RequirementHasPerm.get(Perm.MONEY_P2F));

4
src/com/massivecraft/factions/cmd/CmdFactionsMoneyWithdraw.java
View File

@ -22,8 +22,8 @@ public class CmdFactionsMoneyWithdraw extends FactionsCommand
public CmdFactionsMoneyWithdraw()
{
// Parameters
this.addParameter(TypeDouble.get(), "amount");
this.addParameter(TypeFaction.get(), "faction", "you");
this.addParameter(TypeDouble.get(), "amount").setDesc("the amount of money to withdraw");
this.addParameter(TypeFaction.get(), "faction", "you").setDesc("the faction to transfer money to");
// Requirements
this.addRequirements(ReqBankCommandsEnabled.get());

2
src/com/massivecraft/factions/cmd/CmdFactionsMotd.java
View File

@ -19,7 +19,7 @@ public class CmdFactionsMotd extends FactionsCommand
public CmdFactionsMotd()
{
// Parameters
this.addParameter(TypeNullable.get(TypeString.get()), "new", "read", true);
this.addParameter(TypeNullable.get(TypeString.get()), "new", "read", true).setDesc("the new motd\nif not specified you will just see the current one");
}
// -------------------------------------------- //

9
src/com/massivecraft/factions/cmd/CmdFactionsName.java
View File

@ -3,14 +3,9 @@ package com.massivecraft.factions.cmd;
import com.massivecraft.factions.cmd.type.TypeFaction;
import com.massivecraft.factions.cmd.type.TypeFactionNameLenient;
import com.massivecraft.factions.entity.Faction;
import com.massivecraft.factions.entity.FactionColl;
import com.massivecraft.factions.entity.MPerm;
import com.massivecraft.factions.event.EventFactionsNameChange;
import com.massivecraft.factions.util.MiscUtil;
import com.massivecraft.massivecore.MassiveException;
import com.massivecraft.massivecore.command.type.primitive.TypeString;
import java.util.ArrayList;
public class CmdFactionsName extends FactionsCommand
{
@ -21,8 +16,8 @@ public class CmdFactionsName extends FactionsCommand
public CmdFactionsName()
{
// Parameters
this.addParameter(TypeFactionNameLenient.get(), "new name");
this.addParameter(TypeFaction.get(), "faction", "you");
this.addParameter(TypeFactionNameLenient.get(), "new name").setDesc("the new name of the faction");
this.addParameter(TypeFaction.get(), "faction", "you").setDesc("the faction whose name to change");
}
// -------------------------------------------- //

4
src/com/massivecraft/factions/cmd/CmdFactionsStatus.java
View File

@ -28,8 +28,8 @@ public class CmdFactionsStatus extends FactionsCommand
{
// Parameters
this.addParameter(Parameter.getPage());
this.addParameter(TypeFaction.get(), "faction", "you");
this.addParameter(TypeSortMPlayer.get(), "sort", "time");
this.addParameter(TypeFaction.get(), "faction", "you").setDesc("the faction whose status to see");
this.addParameter(TypeSortMPlayer.get(), "sort", "time").setDesc("sort mplayers by rank, power or last active time?");
}
// -------------------------------------------- //