steam

steam.init()

steam.init()

Initialize Steamworks.

PARAMETERS

None

RETURNS

steam.update()

steam.update()

Update Steamworks. Call this from a script component.

PARAMETERS

None

steam.restart()

steam.restart(appid)

Restart Steamworks.

PARAMETERS

steam.final()

steam.final()

Finalize Steamworks.

PARAMETERS

None

steam.apps_is_dlc_installed()

steam.apps_is_dlc_installed(app_id)

Takes AppID of DLC and checks if the user owns the DLC & if the DLC is installed.

PARAMETERS

RETURNS

steam.friends_get_friend_persona_name()

steam.friends_get_friend_persona_name(CSteamID)

Returns the name of another user. Same rules as GetFriendPersonaState() apply as to whether or not the user knowns the name of the other user note that on first joining a lobby, chat room or game server the local user will not known the name of the other users automatically; that information will arrive asyncronously.

PARAMETERS

RETURNS

steam.friends_get_persona_name()

steam.friends_get_persona_name()

Returns the local players name - guaranteed to not be NULL. This is the same name as on the users community profile page. This is stored in UTF-8 format.

PARAMETERS

None

RETURNS

steam.friends_get_persona_state()

steam.friends_get_persona_state()

Gets the status of the current user. Returned as EPersonaState.

PARAMETERS

None

RETURNS

steam.friends_get_friend_count()

steam.friends_get_friend_count(iFriendFlags)

Friend iteration. Takes a set of EFriendFlags, and returns the number of users the client knows about who meet that criteria. Then GetFriendByIndex() can then be used to return the id's of each of those users.

PARAMETERS

RETURNS

steam.friends_get_friend_by_index()

steam.friends_get_friend_by_index(iFriend,iFriendsFlags)

Returns the steamID of a user. The returned CSteamID can then be used by all the functions below to access details about the user.

PARAMETERS

RETURNS

steam.friends_get_friend_persona_state()

steam.friends_get_friend_persona_state(steamIDFriend)

Returns the current status of the specified user. This will only be known by the local user if steamIDFriend is in their friends list; on the same game server; in a chat room or lobby; or in a small group with the local user.

PARAMETERS

RETURNS

steam.friends_get_friend_steam_level()

steam.friends_get_friend_steam_level(steamIDFriend)

Get friends steam level.

PARAMETERS

RETURNS

steam.friends_get_friend_relationship()

steam.friends_get_friend_relationship(steamIDFriend)

Returns a relationship to a user.

PARAMETERS

RETURNS

steam.friends_get_small_friend_avatar()

steam.friends_get_small_friend_avatar(steamIDFriend)

Gets a handle to the small (32*32px) avatar for the specified user. This is a handle to be used in IClientUtils::GetImageRGBA(), or 0 if none set

PARAMETERS

RETURNS

steam.friends_get_medium_friend_avatar()

steam.friends_get_medium_friend_avatar(steamIDFriend)

Gets a handle to the medium (64*64px) avatar for the specified user. This is a handle to be used in IClientUtils::GetImageRGBA(), or 0 if none set

PARAMETERS

RETURNS

steam.friends_get_large_friend_avatar()

steam.friends_get_large_friend_avatar(steamIDFriend)

Gets a handle to the large (128*128px) avatar for the specified user. This is a handle to be used in IClientUtils::GetImageRGBA(), or 0 if none set

PARAMETERS

RETURNS

steam.friends_activate_game_overlay_to_store()

steam.friends_activate_game_overlay_to_store(app_id,flag)

Activates game overlay to store page for app.

PARAMETERS

steam.friends_activate_game_overlay_to_web_page()

steam.friends_activate_game_overlay_to_web_page(url,mode)

Activates game overlay web browser directly to the specified URL. Full address with protocol type is required, e.g. http://www.steamgames.com/

PARAMETERS

steam.friends_set_rich_presence()

steam.friends_set_rich_presence(key,value)

Sets a Rich Presence key/value for the current user.

PARAMETERS

RETURNS

steam.friends_clear_rich_presence()

steam.friends_clear_rich_presence()

Clears all of the current user's Rich Presence key/values.

PARAMETERS

None

steam.friends_invite_user_to_game()

steam.friends_invite_user_to_game(steamIDFriend,connect)

Invites a friend or clan member to the current game using a special invite string. If the target accepts the invite, a GameRichPresenceJoinRequested_t callback is posted containing the connect string.

PARAMETERS

RETURNS

steam.set_listener()

steam.set_listener(listener)

Set a listener.

PARAMETERS

