> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vorp-core.com/llms.txt
> Use this file to discover all available pages before exploring further.
# core
> API reference for 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
The core table containing all the getters and setters.
```lua theme={null}
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
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.
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.
The resource name to register the jobs to for debug
```lua theme={null}
local jobsData = {
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
The title of the notification
The subtitle of the notification
The dictionary for the icon
The icon name
Duration in milliseconds
Color of the notification
```lua theme={null}
Core.NotifyLeft("title", "subtitle", "dict", "icon", 4000, "color")
```
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyTip("title", 4000)
```
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyRightTip("title", 4000)
```
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyObjective("title", 4000)
```
The title of the notification
The location to display
Duration in milliseconds
```lua theme={null}
Core.NotifyTop("title", "location", 4000)
```
The title of the notification
The subtitle of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifySimpleTop("title", "subtitle", 4000)
```
The title of the notification
The dictionary for the icon
The icon name
Color of the notification
Duration in milliseconds
enables the stars for quality like animal pelt stars
shows the quality of the notification
```lua theme={null}
Core.NotifyAvanced("title", "dict", "icon", "color", 4000, quality, showQuality)
```
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyCenter("title", 4000)
```
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyBottomRight("title", 4000)
```
The title of the notification
The subtitle of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyFail("title", "subtitle", 4000)
```
The title of the notification
The audio reference
The audio name
Duration in milliseconds
```lua theme={null}
Core.NotifyDead("title", "audioref", "audioname", 4000)
```
The title of the notification
The subtitle of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyUpdate("title", "subtitle", 4000)
```
The title of the notification
The subtitle of the notification
The audio reference
The audio name
Duration in milliseconds
```lua theme={null}
Core.NotifyWarning("title", "subtitle", "audioref", "audioname", 4000)
```
The title of the notification
The subtitle of the notification
The dictionary for the icon
The icon name
Duration in milliseconds
Color of the notification
```lua theme={null}
Core.NotifyLeftRank("title", "subtitle", "dict", "icon", 4000, "color")
```
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyOneSimpleTop("title", 4000)
```
The title of the notification
The description of the notification
The second description of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyThreeSimpleTop("title","description","second_description", 4000)
```
The title of the notification
The subtitle of the notification
The dictionary for the icon
The icon name
Duration in milliseconds or -1 for infinite
Color of the notification
```lua theme={null}
Core.NotifyLeftInteractive("title", "subtitle", "dict", "icon", 4000, "color")
```
The player ID
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyTip(source, "title", 4000)
```
The player ID
The title of the notification
The subtitle of the notification
The dictionary for the icon
The icon name
Duration in milliseconds
Color of the notification
```lua theme={null}
Core.NotifyLeft(source, "title", "subtitle", "dict", "icon", 4000, "color")
```
The player ID
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyRightTip(source, "title", 4000)
```
The player ID
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyObjective(source, "title", 4000)
```
The player ID
The title of the notification
The location to display
Duration in milliseconds
```lua theme={null}
Core.NotifyTop(source, "title", "location", 4000)
```
The player ID
The title of the notification
The subtitle of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifySimpleTop(source, "title", "subtitle", 4000)
```
The player ID
The title of the notification
The dictionary for the icon
The icon name
Color of the notification
Duration in milliseconds
Show the quality of the notification
The quality of the notification max 3
```lua theme={null}
Core.NotifyAvanced(source, "title", "dict", "icon", "color",showQuality,quality, 4000)
```
The player ID
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyCenter(source, "title", 4000)
```
The player ID
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyBottomRight(source, "title", 4000)
```
The player ID
The title of the notification
The subtitle of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyFail(source, "title", "subtitle", 4000)
```
The player ID
The title of the notification
The audio reference
The audio name
Duration in milliseconds
```lua theme={null}
Core.NotifyDead(source, "title", "audioref", "audioname", 4000)
```
The player ID
The title of the notification
The subtitle of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyUpdate(source, "title", "subtitle", 4000)
```
The player ID
The title of the notification
The subtitle of the notification
The audio reference
The audio name
Duration in milliseconds
```lua theme={null}
Core.NotifyWarning(source, "title", "subtitle", "audioref", "audioname", 4000)
```
The player ID
The title of the notification
The subtitle of the notification
The dictionary for the icon
The icon name
Duration in milliseconds
Color of the notification
```lua theme={null}
Core.NotifyLeftRank(source, "title", "subtitle", "dict", "icon", 4000, "color")
```
The player ID
The title of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyOneSimpleTop(source, "title", 4000)
```
The player ID
The title of the notification
The description of the notification
The second description of the notification
Duration in milliseconds
```lua theme={null}
Core.NotifyThreeSimpleTop(source, "title","description","second_description", 4000)
```
The player ID
The title of the notification
The subtitle of the notification
The dictionary for the icon
The icon name
Duration in milliseconds or -1 for infinite
Color of the notification
```lua theme={null}
Core.NotifyLeftInteractive(source, "title", "subtitle", "dict", "icon", 4000, "color")
```
## Characters
Get the character data to access getters and setters
Server
The player ID
```lua theme={null}
local user = Core.getUser(source) --[[@as User]]
if not user then return end -- is player in session?
local character = user.getUsedCharacter --[[@as Character]]
```
The unique identifier of the character
```lua theme={null}
local identifier = character.identifier
```
The unique character identifier
```lua theme={null}
local charIdentifier = character.charIdentifier
```
The group the character belongs to
```lua theme={null}
local group = character.group
```
The multiJobs of the character
```lua theme={null}
local multijobs = character.multiJobs
for _, job in pairs(multiJobs) do
print(job.job, job.grade, job.label)
end
```
The job of the character
```lua theme={null}
local job = character.job
```
The job grade of the character
```lua theme={null}
local jobGrade = character.jobGrade
```
The job label of the character
```lua theme={null}
local jobLabel = character.jobLabel
```
The amount of money the character has
```lua theme={null}
local money = character.money
```
The amount of gold the character has
```lua theme={null}
local gold = character.gold
```
The amount of rol the character has
```lua theme={null}
local rol = character.rol
```
The amount of experience points the character has
```lua theme={null}
local xp = character.xp
```
The first name of the character
```lua theme={null}
local firstname = character.firstname
```
The last name of the character
```lua theme={null}
local lastname = character.lastname
```
The status of the character
```lua theme={null}
local status = character.status
```
The coordinates of the character
```lua theme={null}
local coords = character.coords
```
Whether the character is dead or not
```lua theme={null}
local isDead = character.isdead
```
The skin details of the character
```lua theme={null}
local skin = character.skin
```
The component details of the character
```lua theme={null}
local comps = character.comps
```
The component tints of the character
```lua theme={null}
local compTints = character.compTints
```
The age of the character
```lua theme={null}
local age = character.age
```
The gender of the character
```lua theme={null}
local gender = character.gender
```
The description of the character
```lua theme={null}
local charDescription = character.charDescription
```
The nickname of the character
```lua theme={null}
local nickname = character.nickname
```
The inventory capacity of the character
```lua theme={null}
local invCapacity = character.invCapacity
```
The skills of the character
```lua theme={null}
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
```
The job name to set
If true, the job change event won't be triggered
```lua theme={null}
character.setJob("job", flag)
```
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
The job name to set
The job grade to set
The job label to set
```lua theme={null}
character.setMultiJob("job", 1, "label")
```
The job name to remove
```lua theme={null}
character.removeMultiJob("job")
```
The number of multijobs the character has
```lua theme={null}
local multiJobCount = character.getMultiJobsCount()
```
The job grade to set
If true, the job change event won't be triggered
```lua theme={null}
character.setJobGrade(1, flag)
```
The job label to set
```lua theme={null}
character.setJobLabel("Label")
```
The group to set
If true, the group change event won't be triggered
```lua theme={null}
character.setGroup("admin", false)
```
Set the amount of Rol of the character
```lua theme={null}
character.setRol(1000)
```
Set the amount of XP of the character
```lua theme={null}
character.setXp(5000)
```
Set the first name of the character
```lua theme={null}
character.setFirstname("Sadie")
```
Set the last name of the character
```lua theme={null}
character.setLastname("Adler")
```
The skin in JSON format
```lua theme={null}
character.updateSkin("skin")
```
The clothing components in JSON format
```lua theme={null}
character.updateComps("comps")
```
The clothing components tints in JSON format
```lua theme={null}
character.updateCompTints("comps")
```
The currency type (0 = money, 1 = gold, 2 = rol)
The amount to add to character
```lua theme={null}
character.addCurrency(0, 1000)
```
The currency type (0 = money, 1 = gold, 2 = rol)
The amount to remove from character
```lua theme={null}
character.removeCurrency(0, 1000)
```
The amount of XP to add
```lua theme={null}
character.addXp(100)
```
The amount of XP to remove
```lua theme={null}
character.removeXp(100)
```
The age to set to the character
```lua theme={null}
character.setAge(45)
```
The character description to set to the character
```lua theme={null}
character.setCharDescription("string")
```
The nickname to set to the character
```lua theme={null}
character.setNickName("string")
```
The gender to set (male or female)
```lua theme={null}
character.setGender("string")
```
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
```lua theme={null}
character.updateInvCapacity(1)
```
The name of the skill to set, these skillNames will be in VORP Core config skills
the Exp value to be set to the skillName you passed values are incremental so 1000 exp will be 1000 + what you already have
```lua theme={null}
character.setSkills("skillName", 10) -- skillname exp
```
## Users
Get the user data to access getters and setters
The player ID
```lua theme={null}
local user = Core.getUser(source) --[[@as User]]
if not user then return end -- is player in session?
```
The maximum number of jobs allowed for the user
```lua theme={null}
user.setMaxJobsAllowed(maxJobs)
```
The character ID
```lua theme={null}
local user = Core.getUserByCharId(charid) --[[@as User]]
```
The user group (not character group)
```lua theme={null}
local userGroup = user.getGroup
```
The user's source (player ID)
```lua theme={null}
local userSource = user.source
```
The maximum number of jobs allowed for the user
```lua theme={null}
local maxJobsAllowed = user.maxJobsAllowed
```
The group to set for the user
```lua theme={null}
user.SetGroup(group)
```
The steam ID of the user
```lua theme={null}
local steam = user.getIdentifier()
```
All characters of the user
```lua theme={null}
local data = user.getUserCharacters()
```
The warning status of the user
```lua theme={null}
local warnstatus = user.getPlayerwarnings()
```
## Whitelist
Server
The identifier of the whitelist entry
```lua theme={null}
local data = Core.Whitelist.getEntry(identifier)
print(json.encode(data),{ident = true})
```
The identifier of the whitelist entry
```lua theme={null}
Core.Whitelist.whitelistUser(identifier)
```
The identifier of the whitelist entry
```lua theme={null}
Core.Whitelist.unWhitelistUser(identifier)
```
## Webhooks
Shared
The title of the webhook
The webhook link
The description of the webhook
The color of the webhook
The name of the webhook
The logo of the webhook
The footerlogo of the webhook
The avatar of the webhook
```lua theme={null}
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
```lua theme={null}
local instanceNumber = 54123 -- any number
VORPcore.instancePlayers(GetPlayerServerId(PlayerId())+ instanceNumber)
```
remove players from instance
```lua theme={null}
VORPcore.instancePlayers(0)
```
## Player
Available through core export
Server Side
when using these functions you will benefit of the event listeners `OnPlayerDeath` `OnPlayerRevive` `OnPlayerRespawn`
The player ID
```lua theme={null}
Core.Player.Heal(source)
```
The player ID
```lua theme={null}
Core.Player.Revive(source)
```
The player ID
```lua theme={null}
Core.Player.Respawn(source)
```
## Callbacks
Callbacks are available through core export or single exports
if you need only the call back system
```lua theme={null}
local ServerRPC = exports.vorp_core:ServerRpcCall() --[[@as ServerRPC]] -- for intellisense
```
trigger a synchronous callback from client to server
The name of the callback
The parameters to pass to the callback
The result of the callback
```lua theme={null}
local result = Core.Callback.TriggerAwait(name,...)
print(result)
```
trigger an asynchronous callback from client to server
The name of the callback
The parameters to pass to the callback
The result of the callback
```lua theme={null}
Core.Callback.TriggerAsync(name, function(result)
print(result)
end, ...)
```
register a callback on the server to receive a client callback
The name of the callback
The callback function
The source of the callback
The callback function
The parameters to pass to the callback
The result of the callback
```lua theme={null}
Core.Callback.Register(name, function(source,callback,...)
callback(...)
end)
```
if you need only the call back system
```lua theme={null}
local ClientRPC = exports.vorp_core:ClientRpcCall() --[[@as ClientRPC]] -- for intellisense
```
trigger a server to client callback synchronously
The name of the callback
The source of the callback
The parameters to pass to the callback
The result of the callback
```lua theme={null}
local result = Core.Callback.TriggerAwait(name,source,...)
print(result)
```
trigger an asynchronous callback from client to server
The name of the callback
The source of the callback
The parameters to pass to the callback
The result of the callback
```lua theme={null}
Core.Callback.TriggerAsync(name, source, function(result)
print(result)
end, ...)
```
register a callback on the client to receive a server callback
The name of the callback
The callback function
The parameters to pass to the callback
The result of the callback
```lua theme={null}
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
```lua theme={null}
AddEventHandler("vorp:playerGroupChange",function(source, newgroup,oldgroup) end)
```
#### onJobChange
```lua theme={null}
AddEventHandler("vorp:playerJobChange", function(source, newjob,oldjob) end)
```
#### onJobGradeChange
```lua theme={null}
AddEventHandler("vorp:playerJobGradeChange",function(source, newjobgrade,oldjobgrade) end)
```
#### onPlayerDeath
when player dies this event is triggered
```lua theme={null}
--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
```lua theme={null}
--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
```lua theme={null}
--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
```lua theme={null}
--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
```lua theme={null}
--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
```lua theme={null}
--CLIENT
AddEventHandler("vorp_core:Client:OnPlayerSpawned",function()end)
```
## Dataview
call dataview in your script fxmanifest
```lua theme={null}
client_scripts {
'@vorp_core/client/dataview.lua'
}
```
## GlobalStates
* easily get players count from client or server
```lua theme={null}
GlobalState.PlayersInSession
```
## 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
The IsInSession of the character
```lua theme={null}
LocalPlayer.state.IsInSession
```
get the first name of the character
The first name of the character
```lua theme={null}
LocalPlayer.state.Character.FirstName
```
get the last name of the character
The last name of the character
```lua theme={null}
LocalPlayer.state.Character.LastName
```
get the job of the character
The job of the character
```lua theme={null}
LocalPlayer.state.Character.Job
```
get the job label of the character
The job label of the character
```lua theme={null}
LocalPlayer.state.Character.JobLabel
```
get the grade of the character
The grade of the character
```lua theme={null}
LocalPlayer.state.Character.Grade
```
get the group of the character
The group of the character
```lua theme={null}
LocalPlayer.state.Character.Group
```
get the age of the character
The age of the character
```lua theme={null}
LocalPlayer.state.Character.Age
```
get the gender of the character
The gender of the character
```lua theme={null}
LocalPlayer.state.Character.Gender
```
get the nickname of the character
The nickname of the character
```lua theme={null}
LocalPlayer.state.Character.NickName
```
get the character description of the character
The character description of the character
```lua theme={null}
LocalPlayer.state.Character.CharDescription
```
get the money of the character
The money of the character
```lua theme={null}
LocalPlayer.state.Character.Money
```
get the gold of the character
The gold of the character
```lua theme={null}
LocalPlayer.state.Character.Gold
```
get the rol of the character
The rol of the character
```lua theme={null}
LocalPlayer.state.Character.Rol
```
get the charid of the character
The charid of the character
```lua theme={null}
LocalPlayer.state.Character.CharId
```
is player in session? this will return true when player choose his character
The IsInSession of the character
```lua theme={null}
Player(source).state.IsInSession
```
get the first name of the character
The first name of the character
```lua theme={null}
Player(source).state.Character.FirstName
```
get the last name of the character
The last name of the character
```lua theme={null}
Player(source).state.Character.LastName
```
get the job of the character
The job of the character
```lua theme={null}
Player(source).state.Character.Job
```
get the job label of the character
The job label of the character
```lua theme={null}
Player(source).state.Character.JobLabel
```
get the grade of the character
The grade of the character
```lua theme={null}
Player(source).state.Character.Grade
```
get the group of the character
The group of the character
```lua theme={null}
Player(source).state.Character.Group
```
get the age of the character
The age of the character
```lua theme={null}
Player(source).state.Character.Age
```
get the gender of the character
The gender of the character
```lua theme={null}
Player(source).state.Character.Gender
```
get the nickname of the character
The nickname of the character
```lua theme={null}
Player(source).state.Character.NickName
```
get the character description of the character
The character description of the character
```lua theme={null}
Player(source).state.Character.CharDescription
```
get the money of the character
The money of the character
```lua theme={null}
Player(source).state.Character.Money
```
get the gold of the character
The gold of the character
```lua theme={null}
Player(source).state.Character.Gold
```
get the rol of the character
The rol of the character
```lua theme={null}
Player(source).state.Character.Rol
```
get the charid of the character
The charid of the character
```lua theme={null}
Player(source).state.Character.CharId
```
## Version
Use vorp version check with change logs feature in your scripts
add this in your fxmanifest
```lua theme={null}
-- 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
```lua theme={null}
<0.0.1> -- version must be the same in fxmanifest
- new version
- added feature
- removed feature
- fixed something
```