VCORE Ecosystem StudioFrameworkServerClipr
VCORE Studio›Products›Vcore Framework›Documentation
Documentation
Verified

Player Data

The server Core loads persistent character state from the players table and wraps it in a Vcore Player object.

PlayerData fields

FieldObserved role
citizenidPrimary character identifier.
licenseFiveM license associated with the character.
namePlayer/server display name field.
moneyMoney table; bank operations integrate with the banking resource when started.
jobsOwned jobs and duty state.
charinfoCharacter identity information.
metadataPersistent metadata/state.
repReputation values.
positionLast saved coordinates/heading.
roleFramework role/permission-facing player field.

Get a player

lua
local Player = VCORE.Functions.GetPlayer(source)
if not Player then return end local citizenId = Player.PlayerData.citizenid

Player Functions

25 Player object methods were detected in core/server/player.lua.

SignatureSource
Player.Functions.GetData()server/player.lua:171
Player.Functions.GetFullName()server/player.lua:175
Player.Functions.GetFormalName()server/player.lua:179
Player.Functions.Set(key, val)server/player.lua:190
Player.Functions.GetMoney(account)server/player.lua:196
Player.Functions.AddMoney(account, amount, reason)server/player.lua:203
Player.Functions.RemoveMoney(account, amount, reason)server/player.lua:216
Player.Functions.SetMoney(account, amount)server/player.lua:243
Player.Functions.SetJob(jobName, grade)server/player.lua:259
Player.Functions.AddJob(jobName, grade, onDuty)server/player.lua:300
Player.Functions.SetJobGrade(jobName, grade, onDuty)server/player.lua:336
Player.Functions.SetActiveJob(jobName)server/player.lua:365
Player.Functions.RemoveJob(jobName)server/player.lua:458
Player.Functions.GetJob()server/player.lua:476
Player.Functions.AddItem(item, amount, slot, info)server/player.lua:488
Player.Functions.RemoveItem(item, amount, slot)server/player.lua:500
Player.Functions.HasItem(item, amount)server/player.lua:507
Player.Functions.SetMetadata(key, value)server/player.lua:522
Player.Functions.SetMetaData(key, value)server/player.lua:530
Player.Functions.GetMetadata(key)server/player.lua:534
Player.Functions.Save()server/player.lua:540
Player.Functions.Logout()server/player.lua:554
Player.Functions.GetRep(name)server/player.lua:120
Player.Functions.AddRep(name, amount)server/player.lua:125
Player.Functions.RemoveRep(name, amount)server/player.lua:144

Replicated state

During player load, the Core sets state bags including playerLoaded, charinfo, jobs, metadata and rep. Job changes also emit VCORE:Client:JobsUpdated.