steam.matchmaking_add_request_lobby_list_string_filter()

steam.matchmaking_add_request_lobby_list_string_filter(key,value,cmp)

Adds a string comparison filter to the next RequestLobbyList call.

PARAMETERS

steam.matchmaking_add_request_lobby_list_numerical_filter()

steam.matchmaking_add_request_lobby_list_numerical_filter(key,value,cmp)

Adds a numerical comparison filter to the next RequestLobbyList call.

PARAMETERS

steam.matchmaking_add_request_lobby_list_near_value_filter()

steam.matchmaking_add_request_lobby_list_near_value_filter(key,value)

Sorts the results closest to the specified value.

PARAMETERS

steam.matchmaking_add_request_lobby_list_filter_slots_available()

steam.matchmaking_add_request_lobby_list_filter_slots_available(slots)

Filters to only return lobbies with the specified number of open slots. Available.

PARAMETERS

steam.matchmaking_add_request_lobby_list_distance_filter()

steam.matchmaking_add_request_lobby_list_distance_filter(dist)

Sets the physical distance for which we should search for lobbies, this is. Based on the users IP address and a IP location map on the Steam backed.

PARAMETERS

steam.matchmaking_add_request_lobby_list_result_count_filter()

steam.matchmaking_add_request_lobby_list_result_count_filter(max_count)

Sets the maximum number of lobbies to return. The lower the count the faster. It is to download the lobby results & details to the client.

PARAMETERS

steam.matchmaking_add_request_lobby_list_compatible_members_filter()

steam.matchmaking_add_request_lobby_list_compatible_members_filter(steam_id)

Unused - Checks the player compatibility based on the frenemy system.

PARAMETERS

steam.matchmaking_request_lobby_list()

steam.matchmaking_request_lobby_list()

Get a filtered list of relevant lobbies. Will return results as a LobbyMatchList_t event

PARAMETERS

None

RETURNS

steam.matchmaking_get_lobby_by_index()

steam.matchmaking_get_lobby_by_index(index)

Gets the Steam ID of the lobby at the specified index. This should only be called after a LobbyMatchList_t call result is received

PARAMETERS

RETURNS

steam.matchmaking_create_lobby()

steam.matchmaking_create_lobby(lobby_type,max_members)

Create a new matchmaking lobby. Will generate a LobbyCreated_t, LobbyEnter_t and LobbyDataUpdate_t event

PARAMETERS

RETURNS

steam.matchmaking_join_lobby()

steam.matchmaking_join_lobby(lobby_id)

Joins an existing lobby. Will generate a LobbyEnter_t event

PARAMETERS

RETURNS

steam.matchmaking_leave_lobby()

steam.matchmaking_leave_lobby(lobby_id)

Leave a lobby that the user is currently in. Leave a lobby that the user is currently in; this will take effect immediately on the client side, other users in the lobby will be notified by a LobbyChatUpdate_t callback.

PARAMETERS

steam.matchmaking_get_lobby_owner()

steam.matchmaking_get_lobby_owner(lobby_id)

Returns the current lobby owner. There always one lobby owner - if the current owner leaves, another user in the lobby will become the owner automatically. It is possible (but rare) to join a lobby just as the owner is leaving, thus entering a lobby with self as the owner. You must be a member of the lobby to access this.

PARAMETERS

RETURNS

steam.matchmaking_set_lobby_owner()

steam.matchmaking_set_lobby_owner(lobby_id,new_owner)

Changes who the lobby owner is. This can only be set by the owner of the lobby. This will trigger a LobbyDataUpdate_t for all of the users in the lobby, each user should update their local state to reflect the new owner. This is typically accomplished by displaying a crown icon next to the owners name.

PARAMETERS

steam.matchmaking_set_lobby_type()

steam.matchmaking_set_lobby_type(lobby_id,type)

Updates what type of lobby this is. This is also set when you create the lobby with CreateLobby. This can only be set by the owner of the lobby.

PARAMETERS

steam.matchmaking_set_lobby_joinable()

steam.matchmaking_set_lobby_joinable(lobby_id,joinable)

Sets whether or not a lobby is joinable by other players. This always defaults to enabled for a new lobby. If joining is disabled, then no players can join, even if they are a friend or have been invited. Lobbies with joining disabled will not be returned from a lobby search.

PARAMETERS

RETURNS

steam.matchmaking_set_lobby_member_limit()

steam.matchmaking_set_lobby_member_limit(lobby_id,max_members)

Set the maximum number of players that can join the lobby. This is also set when you create the lobby with CreateLobby. This can only be set by the owner of the lobby.

