Utils

Only available in the main GodotSteam branches

Functions

dismissFloatingGamepadTextInput

dismissFloatingGamepadTextInput( )

Dismisses the floating keyboard.

Returns: bool

dismissGamepadTextInput

dismissGamepadTextInput( )

Dismisses the full-screen text input dialog.

Returns: bool

filterText

filterText( int context, uint64_t steam_id, string message )

Filters the provided input message and returns the filtered result. Legally required filtering is always applied. Additional filtering may occur, based on the context and user settings.

Returns: string

getAPICallFailureReason

getAPICallFailureReason()

Used to get the failure reason of a call result.

The primary usage for this function is debugging. The failure reasons are typically out of your control and tend to not be very important. Just keep retrying your API Call until it works.

Returns: string

getAppID

getAppID()

Gets the App ID of the current process.

Returns: uint32_t

getCurrentBatteryPower

getCurrentBatteryPower()

Gets the current amount of battery power on the computer.

Returns: int

getImageRGBA

getImageRGBA( int image )

Gets the image bytes from an image handle.

Prior to calling this you must get the size of the image by calling getImageSize so that you can create your buffer with an appropriate size. You can then allocate your buffer with the width and height as: width * height * 4. The image is provided in RGBA format. This call can be somewhat expensive as it converts from the compressed type (JPG, PNG, TGA) and provides no internal caching of returned buffer, thus it is highly recommended to only call this once per image handle and cache the result. This function is only used for Steam Avatars and Achievement images and those are not expected to change mid game.

Returns: dictionary

Contains the following keys:

buffer (PoolByteArray / PackedByteArray)
success (bool)

getImageSize

getImageSize( int image )

Gets the size of a Steam image handle.

This must be called before calling getImageRGBA to create an appropriately sized buffer that will be filled with the raw image data.

Returns: dictionary

Contains the following keys:

width (uint32)
height (uint32)

getIPCCallCount

getIPCCallCount()

Returns the number of IPC calls made since the last time this function was called.

Used for perf debugging so you can determine how many IPC (Inter-Process Communication) calls your game makes per frame.

Every IPC call is at minimum a thread context switch if not a process one so you want to rate control how often you do them.

Returns: uint32

getIPCountry

getIPCountry()

Returns the 2 digit ISO 3166-1-alpha-2 format country code which client is running in. e.g "US" or "UK".

This is looked up via an IP-to-location database.

Returns: string

getSecondsSinceAppActive

getSecondsSinceAppActive()

Returns the number of seconds since the application was active.

Returns: int

getSecondsSinceComputerActive

getSecondsSinceComputerActive()

Returns the number of seconds since the user last moved the mouse.

Returns: int

getServerRealTime

getServerRealTime()

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

Returns: int

getSteamUILanguage

getSteamUILanguage()

Returns the language the steam client is running in.

You probably want getCurrentGameLanguage instead, this should only be used in very special cases.

For a full list of languages see Supported Languages.

Returns: string

initFilterText

initFilterText()

Initializes text filtering, loading dictionaries for the language the game is running in.

Users can customize the text filter behavior in their Steam Account preferences.

Returns: bool

isAPICallCompleted

isAPICallCompleted()

Checks if an API Call is completed. Provides the backend of the CallResult wrapper.

It's generally not recommended that you use this yourself.

Returns: dictionary

Contains the following keys:

completed (bool)
failed (bool)

isOverlayEnabled

isOverlayEnabled()

Checks if the Steam Overlay is running & the user can access it.

The overlay process could take a few seconds to start & hook the game process, so this function will initially return false while the overlay is loading.

Returns: bool

isSteamChinaLauncher

isSteamChinaLauncher()

Returns whether the current launcher is a Steam China launcher. You can cause the client to behave as the Steam China launcher by adding -dev -steamchina to the command line when running Steam.

Returns: bool

isSteamInBigPictureMode

isSteamInBigPictureMode()

Checks if Steam & the Steam Overlay are running in Big Picture mode.

Games must be launched through the Steam client to enable the Big Picture overlay. During development, a game can be added as a non-steam game to the developers library to test this feature.

Returns: bool

isSteamRunningInVR

isSteamRunningInVR()

Checks if Steam is running in VR mode.

Returns: bool

isSteamRunningOnSteamDeck

isSteamRunningOnSteamDeck()

Checks if Steam is running on a Steam Deck device.

Returns: bool

isVRHeadsetStreamingEnabled

isVRHeadsetStreamingEnabled()

Checks if the HMD view will be streamed via Steam In-Home Streaming.

Returns: bool

overlayNeedsPresent

overlayNeedsPresent()

Checks if the Overlay needs a present. Only required if using event driven render updates.

