Up to date

This page is up to date for Godot 4.3. If you still find outdated information, please open an issue.

Steam¶

Inherits: Object

An ecosystem of tools for Godot Engine and Valve's Steam.

Description¶

Full documentation and tutorials are available at https://godotsteam.com/.

Properties¶

int	browser_handle	`0`
int	current_app_id	`0`
int	current_clan_id	`0`
int	current_steam_id	`0`
int	inventory_handle	`0`
int	inventory_update_handle	`0`
int	leaderboard_details_max	`64`
Array	leaderboard_entries_array	`[]`
int	leaderboard_handle	`0`

Methods¶

int	acceptConnection(connection_handle: int)
int	acceptGame()
bool	acceptP2PSessionWithUser(remote_steam_id: int)
bool	acceptSessionWithUser(remote_steam_id: int)
void	activateActionSet(input_handle: int, action_set_handle: int)
void	activateActionSetLayer(input_handle: int, action_set_layer_handle: int)
void	activateGameOverlay(type: String = "")
void	activateGameOverlayInviteDialog(steam_id: int)
void	activateGameOverlayInviteDialogConnectString(connect_string: String)
void	activateGameOverlayToStore(app_id: int = 0)
void	activateGameOverlayToUser(type: String = "", steam_id: int = 0)
void	activateGameOverlayToWebPage(url: String)
bool	activationSuccess(activate: bool)
void	addAppDependency(published_file_id: int, app_id: int)
bool	addContentDescriptor(update_handle: int, descriptor_id: int)
void	addDependency(published_file_id: int, child_published_file_id: int)
bool	addExcludedTag(query_handle: int, tag_name: String)
int	addFavoriteGame(ip: String, port: int, query_port: int, flags: int, last_played: int)
void	addGamePhaseTag(tag_name: String, tag_icon: String, tag_group: String, priority: int)
int	addGameSearchParams(key: String, values: String)
void	addHeader(key: String, value: String, this_handle: int = 0)
int	addInstantaneousTimelineEvent(title: String, description: String, icon: String, icon_priority: int, start_offset_seconds: float, possible_clip: TimelineEventClipPriority = 1)
bool	addItemKeyValueTag(query_handle: int, key: String, value: String)
bool	addItemPreviewFile(query_handle: int, preview_file: String, type: ItemPreviewType)
bool	addItemPreviewVideo(query_handle: int, video_id: String)
void	addItemToFavorites(app_id: int, published_file_id: int)
int	addPromoItem(item: int)
int	addPromoItems(items: PackedInt64Array)
int	addRangeTimelineEvent(title: String, description: String, icon: String, icon_priority: int, start_offset_seconds: float, duration: float, possible_clip: TimelineEventClipPriority = 1)
void	addRequestLobbyListDistanceFilter(distance_filter: LobbyDistanceFilter)
void	addRequestLobbyListFilterSlotsAvailable(slots_available: int)
void	addRequestLobbyListNearValueFilter(key_to_match: String, value_to_be_close_to: int)
void	addRequestLobbyListNumericalFilter(key_to_match: String, value_to_match: int, comparison_type: LobbyComparison)
void	addRequestLobbyListResultCountFilter(max_results: int)
void	addRequestLobbyListStringFilter(key_to_match: String, value_to_match: String, comparison_type: LobbyComparison)
bool	addRequiredKeyValueTag(query_handle: int, key: String, value: String)
bool	addRequiredTag(query_handle: int, tag_name: String)
bool	addRequiredTagGroup(query_handle: int, tag_array: Array)
int	addScreenshotToLibrary(filename: String, thumbnail_filename: String, width: int, height: int)
int	addVRScreenshotToLibrary(type: VRScreenshotType, filename: String, vr_filename: String)
void	advertiseGame(server_ip: String, port: int)
bool	allowP2PPacketRelay(allow: bool)
void	allowStartRequest(allowed: bool, this_handle: int = 0)
void	attachLeaderboardUGC(ugc_handle: int, this_leaderboard: int = 0)
bool	beginAsyncRequestFakeIP(num_ports: int)
BeginAuthSessionResult	beginAuthSession(ticket: PackedByteArray, ticket_size: int, steam_id: int)
bool	beginFileWriteBatch()
void	cancelAuthTicket(auth_ticket: int)
void	cancelQuery(server_list_request: int)
int	cancelRequestPlayersForGame()
void	cancelReservation(beacon_id: int, steam_id: int)
void	cancelServerQuery(server_query: int)
void	changeNumOpenSlots(beacon_id: int, open_slots: int)
void	checkFileSignature(file_name: String)
bool	checkPingDataUpToDate(max_age_in_seconds: float)
bool	checkResultSteamID(steam_id_expected: int, this_inventory_handle: int = 0)
bool	clearAchievement(achievement_name: String)
void	clearRichPresence()
void	clearTimelineTooltip(time_delta: float)
bool	closeChannelWithUser(remote_steam_id: int, channel: int)
bool	closeClanChatWindowInSteam(chat_id: int)
bool	closeConnection(peer: int, reason: int, debug_message: String, linger: bool)
bool	closeListenSocket(socket: int)
bool	closeP2PChannelWithUser(remote_steam_id: int, channel: int)
bool	closeP2PSessionWithUser(remote_steam_id: int)
bool	closeSessionWithUser(remote_steam_id: int)
int	configureConnectionLanes(connection: int, lanes: int, priorities: Array, weights: Array)
int	connectByIPAddress(ip_address_with_port: String, options: Dictionary)
int	connectP2P(remote_steam_id: int, virtual_port: int, options: Dictionary)
int	connectToHostedDedicatedServer(remote_steam_id: int, virtual_port: int, options: Dictionary)
int	consumeItem(item_consume: int, quantity: int)
String	convertPingLocationToString(location: PackedByteArray)
void	copyToClipboard(this_handle: int = 0)
void	createBeacon(open_slots: int, location_id: int, type: PartyBeaconLocationType, connect_string: String, beacon_metadata: String)
void	createBrowser(user_agent: String = "", user_css: String = "")
int	createCookieContainer(allow_response_to_modify: bool)
void	createFakeUDPPort(fake_server_port: int)
int	createHTTPRequest(request_method: HTTPMethod, absolute_url: String)
int	createHostedDedicatedServerListenSocket(virtual_port: int, options: Dictionary)
void	createItem(app_id: int, file_type: WorkshopFileType)
int	createListenSocketIP(ip_reference: String, options: Dictionary)
int	createListenSocketP2P(virtual_port: int, options: Dictionary)
int	createListenSocketP2PFakeIP(fake_port: int, options: Dictionary)
void	createLobby(lobby_type: LobbyType, max_members: int = 2)
int	createPollGroup()
int	createQueryAllUGCRequest(query_type: UGCQuery, matching_type: UGCMatchingUGCType, creator_id: int, consumer_id: int, page: int)
int	createQueryUGCDetailsRequest(published_file_id: Array)
int	createQueryUserUGCRequest(account_id: int, list_type: UserUGCList, matching_ugc_type: UGCMatchingUGCType, sort_order: UserUGCListSortOrder, creator_id: int, consumer_id: int, page: int)
Dictionary	createSocketPair(loopback: bool, remote_steam_id1: int, remote_steam_id2: int)
bool	currentEntryDidChange()
bool	currentEntryIsAvailable(available: bool)
bool	currentEntryWillChange()
void	deactivateActionSetLayer(input_handle: int, action_set_handle: int)
void	deactivateAllActionSetLayers(input_handle: int)
int	declineGame()
Dictionary	decompressVoice(voice: PackedByteArray, sample_rate: int, buffer_size_override: int = 20480)
bool	deferHTTPRequest(request_handle: int)
void	deleteItem(published_file_id: int)
bool	deleteLobbyData(steam_lobby_id: int, key: String)
bool	deregisterSteamMusicRemote()
int	deserializeResult(buffer: PackedByteArray)
bool	destroyBeacon(beacon_id: int)
bool	destroyPollGroup(poll_group: int)
void	destroyResult(this_inventory_handle: int = 0)
bool	dismissFloatingGamepadTextInput()
bool	dismissGamepadTextInput()
void	doesEventRecordingExist(this_event: int)
void	doesGamePhaseRecordingExist(phase_id: String)
void	downloadClanActivityCounts(chat_id: int, clans_to_request: int)
bool	downloadItem(published_file_id: int, high_priority: bool)
void	downloadLeaderboardEntries(start: int, end: int, type: LeaderboardDataRequest = 0, this_leaderboard: int = 0)
void	downloadLeaderboardEntriesForUsers(users_id: Array, this_leaderboard: int = 0)
void	enableActionEventCallbacks()
void	enableDeviceCallbacks()
bool	enableLooped(loop: bool)
bool	enablePlayNext(next: bool)
bool	enablePlayPrevious(previous: bool)
bool	enablePlaylists(playlists: bool)
bool	enableQueue(queue: bool)
bool	enableShuffled(shuffle: bool)
void	endAuthSession(steam_id: int)
bool	endFileWriteBatch()
int	endGame(game_id: int)
void	endGamePhase()
int	endGameSearch()
void	endRangeTimelineEvent(this_event: int, end_offset_seconds: float)
void	enumerateFollowingList(start_index: int)
int	estimatePingTimeBetweenTwoLocations(location1: PackedByteArray, location2: PackedByteArray)
int	estimatePingTimeFromLocalHost(location: PackedByteArray)
int	exchangeItems(output_items: PackedInt64Array, output_quantity: PackedInt32Array, input_items: PackedInt64Array, input_quantity: PackedInt32Array)
void	executeJavascript(script: String, this_handle: int = 0)
bool	fileDelete(file: String)
bool	fileExists(file: String)
bool	fileForget(file: String)
bool	filePersisted(file: String)
Dictionary	fileRead(file: String, data_to_read: int)
void	fileReadAsync(file: String, offset: int, data_to_read: int)
void	fileShare(file: String)
bool	fileWrite(file: String, data: PackedByteArray, size: int = 0)
void	fileWriteAsync(file: String, data: PackedByteArray, size: int = 0)
bool	fileWriteStreamCancel(write_handle: int)
bool	fileWriteStreamClose(write_handle: int)
int	fileWriteStreamOpen(file: String)
bool	fileWriteStreamWriteChunk(write_handle: int, data: PackedByteArray)
String	filterText(context: TextFilteringContext, steam_id: int, message: String)
void	find(search: String, currently_in_find: bool, reverse: bool, this_handle: int = 0)
void	findLeaderboard(leaderboard_name: String)
void	findOrCreateLeaderboard(leaderboard_name: String, sort_method: LeaderboardSortMethod, display_type: LeaderboardDisplayType)
int	flushMessagesOnConnection(connection_handle: int)
int	generateItems(items: PackedInt64Array, quantity: PackedInt32Array)
String	getAPICallFailureReason()
Dictionary	getAchievement(achievement_name: String)
Dictionary	getAchievementAchievedPercent(achievement_name: String)
Dictionary	getAchievementAndUnlockTime(achievement_name: String)
String	getAchievementDisplayAttribute(achievement_name: String, key: String)
int	getAchievementIcon(achievement_name: String)
String	getAchievementName(achievement: int)
Dictionary	getAchievementProgressLimitsFloat(achievement_name: String)
Dictionary	getAchievementProgressLimitsInt(achievement_name: String)
InputActionOrigin	getActionOriginFromXboxOrigin(input_handle: int, origin: int)
int	getActionSetHandle(action_set_name: String)
Array	getActiveActionSetLayers(input_handle: int)
int	getAllItems()
Dictionary	getAllLobbyData(steam_lobby_id: int)
Dictionary	getAnalogActionData(input_handle: int, analog_action_handle: int)
int	getAnalogActionHandle(action_name: String)
Array	getAnalogActionOrigins(input_handle: int, action_set_handle: int, analog_action_handle: int)
int	getAppBuildId()
void	getAppDependencies(published_file_id: int)
int	getAppID()
Dictionary	getAppInstallDir(app_id: int)
int	getAppOwner()
Dictionary	getAuthSessionTicket(remote_steam_id: int = 0)
int	getAuthTicketForWebApi(service_identity: String = "")
NetworkingAvailability	getAuthenticationStatus()
Array	getAvailableBeaconLocations(max: int)
String	getAvailableGameLanguages()
int	getAvailableP2PPacketSize(channel: int = 0)
Dictionary	getAvailableVoice()
int	getBeaconByIndex(index: int)
Dictionary	getBeaconDetails(beacon_id: int)
String	getBeaconLocationData(location_id: int, location_type: PartyBeaconLocationType, location_data: PartyBeaconLocationData)
Dictionary	getBetaInfo()
int	getCachedUGCCount()
int	getCachedUGCHandle(content: int)
Dictionary	getCertificateRequest()
int	getChatMemberByIndex(clan_id: int, user: int)
Dictionary	getClanActivityCounts(clan_id: int)
int	getClanByIndex(clan_index: int)
int	getClanChatMemberCount(clan_id: int)
Dictionary	getClanChatMessage(chat_id: int, message: int)
int	getClanCount()
String	getClanName(clan_id: int)
int	getClanOfficerByIndex(clan_id: int, officer: int)
int	getClanOfficerCount(clan_id: int)
int	getClanOwner(clan_id: int)
String	getClanTag(clan_id: int)
Dictionary	getConfigValue(config_value: NetworkingConfigValue, scope_type: NetworkingConfigScope, connection_handle: int)
Dictionary	getConfigValueInfo(config_value: NetworkingConfigValue)
Array	getConnectedControllers()
Dictionary	getConnectionInfo(connection_handle: int)
String	getConnectionName(peer: int)
Dictionary	getConnectionRealTimeStatus(connection_handle: int, lanes: int, get_status: bool = true)
int	getConnectionUserData(peer: int)
int	getControllerForGamepadIndex(index: int)
int	getCoplayFriend(friend_number: int)
int	getCoplayFriendCount()
int	getCurrentActionSet(input_handle: int)
int	getCurrentBatteryPower()
String	getCurrentBetaName()
String	getCurrentGameLanguage()
int	getDLCCount()
Array	getDLCData()
Dictionary	getDLCDataByIndex(this_dlc_index: int)
Dictionary	getDLCDownloadProgress(dlc_id: int)
Dictionary	getDetailedConnectionStatus(connection_handle: int)
Array	getDeviceBindingRevision(input_handle: int)
Dictionary	getDigitalActionData(input_handle: int, digital_action_handle: int)
int	getDigitalActionHandle(action_name: String)
Array	getDigitalActionOrigins(input_handle: int, action_set_handle: int, digital_action_handle: int)
int	getDirectPingToPOP(pop_id: int)
void	getDurationControl()
int	getEarliestPurchaseUnixTime(app_id: int)
Dictionary	getEncryptedAppTicket()
Dictionary	getFakeIP(first_port: int = 0)
Array	getFavoriteGames()
int	getFileCount()
void	getFileDetails(filename: String)
Dictionary	getFileNameAndSize(file: int)
int	getFileSize(file: String)
int	getFileTimestamp(file: String)
void	getFollowerCount(steam_id: int)
int	getFriendByIndex(friend_number: int, friend_flags: BitField[FriendFlags])
int	getFriendCoplayGame(friend_id: int)
int	getFriendCoplayTime(friend_id: int)
int	getFriendCount(friend_flags: BitField[FriendFlags] = 65535)
int	getFriendCountFromSource(source_id: int)
int	getFriendFromSourceByIndex(source_id: int, friend_number: int)
Dictionary	getFriendGamePlayed(steam_id: int)
Dictionary	getFriendMessage(friend_id: int, message: int)
String	getFriendPersonaName(steam_id: int)
String	getFriendPersonaNameHistory(steam_id: int, name_history: int)
PersonaState	getFriendPersonaState(steam_id: int)
FriendRelationship	getFriendRelationship(steam_id: int)
String	getFriendRichPresence(friend_id: int, key: String)
String	getFriendRichPresenceKeyByIndex(friend_id: int, key: int)
int	getFriendRichPresenceKeyCount(friend_id: int)
int	getFriendSteamLevel(steam_id: int)
int	getFriendsGroupCount()
int	getFriendsGroupIDByIndex(friend_group: int)
int	getFriendsGroupMembersCount(friend_group: int)
Array	getFriendsGroupMembersList(friend_group: int, member_count: int)
String	getFriendsGroupName(friend_group: int)
int	getGameBadgeLevel(series: int, foil: bool)
int	getGamepadIndexForController(input_handle: int)
float	getGlobalStatFloat(stat_name: String)
PackedFloat64Array	getGlobalStatFloatHistory(stat_name: String)
int	getGlobalStatInt(stat_name: String)
PackedInt64Array	getGlobalStatIntHistory(stat_name: String)
String	getGlyphForActionOrigin(origin: InputActionOrigin)
String	getGlyphForXboxOrigin(origin: int)
String	getGlyphPNGForActionOrigin(origin: InputActionOrigin, size: InputGlyphSize, flags: int)
String	getGlyphSVGForActionOrigin(origin: InputActionOrigin, flags: int)
float	getHTTPDownloadProgressPct(request_handle: int)
bool	getHTTPRequestWasTimedOut(request_handle: int)
PackedByteArray	getHTTPResponseBodyData(request_handle: int, buffer_size: int)
int	getHTTPResponseBodySize(request_handle: int)
int	getHTTPResponseHeaderSize(request_handle: int, header_name: String)
PackedByteArray	getHTTPResponseHeaderValue(request_handle: int, header_name: String, buffer_size: int)
PackedByteArray	getHTTPStreamingResponseBodyData(request_handle: int, offset: int, buffer_size: int)
int	getHostedDedicatedServerPOPId()
int	getHostedDedicatedServerPort()
int	getIPCCallCount()
String	getIPCountry()
Dictionary	getImageRGBA(image: int)
Dictionary	getImageSize(image: int)
InputType	getInputTypeForHandle(input_handle: int)
Array	getInstalledDepots(app_id: int)
String	getItemDefinitionProperty(definition: int, name: String)
Dictionary	getItemDownloadInfo(published_file_id: int)
Dictionary	getItemInstallInfo(published_file_id: int)
Dictionary	getItemPrice(definition: int)
int	getItemState(published_file_id: int)
Dictionary	getItemUpdateProgress(update_handle: int)
int	getItemsByID(id_array: PackedInt64Array)
Array	getItemsWithPrices()
int	getLargeFriendAvatar(steam_id: int)
String	getLaunchCommandLine()
String	getLaunchQueryParam(key: String)
Dictionary	getLeaderboardDisplayType(this_leaderboard: int = 0)
int	getLeaderboardEntryCount(this_leaderboard: int = 0)
String	getLeaderboardName(this_leaderboard: int = 0)
Dictionary	getLeaderboardSortMethod(this_leaderboard: int = 0)
void	getLinkAtPosition(x: int, y: int, this_handle: int = 0)
String	getListenSocketAddress(socket: int, with_port: bool = true)
String	getLobbyData(steam_lobby_id: int, key: String)
Dictionary	getLobbyGameServer(steam_lobby_id: int)
int	getLobbyMemberByIndex(steam_lobby_id: int, member: int)
String	getLobbyMemberData(steam_lobby_id: int, steam_id_user: int, key: String)
int	getLobbyMemberLimit(steam_lobby_id: int)
int	getLobbyOwner(steam_lobby_id: int)
Dictionary	getLocalFileChange(file: int)
int	getLocalFileChangeCount()
Dictionary	getLocalPingLocation()
int	getLocalTimestamp()
int	getMediumFriendAvatar(steam_id: int)
Dictionary	getMostAchievedAchievementInfo()
Dictionary	getMotionData(input_handle: int)
Dictionary	getNextMostAchievedAchievementInfo(iterator: int)
int	getNumAchievements()
int	getNumActiveBeacons()
Dictionary	getNumBetas()
int	getNumLobbyMembers(steam_lobby_id: int)
int	getNumSubscribedItems()
int	getNumSupportedGameVersions(query_handle: int, index: int)
void	getNumberOfCurrentPlayers()
void	getOPFSettings(app_id: int)
String	getOPFStringForApp(app_id: int)
Dictionary	getP2PSessionState(remote_steam_id: int)
int	getPOPCount()
Array	getPOPList()
String	getPersonaName()
PersonaState	getPersonaState()
Dictionary	getPingToDataCenter(pop_id: int)
AudioPlaybackStatus	getPlaybackStatus()
void	getPlayerAvatar(size: int = 2, steam_id: int = 0)
String	getPlayerNickname(steam_id: int)
int	getPlayerSteamLevel()
int	getProfileItemPropertyInt(steam_id: int, item_type: CommunityProfileItemType, item_property: CommunityProfileItemProperty)
String	getProfileItemPropertyString(steam_id: int, item_type: CommunityProfileItemType, item_property: CommunityProfileItemProperty)
Dictionary	getQueryUGCAdditionalPreview(query_handle: int, index: int, preview_index: int)
Dictionary	getQueryUGCChildren(query_handle: int, index: int, child_count: int)
Dictionary	getQueryUGCContentDescriptors(query_handle: int, index: int, max_entries: int)
Dictionary	getQueryUGCKeyValueTag(query_handle: int, index: int, key_value_tag_index: int)
String	getQueryUGCMetadata(query_handle: int, index: int)
int	getQueryUGCNumAdditionalPreviews(query_handle: int, index: int)
int	getQueryUGCNumKeyValueTags(query_handle: int, index: int)
int	getQueryUGCNumTags(query_handle: int, index: int)
String	getQueryUGCPreviewURL(query_handle: int, index: int)
Dictionary	getQueryUGCResult(query_handle: int, index: int)
Dictionary	getQueryUGCStatistic(query_handle: int, index: int, stat_type: ItemStatistic)
String	getQueryUGCTag(query_handle: int, index: int, tag_index: int)
String	getQueryUGCTagDisplayName(query_handle: int, index: int, tag_index: int)
Dictionary	getQuota()
Array	getRecentPlayers()
NetworkingAvailability	getRelayNetworkStatus()
Dictionary	getRemoteFakeIPForConnection(connection: int)
int	getRemotePlaySessionID(input_handle: int)
String	getResultItemProperty(index: int, name: String, this_inventory_handle: int = 0)
Array	getResultItems(this_inventory_handle: int = 0)
Result	getResultStatus(this_inventory_handle: int = 0)
int	getResultTimestamp(this_inventory_handle: int = 0)
int	getSecondsSinceAppActive()
int	getSecondsSinceComputerActive()
int	getServerCount(server_list_request: int)
Dictionary	getServerDetails(server: int, server_list_request: int)
int	getServerRealTime()
int	getSessionClientFormFactor(session_id: int)
String	getSessionClientName(session_id: int)
Dictionary	getSessionClientResolution(session_id: int)
Dictionary	getSessionConnectionInfo(remote_steam_id: int, get_connection: bool, get_status: bool)
int	getSessionCount()
int	getSessionID(index: int)
int	getSessionInputConfigurationSettings()
int	getSessionSteamID(session_id: int)
int	getSmallFriendAvatar(steam_id: int)
float	getStatFloat(stat_name: String)
int	getStatInt(stat_name: String)
int	getSteamID()
int	getSteamID32(steam_id: int)
String	getSteamUILanguage()
String	getStringForActionOrigin(origin: InputActionOrigin)
String	getStringForAnalogActionName(action_handle: int)
String	getStringForDigitalActionName(action_handle: int)
String	getStringForXboxOrigin(origin: int)
Array	getSubscribedItems()
Dictionary	getSupportedGameVersionData(query_handle: int, index: int, version_index: int)
Dictionary	getSyncPlatforms(file: String)
Dictionary	getUGCDetails(content: int)
Dictionary	getUGCDownloadProgress(content: int)
Dictionary	getUserAchievement(steam_id: int, name: String)
Dictionary	getUserAchievementAndUnlockTime(steam_id: int, name: String)
Array	getUserContentDescriptorPreferences(max_entries: int)
Array	getUserFriendsGroups()
void	getUserItemVote(published_file_id: int)
int	getUserRestrictions()
float	getUserStatFloat(steam_id: int, name: String)
int	getUserStatInt(steam_id: int, name: String)
Array	getUserSteamFriends()
Array	getUserSteamGroups()
void	getVideoURL(app_id: int)
Dictionary	getVoice(buffer_size_override: int = 0)
int	getVoiceOptimalSampleRate()
void	getWorkshopEULAStatus()
String	get_godotsteam_version() const
int	get_server_list_request() const
void	goBack(this_handle: int = 0)
void	goForward(this_handle: int = 0)
int	grantPromoItems()
bool	hasEquippedProfileItem(steam_id: int, friend_flags: CommunityProfileItemType)
bool	hasFriend(steam_id: int, friend_flags: BitField[FriendFlags])
void	hookScreenshots(hook: bool)
int	hostConfirmGameStart(game_id: int)
bool	htmlInit()
bool	htmlShutdown()
bool	indicateAchievementProgress(name: String, current_progress: int, max_progress: int)
NetworkingAvailability	initAuthentication()
bool	initFilterText()
void	initRelayNetworkAccess()
bool	initWorkshopForGameServer(workshop_depot_id: int, folder: String)
Dictionary	initiateGameConnection(server_id: int, server_ip: String, server_port: int, secure: bool)
bool	inputInit(explicitly_call_runframe: bool = false)
bool	inputShutdown()
void	installDLC(dlc_id: int)
bool	inviteUserToGame(friend_id: int, connect_string: String)
bool	inviteUserToLobby(steam_lobby_id: int, steam_id_invitee: int)
Dictionary	isAPICallCompleted()
bool	isAnonAccount(steam_id: int)
bool	isAnonUserAccount(steam_id: int)
bool	isAppBlocked(app_id: int)
bool	isAppInBlockList(app_id: int)
bool	isAppInstalled(app_id: int)
bool	isBehindNAT()
Dictionary	isBroadcasting()
bool	isChatAccount(steam_id: int)
bool	isClanAccount(steam_id: int)
bool	isClanChatAdmin(chat_id: int, steam_id: int)
bool	isClanChatWindowOpenInSteam(chat_id: int)
bool	isClanOfficialGameGroup(clan_id: int)
bool	isClanPublic(clan_id: int)
bool	isCloudEnabledForAccount()
bool	isCloudEnabledForApp()
bool	isConsoleUserAccount(steam_id: int)
bool	isCurrentMusicRemote()
bool	isCybercafe()
bool	isDLCInstalled(dlc_id: int)
bool	isFeatureBlocked(feature: ParentalFeature)
bool	isFeatureInBlockList(feature: ParentalFeature)
void	isFollowing(steam_id: int)
bool	isIndividualAccount(steam_id: int)
bool	isLobby(steam_id: int)
bool	isLowViolence()
bool	isOverlayEnabled()
bool	isParentalLockEnabled()
bool	isParentalLockLocked()
bool	isPhoneIdentifying()
bool	isPhoneRequiringVerification()
bool	isPhoneVerified()
bool	isRefreshing(server_list_request: int)
bool	isScreenshotsHooked()
bool	isSteamChinaLauncher()
bool	isSteamInBigPictureMode()
bool	isSteamRunning()
bool	isSteamRunningInVR()
bool	isSteamRunningOnSteamDeck()
bool	isSubscribed()
bool	isSubscribedApp(app_id: int)
bool	isSubscribedFromFamilySharing()
bool	isSubscribedFromFreeWeekend()
Dictionary	isTimedTrial()
bool	isTwoFactorEnabled()
bool	isUserInSource(steam_id: int, source_id: int)
bool	isVACBanned()
bool	isVRHeadsetStreamingEnabled()
void	joinClanChatRoom(clan_id: int)
void	joinLobby(steam_lobby_id: int)
void	joinParty(beacon_id: int)
void	jsDialogResponse(result: bool, this_handle: int = 0)
void	keyChar(unicode_char: int, key_modifiers: BitField[HTMLKeyModifiers], this_handle: int = 0)
void	keyDown(native_key_code: int, key_modifiers: BitField[HTMLKeyModifiers], this_handle: int = 0)
void	keyUp(native_key_code: int, key_modifiers: BitField[HTMLKeyModifiers], this_handle: int = 0)
bool	leaveClanChatRoom(clan_id: int)
void	leaveLobby(steam_lobby_id: int)
bool	loadItemDefinitions()
void	loadURL(url: String, post_data: String, this_handle: int = 0)
bool	loggedOn()
bool	markContentCorrupt(missing_files_only: bool)
void	mouseDoubleClick(mouse_button: HTMLMouseButton, this_handle: int = 0)
void	mouseDown(mouse_button: HTMLMouseButton, this_handle: int = 0)
void	mouseMove(x: int, y: int, this_handle: int = 0)
void	mouseUp(mouse_button: HTMLMouseButton, this_handle: int = 0)
void	mouseWheel(delta: int, this_handle: int = 0)
float	musicGetVolume()
bool	musicIsEnabled()
bool	musicIsPlaying()
void	musicPause()
void	musicPlay()
void	musicPlayNext()
void	musicPlayPrev()
void	musicSetVolume(volume: float)
bool	newDataAvailable()
void	onReservationCompleted(beacon_id: int, steam_id: int)
bool	openClanChatWindowInSteam(chat_id: int)
void	openOverlayToGamePhase(phase_id: String)
void	openOverlayToTimelineEvent(this_event: int)
bool	overlayNeedsPresent()
Dictionary	parsePingLocationString(string: String)
void	pasteFromClipboard(this_handle: int = 0)
int	pingServer(ip: String, port: int)
int	playerDetails(ip: String, port: int)
bool	playlistDidChange()
bool	playlistWillChange()
bool	prioritizeHTTPRequest(request_handle: int)
bool	queueDidChange()
bool	queueWillChange()
Dictionary	readP2PPacket(packet: int, channel: int = 0)
Array	receiveMessagesOnChannel(channel: int, max_messages: int)
Array	receiveMessagesOnConnection(connection: int, max_messages: int)
Array	receiveMessagesOnPollGroup(poll_group: int, max_messages: int)
void	refreshQuery(server_list_request: int)
void	refreshServer(server: int, server_list_request: int)
bool	registerProtocolInOverlayBrowser(protocol: String)
bool	registerSteamMusicRemote(name: String)
bool	releaseCookieContainer(cookie_handle: int)
bool	releaseHTTPRequest(request_handle: int)
bool	releaseQueryUGCRequest(query_handle: int)
void	releaseRequest(server_list_request: int)
void	reload(this_handle: int = 0)
void	removeAppDependency(published_file_id: int, app_id: int)
void	removeBrowser(this_handle: int = 0)
bool	removeContentDescriptor(update_handle: int, descriptor_id: int)
void	removeDependency(published_file_id: int, child_published_file_id: int)
bool	removeFavoriteGame(app_id: int, ip: String, port: int, query_port: int, flags: int)
void	removeItemFromFavorites(app_id: int, published_file_id: int)
bool	removeItemKeyValueTags(update_handle: int, key: String)
bool	removeItemPreview(update_handle: int, index: int)
bool	removeProperty(item_id: int, name: String, this_inventory_update_handle: int = 0)
void	removeTimelineEvent(this_event: int)
bool	replyToFriendMessage(steam_id: int, message: String)
void	requestClanOfficerList(clan_id: int)
void	requestEligiblePromoItemDefinitionsIDs(steam_id: int)
void	requestEncryptedAppTicket(secret: String)
void	requestEquippedProfileItems(steam_id: int)
int	requestFavoritesServerList(app_id: int, filters: Array)
void	requestFriendRichPresence(friend_id: int)
int	requestFriendsServerList(app_id: int, filters: Array)
void	requestGlobalAchievementPercentages()
void	requestGlobalStats(history_days: int)
int	requestHistoryServerList(app_id: int, filters: Array)
int	requestInternetServerList(app_id: int, filters: Array)
int	requestLANServerList(app_id: int)
bool	requestLobbyData(steam_lobby_id: int)
void	requestLobbyList()
int	requestPlayersForGame(player_min: int, player_max: int, max_team_size: int)
void	requestPrices()
int	requestSpectatorServerList(app_id: int, filters: Array)
void	requestStoreAuthURL(redirect: String)
bool	requestUserInformation(steam_id: int, require_name_only: bool)
void	requestUserStats(steam_id: int)
bool	resetAllStats(achievements_too: bool)
void	resetIdentity(remote_steam_id: int)
bool	resetPlaylistEntries()
bool	resetQueueEntries()
bool	restartAppIfNecessary(app_id: int)
String	retrieveConnectionDetails(host_id: int)
void	runFrame(reserved_value: bool = true)
void	runNetworkingCallbacks()
void	run_callbacks()
int	searchForGameSolo(player_min: int, player_max: int)
int	searchForGameWithLobby(lobby_id: int, player_min: int, player_max: int)
bool	sendClanChatMessage(chat_id: int, text: String)
bool	sendHTTPRequest(request_handle: int)
bool	sendHTTPRequestAndStreamResponse(request_handle: int)
bool	sendLobbyChatMsg(steam_lobby_id: int, message_body: String)
Dictionary	sendMessageToConnection(connection_handle: int, data: PackedByteArray, flags: int)
int	sendMessageToUser(remote_steam_id: int, data: PackedByteArray, flags: int, channel: int)
bool	sendP2PPacket(remote_steam_id: int, data: PackedByteArray, send_type: P2PSend, channel: int = 0)
void	sendQueryUGCRequest(update_handle: int)
bool	sendRemotePlayTogetherInvite(friend_id: int)
PackedByteArray	serializeResult(this_inventory_handle: int = 0)
int	serverRules(ip: String, port: int)
bool	setAchievement(name: String)
bool	setActiveBeta(beta_name: String)
bool	setAdminQuery(update_handle: int, admin_query: bool)
bool	setAllowCachedResponse(update_handle: int, max_age_seconds: int)
void	setBackgroundMode(background_mode: bool, this_handle: int = 0)
Dictionary	setCertificate(certificate: PackedByteArray)
void	setCloudEnabledForApp(enabled: bool)
bool	setCloudFileNameFilter(update_handle: int, match_cloud_filename: String)
bool	setConnectionConfigValueFloat(connection: int, config: NetworkingConfigValue, value: float)
bool	setConnectionConfigValueInt32(connection: int, config: NetworkingConfigValue, value: int)
bool	setConnectionConfigValueString(connection: int, config: NetworkingConfigValue, value: String)
int	setConnectionDetails(details: String, connection_details: int)
void	setConnectionName(peer: int, name: String)
bool	setConnectionPollGroup(connection_handle: int, poll_group: int)
void	setCookie(hostname: String, key: String, value: String, path: String, expires: int, secure: bool, http_only: bool)
bool	setCurrentPlaylistEntry(id: int)
bool	setCurrentQueueEntry(id: int)
bool	setDLCContext(app_id: int)
bool	setDisplayName(name: String)
void	setDualSenseTriggerEffect(input_handle: int, parameters: int, trigger_mask: int, effect_mode: SCEPadTriggerEffectMode, position: int, amplitude: int, frequency: int)
bool	setDurationControlOnlineState(new_state: int)
int	setGameHostParams(key: String, value: String)
void	setGameLauncherMode(mode: bool)
void	setGamePhaseAttribute(attribute_group: String, attribute_value: String, priority: int)
void	setGamePhaseID(phase_id: String)
bool	setGlobalConfigValueFloat(config: NetworkingConfigValue, value: float)
bool	setGlobalConfigValueInt32(config: NetworkingConfigValue, value: int)
bool	setGlobalConfigValueString(config: NetworkingConfigValue, value: String)
bool	setHTTPCookie(cookie_handle: int, host: String, url: String, cookie: String)
bool	setHTTPRequestAbsoluteTimeoutMS(request_handle: int, milliseconds: int)
bool	setHTTPRequestContextValue(request_handle: int, context_value: int)
bool	setHTTPRequestCookieContainer(request_handle: int, cookie_handle: int)
bool	setHTTPRequestGetOrPostParameter(request_handle: int, name: String, value: String)
bool	setHTTPRequestHeaderValue(request_handle: int, header_name: String, header_value: String)
bool	setHTTPRequestNetworkActivityTimeout(request_handle: int, timeout_seconds: int)
bool	setHTTPRequestRawPostBody(request_handle: int, content_type: String, body: String)
bool	setHTTPRequestRequiresVerifiedCertificate(request_handle: int, require_verified_certificate: bool)
bool	setHTTPRequestUserAgentInfo(request_handle: int, user_agent_info: String)
void	setHorizontalScroll(absolute_pixel_scroll: int, this_handle: int = 0)
void	setInGameVoiceSpeaking(steam_id: int, speaking: bool)
bool	setInputActionManifestFilePath(manifest_path: String)
bool	setItemContent(update_handle: int, content_folder: String)
bool	setItemDescription(update_handle: int, description: String)
bool	setItemMetadata(update_handle: int, ugc_metadata: String)
bool	setItemPreview(update_handle: int, preview_file: String)
bool	setItemTags(update_handle: int, tag_array: Array, allow_admin_tags: bool = false)
bool	setItemTitle(update_handle: int, title: String)
bool	setItemUpdateLanguage(update_handle: int, language: String)
bool	setItemVisibility(update_handle: int, visibility: RemoteStoragePublishedFileVisibility)
void	setKeyFocus(has_key_focus: bool, this_handle: int = 0)
void	setLEDColor(input_handle: int, color_r: int, color_g: int, color_b: int, flags: int)
bool	setLanguage(query_handle: int, language: String)
bool	setListenForFriendsMessages(intercept: bool)
bool	setLobbyData(steam_lobby_id: int, key: String, value: String)
void	setLobbyGameServer(steam_lobby_id: int, server_ip: String = "0", server_port: int = 0, steam_id_game_server: int = 0)
bool	setLobbyJoinable(steam_lobby_id: int, joinable: bool)
void	setLobbyMemberData(steam_lobby_id: int, key: String, value: String)
bool	setLobbyMemberLimit(steam_lobby_id: int, max_members: int)
bool	setLobbyOwner(steam_lobby_id: int, steam_id_new_owner: int)
bool	setLobbyType(steam_lobby_id: int, lobby_type: LobbyType)
bool	setLocation(screenshot: int, location: String)
bool	setMatchAnyTag(query_handle: int, match_any_tag: bool)
void	setOverlayNotificationInset(horizontal: int, vertical: int)
void	setOverlayNotificationPosition(pos: int)
bool	setPNGIcon64x64(icon: PackedByteArray)
void	setPageScaleFactor(zoom: float, point_x: int, point_y: int, this_handle: int = 0)
void	setPersonaName(name: String)
void	setPlayedWith(steam_id: int)
bool	setPlaylistEntry(id: int, position: int, entry_text: String)
bool	setPropertyBool(item_id: int, name: String, value: bool, this_inventory_update_handle: int = 0)
bool	setPropertyFloat(item_id: int, name: String, value: float, this_inventory_update_handle: int = 0)
bool	setPropertyInt(item_id: int, name: String, value: int, this_inventory_update_handle: int = 0)
bool	setPropertyString(item_id: int, name: String, value: String, this_inventory_update_handle: int = 0)
bool	setQueueEntry(id: int, position: int, entry_text: String)
bool	setRankedByTrendDays(query_handle: int, days: int)
bool	setRequiredGameVersions(query_handle: int, game_branch_min: String, game_branch_max: String)
bool	setReturnAdditionalPreviews(query_handle: int, return_additional_previews: bool)
bool	setReturnChildren(query_handle: int, return_children: bool)
bool	setReturnKeyValueTags(query_handle: int, return_key_value_tags: bool)
bool	setReturnLongDescription(query_handle: int, return_long_description: bool)
bool	setReturnMetadata(query_handle: int, return_metadata: bool)
bool	setReturnOnlyIDs(query_handle: int, return_only_ids: bool)
bool	setReturnPlaytimeStats(query_handle: int, days: int)
bool	setReturnTotalOnly(query_handle: int, return_total_only: bool)
bool	setRichPresence(key: String, value: String)
bool	setSearchText(query_handle: int, search_text: String)
void	setSize(width: int, height: int, this_handle: int = 0)
bool	setStatFloat(name: String, value: float)
bool	setStatInt(name: String, value: int)
bool	setSyncPlatforms(file: String, platform: int)
bool	setTimeCreatedDateRange(update_handle: int, start: int, end: int)
bool	setTimeUpdatedDateRange(update_handle: int, start: int, end: int)
void	setTimelineGameMode(mode: TimelineGameMode)
void	setTimelineTooltip(description: String, time_delta: float)
void	setUserItemVote(published_file_id: int, vote_up: bool)
void	setVRHeadsetStreamingEnabled(enabled: bool)
void	setVerticalScroll(absolute_pixel_scroll: int, this_handle: int = 0)
void	set_server_list_request(new_server_list_request: int)
bool	showBindingPanel(input_handle: int)
bool	showFloatingGamepadTextInput(input_mode: FloatingGamepadTextInputMode, text_field_x_position: int, text_field_y_position: int, text_field_width: int, text_field_height: int)
bool	showGamepadTextInput(input_mode: GamepadTextInputMode, line_input_mode: GamepadTextInputLineMode, description: String, max_text: int, preset_text: String)
bool	showWorkshopEULA()
void	startGamePhase()
int	startItemUpdate(app_id: int, file_id: int)
void	startPlaytimeTracking(published_file_ids: Array)
void	startPurchase(items: PackedInt64Array, quantity: PackedInt32Array)
int	startRangeTimelineEvent(title: String, description: String, icon: String, priority: int, start_offset_seconds: float, possible_clip: TimelineEventClipPriority = 1)
bool	startRemotePlayTogether(show_overlay: bool = true)
void	startUpdateProperties()
void	startVRDashboard()
void	startVoiceRecording()
Dictionary	steamInit(retrieve_stats: bool = false, app_id: int = 0, embed_callbacks: bool = false)
Dictionary	steamInitEx(retrieve_stats: bool = false, app_id: int = 0, embed_callbacks: bool = false)
void	steamShutdown()
void	stopAnalogActionMomentum(input_handle: int, action: int)
void	stopFind(this_handle: int = 0)
void	stopLoad(this_handle: int = 0)
void	stopPlaytimeTracking(published_file_ids: Array)
void	stopPlaytimeTrackingForAllItems()
void	stopVoiceRecording()
bool	storeStats()
void	submitItemUpdate(update_handle: int, change_note: String)
int	submitPlayerResult(game_id: int, player_id: int, player_result: PlayerResult)
int	submitUpdateProperties(this_inventory_update_handle: int = 0)
void	subscribeItem(published_file_id: int)
void	suspendDownloads(suspend: bool)
bool	tagPublishedFile(screenshot: int, file_id: int)
bool	tagUser(screenshot: int, steam_id: int)
void	terminateGameConnection(server_ip: String, server_port: int)
int	transferItemQuantity(item_id: int, quantity: int, item_destination: int, split: bool)
int	translateActionOrigin(destination_input: InputType, source_origin: InputActionOrigin)
void	triggerHapticPulse(input_handle: int, target_pad: int, duration: int)
int	triggerItemDrop(definition: int)
void	triggerRepeatedHapticPulse(input_handle: int, target_pad: int, duration: int, offset: int, repeat: int, flags: int)
void	triggerScreenshot()
void	triggerSimpleHapticEvent(input_handle: int, haptic_location: int, intensity: int, gain_db: String, other_intensity: int, other_gain_db: String)
void	triggerVibration(input_handle: int, left_speed: int, right_speed: int)
void	triggerVibrationExtended(input_handle: int, left_speed: int, right_speed: int, left_trigger_speed: int, right_trigger_speed: int)
void	ugcDownload(content: int, priority: int)
void	ugcDownloadToLocation(content: int, location: String, priority: int)
PackedByteArray	ugcRead(content: int, data_size: int, offset: int, action: UGCReadAction)
void	uninstallDLC(dlc_id: int)
void	unsubscribeItem(published_file_id: int)
bool	updateAvgRateStat(name: String, this_session: float, session_length: float)
bool	updateCurrentEntryCoverArt(art: PackedByteArray)
bool	updateCurrentEntryElapsedSeconds(seconds: int)
bool	updateCurrentEntryText(text: String)
bool	updateItemPreviewFile(update_handle: int, index: int, preview_file: String)
bool	updateItemPreviewVideo(update_handle: int, index: int, video_id: String)
bool	updateLooped(looped: bool)
bool	updatePlaybackStatus(status: AudioPlaybackStatus)
void	updateRangeTimelineEvent(this_event: int, title: String, description: String, icon: String, priority: int, possible_clip: TimelineEventClipPriority = 1)
bool	updateShuffled(shuffle: bool)
bool	updateVolume(volume: float)
void	uploadLeaderboardScore(score: int, keep_best: bool = true, details: PackedInt32Array = PackedInt32Array(), this_leaderboard: int = 0)
int	userHasLicenseForApp(steam_id: int, app_id: int)
void	viewSource(this_handle: int = 0)
bool	waitForData(wait_forever: bool, timeout: int)
int	writeScreenshot(rgb: PackedByteArray, width: int, height: int)

