Steamworks

https://partner.steamgames.com/doc/api/
Admin
Steamworks is a comprehensive set of tools and services provided by Valve for game developers and...
Tokens:3,143,510
Snippets:31,375
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### StartUpdateProperties Example

Source: https://partner.steamgames.com/doc/api/ISteamInventory?l=arabic

Example of starting a transaction to update dynamic properties on items, setting multiple properties, and submitting the update. Must call DestroyResult on the result handle from SubmitUpdateProperties when done.

```cpp
void CInventory::FinishLevel() {
  SteamInventoryUpdateHandle_t updateHandle = SteamInventory()->StartUpdateProperties();
  for ( SteamItemInstanceID_t itemid : m_vecItemIDs ) {
    SteamInventory()->SetProperty( updateHandle, itemid, "string_value", "blah" );
    SteamInventory()->SetProperty( updateHandle, itemid, "bool_value", true );
    SteamInventory()->SetProperty( updateHandle, itemid, "int64_value", (int64)55 );
    SteamInventory()->SetProperty( updateHandle, itemid, "float_value", 123.456f );
  }
  SteamInventoryResult_t resultHandle;
  SteamInventory()->SubmitUpdateProperties( updateHandle, &resultHandle );
}
```

--------------------------------

### StartUpdateProperties Example

Source: https://partner.steamgames.com/doc/api/iSteamInventory?l=bulgarian

Example usage of StartUpdateProperties in a C++ function. It starts a transaction, sets multiple properties on items, and submits the update. Remember to call ISteamInventory::DestroyResult on the result handle when done.

```cpp
void CInventory::FinishLevel() { SteamInventoryUpdateHandle_t updateHandle = SteamInventory()->StartUpdateProperties(); for ( SteamItemInstanceID_t itemid : m_vecItemIDs ) { SteamInventory()->SetProperty( updateHandle, itemid, "string_value", "blah" ); SteamInventory()->SetProperty( updateHandle, itemid, "bool_value", true ); SteamInventory()->SetProperty( updateHandle, itemid, "int64_value", (int64)55 ); SteamInventory()->SetProperty( updateHandle, itemid, "float_value", 123.456f ); } SteamInventoryResult_t resultHandle; SteamInventory()->SubmitUpdateProperties( updateHandle, &resultHandle ); } 
```

--------------------------------

### Init example

Source: https://partner.steamgames.com/doc/api/ISteamController?l=bulgarian

Initializes the ISteamController interface. Must be called when starting use of the interface. Always returns true.

```cpp
SteamController()->Init();
```

--------------------------------

### GetItemState usage example

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=czech&language=english

Shows how to call GetItemState and check the returned state flags to determine if an item is downloading or installed but needs an update.

```cpp
uint32 unItemState = GetItemState( 280762427 );
if ( unItemState & k_EItemStateDownloading )
{
	// indicates the item is currently downloading to the client
}
else if ( ( unItemState & k_EItemStateInstalled ) && ( unItemState & k_EItemStateNeedsUpdate ) )
{
	// indicates the item is installed but needs to be updated
}
```

--------------------------------

### Iterate beta branches with GetNumBetas and GetBetaInfo

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=japanese&language=english

Example showing how to iterate over all beta branches using GetNumBetas to get the count and GetBetaInfo to retrieve details for each branch. The example uses nullptr for the output parameters of GetNumBetas and allocates fixed-size buffers for the beta name and description.

```cpp
int32 betaCount = SteamApps()->GetNumBetas( nullptr, nullptr );
for ( int betaIndex = 0; betaIndex < betaCount; ++betaIndex )
{
    char name[128];
    char description[1024];
    uint32 flags = 0; // EBetaBranchFlags
    uint32 buildID = 0;
    SteamApps()->GetBetaInfo( betaIndex, &flags, &buildID, name, sizeof( name ), description, sizeof( description ) );
}
```

--------------------------------

### GetItemState usage example

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=brazilian&language=english

