UgCore.LocalPlayer

Client Reads statebags only. No network call.

UgCore.LocalPlayer.GetData() -> { name, characterId? }?
UgCore.LocalPlayer.IsLoaded() -> boolean
UgCore.LocalPlayer.GetMetadata(key?) -> any
UgCore.LocalPlayer.GetDeathState() -> 'Alive' | 'Downed' | 'Dead'
UgCore.LocalPlayer.IsDead() -> boolean
UgCore.LocalPlayer.IsDowned() -> boolean
UgCore.LocalPlayer.GetInjuries() -> UgInjury[]

any

Replicated metadata only. Every replicated key when key is nil.

UgInjury[]

Same shape as on the server.

Example

CreateThread(function()
    while true do
        if UgCore.LocalPlayer.IsDowned() then
            -- show your own downed UI
        end

        Wait(500)
    end
end)

To react instantly, watch the statebag with AddStateBagChangeHandler('ug-core:DeathState', ...). See Statebags.

⌘I

Overview

Core

Networking and security

Modules

Reference

UgCore.LocalPlayer

Example

​Example

Example