Reference/Libraries/roblox
Library

roblox

table

Roblox platform helpers reachable from outside the game session: public server lookup, deep-link launching, and launch-URL construction.

Functions

3

#roblox.fetch_public_servers(placeId: number, cursor: string?, limit: number?) → table

since 1.8.3-free

Fetches the list of public servers for a place from games.roblox.com. Synchronous; blocks the calling thread.

Aliasesfetchpublicserversget_public_servers

Parameters

placeIdnumber

The PlaceId of the place to query.

cursorstring?

Optional pagination cursor returned by a previous call.

limitnumber?

Page size (default 100, max enforced by Roblox).

Returns

table

Response body decoded from JSON: { data = { { id, maxPlayers, playing, fps, ping, ... }, ... }, nextPageCursor = string, previousPageCursor =

Errors

  • LuaError network error -- The underlying HTTP request failed.
  • LuaError http error -- The server returned a non-2xx HTTP status.
  • LuaError parse error -- Response body could not be parsed as JSON.

#roblox.join_server(placeId: number, gameInstanceId: string?) → boolean

since 1.8.3-free

Launches the Roblox client to join the given place / server instance via the roblox:// URL scheme. Returns true if ShellExecute reported success (which only means the launcher was invoked, not that the join completed).

Aliasesjoinserver

Parameters

placeIdnumber

The PlaceId to join.

gameInstanceIdstring?

Optional server JobId; when present, joins that specific server.

#roblox.make_launch_url(placeId: number, gameInstanceId: string?) → string

since 1.8.3-free

Returns the launch URL roblox.join_server would invoke without launching the client. Useful for copy-paste / diagnostics.

Aliasesmakelaunchurl

Parameters

placeIdnumber
gameInstanceIdstring?