Shows how to retrieve the state of a workshop item and check it against EItemState flags to determine if it is downloading or installed but needs an update.

```cpp
uint32 unItemState = GetItemState( 280762427 );
if ( unItemState & k_EItemStateDownloading ) {
    // indicates the item is currently downloading to the client
} else if ( ( unItemState & k_EItemStateInstalled ) && ( unItemState & k_EItemStateNeedsUpdate ) ) {
    // indicates the item is installed but needs to be updated
}
```

--------------------------------

### SteamAPI_RestartAppIfNecessary startup example

Source: https://partner.steamgames.com/doc/api/steam_api?l=koreana

Shows the recommended startup sequence: call SteamAPI_RestartAppIfNecessary with your App ID (use k_uAppIdInvalid as a placeholder) and quit immediately if it returns true. Then call SteamAPI_Init() and exit with an error message if it fails.

```cpp
int main()
{
	if ( SteamAPI_RestartAppIfNecessary( k_uAppIdInvalid ) ) // Replace with your App ID
	{
		return 1;
	}

	if ( !SteamAPI_Init() )
	{
		printf( "Fatal Error - Steam must be running to play this game (SteamAPI_Init() failed).\n" );
		return 1;
	}

	return 0;
}
```

--------------------------------

### StartUpdateProperties example

Source: https://partner.steamgames.com/doc/api/iSteamInventory?l=brazilian&language=english

Starts a transaction to update dynamic properties on items for the current user. This call is rate-limited by user, so property modifications should be batched as much as possible (e.g., at the end of a map or game session). After calling ISteamInventory::SetProperty or ISteamInventory::RemoveProperty for all items to modify, call ISteamInventory::SubmitUpdateProperties to send the request to Steam servers. A SteamInventoryResultReady_t callback will be fired with the results. You must call ISteamInventory::DestroyResult on the provided inventory result when done.

```cpp
void CInventory::FinishLevel() { SteamInventoryUpdateHandle_t updateHandle = SteamInventory()->StartUpdateProperties(); for ( SteamItemInstanceID_t itemid : m_vecItemIDs ) { SteamInventory()->SetProperty( updateHandle, itemid, "string_value", "blah" ); SteamInventory()->SetProperty( updateHandle, itemid, "bool_value", true ); SteamInventory()->SetProperty( updateHandle, itemid, "int64_value", (int64)55 ); SteamInventory()->SetProperty( updateHandle, itemid, "float_value", 123.456f ); } SteamInventoryResult_t resultHandle; SteamInventory()->SubmitUpdateProperties( updateHandle, &resultHandle ); }
```

--------------------------------

### SteamAPI_Init

Source: https://partner.steamgames.com/doc/api/steam_api?l=arabic

Documentation for the SteamAPI_Init global function, including its return value and example usage.

```APIDOC
## SteamAPI_Init

### Description
Initializes the Steamworks API. Returns true if all required interfaces have been acquired and are accessible, false otherwise.

### Method
N/A (Global function)

### Endpoint
N/A (Global function)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (true)
- **bool** - true indicates that all required interfaces have been acquired and are accessible.

#### Failure Response (false)
- **bool** - false indicates one of the following conditions:
  - The Steam client isn't running.
  - The Steam client couldn't determine the App ID of game.
  - Your application is not running under the same OS user context as the Steam client.
  - Ensure that you own a license for the App ID on the currently active Steam account.
  - Your App ID is not completely set up.

#### Response Example
```cpp
int main() {
    if ( SteamAPI_RestartAppIfNecessary( k_uAppIdInvalid ) ) // Replace with your App ID
    {
        return 1;
    }
    if ( !SteamAPI_Init() )
    {
        printf( "Fatal Error - Steam must be running to play this game (SteamAPI_Init() failed).\n" );
        return 1;
    }
    return 0;
}
```
```

--------------------------------

### GetItemInstallInfo

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=french&language=english

SDK function to get install info for a workshop item.

