steam_ugc_get_item_install_info

Syntax:

steam_ugc_get_item_install_info(published_file_id, info_map);


Argument Description
published_file_id The unique handle for the UGC to be updated.
info_map A (previously created) DS map index.


Returns: Boolean


Description

This function can be used to retrieve information about any given published file item that has been subscribed to and downloaded to the Steam local storage area for your game. You give the item ID and supply the index to an empty DS map which will then be populated with the following key/value pairs if the item exists:

  1. "size_on_disk" - The file size on disk (in bytes)

  2. "legacy_item" - Will be true or false depending on whether it is a legacy file or not.

  3. "folder" - This is the full path to the installed content ( please refer to "Item Installation" in Steam SDK docs, as "legacy" items uploaded with the old method, are treated differently).

If the item exists then the function will return true and populate the map, otherwise it will return false and the map will remain empty.


Example:

var item_map = ds_map_create();
steam_ugc_get_item_install_info(global.fileID, item_map);

The above code will query the install status of the item indexed in the global variable "fileID", using a ds_map to store the information.