Signals¶

active_beacons_updated() 🔗

Notification that the list of active beacons visible to the current user has changed.

add_app_dependency_result(result: int, file_id: int, app_id: int) 🔗

The result of a call to addAppDependency.

add_ugc_dependency_result(result: int, file_id: int, child_id: int) 🔗

The result of a call to addAppDependency.

app_resuming_from_suspend() 🔗

Sent after the device returns from sleep/suspend mode.

available_beacon_locations_updated() 🔗

Notification that the list of available locations for posting a beacon has been updated.

avatar_image_loaded(avatar_id: int, avatar_index: int, width: int, height: int) 🔗

Called when an avatar is requested; sends back the raw Steamworks callback data compared to avatar_loaded.

Emits signal in response to function getLargeFriendAvatar, getMediumFriendAvatar, or getSmallFriendAvatar.

avatar_loaded(avatar_id: int, size: int, data: Array) 🔗

Called when a large avatar is loaded if you have tried requesting it when it was unavailable.

Emits signal in response to function getLargeFriendAvatar, getMediumFriendAvatar, or getSmallFriendAvatar.

change_num_open_slots(result: int) 🔗

Call result for changeNumOpenSlots.

change_server_requested(server: String, password: String) 🔗

This callback is made when joining a game. If the user is attempting to join a lobby, then the callback join_requested will be made.

