@infernus/core 0.8.7 → 0.9.0

package/src/controllers/filterscript/index.ts

@@ -1,69 +0,0 @@
-import type { IFilterScript } from "@/interfaces";
-import { logger } from "@/logger";
-import { OnGameModeExit, OnGameModeInit } from "@/wrapper/native/callbacks";
-
-const preInstallScripts: Array<IFilterScript> = [];
-const installedScripts: Array<IFilterScript> = [];
-
-export const loadUseScript = (scriptName: string): void => {
-  setTimeout(async () => {
-    try {
-      const fsIdx = preInstallScripts.findIndex((fs) => fs.name === scriptName);
-      if (fsIdx === -1) return;
-
-      const fs = preInstallScripts[fsIdx];
-      await fs.load();
-
-      preInstallScripts.splice(fsIdx, 1);
-      installedScripts.push(fs);
-    } catch (err) {
-      logger.error(`[GameMode]: script ${scriptName} load fail`);
-      logger.warn(new Error(JSON.stringify(err)));
-    }
-  });
-};
-export const unloadUseScript = (scriptName: string): void => {
-  setTimeout(async () => {
-    try {
-      const fsIdx = installedScripts.findIndex((fs) => fs.name === scriptName);
-      if (fsIdx === -1) return;
-
-      const fs = installedScripts[fsIdx];
-      await fs.unload();
-
-      installedScripts.splice(fsIdx, 1);
-      preInstallScripts.push(fs);
-    } catch (err) {
-      logger.error(`[GameMode]: script ${scriptName} unload fail`);
-      logger.warn(new Error(JSON.stringify(err)));
-    }
-  });
-};
-
-export const reloadUseScript = (scriptName: string) => {
-  unloadUseScript(scriptName);
-  loadUseScript(scriptName);
-};
-
-OnGameModeInit(() => {
-  preInstallScripts.forEach((fs) => loadUseScript(fs.name));
-});
-
-OnGameModeExit(() => {
-  installedScripts.forEach((fs) => unloadUseScript(fs.name));
-});
-
-export const useFilterScript = function (
-  plugin: IFilterScript,
-  ...options: Array<any>
-): void {
-  if (
-    preInstallScripts.some((fs) => fs === plugin) ||
-    installedScripts.some((fs) => fs === plugin)
-  ) {
-    logger.warn(`[GameMode]: script has already been applied`);
-    return;
-  }
-  plugin.load = plugin.load.bind(plugin, ...options);
-  preInstallScripts.push(plugin);
-};

package/src/controllers/gamemode/index.ts

