ISteamUtils - adambiser/agk-steam-plugin GitHub Wiki

OverlayNeedsPresent

OverlayNeedsPresent() as integer

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 Sync() or Swap() every frame.

Returns: 1 if the overlay needs you to refresh the screen, otherwise 0.

Reference:
ISteamUtils#BOverlayNeedsPresent

GetAppID

GetAppID() as integer

This method is just for testing purposes since the app should already know its AppID.

Returns the AppID or 0 if the Steam API has not been not initialized or the AppID cannot be found.

Returns: The AppID or 0.

Reference:
ISteamUtils#GetAppID

GetCurrentBatteryPower

GetCurrentBatteryPower() as integer

Gets the current amount of battery power on the computer.

Returns: The current batter power as a percentage, from 0 to 100, or 255 when on AC power.

Reference:
ISteamUtils#GetCurrentBatteryPower

LoadImageFromHandle

LoadImageFromHandle(hImage as integer) as integer

hImage - The handle to the image that will be obtained.

Loads an image from an image handle into a new image ID.

Returns: An image ID containing the loaded image.

Reference:
SteamUtils#GetImageSize
SteamUtils#GetImageRGBA

LoadImageFromHandle

LoadImageFromHandle(imageID as integer, hImage as integer)

imageID - The image ID into which to load the image.

hImage - The handle to the image that will be obtained.

Loads an image from an image handle into a new image ID.

Reference:
SteamUtils#GetImageSize
SteamUtils#GetImageRGBA

GetIPCCallCount

GetIPCCallCount() as integer

Returns the number of Inter-Process Communication calls made since the last time this method 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: An integer.

Reference:
ISteamUtils#GetIPCCallCount

GetIPCountry

GetIPCountry() as string

Returns the 2 character ISO 3166-1-alpha-2 format country code which client is running in.

Returns: A two character string.

Reference:
ISteamUtils#GetIPCountry

GetSecondsSinceAppActive

GetSecondsSinceAppActive() as integer

Returns the number of seconds since the application was active.

Returns: An integer.

Reference:
ISteamUtils#GetSecondsSinceAppActive

GetSecondsSinceComputerActive

GetSecondsSinceComputerActive() as integer

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

Returns: An integer

Reference:
ISteamUtils#GetSecondsSinceComputerActive

GetServerRealTime

GetServerRealTime() as integer

Returns the Steam server time in Unix epoch format.

Returns: An integer.

Reference:
ISteamUtils#GetServerRealTime

GetSteamUILanguage

GetSteamUILanguage() as string

Returns the language the steam client is running in.

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

Returns: A string.

Reference:
ISteamUtils#GetSteamUILanguage

InitFilterText

InitFilterText() as integer

Initializes text filtering. Returns false if filtering is unavailable for the language the user is currently running in. If the language is unsupported, the FilterText API will act as a passthrough.

Returns: 1 if text filtering is available; otherwise 0.

Reference:
ISteamUtils#InitFilterText

FilterText

FilterText(inputMessage as string, legalOnly as integer) as string

inputMessage - The input string that should be filtered.

legalOnly - 0 if you want profanity and legally required filtering (where required) and 1 if you want legally required filtering only.

Filters the provided input message and places the filtered result into pchOutFilteredText.

Returns: The filtered text.

Reference:
ISteamUtils#FilterText

IsOverlayEnabled

IsOverlayEnabled() as integer

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

The overlay process could take a few seconds to start and hook the game process, so this method will initially return 0 while the overlay is loading.

Returns: 1 when the overlay is enabled; otherwise 0.

Reference:
ISteamUtils#IsOverlayEnabled

IsSteamChinaLauncher

IsSteamChinaLauncher() as integer

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: 1 when the current launcher is a Steam China launcher; otherwise 0.

Reference:
ISteamUtils#IsSteamChinaLauncher

IsSteamInBigPictureMode

IsSteamInBigPictureMode() as integer

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

Returns: 1 if in Big Picture Mode; otherwise 0.

Reference:
ISteamUtils#IsSteamInBigPictureMode

IsSteamRunningInVR

IsSteamRunningInVR() as integer

Checks if Steam is running in VR mode.

Returns: 1 when Steam is running in VR mode; otherwise 0.

Reference:
ISteamUtils#IsSteamRunningInVR

IsVRHeadsetStreamingEnabled

IsVRHeadsetStreamingEnabled() as integer

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

See API reference for further information.

Returns: 1 if streaming is enabled; otherwise 0.

Reference:
ISteamUtils#IsVRHeadsetStreamingEnabled

