unitFps.js 17 KB

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