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.
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.
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
Notifications
notifications can also accept -1 as duration to always stay on screen and to clear them you need to use UiFeedClearChannel
The title of the notification
The subtitle of the notification
The dictionary for the icon
Color of the notification
The title of the notification
The title of the notification
The title of the notification
The title of the notification
The title of the notification
The subtitle of the notification
The title of the notification
The dictionary for the icon
Color of the notification
enables the stars for quality like animal pelt stars
shows the quality of the notification
The title of the notification
The title of the notification
The title of the notification
The subtitle of the notification
The title of the notification
The title of the notification
The subtitle of the notification
The title of the notification
The subtitle of the notification
The title of the notification
The subtitle of the notification
The dictionary for the icon
Color of the notification
The title of the notification
The title of the notification
The description of the notification
The second description of the notification
The title of the notification
The subtitle of the notification
The dictionary for the icon
Duration in milliseconds or -1 for infinite
Color of the notification
The title of the notification
The title of the notification
The subtitle of the notification
The dictionary for the icon
Color of the notification
The title of the notification
The title of the notification
The title of the notification
The title of the notification
The subtitle of the notification
The title of the notification
The dictionary for the icon
Color of the notification
Show the quality of the notification
The quality of the notification max 3
The title of the notification
The title of the notification
The title of the notification
The subtitle of the notification
The title of the notification
The title of the notification
The subtitle of the notification
The title of the notification
The subtitle of the notification
The title of the notification
The subtitle of the notification
The dictionary for the icon
Color of the notification
The title of the notification
The title of the notification
The description of the notification
The second description of the notification
The title of the notification
The subtitle of the notification
The dictionary for the icon
Duration in milliseconds or -1 for infinite
Color of the notification
Characters
Get the character data to access getters and setters
The unique identifier of the character
The unique character identifier
The group the character belongs to
The multiJobs of the character
The job grade of the character
The job label of the character
The amount of money the character has
The amount of gold the character has
The amount of rol the character has
The amount of experience points the character has
The first name of the character
The last name of the character
The status of the character
The coordinates of the character
Whether the character is dead or not
The skin details of the character
The component details of the character
The component tints of the character
The gender of the character
The description of the character
The nickname of the character
The inventory capacity of the character
The skills of the character
If true, the job change event won’t be triggered
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 number of multijobs the character has
If true, the job change event won’t be triggered
If true, the group change event won’t be triggered
Set the amount of Rol of the character
Set the amount of XP of the character
Set the first name of the character
Set the last name of the character
The clothing components in JSON format
The clothing components tints in JSON format
The currency type (0 = money, 1 = gold, 2 = rol)
The amount to add to character
The currency type (0 = money, 1 = gold, 2 = rol)
The amount to remove from character
The amount of XP to remove
The age to set to the character
The character description to set to the character
The nickname to set to the character
The gender to set (male or female)
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
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
Users
Get the user data to access getters and setters
The maximum number of jobs allowed for the user
The user group (not character group)
The user’s source (player ID)
The maximum number of jobs allowed for the user
The group to set for the user
All characters of the user
The warning status of the user
Whitelist
The identifier of the whitelist entry
The identifier of the whitelist entry
The identifier of the whitelist entry
Webhooks
The description of the webhook
The footerlogo of the webhook
The avatar of the webhook
Instancing
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
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 The parameters to pass to the callback
The result of the callback
trigger an asynchronous callback from client to server The parameters to pass to the callback
The result of the callback
register a callback on the server to receive a client callback The source of the callback
The parameters to pass to the callback
The result of the callback
if you need only the call back system
trigger a server to client callback synchronously The source of the callback
The parameters to pass to the callback
The result of the callback
trigger an asynchronous callback from client to server The source of the callback
The parameters to pass to the callback
The result of the callback
register a callback on the client to receive a server callback The parameters to pass to the callback
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
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
is player in session? this will return true when player choose his character The IsInSession of the character
get the first name of the character The first name of the character
get the last name of the character The last name of the character
get the job of the character
get the job label of the character The job label of the character
get the grade of the character The grade of the character
get the group of the character The group of the character
get the age of the character
get the gender of the character The gender of the character
get the nickname of the character The nickname of the character
get the character description of the character The character description of the character
get the money of the character The money of the character
get the gold of the character The gold of the character
get the rol of the character
get the charid of the character The charid of the character
is player in session? this will return true when player choose his character The IsInSession of the character
get the first name of the character The first name of the character
get the last name of the character The last name of the character
get the job of the character
get the job label of the character The job label of the character
get the grade of the character The grade of the character
get the group of the character The group of the character
get the age of the character
get the gender of the character The gender of the character
get the nickname of the character The nickname of the character
get the character description of the character The character description of the character
get the money of the character The money of the character
get the gold of the character The gold of the character
get the rol of the character
get the charid of the character 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