check_file_signature(signature: String) 🔗

Call result for checkFileSignature.

clan_activity_downloaded(activity: Dictionary) 🔗

Called when a Steam group activity has received.

Emits signal in response to function downloadClanActivityCounts.

client_game_server_deny(app_id: int, ip: String, server_port: int, secure: int, reason: int) 🔗

Sent by the Steam server to the client telling it to disconnect from the specified game server, which it may be in the process of or already connected to. The game client should immediately disconnect upon receiving this message. This can usually occur if the user doesn't have rights to play on the game server.

connected_chat_join(chat_id: int, steam_id: int) 🔗

Called when a user has joined a Steam group chat that the we are in.

connected_chat_leave(chat_id: int, steam_id: int, kicked: bool, dropped: bool) 🔗

Called when a user has left a Steam group chat that the we are in.

connected_clan_chat_message(chat: Dictionary) 🔗

Called when a chat message has been received in a Steam group chat that we are in.

The returned dictionary contains the following keys:

┠╴ret (int)
┠╴text (string)
┠╴type (string)
┖╴chatter (int)

connected_friend_chat_message(chat: Dictionary) 🔗

Called when chat message has been received from a friend.

The returned dictionary contains the following keys:

┠╴ret (int)
┠╴text (string)
┖╴type (int)