@@ -1,277 +0,0 @@
-import {
-  OnGameModeExit,
-  OnGameModeInit,
-  OnIncomingConnection,
-} from "@/wrapper/native/callbacks";
-import * as fns from "@/wrapper/native/functions";
-import { logger } from "@/logger";
-import {
-  OnRconCommand,
-  OnRconLoginAttempt,
-  promisifyCallback,
-} from "@/utils/helperUtils";
-import { defaultCharset } from "./settings";
-import type { TCommonCallback } from "@/types";
-import {
-  loadUseScript,
-  reloadUseScript,
-  unloadUseScript,
-  useFilterScript,
-} from "../filterscript";
-import {
-  ClearBanList,
-  IsBanned,
-  IsValidNickName,
-  AllowNickNameCharacter,
-  IsNickNameCharacterAllowed,
-  AddServerRule,
-  SetServerRule,
-  IsValidServerRule,
-  RemoveServerRule,
-  GetWeaponSlot,
-  GetAvailableClasses,
-  GetPlayerClass,
-  EditPlayerClass,
-  ToggleChatTextReplacement,
-  ChatTextReplacementToggled,
-  AllowAdminTeleport,
-  IsAdminTeleportAllowed,
-  AllowInteriorWeapons,
-  AreInteriorWeaponsAllowed,
-  AreAllAnimationsEnabled,
-  EnableAllAnimations,
-} from "@infernus/wrapper";
-import type { IFilterScript } from "@/interfaces";
-
-export class GameMode {
-  static charset = defaultCharset;
-  private initialized = false;
-
-  constructor() {
-    OnGameModeInit((): void => {
-      if (this.initialized)
-        return logger.error("[GameMode]: Cannot be initialized more than once");
-      GameMode.supportAllNickname();
-      this.initialized = true;
-      this.onInit && this.onInit();
-    });
-    OnGameModeExit((): void => {
-      if (!this.initialized)
-        return logger.error("[GameMode]: Cannot unload more than once");
-      this.initialized = false;
-      this.onExit && this.onExit();
-    });
-    OnIncomingConnection(promisifyCallback(this, "onIncomingConnection"));
-    OnRconCommand(
-      promisifyCallback(this, "onRconCommand", "OnRconCommandI18n")
-    );
-    OnRconLoginAttempt(promisifyCallback(this, "onRconLoginAttempt"));
-  }
-
-  isInitialized(): boolean {
-    return this.initialized;
-  }
-
-  // do something during close/restart server, such as storage of player data
-  static exit(): void {
-    // it's restart
-    fns.GameModeExit();
-  }
-
-  // support filter script which use @infernus/core
-  static use = (plugin: IFilterScript, ...options: Array<any>) => {
-    useFilterScript(plugin, ...options);
-    return this;
-  };
-
-  static loadScript = loadUseScript;
-  static unloadScript = unloadUseScript;
-  static reloadScript = reloadUseScript;
-
-  static supportAllNickname() {
-    /**
-     * In utf8, different national languages take up different numbers of bytes,
-     * but no matter how many bytes they take up, a byte always takes up 8 bits of binary,
-     * i.e., a decimal integer up to 255.
-     */
-    for (let i = 0; i <= 255; i++) {
-      if (!GameMode.isNickNameCharacterAllowed(i))
-        GameMode.allowNickNameCharacter(i, true);
-    }
-  }
-
-  onInit?(): void;
-  onExit?(): void;
-  onIncomingConnection?(
-    playerid: number,
-    ipAddress: string,
-    port: number
-  ): TCommonCallback;
-  onRconCommand?(cmd: string): TCommonCallback;
-  onRconLoginAttempt?(
-    ip: string,
-    password: string,
-    success: boolean
-  ): TCommonCallback;
-  static allowAdminTeleport = AllowAdminTeleport;
-  static isAdminTeleportAllowed = IsAdminTeleportAllowed;
-  static allowInteriorWeapons = AllowInteriorWeapons;
-  static areInteriorWeaponsAllowed = AreInteriorWeaponsAllowed;
-  static areAllAnimationsEnabled = AreAllAnimationsEnabled;
-  static enableAllAnimations = EnableAllAnimations;
-  static enableStuntBonusForAll = fns.EnableStuntBonusForAll;
-  static enableVehicleFriendlyFire = fns.EnableVehicleFriendlyFire;
-  static enableZoneNames = fns.EnableZoneNames;
-  static disableInteriorEnterExits = fns.DisableInteriorEnterExits;
-  static setGameModeText = fns.SetGameModeText;
-  static getGravity = fns.GetGravity;
-  static setGravity = fns.SetGravity;
-  static showNameTags = fns.ShowNameTags;
-  static disableNameTagLOS = fns.DisableNameTagLOS;
-  static usePlayerPedAnims = fns.UsePlayerPedAnims;
-  static showPlayerMarkers = fns.ShowPlayerMarkers;
-  static limitPlayerMarkerRadius = fns.LimitPlayerMarkerRadius;
-  static limitGlobalChatRadius = fns.LimitGlobalChatRadius;
-  static setNameTagDrawDistance = fns.SetNameTagDrawDistance;
-  static setWeather(weather: number): number {
-    if (weather < 0 || weather > 255) {
-      logger.error("[GameMode]: The valid weather value is only 0 to 255");
-      return 0;
-    }
-    return fns.SetWeather(weather);
-  }
-  static setWorldTime(hour: number): number {
-    if (hour < 0 || hour > 23) {
-      logger.error("[GameMode]: The valid hour value is only 0 to 23");
-      return 0;
-    }
-    return fns.SetWorldTime(hour);
-  }
-  static setTeamCount = fns.SetTeamCount;
-  static sendRconCommand = fns.SendRconCommand;
-  static addPlayerClass = fns.AddPlayerClass;
-  static addPlayerClassEx = fns.AddPlayerClassEx;
-  static createExplosion(
-    X: number,
-    Y: number,
-    Z: number,
-    type: number,
-    Radius: number
-  ): number {
-    if (type < 0 || type > 13) {
-      logger.error(
-        "[GameMode]: The valid explosion type value is only 0 to 13"
-      );
-      return 0;
-    }
-    return fns.CreateExplosion(X, Y, Z, type, Radius);
-  }
-  static manualVehicleEngineAndLights = fns.ManualVehicleEngineAndLights;
-  static blockIpAddress = fns.BlockIpAddress;
-  static unBlockIpAddress = fns.UnBlockIpAddress;
-  static getServerTickRate = fns.GetServerTickRate;
-  static addSimpleModel(
-    virtualworld: number,
-    baseid: number,
-    newid: number,
-    dffname: string,
-    txdname: string
-  ): number {
-    if (this.checkSimpleModel(virtualworld, baseid, newid, dffname, txdname)) {
-      return fns.AddSimpleModel(virtualworld, baseid, newid, dffname, txdname);
-    }
-    return 0;
-  }
-  static addSimpleModelTimed(
-    virtualworld: number,
-    baseid: number,
-    newid: number,
-    dffname: string,
-    txdname: string,
-    timeon: number,
-    timeoff: number
-  ): number {
-    if (
-      this.checkSimpleModel(
-        virtualworld,
-        baseid,
-        newid,
-        dffname,
-        txdname,
-        timeon,
-        timeoff
-      )
-    ) {
-      return fns.AddSimpleModelTimed(
-        virtualworld,
-        baseid,
-        newid,
-        dffname,
-        txdname,
-        timeon,
-        timeoff
-      );
-    }
-    return 0;
-  }
-  private static checkSimpleModel(
-    virtualworld: number,
-    baseid: number,
-    newid: number,
-    dffname: string,
-    txdname: string,
-    timeon?: number,
-    timeoff?: number
-  ): number {
-    if (virtualworld < -1) {
-      logger.error("[GameMode]: AddSimpleModel - Error virtual world");
-      return 0;
-    }
-    if (baseid < 0) {
-      logger.error("[GameMode]: AddSimpleModel - Error baseid");
-      return 0;
-    }
-    if (newid > -1000 || newid < -30000) {
-      logger.error("[GameMode]: AddSimpleModel - Error newid range");
-      return 0;
-    }
-    if (dffname.trim().length < 0) {
-      logger.error("[GameMode]: AddSimpleModel - Empty dffname");
-      return 0;
-    }
-    if (txdname.trim().length < 0) {
-      logger.error("[GameMode]: AddSimpleModel - Empty txdname");
-      return 0;
-    }
-    if (timeon !== undefined && (timeon < 0 || timeon > 23)) {
-      logger.error("[GameMode]: AddSimpleModel - Error time on range");
-      return 0;
-    }
-    if (timeoff !== undefined && (timeoff < 0 || timeoff > 23)) {
-      logger.error("[GameMode]: AddSimpleModel - Error time off range");
-      return 0;
-    }
-    return 1;
-  }
-  static findModelFileNameFromCRC = fns.FindModelFileNameFromCRC;
-  static findTextureFileNameFromCRC = fns.FindTextureFileNameFromCRC;
-  static getWeaponName = fns.GetWeaponName;
-  static setObjectsDefaultCameraCollision =
-    fns.SetObjectsDefaultCameraCollision;
-  static vectorSize = fns.VectorSize;
-  static clearBanList = ClearBanList;
-  static isBanned = IsBanned;
-  static isValidNickName = IsValidNickName;
-  static allowNickNameCharacter = AllowNickNameCharacter;
-  static isNickNameCharacterAllowed = IsNickNameCharacterAllowed;
-  static addServerRule = AddServerRule;
-  static setServerRule = SetServerRule;
-  static isValidServerRule = IsValidServerRule;
-  static removeServerRule = RemoveServerRule;
-  static getWeaponSlot = GetWeaponSlot;
-  static getAvailableClasses = GetAvailableClasses;
-  static getPlayerClass = GetPlayerClass;
-  static editPlayerClass = EditPlayerClass;
-  static toggleChatTextReplacement = ToggleChatTextReplacement;
-  static chatTextReplacementToggled = ChatTextReplacementToggled;
-}

