lib

VORP Lib is a modular scripting library for RedM that simplifies game development by providing reusable, instance-based components with automatic cleanup. Designed specifically for VORP Core Framework, it helps developers write cleaner, more efficient scripts while eliminating common issues like memory leaks and global variable pollution

This documentation is for developers who are making scripts for redm, you should also note that this is a work in progress and anything can be changed at any time until the final release.

You cannot Import encrypted files like with escrow etc, only files that aren’t encrypted can be imported.

Lib usage

To import modules to your script you must add the following to the script fxmanifest.lua file

fxmanifest

   shared_script "@vorp_lib/import.lua"

the global variables below will be available for both server and client, so make sure you dont call vorp exports in your script to avoid calling it twice.

• LIB is a global variable that contains a table with CORE and NOTIFY as sub-variables like LIB.CORE and LIB.NOTIFY to access them easily

Variables

server

CORE

CORE is available for server and client , you wont need to call exports.vorp_core:GetCore()

 -- just simply use the global variable
 LIB.CORE.NotifyObjective(source,"Hello World",5000)
 -- callbacks
 local result = LIB.CORE.Callback.TriggerAwait("my_callback")

NOTIFY

NOTIFY is available for server and client , you wont need to use vorp core notify or even import the notify module

 -- just simply use the global variable
 LIB.NOTIFY:Objective(source,"Hello World",5000)

Module Import

Only Lua files can be imported

List of Modules

client

modules

entities

this module contains methods that allows you to create entities like peds, vehicles, objects, etc

blips

this module contains methods that allows you to create various types of blips styles and map related stuff

inputs

this module contains methods that allows you to create input controls

prompts

this module contains methods that allows you to create prompts

commands

this module contains methods that allows you to register commands

points

this module contains methods that allows you to create points enter/exit with debug options

events

this module contains methods that allows you to register game events

dataview

this module contains methods that allows you to use dataview in lua

streaming

this module contains methods that allows you to call to load several game assets like anim dics models etc

Importing Modules

LibImport

Import

module · string · required

Allows to import any modules from the lib, a list of modules available can be found here

local module = Import "modulename" -- no symbols

local prompts = Import("prompts").Prompts -- every module has a table with the module name as the key for readability

local Lib = Import "prompts"
local Prompts = Lib.Prompts -- [[@as PROMPTS]] -- for intellisense

Import Usage

Single Module Import

Single

module · string · required

The module name to import

local module = Import "module"

Modules

The following modules are available in the lib, you can import them using the Import function, documentation for each module will be available below

Entities

This module is used to create entities like peds, vehicles, objects, etc, it has a baseclass for all entities and sub classes for each entity type all creations are instanced objects every creation will have its own instance and wont be shared with other scripts since its imported to your script when you restart your resource the entities will be removed for easy development

it has a entity tracker if you wish to track the entities from other scripts (see collector file) for exports

BASECLASS

Shared

This is the baseclass for (peds, vehicles, objects) subclasses you can use these methods bellow or use directly the natives

Getters

GetHandle

return · string

Get the handle of the entity, this is a unique identifier for the entity

GetModel

return · string

Get the model of the entity

GetPosition

return · vector3

Get the position of the entity

GetHeading

return · number

Get the heading of the entity

GetRotation

return · vector3

Get the rotation of the entity

GetNetId

return · number

Get the networked id of the entity if the entity created had IsNetworked = true

Map

The map module is used to create blips for now but will be expanded to include more map related features when you restart your resource the blips will be removed for easy development

Map

Blip

This is the baseclass for blips, you can use these methods below or use directly the natives

Getters

GetHandle

return · integer

Get the handle of the blip

GetBlipColor

color · string|table · required

Get the color value's for blip colors, can be a single color string or table of color strings

return · integer

Returns the color value's corresponding to the color name's

    -- single string or multiple colors can be requested just for ease of use
    local blue, red, yellow = Map.Blips:GetBlipColor({ 'blue', 'red', 'yellow' }) 
    blip:AddModifierColor(blue) -- or string  "blue"

Inputs