create_beacon(result: int, beacon_id: int) 🔗

This callback is used as a call response for createBeacon. If successful, your beacon has been posted in the desired location and you may start receiving reservation_notification callbacks for users following the beacon.

current_stats_received(game_id: int, result: int, user_id: int) 🔗

Called when the latest stats and achievements for the local user have been received from the server;

dlc_installed(app: int) 🔗

Triggered after the current user gains ownership of DLC and that DLC is installed.

download_ugc_result(result: int, download_data: Dictionary) 🔗

Response when downloading UGC.

The returned dictionary has the following keys:

┠╴handle (int)
┠╴app_id (int)
┠╴size (int)
┠╴filename (string)
┖╴owner_id (int)

duration_control(result: int, duration: Dictionary) 🔗

Sent for games with enabled anti indulgence / duration control, for enabled users. Lets the game know whether persistent rewards or XP should be granted at normal rate, half rate, or zero rate.

The returned dictionary contains the following keys:

┠╴app_id (int)
┠╴applicable (bool)
┠╴seconds_last_5hrs (int)
┠╴progress (int)
┠╴notification (int)
┖╴notification_verbal (string)

encrypted_app_ticket_response(result: String) 🔗

Called when an encrypted application ticket has been received.

end_game_result(result: int, game_id: int) 🔗

