SkillTools.java 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447
  1. package com.gmail.nossr50.util.skills;
  2. import com.gmail.nossr50.api.exceptions.InvalidSkillException;
  3. import com.gmail.nossr50.config.experience.ExperienceConfig;
  4. import com.gmail.nossr50.datatypes.skills.PrimarySkillType;
  5. import com.gmail.nossr50.datatypes.skills.SubSkillType;
  6. import com.gmail.nossr50.datatypes.skills.SuperAbilityType;
  7. import com.gmail.nossr50.datatypes.skills.ToolType;
  8. import com.gmail.nossr50.locale.LocaleLoader;
  9. import com.gmail.nossr50.mcMMO;
  10. import com.gmail.nossr50.util.Permissions;
  11. import com.gmail.nossr50.util.text.StringUtils;
  12. import com.google.common.collect.ImmutableList;
  13. import com.google.common.collect.ImmutableMap;
  14. import com.google.common.collect.ImmutableSet;
  15. import org.bukkit.entity.Entity;
  16. import org.bukkit.entity.Player;
  17. import org.bukkit.entity.Tameable;
  18. import org.jetbrains.annotations.NotNull;
  19. import org.jetbrains.annotations.VisibleForTesting;
  20. import java.util.*;
  21. public class SkillTools {
  22. private final mcMMO pluginRef;
  23. //TODO: Figure out which ones we don't need, this was copy pasted from a diff branch
  24. public final @NotNull ImmutableList<String> LOCALIZED_SKILL_NAMES;
  25. public final @NotNull ImmutableList<String> FORMATTED_SUBSKILL_NAMES;
  26. public final @NotNull ImmutableSet<String> EXACT_SUBSKILL_NAMES;
  27. public final @NotNull ImmutableList<PrimarySkillType> CHILD_SKILLS;
  28. public final static @NotNull ImmutableList<PrimarySkillType> NON_CHILD_SKILLS;
  29. public final @NotNull ImmutableList<PrimarySkillType> COMBAT_SKILLS;
  30. public final @NotNull ImmutableList<PrimarySkillType> GATHERING_SKILLS;
  31. public final @NotNull ImmutableList<PrimarySkillType> MISC_SKILLS;
  32. private final @NotNull ImmutableMap<SubSkillType, PrimarySkillType> subSkillParentRelationshipMap;
  33. private final @NotNull ImmutableMap<SuperAbilityType, PrimarySkillType> superAbilityParentRelationshipMap;
  34. private final @NotNull ImmutableMap<PrimarySkillType, Set<SubSkillType>> primarySkillChildrenMap;
  35. // The map below is for the super abilities which require readying a tool, its everything except blast mining
  36. private final ImmutableMap<PrimarySkillType, SuperAbilityType> mainActivatedAbilityChildMap;
  37. private final ImmutableMap<PrimarySkillType, ToolType> primarySkillToolMap;
  38. static {
  39. ArrayList<PrimarySkillType> tempNonChildSkills = new ArrayList<>();
  40. for(PrimarySkillType primarySkillType : PrimarySkillType.values()) {
  41. if (primarySkillType != PrimarySkillType.SALVAGE && primarySkillType != PrimarySkillType.SMELTING)
  42. tempNonChildSkills.add(primarySkillType);
  43. }
  44. NON_CHILD_SKILLS = ImmutableList.copyOf(tempNonChildSkills);
  45. }
  46. public SkillTools(@NotNull mcMMO pluginRef) {
  47. this.pluginRef = pluginRef;
  48. /*
  49. * Setup subskill -> parent relationship map
  50. */
  51. EnumMap<SubSkillType, PrimarySkillType> tempSubParentMap = new EnumMap<>(SubSkillType.class);
  52. //Super hacky and disgusting
  53. for(PrimarySkillType primarySkillType1 : PrimarySkillType.values()) {
  54. for(SubSkillType subSkillType : SubSkillType.values()) {
  55. String[] splitSubSkillName = subSkillType.toString().split("_");
  56. if(primarySkillType1.toString().equalsIgnoreCase(splitSubSkillName[0])) {
  57. //Parent Skill Found
  58. tempSubParentMap.put(subSkillType, primarySkillType1);
  59. }
  60. }
  61. }
  62. subSkillParentRelationshipMap = ImmutableMap.copyOf(tempSubParentMap);
  63. /*
  64. * Setup primary -> (collection) subskill map
  65. */
  66. EnumMap<PrimarySkillType, Set<SubSkillType>> tempPrimaryChildMap = new EnumMap<>(PrimarySkillType.class);
  67. //Init the empty Hash Sets
  68. for(PrimarySkillType primarySkillType1 : PrimarySkillType.values()) {
  69. tempPrimaryChildMap.put(primarySkillType1, new HashSet<>());
  70. }
  71. //Fill in the hash sets
  72. for(SubSkillType subSkillType : SubSkillType.values()) {
  73. PrimarySkillType parentSkill = subSkillParentRelationshipMap.get(subSkillType);
  74. //Add this subskill as a child
  75. tempPrimaryChildMap.get(parentSkill).add(subSkillType);
  76. }
  77. primarySkillChildrenMap = ImmutableMap.copyOf(tempPrimaryChildMap);
  78. /*
  79. * Setup primary -> tooltype map
  80. */
  81. EnumMap<PrimarySkillType, ToolType> tempToolMap = new EnumMap<>(PrimarySkillType.class);
  82. tempToolMap.put(PrimarySkillType.AXES, ToolType.AXE);
  83. tempToolMap.put(PrimarySkillType.WOODCUTTING, ToolType.AXE);
  84. tempToolMap.put(PrimarySkillType.UNARMED, ToolType.FISTS);
  85. tempToolMap.put(PrimarySkillType.SWORDS, ToolType.SWORD);
  86. tempToolMap.put(PrimarySkillType.EXCAVATION, ToolType.SHOVEL);
  87. tempToolMap.put(PrimarySkillType.HERBALISM, ToolType.HOE);
  88. tempToolMap.put(PrimarySkillType.MINING, ToolType.PICKAXE);
  89. primarySkillToolMap = ImmutableMap.copyOf(tempToolMap);
  90. /*
  91. * Setup ability -> primary map
  92. * Setup primary -> ability map
  93. */
  94. EnumMap<SuperAbilityType, PrimarySkillType> tempAbilityParentRelationshipMap = new EnumMap<>(SuperAbilityType.class);
  95. EnumMap<PrimarySkillType, SuperAbilityType> tempMainActivatedAbilityChildMap = new EnumMap<>(PrimarySkillType.class);
  96. for(SuperAbilityType superAbilityType : SuperAbilityType.values()) {
  97. try {
  98. PrimarySkillType parent = getSuperAbilityParent(superAbilityType);
  99. tempAbilityParentRelationshipMap.put(superAbilityType, parent);
  100. if(superAbilityType != SuperAbilityType.BLAST_MINING) {
  101. //This map is used only for abilities that have a tool readying phase, so blast mining is ignored
  102. tempMainActivatedAbilityChildMap.put(parent, superAbilityType);
  103. }
  104. } catch (InvalidSkillException e) {
  105. e.printStackTrace();
  106. }
  107. }
  108. superAbilityParentRelationshipMap = ImmutableMap.copyOf(tempAbilityParentRelationshipMap);
  109. mainActivatedAbilityChildMap = ImmutableMap.copyOf(tempMainActivatedAbilityChildMap);
  110. /*
  111. * Build child skill and nonchild skill lists
  112. */
  113. List<PrimarySkillType> childSkills = new ArrayList<>();
  114. // List<PrimarySkillType> nonChildSkills = new ArrayList<>();
  115. for (PrimarySkillType primarySkillType : PrimarySkillType.values()) {
  116. if (isChildSkill(primarySkillType))
  117. childSkills.add(primarySkillType);
  118. // } {
  119. // nonChildSkills.add(primarySkillType);
  120. // }
  121. }
  122. CHILD_SKILLS = ImmutableList.copyOf(childSkills);
  123. // NON_CHILD_SKILLS = ImmutableList.copyOf(nonChildSkills);
  124. /*
  125. * Build categorized skill lists
  126. */
  127. COMBAT_SKILLS = ImmutableList.of(PrimarySkillType.ARCHERY, PrimarySkillType.AXES, PrimarySkillType.SWORDS, PrimarySkillType.TAMING, PrimarySkillType.UNARMED);
  128. GATHERING_SKILLS = ImmutableList.of(PrimarySkillType.EXCAVATION, PrimarySkillType.FISHING, PrimarySkillType.HERBALISM, PrimarySkillType.MINING, PrimarySkillType.WOODCUTTING);
  129. MISC_SKILLS = ImmutableList.of(PrimarySkillType.ACROBATICS, PrimarySkillType.ALCHEMY, PrimarySkillType.REPAIR, PrimarySkillType.SALVAGE, PrimarySkillType.SMELTING);
  130. /*
  131. * Build formatted/localized/etc string lists
  132. */
  133. LOCALIZED_SKILL_NAMES = ImmutableList.copyOf(buildLocalizedPrimarySkillNames());
  134. FORMATTED_SUBSKILL_NAMES = ImmutableList.copyOf(buildFormattedSubSkillNameList());
  135. EXACT_SUBSKILL_NAMES = ImmutableSet.copyOf(buildExactSubSkillNameList());
  136. }
  137. private @NotNull PrimarySkillType getSuperAbilityParent(SuperAbilityType superAbilityType) throws InvalidSkillException {
  138. return switch (superAbilityType) {
  139. case BERSERK -> PrimarySkillType.UNARMED;
  140. case GREEN_TERRA -> PrimarySkillType.HERBALISM;
  141. case TREE_FELLER -> PrimarySkillType.WOODCUTTING;
  142. case SUPER_BREAKER, BLAST_MINING -> PrimarySkillType.MINING;
  143. case SKULL_SPLITTER -> PrimarySkillType.AXES;
  144. case SERRATED_STRIKES -> PrimarySkillType.SWORDS;
  145. case GIGA_DRILL_BREAKER -> PrimarySkillType.EXCAVATION;
  146. case SUPER_SHOTGUN -> PrimarySkillType.CROSSBOWS;
  147. case TRIDENT_ABILITY -> PrimarySkillType.TRIDENTS;
  148. default ->
  149. throw new InvalidSkillException("No parent defined for super ability! " + superAbilityType.toString());
  150. };
  151. }
  152. /**
  153. * Makes a list of the "nice" version of sub skill names
  154. * Used in tab completion mostly
  155. * @return a list of formatted sub skill names
  156. */
  157. private @NotNull ArrayList<String> buildFormattedSubSkillNameList() {
  158. ArrayList<String> subSkillNameList = new ArrayList<>();
  159. for(SubSkillType subSkillType : SubSkillType.values()) {
  160. subSkillNameList.add(subSkillType.getNiceNameNoSpaces(subSkillType));
  161. }
  162. return subSkillNameList;
  163. }
  164. private @NotNull HashSet<String> buildExactSubSkillNameList() {
  165. HashSet<String> subSkillNameExactSet = new HashSet<>();
  166. for(SubSkillType subSkillType : SubSkillType.values()) {
  167. subSkillNameExactSet.add(subSkillType.toString());
  168. }
  169. return subSkillNameExactSet;
  170. }
  171. /**
  172. * Builds a list of localized {@link PrimarySkillType} names
  173. * @return list of localized {@link PrimarySkillType} names
  174. */
  175. @VisibleForTesting
  176. private @NotNull ArrayList<String> buildLocalizedPrimarySkillNames() {
  177. ArrayList<String> localizedSkillNameList = new ArrayList<>();
  178. for(PrimarySkillType primarySkillType : PrimarySkillType.values()) {
  179. localizedSkillNameList.add(getLocalizedSkillName(primarySkillType));
  180. }
  181. Collections.sort(localizedSkillNameList);
  182. return localizedSkillNameList;
  183. }
  184. /**
  185. * Matches a string of a skill to a skill
  186. * This is NOT case sensitive
  187. * First it checks the locale file and tries to match by the localized name of the skill
  188. * Then if nothing is found it checks against the hard coded "name" of the skill, which is just its name in English
  189. *
  190. * @param skillName target skill name
  191. * @return the matching PrimarySkillType if one is found, otherwise null
  192. */
  193. public PrimarySkillType matchSkill(String skillName) {
  194. if (!pluginRef.getGeneralConfig().getLocale().equalsIgnoreCase("en_US")) {
  195. for (PrimarySkillType type : PrimarySkillType.values()) {
  196. if (skillName.equalsIgnoreCase(LocaleLoader.getString(StringUtils.getCapitalized(type.name()) + ".SkillName"))) {
  197. return type;
  198. }
  199. }
  200. }
  201. for (PrimarySkillType type : PrimarySkillType.values()) {
  202. if (type.name().equalsIgnoreCase(skillName)) {
  203. return type;
  204. }
  205. }
  206. if (!skillName.equalsIgnoreCase("all")) {
  207. pluginRef.getLogger().warning("Invalid mcMMO skill (" + skillName + ")"); //TODO: Localize
  208. }
  209. return null;
  210. }
  211. /**
  212. * Gets the PrimarySkillStype to which a SubSkillType belongs
  213. * Return null if it does not belong to one.. which should be impossible in most circumstances
  214. * @param subSkillType target subskill
  215. * @return the PrimarySkillType of this SubSkill, null if it doesn't exist
  216. */
  217. public PrimarySkillType getPrimarySkillBySubSkill(SubSkillType subSkillType) {
  218. return subSkillParentRelationshipMap.get(subSkillType);
  219. }
  220. /**
  221. * Gets the PrimarySkillStype to which a SuperAbilityType belongs
  222. * Return null if it does not belong to one.. which should be impossible in most circumstances
  223. * @param superAbilityType target super ability
  224. * @return the PrimarySkillType of this SuperAbilityType, null if it doesn't exist
  225. */
  226. public PrimarySkillType getPrimarySkillBySuperAbility(SuperAbilityType superAbilityType) {
  227. return superAbilityParentRelationshipMap.get(superAbilityType);
  228. }
  229. public SuperAbilityType getSuperAbility(PrimarySkillType primarySkillType) {
  230. if(mainActivatedAbilityChildMap.get(primarySkillType) == null)
  231. return null;
  232. return mainActivatedAbilityChildMap.get(primarySkillType);
  233. }
  234. public boolean isSuperAbilityUnlocked(PrimarySkillType primarySkillType, Player player) {
  235. SuperAbilityType superAbilityType = mcMMO.p.getSkillTools().getSuperAbility(primarySkillType);
  236. SubSkillType subSkillType = superAbilityType.getSubSkillTypeDefinition();
  237. return RankUtils.hasUnlockedSubskill(player, subSkillType);
  238. }
  239. public boolean getPVPEnabled(PrimarySkillType primarySkillType) {
  240. return pluginRef.getGeneralConfig().getPVPEnabled(primarySkillType);
  241. }
  242. public boolean getPVEEnabled(PrimarySkillType primarySkillType) {
  243. return pluginRef.getGeneralConfig().getPVEEnabled(primarySkillType);
  244. }
  245. public boolean getHardcoreStatLossEnabled(PrimarySkillType primarySkillType) {
  246. return pluginRef.getGeneralConfig().getHardcoreStatLossEnabled(primarySkillType);
  247. }
  248. public boolean getHardcoreVampirismEnabled(PrimarySkillType primarySkillType) {
  249. return pluginRef.getGeneralConfig().getHardcoreVampirismEnabled(primarySkillType);
  250. }
  251. public ToolType getPrimarySkillToolType(PrimarySkillType primarySkillType) {
  252. return primarySkillToolMap.get(primarySkillType);
  253. }
  254. public Set<SubSkillType> getSubSkills(PrimarySkillType primarySkillType) {
  255. //TODO: Cache this!
  256. return primarySkillChildrenMap.get(primarySkillType);
  257. }
  258. public double getXpModifier(PrimarySkillType primarySkillType) {
  259. return ExperienceConfig.getInstance().getFormulaSkillModifier(primarySkillType);
  260. }
  261. // TODO: This is a little "hacky", we probably need to add something to distinguish child skills in the enum, or to use another enum for them
  262. public static boolean isChildSkill(PrimarySkillType primarySkillType) {
  263. switch (primarySkillType) {
  264. case SALVAGE:
  265. case SMELTING:
  266. return true;
  267. default:
  268. return false;
  269. }
  270. }
  271. /**
  272. * Get the localized name for a {@link PrimarySkillType}
  273. * @param primarySkillType target {@link PrimarySkillType}
  274. * @return the localized name for a {@link PrimarySkillType}
  275. */
  276. public String getLocalizedSkillName(PrimarySkillType primarySkillType) {
  277. //TODO: Replace with current impl
  278. return StringUtils.getCapitalized(LocaleLoader.getString(StringUtils.getCapitalized(primarySkillType.toString()) + ".SkillName"));
  279. }
  280. public boolean doesPlayerHaveSkillPermission(Player player, PrimarySkillType primarySkillType) {
  281. return Permissions.skillEnabled(player, primarySkillType);
  282. }
  283. public boolean canCombatSkillsTrigger(PrimarySkillType primarySkillType, Entity target) {
  284. return (target instanceof Player || (target instanceof Tameable && ((Tameable) target).isTamed())) ? getPVPEnabled(primarySkillType) : getPVEEnabled(primarySkillType);
  285. }
  286. public String getCapitalizedPrimarySkillName(PrimarySkillType primarySkillType) {
  287. return StringUtils.getCapitalized(primarySkillType.toString());
  288. }
  289. public int getSuperAbilityCooldown(SuperAbilityType superAbilityType) {
  290. return pluginRef.getGeneralConfig().getCooldown(superAbilityType);
  291. }
  292. public int getSuperAbilityMaxLength(SuperAbilityType superAbilityType) {
  293. return pluginRef.getGeneralConfig().getMaxLength(superAbilityType);
  294. }
  295. public String getSuperAbilityOnLocaleKey(SuperAbilityType superAbilityType) {
  296. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + ".On";
  297. }
  298. public String getSuperAbilityOffLocaleKey(SuperAbilityType superAbilityType) {
  299. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + ".Off";
  300. }
  301. public String getSuperAbilityOtherPlayerActivationLocaleKey(SuperAbilityType superAbilityType) {
  302. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + ".Other.On";
  303. }
  304. public String getSuperAbilityOtherPlayerDeactivationLocaleKey(SuperAbilityType superAbilityType) {
  305. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + "Other.Off";
  306. }
  307. public String getSuperAbilityRefreshedLocaleKey(SuperAbilityType superAbilityType) {
  308. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + ".Refresh";
  309. }
  310. public int getLevelCap(@NotNull PrimarySkillType primarySkillType) {
  311. return mcMMO.p.getGeneralConfig().getLevelCap(primarySkillType);
  312. }
  313. /**
  314. * Get the permissions for this ability.
  315. *
  316. * @param player Player to check permissions for
  317. * @param superAbilityType target super ability
  318. * @return true if the player has permissions, false otherwise
  319. */
  320. public boolean superAbilityPermissionCheck(SuperAbilityType superAbilityType, Player player) {
  321. switch (superAbilityType) {
  322. case BERSERK:
  323. return Permissions.berserk(player);
  324. case BLAST_MINING:
  325. return Permissions.remoteDetonation(player);
  326. case GIGA_DRILL_BREAKER:
  327. return Permissions.gigaDrillBreaker(player);
  328. case GREEN_TERRA:
  329. return Permissions.greenTerra(player);
  330. case SERRATED_STRIKES:
  331. return Permissions.serratedStrikes(player);
  332. case SKULL_SPLITTER:
  333. return Permissions.skullSplitter(player);
  334. case SUPER_BREAKER:
  335. return Permissions.superBreaker(player);
  336. case TREE_FELLER:
  337. return Permissions.treeFeller(player);
  338. default:
  339. return false;
  340. }
  341. }
  342. public @NotNull List<PrimarySkillType> getChildSkills() {
  343. return CHILD_SKILLS;
  344. }
  345. public @NotNull ImmutableList<PrimarySkillType> getNonChildSkills() {
  346. return NON_CHILD_SKILLS;
  347. }
  348. public @NotNull ImmutableList<PrimarySkillType> getCombatSkills() {
  349. return COMBAT_SKILLS;
  350. }
  351. public @NotNull ImmutableList<PrimarySkillType> getGatheringSkills() {
  352. return GATHERING_SKILLS;
  353. }
  354. public @NotNull ImmutableList<PrimarySkillType> getMiscSkills() {
  355. return MISC_SKILLS;
  356. }
  357. }