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.

📄️ Cmd

Command-related APIs for registering and managing chat commands that can be executed by players.

📄️ 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.

📄️ NetObject

Client-side NetObject methods. Includes shared methods and client-only extensions.

📄️ NetPlayer

This is the client-side class for NetPlayer.

📄️ NetRigidObject

This is the client-side class for NetRigidObject.

📄️ NetVehicle

This is the client-side class for NetVehicle.

📄️ 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

📄️ PlayerClient

A player's client instance.

📄️ Players

These APIs allow you to interface with Players in the game.

📄️ POI

POI is a class that represents a point of interest in the game.

📄️ 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.

📄️ RigidObject

This is the client-side class for RigidObject returned by World.SpawnRigidObject.

📄️ Sound

Global table for sound management and playback.

📄️ SoundChannel

This is the client-side class for controlling sound playback returned by Sound.Play2D and Sound.Play3D.

📄️ Terrain

Terrain.GetInfo (position table

📄️ UI

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

📄️ 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.