@schmoker/rageenginebridge 0.1.0 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schmoker/rageenginebridge",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Engine-agnostic abstraction layer over RAGEMP Client-API. Swap RAGEMP for alt:V, FiveM or a mock without changing feature code.",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -52,7 +52,7 @@
     "engine-bridge",
     "typescript"
   ],
-  "author": "kilypso",
+  "author": "schmoker",
   "license": "MIT",
   "devDependencies": {
     "@ragempcommunity/types-client": "^2.1.9",

package/dist/IEngine-BSo5z5Jl.d.cts

@@ -1,598 +0,0 @@
-interface Vector3 {
-    x: number;
-    y: number;
-    z: number;
-}
-interface RGBA {
-    r: number;
-    g: number;
-    b: number;
-    a: number;
-}
-interface RGB {
-    r: number;
-    g: number;
-    b: number;
-}
-type Array2d = [number, number];
-type Array3d = [number, number, number];
-interface RaycastResult {
-    entity: number;
-    position: Vector3;
-    surfaceNormal: Vector3;
-}
-declare enum EntityType {
-    Player = "player",
-    Vehicle = "vehicle",
-    Object = "object",
-    Ped = "ped",
-    Blip = "blip",
-    Checkpoint = "checkpoint",
-    Colshape = "colshape",
-    Camera = "camera",
-    Browser = "browser",
-    TextLabel = "textlabel",
-    Marker = "marker",
-    Pickup = "pickup"
-}
-interface SystemNotifyArgs {
-    title: string;
-    text: string;
-    attribute: string;
-    duration: number;
-    silent: boolean;
-}
-interface NametagsHealthBarStyle {
-    size: Array2d;
-    color: RGBA;
-    bgColor: RGBA;
-}
-interface NametagsStyle {
-    font: number;
-    outline: boolean;
-    offset: Array2d;
-    vehOffset: Array2d;
-    color: RGBA;
-    size: number;
-    hbar?: NametagsHealthBarStyle;
-}
-interface BlipCreateOpts {
-    sprite: number;
-    position: Vector3;
-    name?: string;
-    scale?: number;
-    color?: number;
-    alpha?: number;
-    drawDistance?: number;
-    shortRange?: boolean;
-    rotation?: number;
-    dimension?: number;
-}
-interface CheckpointCreateOpts {
-    type: number;
-    position: Vector3;
-    radius: number;
-    direction?: Vector3;
-    color?: RGBA;
-    visible?: boolean;
-    dimension?: number;
-}
-interface ColshapeCreateOpts {
-    shape: "sphere" | "tube" | "circle" | "cuboid" | "rectangle" | "polygon";
-    x: number;
-    y: number;
-    z: number;
-    width?: number;
-    height?: number;
-    depth?: number;
-    radius?: number;
-    dimension?: number;
-}
-interface CameraCreateOpts {
-    name: string;
-    position?: Vector3;
-    rotation?: Vector3;
-    fov?: number;
-}
-interface BrowserCreateOpts {
-    url: string;
-}
-interface TextLabelCreateOpts {
-    text: string;
-    position: Vector3;
-    font?: number;
-    color?: RGBA;
-    drawDistance?: number;
-    los?: boolean;
-    dimension?: number;
-}
-interface PedCreateOpts {
-    model: number;
-    position: Vector3;
-    heading: number;
-    dimension?: number;
-}
-
-interface IEntity {
-    readonly id: number;
-    readonly remoteId: number;
-    readonly type: EntityType;
-    readonly handle: number;
-    alpha: number;
-    data: Record<string, unknown>;
-    dimension: number;
-    model: number;
-    position: Vector3;
-    rotation: Vector3;
-    destroy(): void;
-    doesExist(): boolean;
-    dist(position: Vector3): number;
-    distSquared(position: Vector3): number;
-    getVariable(name: string): unknown;
-    hasVariable(name: string): boolean;
-    setCoords(x: number, y: number, z: number): void;
-    setRotation(x: number, y: number, z: number): void;
-    freezePosition(toggle: boolean): void;
-    setVelocity(x: number, y: number, z: number): void;
-    getVelocity(): Vector3;
-    setAlpha(alpha: number): void;
-    setVisible(visible: boolean): void;
-    setCollision(toggle: boolean): void;
-    setInvincible(toggle: boolean): void;
-    getHealth(): number;
-    setHealth(health: number): void;
-    getMaxHealth(): number;
-    setMaxHealth(health: number): void;
-    getSpeed(): number;
-    getForwardVector(): Vector3;
-    getHeading(): number;
-    setHeading(heading: number): void;
-    isOnScreen(): boolean;
-    isDead(): boolean;
-    isInWater(): boolean;
-    isInAir(): boolean;
-    isVisible(): boolean;
-}
-interface IEntityPool<T> {
-    readonly length: number;
-    readonly size: number;
-    readonly streamed: T[];
-    at(id: number): T | undefined;
-    atRemoteId(remoteId: number): T | undefined;
-    atHandle(handle: number): T | undefined;
-    exists(entity: T): boolean;
-    forEach(callback: (entity: T) => void): void;
-    forEachInRange(position: Vector3, range: number, callback: (entity: T) => void): void;
-    forEachInRange(position: Vector3, range: number, dimension: number, callback: (entity: T) => void): void;
-    forEachInStreamRange(callback: (entity: T) => void): void;
-    forEachInDimension(dimension: number, callback: (entity: T) => void): void;
-    getClosest(position: Vector3): T | undefined;
-    toArray(): T[];
-}
-interface ICreatableEntityPool<T, Opts> extends IEntityPool<T> {
-    create(opts: Opts): T;
-}
-
-interface IPlayer extends IEntity {
-    readonly armour: number;
-    readonly eyeColour: number;
-    readonly hairColour: number;
-    readonly hairHighlightColour: number;
-    readonly heading: number;
-    readonly health: number;
-    readonly name: string;
-    readonly weapon: number;
-    readonly weaponAmmo: number;
-    readonly action: string;
-    readonly aimTarget: number;
-    readonly ip: string;
-    readonly isTypingInTextChat: boolean;
-    readonly isVoiceActive: boolean;
-    readonly ping: number;
-    readonly vehicle: number | null;
-    setComponentVariation(component: number, drawable: number, texture: number, palette: number): void;
-    setHeadBlendData(shapeFirst: number, shapeSecond: number, shapeThird: number, skinFirst: number, skinSecond: number, skinThird: number, shapeMix: number, skinMix: number, thirdMix: number): void;
-    setHeadOverlay(overlayId: number, index: number, opacity: number, firstColor?: number, secondColor?: number): void;
-    setHairColor(color: number, highlight: number): void;
-    setEyeColor(color: number): void;
-    setFaceFeature(index: number, scale: number): void;
-    setPropIndex(propId: number, drawableId: number, textureId: number, attach: boolean): void;
-    clearProp(propId: number): void;
-    getDrawableVariation(component: number): number;
-    getTextureVariation(component: number): number;
-    getPropIndex(propId: number): number;
-    getPropTextureIndex(propId: number): number;
-    getBonePosition(boneId: number): Vector3;
-    getWorldPositionOfBone(boneIndex: number): Vector3;
-    getBoneIndex(boneName: string): number;
-    giveWeapon(hash: number, ammo: number): void;
-    removeAllWeapons(): void;
-    getAmmoInClip(weapon: number): number;
-    setAmmoInClip(weapon: number, ammo: number): void;
-    getWeaponTintIndex(weapon: number): number;
-    isJumping(): boolean;
-    isFalling(): boolean;
-    isShooting(): boolean;
-    isReloading(): boolean;
-    isSprinting(): boolean;
-    isSwimming(): boolean;
-    isSwimmingUnderWater(): boolean;
-    isClimbing(): boolean;
-    isGettingIntoVehicle(): boolean;
-    isDiving(): boolean;
-    isParachuting(): boolean;
-    isInAnyVehicle(): boolean;
-    isSittingInVehicle(vehicle: number): boolean;
-    setIntoVehicle(vehicle: number, seat: number): void;
-    setArmour(armour: number): void;
-    getArmour(): number;
-    taskPlayAnim(dict: string, name: string, blendInSpeed: number, blendOutSpeed: number, duration: number, flag: number, playbackRate: number, lockX: boolean, lockY: boolean, lockZ: boolean): void;
-    clearTasks(): void;
-    clearTasksImmediately(): void;
-    canRagdoll(): boolean;
-    setCanRagdoll(toggle: boolean): void;
-    setRagdollOnCollision(toggle: boolean): void;
-}
-
-interface IVehicle extends IEntity {
-    readonly gear: number;
-    readonly rpm: number;
-    readonly steeringAngle: number;
-    isPositionFrozen: boolean;
-    gravity: number;
-    setEngineOn(toggle: boolean, instantly: boolean, noAutoTurnOn: boolean): void;
-    isEngineRunning(): boolean;
-    getEngineHealth(): number;
-    setEngineHealth(health: number): void;
-    setEnginePowerMultiplier(multiplier: number): void;
-    setEngineTorqueMultiplier(multiplier: number): void;
-    getBodyHealth(): number;
-    setBodyHealth(health: number): void;
-    getPetrolTankHealth(): number;
-    setPetrolTankHealth(health: number): void;
-    setDirtLevel(level: number): void;
-    setCustomPrimaryColour(r: number, g: number, b: number): void;
-    setCustomSecondaryColour(r: number, g: number, b: number): void;
-    getCustomPrimaryColour(): RGB;
-    getCustomSecondaryColour(): RGB;
-    setColours(primary: number, secondary: number): void;
-    setNeonLightEnabled(index: number, toggle: boolean): void;
-    isNeonLightEnabled(index: number): boolean;
-    setNeonLightsColour(r: number, g: number, b: number): void;
-    getNeonLightsColour(): RGB;
-    setMod(modType: number, modIndex: number): void;
-    getMod(modType: number): number;
-    setModKit(modKit: number): void;
-    getModKit(): number;
-    getNumMods(modType: number): number;
-    setWindowTint(tint: number): void;
-    getWindowTint(): number;
-    setNumberPlateText(text: string): void;
-    getNumberPlateText(): string;
-    setNumberPlateTextIndex(index: number): void;
-    getNumberPlateTextIndex(): number;
-    setTyreBurst(index: number, onRim: boolean, p2: number): void;
-    isTyreBurst(wheelId: number): boolean;
-    setTyresCanBurst(toggle: boolean): void;
-    getTyresCanBurst(): boolean;
-    setTyreFixed(index: number): void;
-    setDoorOpen(doorIndex: number, loose: boolean, openInstantly: boolean): void;
-    setDoorShut(doorIndex: number, closeInstantly: boolean): void;
-    setDoorBroken(doorIndex: number, deleteDoor: boolean): void;
-    isDoorDamaged(doorIndex: number): boolean;
-    isDoorFullyOpen(doorIndex: number): boolean;
-    getDoorAngleRatio(doorIndex: number): number;
-    setLight(lightIndex: number, toggle: boolean): void;
-    setLights(toggle: boolean): void;
-    getLightsState(): boolean;
-    setXenonHeadlights(toggle: boolean): void;
-    isXenonHeadlightsEnabled(): boolean;
-    setExtra(extraId: number, toggle: boolean): void;
-    doesExtraExist(extraId: number): boolean;
-    isExtraTurnedOn(extraId: number): boolean;
-    isSeatFree(seatIndex: number): boolean;
-    getPedInSeat(seatIndex: number): number;
-    getMaxNumberOfPassengers(): number;
-    setFixed(): void;
-    setUndriveable(toggle: boolean): void;
-    setCanBeDamaged(toggle: boolean): void;
-    setCanBeVisiblyDamaged(toggle: boolean): void;
-    getWheelType(): number;
-    setWheelType(type: number): void;
-    setLivery(livery: number): void;
-    getLivery(): number;
-    getLiveryCount(): number;
-    setRoofOpened(toggle: boolean): void;
-    isRoofOpened(): boolean;
-    setHandling(field: string, value: number): void;
-    getHandling(field: string): number;
-    resetHandling(): void;
-    setSuspensionHeight(height: number): void;
-}
-
-interface IPed extends IEntity {
-    readonly isDynamic: boolean;
-    readonly spawnPosition: Vector3;
-    readonly weapon: number;
-    readonly weaponAmmo: number;
-    setComponentVariation(component: number, drawable: number, texture: number, palette: number): void;
-    setHeadBlendData(shapeFirst: number, shapeSecond: number, shapeThird: number, skinFirst: number, skinSecond: number, skinThird: number, shapeMix: number, skinMix: number, thirdMix: number): void;
-    setHeadOverlay(overlayId: number, index: number, opacity: number, firstColor?: number, secondColor?: number): void;
-    setHairColor(color: number, highlight: number): void;
-    setEyeColor(color: number): void;
-    setFaceFeature(index: number, scale: number): void;
-    setPropIndex(propId: number, drawableId: number, textureId: number, attach: boolean): void;
-    clearProp(propId: number): void;
-    getDrawableVariation(component: number): number;
-    getTextureVariation(component: number): number;
-    getPropIndex(propId: number): number;
-    getPropTextureIndex(propId: number): number;
-    getBonePosition(boneId: number): Vector3;
-    getWorldPositionOfBone(boneIndex: number): Vector3;
-    getBoneIndex(boneName: string): number;
-    giveWeapon(hash: number, ammo: number): void;
-    removeAllWeapons(): void;
-    getAmmoInClip(weapon: number): number;
-    setAmmoInClip(weapon: number, ammo: number): void;
-    taskPlayAnim(dict: string, name: string, blendInSpeed: number, blendOutSpeed: number, duration: number, flag: number, playbackRate: number, lockX: boolean, lockY: boolean, lockZ: boolean): void;
-    clearTasks(): void;
-    clearTasksImmediately(): void;
-    canRagdoll(): boolean;
-    setCanRagdoll(toggle: boolean): void;
-    setRagdollOnCollision(toggle: boolean): void;
-}
-
-interface IObject extends IEntity {
-    setActivatePhysicsAsSoonAsItIsUnfrozen(toggle: boolean): void;
-    hasBeenBroken(): boolean;
-    placeOnGroundProperly(): boolean;
-    slide(toX: number, toY: number, toZ: number, speedX: number, speedY: number, speedZ: number): boolean;
-    setTargetable(targetable: boolean): void;
-}
-
-interface IBlip {
-    readonly id: number;
-    readonly remoteId: number;
-    readonly type: string;
-    readonly handle: number;
-    dimension: number;
-    position: Vector3;
-    destroy(): void;
-    setSprite(sprite: number): void;
-    getSprite(): number;
-    setColour(colour: number): void;
-    getColour(): number;
-    setScale(scale: number): void;
-    getScale(): number;
-    setAlpha(alpha: number): void;
-    getAlpha(): number;
-    setRotation(rotation: number): void;
-    getRotation(): number;
-    setName(name: string): void;
-    getName(): string;
-    setRoute(toggle: boolean): void;
-    setRouteColour(colour: number): void;
-    setFlashes(toggle: boolean): void;
-    setFlashTimer(duration: number): void;
-    setFlashInterval(interval: number): void;
-    setCategory(category: number): void;
-    setPriority(priority: number): void;
-    setDisplay(display: number): void;
-    setAsShortRange(toggle: boolean): void;
-    setHighDetail(toggle: boolean): void;
-    setBright(toggle: boolean): void;
-    setAsFriendly(toggle: boolean): void;
-    setShowCone(toggle: boolean): void;
-    setShowHeadingIndicator(toggle: boolean): void;
-    setSecondaryColour(r: number, g: number, b: number): void;
-    pulse(): void;
-    setFade(opacity: number, duration: number): void;
-}
-
-interface ICheckpoint extends IEntity {
-    visible: boolean;
-}
-
-interface IColshape extends IEntity {
-    triggered: boolean;
-}
-
-interface ICamera {
-    readonly handle: number;
-    getCoord(): Vector3;
-    setCoord(x: number, y: number, z: number): void;
-    getRot(): Vector3;
-    setRot(x: number, y: number, z: number, rotationOrder: number): void;
-    getFov(): number;
-    setFov(fov: number): void;
-    isActive(): boolean;
-    setActive(toggle: boolean): void;
-    setActiveWithInterp(camFrom: number, duration: number, easeLocation: number, easeRotation: number): void;
-    pointAtCoord(x: number, y: number, z: number): void;
-    pointAt(entity: number): void;
-    stopPointing(): void;
-    shake(type: string, amplitude: number): void;
-    isShaking(): boolean;
-    setShakeAmplitude(amplitude: number): void;
-    stopShaking(p0: boolean): void;
-    isRendering(): boolean;
-    isInterpolating(): boolean;
-    setFarClip(farClip: number): void;
-    setNearClip(nearClip: number): void;
-    setFarDof(farDof: number): void;
-    setNearDof(nearDof: number): void;
-    setDofStrength(strength: number): void;
-    setUseShallowDofMode(toggle: boolean): void;
-    setMotionBlurStrength(strength: number): void;
-    attachTo(entity: number, xOffset: number, yOffset: number, zOffset: number, isRelative: boolean): void;
-    detach(): void;
-    destroy(): void;
-}
-
-interface IBrowser {
-    active: boolean;
-    url: string;
-    inputEnabled: boolean;
-    orderId: number;
-    destroy(): void;
-    execute(code: string): void;
-    executeCached(code: string): void;
-    call(eventName: string, ...args: unknown[]): void;
-    callProc(procName: string, ...args: unknown[]): Promise<unknown>;
-    reload(ignoreCache: boolean): void;
-    sendMouseMoveEvent(x: number, y: number): void;
-    sendMouseClickEvent(x: number, y: number, button: number, isUp: boolean): void;
-}
-
-interface ITextLabel extends IEntity {
-    color: RGBA;
-    drawDistance: number;
-    los: boolean;
-    text: string;
-}
-
-interface IMarker extends IEntity {
-}
-
-interface IPickup extends IEntity {
-}
-
-interface IEvents {
-    add(eventName: string, callback: (...args: unknown[]) => void): void;
-    add(events: Record<string, (...args: unknown[]) => void>): void;
-    remove(eventName: string, callback?: (...args: unknown[]) => void): void;
-    call(eventName: string, ...args: unknown[]): void;
-    callRemote(eventName: string, ...args: unknown[]): void;
-    callRemoteProc(procName: string, ...args: unknown[]): Promise<unknown>;
-    callRemoteUnreliable(eventName: string, ...args: unknown[]): void;
-    addProc(procName: string, callback: (...args: unknown[]) => unknown): void;
-    addDataHandler(key: string, callback: (entity: unknown, value: unknown, oldValue: unknown) => void): void;
-    cancelPendingProc(procName: string): void;
-    hasPendingProc(procName: string): boolean;
-}
-
-interface IGuiChat {
-    colors: boolean;
-    safeMode: boolean;
-    activate(toggle: boolean): void;
-    push(text: string): void;
-    show(toggle: boolean): void;
-}
-interface IGuiCursor {
-    position: Array2d;
-    visible: boolean;
-    show(freezeControls: boolean, toggle: boolean): void;
-}
-interface IGui {
-    readonly chat: IGuiChat;
-    readonly cursor: IGuiCursor;
-    readonly isGpuRenderingEnabled: boolean;
-    takeScreenshot(name: string, type: number, quality: number, compressionQuality: number): void;
-    execute(code: string): void;
-}
-
-interface IKeys {
-    bind(keyCode: number, keyHold: boolean, callback: () => void): void;
-    unbind(keyCode: number, keyHold: boolean, callback?: () => void): void;
-    isUp(keyCode: number): boolean;
-    isDown(keyCode: number): boolean;
-}
-
-interface IStorage {
-    data: Record<string, unknown>;
-    sessionData: Record<string, unknown>;
-    flush(): void;
-}
-
-interface IVoiceChat {
-    readonly isAllowed: boolean;
-    readonly lastVad: number;
-    muted: boolean;
-    minVad: number;
-    advancedNoiseSuppression: boolean;
-    networkOptimisations: boolean;
-    bitrate: number;
-    defaultVolume: number;
-    gameOutputEnabled: boolean;
-    gameOutputCategory: string;
-    getPreprocessingParam(param: string): unknown;
-    setPreprocessingParam(param: string, value: unknown): void;
-    cleanupAndReload(force: boolean, clearTemporary: boolean): void;
-}
-
-interface INametags {
-    enabled: boolean;
-    set(style: NametagsStyle): void;
-    useScreen2dCoords(toggle: boolean): void;
-    orderByDistance(toggle: boolean): void;
-}
-
-interface IRaycasting {
-    testPointToPoint(startPos: Vector3, endPos: Vector3, ignoreEntity: number, flags: number): RaycastResult;
-    testPointToPointAsync(startPos: Vector3, endPos: Vector3, ignoreEntity: number, flags: number): Promise<RaycastResult>;
-    testCapsule(startPos: Vector3, endPos: Vector3, radius: number, ignoreEntity: number, flags: number): RaycastResult;
-}
-
-interface IConsole {
-    verbosity: number;
-    logInfo(message: string): void;
-    logWarning(message: string): void;
-    logError(message: string): void;
-    logFatal(message: string): void;
-    clear(): void;
-    reset(): void;
-}
-
-interface IDiscord {
-    update(details: string, state: string): void;
-    requestOAuth2(appId: string, scopes: string): Promise<string>;
-}
-
-interface ISystem {
-    readonly isFullscreen: boolean;
-    readonly isFocused: boolean;
-    notify(args: SystemNotifyArgs): void;
-}
-
-interface IUserPreferences {
-    readonly lowQualityAssets: boolean;
-    readonly language: string;
-    readonly serverAddress: string;
-}
-interface IUser {
-    readonly preferences: IUserPreferences;
-}
-
-interface INativesBridge {
-    invoke(namespace: string, name: string, ...args: unknown[]): unknown;
-}
-
-interface IEngine {
-    readonly localPlayer: IPlayer;
-    readonly players: IEntityPool<IPlayer>;
-    readonly vehicles: IEntityPool<IVehicle>;
-    readonly peds: ICreatableEntityPool<IPed, PedCreateOpts>;
-    readonly objects: IEntityPool<IObject>;
-    readonly blips: ICreatableEntityPool<IBlip, BlipCreateOpts>;
-    readonly checkpoints: ICreatableEntityPool<ICheckpoint, CheckpointCreateOpts>;
-    readonly colshapes: ICreatableEntityPool<IColshape, ColshapeCreateOpts>;
-    readonly cameras: ICreatableEntityPool<ICamera, CameraCreateOpts>;
-    readonly browsers: ICreatableEntityPool<IBrowser, BrowserCreateOpts>;
-    readonly labels: ICreatableEntityPool<ITextLabel, TextLabelCreateOpts>;
-    readonly markers: IEntityPool<IMarker>;
-    readonly pickups: IEntityPool<IPickup>;
-    readonly events: IEvents;
-    readonly gui: IGui;
-    readonly keys: IKeys;
-    readonly storage: IStorage;
-    readonly voiceChat: IVoiceChat;
-    readonly nametags: INametags;
-    readonly raycasting: IRaycasting;
-    readonly console: IConsole;
-    readonly discord: IDiscord;
-    readonly system: ISystem;
-    readonly user: IUser;
-    readonly natives: INativesBridge;
-}
-
-export { type Array2d as A, type BlipCreateOpts as B, type CameraCreateOpts as C, type IRaycasting as D, EntityType as E, type IStorage as F, type ISystem as G, type ITextLabel as H, type IEngine as I, type IUser as J, type IUserPreferences as K, type IVehicle as L, type IVoiceChat as M, type NametagsHealthBarStyle as N, type NametagsStyle as O, type PedCreateOpts as P, type RGBA as Q, type RGB as R, type RaycastResult as S, type SystemNotifyArgs as T, type TextLabelCreateOpts as U, type Vector3 as V, type Array3d as a, type BrowserCreateOpts as b, type CheckpointCreateOpts as c, type ColshapeCreateOpts as d, type IBlip as e, type IBrowser as f, type ICamera as g, type ICheckpoint as h, type IColshape as i, type IConsole as j, type ICreatableEntityPool as k, type IDiscord as l, type IEntity as m, type IEntityPool as n, type IEvents as o, type IGui as p, type IGuiChat as q, type IGuiCursor as r, type IKeys as s, type IMarker as t, type INametags as u, type INativesBridge as v, type IObject as w, type IPed as x, type IPickup as y, type IPlayer as z };