Improved comments for nether and end sethome

This commit is contained in:
tastybento 2020-07-18 08:15:30 -07:00
parent aaea6fd6fe
commit cb38e67e36
2 changed files with 43 additions and 37 deletions

View File

@ -824,6 +824,7 @@ public class Settings implements WorldSettings
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
@Override
public String getPlayerCommandAliases() public String getPlayerCommandAliases()
{ {
return playerCommandAliases; return playerCommandAliases;
@ -833,6 +834,7 @@ public class Settings implements WorldSettings
/** /**
* {@inheritDoc} * {@inheritDoc}
*/ */
@Override
public String getAdminCommandAliases() public String getAdminCommandAliases()
{ {
return adminCommandAliases; return adminCommandAliases;
@ -1185,15 +1187,15 @@ public class Settings implements WorldSettings
} }
/** /**
* This method sets the fallingBannedCommands object value. * This method sets the fallingBannedCommands object value.
* @param fallingBannedCommands the fallingBannedCommands object new value. * @param fallingBannedCommands the fallingBannedCommands object new value.
* *
*/ */
public void setFallingBannedCommands(List<String> fallingBannedCommands) public void setFallingBannedCommands(List<String> fallingBannedCommands)
{ {
this.fallingBannedCommands = fallingBannedCommands; this.fallingBannedCommands = fallingBannedCommands;
} }
/** /**
@ -1317,36 +1319,36 @@ public class Settings implements WorldSettings
} }
/** /**
* This method sets the createCaveOnFirstLoginEnabled object value. * This method sets the createCaveOnFirstLoginEnabled object value.
* @param createIslandOnFirstLoginEnabled the createCaveOnFirstLoginEnabled object new value. * @param createIslandOnFirstLoginEnabled the createCaveOnFirstLoginEnabled object new value.
* *
*/ */
public void setCreateIslandOnFirstLoginEnabled(boolean createIslandOnFirstLoginEnabled) public void setCreateIslandOnFirstLoginEnabled(boolean createIslandOnFirstLoginEnabled)
{ {
this.createIslandOnFirstLoginEnabled = createIslandOnFirstLoginEnabled; this.createIslandOnFirstLoginEnabled = createIslandOnFirstLoginEnabled;
} }
/** /**
* This method sets the createCaveOnFirstLoginDelay object value. * This method sets the createCaveOnFirstLoginDelay object value.
* @param createIslandOnFirstLoginDelay the createCaveOnFirstLoginDelay object new value. * @param createIslandOnFirstLoginDelay the createCaveOnFirstLoginDelay object new value.
* *
*/ */
public void setCreateIslandOnFirstLoginDelay(int createIslandOnFirstLoginDelay) public void setCreateIslandOnFirstLoginDelay(int createIslandOnFirstLoginDelay)
{ {
this.createIslandOnFirstLoginDelay = createIslandOnFirstLoginDelay; this.createIslandOnFirstLoginDelay = createIslandOnFirstLoginDelay;
} }
/** /**
* This method sets the createCaveOnFirstLoginDelay object value. * This method sets the createCaveOnFirstLoginDelay object value.
* @param createIslandOnFirstLoginAbortOnLogout the createCaveOnFirstLoginDelay object new value. * @param createIslandOnFirstLoginAbortOnLogout the createCaveOnFirstLoginDelay object new value.
* *
*/ */
public void setCreateIslandOnFirstLoginAbortOnLogout(boolean createIslandOnFirstLoginAbortOnLogout) public void setCreateIslandOnFirstLoginAbortOnLogout(boolean createIslandOnFirstLoginAbortOnLogout)
{ {
this.createIslandOnFirstLoginAbortOnLogout = createIslandOnFirstLoginAbortOnLogout; this.createIslandOnFirstLoginAbortOnLogout = createIslandOnFirstLoginAbortOnLogout;
} }
/** /**
@ -2182,7 +2184,7 @@ public class Settings implements WorldSettings
@ConfigComment("permission size cannot be less than the default below. ") @ConfigComment("permission size cannot be less than the default below. ")
@ConfigEntry(path = "cave.max-coop-size", since = "1.13.0") @ConfigEntry(path = "cave.max-coop-size", since = "1.13.0")
private int maxCoopSize = 4; private int maxCoopSize = 4;
@ConfigComment("Default maximum number of trusted rank members per cave") @ConfigComment("Default maximum number of trusted rank members per cave")
@ConfigComment("Players can have the caveblock.trust.maxsize.<number> permission to be bigger but") @ConfigComment("Players can have the caveblock.trust.maxsize.<number> permission to be bigger but")
@ConfigComment("permission size cannot be less than the default below. ") @ConfigComment("permission size cannot be less than the default below. ")
@ -2331,12 +2333,14 @@ public class Settings implements WorldSettings
private List<String> onLeaveCommands = new ArrayList<>(); private List<String> onLeaveCommands = new ArrayList<>();
// Sethome // Sethome
@ConfigComment("Allow setting home in the nether. Only available on nether islands, not vanilla nether.")
@ConfigEntry(path = "cave.sethome.nether.allow") @ConfigEntry(path = "cave.sethome.nether.allow")
private boolean allowSetHomeInNether = true; private boolean allowSetHomeInNether = true;
@ConfigEntry(path = "cave.sethome.nether.require-confirmation") @ConfigEntry(path = "cave.sethome.nether.require-confirmation")
private boolean requireConfirmationToSetHomeInNether = true; private boolean requireConfirmationToSetHomeInNether = true;
@ConfigComment("Allow setting home in the end. Only available on end islands, not vanilla end.")
@ConfigEntry(path = "cave.sethome.the-end.allow") @ConfigEntry(path = "cave.sethome.the-end.allow")
private boolean allowSetHomeInTheEnd = true; private boolean allowSetHomeInTheEnd = true;

View File

@ -413,9 +413,11 @@ cave:
on-leave: [] on-leave: []
sethome: sethome:
nether: nether:
# Allow setting home in the nether. Only available on nether islands, not vanilla nether.
allow: true allow: true
require-confirmation: true require-confirmation: true
the-end: the-end:
# Allow setting home in the end. Only available on end islands, not vanilla end.
allow: true allow: true
require-confirmation: true require-confirmation: true
deaths: deaths: