unitFps.js 16 KB

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