this module is used to create input controls for your resource, single or multiple , without the user having to create loops and a bunch of code all creations are instanced objects every creation will have its own instance and wont be shared with other scripts since its imported to your script when you restart your resource the inputs will be removed for easy development

Inputs

Input

use these methods below to manage input controls

Setters

Destroy

return · nil

Destroy the input instance and stop all processing

RemoveKey

key · string · required

Remove a specific key from multiple inputs or if single input , destroys the input

Pause

return · nil

Pause the input processing without destroying the instance

Resume

return · nil

Resume the input processing after being paused

Update

data · table · required

Update custom parameters for the input if needed

key · string|integer · required

Required if using multiple inputs - specifies which input to update

Start

return · nil

Start the input processing if is not running, useful when you set state to false and start this when player is near something or character is selected

Prompts

this module is used to create prompts with coordinate-based activation, multiple prompts can be grouped together and managed as one unit all creations are instanced objects every creation will have its own instance and wont be shared with other scripts since its imported to your script when you restart your resource the prompts will be removed for easy development

Prompts

Prompt

use these methods below to manage prompts

Getters

GetHandle

key · string|integer · required

The key identifier of the specific prompt, its whatever you set in the register

return · integer

Get the handle of a specific prompt by key

GetPromptGroup

key · string|integer · required

The key identifier of the specific prompt, its whatever you set in the register

return · integer

Get the group ID of a specific prompt

GetGroupLabel

key · string|integer · required

The key identifier of the specific prompt, its whatever you set in the register

return · string

Get the group label of a specific prompt

IsRunning

return · boolean

Check if the prompt you registered is currently running

Commands

this module is used to register client-side/server-side commands with permissions, suggestions, and argument validation all creations are instanced objects every creation will have its own instance and wont be shared with other scripts since its imported to your script when you restart your resource the commands will be removed for easy development, if a command is active and suggestion hasnt been marked to add on register, it will be added on character selected automatically

Client

Command

use these methods below to manage command controls

Setters

Remove

return · nil

Removes the command and its suggestion from chat

AddSuggestion

return · nil

Adds command suggestion to chat

RemoveSuggestion

return · nil

Removes the command suggestion from chat

Pause

return · nil

Pause the command without removing it (temporarily disables the command)

Resume

return · nil

Resume the command after being paused

Destroy

return · nil

Completely destroy the command instance and clean up

Start

addSuggestion · boolean

Whether to add chat suggestion when registering the command, use this only on runtime, by default when player selects character suggestion is added automatically

return · nil

Start/activate the command

OnExecute

callback · function · required

its called when the command is executed

OnError

callback · function

its called when the command has errors

Points

this module is used to create coordinate-based enter/exit areas with radius detection, multiple points can be registered and managed independently all creations are instanced objects every creation will have its own instance and wont be shared with other scripts since its imported to your script when you restart your resource the points will be removed for easy development

Points

Point

use these methods below to manage points

Getters

IsPointActive

id · string|integer · required

The unique identifier of the point to check

return · boolean

Returns true if the point is active and not deactivated

IsPointInside

id · string|integer · required

The unique identifier of the point to check

return · boolean

Returns true if the player is currently inside the point radius

IsPointOutside

id · string|integer · required

The unique identifier of the point to check

return · boolean

Returns true if the player is currently outside the point radius

Events

this module is used to register game event listeners that can capture and process native game events with automatic data parsing all creations are instanced objects every creation will have its own instance and wont be shared with other scripts since its imported to your script when you restart your resource the event listeners will be removed for easy development

Events

Event

use these methods below to manage event listeners

Setters

Start

return · nil

Start the event listener and begin monitoring for the registered event

Pause

return · nil

Pause the event listener without destroying the instance

Resume

return · nil

Resume the event listener after being paused

Destroy

return · nil

Destroy the event listener instance and clean up

DevMode

enabled · boolean · required

Enable or disable developer mode for debugging events

eventsToIgnore · string|array

Optional events to ignore when in dev mode (can be event name string, hash)

return · nil

