core - VORP Core

This documentation is for developers who are making scripts for VORP Core Framework

Export

GetCore is a shared export that returns the core table containing all the getters and setters for VORP Core. some of the getters and setters are client side only and some are server side only.

Shared

GetCore

table

The core table containing all the getters and setters.

local Core = exports.vorp_core:GetCore()

Register Server Jobs

Allowing you to only give correct jobs and grades to the players and to prevent them from using incorrect jobs and grades.

Server Side

RegisterJobs

RegisterJobs

Register jobs to the server, this will be stored in config/jobs.lua file in vorp core then can be registered automatically using the RegisterJobs function or manually by adding the jobs to the lua file.

table

required

job data is a table with the following keys:

jobname: string job name as the key and the job data as the value.
groups: array optional, if you wish to set this job to only this group can give this job.
privateJob: boolean if true, the job will be private no one can give this job.
grades: table only add grades if you use grades
[grade]: table grade number as the key and the grade data as the value.
label: string the label of the grade
privateGrade: boolean if true, the grade will be private no one can give this grade.

string

required

The resource name to register the jobs to for debug

local jobsData <const> = {
    jobname = {
        groups = {"admin"} -- optional, if you wish to set this job to only this group can give this job.
        privateJob = true -- if true, the job will be private no one can give this job.
        grades = { -- only add grades if you use grades
            [1] = {
                label = "Grade Label"
                privateGrade = true -- if true, the grade will be private no one can give this grade.
            }
        }
    }
}

if Core.RegisterJobs then
    Core.RegisterJobs(jobsData, GetCurrentResourceName())
else
    print("Core.RegisterJobs is not available update vorp core to the latest version")
end

Notifications

notifications can also accept -1 as duration to always stay on screen and to clear them you need to use UiFeedClearChannel

Shared

Client
Server

NotifyLeft

string

required

The title of the notification

string

required

The subtitle of the notification

string

required

The dictionary for the icon

string

required

The icon name

number

required

Duration in milliseconds

string

required

Color of the notification

Core.NotifyLeft("title", "subtitle", "dict", "icon", 4000, "color")

NotifyTip

string

required

The title of the notification

number

required

Duration in milliseconds

Core.NotifyTip("title", 4000)

NotifyRightTip

string

required

The title of the notification

number

required

Duration in milliseconds

Core.NotifyRightTip("title", 4000)

NotifyObjective

string

required

The title of the notification

number

required

Duration in milliseconds

Core.NotifyObjective("title", 4000)

NotifyTop

string

required

The title of the notification

string

required

The location to display

number

required

Duration in milliseconds

Core.NotifyTop("title", "location", 4000)

NotifySimpleTop

string

required

The title of the notification

string

required

The subtitle of the notification

number

required

Duration in milliseconds

Core.NotifySimpleTop("title", "subtitle", 4000)

NotifyAvanced

string

required

The title of the notification

string

required

The dictionary for the icon

string

required

The icon name

string

required

Color of the notification

number

required

Duration in milliseconds

number

required

enables the stars for quality like animal pelt stars

boolean

required

shows the quality of the notification

Core.NotifyAvanced("title", "dict", "icon", "color", 4000, quality, showQuality)

NotifyCenter

string

required

The title of the notification

number

required

Duration in milliseconds

Core.NotifyCenter("title", 4000)

NotifyBottomRight

string

required

The title of the notification

number

required

Duration in milliseconds

Core.NotifyBottomRight("title", 4000)

NotifyFail

string

required

The title of the notification

string

required

The subtitle of the notification

number

required

Duration in milliseconds

Core.NotifyFail("title", "subtitle", 4000)

NotifyDead

string

required

The title of the notification

string

required

The audio reference

string

required

The audio name

number

required

Duration in milliseconds

Core.NotifyDead("title", "audioref", "audioname", 4000)

NotifyUpdate

string

required

The title of the notification

string

required

The subtitle of the notification

number

required

Duration in milliseconds

Core.NotifyUpdate("title", "subtitle", 4000)

