C# Class Valve.Steamworks.CSteamUGC

Inheritance: ISteamUGC

Mostra file Open project: kronosaur/Transcendence

Public Methods

Method	Description
AddExcludedTag ( ulong handle, string pTagName ) : bool
AddItemKeyValueTag ( ulong handle, string pchKey, string pchValue ) : bool
AddItemToFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
AddRequiredKeyValueTag ( ulong handle, string pKey, string pValue ) : bool
AddRequiredTag ( ulong handle, string pTagName ) : bool
BInitWorkshopForGameServer ( uint unWorkshopDepotID, string pszFolder ) : bool
CSteamUGC ( IntPtr SteamUGC )
CreateItem ( uint nConsumerAppId, uint eFileType ) : ulong
CreateQueryAllUGCRequest ( uint eQueryType, uint eMatchingeMatchingUGCTypeFileType, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
CreateQueryUGCDetailsRequest ( ulong &pvecPublishedFileID, uint unNumPublishedFileIDs ) : ulong
CreateQueryUserUGCRequest ( uint unAccountID, uint eListType, uint eMatchingUGCType, uint eSortOrder, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
DownloadItem ( ulong nPublishedFileID, bool bHighPriority ) : bool
GetIntPtr ( ) : IntPtr
GetItemDownloadInfo ( ulong nPublishedFileID, ulong &punBytesDownloaded, ulong &punBytesTotal ) : bool
GetItemInstallInfo ( ulong nPublishedFileID, ulong &punSizeOnDisk, string &pchFolder, uint &punTimeStamp ) : bool
GetItemState ( ulong nPublishedFileID ) : uint
GetItemUpdateProgress ( ulong handle, ulong &punBytesProcessed, ulong &punBytesTotal ) : uint
GetNumSubscribedItems ( ) : uint
GetQueryUGCAdditionalPreview ( ulong handle, uint index, uint previewIndex, string &pchURLOrVideoID, bool &pbIsImage ) : bool
GetQueryUGCChildren ( ulong handle, uint index, ulong &pvecPublishedFileID, uint cMaxEntries ) : bool
GetQueryUGCKeyValueTag ( ulong handle, uint index, uint keyValueTagIndex, string &pchKey, string &pchValue ) : bool
GetQueryUGCMetadata ( ulong handle, uint index, string &pchMetadata ) : bool
GetQueryUGCNumAdditionalPreviews ( ulong handle, uint index ) : uint
GetQueryUGCNumKeyValueTags ( ulong handle, uint index ) : uint
GetQueryUGCPreviewURL ( ulong handle, uint index, string &pchURL ) : bool
GetQueryUGCResult ( ulong handle, uint index, SteamUGCDetails_t &pDetails ) : bool
GetQueryUGCStatistic ( ulong handle, uint index, uint eStatType, uint &pStatValue ) : bool
GetSubscribedItems ( ulong &pvecPublishedFileID, uint cMaxEntries ) : uint
GetUserItemVote ( ulong nPublishedFileID ) : ulong
ReleaseQueryUGCRequest ( ulong handle ) : bool
RemoveItemFromFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
RemoveItemKeyValueTags ( ulong handle, string pchKey ) : bool
RequestUGCDetails ( ulong nPublishedFileID, uint unMaxAgeSeconds ) : ulong
SendQueryUGCRequest ( ulong handle ) : ulong
SetAllowCachedResponse ( ulong handle, uint unMaxAgeSeconds ) : bool
SetCloudFileNameFilter ( ulong handle, string pMatchCloudFileName ) : bool
SetItemContent ( ulong handle, string pszContentFolder ) : bool
SetItemDescription ( ulong handle, string pchDescription ) : bool
SetItemMetadata ( ulong handle, string pchMetaData ) : bool
SetItemPreview ( ulong handle, string pszPreviewFile ) : bool
SetItemTags ( ulong updateHandle, SteamParamStringArray_t &pTags ) : bool
SetItemTitle ( ulong handle, string pchTitle ) : bool
SetItemUpdateLanguage ( ulong handle, string pchLanguage ) : bool
SetItemVisibility ( ulong handle, uint eVisibility ) : bool
SetLanguage ( ulong handle, string pchLanguage ) : bool
SetMatchAnyTag ( ulong handle, bool bMatchAnyTag ) : bool
SetRankedByTrendDays ( ulong handle, uint unDays ) : bool
SetReturnAdditionalPreviews ( ulong handle, bool bReturnAdditionalPreviews ) : bool
SetReturnChildren ( ulong handle, bool bReturnChildren ) : bool
SetReturnKeyValueTags ( ulong handle, bool bReturnKeyValueTags ) : bool
SetReturnLongDescription ( ulong handle, bool bReturnLongDescription ) : bool
SetReturnMetadata ( ulong handle, bool bReturnMetadata ) : bool
SetReturnTotalOnly ( ulong handle, bool bReturnTotalOnly ) : bool
SetSearchText ( ulong handle, string pSearchText ) : bool
SetUserItemVote ( ulong nPublishedFileID, bool bVoteUp ) : ulong
StartItemUpdate ( uint nConsumerAppId, ulong nPublishedFileID ) : ulong
SubmitItemUpdate ( ulong handle, string pchChangeNote ) : ulong
SubscribeItem ( ulong nPublishedFileID ) : ulong
SuspendDownloads ( bool bSuspend ) : void
UnsubscribeItem ( ulong nPublishedFileID ) : ulong

Private Methods

Method	Description
CheckIfUsable ( ) : void

Method Details

AddExcludedTag() public method

public AddExcludedTag ( ulong handle, string pTagName ) : bool
handle	ulong
pTagName	string
return	bool

AddItemKeyValueTag() public method

public AddItemKeyValueTag ( ulong handle, string pchKey, string pchValue ) : bool
handle	ulong
pchKey	string
pchValue	string
return	bool

AddItemToFavorites() public method

public AddItemToFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
nAppId	uint
nPublishedFileID	ulong
return	ulong

AddRequiredKeyValueTag() public method

public AddRequiredKeyValueTag ( ulong handle, string pKey, string pValue ) : bool
handle	ulong
pKey	string
pValue	string
return	bool

AddRequiredTag() public method

public AddRequiredTag ( ulong handle, string pTagName ) : bool
handle	ulong
pTagName	string
return	bool

BInitWorkshopForGameServer() public method

public BInitWorkshopForGameServer ( uint unWorkshopDepotID, string pszFolder ) : bool
unWorkshopDepotID	uint
pszFolder	string
return	bool

CSteamUGC() public method

public CSteamUGC ( IntPtr SteamUGC )
SteamUGC	System.IntPtr

CreateItem() public method

public CreateItem ( uint nConsumerAppId, uint eFileType ) : ulong
nConsumerAppId	uint
eFileType	uint
return	ulong

CreateQueryAllUGCRequest() public method

public CreateQueryAllUGCRequest ( uint eQueryType, uint eMatchingeMatchingUGCTypeFileType, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
eQueryType	uint
eMatchingeMatchingUGCTypeFileType	uint
nCreatorAppID	uint
nConsumerAppID	uint
unPage	uint
return	ulong

CreateQueryUGCDetailsRequest() public method

public CreateQueryUGCDetailsRequest ( ulong &pvecPublishedFileID, uint unNumPublishedFileIDs ) : ulong
pvecPublishedFileID	ulong
unNumPublishedFileIDs	uint
return	ulong

CreateQueryUserUGCRequest() public method

public CreateQueryUserUGCRequest ( uint unAccountID, uint eListType, uint eMatchingUGCType, uint eSortOrder, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
unAccountID	uint
eListType	uint
eMatchingUGCType	uint
eSortOrder	uint
nCreatorAppID	uint
nConsumerAppID	uint
unPage	uint
return	ulong

DownloadItem() public method

public DownloadItem ( ulong nPublishedFileID, bool bHighPriority ) : bool
nPublishedFileID	ulong
bHighPriority	bool
return	bool

GetIntPtr() public method

public GetIntPtr ( ) : IntPtr
return	System.IntPtr

GetItemDownloadInfo() public method

public GetItemDownloadInfo ( ulong nPublishedFileID, ulong &punBytesDownloaded, ulong &punBytesTotal ) : bool
nPublishedFileID	ulong
punBytesDownloaded	ulong
punBytesTotal	ulong
return	bool

GetItemInstallInfo() public method

public GetItemInstallInfo ( ulong nPublishedFileID, ulong &punSizeOnDisk, string &pchFolder, uint &punTimeStamp ) : bool
nPublishedFileID	ulong
punSizeOnDisk	ulong
pchFolder	string
punTimeStamp	uint
return	bool

GetItemState() public method

public GetItemState ( ulong nPublishedFileID ) : uint
nPublishedFileID	ulong
return	uint

GetItemUpdateProgress() public method

public GetItemUpdateProgress ( ulong handle, ulong &punBytesProcessed, ulong &punBytesTotal ) : uint
handle	ulong
punBytesProcessed	ulong
punBytesTotal	ulong
return	uint

GetNumSubscribedItems() public method

public GetNumSubscribedItems ( ) : uint
return	uint

GetQueryUGCAdditionalPreview() public method

public GetQueryUGCAdditionalPreview ( ulong handle, uint index, uint previewIndex, string &pchURLOrVideoID, bool &pbIsImage ) : bool
handle	ulong
index	uint
previewIndex	uint
pchURLOrVideoID	string
pbIsImage	bool
return	bool

GetQueryUGCChildren() public method

public GetQueryUGCChildren ( ulong handle, uint index, ulong &pvecPublishedFileID, uint cMaxEntries ) : bool
handle	ulong
index	uint
pvecPublishedFileID	ulong
cMaxEntries	uint
return	bool

GetQueryUGCKeyValueTag() public method

public GetQueryUGCKeyValueTag ( ulong handle, uint index, uint keyValueTagIndex, string &pchKey, string &pchValue ) : bool
handle	ulong
index	uint
keyValueTagIndex	uint
pchKey	string
pchValue	string
return	bool

GetQueryUGCMetadata() public method

public GetQueryUGCMetadata ( ulong handle, uint index, string &pchMetadata ) : bool
handle	ulong
index	uint
pchMetadata	string
return	bool

GetQueryUGCNumAdditionalPreviews() public method

public GetQueryUGCNumAdditionalPreviews ( ulong handle, uint index ) : uint
handle	ulong
index	uint
return	uint

GetQueryUGCNumKeyValueTags() public method

public GetQueryUGCNumKeyValueTags ( ulong handle, uint index ) : uint
handle	ulong
index	uint
return	uint

GetQueryUGCPreviewURL() public method

public GetQueryUGCPreviewURL ( ulong handle, uint index, string &pchURL ) : bool
handle	ulong
index	uint
pchURL	string
return	bool

GetQueryUGCResult() public method

public GetQueryUGCResult ( ulong handle, uint index, SteamUGCDetails_t &pDetails ) : bool
handle	ulong
index	uint
pDetails	SteamUGCDetails_t
return	bool

GetQueryUGCStatistic() public method

public GetQueryUGCStatistic ( ulong handle, uint index, uint eStatType, uint &pStatValue ) : bool
handle	ulong
index	uint
eStatType	uint
pStatValue	uint
return	bool

GetSubscribedItems() public method

public GetSubscribedItems ( ulong &pvecPublishedFileID, uint cMaxEntries ) : uint
pvecPublishedFileID	ulong
cMaxEntries	uint
return	uint

GetUserItemVote() public method

public GetUserItemVote ( ulong nPublishedFileID ) : ulong
nPublishedFileID	ulong
return	ulong

ReleaseQueryUGCRequest() public method

public ReleaseQueryUGCRequest ( ulong handle ) : bool
handle	ulong
return	bool

RemoveItemFromFavorites() public method

public RemoveItemFromFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
nAppId	uint
nPublishedFileID	ulong
return	ulong

RemoveItemKeyValueTags() public method

public RemoveItemKeyValueTags ( ulong handle, string pchKey ) : bool
handle	ulong
pchKey	string
return	bool

RequestUGCDetails() public method

public RequestUGCDetails ( ulong nPublishedFileID, uint unMaxAgeSeconds ) : ulong
nPublishedFileID	ulong
unMaxAgeSeconds	uint
return	ulong

SendQueryUGCRequest() public method

public SendQueryUGCRequest ( ulong handle ) : ulong
handle	ulong
return	ulong

SetAllowCachedResponse() public method

public SetAllowCachedResponse ( ulong handle, uint unMaxAgeSeconds ) : bool
handle	ulong
unMaxAgeSeconds	uint
return	bool

SetCloudFileNameFilter() public method

public SetCloudFileNameFilter ( ulong handle, string pMatchCloudFileName ) : bool
handle	ulong
pMatchCloudFileName	string
return	bool

SetItemContent() public method

public SetItemContent ( ulong handle, string pszContentFolder ) : bool
handle	ulong
pszContentFolder	string
return	bool

SetItemDescription() public method

public SetItemDescription ( ulong handle, string pchDescription ) : bool
handle	ulong
pchDescription	string
return	bool

SetItemMetadata() public method

public SetItemMetadata ( ulong handle, string pchMetaData ) : bool
handle	ulong
pchMetaData	string
return	bool

SetItemPreview() public method

public SetItemPreview ( ulong handle, string pszPreviewFile ) : bool
handle	ulong
pszPreviewFile	string
return	bool

SetItemTags() public method

public SetItemTags ( ulong updateHandle, SteamParamStringArray_t &pTags ) : bool
updateHandle	ulong
pTags	SteamParamStringArray_t
return	bool

SetItemTitle() public method

public SetItemTitle ( ulong handle, string pchTitle ) : bool
handle	ulong
pchTitle	string
return	bool

SetItemUpdateLanguage() public method

public SetItemUpdateLanguage ( ulong handle, string pchLanguage ) : bool
handle	ulong
pchLanguage	string
return	bool

SetItemVisibility() public method

public SetItemVisibility ( ulong handle, uint eVisibility ) : bool
handle	ulong
eVisibility	uint
return	bool

SetLanguage() public method

public SetLanguage ( ulong handle, string pchLanguage ) : bool
handle	ulong
pchLanguage	string
return	bool

SetMatchAnyTag() public method

public SetMatchAnyTag ( ulong handle, bool bMatchAnyTag ) : bool
handle	ulong
bMatchAnyTag	bool
return	bool

SetRankedByTrendDays() public method

public SetRankedByTrendDays ( ulong handle, uint unDays ) : bool
handle	ulong
unDays	uint
return	bool

SetReturnAdditionalPreviews() public method

public SetReturnAdditionalPreviews ( ulong handle, bool bReturnAdditionalPreviews ) : bool
handle	ulong
bReturnAdditionalPreviews	bool
return	bool

SetReturnChildren() public method

public SetReturnChildren ( ulong handle, bool bReturnChildren ) : bool
handle	ulong
bReturnChildren	bool
return	bool

SetReturnKeyValueTags() public method

public SetReturnKeyValueTags ( ulong handle, bool bReturnKeyValueTags ) : bool
handle	ulong
bReturnKeyValueTags	bool
return	bool

SetReturnLongDescription() public method

public SetReturnLongDescription ( ulong handle, bool bReturnLongDescription ) : bool
handle	ulong
bReturnLongDescription	bool
return	bool

SetReturnMetadata() public method

public SetReturnMetadata ( ulong handle, bool bReturnMetadata ) : bool
handle	ulong
bReturnMetadata	bool
return	bool

SetReturnTotalOnly() public method

public SetReturnTotalOnly ( ulong handle, bool bReturnTotalOnly ) : bool
handle	ulong
bReturnTotalOnly	bool
return	bool

SetSearchText() public method

public SetSearchText ( ulong handle, string pSearchText ) : bool
handle	ulong
pSearchText	string
return	bool

SetUserItemVote() public method

public SetUserItemVote ( ulong nPublishedFileID, bool bVoteUp ) : ulong
nPublishedFileID	ulong
bVoteUp	bool
return	ulong

StartItemUpdate() public method

public StartItemUpdate ( uint nConsumerAppId, ulong nPublishedFileID ) : ulong
nConsumerAppId	uint
nPublishedFileID	ulong
return	ulong

SubmitItemUpdate() public method

public SubmitItemUpdate ( ulong handle, string pchChangeNote ) : ulong
handle	ulong
pchChangeNote	string
return	ulong

SubscribeItem() public method

public SubscribeItem ( ulong nPublishedFileID ) : ulong
nPublishedFileID	ulong
return	ulong

SuspendDownloads() public method

public SuspendDownloads ( bool bSuspend ) : void
bSuspend	bool
return	void

UnsubscribeItem() public method

public UnsubscribeItem ( ulong nPublishedFileID ) : ulong
nPublishedFileID	ulong
return	ulong