UgCore.Players

Server Required module. Proxied to ug-core. On clients, use UgCore.LocalPlayer.

Lookup

UgCore.Players.Get(source) -> UgPlayer?
UgCore.Players.GetAll() -> UgPlayer[]
UgCore.Players.GetByIdentifier(identifier) -> UgPlayer?
UgCore.Players.GetByCharacterId(characterId) -> UgPlayer?

table

Hide fields

integer

string

Primary identifier.

integer?

The loaded character.

integer

Unix seconds.

GetAll is sorted by source.

Metadata

Session metadata. It lives while the player is connected.

UgCore.Players.SetMetadata(source, key, value, replicate?) -> ok, errorCode
UgCore.Players.GetMetadata(source, key?) -> any

string

required

camelCase.

any

nil deletes the key.

boolean

Copies the key to the ug-core:Metadata statebag. Every client can read it, so it MUST NOT hold secrets.

GetMetadata without a key returns every key.

Kick

UgCore.Players.Kick(source, reason?) -> ok, errorCode

string

Shown to the player. A generic message when nil.

Death state

See the Death system for states, rules and the downed flow.

Read

UgCore.Players.GetDeathState(source) -> 'Alive' | 'Downed' | 'Dead'
UgCore.Players.IsDead(source) -> boolean
UgCore.Players.IsDowned(source) -> boolean
UgCore.Players.GetInjuries(source) -> UgInjury[]
UgCore.Players.GetCauseOfDeath(source) -> UgCauseOfDeath?

table

Show fields

UgBodyRegion

UgDamageCategory

integer?

Weapon hash of the last hit.

integer?

Player source of the last hit, when confirmed.

integer

Unix seconds.

table

Show fields

UgBodyRegion

UgDamageCategory

integer?

Only when a recorded weaponDamageEvent confirms it.

integer

Unix seconds.

Change

UgCore.Players.ClearInjuries(source, region?) -> ok, errorCode
UgCore.Players.Down(source, cause?) -> ok, errorCode
UgCore.Players.Kill(source, cause?) -> ok, errorCode
UgCore.Players.Revive(source, options?) -> ok, errorCode
UgCore.Players.Respawn(source, coords?) -> ok, errorCode

Function	From	To	Hook
`Down`	`Alive`	`Downed`	`Players:BeforeDown`
`Kill`	`Alive`, `Downed`	`Dead`
`Revive`	`Downed`, `Dead`	`Alive`, in place	`Players:BeforeRevive`
`Respawn`	`Downed`, `Dead`	`Alive`, at `coords`	`Players:BeforeRespawn`

From any other state they return invalid_args. A cancelled hook returns no_permission.

UgReviveOptions

Show fields

integer

Player source who revived.

string

integer

default:"200"

101 to 200.

boolean

vector4

Respawn position. Defaults to respawn.coords in config/players.lua. Respawn always clears injuries.

-- ug-ambulance, after its own job, item and distance checks
local ok, err = UgCore.Players.Revive(target, { by = source, reason = 'cpr', clearInjuries = false })

Overview

Core

Networking and security

Modules

Reference

UgCore.Players

Lookup

Metadata

Kick

Death state

Read

Change

​Lookup

​Metadata

​Kick

​Death state

​Read

​Change

Lookup

Metadata

Kick

Death state

Read

Change