@schmoker/rageenginebridge 0.1.0

package/dist/ragemp.d.ts

@@ -0,0 +1,426 @@
+import { I as IEngine, n as IEntityPool, z as IPlayer, L as IVehicle, k as ICreatableEntityPool, x as IPed, P as PedCreateOpts, w as IObject, e as IBlip, B as BlipCreateOpts, h as ICheckpoint, c as CheckpointCreateOpts, i as IColshape, d as ColshapeCreateOpts, g as ICamera, C as CameraCreateOpts, f as IBrowser, b as BrowserCreateOpts, H as ITextLabel, U as TextLabelCreateOpts, t as IMarker, y as IPickup, o as IEvents, p as IGui, s as IKeys, F as IStorage, M as IVoiceChat, u as INametags, D as IRaycasting, j as IConsole, l as IDiscord, G as ISystem, J as IUser, v as INativesBridge, V as Vector3, m as IEntity, E as EntityType, R as RGB, Q as RGBA } from './IEngine-BSo5z5Jl.js';
+
+declare class RageMpEngine implements IEngine {
+    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;
+    private _localPlayer;
+    constructor();
+    get localPlayer(): IPlayer;
+}
+
+declare class RageMpEntityPool<T, Raw> implements IEntityPool<T> {
+    protected readonly pool: RageMpPool<Raw>;
+    protected readonly wrap: (raw: Raw) => T;
+    private cache;
+    constructor(pool: RageMpPool<Raw>, wrap: (raw: Raw) => T);
+    protected getWrapped(raw: Raw): T;
+    get length(): number;
+    get size(): number;
+    get 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, callbackOrDimension: ((entity: T) => void) | 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[];
+}
+declare class RageMpCreatablePool<T, Raw, Opts> extends RageMpEntityPool<T, Raw> implements ICreatableEntityPool<T, Opts> {
+    private readonly createFn;
+    constructor(pool: RageMpPool<Raw>, wrap: (raw: Raw) => T, createFn: (opts: Opts) => Raw);
+    create(opts: Opts): T;
+}
+interface RageMpPool<T> {
+    length: number;
+    streamed: T[];
+    at(id: number): T;
+    atRemoteId(remoteId: number): T;
+    atHandle(handle: number): T;
+    exists(entity: T): boolean;
+    forEach(callback: (entity: T) => void): void;
+    forEachInRange(position: any, range: number, callback: (entity: T) => void): void;
+    forEachInRange(position: any, range: number, dimension: number, callback: (entity: T) => void): void;
+    forEachInStreamRange(callback: (entity: T) => void): void;
+    forEachInDimension(dimension: number, callback: (entity: T) => void): void;
+    toArray(): T[];
+}
+
+declare class RageMpEntity implements IEntity {
+    protected readonly raw: any;
+    constructor(raw: any);
+    get id(): number;
+    get remoteId(): number;
+    get type(): EntityType;
+    get handle(): number;
+    get alpha(): number;
+    set alpha(value: number);
+    get data(): Record<string, unknown>;
+    set data(value: Record<string, unknown>);
+    get dimension(): number;
+    set dimension(value: number);
+    get model(): number;
+    set model(value: number);
+    get position(): Vector3;
+    set position(value: Vector3);
+    get rotation(): Vector3;
+    set rotation(value: 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;
+}
+
+declare class RageMpPlayer extends RageMpEntity implements IPlayer {
+    get armour(): number;
+    get eyeColour(): number;
+    get hairColour(): number;
+    get hairHighlightColour(): number;
+    get heading(): number;
+    get health(): number;
+    get name(): string;
+    get weapon(): number;
+    get weaponAmmo(): number;
+    get action(): string;
+    get aimTarget(): number;
+    get ip(): string;
+    get isTypingInTextChat(): boolean;
+    get isVoiceActive(): boolean;
+    get ping(): number;
+    get 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;
+}
+
+declare class RageMpVehicle extends RageMpEntity implements IVehicle {
+    get gear(): number;
+    get rpm(): number;
+    get steeringAngle(): number;
+    get isPositionFrozen(): boolean;
+    set isPositionFrozen(value: boolean);
+    get gravity(): number;
+    set gravity(value: 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;
+}
+
+declare class RageMpPed extends RageMpEntity implements IPed {
+    get isDynamic(): boolean;
+    get spawnPosition(): Vector3;
+    get weapon(): number;
+    get 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;
+}
+
+declare class RageMpObject extends RageMpEntity implements IObject {
+    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;
+}
+
+declare class RageMpBlip implements IBlip {
+    private readonly raw;
+    constructor(raw: any);
+    get id(): number;
+    get remoteId(): number;
+    get type(): string;
+    get handle(): number;
+    get dimension(): number;
+    set dimension(value: number);
+    get position(): Vector3;
+    set position(value: 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;
+}
+
+declare class RageMpCheckpoint extends RageMpEntity implements ICheckpoint {
+    get visible(): boolean;
+    set visible(value: boolean);
+}
+
+declare class RageMpColshape extends RageMpEntity implements IColshape {
+    get triggered(): boolean;
+    set triggered(value: boolean);
+}
+
+declare class RageMpCamera implements ICamera {
+    private readonly raw;
+    constructor(raw: any);
+    get 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;
+}
+
+declare class RageMpBrowser implements IBrowser {
+    private readonly raw;
+    constructor(raw: any);
+    get active(): boolean;
+    set active(value: boolean);
+    get url(): string;
+    set url(value: string);
+    get inputEnabled(): boolean;
+    set inputEnabled(value: boolean);
+    get orderId(): number;
+    set orderId(value: 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;
+}
+
+declare class RageMpTextLabel extends RageMpEntity implements ITextLabel {
+    get color(): RGBA;
+    set color(value: RGBA);
+    get drawDistance(): number;
+    set drawDistance(value: number);
+    get los(): boolean;
+    set los(value: boolean);
+    get text(): string;
+    set text(value: string);
+}
+
+declare class RageMpMarker extends RageMpEntity implements IMarker {
+}
+
+declare class RageMpPickup extends RageMpEntity implements IPickup {
+}
+
+export { RageMpBlip, RageMpBrowser, RageMpCamera, RageMpCheckpoint, RageMpColshape, RageMpCreatablePool, RageMpEngine, RageMpEntity, RageMpEntityPool, RageMpMarker, RageMpObject, RageMpPed, RageMpPickup, RageMpPlayer, RageMpTextLabel, RageMpVehicle };