```APIDOC
## GetItemInstallInfo

### Description
Gets info about currently installed content on the disc for workshop items that have `k_EItemStateInstalled` set. Calling this sets the "used" flag on the workshop item for the current player and adds it to their `k_EUserUGCList_UsedOrPlayed` list. If `k_EItemStateLegacyItem` is set then `pchFolder` contains the path to the legacy file itself, not a folder.

### Method
N/A (SDK function)

### Endpoint
N/A (SDK function)

### Parameters
#### Function Parameters
- **nPublishedFileID** (PublishedFileId_t) - Required - The workshop item to get the install info for.
- **punSizeOnDisk** (uint64 *) - Required - Returns the size of the workshop item in bytes.
- **pchFolder** (char *) - Required - Returns the absolute path to the folder containing the content by copying it.
- **cchFolderSize** (uint32) - Required - The size of `pchFolder` in bytes.
- **punTimeStamp** (uint32 *) - Required - Returns the time when the workshop item was last updated.

### Returns
bool
- **true** if the workshop item is already installed.
- **false** in the following cases:
  - `cchFolderSize` is **0**.
  - The workshop item has no content.
  - The workshop item is not installed.
```

--------------------------------

### GetItemInstallInfo

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=english&language=english

SDK function to get install info for a workshop item.

```APIDOC
## GetItemInstallInfo

### Description
Gets info about currently installed content on the disc for workshop items that have `k_EItemStateInstalled` set. Calling this sets the "used" flag on the workshop item for the current player and adds it to their `k_EUserUGCList_UsedOrPlayed` list. If `k_EItemStateLegacyItem` is set then `pchFolder` contains the path to the legacy file itself, not a folder.

### Method
N/A (SDK function)

### Endpoint
N/A (SDK function)

### Parameters
#### Function Parameters
- **nPublishedFileID** (PublishedFileId_t) - Required - The workshop item to get the install info for.
- **punSizeOnDisk** (uint64 *) - Required - Returns the size of the workshop item in bytes.
- **pchFolder** (char *) - Required - Returns the absolute path to the folder containing the content by copying it.
- **cchFolderSize** (uint32) - Required - The size of `pchFolder` in bytes.
- **punTimeStamp** (uint32 *) - Required - Returns the time when the workshop item was last updated.

### Returns
bool - **true** if the workshop item is already installed. **false** in the following cases: `cchFolderSize` is **0**. The workshop item has no content. The workshop item is not installed.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=romanian

Gets the install folder for a specific AppID, even if the application is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char *) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the `pchFolder` buffer.

### Returns
uint32 - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=romanian&language=english

Gets the install folder for a specific AppID, even if the application is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Parameters
#### Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char *) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the `pchFolder` buffer.

### Returns
uint32 - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### GetItemInstallInfo

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=english

Gets installation information for a workshop item, including size on disk, folder path, and last update timestamp. Also marks the item as used by the player.

```APIDOC
## GetItemInstallInfo

### Description
Gets info about currently installed content on the disc for workshop items that have `k_EItemStateInstalled` set. Calling this sets the "used" flag on the workshop item for the current player and adds it to their `k_EUserUGCList_UsedOrPlayed` list. If `k_EItemStateLegacyItem` is set then `pchFolder` contains the path to the legacy file itself, not a folder.

### Method
N/A (SDK function)

### Endpoint
N/A (SDK function)

### Parameters
- **nPublishedFileID** (PublishedFileId_t) - Required - The workshop item to get the install info for.
- **punSizeOnDisk** (uint64 *) - Required - Returns the size of the workshop item in bytes.
- **pchFolder** (char *) - Required - Returns the absolute path to the folder containing the content by copying it.
- **cchFolderSize** (uint32) - Required - The size of `pchFolder` in bytes.
- **punTimeStamp** (uint32 *) - Required - Returns the time when the workshop item was last updated.

### Returns
bool - **true** if the workshop item is already installed. **false** in the following cases: `cchFolderSize` is **0**, the workshop item has no content, or the workshop item is not installed.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=portuguese&language=english

