RoyaleWindPlayer
Server-side API for managing player routing buckets.
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. Automatically removes the player from any bucket they're currently in first, and fires rw_buckets:onBucketUpdate both server-side and to the target client.
exports.rw_buckets:setPlayerBucket(12, 'mission_alpha')- src:
number— Player ID (source identifier). - key:
string— The bucket key to associate the player with.
This export does not return a value. src must belong to a currently-connected player — invalid IDs are silently ignored. Call getPlayerBucketKey afterwards if you need to confirm the change.
exports.rw_buckets:removePlayerFromBucket(src)
Removes a player from their current bucket, routing them back to bucket 0.
exports.rw_buckets:removePlayerFromBucket(12)- src:
number— Player ID (source identifier).
This export does not return a value, and silently does nothing if src isn't a connected player.
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.
Players are also removed from their bucket automatically when they disconnect — you don't need to call removePlayerFromBucket yourself for that case.