PARAMETERS

RETURNS

steam.matchmaking_get_lobby_member_limit()

steam.matchmaking_get_lobby_member_limit(lobby_id)

The current limit on the

PARAMETERS

RETURNS

steam.matchmaking_get_num_lobby_members()

steam.matchmaking_get_num_lobby_members(lobby_id)

Gets the number of users in a lobby. This is used for iteration, after calling this then GetLobbyMemberByIndex can be used to get the Steam ID of each person in the lobby. Persona information for other lobby members (name, avatar, etc.) is automatically received and accessible via the ISteamFriends interface. The current user must be in the lobby to retrieve the Steam IDs of other users in that lobby.

PARAMETERS

RETURNS

steam.matchmaking_get_lobby_member_by_index()

steam.matchmaking_get_lobby_member_by_index(lobby_id,index)

Gets the Steam ID of the lobby member at the given index. You must call matchmaking_get_num_lobby_members before calling this. The current user must be in the lobby to retrieve the Steam IDs of other users in that lobby.

PARAMETERS

RETURNS

steam.matchmaking_set_lobby_data()

steam.matchmaking_set_lobby_data(lobby_id,key,data)

Sets a key/value pair in the lobby metadata.

PARAMETERS

RETURNS

steam.matchmaking_set_lobby_member_data()

steam.matchmaking_set_lobby_member_data(lobby_id,key,data)

Sets per-user metadata for the local user.

PARAMETERS

steam.matchmaking_get_lobby_data()

steam.matchmaking_get_lobby_data(lobby_id,key)

Get data associated with this lobby.

PARAMETERS

RETURNS

steam.matchmaking_get_lobby_member_data()

steam.matchmaking_get_lobby_member_data(lobby_id,user_id,key)

Gets per-user metadata from another player in the specified lobby.

PARAMETERS

RETURNS

steam.matchmaking_get_lobby_data_count()

steam.matchmaking_get_lobby_data_count(lobby_id)

Returns the number of metadata keys set on the specified lobby.

PARAMETERS

RETURNS

steam.matchmaking_get_lobby_data_by_index()

steam.matchmaking_get_lobby_data_by_index(lobby_id,index)

Returns a lobby metadata key/values pair by index.

PARAMETERS

RETURNS

steam.matchmaking_send_lobby_chat_message()

steam.matchmaking_send_lobby_chat_message(lobby_id,body)

Broadcasts a chat message to the all the users in the lobby.

PARAMETERS

RETURNS

steam.matchmaking_get_lobby_chat_entry()

steam.matchmaking_get_lobby_chat_entry(lobby_id,index)

Get a chat message as specified in a LobbyChatMsg_t callback.

PARAMETERS

RETURNS

steam.networking_send_message_to_user()

steam.networking_send_message_to_user(identity_remote,data,send_flags,remote_channel)

Send message.

PARAMETERS

steam.networking_receive_messages_on_channel()

steam.networking_receive_messages_on_channel(localChannel)

Receive message.

PARAMETERS

RETURNS

steam.networking_accept_session_with_user()

steam.networking_accept_session_with_user(identity_remote)

Accept session. Call this in response to a SteamNetworkingMessagesSessionRequest_t callback.

PARAMETERS

RETURNS

steam.networking_close_session_with_user()

steam.networking_close_session_with_user(identity_remote)

Close sesssion. Call this when you're done talking to a user to immediately free up resources under-the-hood

PARAMETERS

RETURNS

steam.networking_close_channel_with_user()

steam.networking_close_channel_with_user(identity_remote,local_channel)

Close channel. Call this when you're done talking to a user on a specific channel.

PARAMETERS

RETURNS

steam.networking_get_session_connection_info()

steam.networking_get_session_connection_info(identity_remote)

Get connection info. Returns information about the latest state of a connection, if any, with the given peer.

PARAMETERS

RETURNS

steam.remote_storage_file_share()

steam.remote_storage_file_share(filename)

Share a file.

PARAMETERS

RETURNS

steam.remote_storage_get_file_count()

steam.remote_storage_get_file_count()

Get number of uploaded files.

PARAMETERS

None

RETURNS

steam.remote_storage_get_file_name_and_size()

steam.remote_storage_get_file_name_and_size()

Get file information.

PARAMETERS

None

RETURNS

steam.remote_storage_get_quota()

steam.remote_storage_get_quota()

Get storage quota.

PARAMETERS

None

RETURNS

steam.remote_storage_file_write()

steam.remote_storage_file_write(filename,data)