This callback confirms that the game is recorded as complete on the matchmaking service, the next call to requestPlayersForGame will generate a new unique game ID.

enumerate_following_list(message: String, following: Array) 🔗

Returns the result of enumerateFollowingList.

The returned array contains a list of dictionaries containing the following keys:

┠╴num (int)
┖╴id (int)

equipped_profile_items(result: int, steam_id: int, profile_data: Dictionary) 🔗

Call result from requestEquippedProfileItems. Also sent as a callback.

The returned dictionary contains the following keys:

┠╴avatar_animated (bool)
┠╴avatar_frame (bool)
┠╴profile_modifier (bool)
┠╴profile_background (bool)
┖╴profile_mini_background (bool)

equipped_profile_items_changed(steam_id: int) 🔗

Callback for when a user's equipped Steam Commuity profile items have changed. This can be for the current user or their friends.

fake_ip_result(result: int, remote_fake_steam_id: int, fake_ip: String, port_list: Array) 🔗

A struct used to describe a "fake IP" we have been assigned to use as an identifier. This callback is posted when beginAsyncRequestFakeIPcompletes.

favorites_list_accounts_updated(result: int) 🔗

Called when an account on your favorites list is updated.

favorites_list_changed(favorite: Dictionary) 🔗

A server was added/removed from the favorites list, you should refresh now.

