Skip to content

Optimization: Update Player Data When Key Change #663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions client/events.lua
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,28 @@ RegisterNetEvent('QBCore:Client:OnPlayerLoaded', function()
end
end)

---@param key string
---@param value PlayerData
RegisterNetEvent('qbx_core:client:onUpdatePlayerData', function (key, value)
if source == '' then return end
QBX.PlayerData[key] = value
TriggerEvent('QBCore:Player:SetPlayerData', QBX.PlayerData)
end)

---@param key string
---@param value PlayerMetadata
RegisterNetEvent('qbx_core:client:onSetMetaData', function(key, _, value)
if source == '' then return end
QBX.PlayerData.metadata[key] = value
TriggerEvent('QBCore:Player:SetPlayerData', QBX.PlayerData)
end)

RegisterNetEvent('qbx_core:client:loadPlayerData', function (val)
if source == '' then return end
QBX.PlayerData = val
TriggerEvent('QBCore:Player:SetPlayerData', QBX.PlayerData)
end)

---@param val PlayerData
RegisterNetEvent('QBCore:Player:SetPlayerData', function(val)
local invokingResource = GetInvokingResource()
Expand Down
2 changes: 2 additions & 0 deletions modules/playerdata.lua
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@ RegisterNetEvent('QBCore:Client:OnPlayerUnload', function()
end)

RegisterNetEvent('QBCore:Player:SetPlayerData', function(value)
local invokingResource = GetInvokingResource()
if invokingResource and invokingResource ~= 'qbx_core' then return end
QBX.PlayerData = value
end)
35 changes: 19 additions & 16 deletions server/player.lua
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ function SetJobDuty(identifier, onDuty)
TriggerEvent('QBCore:Server:SetDuty', player.PlayerData.source, player.PlayerData.job.onduty)
TriggerClientEvent('QBCore:Client:SetDuty', player.PlayerData.source, player.PlayerData.job.onduty)

UpdatePlayerData(identifier)
UpdatePlayerData(identifier, 'job', player.PlayerData.job)
end

exports('SetJobDuty', SetJobDuty)
Expand Down Expand Up @@ -206,7 +206,7 @@ function SetPlayerPrimaryJob(citizenid, jobName)
SaveOffline(player.PlayerData)
else
Save(player.PlayerData.source)
UpdatePlayerData(player.PlayerData.source)
UpdatePlayerData(player.PlayerData.source, 'job', player.PlayerData.job)
TriggerEvent('QBCore:Server:OnJobUpdate', player.PlayerData.source, player.PlayerData.job)
TriggerClientEvent('QBCore:Client:OnJobUpdate', player.PlayerData.source, player.PlayerData.job)
end
Expand Down Expand Up @@ -430,7 +430,7 @@ function SetPlayerPrimaryGang(citizenid, gangName)
SaveOffline(player.PlayerData)
else
Save(player.PlayerData.source)
UpdatePlayerData(player.PlayerData.source)
UpdatePlayerData(player.PlayerData.source, 'gang', player.PlayerData.gang)
TriggerEvent('QBCore:Server:OnGangUpdate', player.PlayerData.source, player.PlayerData.gang)
TriggerClientEvent('QBCore:Client:OnGangUpdate', player.PlayerData.source, player.PlayerData.gang)
end
Expand Down Expand Up @@ -804,7 +804,7 @@ function CreatePlayer(playerData, Offline)
self.PlayerData.metadata[self.PlayerData.job.name].reputation += amount

---@diagnostic disable-next-line: param-type-mismatch
UpdatePlayerData(self.Offline and self.PlayerData.citizenid or self.PlayerData.source)
UpdatePlayerData(self.Offline and self.PlayerData.citizenid or self.PlayerData.source, 'metadata', self.PlayerData.metadata)
end

---@param moneytype MoneyType
Expand Down Expand Up @@ -914,7 +914,7 @@ function CreatePlayer(playerData, Offline)
self.PlayerData.charinfo.card = cardNumber

---@diagnostic disable-next-line: param-type-mismatch
UpdatePlayerData(self.Offline and self.PlayerData.citizenid or self.PlayerData.source)
UpdatePlayerData(self.Offline and self.PlayerData.citizenid or self.PlayerData.source, 'charinfo', self.PlayerData.charinfo)
end

---@deprecated use Save or SaveOffline instead
Expand Down Expand Up @@ -970,7 +970,7 @@ function CreatePlayer(playerData, Offline)
end

if not self.Offline then
UpdatePlayerData(self.PlayerData.source)
UpdatePlayerData(self.PlayerData.source, 'job', self.PlayerData.job)
TriggerEvent('QBCore:Server:OnJobUpdate', self.PlayerData.source, self.PlayerData.job)
TriggerClientEvent('QBCore:Client:OnJobUpdate', self.PlayerData.source, self.PlayerData.job)
end
Expand Down Expand Up @@ -1010,7 +1010,7 @@ function CreatePlayer(playerData, Offline)
end

if not self.Offline then
UpdatePlayerData(self.PlayerData.source)
UpdatePlayerData(self.PlayerData.source, 'gang', self.PlayerData.gang)
TriggerEvent('QBCore:Server:OnGangUpdate', self.PlayerData.source, self.PlayerData.gang)
TriggerClientEvent('QBCore:Client:OnGangUpdate', self.PlayerData.source, self.PlayerData.gang)
end
Expand Down Expand Up @@ -1101,17 +1101,21 @@ function SetPlayerData(identifier, key, value)

player.PlayerData[key] = value

UpdatePlayerData(identifier)
UpdatePlayerData(identifier, key, value)
end

---@param identifier Source | string
function UpdatePlayerData(identifier)
function UpdatePlayerData(identifier, key, value)
local player = type(identifier) == 'string' and (GetPlayerByCitizenId(identifier) or GetOfflinePlayer(identifier)) or GetPlayer(identifier)

if not player or player.Offline then return end

TriggerEvent('QBCore:Player:SetPlayerData', player.PlayerData)
TriggerClientEvent('QBCore:Player:SetPlayerData', player.PlayerData.source, player.PlayerData)
if not key then
TriggerClientEvent('qbx_core:client:loadPlayerData', player.PlayerData.source, player.PlayerData)
return
end
TriggerClientEvent('qbx_core:client:onUpdatePlayerData', player.PlayerData.source, key, value)
end

---@param identifier Source | string
Expand Down Expand Up @@ -1144,11 +1148,10 @@ function SetMetadata(identifier, metadata, value)
player.PlayerData.metadata[metadata] = value
end

UpdatePlayerData(identifier)

if not player.Offline then
local playerState = Player(player.PlayerData.source).state

TriggerEvent('QBCore:Player:SetPlayerData', player.PlayerData)
TriggerClientEvent('qbx_core:client:onSetMetaData', player.PlayerData.source, metadata, oldValue, value)
TriggerEvent('qbx_core:server:onSetMetaData', metadata, oldValue, value, player.PlayerData.source)

Expand Down Expand Up @@ -1215,7 +1218,7 @@ function SetCharInfo(identifier, charInfo, value)

player.PlayerData.charinfo[charInfo] = value

UpdatePlayerData(identifier)
UpdatePlayerData(identifier, 'charinfo', player.PlayerData.charinfo)
end

exports('SetCharInfo', SetCharInfo)
Expand Down Expand Up @@ -1270,7 +1273,7 @@ function AddMoney(identifier, moneyType, amount, reason)
player.PlayerData.money[moneyType] += amount

if not player.Offline then
UpdatePlayerData(identifier)
UpdatePlayerData(identifier, 'money', player.PlayerData.money)

local tags = amount > 100000 and config.logging.role or nil
local resource = GetInvokingResource() or cache.resource
Expand Down Expand Up @@ -1325,7 +1328,7 @@ function RemoveMoney(identifier, moneyType, amount, reason)
player.PlayerData.money[moneyType] -= amount

if not player.Offline then
UpdatePlayerData(identifier)
UpdatePlayerData(identifier, 'money', player.PlayerData.money)

local tags = amount > 100000 and config.logging.role or nil
local resource = GetInvokingResource() or cache.resource
Expand Down Expand Up @@ -1373,7 +1376,7 @@ function SetMoney(identifier, moneyType, amount, reason)
player.PlayerData.money[moneyType] = amount

if not player.Offline then
UpdatePlayerData(identifier)
UpdatePlayerData(identifier, 'money', player.PlayerData.money)

local difference = amount - oldAmount
local dirChange = difference < 0 and 'removed' or 'added'
Expand Down