Creates a new file, writes the bytes to the file, and then closes the file. If the target file already exists, it is overwritten.

PARAMETERS

RETURNS

steam.remote_storage_file_read()

steam.remote_storage_file_read(filename)

Opens a binary file, reads the contents of the file into a byte array,. And then closes the file.

PARAMETERS

RETURNS

steam.user_get_steam_id()

steam.user_get_steam_id()

Returns the CSteamID of the account currently logged into the Steam client. A CSteamID is a unique identifier for an account, and used to differentiate users in all parts of the Steamworks API.

PARAMETERS

None

RETURNS

steam.user_get_player_steam_level()

steam.user_get_player_steam_level()

Gets the Steam Level of the user, as shown on their profile.

PARAMETERS

None

RETURNS

steam.user_get_game_badge_level()

steam.user_get_game_badge_level()

Trading Card badges data access. If you only have one set of cards, the series will be 1. The user has can have two different badges for a series; the regular (max level 5) and the foil (max level 1).

PARAMETERS

None

RETURNS

steam.user_logged_on()

steam.user_logged_on()

Returns true if the Steam client current has a live connection to the Steam. Servers.

PARAMETERS

None

RETURNS

steam.user_is_behind_nat()

steam.user_is_behind_nat()

Returns true if this users looks like they are behind a NAT device. Only valid once the user has connected to steam .

PARAMETERS

None

RETURNS

steam.user_is_phone_verified()

steam.user_is_phone_verified()

Gets whether the users phone number is verified.

PARAMETERS

None

RETURNS

steam.user_is_phone_identifying()

steam.user_is_phone_identifying()

Gets whether the users phone number is identifying.

PARAMETERS

None

RETURNS

steam.user_is_phone_requiring_verification()

steam.user_is_phone_requiring_verification()

Gets whether the users phone number is awaiting (re)verification.

PARAMETERS

None

RETURNS

steam.user_is_two_factor_enabled()

steam.user_is_two_factor_enabled()

Gets whether the user has two factor enabled on their account.

PARAMETERS

None

RETURNS

steam.user_get_auth_session_ticket()

steam.user_get_auth_session_ticket()

Get an authentication ticket. Retrieve an authentication ticket to be sent to the entity who wishes to authenticate you.

PARAMETERS

None

RETURNS

steam.user_begin_auth_session()

steam.user_begin_auth_session(ticket,steamId)

Validate an authentication ticket. Authenticate the ticket from the entity Steam ID to be sure it is valid and isn't reused. Note that identity is not confirmed until the callback ValidateAuthTicketResponse_t is received and the return value in that callback is checked for success.

PARAMETERS

RETURNS

steam.user_cancel_auth_ticket()

steam.user_cancel_auth_ticket(ticket)

Cancels an auth ticket. Cancels an auth ticket received from GetAuthSessionTicket or GetAuthTicketForWebApi. This should be called when no longer playing with the specified entity.

PARAMETERS

steam.user_end_auth_session()

steam.user_end_auth_session(steamId)

Ends an auth session. Ends an auth session that was started with BeginAuthSession. This should be called when no longer playing with the specified entity.

PARAMETERS

steam.user_get_auth_ticket_for_web_api()

steam.user_get_auth_ticket_for_web_api(identity)

Get an authentication ticket for web API. Request an authentication ticket suitable to authenticated in a web backend. Will trigger a GetTicketForWebApiResponse_t callback when the ticket is ready.

PARAMETERS

RETURNS

steam.user_stats_get_stat_int()

steam.user_stats_get_stat_int(id)

Get user stat as an integer. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetStat

PARAMETERS

RETURNS

steam.user_stats_set_stat_int()

steam.user_stats_set_stat_int(id,stat)

Set user stat. Https://partner.steamgames.com/doc/api/ISteamUserStats#SetStat

PARAMETERS

RETURNS

steam.user_stats_get_stat_float()

steam.user_stats_get_stat_float(id)

Get user stat as a floating point number. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetStat

PARAMETERS

RETURNS

steam.user_stats_set_stat_float()

steam.user_stats_set_stat_float(id,stat)

Set user stat. Https://partner.steamgames.com/doc/api/ISteamUserStats#SetStat

PARAMETERS

RETURNS

steam.user_stats_request_global_stats()

steam.user_stats_request_global_stats(history_days)

Requests global stats data, which is available for stats marked as "aggregated". This call is asynchronous, with the results returned in GlobalStatsReceived_t. nHistoryDays specifies how many days of day-by-day history to retrieve in addition to the overall totals. The limit is 60. https://partner.steamgames.com/doc/api/ISteamUserStats#RequestGlobalStats

