Improve player system memory usage and performance by CaseIRL · Pull Request #1216 · qbcore-framework/qb-core

CaseIRL · 2026-02-19T02:27:04Z

Description

Rewrites player.lua to use a class-based prototype pattern with shared methods via __index and weak-keyed private state to reduce memory usage and improve performance at scale.

All existing scripts continue to work without any changes needed, QBCore.Functions.GetPlayer() acts as an API layer. Each GetPlayer call still creates closures for the proxy but these are short-lived rather than permanently stored on the player object still a net improvement over the original.

player.lua: Virtually a full rewrite to class methods
functions.lua: New helper added, all player lookups updated
events.lua: Internal player handling cleaned up

Mock Object Benchmark

Checklist

I have personally loaded this code into an updated qbcore project and checked all of its functionality.
My code fits the style guidelines.
My PR fits the contribution guidelines.

Rewrites player.lua to use a class-based prototype pattern with shared methods via __index and weak-keyed private state to reduce memory usage and improve performance at scale. All existing scripts continue to work without any changes needed, QBCore.Functions.GetPlayer() acts as an API layer. Each GetPlayer call still creates closures for the proxy but these are short-lived rather than permanently stored on the player object still a net improvement over the original. - player.lua: Virtually a full rewrite to class methods - functions.lua: New helper added, all player lookups updated - events.lua: Internal player handling cleaned up

Title says it all. I forgot to swap the Player.Functions calls in paycheck interval to call class methods.

CaseIRL · 2026-02-19T13:57:29Z

I forgot to do the PaycheckInterval in this

function PaycheckInterval()
    if not next(QBCore.Players) then
        SetTimeout(QBCore.Config.Money.PayCheckTimeOut * (60 * 1000), PaycheckInterval) -- Prevent paychecks from stopping forever once 0 players
        return
    end
    for _, Player in pairs(QBCore.Players) do
        if not Player then return end
        local payment = QBShared.Jobs[Player.PlayerData.job.name]['grades'][tostring(Player.PlayerData.job.grade.level)].payment
        if not payment then payment = Player.PlayerData.job.payment end
        if Player.PlayerData.job and payment > 0 and (QBShared.Jobs[Player.PlayerData.job.name].offDutyPay or Player.PlayerData.job.onduty) then
            if QBCore.Config.Money.PayCheckSociety then
                local account = exports['qb-banking']:GetAccountBalance(Player.PlayerData.job.name)
                if account ~= 0 then
                    if account < payment then
                        TriggerClientEvent('QBCore:Notify', Player.PlayerData.source, Lang:t('error.company_too_poor'), 'error')
                    else
                        Player:AddMoney('bank', payment, 'paycheck')
                        exports['qb-banking']:RemoveMoney(Player.PlayerData.job.name, payment, 'Employee Paycheck')
                        TriggerClientEvent('QBCore:Notify', Player.PlayerData.source, Lang:t('info.received_paycheck', { value = payment }))
                    end
                else
                    Player:AddMoney('bank', payment, 'paycheck')
                    TriggerClientEvent('QBCore:Notify', Player.PlayerData.source, Lang:t('info.received_paycheck', { value = payment }))
                end
            else
                Player:AddMoney('bank', payment, 'paycheck')
                TriggerClientEvent('QBCore:Notify', Player.PlayerData.source, Lang:t('info.received_paycheck', { value = payment }))
            end
        end
    end
    SetTimeout(QBCore.Config.Money.PayCheckTimeOut * (60 * 1000), PaycheckInterval)
end

Qwerty1Verified · 2026-03-22T00:55:07Z

+    }
+
+    for name, fn in pairs(player:GetAllExtraMethods()) do
+        functions[name] = function(...) return fn(player, ...) end


I believe I noticed an issue with this whilst testing. Extra methods are defined by resources that call AddMethod, so they typically won't need the player object passed as the first parameter. An example you can test with is GetItemByName from qb-inventory.

