UgCore.Sessions

Server Optional module. Proxied to ug-core. A session is a routing bucket owned by ug-core: an instance for an apartment, a race or a heist. Buckets are allocated from 1000 up. Bucket 0 is the shared world. A player is in at most one session.

Create

UgCore.Sessions.Create(options?) -> ok, sessionId, errorCode

string

Up to 64 characters.

'strict' | 'relaxed' | 'inactive'

default:"strict"

Client entity creation in the bucket.

boolean

default:"false"

Ambient peds and vehicles.

boolean

default:"false"

Keeps the session when the last member leaves.

Destroy

UgCore.Sessions.Destroy(sessionId) -> ok, errorCode

Moves every member back to the shared world.

Join / Leave

UgCore.Sessions.Join(source, sessionId) -> ok, errorCode
UgCore.Sessions.Leave(source) -> ok, errorCode

Join leaves the current session first. Sessions:BeforeJoin MAY cancel. Leave returns not_found when the player is in no session. An empty session that is not persistent is destroyed.

Get / GetMembers / GetSession

UgCore.Sessions.Get(sessionId) -> UgSession?
UgCore.Sessions.GetMembers(sessionId) -> integer[]
UgCore.Sessions.GetSession(source) -> integer?

table

Show fields

integer

string?

integer

string

boolean

integer[]

The client reads its session id from the ug-core:Session statebag.

Example

local ok, sessionId = UgCore.Sessions.Create({ name = 'apartment:' .. characterId })

UgCore.Sessions.Join(source, sessionId)

Overview

Core

Networking and security

Modules

Reference

UgCore.Sessions

Create

Destroy

Join / Leave

Get / GetMembers / GetSession

Example

​Create

​Destroy

​Join / Leave

​Get / GetMembers / GetSession

​Example

Create

Destroy

Join / Leave

Get / GetMembers / GetSession

Example