PARAMETERS

RETURNS

steam.user_stats_store_stats()

steam.user_stats_store_stats()

Store the current data on the server. Will get a callback when set and one callback for every new achievement If the callback has a result of k_EResultInvalidParam, one or more stats uploaded has been rejected, either because they broke constraints or were out of date. In this case the server sends back updated values. The stats should be re-iterated to keep in sync. https://partner.steamgames.com/doc/api/ISteamUserStats#StoreStats

PARAMETERS

None

RETURNS

steam.user_stats_reset_all_stats()

steam.user_stats_reset_all_stats(achievements)

Reset stats. Https://partner.steamgames.com/doc/api/ISteamUserStats#ResetAllStats

PARAMETERS

RETURNS

steam.user_stats_set_achievement()

steam.user_stats_set_achievement(name)

Set achievement. Https://partner.steamgames.com/doc/api/ISteamUserStats#SetAchievement

PARAMETERS

RETURNS

steam.user_stats_get_achievement()

steam.user_stats_get_achievement(name)

Get achievement. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetAchievement

PARAMETERS

RETURNS

steam.user_stats_clear_achievement()

steam.user_stats_clear_achievement(name)

Clear achievement. Https://partner.steamgames.com/doc/api/ISteamUserStats#ClearAchievement

PARAMETERS

RETURNS

steam.user_stats_get_num_achievements()

steam.user_stats_get_num_achievements()

Used for iterating achievements. In general games should not need these functions because they should have a list of existing achievements compiled into them. https://partner.steamgames.com/doc/api/ISteamUserStats#GetNumAchievements

PARAMETERS

None

RETURNS

steam.user_stats_get_achievement_name()

steam.user_stats_get_achievement_name(index)

Get achievement name iAchievement in [0,GetNumAchievements). Https://partner.steamgames.com/doc/api/ISteamUserStats#GetAchievementName

PARAMETERS

RETURNS

steam.user_stats_get_achievement_display_attribute()

steam.user_stats_get_achievement_display_attribute(name,key)

Get general attributes for an achievement. Accepts the following keys * "name" and "desc" for retrieving the localized achievement name and description (returned in UTF8) * "hidden" for retrieving if an achievement is hidden (returns "0" when not hidden, "1" when hidden) https://partner.steamgames.com/doc/api/ISteamUserStats#GetAchievementDisplayAttribute

PARAMETERS

RETURNS

steam.user_stats_get_achievement_achieved_percent()

steam.user_stats_get_achievement_achieved_percent()

Returns the percentage of users who have achieved the specified achievement. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetAchievementAchievedPercent

PARAMETERS

None

RETURNS

steam.user_stats_find_leaderboard()

steam.user_stats_find_leaderboard(name)

Find a leaderboard. Will return leaderboard asynchronously. https://partner.steamgames.com/doc/api/ISteamUserStats#FindLeaderboard

PARAMETERS

steam.user_stats_find_or_create_leaderboard()

steam.user_stats_find_or_create_leaderboard(leaderboard_name,eLeaderboardSortMethod,eLeaderboardDisplayType)

Gets a leaderboard by name, it will create it if it's not yet created. This call is asynchronous, with the result returned in a listener callback with event set to LeaderboardFindResult_t. https://partner.steamgames.com/doc/api/ISteamUserStats#FindOrCreateLeaderboard

PARAMETERS

steam.user_stats_get_leaderboard_name()

steam.user_stats_get_leaderboard_name(leaderboard)

Get the name of a leaderboard. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetLeaderboardName

PARAMETERS

RETURNS

steam.user_stats_get_leaderboard_entry_count()

steam.user_stats_get_leaderboard_entry_count(leaderboard)

Get the total number of entries in a leaderboard, as of the last request. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetLeaderboardEntryCount

PARAMETERS

RETURNS

steam.user_stats_get_leaderboard_sort_method()

steam.user_stats_get_leaderboard_sort_method(leaderboard)

Returns the sort method of the leaderboard. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetLeaderboardSortMethod

PARAMETERS

RETURNS

steam.user_stats_get_leaderboard_display_type()

steam.user_stats_get_leaderboard_display_type(leaderboard)

Returns the display type of a leaderboard handle. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetLeaderboardDisplayType

PARAMETERS

RETURNS

steam.user_stats_download_leaderboard_entries()

steam.user_stats_download_leaderboard_entries(leaderboard,request,start,end)

