Skip to main content

Module roblox

Module roblox 

Source
Expand description

Roblox HTTP flows and strict launch-URI construction.

Structsยง

GameResponse ๐Ÿ”’
One gameโ€™s details.
GamesEnvelope ๐Ÿ”’
The games API response.
PresenceDetail
Presence plus the game an in-game account is playing. Roblox omits the place for accounts the viewing session isnโ€™t allowed to see.
PresenceEnvelope ๐Ÿ”’
The presence API response.
PresenceResponse ๐Ÿ”’
One userโ€™s presence.
Profile
A Roblox userโ€™s public profile.
ThumbnailEnvelope ๐Ÿ”’
The thumbnails API response.
ThumbnailResponse ๐Ÿ”’
One avatar image.
UniverseResponse ๐Ÿ”’
The place universe API response.
UserResponse ๐Ÿ”’
A user from the users API.

Enumsยง

RobloxError
Why a Roblox request failed. Displays as a user-facing message.

Constantsยง

AUTH_URL ๐Ÿ”’
Returns the user a session belongs to.
GAMES_URL ๐Ÿ”’
Game details, by universe ID.
PLACE_LAUNCHER_URL ๐Ÿ”’
Roblox place launcher, passed to the client in the launch URI.
PLACE_UNIVERSE_URL ๐Ÿ”’
The universe a place belongs to.
PRESENCE_URL ๐Ÿ”’
User presence. Requires a signed-in session.
THUMBNAIL_URL ๐Ÿ”’
Avatar headshot images.
TICKET_URL ๐Ÿ”’
Issues one-time authentication tickets for launching the Roblox client.
USERS_URL ๐Ÿ”’
Public user profiles, by ID.

Staticsยง

TRACKER_SEQUENCE ๐Ÿ”’
Keeps browser tracker IDs distinct for joins in the same instant.

Functionsยง

authenticated_profile
Returns the profile of the user a session belongs to, validating the session.
build_join_uri
Builds a roblox-player: URI that joins the place as the sessionโ€™s user.
clean_game_name ๐Ÿ”’
Trims a Roblox-supplied game name and caps its length for display.
cookie_header ๐Ÿ”’
Builds the session cookie header, marked sensitive so it isnโ€™t logged.
fetch_game_names
Looks up game names by universe ID. Failures return no names because theyโ€™re display-only.
fetch_place_universe
Finds the universe for a place. Ok(None) means Roblox has no universe for that place.
fetch_presence
Returns each requested userโ€™s presence state.
fetch_presence_details
Returns each requested userโ€™s presence and game, retrying once with the CSRF token Roblox returns on the first request.
join_uri ๐Ÿ”’
Formats the launch URI for a ticket and place.
parse_games_response ๐Ÿ”’
Keeps names for requested universes only.
parse_place_id
Extracts a place ID from digits or an https://www.roblox.com/games/<id>/รขโ‚ฌยฆ link.
parse_presence_response ๐Ÿ”’
Maps each requested user to a presence. Users missing from the response are Unknown, and game details are kept only for users in game.
profile_with_avatar ๐Ÿ”’
Adds the userโ€™s avatar headshot URL. A missing avatar isnโ€™t an error.
public_profile
Returns a userโ€™s public profile, rejecting a response for a different user.