unitFps.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  1. "use strict";
  2. /*
  3. * Unit for Fps Manager. Managing client state based on module settings
  4. * Author: SaltyMonkey
  5. * Contributors:
  6. */
  7. /**
  8. * @typedef {import("../fpsManager.js").deps} deps
  9. */
  10. const utils = require("./helpers/utils");
  11. const { ENTITY_HOOK_TYPE, RAW_HOOK_MODE, HOOK_SETTINGS, DESPAWN_TYPES, EVENTS } = require("./helpers/enums");
  12. class unitFps {
  13. /**
  14. *Creates an instance of unitFps
  15. * @param {deps} deps dependencies
  16. * @memberof unitFps
  17. */
  18. constructor(deps) {
  19. const data = deps.data;
  20. const mod = deps.mod;
  21. const tracker = deps.tracker;
  22. const proto = deps.proto;
  23. let throttledDAta = {};
  24. const blockedPlayers = new Set();
  25. const blockedNpcs = new Set();
  26. const blockedSummons = new Set();
  27. const blockedServants = new Set();
  28. const blockedDrop = new Set();
  29. //-------------------------------------
  30. // Basic internal functions
  31. //-------------------------------------
  32. const isEntityBlocked = (gameId) => !!((blockedPlayers.has(gameId) || blockedNpcs.has(gameId) || blockedSummons.has(gameId)));
  33. const changeShakeState = (state) => mod.clientInterface.configureCameraShake(state);
  34. const isMe = (gameId) => mod.game.me.is(gameId);
  35. const meInCombat = () => mod.game.me.inCombat;
  36. //-------------------------------------
  37. // Handlers for hooks
  38. //-------------------------------------
  39. const dropHandler = (type, event) => {
  40. switch (type) {
  41. case (ENTITY_HOOK_TYPE.DESPAWN):
  42. blockedDrop.delete(event.gameId);
  43. break;
  44. case (ENTITY_HOOK_TYPE.SPAWN):
  45. if (data.activeMode.blockCollections && data.activeMode.blockDropItemsOptions) {
  46. if (data.activeMode.blockDropItemsOptions.all) {
  47. blockedDrop.add(event.gameId);
  48. return false;
  49. }
  50. else if (data.activeMode.blockDropItemsOptions.templateId && utils.arraysHasIntersect(event.templateId, data.activeMode.blockDropItemsOptions.templateId)) {
  51. blockedDrop.add(event.gameId);
  52. return false;
  53. }
  54. }
  55. break;
  56. }
  57. };
  58. // eslint-disable-next-line no-unused-vars
  59. const collectionHandler = (type, event) => {
  60. switch (type) {
  61. case (ENTITY_HOOK_TYPE.DESPAWN):
  62. break;
  63. case (ENTITY_HOOK_TYPE.SPAWN):
  64. if (data.activeMode.blockCollections) {
  65. return false;
  66. }
  67. }
  68. };
  69. const servantsHandler = (type, event) => {
  70. switch (type) {
  71. case (ENTITY_HOOK_TYPE.DESPAWN):
  72. blockedServants.delete(event.gameId);
  73. break;
  74. case (ENTITY_HOOK_TYPE.SPAWN):
  75. if (data.activeMode.blockOwnServants && isMe(event.ownerId)) {
  76. blockedServants.add(event.gameId);
  77. return false;
  78. }
  79. else if (data.activeMode.blockAreaServants) {
  80. blockedServants.add(event.gameId);
  81. return false;
  82. }
  83. }
  84. };
  85. const npcsHandler = (type, event) => {
  86. switch (type) {
  87. case (ENTITY_HOOK_TYPE.DESPAWN):
  88. if (!blockedNpcs.has(event.gameId) && data.activeMode.blockNpcsDeathAnimations && event.type === DESPAWN_TYPES.DEAD) {
  89. event.type = DESPAWN_TYPES.OUTOFVIEW;
  90. return true;
  91. }
  92. blockedNpcs.delete(event.gameId);
  93. break;
  94. case (ENTITY_HOOK_TYPE.SPAWN):
  95. if (tracker.summons.has(event.gameId)) {
  96. if (data.activeMode.blockOwnSummons && isMe(event.owner)) {
  97. blockedSummons.add(event.gameId);
  98. return false;
  99. }
  100. else if (data.activeMode.blockAreaSummons && !isMe(event.owner)) {
  101. blockedSummons.add(event.gameId);
  102. return false;
  103. }
  104. }
  105. if (data.activeMode.blockNpcs && data.activeMode.blockNpcsOptions) {
  106. if (utils.arraysHasIntersect(event.templateId, data.activeMode.blockNpcsOptions.templateId)) {
  107. blockedNpcs.add(event.gameId);
  108. return false;
  109. }
  110. else if (utils.arraysHasIntersect(event.huntingZoneId, data.activeMode.blockNpcsOptions.huntingZoneId)) {
  111. blockedNpcs.add(event.gameId);
  112. return false;
  113. }
  114. }
  115. break;
  116. }
  117. };
  118. const userHandler = (type, event) => {
  119. switch (type) {
  120. case (ENTITY_HOOK_TYPE.DESPAWN):
  121. blockedPlayers.delete(event.gameId);
  122. break;
  123. case (ENTITY_HOOK_TYPE.SPAWN):
  124. if (data.activeMode.blockPlayers && data.activeMode.blockPlayersOptions) {
  125. if (data.activeMode.blockPlayersOptions.all) {
  126. blockedPlayers.add(event.gameId);
  127. return false;
  128. }
  129. else if (data.activeMode.blockPlayersOptions.class) {
  130. if (utils.arraysHasIntersect(data.userTemplateToClassMap[event.templateId], data.activeMode.blockPlayersOptions.class)) {
  131. blockedPlayers.add(event.gameId);
  132. return false;
  133. }
  134. }
  135. }
  136. break;
  137. }
  138. };
  139. const projectileHandler = (event) => {
  140. if (isEntityBlocked(event.gameId)) return false;
  141. if (data.activeMode.blockProjectiles && data.activeMode.blockProjectilesOptions) {
  142. if (data.activeMode.blockProjectilesOptions.players && tracker.users.has(event.gameId)) return false;
  143. }
  144. };
  145. const blockAdditionalSkillEffectsHandler = (event) => {
  146. if (isEntityBlocked(event.gameId)) return false;
  147. if (data.activeMode.blockAdditionalSkillEffects && data.activeMode.blockAdditionalSkillEffectsOptions) {
  148. if (data.activeMode.blockProjectilesOptions.players && tracker.users.has(event.gameId)) return false;
  149. if (data.activeMode.blockProjectilesOptions.own && isMe(event.gameId)) return false;
  150. }
  151. };
  152. const blockAnnoyingScreenMessages = (event) => (
  153. (data.activeMode.blockAnnoyingScreenMessages && data.smtsSet.has(mod.parseSystemMessage(event.message).id))
  154. ? false
  155. : undefined
  156. );
  157. const blockInventoryInCombat = () => (
  158. (data.activeMode.blockInventoryInCombat && meInCombat()) ? false : undefined
  159. );
  160. const blockUselessPackets = () => (
  161. (data.activeMode.blockUselessPackets) ? false : undefined
  162. );
  163. const throttlePackets = (name, code, data) => {
  164. // eslint-disable-next-line no-magic-numbers
  165. let needBlock = (data.activeMode.throttleSomePackets && throttledDAta[name] && (Buffer.compare(throttledDAta[name], data) === 0));
  166. throttledDAta[name] = data;
  167. return needBlock ? true : undefined;
  168. };
  169. const abnormalsHandler = (event) => {
  170. if ((data.activeMode.blockAreaBuffs && !isMe(event.target)) || isEntityBlocked(event.target)) return false;
  171. if (data.activeMode.blockHuntingRewardsBuffs && data.huntingRewardsBuffs.has(event.id)) return false;
  172. if (data.activeMode.blockShapeChangeBuffs && data.shapeChangersBuffs.has(event.id)) return false;
  173. if (data.activeMode.blockOnScreenEffectsBuffs && data.onScreenEffectsBuffs.has(event.id)) return false;
  174. };
  175. const blockHpPopups = (event) => {
  176. if (data.activeMode.blockHpPopups && isMe(event.target)) {
  177. event.type = 10;
  178. return true;
  179. }
  180. };
  181. const blockMpPopups = (event) => {
  182. if (data.activeMode.blockMpPopups && isMe(event.target)) {
  183. event.type = 0;
  184. return true;
  185. }
  186. };
  187. const eachSkillResultHandler = (event) => {
  188. if (isMe(event.source) || isMe(event.owner)) {
  189. let res = undefined;
  190. if (data.activeMode.blockOwnHits) {
  191. event.skill.id = 0;
  192. event.templateId = 0;
  193. event.superArmorId = 0;
  194. event.hitCylinderId = 0;
  195. event.crit = false;
  196. event.stackExplode = false;
  197. event.superArmor = false;
  198. event.time = 0;
  199. event.type = 0;
  200. event.noctEffect = 0;
  201. res = true;
  202. }
  203. if (data.activeMode.blockDamageNumbers) {
  204. // eslint-disable-next-line no-magic-numbers
  205. event.value = BigInt(0);
  206. res = true;
  207. }
  208. return res;
  209. }
  210. else if (
  211. data.activeMode.blockAreaHits && (tracker.users.has(event.owner) || tracker.users.has(event.source))
  212. && !isMe(event.target) && !isMe(event.source) && !isMe(event.owner)
  213. ) {
  214. event.skill.id = 0;
  215. event.templateId = 0;
  216. event.superArmorId = 0;
  217. event.hitCylinderId = 0;
  218. event.crit = false;
  219. event.stackExplode = false;
  220. event.superArmor = false;
  221. event.time = 0;
  222. event.type = 0;
  223. event.noctEffect = 0;
  224. return true;
  225. }
  226. };
  227. const dropIfBlockedHandler = (event) => {
  228. let id = event.target || event.gameId;
  229. if (isEntityBlocked(id)) return false;
  230. };
  231. const actionHandler = (event) => {
  232. if (isEntityBlocked(event.gameId)) return false;
  233. };
  234. const appearanceChangeHandler = (event) => {
  235. if (isEntityBlocked(event.gameId) || data.activeMode.blockCustomAppearanceChanges) return false;
  236. };
  237. const blockAchievementsInCombat = () => ((data.activeMode.blockAchievementSpamInCombat && meInCombat()) ? false : undefined);
  238. const cleanup = () => {
  239. blockedPlayers.clear();
  240. blockedNpcs.clear();
  241. blockedSummons.clear();
  242. blockedServants.clear();
  243. blockedDrop.clear();
  244. };
  245. //-------------------------------------
  246. // Simple hooks
  247. //-------------------------------------
  248. //Simple basic hooks
  249. data.throttlePacketsData.forEach(packet => { mod.hook(packet, RAW_HOOK_MODE.PAYLOAD, HOOK_SETTINGS.LAST, throttlePackets); });
  250. data.lockedPacketsData.forEach(packet => { mod.hook(packet, RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, blockUselessPackets); });
  251. mod.hook(...proto.getData("S_SYSTEM_MESSAGE"), HOOK_SETTINGS.LAST, blockAnnoyingScreenMessages);
  252. mod.hook("C_SHOW_ITEMLIST", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, blockInventoryInCombat);
  253. mod.hook("S_INVEN_USERDATA", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, blockInventoryInCombat);
  254. mod.hook("S_ITEMLIST", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, blockInventoryInCombat);
  255. mod.hook("S_UPDATE_ACHIEVEMENT_PROGRESS", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, blockAchievementsInCombat);
  256. mod.hook("S_LOAD_TOPO", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.FIRST, cleanup);
  257. //Basic spawn handling
  258. mod.hook(...proto.getData("S_DESPAWN_COLLECTION"), HOOK_SETTINGS.LAST, collectionHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  259. mod.hook(...proto.getData("S_SPAWN_COLLECTION"), HOOK_SETTINGS.LAST, collectionHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  260. mod.hook(...proto.getData("S_REQUEST_SPAWN_SERVANT"), HOOK_SETTINGS.LAST, servantsHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  261. mod.hook(...proto.getData("S_REQUEST_DESPAWN_SERVANT"), HOOK_SETTINGS.LAST, servantsHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  262. mod.hook(...proto.getData("S_SPAWN_NPC"), HOOK_SETTINGS.LAST, npcsHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  263. mod.hook(...proto.getData("S_DESPAWN_NPC"), HOOK_SETTINGS.LAST, npcsHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  264. mod.hook(...proto.getData("S_SPAWN_USER"), HOOK_SETTINGS.FIRST, userHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  265. mod.hook(...proto.getData("S_DESPAWN_USER"), HOOK_SETTINGS.FIRST, userHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  266. mod.hook(...proto.getData("S_SPAWN_DROPITEM"), HOOK_SETTINGS.LAST, dropHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  267. mod.hook(...proto.getData("S_DESPAWN_DROPITEM"), HOOK_SETTINGS.LAST, dropHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  268. //-------------------------------------
  269. // Cleanup hooks for entities
  270. //-------------------------------------
  271. mod.hook(...proto.getData("S_SOCIAL"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  272. mod.hook(...proto.getData("S_USER_STATUS"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  273. mod.hook(...proto.getData("S_USER_MOVETYPE"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  274. mod.hook(...proto.getData("S_FEARMOVE_STAGE"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  275. mod.hook(...proto.getData("S_FEARMOVE_END"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  276. mod.hook(...proto.getData("S_USER_LOCATION_IN_ACTION"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  277. mod.hook(...proto.getData("S_USER_LOCATION"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  278. //---------------------------------------
  279. // Combined hooks with complicated logic
  280. //---------------------------------------
  281. mod.hook(...proto.getData("S_INSTANCE_ARROW"), RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, blockAdditionalSkillEffectsHandler);
  282. mod.hook(...proto.getData("S_CREATURE_CHANGE_HP"), HOOK_SETTINGS.LAST, blockHpPopups);
  283. mod.hook(...proto.getData("S_PLAYER_CHANGE_MP"), HOOK_SETTINGS.LAST, blockMpPopups);
  284. mod.hook(...proto.getData("S_EACH_SKILL_RESULT"), HOOK_SETTINGS.LAST, eachSkillResultHandler);
  285. mod.hook(...proto.getData("S_ACTION_STAGE"), HOOK_SETTINGS.LAST, actionHandler);
  286. mod.hook(...proto.getData("S_ACTION_END"), HOOK_SETTINGS.LAST, actionHandler);
  287. mod.hook(...proto.getData("S_ABNORMALITY_BEGIN"), HOOK_SETTINGS.LAST, abnormalsHandler);
  288. mod.hook(...proto.getData("S_ABNORMALITY_END"), HOOK_SETTINGS.LAST, abnormalsHandler);
  289. mod.hook(...proto.getData("S_ABNORMALITY_FAIL"), HOOK_SETTINGS.LAST, abnormalsHandler);
  290. mod.hook(...proto.getData("S_ABNORMALITY_DAMAGE_ABSORB"), HOOK_SETTINGS.LAST, abnormalsHandler);
  291. mod.hook(...proto.getData("S_ABNORMALITY_RESIST"), HOOK_SETTINGS.LAST, abnormalsHandler);
  292. mod.hook(...proto.getData("S_SPAWN_PROJECTILE"), HOOK_SETTINGS.LAST, projectileHandler);
  293. mod.hook(...proto.getData("S_START_USER_PROJECTILE"), HOOK_SETTINGS.LAST, projectileHandler);
  294. mod.hook(...proto.getData("S_END_USER_PROJECTILE"), HOOK_SETTINGS.LAST, projectileHandler);
  295. mod.hook(...proto.getData("S_DESPAWN_PROJECTILE"), HOOK_SETTINGS.LAST, projectileHandler);
  296. mod.hook(...proto.getData("S_USER_APPEARANCE_CHANGE"), HOOK_SETTINGS.LAST, appearanceChangeHandler);
  297. mod.hook(...proto.getData("S_USER_EXTERNAL_CHANGE"), HOOK_SETTINGS.LAST, appearanceChangeHandler);
  298. mod.hook(...proto.getData("S_UNICAST_TRANSFORM_DATA"), HOOK_SETTINGS.LAST, appearanceChangeHandler);
  299. mod.hook(...proto.getData("S_USER_CHANGE_FACE_CUSTOM"), HOOK_SETTINGS.LAST, appearanceChangeHandler);
  300. deps.data.on(EVENTS.RECONFIGURE, (oldMode, newMode) => {
  301. if (oldMode.blockShakeEffects !== newMode.blockShakeEffects) {
  302. changeShakeState(newMode.blockShakeEffects);
  303. }
  304. //respawn collections back (nothing to analyze so we are just using original data )
  305. if (oldMode.blockCollections !== newMode.blockCollections && newMode.blockCollections === false) {
  306. for (const val of tracker.collections.values()) {
  307. mod.send(...proto.getData("S_SPAWN_COLLECTION"), val);
  308. }
  309. }
  310. //respawn servants back
  311. if (oldMode.blockOwnServants !== newMode.blockOwnServants && newMode.blockOwnServants === false) {
  312. for (const val of tracker.blockedServants.values()) {
  313. mod.send(...proto.getData("S_REQUEST_SPAWN_SERVANT"), val);
  314. }
  315. }
  316. });
  317. }
  318. }
  319. module.exports = unitFps;