When enabled, logs all events in the group. Use eventsToIgnore to filter out noise.

    -- Enable dev mode and ignore specific events
    event:DevMode(true, {"EVENT_PED_CREATED", "EVENT_PED_DESTROYED"})
    
    -- Enable dev mode for all events
    event:DevMode(true)
    
    -- Disable dev mode
    event:DevMode(false)

DataView

this module provides JavaScript-like DataView functionality for handling binary data in Lua with support for various data types and endianness this module is based on gottfriedleibniz’s DataView implementation providing efficient binary data manipulation

DataView

DataView

use these methods below to manage binary data

Getters

Buffer

return · string

Get the underlying binary buffer as a string

ByteLength

return · integer

Get the length of the buffer in bytes

ByteOffset

return · integer

Get the current offset position within the buffer

Data Type Getters

Available getter methods for reading different data types:

• GetInt8(offset, endian) - Read 8-bit signed integer
• GetUint8(offset, endian) - Read 8-bit unsigned integer
• GetInt16(offset, endian) - Read 16-bit signed integer
• GetUint16(offset, endian) - Read 16-bit unsigned integer
• GetInt32(offset, endian) - Read 32-bit signed integer
• GetUint32(offset, endian) - Read 32-bit unsigned integer
• GetInt64(offset, endian) - Read 64-bit signed integer
• GetUint64(offset, endian) - Read 64-bit unsigned integer
• GetFloat32(offset, endian) - Read 32-bit float
• GetFloat64(offset, endian) - Read 64-bit double
• GetString(offset, endian) - Read null-terminated string
• GetLuaInt(offset, endian) - Read Lua integer
• GetLuaNum(offset, endian) - Read Lua number

offset · integer · required

Byte offset from buffer start to read from

endian · boolean

Endianness: true for big-endian, false/nil for little-endian

return · number|string|nil

The read value, or nil if offset is out of bounds

Fixed Size Getters

• GetFixedString(offset, length, endian) - Read fixed-length string
• GetFixedInt(offset, length, endian) - Read fixed-size signed integer
• GetFixedUint(offset, length, endian) - Read fixed-size unsigned integer

offset · integer · required

Byte offset from buffer start

length · integer · required

Number of bytes to read

endian · boolean

Endianness: true for big-endian, false/nil for little-endian

Streaming

this module provides utility functions for loading various game assets like models, animations, textures, and more with automatic cleanup and timeout handling all functions handle the loading process with proper validation and error handling, preventing common issues with asset streaming

Streaming

Asset Loading

use these functions below to load various game assets with automatic cleanup

Models & Textures

LoadModel

model · string|integer · required

Model name (string) or hash (integer) to load

timeout · integer

Optional timeout in milliseconds to automatically unload the model and free memory

return · nil

Loads and validates the model, throws error if invalid or fails to load within 5 seconds

LoadTextureDict

dict · string · required

Texture dictionary name to load

timeout · integer

Optional timeout in milliseconds to automatically unload the texture dictionary

return · nil

Loads texture dictionary with validation and error handling

LoadParticleFx

dict · string · required

Particle effect dictionary name to load

timeout · integer

Optional timeout in milliseconds to automatically remove the particle effect asset

return · nil

Loads particle effect dictionary for use with particle systems

Class

this module provides a complete object-oriented programming system for Lua with classes, inheritance, private members, and automatic getters/setters supports both traditional Lua OOP patterns and modern structured approaches with automatic property management was inspired by JavaScript classes

Class

OOP System

use these methods below to create classes with full OOP support

Class Creation

Create

base · table|class

Base class to inherit from, or table of initial methods/properties

className · string

Optional name for the class (used in error messages)

return · class

Returns a new class that can create instances with :New()

    -- Import the class module
    local Lib = Import 'class' --[[@as CLASS]]
    
    -- Create a basic class
    local MyClass = Lib.Class:Create({
        constructor = function(self, name)
            self.name = name
        end,
        
        getName = function(self)
            return self.name
        end
    }, "MyClass")
    
    -- Create instance
    local instance = MyClass:New("Test")
    print(instance:getName()) -- "Test"