The returned dictionary contains the following keys:

┠╴ip (string)
┠╴query_port (int)
┠╴connection_port (int)
┠╴app_id (int)
┠╴flags (int)
┠╴add (bool)
┖╴account_id (int)

file_details_result(result: int, file_size: PackedByteArray, file_hash: int, flags: int) 🔗

Called after requesting the details of a specific file.

file_read_async_complete(file_read: Dictionary) 🔗

Response when reading a file with fileReadAsync.

Response to a file being shared.

file_write_async_complete(result: int) 🔗

Response when writing a file asyncrounously with fileWriteAsync.

filter_text_dictionary_changed(language: int) 🔗

Sent when the text filtering dictionary has changed languages.

floating_gamepad_text_input_dismissed() 🔗

Called when the floating keyboard invoked from showFloatingGamepadTextInput has been closed.

friend_rich_presence_update(steam_id: int, app_id: int) 🔗

Called when rich presence data has been updated for a user, this can happen automatically when friends in the same game update their rich presence, or after a call to requestFriendRichPresence.

game_web_callback(url: String) 🔗

Sent to your game in response to a steam://gamewebcallback/ command from a user clicking a link in the Steam overlay browser. You can use this to add support for external site signups where you want to pop back into the browser after some web page signup sequence, and optionally get back some detail about that.

gamepad_text_input_dismissed(submitted: bool, entered_text: String, app_id: int) 🔗

Called when the Big Picture gamepad text input has been closed.

get_app_dependencies_result(result: int, file_id: int, app_dependencies: int, total_app_dependencies: int) 🔗

Called when getting the app dependencies for an item.

get_auth_session_ticket_response(auth_ticket: int, result: int) 🔗

Result when creating an auth session ticket.

get_follower_count(result: int, steam_id: int, count: int) 🔗

Returns the result of getFollowerCount.

get_item_vote_result(result: int, file_id: int, vote_up: bool, vote_down: bool, vote_skipped: bool) 🔗

Called when getting the users vote status on an item.

get_opf_settings_result(result: int, app_id: int) 🔗

Triggered when the OPF Details for 360 video playback are retrieved. After receiving this you can use getOPFStringForApp to access the OPF details.

get_ticket_for_web_api(auth_ticket: int, result: int, ticket_size: int, ticket_buffer: Array) 🔗

Result when creating an web API ticket from GetAuthTicketForWebApi.

get_video_result(result: int, app_id: int, url: String) 🔗

Provides the result of a call to getVideoURL.

global_achievement_percentages_ready(game_id: int, result: int) 🔗

Called when the global achievement percentages have been received from the server.

global_stats_received(game_id: int, result: String) 🔗

Called when the global stats have been received from the server.

html_browser_ready(browser_handle: int) 🔗

A new browser was created and is ready for use.

html_can_go_backandforward(browser_handle: int, go_back: bool, go_forward: bool) 🔗

Called when page history status has changed the ability to go backwards and forward.

html_changed_title(browser_handle: int, title: String) 🔗

Called when the current page in a browser gets a new title.

html_close_browser(browser_handle: int) 🔗

Called when the browser has been requested to close due to user interaction; usually because of a javascript window.close() call.

html_file_open_dialog(browser_handle: int, title: String, initial_file: String) 🔗

Called when a browser surface has received a file open dialog from a input type="file" click or similar.

html_finished_request(browser_handle: int, url: String, title: String) 🔗

Called when a browser has finished loading a page.

Called when a a browser wants to hide a tooltip.

html_horizontal_scroll(browser_handle: int, scroll_data: Dictionary) 🔗

Provides details on the visibility and size of the horizontal scrollbar.

The returned dictionary contains the following keys:

┠╴scroll_max (int)
┠╴scroll_current (int)
┠╴page_scale (float)
┠╴visible (bool)
┖╴page_size (int)

html_js_alert(browser_handle: int, message: String) 🔗

Called when the browser wants to display a Javascript alert dialog, call jsDialogResponse when the user dismisses this dialog; or right away to ignore it.

html_js_confirm(browser_handle: int, message: String) 🔗

Called when the browser wants to display a Javascript confirmation dialog, call jsDialogResponse when the user dismisses this dialog; or right away to ignore it.

html_link_at_position(browser_handle: int, link_data: Dictionary) 🔗

Result of a call to getLinkAtPosition.

html_needs_paint(browser_handle: int, page_data: Dictionary) 🔗

Called when a browser surface has a pending paint. This is where you get the actual image data to render to the screen.

The returned dictionary contains the following keys:

┠╴bgra (string)
┠╴wide (int)
┠╴tall (int)
┠╴update_x (int)
┠╴update_y (int)
┠╴update_wide (int)
┠╴update_tall (int)
┠╴scroll_x (int)
┠╴scroll_y (int)
┠╴page_scale (float)
┖╴page_serial (int)

html_new_window(browser_handle: int, window_data: Dictionary) 🔗

A browser has created a new HTML window.

The returned dictionary contains the following keys:

┠╴url (string)
┠╴x (int)
┠╴y (int)
┠╴wide (int)
┠╴tall (int)
┖╴new_handle (int)

html_open_link_in_new_tab(browser_handle: int, url: String) 🔗

The browser has requested to load a url in a new tab.

html_search_results(browser_handle: int, results: int, current_match: int) 🔗

Results from a search.

html_set_cursor(browser_handle: int, mouse_cursor: int) 🔗

Called when a browser wants to change the mouse cursor.

Called when a browser wants to display a tooltip.

html_start_request(browser_handle: int, url: String, target: String, post_data: String, redirect: bool) 🔗

Called when a browser wants to navigate to a new page.

html_status_text(browser_handle: int, message: String) 🔗

Called when a browser wants you to display an informational message. This is most commonly used when you hover over links.

Called when the text of an existing tooltip has been updated.

html_url_changed(browser_handle: int, url_data: Dictionary) 🔗

Called when the browser is navigating to a new url.

The returned dictionary contains the following keys:

┠╴url (string)
┠╴post_data (string)
┠╴redirect (bool)
┠╴title (string)
┖╴new_navigation (bool)

html_vertical_scroll(browser_handle: int, scroll_data: Dictionary) 🔗

Provides details on the visibility and size of the vertical scrollbar.

The returned dictionary contains the following keys:

┠╴scroll_max (int)
┠╴scroll_current (int)
┠╴page_scale (float)
┠╴visible (bool)
┖╴page_size (int)

http_request_completed(cookie_handle: int, context_value: int, request_success: bool, status_code: int, body_size: int) 🔗

Result when an HTTP request completes. If you're using getHTTPStreamingResponseBodyData then you should be using the http_request_headers_received or http_request_data_received.

http_request_data_received(cookie_handle: int, context_value: int, offset: int, bytes_received: int) 🔗