package/src/controllers/gamemode/settings.ts

@@ -1,3 +0,0 @@
-// Used to split circular dependency tips that ignore annoyance
-export const defaultCharset = "utf8";
-export const defaultLocale = "en_US";

package/src/controllers/gametext/index.ts

@@ -1,61 +0,0 @@
-import {
-  GameTextForAll,
-  GameTextForPlayer,
-  HasGameText,
-  HideGameTextForAll,
-  HideGameTextForPlayer,
-} from "@/wrapper/native/functions";
-import type { Player } from "../player";
-
-export class GameText<P extends Player = Player> {
-  private _text: string;
-  private _time: number;
-  private _style: number;
-
-  get text(): string {
-    return this._text;
-  }
-  set text(value: string) {
-    this._text = value;
-  }
-
-  get time(): number {
-    return this._time;
-  }
-  set time(value: number) {
-    this._time = value;
-  }
-
-  get style(): number {
-    return this._style;
-  }
-  set style(value: number) {
-    this._style = value;
-  }
-
-  constructor(str: string, time: number, style: number) {
-    this._text = str;
-    this._time = time;
-    this._style = style;
-  }
-
-  static hideForAll(style: number) {
-    HideGameTextForAll(style);
-  }
-
-  static has<P extends Player>(player: P, style: number) {
-    return HasGameText(player.id, style);
-  }
-
-  forAll() {
-    GameTextForAll(this.text, this.time, this.style);
-  }
-
-  forPlayer(player: P) {
-    GameTextForPlayer(player.id, this.text, this.time, this.style);
-  }
-
-  hideForPlayer(player: P) {
-    return HideGameTextForPlayer(player.id, this.style);
-  }
-}