• Traditional Lua example

 local MyClass = Lib.Class:Create({},"MyClass")

 function MyClass:constructor(name)
    self.name = name
 end

 function MyClass:getName()
    return self.name
 end

 local instance = MyClass:New("Test")
 print(instance:getName()) -- "Test"

New

... · any

Arguments to pass to the constructor

return · instance

Returns a new instance of the class

Creates new instances of the class. Supports both table-based and argument-based constructors.

    -- Table-based constructor
    local instance1 = MyClass:New({
        name = "John",
        age = 30
    })
    
    -- Argument-based constructor  
    local instance2 = MyClass:New("John", 30)

Functions

utility classes for control flow, timing, and conditional execution provides Switch-case patterns, repeating intervals, and one-time timeouts with full control over execution state shared between server and client environments

Functions

Control Flow & Timing

use these utilities for advanced control flow and timing operations

Switch

value · any

The value to match against cases

creates a switch-case control structure that allows chaining case statements and default handling inspired by JS

    -- Import the functions module
    local Lib = Import 'functions' --[[@as FUNCTIONS]]
    
    -- Basic switch usage
    local result = Lib.Switch(playerLevel)
        :case(1, function(value) 
            return "Beginner" 
        end)
        :case(2, function(value) 
            return "Intermediate" 
        end)
        :case(3, function(value) 
            return "Advanced" 
        end)
        :default(function(value) 
            return "Unknown Level: " .. value 
        end)
        :execute()
    
    print(result)

Notify

notification module for displaying various types of notifications to players from the base game supports both server and client environments with different method signatures

Client

Notify

use these methods below to display notifications on client side

Left

title · string · required

Title text for the notification

subtitle · string · required

Subtitle text for the notification

dict · string · required

Texture dictionary name

icon · string · required

Icon name from the dictionary

duration · integer · default: "5000"

Duration in milliseconds

color · string · default: "COLOR_WHITE"

Color name for the notification

Tip

tipMessage · string · required

Message to display in the tip

duration · integer · default: "5000"

Duration in milliseconds

Top

message · string · required

Message text to display

location · string · required

Location identifier for positioning

duration · integer · default: "5000"

Duration in milliseconds

RightTip

tipMessage · string · required

Message to display in the right tip

duration · integer · default: "5000"

Duration in milliseconds

Objective

message · string · required

Objective message text

duration · integer · default: "5000"

Duration in milliseconds

SimpleTop

title · string · required

Title text

subtitle · string · required

Subtitle text

duration · integer · default: "5000"

Duration in milliseconds

RightAdvanced

text · string · required

Main text content

dict · string · required

Texture dictionary name

icon · string · required

Icon name from dictionary

text_color · string · default: "COLOR_WHITE"

Text color name

duration · integer · default: "5000"

Duration in milliseconds

quality · integer · default: "1"

Quality level for display

showquality · boolean

Whether to show quality indicator

BasicTop

text · string · required

Text to display

duration · integer · default: "5000"

Duration in milliseconds

Center

text · string · required

Text to display in center

duration · integer · default: "5000"

Duration in milliseconds

text_color · string · default: "COLOR_PURE_WHITE"

Text color name

BottomRight

text · string · required

Text to display

duration · integer · default: "5000"

Duration in milliseconds

Fail

title · string · required

Failure title

subtitle · string · required

Failure subtitle

duration · integer · default: "5000"

Duration in milliseconds

Dead

title · string · required

Death message title

audioRef · string · required

Audio reference for sound

audioName · string · required

Audio name for sound

duration · integer · default: "5000"

Duration in milliseconds

Update

title · string · required

Update title

message · string · required

Update message

duration · integer · default: "5000"

Duration in milliseconds

Warning

title · string · required

Warning title

message · string · required

Warning message

audioRef · string · required

Audio reference for sound

audioName · string · required

Audio name for sound

duration · integer · default: "5000"

Duration in milliseconds

LeftRank

title · string · required

Rank title

subtitle · string · required

Rank subtitle

dict · string · required

Texture dictionary

texture · string · required

Texture name

duration · integer · default: "5000"

Duration in milliseconds

color · string · default: "COLOR_WHITE"

Color name

Test

return · nil

Displays all notification types for testing