Triggered when a chunk of data is received from a streaming HTTP request.

http_request_headers_received(cookie_handle: int, context_value: int) 🔗

Triggered when HTTP headers are received from a streaming HTTP request.

input_action_event(input_handle: int, event_type: int, action_handle: int, is_active: bool, action_data: Dictionary) 🔗

Purpose: when callbacks are enabled this fires each time a controller action state changes.

input_configuration_loaded(app_id: int, device_handle: int, config_data: Dictionary) 🔗

Called when a controller configuration has been loaded, will fire once per controller per focus change for Steam Input enabled controllers.

The returned dictionary contains the following keys:

┠╴mapping_creator (int)
┠╴major_revision (int)
┠╴minor_revision (int)
┠╴uses_steam_input_api (bool)
┖╴uses_gamepad_api (bool)

input_device_connected(input_handle: int) 🔗

Called when a new controller has been connected, will fire once per controller if multiple new controllers connect in the same frame.

input_device_disconnected(input_handle: int) 🔗

Called when a new controller has been disconnected, will fire once per controller if multiple new controllers disconnect in the same frame.

input_gamepad_slot_change(app_id: int, device_handle: int, device_type: int, old_gamepad_slot: int, new_gamepad_slot: int) 🔗

Called when controller gamepad slots change. On Linux / macOS these slots are shared for all running apps.

inventory_definition_update(definitions: Array) 🔗

This callback is triggered whenever item definitions have been updated, which could be in response to loadItemDefinitions or any time new item definitions are available (eg, from the dynamic addition of new item types while players are still in-game).

Returned when you have requested the list of "eligible" promo items that can be manually granted to the given user. These are promo items of type "manual" that won't be granted automatically.

inventory_full_update(inventory_handle: int) 🔗

