Skip to main content
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
return
table
The core table containing all the getters and setters.

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
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.
jobsData
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.
resourceName
string
required
The resource name to register the jobs to for debug

Notifications

notifications can also accept -1 as duration to always stay on screen and to clear them you need to use UiFeedClearChannel
Shared
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
title
string
required
The title of the notification
duration
number
required
Duration in milliseconds
title
string
required
The title of the notification
duration
number
required
Duration in milliseconds
title
string
required
The title of the notification
duration
number
required
Duration in milliseconds
title
string
required
The title of the notification
location
string
required
The location to display
duration
number
required
Duration in milliseconds
title
string
required
The title of the notification
subtitle
string
required
The subtitle of the notification
duration
number
required
Duration in milliseconds
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
quality
number
required
enables the stars for quality like animal pelt stars
showQuality
boolean
required
shows the quality of the notification
title
string
required
The title of the notification
duration
number
required
Duration in milliseconds
title
string
required
The title of the notification
duration
number
required
Duration in milliseconds
title
string
required
The title of the notification
subtitle
string
required
The subtitle of the notification
duration
number
required
Duration in milliseconds
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
title
string
required
The title of the notification
subtitle
string
required
The subtitle of the notification
duration
number
required
Duration in milliseconds
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
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
title
string
required
The title of the notification
duration
number
required
Duration in milliseconds
title
string
required
The title of the notification
description
string
required
The description of the notification
second_description
string
required
The second description of the notification
duration
number
required
Duration in milliseconds
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 or -1 for infinite
color
string
required
Color of the notification

Characters

Get the character data to access getters and setters
Server
source
integer
required
The player ID
return
string
The unique identifier of the character
return
string
The unique character identifier
return
string
The group the character belongs to
return
table
The multiJobs of the character
return
string
The job of the character
return
integer
The job grade of the character
return
string
The job label of the character
return
number
The amount of money the character has
return
number
The amount of gold the character has
return
number
The amount of rol the character has
return
number
The amount of experience points the character has
return
string
The first name of the character
return
string
The last name of the character
return
table
The status of the character
return
table
The coordinates of the character
return
boolean
Whether the character is dead or not
return
table
The skin details of the character
return
table
The component details of the character
return
table
The component tints of the character
return
number
The age of the character
return
string
The gender of the character
return
string
The description of the character
return
string
The nickname of the character
return
number
The inventory capacity of the character
return
table
The skills of the character

Users

Get the user data to access getters and setters
source
number
required
The player ID
maxJobs
number
required
The maximum number of jobs allowed for the user
charid
number
required
The character ID
return
string
The user group (not character group)
return
integer
The user’s source (player ID)
return
number
The maximum number of jobs allowed for the user

Whitelist

Server
identifier
string
required
The identifier of the whitelist entry

Webhooks

Shared
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
The logo of the webhook
The footerlogo of the webhook
avatar
string
The avatar of the webhook

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
remove players from instance

Player

Available through core export
Server Side
when using these functions you will benefit of the event listeners OnPlayerDeath OnPlayerRevive OnPlayerRespawn
source
integer
required
The player ID
source
integer
required
The player ID
source
integer
required
The player ID

Callbacks

Callbacks are available through core export or single exports
if you need only the call back system
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
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
register a callback on the server to receive a client callback
name
string
required
The name of the callback
callback
function
required
The callback function
source
integer
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

Events

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

onGroupChange

onJobChange

onJobGradeChange

onPlayerDeath

when player dies this event is triggered

onPlayerRevive

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

onPlayerRespawn

when player respawns through VORP Core export this event will trigger

onPlayerHeal

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

onPlayerLevelUp

triggered when a player has leveled up or down

onPlayerSpawned

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

Dataview

call dataview in your script fxmanifest

GlobalStates

  • easily get players count from client or server

Statebags

statebag getters that allow you to get the character data
Shared
is player in session? this will return true when player choose his character
return
boolean
The IsInSession of the character
get the first name of the character
return
string
The first name of the character
get the last name of the character
return
string
The last name of the character
get the job of the character
return
string
The job of the character
get the job label of the character
return
string
The job label of the character
get the grade of the character
return
integer
The grade of the character
get the group of the character
return
string
The group of the character
get the age of the character
return
integer
The age of the character
get the gender of the character
return
string
The gender of the character
get the nickname of the character
return
string
The nickname of the character
get the character description of the character
return
string
The character description of the character
get the money of the character
return
integer
The money of the character
get the gold of the character
return
integer
The gold of the character
get the rol of the character
return
integer
The rol of the character
get the charid of the character
return
integer
The charid of the character

Version

Use vorp version check with change logs feature in your scripts add this in your fxmanifest
example of a version.file