Asks the Steam back-end for a set of rows in the leaderboard. This call is asynchronous, with the result returned in a listener callback with event set to LeaderboardScoresDownloaded_t. LeaderboardScoresDownloaded_t will contain a handle to pull the results from GetDownloadedLeaderboardEntries(). You can ask for more entries than exist, and it will return as many as do exist. * k_ELeaderboardDataRequestGlobal requests rows in the leaderboard from the full table, with nRangeStart & nRangeEnd in the range [1, TotalEntries] * k_ELeaderboardDataRequestGlobalAroundUser requests rows around the current user, nRangeStart being negate e.g. DownloadLeaderboardEntries( hLeaderboard, k_ELeaderboardDataRequestGlobalAroundUser, -3, 3 ) will return 7 rows, 3 before the user, 3 after * k_ELeaderboardDataRequestFriends requests all the rows for friends of the current user https://partner.steamgames.com/doc/api/ISteamUserStats#DownloadLeaderboardEntries

PARAMETERS

steam.user_stats_get_downloaded_leaderboard_entry()

steam.user_stats_get_downloaded_leaderboard_entry(hSteamLeaderboardEntries,index)

Returns data about a single leaderboard entry. Https://partner.steamgames.com/doc/api/ISteamUserStats#GetDownloadedLeaderboardEntry

PARAMETERS

RETURNS

steam.user_stats_upload_leaderboard_score()

steam.user_stats_upload_leaderboard_score(leaderboard,eLeaderboardUploadScoreMethod,nScore)

Uploads a user score to a specified leaderboard. This call is asynchronous, with the result returned in a listener callback with event set to LeaderboardScoreUploaded_t. https://partner.steamgames.com/doc/api/ISteamUserStats#UploadLeaderboardScore

PARAMETERS

steam.user_stats_attach_leadboard_ugc()

steam.user_stats_attach_leadboard_ugc(leaderboard,ugc_handle)

Attaches a piece of user generated content the current user's entry on a. Leaderboard. https://partner.steamgames.com/doc/api/ISteamUserStats#AttachLeaderboardUGC

PARAMETERS

RETURNS

steam.utils_get_app_id()

steam.utils_get_app_id()

Returns the appID of the current process.

PARAMETERS

None

RETURNS

steam.utils_get_seconds_since_app_active()

steam.utils_get_seconds_since_app_active()

Return the number of seconds since the user.

PARAMETERS

None

RETURNS

steam.utils_is_steam_running_on_steam_deck()

steam.utils_is_steam_running_on_steam_deck()

Returns true if currently running on the Steam Deck device.

PARAMETERS

None

RETURNS

steam.utils_is_steam_overlay_available()

steam.utils_is_steam_overlay_available()

Returns true if the Steam Overlay is running and the user can access it.

PARAMETERS

None

RETURNS

steam.utils_get_image_size()

steam.utils_get_image_size(image)

Get size of image.

PARAMETERS

RETURNS

steam.utils_get_image_rgba()

steam.utils_get_image_rgba(image,size)

Get image in RGBA format.

PARAMETERS

RETURNS

steam.utils_get_server_real_time()

steam.utils_get_server_real_time()

Returns the Steam server time in Unix epoch format. (Number of seconds since Jan 1, 1970 UTC).

PARAMETERS

None

RETURNS

steam.utils_show_floating_gamepad_text_input()

steam.utils_show_floating_gamepad_text_input(mode,x,y,width,height)

Opens a floating keyboard over the game content and sends OS keyboard keys directly to the game.

PARAMETERS

RETURNS

steam.utils_show_gamepad_text_input()

steam.utils_show_gamepad_text_input(input_mode,line_input_mode,description,existing_text)

Activates the Big Picture text input dialog which only supports gamepad input.

PARAMETERS

RETURNS

EFloatingGamepadTextInputModeModeSingleLine

Enter dismisses the keyboard

EFloatingGamepadTextInputModeModeMultipleLines

User needs to explicitly dismiss the keyboard

EFloatingGamepadTextInputModeModeEmail

Keyboard is displayed in a special mode that makes it easier to enter emails

EFloatingGamepadTextInputModeModeNumeric

Numeric keypad is shown

EGamepadTextInputModeNormal

Normal text input

EGamepadTextInputModePassword

Password text input

EGamepadTextInputLineModeSingleLine

Single line text

EGamepadTextInputLineModeMultipleLines

Multi line text

ELeaderboardDataRequestGlobal

Requests rows in the leaderboard from the full table.

ELeaderboardDataRequestGlobalAroundUser

Requests rows in the leaderboard from rows around the user.

ELeaderboardDataRequestFriends

Requests all the rows for friends of the current user.

