Skip to main content

SteamPlatform

21 tools in this family (folder Editor/Tools/SteamPlatform/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.

ToolEffectDescription
pcstore_cloud_readread-onlyRead a file from Steam Cloud and return it as base64. Returns status=not_found if the file
pcstore_cloud_writewritesWrite a file to Steam Cloud. Pass the payload as base64; Buril decodes it server-side. Files
pcstore_create_lobbywritesCreate a matchmaking lobby. type controls visibility (private / friends_only / public /
pcstore_download_scoresread-onlyDownload scores from a leaderboard. range=global asks for global ranks [start, end] (1-based);
pcstore_export_setupread-onlyReturn a complete snapshot of the Steam state — AppID, self id, persona name, mock mode,
pcstore_find_leaderboardwritesFind a leaderboard by name and return an opaque handle for use with pcstore_upload_score /
pcstore_get_friendsread-onlyReturn the friend list as an array. In mock mode 8 deterministic friends are returned, seeded
pcstore_get_userread-onlyReturn the local Steam user's id, persona name and online state. The id is a 64-bit Steam ID
pcstore_initwritesInitialise the Steam runtime for an AppID. When Steamworks.NET is installed and the Steam
pcstore_join_lobbywritesJoin a Steam lobby by ID. Blocks up to timeout_ms for the LobbyEnter_t callback. Returns
pcstore_open_overlaywritesOpen a Steam overlay dialog. Valid dialogs: friends, community, players, settings,
pcstore_query_achievementread-onlyReturn whether an achievement is currently unlocked, plus the unlock time and the localised
pcstore_request_lobby_listread-onlyQuery the lobby list with optional string filters. In mock mode results are returned
pcstore_request_statswritesRequest the local user's stats and achievements from the Steam server. Required before reading
pcstore_set_statwritesSet an int or float stat. Like achievements, stat updates are LOCAL until pcstore_store_stats.
pcstore_shutdownwritesTear down the Steam runtime. Persists pending mock state and unregisters callbacks. Safe to
pcstore_store_statswritesCommit pending achievement / stat changes to the Steam server. Required after a sequence of
pcstore_unlock_achievementwritesUnlock an achievement by its Steamworks API name (the all-caps id you configured on the partner
pcstore_upload_scorewritesUpload a score to a leaderboard. method=keep_best only writes if the new score is better than
pcstore_workshop_create_itemwritesPublish a new Workshop item. Provide title, description, the content directory path, an
pcstore_workshop_queryread-onlyQuery the Workshop for items. matching_type filters by content type ('community', 'art',