yolkbot 0.1.0-alpha.6 → 0.1.0-alpha.8

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "yolkbot",
     "description": "create a shell shockers (self) bot in under 10 lines.",
-    "version": "0.1.0-alpha.6",
+    "version": "0.1.0-alpha.8",
     "keywords": [
         "shell shockers",
         "shellshock.io",

package/src/types/bot.d.ts

@@ -1,9 +1,9 @@
-import { CommCode } from '../comm/Codes.js';
-import { GamePlayer } from '../bot/GamePlayer.js';
-import { Matchmaker } from '../matchmaker.js';
-import { yolkws } from '../socket.js';
 import { NodeList } from '../pathing/mapnode.js';
-import { Maps } from '../constants/maps.js';
+import { yolkws } from '../socket.js';
+
+import { Character, GamePlayer } from './bot/GamePlayer';
+import { Gun } from './gun';
+import { Matchmaker } from './matchmaker';
 
 export interface BotParams {
     name?: string;
@@ -51,8 +51,39 @@ export interface GameOptions {
     mustUseSecondary: boolean;
 }
 
+export interface RawGameData {
+    command: 'gameFound';
+    region: string;
+    subdomain: string;
+    id: string;
+    uuid: string;
+    private: boolean;
+    noobLobby: boolean;
+}
+
+export interface RawMapData {
+    filename: string;
+    hash: string;
+    name: string;
+    modes: {
+        FFA: boolean;
+        Teams: boolean;
+        Spatula: boolean;
+        King?: boolean;
+    };
+    availability: string;
+    numPlayers: string;
+}
+
+export interface Collectable {
+    id: number;
+    x: number;
+    y: number;
+    z: number;
+}
+
 export interface Game {
-    raw: any;
+    raw: RawGameData;
     code: string;
     gameModeId: number;
     gameMode: string;
@@ -69,14 +100,14 @@ export interface Game {
         };
         availability: string;
         numPlayers: string;
-        raw: any;
+        raw: RawMapData;
         nodes: any;
     };
     playerLimit: number;
     isGameOwner: boolean;
     isPrivate: boolean;
     options: GameOptions;
-    collectables: any[][];
+    collectables: Collectable[][];
     teamScore: number[];
     spatula: {
         coords: { x: number; y: number; z: number };
@@ -142,11 +173,44 @@ export class Bot {
     dispatch(disp: any): void;
     drain(): void;
     initMatchmaker(): Promise<boolean>;
-    createPrivateGame(opts: { region: string; mode: string; map: string }): Promise<any>;
-    join(data: string | any): Promise<void>;
+    createPrivateGame(opts: { region: string; mode: string; map: string }): Promise<RawGameData>;
+    join(data: string | RawGameData): Promise<void>;
     update(): void;
     on(event: string, cb: Function): void;
     onAny(cb: Function): void;
+    
+    on(event: 'authFail', cb: (reason: string) => void): void;
+    on(event: 'balanceUpdate', cb: (oldBalance: number, newBalance: number) => void): void;
+    on(event: 'banned', cb: (banRemaining: string) => void): void;
+    on(event: 'chat', cb: (player: GamePlayer, message: string, flags: number) => void): void;
+    on(event: 'close', cb: (code: number) => void): void;
+    on(event: 'collectAmmo', cb: (player: GamePlayer, weapon: Gun) => void): void;
+    on(event: 'collectGrenade', cb: (player: GamePlayer) => void): void;
+    on(event: 'gameForcePause', cb: () => void): void;
+    on(event: 'gameOptionsChange', cb: (oldOptions: GameOptions, newOptions: GameOptions) => void): void;
+    on(event: 'gameReset', cb: () => void): void;
+    on(event: 'gameStateChange', cb: (oldState: Game, newState: Game) => void): void;
+    on(event: 'pingUpdate', cb: (oldPing: number, newPing: number) => void): void;
+    on(event: 'playerBeginStreak', cb: (player: GamePlayer, streak: number) => void): void;
+    on(event: 'playerChangeCharacter', cb: (player: GamePlayer, oldCharacter: Character, newCharacter: Character) => void): void;
+    on(event: 'playerChangeGun', cb: (player: GamePlayer, oldGun: number, newGun: number) => void): void;
+    on(event: 'playerDamaged', cb: (player: GamePlayer, oldHp: number, newHp: number) => void): void;
+    on(event: 'playerDeath', cb: (player: GamePlayer, killer: GamePlayer) => void): void;
+    on(event: 'playerFire', cb: (player: GamePlayer, weapon: Gun) => void): void;
+    on(event: 'playerJoin', cb: (player: GamePlayer) => void): void;
+    on(event: 'playerLeave', cb: (player: GamePlayer) => void): void;
+    on(event: 'playerMelee', cb: (player: GamePlayer) => void): void;
+    on(event: 'playerPause', cb: (player: GamePlayer) => void): void;
+    on(event: 'playerReload', cb: (player: GamePlayer, weapon: Gun) => void): void;
+    on(event: 'playerRespawn', cb: (player: GamePlayer) => void): void;
+    on(event: 'playerSwapWeapon', cb: (player: GamePlayer, nowActive: number) => void): void;
+    on(event: 'playerSwitchTeam', cb: (player: GamePlayer, oldTeam: number, newTeam: number) => void): void;
+    on(event: 'selfDamaged', cb: (oldHp: number, newHp: number) => void): void;
+    on(event: 'selfMoved', cb: (oldPos: { x: number; y: number; z: number }, newPos: { x: number; y: number; z: number }) => void): void;
+    on(event: 'selfRespawnFail', cb: () => void): void;
+    on(event: 'selfShieldHit', cb: (oldShield: number, newShield: number) => void): void;
+    on(event: 'selfShieldLost', cb: () => void): void;
+    on(event: 'spawnItem', cb: (type: number, _id: number, pos: { x: number; y: number; z: number }) => void): void;
 }
 
 export default Bot;

package/src/types/dispatches/BootPlayerDispatch.d.ts

@@ -1,10 +1,12 @@
+import Bot from '../bot';
+
 export declare class BootPlayerDispatch {
     uniqueId: string;
 
     constructor(uniqueId: string);
 
-    check(bot: any): boolean;
-    execute(bot: any): void;
+    check(bot: Bot): boolean;
+    execute(bot: Bot): void;
 }
 
 export default BootPlayerDispatch;

package/src/types/dispatches/ChatDispatch.d.ts

@@ -1,4 +1,4 @@
-import packet from '#packet';
+import Bot from '../bot';
 
 export declare class ChatDispatch {
     constructor(msg: string, noLimit?: boolean);

package/src/types/dispatches/FireDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 export declare class FireDispatch {
     constructor(amount: number);
 

package/src/types/dispatches/GameOptionsDispatch.d.ts

@@ -1,4 +1,4 @@
-import packet from '#packet';
+import Bot from '../bot';
 
 export declare class GameOptionsDispatch {
     check(bot: Bot): boolean;

package/src/types/dispatches/GoToPlayerDispatch.d.ts

@@ -1,4 +1,5 @@
-import AStar from '../pathing/astar.js';
+import Bot from '../bot';
+import GamePlayer from '../bot/GamePlayer';
 
 export declare class GoToPlayerDispatch {
     constructor(target: GamePlayer);

package/src/types/dispatches/GoToSpatulaDispatch.d.ts

@@ -1,4 +1,4 @@
-import AStar from '../pathing/astar.js';
+import Bot from '../bot';
 
 export class GoToSpatulaDispatch {
     check(bot: Bot): boolean;

package/src/types/dispatches/LookAtPosDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 type Position = {
     x: number;
     y: number;

package/src/types/dispatches/MeleeDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 export class MeleeDispatch {
     check(bot: Bot): boolean;
     execute(bot: Bot): void;

package/src/types/dispatches/PauseDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 export class PauseDispatch {
     check(bot: Bot): boolean;
     execute(bot: Bot): void;

package/src/types/dispatches/ReloadDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 export class ReloadDispatch {
     check(bot: Bot): boolean;
     execute(bot: Bot): void;

package/src/types/dispatches/ReportPlayerDispatch.d.ts

@@ -1,10 +1,19 @@
+import Bot from '../bot';
+
+type CheatingReasons = {
+    cheating?: boolean;
+    harassment?: boolean;
+    offensive?: boolean;
+    other?: boolean;
+}
+
 export class ReportPlayerDispatch {
     id?: number;
     name?: string;
     reasons: boolean[];
     reasonInt: number;
 
-    constructor(idOrName: number | string, reasons?: { cheating?: boolean; harassment?: boolean; offensive?: boolean; other?: boolean });
+    constructor(idOrName: number | string, reasons?: CheatingReasons);
 
     check(bot: Bot): boolean;
     execute(bot: Bot): void;

package/src/types/dispatches/SaveLoadoutDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 type Changes = {
     classIdx?: number;
     hatId?: number;

package/src/types/dispatches/SpawnDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 export class SpawnDispatch {
     check(bot: Bot): boolean;
     execute(bot: Bot): void;

package/src/types/dispatches/SwapWeaponDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 export class SwapWeaponDispatch {
     check(bot: Bot): boolean;
     execute(bot: Bot): void;

package/src/types/dispatches/SwitchTeamDispatch.d.ts

@@ -1,3 +1,5 @@
+import Bot from '../bot';
+
 export class SwitchTeamDispatch {
     check(bot: Bot): boolean;
     execute(bot: Bot): void;

package/src/types/dispatches/ThrowGrenadeDispatch.d.ts

@@ -1,5 +1,8 @@
+import Bot from '../bot';
+
 export class ThrowGrenadeDispatch {
     constructor(power?: number);
+
     check(bot: Bot): boolean;
     execute(bot: Bot): void;
 }

package/src/types/gun.d.ts

@@ -0,0 +1,131 @@
+type Ammo = {
+    rounds: number;
+    capacity: number;
+    reload: number;
+    store: number;
+    storeMax: number;
+    pickup: number;
+};
+
+type GunProps = {
+    dmgTypeId?: number;
+    highPrecision?: boolean;
+    equipTime?: number;
+    stowWeaponTime?: number;
+    accuracy?: number;
+    shootingAccuracy?: number;
+    movementAccuracy?: number;
+    accuracyMax?: number;
+    accuracyMin?: number;
+    accuracyLoss?: number;
+    accuracyRecover?: number;
+    tracer?: number;
+    burstQueue?: number;
+    adsMod?: number;
+    movementAccuracyMod?: number;
+    reloadBloom?: boolean;
+    reloadTimeMod?: number;
+    ammo?: Ammo;
+    longReloadTime?: number;
+    shortReloadTime?: number;
+    weaponName?: string;
+    standardMeshName?: string;
+    rof?: number;
+    recoil?: number;
+    automatic?: boolean;
+    damage?: number;
+    totalDamage?: number;
+    range?: number;
+    velocity?: number;
+    hasScope?: boolean;
+    radius?: number;
+    minRange?: number;
+    burst?: number;
+    burstRof?: number;
+    movementInstability?: number;
+    absoluteMinAccuracy?: number;
+};
+
+class Gun {
+    dmgTypeId: number;
+    highPrecision: boolean;
+    equipTime: number;
+    stowWeaponTime: number;
+    accuracy: number;
+    shootingAccuracy: number;
+    movementAccuracy: number;
+    accuracyMax: number;
+    accuracyMin: number;
+    accuracyLoss: number;
+    accuracyRecover: number;
+    tracer: number;
+    burstQueue: number;
+    adsMod: number;
+    movementAccuracyMod: number;
+    reloadBloom: boolean;
+    reloadTimeMod: number;
+    ammo: Ammo;
+    longReloadTime: number;
+    shortReloadTime: number;
+    weaponName: string;
+    standardMeshName: string;
+    rof: number;
+    recoil: number;
+    automatic: boolean;
+    damage: number;
+    totalDamage: number;
+    range: number;
+    velocity: number;
+    hasScope: boolean;
+    radius: number;
+    minRange: number;
+    burst: number;
+    burstRof: number;
+    movementInstability: number;
+    absoluteMinAccuracy: number;
+
+    constructor(props: GunProps = {}) {
+        this.dmgTypeId = props.dmgTypeId || 0;
+        this.highPrecision = props.highPrecision || false;
+        this.equipTime = props.equipTime || 13;
+        this.stowWeaponTime = props.stowWeaponTime || 13;
+        this.accuracy = props.accuracy || 0;
+        this.shootingAccuracy = props.shootingAccuracy || 0;
+        this.movementAccuracy = props.movementAccuracy || 0;
+        this.accuracyMax = props.accuracyMax || 0;
+        this.accuracyMin = props.accuracyMin || 0;
+        this.accuracyLoss = props.accuracyLoss || 0;
+        this.accuracyRecover = props.accuracyRecover || 0;
+        this.tracer = props.tracer || 0;
+        this.burstQueue = props.burstQueue || 0;
+        this.adsMod = props.adsMod || 0.5;
+        this.movementAccuracyMod = props.movementAccuracyMod || 1;
+        this.reloadBloom = props.reloadBloom || true;
+        this.reloadTimeMod = props.reloadTimeMod || 1;
+        this.ammo = props.ammo || { rounds: 0, capacity: 0, reload: 0, store: 0, storeMax: 0, pickup: 0 };
+        this.longReloadTime = props.longReloadTime || 0;
+        this.shortReloadTime = props.shortReloadTime || 0;
+        this.weaponName = props.weaponName || '';
+        this.standardMeshName = props.standardMeshName || '';
+        this.rof = props.rof || 0;
+        this.recoil = props.recoil || 0;
+        this.automatic = props.automatic || false;
+        this.damage = props.damage || 0;
+        this.totalDamage = props.totalDamage || 0;
+        this.range = props.range || 0;
+        this.velocity = props.velocity || 0;
+        this.hasScope = props.hasScope || false;
+        this.radius = props.radius || 0;
+        this.minRange = props.minRange || 0;
+        this.burst = props.burst || 0;
+        this.burstRof = props.burstRof || 0;
+        this.movementInstability = props.movementInstability || 0;
+        this.absoluteMinAccuracy = props.absoluteMinAccuracy || 0;
+    }
+}
+
+export {
+    Gun,
+    Ammo,
+    GunProps
+};