ELeaderboardSortMethodNone

ELeaderboardSortMethodAscending

Top-score is lowest number.

ELeaderboardSortMethodDescending

Top-score is highest number.

ELeaderboardUploadScoreMethodNone

ELeaderboardUploadScoreMethodKeepBest

Leaderboard will keep user's best score.

ELeaderboardUploadScoreMethodForceUpdate

Leaderboard will always replace score with specified.

ELeaderboardDisplayTypeNone

ELeaderboardDisplayTypeNumeric

Simple numerical score.

ELeaderboardDisplayTypeTimeSeconds

The score represents a time, in seconds.

ELeaderboardDisplayTypeTimeMilliSeconds

The score represents a time, in milliseconds.

EOverlayToStoreFlag_None

Passed as parameter to the store.

EOverlayToStoreFlag_AddToCart

Passed as parameter to the store.

EOverlayToStoreFlag_AddToCartAndShow

Passed as parameter to the store.

EActivateGameOverlayToWebPageMode_Default

Passed as parameter to ActivateGameOverlayToWebPage.

EActivateGameOverlayToWebPageMode_Modal

Passed as parameter to ActivateGameOverlayToWebPage.

EPersonaStateOffline

Friend is not currently logged on.

EPersonaStateOnline

Friend is logged on.

EPersonaStateBusy

User is on, but busy.

EPersonaStateAway

Auto-away feature.

EPersonaStateSnooze

Auto-away for a long time.

EPersonaStateLookingToTrade

Online, trading.

EPersonaStateLookingToPlay

Online, wanting to play.

EPersonaStateInvisible

Online, but appears offline to friends. This status is never published to clients.

EFriendFlagNone

EFriendFlagNone

EFriendFlagBlocked

EFriendFlagBlocked

EFriendFlagFriendshipRequested

EFriendFlagFriendshipRequested

EFriendFlagImmediate

EFriendFlagImmediate

EFriendFlagClanMember

EFriendFlagClanMember

EFriendFlagOnGameServer

EFriendFlagOnGameServer

EFriendFlagRequestingFriendship

EFriendFlagRequestingFriendship

EFriendFlagRequestingInfo

EFriendFlagRequestingInfo

EFriendFlagIgnored

EFriendFlagIgnored

EFriendFlagIgnoredFriend

EFriendFlagIgnoredFriend

EFriendFlagChatMember

EFriendFlagChatMember

EFriendFlagAll

EFriendFlagAll

SteamNetworkingSend_Unreliable

SteamNetworkingSend_Unreliable

SteamNetworkingSend_NoNagle

SteamNetworkingSend_NoNagle

SteamNetworkingSend_UnreliableNoNagle

SteamNetworkingSend_UnreliableNoNagle

SteamNetworkingSend_NoDelay

SteamNetworkingSend_NoDelay

SteamNetworkingSend_UnreliableNoDelay

SteamNetworkingSend_UnreliableNoDelay

SteamNetworkingSend_Reliable

SteamNetworkingSend_Reliable

SteamNetworkingSend_ReliableNoNagle

SteamNetworkingSend_ReliableNoNagle

SteamNetworkingSend_UseCurrentThread

SteamNetworkingSend_UseCurrentThread

SteamNetworkingSend_AutoRestartBrokenSession

SteamNetworkingSend_AutoRestartBrokenSession

ESteamNetConnectionEnd_Invalid

ESteamNetConnectionEnd_Invalid

ESteamNetConnectionEnd_App_Generic

ESteamNetConnectionEnd_App_Generic

ESteamNetConnectionEnd_AppException_Generic

ESteamNetConnectionEnd_AppException_Generic

ESteamNetConnectionEnd_Local_OfflineMode

ESteamNetConnectionEnd_Local_OfflineMode

ESteamNetConnectionEnd_Local_ManyRelayConnectivity

ESteamNetConnectionEnd_Local_ManyRelayConnectivity

ESteamNetConnectionEnd_Local_HostedServerPrimaryRelay

ESteamNetConnectionEnd_Local_HostedServerPrimaryRelay

ESteamNetConnectionEnd_Local_NetworkConfig

ESteamNetConnectionEnd_Local_NetworkConfig

ESteamNetConnectionEnd_Local_Rights

ESteamNetConnectionEnd_Local_Rights

ESteamNetConnectionEnd_Local_P2P_ICE_NoPublicAddresses

ESteamNetConnectionEnd_Local_P2P_ICE_NoPublicAddresses

ESteamNetConnectionEnd_Remote_Timeout

ESteamNetConnectionEnd_Remote_Timeout