Triggered when getAllItems successfully returns a result which is newer / fresher than the last known result. (It will not trigger if the inventory hasn't changed, or if results from two overlapping calls are reversed in flight and the earlier result is already known to be stale/out-of-date.) The regular inventory_result_ready callback will still be triggered immediately afterwards; this is an additional notification for your convenience.

inventory_request_prices_result(result: int, currency: String) 🔗

Returned after requestPrices is called.

inventory_result_ready(result: int, inventory_handle: int) 🔗

This is fired whenever an inventory result transitions from RESULT_PENDING to any other completed state, see getResultStatus for the complete list of states. There will always be exactly one callback per handle.

inventory_start_purchase_result(result: String, order_id: int, transaction_id: int) 🔗

This is fired whenever an inventory result transitions from RESULT_PENDING to any other completed state, see getResultStatus for the complete list of states. There will always be exactly one callback per handle.

ip_country() 🔗

Called when the country of the user changed. The country should be updated with getIPCountry.

ipc_failure(type: int) 🔗

Called when the callback system for this client is in an error state (and has flushed pending callbacks). When getting this message the client should disconnect from Steam, reset any stored Steam state and reconnect. This usually occurs in the rare event the Steam client has some kind of fatal error.

is_following(result: int, steam_id: int, following: bool) 🔗

Returns the result of isFollowing.

item_created(result: int, file_id: int, accept_tos: bool) 🔗

Called when a new workshop item has been created.

item_deleted(result: int, file_id: int) 🔗

Called when an attempt at deleting an item completes.

item_downloaded(result: int, file_id: int, app_id: int) 🔗

Called when a workshop item has been downloaded.

item_installed(app_id: int, file_id: int) 🔗

Called when a workshop item has been installed or updated.

item_updated(result: int, need_to_accept_tos: bool) 🔗

Called when an item update has completed.

Emits signal in response to function submitItemUpdate.

join_clan_chat_complete(chat_id: int, response: int) 🔗

Posted when the user has attempted to join a Steam group chat via joinClanChatRoom.

join_game_requested(user: int, connect: String) 🔗

Called when the user tries to join a game from their friends list or after a user accepts an invite by a friend with inviteUserToGame.

Emits signal in response to receiving a Steam invite.

join_party(result: int, beacon_id: int, steam_id: int, connect_string: String) 🔗

This callback is used as a call response for joinParty. On success, you will have reserved a slot in the beacon-owner's party, and should use connect_string to connect to their game and complete the process.

join_requested(lobby_id: int, steam_id: int) 🔗

Called when the user tries to join a lobby from their friends list or after a user accepts an invite by a friend with inviteUserToGame.

Emits signal in response to receiving a Steam invite.

leaderboard_find_result(leaderboard_handle: int, found: int) 🔗

Result when finding a leaderboard.

leaderboard_score_uploaded(success: bool, this_handle: int, this_score: Dictionary) 🔗

Result indicating that a leaderboard score has been uploaded.

The returned dictionary contains the following keys:

┠╴score (int)
┠╴score_changed (int)
┠╴global_rank_new (int)
┖╴global_rank_prev (int)

leaderboard_scores_downloaded(message: String, leaderboard_handle: int, leaderboard_entries: Array) 🔗

Called when scores for a leaderboard have been downloaded and are ready to be retrieved.

The returned array contains dictionaries containing the following keys:

┠╴score (int)
┠╴steam_id (int)
┠╴global_rank (int)
┠╴ugc_handle (int)
┖╴details (array)

leaderboard_ugc_set(leaderboard_handle: int, result: String) 🔗

Result indicating that user generated content has been attached to one of the current user's leaderboard entries.

licenses_updated() 🔗

Called whenever the users licenses (owned packages) changes.

lobby_chat_update(lobby_id: int, changed_id: int, making_change_id: int, chat_state: int) 🔗

A lobby chat room state has changed, this is usually sent when a user has joined or left the lobby.

lobby_created(connect: int, lobby_id: int) 🔗

Result of our request to create a Lobby. At this point, the lobby has been joined and is ready for use.

lobby_data_update(success: int, lobby_id: int, member_id: int) 🔗

The lobby metadata has changed.

lobby_game_created(lobby_id: int, server_id: int, server_ip: String, port: int) 🔗

A game server has been set via setLobbyGameServer for all of the members of the lobby to join. It's up to the individual clients to take action on this; the typical game behavior is to leave the lobby and connect to the specified game server; but the lobby may stay open throughout the session if desired.

lobby_invite(inviter: int, lobby: int, game: int) 🔗

Someone has invited you to join a lobby. Normally you don't need to do anything with this, as the Steam UI will also display a 'user has invited you to the lobby, join?' notification and message.

lobby_joined(lobby: int, permissions: int, locked: bool, response: int) 🔗

Received upon attempting to enter a lobby. Lobby metadata is available to use immediately after receiving this.

lobby_kicked(lobby_id: int, admin_id: int, due_to_disconnect: int) 🔗

Posted if a user is forcefully removed from a lobby; can occur if a user loses connection to Steam.

lobby_match_list(lobbies: Array) 🔗

Result when requesting the lobby list.

Emits signal in response to function requestLobbyList.

lobby_message(lobby_id: int, user: int, message: String, chat_type: int) 🔗

A chat (text or binary) message for this lobby has been received.

local_file_changed() 🔗

One or more files for this app have changed locally after syncing to remote session changes.

Note: only posted if this happens during the local app session.

low_power(power: int) 🔗

Called when running on a laptop and less than 10 minutes of battery is left, and then fires then every minute afterwards.

microtransaction_auth_response(app_id: int, order_id: int, authorized: bool) 🔗

Called when a user has responded to a microtransaction authorization request.

music_playback_status_has_changed() 🔗

There are no notes in the Steamworks documentation.

music_player_remote_to_front() 🔗

There are no notes in the Steamworks documentation.

music_player_remote_will_activate() 🔗

There are no notes in the Steamworks documentation.

music_player_remote_will_deactivate() 🔗

There are no notes in the Steamworks documentation.

music_player_selects_playlist_entry(entry: int) 🔗

There are no notes in the Steamworks documentation.

music_player_selects_queue_entry(entry: int) 🔗

There are no notes in the Steamworks documentation.

music_player_wants_looped(looped: bool) 🔗

There are no notes in the Steamworks documentation.

music_player_wants_pause() 🔗

There are no notes in the Steamworks documentation.

music_player_wants_play() 🔗

There are no notes in the Steamworks documentation.

music_player_wants_play_next() 🔗

There are no notes in the Steamworks documentation.

music_player_wants_play_previous() 🔗

There are no notes in the Steamworks documentation.

music_player_wants_playing_repeat_status(status: int) 🔗

There are no notes in the Steamworks documentation.

music_player_wants_shuffled(shuffled: bool) 🔗

There are no notes in the Steamworks documentation.

music_player_wants_volume(volume: float) 🔗

There are no notes in the Steamworks documentation.

music_player_will_quit() 🔗

There are no notes in the Steamworks documentation.

music_volume_has_changed(new_volume: float) 🔗

There are no notes in the Steamworks documentation.

name_changed(success: bool, local_success: bool, result: int) 🔗

Reports the result of an attempt to change the current user's persona name.

Emits signal in response to function setPersonaName.

network_authentication_status(available: int, debug_message: String) 🔗

This callback is posted whenever the state of our readiness changes.

network_connection_status_changed(connect_handle: int, connection: Dictionary, old_state: int) 🔗

This callback is posted whenever a connection is created, destroyed, or changes state. The m_info field will contain a complete description of the connection at the time the change occurred and the callback was posted. In particular, m_info.m_eState will have the new connection state.

The returned dictionary contains the following keys:

┠╴identity (string)
┠╴user_data (int)
┠╴listen_socket (int)
┠╴remote_address (string)
┠╴remote_pop (int)
┠╴pop_relay (int)
┠╴connection_state (int)
┠╴end_reason (string)
┠╴end_debug (string)
┖╴debug_description (string)

network_messages_session_failed(reason: int) 🔗

Posted when we fail to establish a connection, or we detect that communications have been disrupted it an unusual way.

network_messages_session_request(remote_steam_id: int) 🔗

Posted when a remote host is sending us a message, and we do not already have a session with them.

new_launch_url_parameters() 🔗

Triggered after the user executes a steam url with command line or query parameters such as steam://run/(app_id)//?param1=value1;param2=value2;param3=value3; while the game is already running. The new params can be queried with getLaunchCommandLine and getLaunchQueryParam.

number_of_current_players(success: int, players: int) 🔗

Gets the current number of players for the current app ID.

overlay_browser_protocol(uri: String) 🔗

Dispatched when an overlay browser instance is navigated to a protocol/scheme registered by registerProtocolInOverlayBrowser.

overlay_toggled(active: bool, user_initiated: bool, app_id: int) 🔗

Posted when the Steam Overlay activates or deactivates. The game can use this to be pause or resume single player games.

p2p_session_connect_fail(remote_steam_id: int, session_error: int) 🔗

Called when a user sends a packet and it fails.

p2p_session_request(remote_steam_id: int) 🔗

Called when a user sends a packet.

parental_setting_changed() 🔗

Callback for querying UGC.

persona_state_change(steam_id: int, flags: int) 🔗

This is called when a user has some kind of change.

ping_server_failed_to_respond() 🔗

The server has failed to respond to a ping request.

ping_server_responded(server_details: Dictionary) 🔗

The server has responded to a ping request.

The returned dictionary contains the following keys:

┠╴name (string)
┠╴connection_address (string)
┠╴query_address (string)
┠╴ping (int)
┠╴success_response (bool)
┠╴no_refresh (bool)
┠╴game_dir (string)
┠╴map (string)
┠╴description (string)
┠╴app_id (int)
┠╴players (int)
┠╴max_players (int)
┠╴bot_players (int)
┠╴password (bool)
┠╴secure (bool)
┠╴last_played (int)
┠╴server_version (int)
┠╴game_tags (string)
┖╴steam_id (uint64_t)

player_details_failed_to_respond() 🔗

The server failed to respond to a player details request.

player_details_player_added(name: String, score: int, time_played: float) 🔗

The server has responded to a player details request.

player_details_refresh_complete() 🔗

The server has completed a player details request.

relay_network_status(available: int, ping_measurement: int, available_config: int, available_relay: int, debug_message: String) 🔗

A struct used to describe our readiness to use the relay network.

remote_play_session_connected(session_id: int) 🔗

Called when a player connects to a remote play session.

remote_play_session_disconnected(session_id: int) 🔗

Called when a player disconnects from a remote play session.

remove_app_dependency_result(result: int, file_id: int, app_id: int) 🔗

Purpose: The result of a call to removeAppDependency.

remove_ugc_dependency_result(result: int, file_id: int, child_id: int) 🔗

Purpose: The result of a call to removeDependency.

request_clan_officer_list(message: String, officer_list: Array) 🔗

Marks the return of a request officer list call.

Emits signal in response to function requestClanOfficerList.

The returned list contains dictionaries which contain the following keys:

┠╴id (int)
┖╴name (string)

request_players_for_game_final_result(result: int, search_id: int, game_id: int) 🔗

There are no notes about this in Valve's header files or documentation.

request_players_for_game_progress(result: int, search_id: int) 🔗

Callback from requestPlayersForGame when the matchmaking service has started or ended search; callback will also follow a call from cancelRequestPlayersForGame - search_in_progress will be false.

request_players_for_game_result(result: int, search_id: int, player_data: Dictionary) 🔗

Callback from requestPlayersForGame, one of these will be sent per player followed by additional callbacks when players accept or decline the game.

The returned dictionary contains the following keys:

┠╴player_id (int)
┠╴lobby_id (int)
┠╴player_accept_state (int)
┠╴player_index (int)
┠╴total_players (int)
┠╴total_players_accepted_game (int)
┠╴suggested_team_index (int)
┖╴unique_game_id (int)

request_server_list_refresh_complete(request_handle: int, response: int) 🔗

A server list request has completed.

request_server_list_server_failed_to_respond(request_handle: int, server: int) 🔗

A server failed to respond to a list request.

request_server_list_server_responded(request_handle: int, server: int) 🔗

A server has responded to a list request.

reservation_notification(beacon_id: int, steam_id: int) 🔗

After creating a beacon, when a user "follows" that beacon Steam will send you this callback to know that you should be prepared for the user to join your game. When they do join, be sure to call onReservationCompleted to let Steam know.

screenshot_ready(handle: int, result: int) 🔗

A screenshot successfully written or otherwise added to the library and can now be tagged.

screenshot_requested() 🔗

A screenshot has been requested by the user from the Steam screenshot hotkey. This will only be called if hookScreenshots has been enabled, in which case Steam will not take the screenshot itself.

search_for_game_progress(result: int, search_id: int, search_progress: Dictionary) 🔗

There are no notes about this in Valve's header files or documentation.

The returned dictionary contains the following keys:

┠╴lobby_id (int)
┠╴ended_search_id (int)
┠╴seconds_remaining_estimate (int)
┖╴players_searching (int)

search_for_game_result(result: int, search_id: int, search_result: Dictionary) 🔗

Notification to all players searching that a game has been found.

The returned dictionary contains the following keys:

┠╴count_players_ingame (int)
┠╴count_accepted_game (int)
┠╴host_id (int)
┖╴final_callback (bool)

server_rules_failed_to_respond() 🔗

The server failed to respond with a rules request.

server_rules_refresh_complete() 🔗

The server has completed a rules refresh.

server_rules_responded(rule: String, value: String) 🔗

The server responded with a rules request.

set_user_item_vote(result: int, file_id: int, vote_up: bool) 🔗

Called when the user has voted on an item.

start_playtime_tracking(result: int) 🔗

Called when workshop item playtime tracking has started.

steam_api_call_completed(async_call: int, callback: int, parameter: int) 🔗

Called when a SteamAPICall_t has completed or failed.

steam_server_connect_failed(result: int, retrying: bool) 🔗

Called when a connection attempt has failed. This will occur periodically if the Steam client is not connected, and has failed when retrying to establish a connection.

steam_server_connected() 🔗

Called when a connections to the Steam back-end has been established. This means the Steam client now has a working connection to the Steam servers. Usually this will have occurred before the game has launched, and should only be seen if the user has dropped connection due to a networking issue or a Steam server update.

steam_server_disconnected() 🔗

Called if the client has lost connection to the Steam servers. Real-time services will be disabled until a matching steam_server_connected has been posted.

steam_shutdown() 🔗

Called when Steam wants to shut down.

stop_playtime_tracking(result: int) 🔗

Called when workshop item playtime tracking has stopped.

store_auth_url_response(url: String) 🔗

Response when we have received the authentication URL after a call to requestStoreAuthURL.

submit_player_result(result: int, game_id: int, player_id: int) 🔗

This callback confirms that results were received by the matchmaking service for this player.

Called when a player attempts to subscribe to a Workshop item.

Deprecated: only used with the deprecated Remote Storage based Workshop API.

timed_trial_status(app_id: int, is_offline: bool, seconds_allowed: int, seconds_played: int) 🔗

Called for games in Timed Trial mode.

timeline_event_recording_exists(event_id: int, recording_exists: bool) 🔗

Called when asking if recordings exist for a game phase ID.

timeline_game_phase_recording_exists(phase_id: String, recording_ms: int, longest_clip_ms: int, clip_count: int, screenshot_count: int) 🔗

Called when asking if recordings exist for an event handle.

ugc_query_completed(handle: int, result: int, results_returned: int, total_matching: int, cached: bool) 🔗

Called when a UGC query request completes.

unread_chat_messages_changed() 🔗

Invoked when the status of unread messages changes

unsubscribe_item(result: int, file_id: int) 🔗

Called when a player attempts to unsubscribe from a Workshop item.

Deprecated: only used with the deprecated Remote Storage based Workshop API.

user_achievement_icon_fetched(game_id: int, achievement_name: String, was_achieved: bool, icon_handle: int) 🔗

Result of an achievement icon that has been fetched.

user_achievement_stored(game_id: int, group_achieve: bool, achievement_name: String, current_progress: int, max_progress: int) 🔗

Result of a request to store the achievements on the server, or an "indicate progress" call. If both current progress and max progress are zero, that means the achievement has been fully unlocked.

user_favorite_items_list_changed(result: int, file_id: int, was_add_request: bool) 🔗

Called when the user has added or removed an item to/from their favorites.

user_stats_received(game_id: int, result: int, user_id: int) 🔗

Called when the latest stats and achievements for a specific user (including the local user) have been received from the server.

user_stats_stored(game_id: int, result: int) 🔗

Result of a request to store the user stats.

user_stats_unloaded(user_id: int) 🔗

Callback indicating that a user's stats have been unloaded. Call requestUserStats again before accessing stats for this user.

user_subscribed_items_list_changed(app_id: int) 🔗

Signal that the list of subscribed items changed.

validate_auth_ticket_response(auth_id: int, response: int, owner_id: int) 🔗

Called when an auth ticket has been validated.

Emits signal in response to function beginAuthSession.

workshop_eula_status(result: int, app_id: int, eula_data: Dictionary) 🔗

Status of the user's acceptable/rejection of the app's specific Workshop EULA.

The returned dictionary contains the following keys:

┠╴version (int)
┠╴action (int)
┠╴accepted (bool)
┖╴needs_action (bool)