NotifyWarning

string

required

The title of the notification

string

required

The subtitle of the notification

string

required

The audio reference

string

required

The audio name

number

required

Duration in milliseconds

Core.NotifyWarning("title", "subtitle", "audioref", "audioname", 4000)

NotifyLeftRank

string

required

The title of the notification

string

required

The subtitle of the notification

string

required

The dictionary for the icon

string

required

The icon name

number

required

Duration in milliseconds

string

required

Color of the notification

Core.NotifyLeftRank("title", "subtitle", "dict", "icon", 4000, "color")

NotifyOneSimpleTop

string

required

The title of the notification

number

required

Duration in milliseconds

Core.NotifyOneSimpleTop("title", 4000)

NotifyThreeSimpleTop

string

required

The title of the notification

string

required

The description of the notification

string

required

The second description of the notification

number

required

Duration in milliseconds

Core.NotifyThreeSimpleTop("title","description","second_description", 4000)

NotifyLeftInteractive

string

required

The title of the notification

string

required

The subtitle of the notification

string

required

The dictionary for the icon

string

required

The icon name

number

required

Duration in milliseconds or -1 for infinite

string

required

Color of the notification

Core.NotifyLeftInteractive("title", "subtitle", "dict", "icon", 4000, "color")

NotifyTip

integer

required

The player ID

string

required

The title of the notification

integer

required

Duration in milliseconds

Core.NotifyTip(source, "title", 4000)

NotifyLeft

integer

required

The player ID

string

required

The title of the notification

string

required

The subtitle of the notification

string

required

The dictionary for the icon

string

required

The icon name

integer

required

Duration in milliseconds

string

required

Color of the notification

Core.NotifyLeft(source, "title", "subtitle", "dict", "icon", 4000, "color")

NotifyRightTip

integer

required

The player ID

string

required

The title of the notification

integer

required

Duration in milliseconds

Core.NotifyRightTip(source, "title", 4000)

NotifyObjective

integer

required

The player ID

string

required

The title of the notification

integer

required

Duration in milliseconds

Core.NotifyObjective(source, "title", 4000)

NotifyTop

integer

required

The player ID

string

required

The title of the notification

string

required

The location to display

integer

required

Duration in milliseconds

Core.NotifyTop(source, "title", "location", 4000)

NotifySimpleTop

integer

required

The player ID

string

required

The title of the notification

string

required

The subtitle of the notification

integer

required

Duration in milliseconds

Core.NotifySimpleTop(source, "title", "subtitle", 4000)

NotifyAvanced

integer

required

The player ID

string

required

The title of the notification

string

required

The dictionary for the icon

string

required

The icon name

string

required

Color of the notification

integer

required

Duration in milliseconds

boolean

required

Show the quality of the notification

number

required

The quality of the notification max 3

Core.NotifyAvanced(source, "title", "dict", "icon", "color",showQuality,quality, 4000)

NotifyCenter

integer

required

The player ID

string

required

The title of the notification

integer

required

Duration in milliseconds

Core.NotifyCenter(source, "title", 4000)

NotifyBottomRight

integer

required

The player ID

string

required

The title of the notification

integer

required

Duration in milliseconds

Core.NotifyBottomRight(source, "title", 4000)

NotifyFail

integer

required

The player ID

string

required

The title of the notification

string

required

The subtitle of the notification

integer

required

Duration in milliseconds

Core.NotifyFail(source, "title", "subtitle", 4000)

NotifyDead

integer

required

The player ID

string

required

The title of the notification

string

required

The audio reference

string

required

The audio name

integer

required

Duration in milliseconds

Core.NotifyDead(source, "title", "audioref", "audioname", 4000)

NotifyUpdate

integer

required

The player ID

string

required

The title of the notification

string

required

The subtitle of the notification

integer

required

Duration in milliseconds

Core.NotifyUpdate(source, "title", "subtitle", 4000)

NotifyWarning

integer

required

The player ID

string

required

The title of the notification

string

required

The subtitle of the notification