SetOverlayNotificationInset

SetOverlayNotificationInset(horizontalInset as integer, verticalInset as integer)

horizontalInset - The horizontal (left-right) distance in pixels from the corner.

verticalInset - The vertical (up-down) distance in pixels from the corner.

Sets the inset of the overlay notification from the corner specified by SetOverlayNotificationPosition.

Reference:
ISteamUtils#SetOverlayNotificationInset

SetOverlayNotificationPosition

SetOverlayNotificationPosition(eNotificationPosition as integer)

eNotificationPosition - The notification popup position.

Sets which corner the Steam overlay notification popup should display itself in.

This position is per-game and is reset each launch.

Reference:
ISteamUtils#SetOverlayNotificationPosition

SetVRHeadsetStreamingEnabled

SetVRHeadsetStreamingEnabled(enabled as integer)

enabled - Turns VR HMD Streaming on (1) or off (0).

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

See API reference for further information.

Reference:
ISteamUtils#SetVRHeadsetStreamingEnabled

SetWarningMessageHook

SetWarningMessageHook()

Sets a warning message hook within the plugin to receive Steam API warnings and info messages and output them to AGK's Debug Log.

Note: I have never seen a warning show up and don't know how to force one to fire, so I can only assume the plugin code is correct.

Reference:
ISteamUtils#SetWarningMessageHook

ShowGamepadTextInput

ShowGamepadTextInput(eInputMode as integer, eLineInputMode as integer, description as string, charMax as integer, existingText as string) as integer

eInputMode - Selects the input mode to use, either Normal or Password (hidden text).

eLineInputMode - Controls whether to use single or multi line input.

description - Sets the description that should inform the user what the input dialog is for.

charMax - The maximum number of characters that the user can input.

existingText - Sets the preexisting text which the user can edit.

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

Note: charMax is limited to 512 characters.

Returns: 1 if the input overlay opens; otherwise 0.

Reference:
ISteamUtils#ShowGamepadTextInput

StartVRDashboard

StartVRDashboard()

Asks Steam to create and render the OpenVR dashboard.

Reference:
ISteamUtils#StartVRDashboard

HasGamepadTextInputDismissedResponse

HasGamepadTextInputDismissedResponse() as integer

Triggered when the big picture gamepad text input has been closed.

Returns: 1 when the big picture gamepad text input has closed; otherwise 0.

Associated Methods:
GetGamepadTextInputDismissedSubmitted
GetGamepadTextInputDismissedSubmittedText

Reference:
ISteamUtils#GamepadTextInputDismissed_t

GetGamepadTextInputDismissedSubmitted

GetGamepadTextInputDismissedSubmitted() as integer

Gets whether the user has entered and accepted text for the current GamepadTextInputDismissed_t call.

This method should only be used when HasGamepadTextInputDismissedResponse has returned 1.

Returns: 1 if user entered and accepted text; otherwise 0.

Reference:
ISteamUtils#GamepadTextInputDismissed_t

GetGamepadTextInputDismissedSubmittedText

GetGamepadTextInputDismissedSubmittedText() as string

Gets the text for the current GamepadTextInputDismissed_t call.

This method should only be used when HasGamepadTextInputDismissedResponse has returned 1.

Returns: A string.

Reference:
ISteamUtils#GamepadTextInputDismissed_t

HasIPCountryChangedResponse

HasIPCountryChangedResponse() as integer

Reports when the country of the user has changed. Use GetIPCountry to get the new value.

Returns: 1 when the country has changed; otherwise 0.

Reference:
ISteamUtils#IPCountry_t

HasLowBatteryWarningResponse

HasLowBatteryWarningResponse() as integer

Tests when running on a laptop and there is less than 10 minutes of battery. Fires every minute afterwards. This method returns 1 once per warning. It is not reported as an on going effect.

Returns: 1 when there is a low battery warning; otherwise 0.

Associated Methods:
GetMinutesBatteryLeft

Reference:
ISteamUtils#LowBatteryPower_t

GetMinutesBatteryLeft

GetMinutesBatteryLeft() as integer

HasLowBatteryWarning should be checked before calling this method.

Reports the estimate battery life in minutes when a low battery warning occurs.

This method should only be used when HasLowBatteryWarningResponse has returned 1.

Returns: Battery life in minutes.

Reference:
ISteamUtils#LowBatteryPower_t

IsSteamShuttingDown

IsSteamShuttingDown() as integer

Called when Steam wants to shutdown.

Returns: 1 when Steam is shutting down; otherwise 0.

Reference:
ISteamUtils#SteamShutdown_t