Could you test this out on your end and confirm? Thank you

For sure, was mostly done pretty quick to be honest as a test if it was even do-able, I am still running the modified version on my dev server atm and i did have to make one or 2 other changes I never pushed back here. Only just noticing this though at 4:50am for me so bare with, i'll take a note of it now, and have a test after sleep ❤️

No worries. Thank you for working on these changes 😃

Your not wrong, thats something i have updated in my version yes, bare with me I have a few things to do today but ill give it all a proper once over again make sure theres nothing else i forgot about :)

Qwerty1Verified

Apologies for the review gap.

I think with these we could save on even more memory, as well as fix a potential future issue on internal calls via the metamethod.

Feel free to let me know what you find 😄

Qwerty1Verified · 2026-04-21T23:27:08Z

+    local self = setmetatable({}, {
+        __index = function(t, key)
+            local priv = Private[t]
+            if priv and priv.extra_methods[key] then
+                return function(...) return priv.extra_methods[key](t, ...) end
+            end
+            return QBPlayer[key]
+        end
+    })


I think we could even move the metatable and closure creation out of here, to re-use the same metatable and closures per player instance. It saves extra allocations per player, and saves on garbage collection.

Also, the closure on line 23 may possibly give us the same issue we had previously where it's passing itself into external "extra_methods". From what I can tell, the only path that this would at any time occur on is internal player object calls, which isn't entirely the intended path anyways, and likely wouldn't work with this call flow unless . syntax is used.

It may be best to eliminate the closure if there's no other need for it, and just return the handler.

Qwerty1Verified · 2026-04-21T23:27:51Z

+        __index = function(t, key)
+            local priv = Private[t]
+            if priv and priv.extra_methods[key] then
+                return function(...) return priv.extra_methods[key](t, ...) end


Suggested change

return function(...) return priv.extra_methods[key](t, ...) end

return priv.extra_methods[key]

This would allow for the same style of call external to occur internally, rather than having either:
Player:Test(arg1) - function(player, player, arg1)
or
Player.Test(arg1) - function(player, arg1)

It could be used as:
Player.Test(arg1) - function(arg1)

auto-assign Bot assigned CaseIRL Feb 19, 2026

Swap over the PaycheckInterval to class methods

affe910

Title says it all. I forgot to swap the Player.Functions calls in paycheck interval to call class methods.

Qwerty1Verified self-requested a review March 21, 2026 23:38

Qwerty1Verified requested changes Mar 22, 2026

View reviewed changes

GetAllExtraMethods fix

6f446ec

Qwerty1Verified requested changes Apr 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve player system memory usage and performance#1216

Improve player system memory usage and performance#1216
CaseIRL wants to merge 3 commits intoqbcore-framework:mainfrom
CaseIRL:main

CaseIRL commented Feb 19, 2026

Uh oh!

CaseIRL commented Feb 19, 2026

Uh oh!

Qwerty1Verified Mar 22, 2026 •

edited

Loading

Uh oh!

CaseIRL Mar 24, 2026

Uh oh!

Qwerty1Verified Mar 24, 2026

Uh oh!

CaseIRL Mar 24, 2026

Uh oh!

Qwerty1Verified left a comment

Uh oh!

Qwerty1Verified Apr 21, 2026

Uh oh!

Qwerty1Verified Apr 21, 2026

Uh oh!

Qwerty1Verified Apr 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	return function(...) return priv.extra_methods[key](t, ...) end
	return priv.extra_methods[key]

Conversation

CaseIRL commented Feb 19, 2026

Description

Checklist

Uh oh!

CaseIRL commented Feb 19, 2026

Uh oh!

Qwerty1Verified Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CaseIRL Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Qwerty1Verified Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

CaseIRL Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Qwerty1Verified left a comment

Choose a reason for hiding this comment

Uh oh!

Qwerty1Verified Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Qwerty1Verified Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Qwerty1Verified Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Qwerty1Verified Mar 22, 2026 •

edited

Loading