Additional Methods - adambiser/agk-steam-plugin GitHub Wiki

Note: These commands are not part of the Steamworks SDK but are included as a convenience.

GetCommandLineArgsJSON

GetCommandLineArgsJSON() as string

Returns the command line arguments.

Returns: The command line arguments as a JSON string of an array of strings.

GetSteamPath

GetSteamPath() as string

On Windows, this returns the path of the folder containing the Steam client EXE as found in the registry by reading the value of SteamPath in HKEY_CURRENT_USER\Software\Valve\Steam. The path may contain slashes instead of backslashes and the trailing slash may or may not be included.

On Linux, this returns the value of the "STEAM_RUNTIME" environment variable.

Returns: The path at which the Steam client is installed.

IsSteamEmulated

IsSteamEmulated() as integer

Attempts to detect when Steam is being emulated. Emulation is sometimes used with pirated games, but it can also be used for valid reasons.

Note: This only works on Windows.

Returns: 1 when Steam emulation is detected, otherwise 0.

SetFileAttributes

SetFileAttributes(filename as string, attributes as integer) as integer

• filename - The name of the file whose attributes are to be set.
• attributes - The file attributes to set for the file.

Sets the attributes of a file. This is only included to help with development because the AppGameKit IDE deletes Steam files in the project folder when the interpreter exits.

Note: This only works on Windows.

Returns: 1 if successful; otherwise, 0.