unitFps.js 16 KB

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