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

Notifications

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

Shared

NotifyLeft

title

string

required

The title of the notification

subtitle

string

required

The subtitle of the notification

dict

string

required

The dictionary for the icon

icon

string

required

The icon name

duration

number

required

Duration in milliseconds

color

string

required

Color of the notification

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

NotifyTip

NotifyLeft

title

string

required

The title of the notification

subtitle

string

required

The subtitle of the notification

dict

string

required

The dictionary for the icon

icon

string

required

The icon name

duration

number

required

Duration in milliseconds

color

string

required

Color of the notification

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

NotifyRightTip

NotifyObjective

NotifyTop

NotifySimpleTop

title

string

required

The title of the notification

subtitle

string

required

The subtitle of the notification

duration

number

required

Duration in milliseconds

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

NotifyAvanced

title

string

required

The title of the notification

dict

string

required

The dictionary for the icon

icon

string

required

The icon name

color

string

required

Color of the notification

duration

number

required

Duration in milliseconds

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

NotifyCenter

NotifyBottomRight

NotifyFail

title

string

required

The title of the notification

subtitle

string

required

The subtitle of the notification

duration

number

required

Duration in milliseconds

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

NotifyDead

title

string

required

The title of the notification

audioref

string

required

The audio reference

audioname

string

required

The audio name

duration

number

required

Duration in milliseconds

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

NotifyUpdate

title

string

required

The title of the notification

subtitle

string

required

The subtitle of the notification

duration

number

required

Duration in milliseconds

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

NotifyWarning

title

string

required

The title of the notification

subtitle

string

required

The subtitle of the notification

audioref

string

required

The audio reference

audioname

string

required

The audio name

duration

number

required

Duration in milliseconds

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

NotifyLeftRank

title

string

required

The title of the notification

subtitle

string

required

The subtitle of the notification

dict

string

required

The dictionary for the icon

icon

string

required

The icon name

duration

number

required

Duration in milliseconds

color

string

required

Color of the notification

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

Characters

Get the character data to access getters and setters

Server

getUsedCharacter

source

number

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]]

identifier

charIdentifier

group

job

jobGrade

jobLabel

money

gold

rol

firstname

lastname

status

coords

isdead

skin

comps

compTints

age

gender

charDescription

nickname

invCapacity

skills

return

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

Users

Get the user data to access getters and setters

getUser

getUserByCharId

getGroup

source

Whitelist

Server

getEntry

Webhooks

Shared

AddWebhook

title

string

required

The title of the webhook

webhook

string

required

The webhook link

description

string

required

The description of the webhook

color

number

required

The color of the webhook

name

string

required

The name of the webhook

logo

string

The logo of the webhook

footerlogo

string

The footerlogo of the webhook

avatar

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

Revive

Respawn

Callbacks

Callbacks are available through core export or single exports

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

name

string

required

The name of the callback

...

any

The parameters to pass to the callback

return

any

The result of the callback

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

TriggerAsync

trigger an asynchronous callback from client to server

name

string

required

The name of the callback

...

any

The parameters to pass to the callback

return

any

The result of the callback

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

name

string

required

The name of the callback

callback

function

required

The callback function

source

number

The source of the callback

callback

function

The callback function

...

any

The parameters to pass to the callback

return

any

The result of the callback

Core.Callback.Register(name, function(source,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

IsInSession

FirstName

LastName

Job

JobLabel

Grade

Group

Age

Gender

NickName

CharDescription

Money

Gold

Rol

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

API Documentation

​Export

​Notifications

​Characters

​Users

​Whitelist

​Webhooks

​Instancing

​Player

​Callbacks

​Events

​onGroupChange

​onJobChange

​onJobGradeChange

​onPlayerDeath

​onPlayerRevive

​onPlayerRespawn

​onPlayerHeal

​onPlayerLevelUp

​onPlayerSpawned

​Dataview

​GlobalStates

​Statebags

​Version

Export

Notifications

Characters

Users

Whitelist

Webhooks

Instancing

Player

Callbacks

Events

onGroupChange

onJobChange

onJobGradeChange

onPlayerDeath

onPlayerRevive

onPlayerRespawn

onPlayerHeal

onPlayerLevelUp

onPlayerSpawned

Dataview

GlobalStates

Statebags

Version