Gets the install folder for a specific AppID, even if the application is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
Function

### Signature
uint32 GetAppInstallDir( AppId_t appID, char *pchFolder, uint32 cchFolderBufferSize );

### Parameters
- **appID** (AppId_t) - Input - The App ID to get the install dir for.
- **pchFolder** (char*) - Output - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - Input - The size in bytes of the `pchFolder` buffer.

### Returns
uint32 - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### C++ Example: StartUpdateProperties and SubmitUpdateProperties

Source: https://partner.steamgames.com/doc/api/ISteamInventory?l=malay&language=english

Shows how to start a property update transaction, set multiple properties on items, and submit the update. Note that StartUpdateProperties is rate-limited by user, so batch modifications. You must call DestroyResult on the result handle from SubmitUpdateProperties when done.

```cpp
void CInventory::FinishLevel() {
    SteamInventoryUpdateHandle_t updateHandle = SteamInventory()->StartUpdateProperties();
    for ( SteamItemInstanceID_t itemid : m_vecItemIDs ) {
        SteamInventory()->SetProperty( updateHandle, itemid, "string_value", "blah" );
        SteamInventory()->SetProperty( updateHandle, itemid, "bool_value", true );
        SteamInventory()->SetProperty( updateHandle, itemid, "int64_value", (int64)55 );
        SteamInventory()->SetProperty( updateHandle, itemid, "float_value", 123.456f );
    }
    SteamInventoryResult_t resultHandle;
    SteamInventory()->SubmitUpdateProperties( updateHandle, &resultHandle );
}
```

--------------------------------

### GetActionOriginFromXboxOrigin example

Source: https://partner.steamgames.com/doc/api/isteaminput

Shows how to get an action origin from an Xbox origin using a controller handle, then retrieve the local glyph path. The example prints the path and loads a button glyph texture from that path.