string

required

The audio reference

string

required

The audio name

integer

required

Duration in milliseconds

Core.NotifyWarning(source, "title", "subtitle", "audioref", "audioname", 4000)

NotifyLeftRank

integer

required

The player ID

string

required

The title of the notification

string

required

The subtitle of the notification

string

required

The dictionary for the icon

string

required

The icon name

integer

required

Duration in milliseconds

string

required

Color of the notification

Core.NotifyLeftRank(source, "title", "subtitle", "dict", "icon", 4000, "color")

NotifyOneSimpleTop

integer

required

The player ID

string

required

The title of the notification

integer

required

Duration in milliseconds

Core.NotifyOneSimpleTop(source, "title", 4000)

NotifyThreeSimpleTop

integer

required

The player ID

string

required

The title of the notification

string

required

The description of the notification

string

required

The second description of the notification

integer

required

Duration in milliseconds

Core.NotifyThreeSimpleTop(source, "title","description","second_description", 4000)

NotifyLeftInteractive

integer

required

The player ID

string

required

The title of the notification

string

required

The subtitle of the notification

string

required

The dictionary for the icon

string

required

The icon name

integer

required

Duration in milliseconds or -1 for infinite

string

required

Color of the notification

Core.NotifyLeftInteractive(source, "title", "subtitle", "dict", "icon", 4000, "color")

Characters

Get the character data to access getters and setters

Server

getUsedCharacter

integer

required

The player ID

    local user = Core.getUser(source) --[[@as User]]  
    if not user then return end -- is player in session?
    local character = user.getUsedCharacter --[[@as Character]]

getters
setters

identifier

string

The unique identifier of the character

local identifier = character.identifier

charIdentifier

string

The unique character identifier

local charIdentifier = character.charIdentifier

group

string

The group the character belongs to

local group = character.group

multiJobs

table

The multiJobs of the character

local multijobs = character.multiJobs
for _, job in pairs(multiJobs) do   
    print(job.job, job.grade, job.label)
end

job

string

The job of the character

local job = character.job

jobGrade

integer

The job grade of the character

local jobGrade = character.jobGrade

jobLabel

string

The job label of the character

local jobLabel = character.jobLabel

money

number

The amount of money the character has

local money = character.money

gold

number

The amount of gold the character has

local gold = character.gold

rol

number

The amount of rol the character has

local rol = character.rol

number

The amount of experience points the character has

local xp = character.xp

firstname

string

The first name of the character

local firstname = character.firstname

lastname

string

The last name of the character

local lastname = character.lastname

status

table

The status of the character

local status = character.status

coords

table

The coordinates of the character

local coords = character.coords

isdead

boolean

Whether the character is dead or not

local isDead = character.isdead

skin

table

The skin details of the character

local skin = character.skin

comps

table

The component details of the character

local comps = character.comps

compTints

table

The component tints of the character

local compTints = character.compTints

age

number

The age of the character

local age = character.age

gender

string

The gender of the character

local gender = character.gender

charDescription

string

The description of the character

local charDescription = character.charDescription

nickname

string

The nickname of the character

local nickname = character.nickname

invCapacity

number

The inventory capacity of the character

local invCapacity = character.invCapacity

skills

table

The skills of the character

local skills = character.skills
local skill = skills.Crafting
if not skill then return print("skill not found in core config or it doesn't exist") end
local skillExp = skill.Exp
local skillLevel = skill.Level

setJob

string

required

The job name to set

boolean

If true, the job change event won’t be triggered

 character.setJob("job", flag)

setMultiJob

multijobs can be added to users and they can switch between them using the switch command in vorp core listen for job change events to know when the user switches jobs

string

required

The job name to set

number

required

The job grade to set

string

required

The job label to set

character.setMultiJob("job", 1, "label")

removeMultiJob

string

required

The job name to remove

character.removeMultiJob("job")

getMultiJobsCount

number

The number of multijobs the character has

local multiJobCount = character.getMultiJobsCount()

setJobGrade

number