Typically this call is unneeded if your game has a constantly running frame loop that calls the D3D Present API, or OGL SwapBuffers API every frame as is the case in most games. However, if you have a game that only refreshes the screen on an event driven basis then that can break the overlay, as it uses your Present/SwapBuffers calls to drive it's internal frame loop and it may also need to Present() to the screen any time a notification happens or when the overlay is brought up over the game by a user. You can use this API to ask the overlay if it currently need a present in that case, and then you can check for this periodically (roughly 33hz is desirable) and make sure you refresh the screen with Present or SwapBuffers to allow the overlay to do it's work.

Returns: bool

setGameLauncherMode

setGameLauncherMode( bool mode)

In game launchers that don't have controller support you can call this to have Steam Input translate the controller input into mouse/kb to navigate the launcher.

Returns: void

setOverlayNotificationInset

setOverlayNotificationInset( int horizontal, int vertical )

Sets the inset of the overlay notification from the corner specified by setOverlayNotificationPosition. Integer should be number of pixels.

Returns: void

setOverlayNotificationPosition

setOverlayNotificationPosition( int pos )

Set the position where overlay shows notifications. Accepts the following integer inputs:

0 - Top Left
1 - Top Right
2 - Bottom Left
3 - Bottom Right

Returns: void

setVRHeadsetStreamingEnabled

setVRHeadsetStreamingEnabled()

Set whether the HMD content will be streamed via Steam In-Home Streaming.

Returns: void

showGamepadTextInput

showGamepadTextInput( int input_mode, int line_input_mode, string description, uint32 max_text, string preset_text )

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

Returns: bool

showFloatingGamepadTextInput

showFloatingGamepadTextInput( int input_mode, int text_field_x_position, int text_field_y_position, int text_field_width, int text_field_height )

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

The text field position is specified in pixels relative the origin of the game window and is used to position the floating keyboard in a way that doesn't cover the text field.

Returns: bool

startVRDashboard

startVRDashboard()

Ask SteamUI to create and render its OpenVR dashboard.

Returns: void

Signals

These callbacks require you to run Steam.run_callbacks() in your _process() function to receive them.

app_resuming_from_suspend

Sent after the device returns from sleep/suspend mode.

Returns: nothing

check_file_signature

Call result for checkFileSignature.

Returns:

signature (string)

filter_text_dictionary_changed

Sent when the text filtering dictionary has changed languages.

Returns:

language (int)

floating_gamepad_text_input_dismissed

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

Returns: nothing

gamepad_text_input_dismissed

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

Returns:

submitted (bool)
text (string)
app_id (uint32_t)

ip_country

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

Returns: nothing

low_power

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

Returns: * power (uint8)

steam_api_call_completed

Called when a SteamAPICall_t has completed or failed.

Returns:

async_call (uint64_t)
callback (int)
parameter (uint32)

steam_shutdown

Called when Steam wants to shut down.

Returns: nothing

Enums

CheckFileSignature

Enumerator	Value
CHECK_FILE_SIGNATURE_INVALID_SIGNATURE	0
CHECK_FILE_SIGNATURE_VALID_SIGNATURE	1
CHECK_FILE_SIGNATURE_FILE_NOT_FOUND	2
CHECK_FILE_SIGNATURE_NO_SIGNATURES_FOUND_FOR_THIS_APP	3
CHECK_FILE_SIGNATURE_NO_SIGNATURES_FOUND_FOR_THIS_FILE	4

GamepadTextInputLineMode

Enumerator	Value
GAMEPAD_TEXT_INPUT_LINE_MODE_SINGLE_LINE	0
GAMEPAD_TEXT_INPUT_LINE_MODE_MULTIPLE_LINES	1

GamepadTextInputMode

Enumerator	Value
GAMEPAD_TEXT_INPUT_MODE_NORMAL	0
GAMEPAD_TEXT_INPUT_MODE_PASSWORD	1

FloatingGamepadTextInputMode

Enumerator	Value
FLOATING_GAMEPAD_TEXT_INPUT_MODE_SINGLE_LINE	0
FLOATING_GAMEPAD_TEXT_INPUT_MODE_MULTIPLE_LINES	1
FLOATING_GAMEPAD_TEXT_INPUT_MODE_EMAIL	2
FLOATING_GAMEPAD_TEXT_INPUT_MODE_NUMERIC	3

SteamAPICallFailure

Enumerator	Value
STEAM_API_CALL_FAILURE_NONE	-1
STEAM_API_CALL_FAILURE_STEAM_GONE	0
STEAM_API_CALL_FAILURE_NETWORK_FAILURE	1
STEAM_API_CALL_FAILURE_INVALID_HANDLE	2
STEAM_API_CALL_FAILURE_MISMATCHED_CALLBACK	3

TextFilteringContext

Enumerator	Value
TEXT_FILTERING_CONTEXT_UNKNOWN	0
TEXT_FILTERING_CONTEXT_GAME_CONTENT	1
TEXT_FILTERING_CONTEXT_CHAT	2
TEXT_FILTERING_CONTEXT_NAME	3