1.6.13 • Published 5 months ago
@wdesgardin/fivem-js v1.6.13
Documentation
Functionality of this wrapper is based on the FiveM C# wrapper - link. It's a feature-rich set of helper classes, objects, and functions to help you develop your project faster.
This library was originally created by d0p3t.
Features
- One dependency @citizenfx/client
- Abstracts common used FiveM practices
- Entity management through class objects (i.e.
Vehicle
andPed
entities) - UI elements such as
scaleforms
and loadingprompts
- Audio, Blips, Cameras and more...
In other words, whatever the FiveM C# wrapper can do, this package can as well and more!
Download & Install
npm install @wdesgardin/fivem-js
Simple Usage
See here for example projects.
Typescript
import * as Cfx from 'fivem-js';
RegisterCommand(
'adder',
async (source: number, args: string[]) => {
const vehicle = await Cfx.World.createVehicle(
new Cfx.Model('adder'),
new Cfx.Vector3(1, 2, 3),
4,
);
Cfx.Game.PlayerPed.setIntoVehicle(vehicle, Cfx.VehicleSeat.Driver);
},
false,
);
You can also individually import classes.
import { World } from 'fivem-js/lib/World';
Javascript
/// <reference path="node_modules/fivem-js/lib/index.d.ts"/>
/// <reference path="node_modules/@citizenfx/client/natives_universal.d.ts"/>
const Cfx = require('fivem-js');
RegisterCommand(
'adder',
async (source, args) => {
const vehicle = await Cfx.World.createVehicle(
new Cfx.Model('adder'),
new Cfx.Vector3(1, 2, 3),
4,
);
Cfx.Game.PlayerPed.setIntoVehicle(vehicle, Cfx.VehicleSeat.Driver);
},
false,
);
Contributing
You are more than welcome to contribute to this project by submitting a pull request and creating issues.
Please checkout CONTRIBUTING.md for our contributing guidelines.
License
MIT with customization. See LICENSE