required

The job grade to set

boolean

If true, the job change event won’t be triggered

character.setJobGrade(1, flag)

setJobLabel

string

required

The job label to set

character.setJobLabel("Label")

setGroup

string

required

The group to set

boolean

If true, the group change event won’t be triggered

character.setGroup("admin", false)

setRol

number

required

Set the amount of Rol of the character

character.setRol(1000)

setXp

number

required

Set the amount of XP of the character

character.setXp(5000)

setFirstname

string

required

Set the first name of the character

character.setFirstname("Sadie")

setLastname

string

required

Set the last name of the character

character.setLastname("Adler")

updateSkin

string

required

The skin in JSON format

character.updateSkin("skin")

updateComps

string

required

The clothing components in JSON format

character.updateComps("comps")

updateCompTints

string

required

The clothing components tints in JSON format

character.updateCompTints("comps")

addCurrency

number

required

The currency type (0 = money, 1 = gold, 2 = rol)

number

required

The amount to add to character

character.addCurrency(0, 1000)

removeCurrency

number

required

The currency type (0 = money, 1 = gold, 2 = rol)

number

required

The amount to remove from character

character.removeCurrency(0, 1000)

addXp

number

required

The amount of XP to add

character.addXp(100)

removeXp

number

required

The amount of XP to remove

character.removeXp(100)

setAge

number

required

The age to set to the character

character.setAge(45)

setCharDescription

string

required

The character description to set to the character

character.setCharDescription("string")

setNickName

string

required

The nickname to set to the character

character.setNickName("string")

setGender

string

required

The gender to set (male or female)

character.setGender("string")

updateInvCapacity

number

required

The amount to change the inventory capacity by (can be positive or negative) its also incremental so 1000 will be 1000 + what you already have

character.updateInvCapacity(1)

setSkills

string

required

The name of the skill to set, these skillNames will be in VORP Core config skills

number

required

the Exp value to be set to the skillName you passed values are incremental so 1000 exp will be 1000 + what you already have

character.setSkills("skillName", 10) -- skillname exp

Users

Get the user data to access getters and setters

getUser

number

required

The player ID

local user = Core.getUser(source) --[[@as User]]  
if not user then return end -- is player in session?

setMaxJobsAllowed

number

required

The maximum number of jobs allowed for the user

user.setMaxJobsAllowed(maxJobs)

getters
setters

getUserByCharId

number

required

The character ID

local user = Core.getUserByCharId(charid) --[[@as User]]

getGroup

string

The user group (not character group)

local userGroup = user.getGroup

source

integer

The user’s source (player ID)

local userSource = user.source

maxJobsAllowed

number

The maximum number of jobs allowed for the user

local maxJobsAllowed = user.maxJobsAllowed

SetGroup

string

required

The group to set for the user

user.SetGroup(group)

getIdentifier

number

The steam ID of the user

local steam = user.getIdentifier()

getUserCharacters

table

All characters of the user

local data = user.getUserCharacters()

getPlayerwarnings

integer

The warning status of the user

local warnstatus = user.getPlayerwarnings()

Whitelist

Server

getters
setters

getEntry

string

required

The identifier of the whitelist entry

local data = Core.Whitelist.getEntry(identifier)
print(json.encode(data),{ident = true})

whitelistUser

string

required

The identifier of the whitelist entry

Core.Whitelist.whitelistUser(identifier)

unWhitelistUser

string

required

The identifier of the whitelist entry

Core.Whitelist.unWhitelistUser(identifier)

Webhooks

Shared

AddWebhook

string

required

The title of the webhook

string

required

The webhook link

string

required

The description of the webhook

number

required

The color of the webhook

string

required

The name of the webhook

string

The logo of the webhook

string

The footerlogo of the webhook

string

The avatar of the webhook

Core.AddWebhook("title", "webhook", "description", 12345678, "name", "logo", "footerlogo", "avatar")

Instancing

Client

to add a players to different instances use his server id + instance number to add players to same instance use only the instanceNumber

