SkillTools.java 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464
  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(
  128. PrimarySkillType.ARCHERY,
  129. PrimarySkillType.AXES,
  130. PrimarySkillType.CROSSBOWS,
  131. PrimarySkillType.SWORDS,
  132. PrimarySkillType.TAMING,
  133. PrimarySkillType.TRIDENTS,
  134. PrimarySkillType.UNARMED);
  135. GATHERING_SKILLS = ImmutableList.of(
  136. PrimarySkillType.EXCAVATION,
  137. PrimarySkillType.FISHING,
  138. PrimarySkillType.HERBALISM,
  139. PrimarySkillType.MINING,
  140. PrimarySkillType.WOODCUTTING);
  141. MISC_SKILLS = ImmutableList.of(
  142. PrimarySkillType.ACROBATICS,
  143. PrimarySkillType.ALCHEMY,
  144. PrimarySkillType.REPAIR,
  145. PrimarySkillType.SALVAGE,
  146. PrimarySkillType.SMELTING);
  147. /*
  148. * Build formatted/localized/etc string lists
  149. */
  150. LOCALIZED_SKILL_NAMES = ImmutableList.copyOf(buildLocalizedPrimarySkillNames());
  151. FORMATTED_SUBSKILL_NAMES = ImmutableList.copyOf(buildFormattedSubSkillNameList());
  152. EXACT_SUBSKILL_NAMES = ImmutableSet.copyOf(buildExactSubSkillNameList());
  153. }
  154. private @NotNull PrimarySkillType getSuperAbilityParent(SuperAbilityType superAbilityType) throws InvalidSkillException {
  155. return switch (superAbilityType) {
  156. case BERSERK -> PrimarySkillType.UNARMED;
  157. case GREEN_TERRA -> PrimarySkillType.HERBALISM;
  158. case TREE_FELLER -> PrimarySkillType.WOODCUTTING;
  159. case SUPER_BREAKER, BLAST_MINING -> PrimarySkillType.MINING;
  160. case SKULL_SPLITTER -> PrimarySkillType.AXES;
  161. case SERRATED_STRIKES -> PrimarySkillType.SWORDS;
  162. case GIGA_DRILL_BREAKER -> PrimarySkillType.EXCAVATION;
  163. case SUPER_SHOTGUN -> PrimarySkillType.CROSSBOWS;
  164. case TRIDENTS_SUPER_ABILITY -> PrimarySkillType.TRIDENTS;
  165. default ->
  166. throw new InvalidSkillException("No parent defined for super ability! " + superAbilityType.toString());
  167. };
  168. }
  169. /**
  170. * Makes a list of the "nice" version of sub skill names
  171. * Used in tab completion mostly
  172. * @return a list of formatted sub skill names
  173. */
  174. private @NotNull ArrayList<String> buildFormattedSubSkillNameList() {
  175. ArrayList<String> subSkillNameList = new ArrayList<>();
  176. for(SubSkillType subSkillType : SubSkillType.values()) {
  177. subSkillNameList.add(subSkillType.getNiceNameNoSpaces(subSkillType));
  178. }
  179. return subSkillNameList;
  180. }
  181. private @NotNull HashSet<String> buildExactSubSkillNameList() {
  182. HashSet<String> subSkillNameExactSet = new HashSet<>();
  183. for(SubSkillType subSkillType : SubSkillType.values()) {
  184. subSkillNameExactSet.add(subSkillType.toString());
  185. }
  186. return subSkillNameExactSet;
  187. }
  188. /**
  189. * Builds a list of localized {@link PrimarySkillType} names
  190. * @return list of localized {@link PrimarySkillType} names
  191. */
  192. @VisibleForTesting
  193. private @NotNull ArrayList<String> buildLocalizedPrimarySkillNames() {
  194. ArrayList<String> localizedSkillNameList = new ArrayList<>();
  195. for(PrimarySkillType primarySkillType : PrimarySkillType.values()) {
  196. localizedSkillNameList.add(getLocalizedSkillName(primarySkillType));
  197. }
  198. Collections.sort(localizedSkillNameList);
  199. return localizedSkillNameList;
  200. }
  201. /**
  202. * Matches a string of a skill to a skill
  203. * This is NOT case sensitive
  204. * First it checks the locale file and tries to match by the localized name of the skill
  205. * Then if nothing is found it checks against the hard coded "name" of the skill, which is just its name in English
  206. *
  207. * @param skillName target skill name
  208. * @return the matching PrimarySkillType if one is found, otherwise null
  209. */
  210. public PrimarySkillType matchSkill(String skillName) {
  211. if (!pluginRef.getGeneralConfig().getLocale().equalsIgnoreCase("en_US")) {
  212. for (PrimarySkillType type : PrimarySkillType.values()) {
  213. if (skillName.equalsIgnoreCase(LocaleLoader.getString(StringUtils.getCapitalized(type.name()) + ".SkillName"))) {
  214. return type;
  215. }
  216. }
  217. }
  218. for (PrimarySkillType type : PrimarySkillType.values()) {
  219. if (type.name().equalsIgnoreCase(skillName)) {
  220. return type;
  221. }
  222. }
  223. if (!skillName.equalsIgnoreCase("all")) {
  224. pluginRef.getLogger().warning("Invalid mcMMO skill (" + skillName + ")"); //TODO: Localize
  225. }
  226. return null;
  227. }
  228. /**
  229. * Gets the PrimarySkillStype to which a SubSkillType belongs
  230. * Return null if it does not belong to one.. which should be impossible in most circumstances
  231. * @param subSkillType target subskill
  232. * @return the PrimarySkillType of this SubSkill, null if it doesn't exist
  233. */
  234. public PrimarySkillType getPrimarySkillBySubSkill(SubSkillType subSkillType) {
  235. return subSkillParentRelationshipMap.get(subSkillType);
  236. }
  237. /**
  238. * Gets the PrimarySkillStype to which a SuperAbilityType belongs
  239. * Return null if it does not belong to one.. which should be impossible in most circumstances
  240. * @param superAbilityType target super ability
  241. * @return the PrimarySkillType of this SuperAbilityType, null if it doesn't exist
  242. */
  243. public PrimarySkillType getPrimarySkillBySuperAbility(SuperAbilityType superAbilityType) {
  244. return superAbilityParentRelationshipMap.get(superAbilityType);
  245. }
  246. public SuperAbilityType getSuperAbility(PrimarySkillType primarySkillType) {
  247. if(mainActivatedAbilityChildMap.get(primarySkillType) == null)
  248. return null;
  249. return mainActivatedAbilityChildMap.get(primarySkillType);
  250. }
  251. public boolean isSuperAbilityUnlocked(PrimarySkillType primarySkillType, Player player) {
  252. SuperAbilityType superAbilityType = mcMMO.p.getSkillTools().getSuperAbility(primarySkillType);
  253. SubSkillType subSkillType = superAbilityType.getSubSkillTypeDefinition();
  254. return RankUtils.hasUnlockedSubskill(player, subSkillType);
  255. }
  256. public boolean getPVPEnabled(PrimarySkillType primarySkillType) {
  257. return pluginRef.getGeneralConfig().getPVPEnabled(primarySkillType);
  258. }
  259. public boolean getPVEEnabled(PrimarySkillType primarySkillType) {
  260. return pluginRef.getGeneralConfig().getPVEEnabled(primarySkillType);
  261. }
  262. public boolean getHardcoreStatLossEnabled(PrimarySkillType primarySkillType) {
  263. return pluginRef.getGeneralConfig().getHardcoreStatLossEnabled(primarySkillType);
  264. }
  265. public boolean getHardcoreVampirismEnabled(PrimarySkillType primarySkillType) {
  266. return pluginRef.getGeneralConfig().getHardcoreVampirismEnabled(primarySkillType);
  267. }
  268. public ToolType getPrimarySkillToolType(PrimarySkillType primarySkillType) {
  269. return primarySkillToolMap.get(primarySkillType);
  270. }
  271. public Set<SubSkillType> getSubSkills(PrimarySkillType primarySkillType) {
  272. //TODO: Cache this!
  273. return primarySkillChildrenMap.get(primarySkillType);
  274. }
  275. public double getXpModifier(PrimarySkillType primarySkillType) {
  276. return ExperienceConfig.getInstance().getFormulaSkillModifier(primarySkillType);
  277. }
  278. // 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
  279. public static boolean isChildSkill(PrimarySkillType primarySkillType) {
  280. switch (primarySkillType) {
  281. case SALVAGE:
  282. case SMELTING:
  283. return true;
  284. default:
  285. return false;
  286. }
  287. }
  288. /**
  289. * Get the localized name for a {@link PrimarySkillType}
  290. * @param primarySkillType target {@link PrimarySkillType}
  291. * @return the localized name for a {@link PrimarySkillType}
  292. */
  293. public String getLocalizedSkillName(PrimarySkillType primarySkillType) {
  294. //TODO: Replace with current impl
  295. return StringUtils.getCapitalized(LocaleLoader.getString(StringUtils.getCapitalized(primarySkillType.toString()) + ".SkillName"));
  296. }
  297. public boolean doesPlayerHaveSkillPermission(Player player, PrimarySkillType primarySkillType) {
  298. return Permissions.skillEnabled(player, primarySkillType);
  299. }
  300. public boolean canCombatSkillsTrigger(PrimarySkillType primarySkillType, Entity target) {
  301. return (target instanceof Player || (target instanceof Tameable && ((Tameable) target).isTamed())) ? getPVPEnabled(primarySkillType) : getPVEEnabled(primarySkillType);
  302. }
  303. public String getCapitalizedPrimarySkillName(PrimarySkillType primarySkillType) {
  304. return StringUtils.getCapitalized(primarySkillType.toString());
  305. }
  306. public int getSuperAbilityCooldown(SuperAbilityType superAbilityType) {
  307. return pluginRef.getGeneralConfig().getCooldown(superAbilityType);
  308. }
  309. public int getSuperAbilityMaxLength(SuperAbilityType superAbilityType) {
  310. return pluginRef.getGeneralConfig().getMaxLength(superAbilityType);
  311. }
  312. public String getSuperAbilityOnLocaleKey(SuperAbilityType superAbilityType) {
  313. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + ".On";
  314. }
  315. public String getSuperAbilityOffLocaleKey(SuperAbilityType superAbilityType) {
  316. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + ".Off";
  317. }
  318. public String getSuperAbilityOtherPlayerActivationLocaleKey(SuperAbilityType superAbilityType) {
  319. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + ".Other.On";
  320. }
  321. public String getSuperAbilityOtherPlayerDeactivationLocaleKey(SuperAbilityType superAbilityType) {
  322. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + "Other.Off";
  323. }
  324. public String getSuperAbilityRefreshedLocaleKey(SuperAbilityType superAbilityType) {
  325. return "SuperAbility." + StringUtils.getPrettyCamelCaseName(superAbilityType) + ".Refresh";
  326. }
  327. public int getLevelCap(@NotNull PrimarySkillType primarySkillType) {
  328. return mcMMO.p.getGeneralConfig().getLevelCap(primarySkillType);
  329. }
  330. /**
  331. * Get the permissions for this ability.
  332. *
  333. * @param player Player to check permissions for
  334. * @param superAbilityType target super ability
  335. * @return true if the player has permissions, false otherwise
  336. */
  337. public boolean superAbilityPermissionCheck(SuperAbilityType superAbilityType, Player player) {
  338. switch (superAbilityType) {
  339. case BERSERK:
  340. return Permissions.berserk(player);
  341. case BLAST_MINING:
  342. return Permissions.remoteDetonation(player);
  343. case GIGA_DRILL_BREAKER:
  344. return Permissions.gigaDrillBreaker(player);
  345. case GREEN_TERRA:
  346. return Permissions.greenTerra(player);
  347. case SERRATED_STRIKES:
  348. return Permissions.serratedStrikes(player);
  349. case SKULL_SPLITTER:
  350. return Permissions.skullSplitter(player);
  351. case SUPER_BREAKER:
  352. return Permissions.superBreaker(player);
  353. case TREE_FELLER:
  354. return Permissions.treeFeller(player);
  355. default:
  356. return false;
  357. }
  358. }
  359. public @NotNull List<PrimarySkillType> getChildSkills() {
  360. return CHILD_SKILLS;
  361. }
  362. public @NotNull ImmutableList<PrimarySkillType> getNonChildSkills() {
  363. return NON_CHILD_SKILLS;
  364. }
  365. public @NotNull ImmutableList<PrimarySkillType> getCombatSkills() {
  366. return COMBAT_SKILLS;
  367. }
  368. public @NotNull ImmutableList<PrimarySkillType> getGatheringSkills() {
  369. return GATHERING_SKILLS;
  370. }
  371. public @NotNull ImmutableList<PrimarySkillType> getMiscSkills() {
  372. return MISC_SKILLS;
  373. }
  374. }