unitFps.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483
  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 throttlePacketsData = {};
  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. console.log("DEBUG: unitFps -> constructor");
  30. //-------------------------------------
  31. // Basic internal functions
  32. //-------------------------------------
  33. const isEntityBlocked = (gameId) => !!((blockedPlayers.has(gameId) || blockedNpcs.has(gameId) || blockedSummons.has(gameId) || blockedServants.has(gameId)));
  34. const changeShakeState = () => mod.clientInterface.configureCameraShake(!!data.activeMode.blockShakeEffects);
  35. const isMe = (gameId) => mod.game.me.is(gameId);
  36. const meInCombat = () => mod.game.me.inCombat;
  37. const isDropBlockable = (event) => {
  38. if (data.activeMode.blockDropItems && data.activeMode.blockDropItemsOptions) {
  39. if (data.activeMode.blockDropItemsOptions.all) {
  40. return true;
  41. }
  42. else if (data.activeMode.blockDropItemsOptions.templateId && utils.arraysHasIntersect(event.templateId, data.activeMode.blockDropItemsOptions.templateId)) {
  43. return true;
  44. }
  45. }
  46. return false;
  47. };
  48. const isCollectionBlockable = () => {
  49. if (data.activeMode.blockCollections)
  50. return true;
  51. return false;
  52. };
  53. const isServantBlockable = (event) => {
  54. if (data.activeMode.blockOwnServants && isMe(event.ownerId)) {
  55. return true;
  56. }
  57. else if (data.activeMode.blockAreaServants) {
  58. return true;
  59. }
  60. return false;
  61. };
  62. const isSummonsBlockable = (event) => {
  63. if (data.activeMode.blockOwnSummons && isMe(event.owner)) {
  64. return true;
  65. }
  66. else if (data.activeMode.blockAreaSummons && !isMe(event.owner)) {
  67. return true;
  68. }
  69. return false;
  70. };
  71. const isNpcBlockable = (event) => {
  72. if (data.activeMode.blockNpcs && data.activeMode.blockNpcsOptions) {
  73. if (utils.arraysHasIntersect(event.templateId, data.activeMode.blockNpcsOptions.templateId)) {
  74. return true;
  75. }
  76. else if (utils.arraysHasIntersect(event.huntingZoneId, data.activeMode.blockNpcsOptions.huntingZoneId)) {
  77. return true;
  78. }
  79. }
  80. return false;
  81. };
  82. const isUserBlockable = (event) => {
  83. if (data.activeMode.blockPlayers && data.activeMode.blockPlayersOptions) {
  84. if (data.activeMode.blockPlayersOptions.all) {
  85. return true;
  86. }
  87. else if (data.activeMode.blockPlayersOptions.class) {
  88. if (utils.arraysHasIntersect(data.userTemplateToClassMap[event.templateId], data.activeMode.blockPlayersOptions.class)) {
  89. return true;
  90. }
  91. }
  92. else if (data.activeMode.blockPlayersOptions.name) {
  93. if (utils.arraysHasIntersect(event.name, data.activeMode.blockPlayersOptions.class)) {
  94. return true;
  95. }
  96. }
  97. }
  98. return false;
  99. };
  100. //-------------------------------------
  101. // Handlers for hooks
  102. //-------------------------------------
  103. const dropHandler = (type, event) => {
  104. switch (type) {
  105. case (ENTITY_HOOK_TYPE.DESPAWN):
  106. blockedDrop.delete(event.gameId);
  107. break;
  108. case (ENTITY_HOOK_TYPE.SPAWN):
  109. if (isDropBlockable(event)) {
  110. blockedDrop.add(event.gameId);
  111. return false;
  112. }
  113. break;
  114. }
  115. };
  116. // eslint-disable-next-line no-unused-vars
  117. const collectionHandler = (type, event) => {
  118. switch (type) {
  119. case (ENTITY_HOOK_TYPE.DESPAWN):
  120. break;
  121. case (ENTITY_HOOK_TYPE.SPAWN):
  122. if (isCollectionBlockable()) {
  123. return false;
  124. }
  125. break;
  126. }
  127. };
  128. const servantsHandler = (type, event) => {
  129. switch (type) {
  130. case (ENTITY_HOOK_TYPE.DESPAWN):
  131. blockedServants.delete(event.gameId);
  132. break;
  133. case (ENTITY_HOOK_TYPE.SPAWN):
  134. if (isServantBlockable(event)) {
  135. blockedServants.add(event.gameId);
  136. return false;
  137. }
  138. }
  139. };
  140. const npcHandler = (type, event) => {
  141. switch (type) {
  142. case (ENTITY_HOOK_TYPE.DESPAWN):
  143. if (!blockedNpcs.has(event.gameId) && data.activeMode.blockNpcsDeathAnimations && event.type === DESPAWN_TYPES.DEAD) {
  144. event.type = DESPAWN_TYPES.OUTOFVIEW;
  145. return true;
  146. }
  147. blockedNpcs.delete(event.gameId);
  148. break;
  149. case (ENTITY_HOOK_TYPE.SPAWN):
  150. if(tracker.spawnedSummons.has(event.gameId) && isSummonsBlockable(event)) {
  151. blockedSummons.add(event.gameId);
  152. return false;
  153. }
  154. else if (isNpcBlockable(event)) {
  155. blockedNpcs.add(event.gameId);
  156. return false;
  157. }
  158. break;
  159. }
  160. };
  161. const userHandler = (type, event) => {
  162. switch (type) {
  163. case (ENTITY_HOOK_TYPE.DESPAWN):
  164. blockedPlayers.delete(event.gameId);
  165. break;
  166. case (ENTITY_HOOK_TYPE.SPAWN):
  167. if (isUserBlockable(event)) {
  168. blockedPlayers.add(event.gameId);
  169. return false;
  170. }
  171. break;
  172. }
  173. };
  174. const projectileHandler = (event) => {
  175. if (isEntityBlocked(event.gameId)) return false;
  176. if (data.activeMode.blockProjectiles && data.activeMode.blockProjectilesOptions) {
  177. if (data.activeMode.blockProjectilesOptions.players && tracker.spawnedPlayers.has(event.gameId)) return false;
  178. }
  179. };
  180. const blockAdditionalSkillEffectsHandler = (event) => {
  181. if (isEntityBlocked(event.gameId)) return false;
  182. if (data.activeMode.blockAdditionalSkillEffects && data.activeMode.blockAdditionalSkillEffectsOptions) {
  183. if (data.activeMode.blockAdditionalSkillEffectsOptions.players && tracker.spawnedPlayers.has(event.gameId)) return false;
  184. if (data.activeMode.blockAdditionalSkillEffectsOptions.own && isMe(event.gameId)) return false;
  185. }
  186. };
  187. const smtHandler = (event) => (
  188. (data.activeMode.blockAnnoyingScreenMessages && data.smtData.has(mod.parseSystemMessage(event.message).id))
  189. ? false
  190. : undefined
  191. );
  192. const inventoryHandler = () => (
  193. (data.activeMode.blockInventoryInCombat && meInCombat()) ? false : undefined
  194. );
  195. const blockUselessPacketsHandler = () => (
  196. (data.activeMode.blockUselessPackets) ? false : undefined
  197. );
  198. const throttlePacketsHandler = (name, code, data) => {
  199. // eslint-disable-next-line no-magic-numbers
  200. let needBlock = (data.activeMode.throttleSomePackets && throttlePacketsData[name] && (Buffer.compare(throttlePacketsData[name], data) === 0));
  201. throttlePacketsData[name] = data;
  202. return needBlock ? true : undefined;
  203. };
  204. const abnormalsHandler = (event) => {
  205. if ((data.activeMode.blockAreaBuffs && !isMe(event.target)) || isEntityBlocked(event.target)) return false;
  206. if (data.activeMode.blockHuntingRewardsBuffs && data.huntingRewardsBuffs.has(event.id)) return false;
  207. if (data.activeMode.blockShapeChangeBuffs && data.shapeChangersBuffs.has(event.id)) return false;
  208. if (data.activeMode.blockOnScreenEffectsBuffs && data.onScreenEffectsBuffs.has(event.id)) return false;
  209. };
  210. const blockHpPopups = (event) => {
  211. if (data.activeMode.blockHpPopups && isMe(event.target)) {
  212. event.type = 10;
  213. return true;
  214. }
  215. };
  216. const blockMpPopups = (event) => {
  217. if (data.activeMode.blockMpPopups && isMe(event.target)) {
  218. event.type = 0;
  219. return true;
  220. }
  221. };
  222. const eachSkillResultHandler = (event) => {
  223. if (isMe(event.source) || isMe(event.owner)) {
  224. let res = undefined;
  225. if (data.activeMode.blockOwnHits) {
  226. event.skill.id = 0;
  227. event.templateId = 0;
  228. event.superArmorId = 0;
  229. event.hitCylinderId = 0;
  230. event.crit = false;
  231. event.stackExplode = false;
  232. event.superArmor = false;
  233. event.time = 0;
  234. event.type = 0;
  235. event.noctEffect = 0;
  236. res = true;
  237. }
  238. if (data.activeMode.blockDamageNumbers) {
  239. // eslint-disable-next-line no-magic-numbers
  240. event.value = BigInt(0);
  241. res = true;
  242. }
  243. return res;
  244. }
  245. else if (
  246. data.activeMode.blockAreaHits && (tracker.spawnedPlayers.has(event.owner) || tracker.spawnedPlayers.has(event.source))
  247. && !isMe(event.target) && !isMe(event.source) && !isMe(event.owner)
  248. ) {
  249. event.skill.id = 0;
  250. event.templateId = 0;
  251. event.superArmorId = 0;
  252. event.hitCylinderId = 0;
  253. event.crit = false;
  254. event.stackExplode = false;
  255. event.superArmor = false;
  256. event.time = 0;
  257. event.type = 0;
  258. event.noctEffect = 0;
  259. return true;
  260. }
  261. };
  262. const fontSwapHandler = () => (data.activeMode.blockDamageNumbers ? false : undefined);
  263. const dropIfBlockedHandler = (event) => {
  264. let id = event.target || event.gameId;
  265. if (isEntityBlocked(id)) return false;
  266. };
  267. const actionHandler = (event) => {
  268. if (isEntityBlocked(event.gameId)) return false;
  269. };
  270. const appearanceChangeHandler = (event) => {
  271. if (isEntityBlocked(event.gameId) || data.activeMode.blockCustomAppearanceChanges) return false;
  272. };
  273. const achievementHandler = () => ((data.activeMode.blockAchievementsInCombat && meInCombat()) ? false : undefined);
  274. const cleanup = () => {
  275. console.log("DEBUG: unitFps -> cleanup");
  276. blockedPlayers.clear();
  277. blockedNpcs.clear();
  278. blockedSummons.clear();
  279. blockedServants.clear();
  280. blockedDrop.clear();
  281. };
  282. //-------------------------------------
  283. // Simple hooks
  284. //-------------------------------------
  285. //Simple basic hooks
  286. data.throttlePacketsData.forEach(packet => { mod.hook(packet, RAW_HOOK_MODE.PAYLOAD, HOOK_SETTINGS.LAST, throttlePacketsHandler); });
  287. data.lockedPacketsData.forEach(packet => { mod.hook(packet, RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, blockUselessPacketsHandler); });
  288. mod.hook(...proto.getData("S_SYSTEM_MESSAGE"), HOOK_SETTINGS.LAST, smtHandler);
  289. mod.hook("C_SHOW_ITEMLIST", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, inventoryHandler);
  290. mod.hook("S_INVEN_USERDATA", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, inventoryHandler);
  291. mod.hook("S_ITEMLIST", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, inventoryHandler);
  292. mod.hook("S_UPDATE_ACHIEVEMENT_PROGRESS", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, achievementHandler);
  293. mod.hook("S_LOAD_TOPO", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.FIRST, cleanup);
  294. //Basic spawn handling
  295. mod.hook(...proto.getData("S_DESPAWN_COLLECTION"), HOOK_SETTINGS.LAST, collectionHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  296. mod.hook(...proto.getData("S_SPAWN_COLLECTION"), HOOK_SETTINGS.LAST, collectionHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  297. mod.hook(...proto.getData("S_REQUEST_SPAWN_SERVANT"), HOOK_SETTINGS.LAST, servantsHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  298. mod.hook(...proto.getData("S_REQUEST_DESPAWN_SERVANT"), HOOK_SETTINGS.LAST, servantsHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  299. mod.hook(...proto.getData("S_SPAWN_NPC"), HOOK_SETTINGS.LAST, npcHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  300. mod.hook(...proto.getData("S_DESPAWN_NPC"), HOOK_SETTINGS.LAST, npcHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  301. mod.hook(...proto.getData("S_SPAWN_USER"), HOOK_SETTINGS.FIRST, userHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  302. mod.hook(...proto.getData("S_DESPAWN_USER"), HOOK_SETTINGS.FIRST, userHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  303. mod.hook(...proto.getData("S_SPAWN_DROPITEM"), HOOK_SETTINGS.LAST, dropHandler.bind(null, ENTITY_HOOK_TYPE.SPAWN));
  304. mod.hook(...proto.getData("S_DESPAWN_DROPITEM"), HOOK_SETTINGS.LAST, dropHandler.bind(null, ENTITY_HOOK_TYPE.DESPAWN));
  305. //-------------------------------------
  306. // Cleanup hooks for hidden entities
  307. //-------------------------------------
  308. mod.hook(...proto.getData("S_SOCIAL"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  309. mod.hook(...proto.getData("S_USER_STATUS"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  310. mod.hook(...proto.getData("S_USER_MOVETYPE"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  311. mod.hook(...proto.getData("S_FEARMOVE_STAGE"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  312. mod.hook(...proto.getData("S_FEARMOVE_END"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  313. mod.hook(...proto.getData("S_USER_LOCATION_IN_ACTION"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  314. mod.hook(...proto.getData("S_USER_LOCATION"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  315. mod.hook(...proto.getData("S_CREATURE_ROTATE"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  316. mod.hook(...proto.getData("S_CREATURE_LIFE"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  317. mod.hook(...proto.getData("S_NPC_LOCATION"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  318. mod.hook(...proto.getData("S_MOUNT_VEHICLE"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  319. mod.hook(...proto.getData("S_UNMOUNT_VEHICLE"), HOOK_SETTINGS.LAST, dropIfBlockedHandler);
  320. //---------------------------------------
  321. // Combined hooks with complicated logic
  322. //---------------------------------------
  323. mod.hook(...proto.getData("S_INSTANCE_ARROW"), RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, blockAdditionalSkillEffectsHandler);
  324. mod.hook(...proto.getData("S_CREATURE_CHANGE_HP"), HOOK_SETTINGS.LAST, blockHpPopups);
  325. mod.hook(...proto.getData("S_PLAYER_CHANGE_MP"), HOOK_SETTINGS.LAST, blockMpPopups);
  326. mod.hook(...proto.getData("S_EACH_SKILL_RESULT"), HOOK_SETTINGS.LAST, eachSkillResultHandler);
  327. mod.hook("S_FONT_SWAP_INFO", RAW_HOOK_MODE.EVENT, HOOK_SETTINGS.LAST, fontSwapHandler);
  328. mod.hook(...proto.getData("S_ACTION_STAGE"), HOOK_SETTINGS.LAST, actionHandler);
  329. mod.hook(...proto.getData("S_ACTION_END"), HOOK_SETTINGS.LAST, actionHandler);
  330. mod.hook(...proto.getData("S_ABNORMALITY_BEGIN"), HOOK_SETTINGS.LAST, abnormalsHandler);
  331. mod.hook(...proto.getData("S_ABNORMALITY_END"), HOOK_SETTINGS.LAST, abnormalsHandler);
  332. mod.hook(...proto.getData("S_ABNORMALITY_FAIL"), HOOK_SETTINGS.LAST, abnormalsHandler);
  333. mod.hook(...proto.getData("S_ABNORMALITY_DAMAGE_ABSORB"), HOOK_SETTINGS.LAST, abnormalsHandler);
  334. mod.hook(...proto.getData("S_ABNORMALITY_RESIST"), HOOK_SETTINGS.LAST, abnormalsHandler);
  335. mod.hook(...proto.getData("S_SPAWN_PROJECTILE"), HOOK_SETTINGS.LAST, projectileHandler);
  336. mod.hook(...proto.getData("S_START_USER_PROJECTILE"), HOOK_SETTINGS.LAST, projectileHandler);
  337. mod.hook(...proto.getData("S_END_USER_PROJECTILE"), HOOK_SETTINGS.LAST, projectileHandler);
  338. mod.hook(...proto.getData("S_DESPAWN_PROJECTILE"), HOOK_SETTINGS.LAST, projectileHandler);
  339. mod.hook(...proto.getData("S_USER_APPEARANCE_CHANGE"), HOOK_SETTINGS.LAST, appearanceChangeHandler);
  340. mod.hook(...proto.getData("S_USER_EXTERNAL_CHANGE"), HOOK_SETTINGS.LAST, appearanceChangeHandler);
  341. mod.hook(...proto.getData("S_UNICAST_TRANSFORM_DATA"), HOOK_SETTINGS.LAST, appearanceChangeHandler);
  342. mod.hook(...proto.getData("S_USER_CHANGE_FACE_CUSTOM"), HOOK_SETTINGS.LAST, appearanceChangeHandler);
  343. deps.data.on(EVENTS.RECONFIGURE, () => {
  344. console.log("DEBUG: unitFps -> constructor -> reconfigureEvent");
  345. changeShakeState();
  346. if (data.prevMode.blockCollections !== data.activeMode.blockCollections) {
  347. switch (data.activeMode.blockCollections) {
  348. case (true):
  349. for (const value of tracker.spawnedCollections.values()) {
  350. mod.send(...proto.getData("S_DESPAWN_COLLECTION"), value);
  351. }
  352. break;
  353. case (false):
  354. for (const value of tracker.spawnedCollections.values()) {
  355. mod.send(...proto.getData("S_SPAWN_COLLECTION"), value);
  356. }
  357. break;
  358. }
  359. }
  360. for (const [key, value] of tracker.spawnedDrop.entries()) {
  361. let needBlock = isDropBlockable(value);
  362. if (needBlock && !blockedDrop.has(key)) {
  363. mod.send(...proto.getData("S_DESPAWN_DROPITEM"), value);
  364. blockedDrop.add(key);
  365. }
  366. else if (!needBlock && blockedDrop.has(key)) {
  367. mod.send(...proto.getData("S_SPAWN_DROPITEM"), value);
  368. blockedDrop.delete(key);
  369. }
  370. }
  371. for (const [key, value] of tracker.spawnedPlayers.entries()) {
  372. let needBlock = isUserBlockable(value);
  373. if (needBlock && !blockedPlayers.has(key)) {
  374. mod.send(...proto.getData("S_DESPAWN_USER"), value);
  375. blockedPlayers.add(key);
  376. }
  377. else if (!needBlock && blockedPlayers.has(key)) {
  378. mod.send(...proto.getData("S_SPAWN_USER"), value);
  379. blockedPlayers.delete(key);
  380. }
  381. }
  382. for (const [key, value] of tracker.spawnedServants.entries()) {
  383. let needBlock = isServantBlockable(value);
  384. if (needBlock && !blockedServants.has(key)) {
  385. mod.send(...proto.getData("S_REQUEST_DESPAWN_SERVANT"), value);
  386. blockedServants.add(key);
  387. }
  388. else if (!needBlock && blockedServants.has(key)) {
  389. mod.send(...proto.getData("S_REQUEST_SPAWN_SERVANT"), value);
  390. blockedServants.remove(key);
  391. }
  392. }
  393. for (const [key, value] of tracker.spawnedSummons.entries()) {
  394. let needBlock = isSummonsBlockable(value);
  395. if (needBlock && !blockedSummons.has(key)) {
  396. mod.send(...proto.getData("S_DESPAWN_NPC"), value);
  397. blockedSummons.add(key);
  398. }
  399. else if (!needBlock && blockedSummons.has(key)) {
  400. mod.send(...proto.getData("S_SPAWN_NPC"), value);
  401. blockedSummons.remove(key);
  402. }
  403. }
  404. for (const [key, value] of tracker.spawnedNPCS.entries()) {
  405. let needBlock = isSummonsBlockable(value);
  406. if (needBlock && !blockedNpcs.has(key)) {
  407. mod.send(...proto.getData("S_DESPAWN_NPC"), value);
  408. blockedNpcs.add(key);
  409. }
  410. else if (!needBlock && blockedNpcs.has(key)) {
  411. mod.send(...proto.getData("S_SPAWN_NPC"), value);
  412. blockedNpcs.remove(key);
  413. }
  414. }
  415. });
  416. }
  417. }
  418. module.exports = unitFps;