forked from gibbed/SteamAchievementManager
    
        
        - 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 6
ISteamUGC
        syntax-tm edited this page Jul 13, 2024 
        ·
        1 revision
      
    A versioned accessor is exported by the library.
S_API ISteamUGC *SteamAPI_SteamUGC_v018();Inline, unversioned accessor to get the current version. Essentially the same as SteamUGC(), but using this ensures that you are using a matching library.
inline ISteamUGC *SteamAPI_SteamUGC() { return SteamAPI_SteamUGC_v018(); }A versioned accessor is exported by the library.
S_API ISteamUGC *SteamAPI_SteamGameServerUGC_v018();Inline, unversioned accessor to get the current version. Essentially the same as SteamGameServerUGC(), but using this ensures that you are using a matching library.
inline ISteamUGC *SteamAPI_SteamGameServerUGC() { return SteamAPI_SteamGameServerUGC_v018(); }| Return Type | Interface | Method | Arguments | 
|---|---|---|---|
| UGCQueryHandle_t | ISteamUGC | CreateQueryUserUGCRequest | ISteamUGC* self, AccountID_t unAccountID, EUserUGCList eListType, EUGCMatchingUGCType eMatchingUGCType, EUserUGCListSortOrder eSortOrder, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint32 unPage | 
| UGCQueryHandle_t | ISteamUGC | CreateQueryAllUGCRequestPage | ISteamUGC* self, EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, uint32 unPage | 
| UGCQueryHandle_t | ISteamUGC | CreateQueryAllUGCRequestCursor | ISteamUGC* self, EUGCQuery eQueryType, EUGCMatchingUGCType eMatchingeMatchingUGCTypeFileType, AppId_t nCreatorAppID, AppId_t nConsumerAppID, const char * pchCursor | 
| UGCQueryHandle_t | ISteamUGC | CreateQueryUGCDetailsRequest | ISteamUGC* self, PublishedFileId_t * pvecPublishedFileID, uint32 unNumPublishedFileIDs | 
| SteamAPICall_t | ISteamUGC | SendQueryUGCRequest | ISteamUGC* self, UGCQueryHandle_t handle | 
| bool | ISteamUGC | GetQueryUGCResult | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, SteamUGCDetails_t * pDetails | 
| uint32 | ISteamUGC | GetQueryUGCNumTags | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index | 
| bool | ISteamUGC | GetQueryUGCTag | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, uint32 indexTag, char * pchValue, uint32 cchValueSize | 
| bool | ISteamUGC | GetQueryUGCTagDisplayName | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, uint32 indexTag, char * pchValue, uint32 cchValueSize | 
| bool | ISteamUGC | GetQueryUGCPreviewURL | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, char * pchURL, uint32 cchURLSize | 
| bool | ISteamUGC | GetQueryUGCMetadata | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, char * pchMetadata, uint32 cchMetadatasize | 
| bool | ISteamUGC | GetQueryUGCChildren | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, PublishedFileId_t * pvecPublishedFileID, uint32 cMaxEntries | 
| bool | ISteamUGC | GetQueryUGCStatistic | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, EItemStatistic eStatType, uint64 * pStatValue | 
| uint32 | ISteamUGC | GetQueryUGCNumAdditionalPreviews | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index | 
| bool | ISteamUGC | GetQueryUGCAdditionalPreview | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, uint32 previewIndex, char * pchURLOrVideoID, uint32 cchURLSize, char * pchOriginalFileName, uint32 cchOriginalFileNameSize, EItemPreviewType * pPreviewType | 
| uint32 | ISteamUGC | GetQueryUGCNumKeyValueTags | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index | 
| bool | ISteamUGC | GetQueryUGCKeyValueTag | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, uint32 keyValueTagIndex, char * pchKey, uint32 cchKeySize, char * pchValue, uint32 cchValueSize | 
| bool | ISteamUGC | GetQueryFirstUGCKeyValueTag | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, const char * pchKey, char * pchValue, uint32 cchValueSize | 
| uint32 | ISteamUGC | GetQueryUGCContentDescriptors | ISteamUGC* self, UGCQueryHandle_t handle, uint32 index, EUGCContentDescriptorID * pvecDescriptors, uint32 cMaxEntries | 
| bool | ISteamUGC | ReleaseQueryUGCRequest | ISteamUGC* self, UGCQueryHandle_t handle | 
| bool | ISteamUGC | AddRequiredTag | ISteamUGC* self, UGCQueryHandle_t handle, const char * pTagName | 
| bool | ISteamUGC | AddRequiredTagGroup | ISteamUGC* self, UGCQueryHandle_t handle, const SteamParamStringArray_t * pTagGroups | 
| bool | ISteamUGC | AddExcludedTag | ISteamUGC* self, UGCQueryHandle_t handle, const char * pTagName | 
| bool | ISteamUGC | SetReturnOnlyIDs | ISteamUGC* self, UGCQueryHandle_t handle, bool bReturnOnlyIDs | 
| bool | ISteamUGC | SetReturnKeyValueTags | ISteamUGC* self, UGCQueryHandle_t handle, bool bReturnKeyValueTags | 
| bool | ISteamUGC | SetReturnLongDescription | ISteamUGC* self, UGCQueryHandle_t handle, bool bReturnLongDescription | 
| bool | ISteamUGC | SetReturnMetadata | ISteamUGC* self, UGCQueryHandle_t handle, bool bReturnMetadata | 
| bool | ISteamUGC | SetReturnChildren | ISteamUGC* self, UGCQueryHandle_t handle, bool bReturnChildren | 
| bool | ISteamUGC | SetReturnAdditionalPreviews | ISteamUGC* self, UGCQueryHandle_t handle, bool bReturnAdditionalPreviews | 
| bool | ISteamUGC | SetReturnTotalOnly | ISteamUGC* self, UGCQueryHandle_t handle, bool bReturnTotalOnly | 
| bool | ISteamUGC | SetReturnPlaytimeStats | ISteamUGC* self, UGCQueryHandle_t handle, uint32 unDays | 
| bool | ISteamUGC | SetLanguage | ISteamUGC* self, UGCQueryHandle_t handle, const char * pchLanguage | 
| bool | ISteamUGC | SetAllowCachedResponse | ISteamUGC* self, UGCQueryHandle_t handle, uint32 unMaxAgeSeconds | 
| bool | ISteamUGC | SetCloudFileNameFilter | ISteamUGC* self, UGCQueryHandle_t handle, const char * pMatchCloudFileName | 
| bool | ISteamUGC | SetMatchAnyTag | ISteamUGC* self, UGCQueryHandle_t handle, bool bMatchAnyTag | 
| bool | ISteamUGC | SetSearchText | ISteamUGC* self, UGCQueryHandle_t handle, const char * pSearchText | 
| bool | ISteamUGC | SetRankedByTrendDays | ISteamUGC* self, UGCQueryHandle_t handle, uint32 unDays | 
| bool | ISteamUGC | SetTimeCreatedDateRange | ISteamUGC* self, UGCQueryHandle_t handle, RTime32 rtStart, RTime32 rtEnd | 
| bool | ISteamUGC | SetTimeUpdatedDateRange | ISteamUGC* self, UGCQueryHandle_t handle, RTime32 rtStart, RTime32 rtEnd | 
| bool | ISteamUGC | AddRequiredKeyValueTag | ISteamUGC* self, UGCQueryHandle_t handle, const char * pKey, const char * pValue | 
| SteamAPICall_t | ISteamUGC | RequestUGCDetails | ISteamUGC* self, PublishedFileId_t nPublishedFileID, uint32 unMaxAgeSeconds | 
| SteamAPICall_t | ISteamUGC | CreateItem | ISteamUGC* self, AppId_t nConsumerAppId, EWorkshopFileType eFileType | 
| UGCUpdateHandle_t | ISteamUGC | StartItemUpdate | ISteamUGC* self, AppId_t nConsumerAppId, PublishedFileId_t nPublishedFileID | 
| bool | ISteamUGC | SetItemTitle | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pchTitle | 
| bool | ISteamUGC | SetItemDescription | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pchDescription | 
| bool | ISteamUGC | SetItemUpdateLanguage | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pchLanguage | 
| bool | ISteamUGC | SetItemMetadata | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pchMetaData | 
| bool | ISteamUGC | SetItemVisibility | ISteamUGC* self, UGCUpdateHandle_t handle, ERemoteStoragePublishedFileVisibility eVisibility | 
| bool | ISteamUGC | SetItemTags | ISteamUGC* self, UGCUpdateHandle_t updateHandle, const SteamParamStringArray_t * pTags, bool bAllowAdminTags | 
| bool | ISteamUGC | SetItemContent | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pszContentFolder | 
| bool | ISteamUGC | SetItemPreview | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pszPreviewFile | 
| bool | ISteamUGC | SetAllowLegacyUpload | ISteamUGC* self, UGCUpdateHandle_t handle, bool bAllowLegacyUpload | 
| bool | ISteamUGC | RemoveAllItemKeyValueTags | ISteamUGC* self, UGCUpdateHandle_t handle | 
| bool | ISteamUGC | RemoveItemKeyValueTags | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pchKey | 
| bool | ISteamUGC | AddItemKeyValueTag | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pchKey, const char * pchValue | 
| bool | ISteamUGC | AddItemPreviewFile | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pszPreviewFile, EItemPreviewType type | 
| bool | ISteamUGC | AddItemPreviewVideo | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pszVideoID | 
| bool | ISteamUGC | UpdateItemPreviewFile | ISteamUGC* self, UGCUpdateHandle_t handle, uint32 index, const char * pszPreviewFile | 
| bool | ISteamUGC | UpdateItemPreviewVideo | ISteamUGC* self, UGCUpdateHandle_t handle, uint32 index, const char * pszVideoID | 
| bool | ISteamUGC | RemoveItemPreview | ISteamUGC* self, UGCUpdateHandle_t handle, uint32 index | 
| bool | ISteamUGC | AddContentDescriptor | ISteamUGC* self, UGCUpdateHandle_t handle, EUGCContentDescriptorID descid | 
| bool | ISteamUGC | RemoveContentDescriptor | ISteamUGC* self, UGCUpdateHandle_t handle, EUGCContentDescriptorID descid | 
| SteamAPICall_t | ISteamUGC | SubmitItemUpdate | ISteamUGC* self, UGCUpdateHandle_t handle, const char * pchChangeNote | 
| EItemUpdateStatus | ISteamUGC | GetItemUpdateProgress | ISteamUGC* self, UGCUpdateHandle_t handle, uint64 * punBytesProcessed, uint64 * punBytesTotal | 
| SteamAPICall_t | ISteamUGC | SetUserItemVote | ISteamUGC* self, PublishedFileId_t nPublishedFileID, bool bVoteUp | 
| SteamAPICall_t | ISteamUGC | GetUserItemVote | ISteamUGC* self, PublishedFileId_t nPublishedFileID | 
| SteamAPICall_t | ISteamUGC | AddItemToFavorites | ISteamUGC* self, AppId_t nAppId, PublishedFileId_t nPublishedFileID | 
| SteamAPICall_t | ISteamUGC | RemoveItemFromFavorites | ISteamUGC* self, AppId_t nAppId, PublishedFileId_t nPublishedFileID | 
| SteamAPICall_t | ISteamUGC | SubscribeItem | ISteamUGC* self, PublishedFileId_t nPublishedFileID | 
| SteamAPICall_t | ISteamUGC | UnsubscribeItem | ISteamUGC* self, PublishedFileId_t nPublishedFileID | 
| uint32 | ISteamUGC | GetNumSubscribedItems | ISteamUGC* self | 
| uint32 | ISteamUGC | GetSubscribedItems | ISteamUGC* self, PublishedFileId_t * pvecPublishedFileID, uint32 cMaxEntries | 
| uint32 | ISteamUGC | GetItemState | ISteamUGC* self, PublishedFileId_t nPublishedFileID | 
| bool | ISteamUGC | GetItemInstallInfo | ISteamUGC* self, PublishedFileId_t nPublishedFileID, uint64 * punSizeOnDisk, char * pchFolder, uint32 cchFolderSize, uint32 * punTimeStamp | 
| bool | ISteamUGC | GetItemDownloadInfo | ISteamUGC* self, PublishedFileId_t nPublishedFileID, uint64 * punBytesDownloaded, uint64 * punBytesTotal | 
| bool | ISteamUGC | DownloadItem | ISteamUGC* self, PublishedFileId_t nPublishedFileID, bool bHighPriority | 
| bool | ISteamUGC | BInitWorkshopForGameServer | ISteamUGC* self, DepotId_t unWorkshopDepotID, const char * pszFolder | 
| void | ISteamUGC | SuspendDownloads | ISteamUGC* self, bool bSuspend | 
| SteamAPICall_t | ISteamUGC | StartPlaytimeTracking | ISteamUGC* self, PublishedFileId_t * pvecPublishedFileID, uint32 unNumPublishedFileIDs | 
| SteamAPICall_t | ISteamUGC | StopPlaytimeTracking | ISteamUGC* self, PublishedFileId_t * pvecPublishedFileID, uint32 unNumPublishedFileIDs | 
| SteamAPICall_t | ISteamUGC | StopPlaytimeTrackingForAllItems | ISteamUGC* self | 
| SteamAPICall_t | ISteamUGC | AddDependency | ISteamUGC* self, PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID | 
| SteamAPICall_t | ISteamUGC | RemoveDependency | ISteamUGC* self, PublishedFileId_t nParentPublishedFileID, PublishedFileId_t nChildPublishedFileID | 
| SteamAPICall_t | ISteamUGC | AddAppDependency | ISteamUGC* self, PublishedFileId_t nPublishedFileID, AppId_t nAppID | 
| SteamAPICall_t | ISteamUGC | RemoveAppDependency | ISteamUGC* self, PublishedFileId_t nPublishedFileID, AppId_t nAppID | 
| SteamAPICall_t | ISteamUGC | GetAppDependencies | ISteamUGC* self, PublishedFileId_t nPublishedFileID | 
| SteamAPICall_t | ISteamUGC | DeleteItem | ISteamUGC* self, PublishedFileId_t nPublishedFileID | 
| bool | ISteamUGC | ShowWorkshopEULA | ISteamUGC* self | 
| SteamAPICall_t | ISteamUGC | GetWorkshopEULAStatus | ISteamUGC* self | 
| uint32 | ISteamUGC | GetUserContentDescriptorPreferences | ISteamUGC* self, EUGCContentDescriptorID * pvecDescriptors, uint32 cMaxEntries | 
Note
This Wiki is work-in-progress. If you notice any errors or would like to add any missing information, changes are welcome.
   
  
   
  
About
Dev
Steamworks
Help
Links