```cpp
int nXinputSlot = 1; // Substitute whatever the correct Xinput slot is for your player
InputHandle_t controller1Handle = GetControllerForGamepadIndex( nXinputSlot );
EInputActionOrigin buttonOrigin = SteamInput()->GetActionOriginFromXboxOrigin( controller1Handle, k_EXboxOrigin_A );
// Gets the image from the Steam client .
const char *localGlyphPath = SteamInput()->GetGlyphForActionOrigin( buttonOrigin );
printf( "path = %s\n", localGlyphPath );
// "path = C:\Program Files (x86)\Steam\tenfoot\resource\images\library\controller\api\ps4_button_x.png"
//a function from the game that turns a file path into a usable game texture
glyphTextureID = loadButtonGlyphTextureFromLocalPath( localGlyphPath );
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=russian&language=english

Gets the install folder for a specific AppID, even if the application is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Parameters
#### Input Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char *) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the `pchFolder` buffer.

### Returns
uint32 - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### ActivateGameOverlay example

Source: https://partner.steamgames.com/doc/api/ISteamFriends

Opens the Steam Overlay to the specified dialog. The example opens the friends dialog.

```cpp
SteamFriends()->ActivateGameOverlay( "friends" );
```

--------------------------------

### SteamAPI_Init usage example

Source: https://partner.steamgames.com/doc/api/steam_api?l=arabic&language=english

Example of initializing the Steamworks API. It first calls SteamAPI_RestartAppIfNecessary with k_uAppIdInvalid (replace with your App ID) and exits if restart is needed. Then it calls SteamAPI_Init and prints a fatal error and returns 1 if initialization fails.

```cpp
int main() { if ( SteamAPI_RestartAppIfNecessary( k_uAppIdInvalid ) ) // Replace with your App ID { return 1; } if ( !SteamAPI_Init() ) { printf( "Fatal Error - Steam must be running to play this game (SteamAPI_Init() failed).\n" ); return 1; } return 0; }
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=norwegian&language=english

Gets the install folder for a specific AppID, even if the application is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Parameters
#### Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char *) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the `pchFolder` buffer.

### Returns
**uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### Init Example

Source: https://partner.steamgames.com/doc/api/ISteamInput

Initializes the ISteamInput interface. Must be called before using other Steam Input functions. Always returns true.

```cpp
SteamInput()->Init();
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=greek

Gets the install folder for a specific AppID, even if the application is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
N/A (SDK function)

### Endpoint
N/A

### Parameters
#### Parameters
- **appID** (AppId_t) - Required - The App ID to get the install dir for.
- **pchFolder** (char *) - Required - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - Required - The size in bytes of the `pchFolder` buffer.

### Returns
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### ActivateActionSet example for all controllers using STEAM_INPUT_HANDLE_ALL_CONTROLLERS

Source: https://partner.steamgames.com/doc/api/isteaminput?l=arabic

Same state loop as the previous example, but uses the constant STEAM_INPUT_HANDLE_ALL_CONTROLLERS as the controller handle to activate the action set on all connected controllers at once. This constant can be used in any function that takes an individual controller handle.

```cpp
void updateStateLoop() {
    switch( currentState ) {
        case MENU:
            SteamInput()->ActivateActionSet( STEAM_INPUT_HANDLE_ALL_CONTROLLERS, menuSetHandle );
            doMenuStuff();
            break;
        case WALKING:
            SteamInput()->ActivateActionSet( STEAM_INPUT_HANDLE_ALL_CONTROLLERS, walkingSetHandle );
            doWalkingStuff();
            break;
        case DRIVING:
            SteamInput()->ActivateActionSet( STEAM_INPUT_HANDLE_ALL_CONTROLLERS, drivingSetHandle );
            doDrivingStuff();
            break;
        case FIGHTING:
            SteamInput()->ActivateActionSet( STEAM_INPUT_HANDLE_ALL_CONTROLLERS, fightingSetHandle );
            doFightingStuff();
            break;
    }
}
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=finnish&language=english

Gets the install folder for a specific AppID, even if the application is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Parameters
#### Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char *) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the `pchFolder` buffer.

### Returns
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### GetEnteredGamepadTextInput Example

Source: https://partner.steamgames.com/doc/api/ISteamUtils

Example callback for GamepadTextInputDismissed_t that retrieves the entered gamepad text. Must be called within the callback and only if m_bSubmitted is true. Uses GetEnteredGamepadTextLength to get the buffer size and checks success.

```cpp
void OnGamepadTextInputDismissed_t( GamepadTextInputDismissed_t* pCallback ) {
    // The user canceled,
    if ( !pCallback.m_bSubmitted )
        return;

    // Use some max input length that we passed into ShowGamepadTextInput, +1 for the null terminator.
    const uint32 MAX_INPUT_LENGTH = 64 + 1;
    uint32 length = SteamUtils()->GetEnteredGamepadTextLength();
    char* szTextInput[MAX_INPUT_LENGTH];
    bool success = SteamUtils()->GetEnteredGamepadTextInput( szTextInput, length );

    if ( !success )
    {
        // Log an error. This should only ever happen if length is > MaxInputLength
        return;
    }

    // Display the updated string
}
```

--------------------------------

### GetAllItems example

Source: https://partner.steamgames.com/doc/api/ISteamInventory?l=bulgarian

Example call to GetAllItems, retrieving all items in the current user's inventory. The result handle must be destroyed with DestroyResult when done.

```cpp
void SpaceWarItem::LoadInventory( IGameEngine *pGameEngine ) {
    SteamInventory()->GetAllItems( &s_RequestResult );
}
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=dutch&language=english

Gets the install folder for a specific AppID, even if the app is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (200)
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.

#### Response Example
```json
{
  "result": 42
}
```
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=bulgarian

Gets the install folder for a specific AppID, even if the application is not installed.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char*) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the pchFolder buffer.

### Returns
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=schinese&language=english

Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
N/A (SDK method)

### Endpoint
N/A

### Parameters
#### Parameters
- **appID** (AppId_t) - Required - The App ID to get the install dir for.
- **pchFolder** (char *) - Required - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - Required - The size in bytes of the `pchFolder` buffer.

### Request Example
N/A

### Response
#### Success Response
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.

#### Response Example
```
42
```
```

--------------------------------

### BInitWorkshopForGameServer

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=danish&language=english

Initializes the workshop folder for a game server.

```APIDOC
## BInitWorkshopForGameServer

### Description
Lets game servers set a specific workshop folder before issuing any UGC commands. This is helpful if you want to support multiple game servers running out of the same install folder.

### Method
N/A (SDK function)

### Endpoint
N/A (SDK function)

### Parameters
- **unWorkshopDepotID** (DepotId_t) - Required - The depot ID of the game server.
- **pszFolder** (const char *) - Required - The absolute path to store the workshop content.

### Returns
- **bool** - true upon success; otherwise, false if the calling user is not a game server or if the workshop is currently updating its content.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=polish&language=english

Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
uint32 GetAppInstallDir( AppId_t appID, char *pchFolder, uint32 cchFolderBufferSize );

### Parameters
#### Input Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char*) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the `pchFolder` buffer.

### Returns
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### BInitWorkshopForGameServer

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=czech&language=english

Initializes the workshop folder for a game server.

```APIDOC
## BInitWorkshopForGameServer

### Description
Lets game servers set a specific workshop folder before issuing any UGC commands. This is helpful if you want to support multiple game servers running out of the same install folder.

### Method
BInitWorkshopForGameServer

### Endpoint
bool BInitWorkshopForGameServer( DepotId_t unWorkshopDepotID, const char *pszFolder );

### Parameters
#### Parameters
- **unWorkshopDepotID** (DepotId_t) - Required - The depot ID of the game server.
- **pszFolder** (const char *) - Required - The absolute path to store the workshop content.

### Returns
- **bool** - **true** upon success; otherwise, **false** if the calling user is not a game server or if the workshop is currently updating its content.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=latam&language=english

Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Endpoint
uint32 GetAppInstallDir( AppId_t appID, char *pchFolder, uint32 cchFolderBufferSize );

### Parameters
#### Parameters
- **appID** (AppId_t) - Required - The App ID to get the install dir for.
- **pchFolder** (char *) - Required - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - Required - The size in bytes of the `pchFolder` buffer.

### Returns
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### BInitWorkshopForGameServer

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=czech

Initializes the workshop folder for a game server.

```APIDOC
## BInitWorkshopForGameServer

### Description
Lets game servers set a specific workshop folder before issuing any UGC commands. This is helpful if you want to support multiple game servers running out of the same install folder.

### Method
BInitWorkshopForGameServer

### Endpoint
bool BInitWorkshopForGameServer( DepotId_t unWorkshopDepotID, const char *pszFolder );

### Parameters
#### Parameters
- **unWorkshopDepotID** (DepotId_t) - Required - The depot ID of the game server.
- **pszFolder** (const char *) - Required - The absolute path to store the workshop content.

### Returns
- **bool** - true upon success; otherwise, false if the calling user is not a game server or if the workshop is currently updating its content.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=italian&language=english

Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Parameters
#### Parameters
- **appID** (AppId_t) - Required - The App ID to get the install dir for.
- **pchFolder** (char *) - Required - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - Required - The size in bytes of the `pchFolder` buffer.

### Returns
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.

```

--------------------------------

### C++ example: Granting promotional items with AddPromoItems

Source: https://partner.steamgames.com/doc/api/iSteamInventory

Shows how to call AddPromoItems with an array of item definitions. The example creates an array of two SteamItemDef_t values and passes it to the function, storing the result handle in s_GenerateRequestResult.

```cpp
void CInventory::GrantPromoItems() {
    SteamItemDef_t newItems[2];
    newItems[0] = 110;
    newItems[1] = 111;
    SteamInventory()->AddPromoItems( &s_GenerateRequestResult, newItems, 2 );
}
```

--------------------------------

### SteamAPI_Init example

Source: https://partner.steamgames.com/doc/api/steam_api

Initializes the Steamworks API and checks for a running Steam client. Returns true if all required interfaces are acquired, false if the Steam client is not running, the App ID cannot be determined, the user context differs, the license is missing, or the App ID is not set up. Requires a steam_appid.txt file in the game directory when running from the executable or debugger.

```cpp
int main() {
    if ( SteamAPI_RestartAppIfNecessary( k_uAppIdInvalid ) ) // Replace with your App ID
    {
        return 1;
    }
    if ( !SteamAPI_Init() )
    {
        printf( "Fatal Error - Steam must be running to play this game (SteamAPI_Init() failed).\n" );
        return 1;
    }
    return 0;
}
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=danish&language=english

Gets the install folder for a specific AppID. Works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Signature
uint32 GetAppInstallDir( AppId_t appID, char *pchFolder, uint32 cchFolderBufferSize );

### Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char*) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the `pchFolder` buffer.

### Returns
uint32 - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=bulgarian&language=english

Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
uint32 GetAppInstallDir( AppId_t appID, char *pchFolder, uint32 cchFolderBufferSize );

### Parameters
#### Input Parameters
- **appID** (AppId_t) - The App ID to get the install dir for.
- **pchFolder** (char*) - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - The size in bytes of the `pchFolder` buffer.

### Returns
uint32 - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps

Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Parameters
- **appID** (AppId_t) - Required - The App ID to get the install dir for.
- **pchFolder** (char *) - Required - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - Required - The size in bytes of the `pchFolder` buffer.

### Request Example
N/A

### Response
#### Success Response
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.

#### Response Example
```
256
```
```

--------------------------------

### BInitWorkshopForGameServer

Source: https://partner.steamgames.com/doc/api/ISteamUGC?l=polish&language=english

Initializes a game server's workshop folder before issuing UGC commands, allowing multiple servers to share an install folder.

```APIDOC
## BInitWorkshopForGameServer

### Description
Lets game servers set a specific workshop folder before issuing any UGC commands. Useful for supporting multiple game servers running from the same install folder.

### Method
BInitWorkshopForGameServer

### Signature
bool BInitWorkshopForGameServer( DepotId_t unWorkshopDepotID, const char *pszFolder );

### Parameters
- **unWorkshopDepotID** (DepotId_t) - Required - The depot ID of the game server.
- **pszFolder** (const char *) - Required - The absolute path to store the workshop content.

### Returns
- **bool** - true upon success; otherwise, false if the calling user is not a game server or if the workshop is currently updating its content.
```

--------------------------------

### InitGameServer

Source: https://partner.steamgames.com/doc/api/ISTeamGameServer?language=english

Documentation for the InitGameServer function, which initializes the ISteamGameServer instance.

```APIDOC
## InitGameServer

### Description
Initializes the instance of ISteamGameServer. This is called by SteamGameServer_Init, and you will usually not need to call it directly. If you pass MASTERSERVERUPDATERPORT_USEGAMESOCKETSHARE into `usQueryPort`, then it causes the game server API to use "GameSocketShare" mode, which means that the game is responsible for sending and receiving UDP packets for the master server updater.

### Method
InitGameServer

### Endpoint
bool InitGameServer( uint32 unIP, uint16 usGamePort, uint16 usQueryPort, uint32 unFlags, AppId_t nGameAppId, const char *pchVersionString );

### Parameters
- **unIP** (uint32) - Required - The IP address you are going to bind to. (This should be in host order, i.e 127.0.0.1 == 0x7f000001). You can use `INADDR_ANY` to bind to all local IPv4 addresses.
- **usGamePort** (uint16) - Required - The port that clients will connect to for gameplay.
- **usQueryPort** (uint16) - Required - The port that will manage server browser related duties and info pings from clients.
- **unFlags** (uint32) - Required - A union of one or more ServerFlags.
- **nGameAppId** (AppId_t) - Required - The app id of the game this server is for.
- **pchVersionString** (const char *) - Required - The version string is usually in the form x.x.x.x, and is used by the master server to detect when the server is out of date. (Only servers with the latest version will be listed.)

### Response
#### Success Response
- **Returns** (bool) - **true** if the game server was successfully able to bind to the provided IP/Port; otherwise, **false** indicating failure.
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=arabic&language=english

Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Parameters
#### Parameters
- **appID** (AppId_t) - Required - The App ID to get the install dir for.
- **pchFolder** (char *) - Required - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - Required - The size in bytes of the `pchFolder` buffer.

### Returns
- **uint32** - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```

--------------------------------

### GetImageRGBA Example

Source: https://partner.steamgames.com/doc/api/ISteamUtils

Example function that converts a Steam image handle to a texture by retrieving the image size, allocating a buffer, and calling GetImageRGBA. Includes error handling and a comment about caching the texture.

```cpp
HGAMETEXTURE GetSteamImageAsTexture( int iImage ) { HGAMETEXTURE hTexture = 0; // You should first check if you have already cached this image using something like a dictionary/map // with iImage as the key and then return the texture handle associated with it if it exists. // If it doesn't exist, continue on, and add the texture to the map before returning at the end of the function. // If we have to check the size of the image. uint32 uAvatarWidth, uAvatarHeight; bool success = SteamUtils()->GetImageSize( iImage, &uAvatarWidth, &uAvatarHeight ); if ( !success ) { // Log a warning message. return hTexture; } // Get the actual raw RGBA data from Steam and turn it into a texture in our game engine const int uImageSizeInBytes = uAvatarWidth * uAvatarHeight * 4; uint8 *pAvatarRGBA = new uint8[uImageSizeInBytes]; success = SteamUtils()->GetImageRGBA( iImage, pAvatarRGBA, uImageSizeInBytes ); if( !success ) { // Do something to convert the RGBA texture into your internal texture format for displaying. // hTexture = m_pGameEngine->HCreateTexture( pAvatarRGBA, uAvatarWidth, uAvatarHeight ); // And add the texture to the cache } // Don't forget to free the memory! delete[] pAvatarRGBA; return hTexture; }
```

--------------------------------

### C++ example: GrantPromoItems using AddPromoItems

Source: https://partner.steamgames.com/doc/api/iSteamInventory?l=arabic&language=english

Example from the documentation showing how to call AddPromoItems with an array of item definitions. The function returns a result handle that must be destroyed with ISteamInventory::DestroyResult.

```cpp
void CInventory::GrantPromoItems() {
  SteamItemDef_t newItems[2];
  newItems[0] = 110;
  newItems[1] = 111;
  SteamInventory()->AddPromoItems( &s_GenerateRequestResult, newItems, 2 );
}
```

--------------------------------

### GetAllItems example

Source: https://partner.steamgames.com/doc/api/ISteamInventory?l=arabic

Call GetAllItems to retrieve the user's full inventory. The result handle must be destroyed with DestroyResult when done.

```cpp
void SpaceWarItem::LoadInventory( IGameEngine *pGameEngine ) {
  SteamInventory()->GetAllItems( &s_RequestResult );
}
```

--------------------------------

### GetAppInstallDir

Source: https://partner.steamgames.com/doc/api/ISteamApps?l=brazilian&language=english

Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

```APIDOC
## GetAppInstallDir

### Description
Gets the install folder for a specific AppID. This works even if the application is not installed, based on where the game would be installed with the default Steam library location.

### Method
GetAppInstallDir

### Signature
uint32 GetAppInstallDir( AppId_t appID, char *pchFolder, uint32 cchFolderBufferSize );

### Parameters
- **appID** (AppId_t) - Input - The App ID to get the install dir for.
- **pchFolder** (char*) - Output - The string buffer that the folder path will be copied into.
- **cchFolderBufferSize** (uint32) - Input - The size in bytes of the `pchFolder` buffer.

### Returns
uint32 - Returns the install directory path as a string into the buffer provided in pchFolder and returns the number of bytes that were copied into that buffer.
```
Tokens:
Raw