package/src/controllers/gangzone/baseGangZone.ts

@@ -1,284 +0,0 @@
-import { LimitsEnum } from "@/enums";
-import type { IGangZone } from "@/interfaces";
-import { logger } from "@/logger";
-import { rgba } from "@/utils/colorUtils";
-import * as fns from "@/wrapper/native/functions";
-import type { GangZonePos } from "@infernus/wrapper";
-import {
-  CreatePlayerGangZone,
-  PlayerGangZoneDestroy,
-  PlayerGangZoneShow,
-  PlayerGangZoneHide,
-  PlayerGangZoneFlash,
-  PlayerGangZoneStopFlash,
-  IsValidPlayerGangZone,
-  IsValidGangZone,
-  IsPlayerInPlayerGangZone,
-  IsPlayerInGangZone,
-  IsPlayerGangZoneVisible,
-  IsGangZoneVisibleForPlayer,
-  PlayerGangZoneGetColour,
-  IsPlayerGangZoneFlashing,
-  IsGangZoneFlashingForPlayer,
-  PlayerGangZoneGetPos,
-  GangZoneGetPos,
-  UsePlayerGangZoneCheck,
-  UseGangZoneCheck,
-  GangZoneGetColourForPlayer,
-  GangZoneGetFlashColourForPlayer,
-  PlayerGangZoneGetFlashColour,
-} from "@infernus/wrapper";
-
-import type { Player } from "../player";
-import { gangZoneBus, gangZoneHooks } from "./gangZoneBus";
-
-export class GangZone<P extends Player> {
-  private _id = -1;
-  private static createdGlobalCount = 0;
-  private static createdPlayerCount = 0;
-  readonly sourceInfo: IGangZone<P>;
-
-  constructor(gangZone: IGangZone<P>) {
-    this.sourceInfo = gangZone;
-  }
-
-  get id() {
-    return this._id;
-  }
-
-  create(): void {
-    if (this.id !== -1)
-      return logger.warn("[GangZone]: Unable to create the gangzone again");
-
-    const { player } = this.sourceInfo;
-    if (!player) {
-      if (GangZone.createdGlobalCount === LimitsEnum.MAX_GANG_ZONES)
-        return logger.warn(
-          "[GangZone]: Unable to continue to create gangzone, maximum allowable quantity has been reached"
-        );
-      const { minx, miny, maxx, maxy } = this.sourceInfo;
-      this._id = fns.GangZoneCreate(minx, miny, maxx, maxy);
-      GangZone.createdGlobalCount++;
-    } else {
-      if (GangZone.createdPlayerCount === LimitsEnum.MAX_GANG_ZONES)
-        return logger.warn(
-          "[GangZone]: Unable to continue to create gangzone, maximum allowable quantity has been reached"
-        );
-      const { minx, miny, maxx, maxy } = this.sourceInfo;
-      this._id = CreatePlayerGangZone(player.id, minx, miny, maxx, maxy);
-      GangZone.createdPlayerCount++;
-      // PlayerGangZones may be automatically destroyed when a player disconnects.
-      samp.addEventListener("OnPlayerDisconnect", this.unregisterEvent);
-    }
-    gangZoneBus.emit(gangZoneHooks.created, {
-      key: { id: this.id, global: player === undefined },
-      value: this,
-    });
-  }
-
-  destroy() {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to destroy the gangzone before create"
-      );
-
-    const { player } = this.sourceInfo;
-    if (!player) {
-      fns.GangZoneDestroy(this.id);
-      GangZone.createdGlobalCount--;
-    } else {
-      PlayerGangZoneDestroy(player.id, this.id);
-      GangZone.createdPlayerCount--;
-    }
-    gangZoneBus.emit(gangZoneHooks.destroyed, {
-      id: this.id,
-      global: player === undefined,
-    });
-    this._id = -1;
-  }
-
-  showForAll(colour: string | number): void | this {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to show the gangzone before create"
-      );
-    const p = this.sourceInfo.player;
-    if (!p) {
-      fns.GangZoneShowForAll(this.id, colour);
-      return this;
-    }
-    return logger.warn(
-      "[GangZone]: player's gangzone should not be show for all."
-    );
-  }
-
-  showForPlayer(colour: string | number, player?: P): void | this {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to show the gangzone before create"
-      );
-    const p = this.sourceInfo.player;
-    if (p) PlayerGangZoneShow(p.id, this.id, rgba(colour));
-    else {
-      if (player) fns.GangZoneShowForPlayer(player.id, this.id, colour);
-      else return logger.warn("[GangZone]: invalid player for show");
-    }
-    return this;
-  }
-
-  hideForAll(): void | this {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to hide the gangzone before create"
-      );
-    const p = this.sourceInfo.player;
-    if (!p) {
-      fns.GangZoneHideForAll(this.id);
-      return this;
-    }
-    return logger.warn(
-      "[GangZone]: player's gangzone should not be hide for all."
-    );
-  }
-
-  hideForPlayer(player?: P): void | this {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to hide the gangzone before create"
-      );
-    const p = this.sourceInfo.player;
-    if (p) PlayerGangZoneHide(p.id, this.id);
-    else {
-      if (player) fns.GangZoneHideForPlayer(player.id, this.id);
-      else return logger.warn("[GangZone]: invalid player for hide");
-    }
-    return this;
-  }
-
-  flashForAll(flashcolour: string | number): void | this {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to flash the gangzone before create"
-      );
-    const p = this.sourceInfo.player;
-    if (!p) {
-      fns.GangZoneFlashForAll(this.id, flashcolour);
-      return this;
-    }
-    return logger.warn(
-      "[GangZone]: player's gangzone should not be flash for all."
-    );
-  }
-
-  flashForPlayer(player: P, flashcolour: string | number): void | this {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to flash the gangzone before create"
-      );
-    const p = this.sourceInfo.player;
-    if (p) PlayerGangZoneFlash(p.id, this.id, rgba(flashcolour));
-    else {
-      if (player) fns.GangZoneFlashForPlayer(player.id, this.id, flashcolour);
-      else return logger.warn("[GangZone]: invalid player for flash");
-    }
-    return this;
-  }
-
-  StopFlashForAll(): void | this {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to stop flash the gangzone before create"
-      );
-    const p = this.sourceInfo.player;
-    if (!p) {
-      fns.GangZoneStopFlashForAll(this.id);
-      return this;
-    }
-    return logger.warn(
-      "[GangZone]: player's gangzone should not be stop flash for all."
-    );
-  }
-
-  StopFlashForPlayer(player: P): void | this {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to stop flash the gangzone before create"
-      );
-    const p = this.sourceInfo.player;
-    if (p) PlayerGangZoneStopFlash(p.id, this.id);
-    else {
-      if (player) fns.GangZoneStopFlashForPlayer(player.id, this.id);
-      else return logger.warn("[GangZone]: invalid player for flash");
-    }
-    return this;
-  }
-
-  isValid(): boolean {
-    if (this.id === -1) return false;
-    const p = this.sourceInfo.player;
-    if (p) return IsValidPlayerGangZone(p.id, this.id);
-    return IsValidGangZone(this.id);
-  }
-
-  isPlayerIn(player: P): boolean {
-    if (this.id === -1) return false;
-    const p = this.sourceInfo.player;
-    if (p) return IsPlayerInPlayerGangZone(p.id, this.id);
-    return IsPlayerInGangZone(player.id, this.id);
-  }
-
-  isVisibleForPlayer(player: P): boolean {
-    if (this.id === -1) return false;
-    const p = this.sourceInfo.player;
-    if (p) return IsPlayerGangZoneVisible(p.id, this.id);
-    return IsGangZoneVisibleForPlayer(player.id, this.id);
-  }
-
-  getColourForPlayer(player: P): void | number {
-    if (this.id === -1)
-      return logger.warn("[GangZone]: Unable to get colour before create");
-    const p = this.sourceInfo.player;
-    if (p) return PlayerGangZoneGetColour(p.id, this.id);
-    return GangZoneGetColourForPlayer(player.id, this.id);
-  }
-
-  getFlashColourForPlayer(player: P): void | number {
-    if (this.id === -1)
-      return logger.warn(
-        "[GangZone]: Unable to get flash colour before create"
-      );
-    const p = this.sourceInfo.player;
-    if (p) return PlayerGangZoneGetFlashColour(p.id, this.id);
-    return GangZoneGetFlashColourForPlayer(player.id, this.id);
-  }
-
-  isFlashingForPlayer(player: P): boolean {
-    if (this.id === -1) return false;
-    const p = this.sourceInfo.player;
-    if (p) return IsPlayerGangZoneFlashing(p.id, this.id);
-    return IsGangZoneFlashingForPlayer(player.id, this.id);
-  }
-
-  getPos(): void | GangZonePos {
-    if (this.id === -1)
-      return logger.warn("[GangZone]: Unable to get position before create");
-    const p = this.sourceInfo.player;
-    if (p) return PlayerGangZoneGetPos(p.id, this.id);
-    return GangZoneGetPos(this.id);
-  }
-
-  useCheck(toggle: boolean): void | this {
-    if (this.id === -1)
-      return logger.warn("[GangZone]: Unable to use check before create");
-    const p = this.sourceInfo.player;
-    if (p) UsePlayerGangZoneCheck(p.id, this.id, toggle);
-    else UseGangZoneCheck(this.id, toggle);
-    return this;
-  }
-
-  private unregisterEvent(): number {
-    this.destroy();
-    samp.removeEventListener("OnPlayerDisconnect", this.unregisterEvent);
-    return 1;
-  }
-}

package/src/controllers/gangzone/gangZoneBus.ts

@@ -1,8 +0,0 @@
-import { EventBus } from "@/utils/eventBus";
-
-export enum gangZoneHooks {
-  created = "OnGangZoneCreate",
-  destroyed = "OnGangZoneDestroy",
-}
-
-export const gangZoneBus = new EventBus();