local instanceNumber = 54123 -- any number
VORPcore.instancePlayers(GetPlayerServerId(PlayerId())+ instanceNumber)

remove players from instance

VORPcore.instancePlayers(0)

Player

Available through core export

Server Side
when using these functions you will benefit of the event listeners OnPlayerDeath OnPlayerRevive OnPlayerRespawn

Heal

integer

required

The player ID

Core.Player.Heal(source)

Revive

integer

required

The player ID

Core.Player.Revive(source)

Respawn

integer

required

The player ID

Core.Player.Respawn(source)

Callbacks

Callbacks are available through core export or single exports

Server
Client

if you need only the call back system

local ServerRPC = exports.vorp_core:ServerRpcCall() --[[@as ServerRPC]] -- for intellisense

TriggerAwait

trigger a synchronous callback from client to server

string

required

The name of the callback

any

The parameters to pass to the callback

any

The result of the callback

local result =  Core.Callback.TriggerAwait(name,...)
print(result)

TriggerAsync

trigger an asynchronous callback from client to server

string

required

The name of the callback

any

The parameters to pass to the callback

any

The result of the callback

Core.Callback.TriggerAsync(name, function(result)
  print(result)
 end, ...)

string

required

The name of the callback

function

required

The callback function

integer

The source of the callback

function

The callback function

any

The parameters to pass to the callback

any

The result of the callback

Core.Callback.Register(name, function(source,callback,...)
   callback(...)
 end)

if you need only the call back system

local ClientRPC = exports.vorp_core:ClientRpcCall() --[[@as ClientRPC]] -- for intellisense

TriggerAwait

trigger a server to client callback synchronously

string

required

The name of the callback

integer

The source of the callback

any

The parameters to pass to the callback

any

The result of the callback

local result = Core.Callback.TriggerAwait(name,source,...)
print(result)

TriggerAsync

trigger an asynchronous callback from client to server

string

required

The name of the callback

integer

The source of the callback

any

The parameters to pass to the callback

any

The result of the callback

Core.Callback.TriggerAsync(name, source, function(result)
  print(result)
 end, ...)

string

required

The name of the callback

function

required

The callback function

any

The parameters to pass to the callback

any

The result of the callback

Core.Callback.Register(name, function(callback,...)
 callback(...)
end)        

Events

Event Listeners to detect changes in the player state when player job and group changes these events are triggered

Server Side

onGroupChange

AddEventHandler("vorp:playerGroupChange",function(source, newgroup,oldgroup) end)

onJobChange

AddEventHandler("vorp:playerJobChange", function(source, newjob,oldjob) end)

onJobGradeChange

AddEventHandler("vorp:playerJobGradeChange",function(source, newjobgrade,oldjobgrade) end)

onPlayerDeath

when player dies this event is triggered

--CLIENT
AddEventHandler("vorp_core:Client:OnPlayerDeath",function(killerserverid,causeofdeath) end)

--SERVER
RegisterNetEvent("vorp_core:Server:OnPlayerDeath",function(killerserverid,causeofdeath) end)

onPlayerRevive

when player is revived through VORP Core export this event will trigger

--SERVER
AddEventHandler("vorp_core:Server:OnPlayerRevive",function(source)end)

--CLIENT
RegisterNetEvent("vorp_core:Client:OnPlayerRevive")

onPlayerRespawn

when player respawns through VORP Core export this event will trigger

--SERVER
AddEventHandler("vorp_core:Server:OnPlayerRespawn"function(source)end)

--CLIENT
RegisterNetEvent("vorp_core:Client:OnPlayerRespawn")

onPlayerHeal

when player is healed through VORP Core export this event will trigger

--SERVER
AddEventHandler("vorp_core:Server:OnPlayerHeal",function(source) end)
--CLIENT
RegisterNetEvent("vorp_core:Client:OnPlayerHeal")

onPlayerLevelUp

triggered when a player has leveled up or down

