How to use Routing Buckets for instanced content

Routing buckets are OneSync's built-in instance system. They let you create separate "worlds" where only players in the same bucket can see each other. This is how apartment interiors, heist lobbies, and instanced missions work. This lesson builds a simple apartment entry system using routing buckets.

You'll build: An apartment system where each apartment is a separate routing bucket - players in different apartments don't see or hear each other.
Time: ~20 minutes
You need: A local FiveM server with OneSync enabled (default).
You'll learn: What routing buckets are, how to assign and remove players from buckets, how to target events to a bucket, and the lockdown mode that controls client entity creation.

BEFORE YOU START

Build it

Create the resource

A server script that manages routing buckets.

code

resources/qu_buckets_demo/
fxmanifest.lua
server.lua

code

fx_version 'cerulean'
game 'gta5'
server_script 'server.lua'

Enter an apartment (assign bucket)

The player enters an instanced world.

code

-- Map of apartment ID → bucket ID
local apartmentBuckets = {}

RegisterNetEvent('qu_buckets:enterApartment', function(apartmentId)
local src = source

-- Create or reuse a bucket for this apartment
if not apartmentBuckets[apartmentId] then
    -- Bucket IDs should be above 100 to avoid conflicts
    apartmentBuckets[apartmentId] = 100 + apartmentId
end

local bucket = apartmentBuckets[apartmentId]
SetPlayerRoutingBucket(src, bucket)

print(('Player %s entered apartment %s (bucket %s)'):format(src, apartmentId, bucket))
end)

How to use Routing Buckets for instanced content

Build it

Create the resource

Enter an apartment (assign bucket)

Lock down entity creation in the bucket

Leave the apartment (return to default)

Keep reading the full lesson