Server
Player

rw_buckets Server API — Player Functions

Server-side API for managing player routing buckets.


exports.rw_buckets:setPlayerBucket(src, key)

Associates a player with a specified bucket.

exports.rw_buckets:setPlayerBucket(12, 'mission_alpha')
  • src: number — Player ID (source identifier).
  • key: string — The bucket key to associate the player with.

exports.rw_buckets:removePlayerFromBucket(src)

Removes a player from their current bucket.

exports.rw_buckets:removePlayerFromBucket(12)
  • src: number — Player ID (source identifier).

exports.rw_buckets:getPlayerBucketKey(src)

Retrieves the bucket key associated with a player.

local bucket = exports.rw_buckets:getPlayerBucketKey(12)
print(bucket)
  • src: number — Player ID (source identifier).

Returns: string | nil — The bucket key associated with the player, or nil if not assigned.