Client API

📄️ Overview

This section contains information about APIs available only to client scripts.

📄️ Ability

Ability is a global enum that represents the different abilities in JC4MP, such as the grappling hook, wingsuit, etc.

📄️ Action

List of all actions used for inputs. For usage details, see Input.

📄️ Character

Character-related APIs. To use these, you must first have a reference to a character, such as the local player's character. Example:

📄️ Events

List of all events that can be used to listen for events. For usage details and more events, see Events.

List of all possible states that the game can be in. For usage details, see Game. For example, to get the current game state, use Game.GetState(). When the player is in game, the game state is GameState.MainMenu.

📄️ GameUI

Global methods for interacting with the base game UI.

📄️ Input

Input-related APIs.

📄️ Key

List of all keys used for inputs. For usage details, see Input.

📄️ Local

This is a global variable that allows you to access local player related APIs.

📄️ NetPlayer

This is the client-side class for NetPlayer. It has all the same methods and properties as the shared class, plus the following on this page.

📄️ NetVehicle

This is the client-side class for NetVehicle. It has all the same methods and properties as the shared class, plus the following on this page.

📄️ Network

These network APIs allow you to send data to the server and receive data from the server.

📄️ PfxLayer

Layers for raycast collisions. For usage, see Physics.Raycast.

📄️ Physics

Physics.Raycast(from vec3, collide_layer table

📄️ Player

Player-related APIs. To use these, you must first have a reference to a player, such as the Local Player. You can get a reference to the Local Player like so:

📄️ PlayerClient

A player's client instance. Inherits from the PlayerClient class. You can use this class to get information about the player, such as their Character and NetPlayer.

📄️ Players

These APIs allow you to interface with Players in the game. This inherits from the shared Players class.

📄️ Render

You can use Render methods to draw primitives to the screen, such as lines, shapes, and text. Render methods must be called inside the Render or PostRender event.

📄️ Terrain

Terrain.GetInfo (position table

📄️ UI

Create and manage user inferface elements, such as buttons, text, images, and menus.

📄️ Vehicle

Vehicle game instance APIs. To use these, you must first have a reference to a Vehicle, which you can get from a NetVehicle using the :GI() method.

📄️ Weapons

Class Instance Methods

📄️ Weather

Global Methods

📄️ WebView

The WebView system allows server owners to create interactive web-based user interfaces within the game client. It supports both local resource files and remote URLs, providing a powerful way to create rich, modern UIs using HTML, CSS, and JavaScript.

📄️ World

APIs related to the Just Cause 4 game world.