ESteamNetConnectionEnd_Remote_BadCrypt

ESteamNetConnectionEnd_Remote_BadCrypt

ESteamNetConnectionEnd_Remote_BadCert

ESteamNetConnectionEnd_Remote_BadCert

ESteamNetConnectionEnd_Remote_BadProtocolVersion

ESteamNetConnectionEnd_Remote_BadProtocolVersion

ESteamNetConnectionEnd_Remote_P2P_ICE_NoPublicAddresses

ESteamNetConnectionEnd_Remote_P2P_ICE_NoPublicAddresses

ESteamNetConnectionEnd_Misc_Generic

ESteamNetConnectionEnd_Misc_Generic

ESteamNetConnectionEnd_Misc_InternalError

ESteamNetConnectionEnd_Misc_InternalError

ESteamNetConnectionEnd_Misc_Timeout

ESteamNetConnectionEnd_Misc_Timeout

ESteamNetConnectionEnd_Misc_SteamConnectivity

ESteamNetConnectionEnd_Misc_SteamConnectivity

ESteamNetConnectionEnd_Misc_NoRelaySessionsToClient

ESteamNetConnectionEnd_Misc_NoRelaySessionsToClient

ESteamNetConnectionEnd_Misc_P2P_Rendezvous

ESteamNetConnectionEnd_Misc_P2P_Rendezvous

ESteamNetConnectionEnd_Misc_P2P_NAT_Firewall

ESteamNetConnectionEnd_Misc_P2P_NAT_Firewall

ESteamNetConnectionEnd_Misc_PeerSentNoConnection

ESteamNetConnectionEnd_Misc_PeerSentNoConnection

ESteamNetworkingConnectionState_None

ESteamNetworkingConnectionState_None

ESteamNetworkingConnectionState_Connecting

ESteamNetworkingConnectionState_Connecting

ESteamNetworkingConnectionState_FindingRoute

ESteamNetworkingConnectionState_FindingRoute

ESteamNetworkingConnectionState_Connected

ESteamNetworkingConnectionState_Connected

ESteamNetworkingConnectionState_ClosedByPeer

ESteamNetworkingConnectionState_ClosedByPeer

ESteamNetworkingConnectionState_ProblemDetectedLocally

ESteamNetworkingConnectionState_ProblemDetectedLocally

ELobbyTypePrivate

ELobbyTypePrivate only way to join the lobby is to invite to someone else

ELobbyTypeFriendsOnly

ELobbyTypeFriendsOnly shows for friends or invitees, but not in lobby list

ELobbyTypePublic

ELobbyTypePublic visible for friends and in lobby list

ELobbyTypeInvisible

ELobbyTypeInvisible returned by search, but not visible to other friends

ELobbyTypePrivateUnique

ELobbyTypePrivateUnique private, unique and does not delete when empty

EAuthSessionResponseOK

EAuthSessionResponseOK Steam has verified the user is online, the ticket is valid and ticket has not been reused.

EAuthSessionResponseUserNotConnectedToSteam

EAuthSessionResponseUserNotConnectedToSteam The user in question is not connected to steam.

EAuthSessionResponseNoLicenseOrExpired

EAuthSessionResponseNoLicenseOrExpired The user doesn't have a license for this App ID or the ticket has expired.

EAuthSessionResponseVACBanned

EAuthSessionResponseVACBanned The user is VAC banned for this game.

EAuthSessionResponseLoggedInElseWhere

EAuthSessionResponseLoggedInElseWhere The user account has logged in elsewhere and the session containing the game instance has been disconnected.

EAuthSessionResponseVACCheckTimedOut

EAuthSessionResponseVACCheckTimedOut VAC has been unable to perform anti-cheat checks on this user.

EAuthSessionResponseAuthTicketCanceled

EAuthSessionResponseAuthTicketCanceled The ticket has been canceled by the issuer.

EAuthSessionResponseAuthTicketInvalidAlreadyUsed

EAuthSessionResponseAuthTicketInvalidAlreadyUsed This ticket has already been used, it is not valid.

EAuthSessionResponseAuthTicketInvalid

EAuthSessionResponseAuthTicketInvalid This ticket is not from a user instance currently connected to steam.

EAuthSessionResponsePublisherIssuedBan

EAuthSessionResponsePublisherIssuedBan The user is banned for this game. The ban came via the web api and not VAC.

EAuthSessionResponseAuthTicketNetworkIdentityFailure

EAuthSessionResponseAuthTicketNetworkIdentityFailure The network identity in the ticket does not match the server authenticating the ticket.