--SERVER
AddEventHandler("vorp_core:Server:OnPlayerLevelUp",function(source,skillName,newLevel,oldLevel) end)
--CLIENT
RegisterNetEvent("vorp_core:Client:OnPlayerLevelUp",function(skillName,newLevel,oldLevel) end)

onPlayerSpawned

triggered when a player has fully spawned after teleportation and loading screens

--CLIENT
AddEventHandler("vorp_core:Client:OnPlayerSpawned",function()end)

Dataview

call dataview in your script fxmanifest

 client_scripts {
    '@vorp_core/client/dataview.lua'
 }

GlobalStates

easily get players count from client or server

GlobalState.PlayersInSession

Statebags

statebag getters that allow you to get the character data

Shared

client
server

IsInSession

is player in session? this will return true when player choose his character

boolean

The IsInSession of the character

LocalPlayer.state.IsInSession

FirstName

get the first name of the character

string

The first name of the character

LocalPlayer.state.Character.FirstName

LastName

get the last name of the character

string

The last name of the character

LocalPlayer.state.Character.LastName

Job

get the job of the character

string

The job of the character

LocalPlayer.state.Character.Job

JobLabel

get the job label of the character

string

The job label of the character

LocalPlayer.state.Character.JobLabel

Grade

get the grade of the character

integer

The grade of the character

LocalPlayer.state.Character.Grade

Group

get the group of the character

string

The group of the character

LocalPlayer.state.Character.Group

Age

get the age of the character

integer

The age of the character

LocalPlayer.state.Character.Age

Gender

get the gender of the character

string

The gender of the character

LocalPlayer.state.Character.Gender

NickName

get the nickname of the character

string

The nickname of the character

LocalPlayer.state.Character.NickName

CharDescription

get the character description of the character

string

The character description of the character

LocalPlayer.state.Character.CharDescription

Money

get the money of the character

integer

The money of the character

LocalPlayer.state.Character.Money

Gold

get the gold of the character

integer

The gold of the character

LocalPlayer.state.Character.Gold

Rol

get the rol of the character

integer

The rol of the character

LocalPlayer.state.Character.Rol

CharId

get the charid of the character

integer

The charid of the character

LocalPlayer.state.Character.CharId

IsInSession

is player in session? this will return true when player choose his character

boolean

The IsInSession of the character

Player(source).state.IsInSession

FirstName

get the first name of the character

string

The first name of the character

Player(source).state.Character.FirstName

LastName

get the last name of the character

string

The last name of the character

Player(source).state.Character.LastName

Job

get the job of the character

string

The job of the character

Player(source).state.Character.Job

JobLabel

get the job label of the character

string

The job label of the character

Player(source).state.Character.JobLabel

Grade

get the grade of the character

integer

The grade of the character

Player(source).state.Character.Grade

Group

get the group of the character

string

The group of the character

Player(source).state.Character.Group

Age

get the age of the character

integer

The age of the character

Player(source).state.Character.Age

Gender

get the gender of the character

string

The gender of the character

Player(source).state.Character.Gender

NickName

get the nickname of the character

string

The nickname of the character

Player(source).state.Character.NickName

CharDescription

get the character description of the character

string

The character description of the character

Player(source).state.Character.CharDescription

Money

get the money of the character

integer

The money of the character

Player(source).state.Character.Money

Gold

get the gold of the character

integer

The gold of the character

Player(source).state.Character.Gold

Rol

get the rol of the character

integer

The rol of the character

Player(source).state.Character.Rol

CharId

get the charid of the character

integer

The charid of the character

Player(source).state.Character.CharId

Version

Use vorp version check with change logs feature in your scripts add this in your fxmanifest

-- version must match version.file
version '0.0.1'
vorp_checker 'yes'
-- can use color codes ^1
vorp_name '^5your resource name ^4version Check^3' 
-- path to the github repository, in here it must have a version.file file type where your change logs will be, also must be public repository
vorp_github 'https://github.com/repository/resource_name' 

example of a version.file

<0.0.1> -- version must be the same in fxmanifest
- new version
- added feature
- removed feature
- fixed something