C# Класс Valve.Steamworks.CSteamUGC

Наследование: ISteamUGC
Показать файл Открыть проект

Открытые методы

Метод Описание
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

Приватные методы

Метод Описание
CheckIfUsable ( ) : void

Описание методов

AddExcludedTag() публичный Метод

public AddExcludedTag ( ulong handle, string pTagName ) : bool
handle ulong
pTagName string
Результат bool

AddItemKeyValueTag() публичный Метод

public AddItemKeyValueTag ( ulong handle, string pchKey, string pchValue ) : bool
handle ulong
pchKey string
pchValue string
Результат bool

AddItemToFavorites() публичный Метод

public AddItemToFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
nAppId uint
nPublishedFileID ulong
Результат ulong

AddRequiredKeyValueTag() публичный Метод

public AddRequiredKeyValueTag ( ulong handle, string pKey, string pValue ) : bool
handle ulong
pKey string
pValue string
Результат bool

AddRequiredTag() публичный Метод

public AddRequiredTag ( ulong handle, string pTagName ) : bool
handle ulong
pTagName string
Результат bool

BInitWorkshopForGameServer() публичный Метод

public BInitWorkshopForGameServer ( uint unWorkshopDepotID, string pszFolder ) : bool
unWorkshopDepotID uint
pszFolder string
Результат bool

CSteamUGC() публичный Метод

public CSteamUGC ( IntPtr SteamUGC )
SteamUGC System.IntPtr

CreateItem() публичный Метод

public CreateItem ( uint nConsumerAppId, uint eFileType ) : ulong
nConsumerAppId uint
eFileType uint
Результат ulong

CreateQueryAllUGCRequest() публичный Метод

public CreateQueryAllUGCRequest ( uint eQueryType, uint eMatchingeMatchingUGCTypeFileType, uint nCreatorAppID, uint nConsumerAppID, uint unPage ) : ulong
eQueryType uint
eMatchingeMatchingUGCTypeFileType uint
nCreatorAppID uint
nConsumerAppID uint
unPage uint
Результат ulong

CreateQueryUGCDetailsRequest() публичный Метод

public CreateQueryUGCDetailsRequest ( ulong &pvecPublishedFileID, uint unNumPublishedFileIDs ) : ulong
pvecPublishedFileID ulong
unNumPublishedFileIDs uint
Результат ulong

CreateQueryUserUGCRequest() публичный Метод

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
Результат ulong

DownloadItem() публичный Метод

public DownloadItem ( ulong nPublishedFileID, bool bHighPriority ) : bool
nPublishedFileID ulong
bHighPriority bool
Результат bool

GetIntPtr() публичный Метод

public GetIntPtr ( ) : IntPtr
Результат System.IntPtr

GetItemDownloadInfo() публичный Метод

public GetItemDownloadInfo ( ulong nPublishedFileID, ulong &punBytesDownloaded, ulong &punBytesTotal ) : bool
nPublishedFileID ulong
punBytesDownloaded ulong
punBytesTotal ulong
Результат bool

GetItemInstallInfo() публичный Метод

public GetItemInstallInfo ( ulong nPublishedFileID, ulong &punSizeOnDisk, string &pchFolder, uint &punTimeStamp ) : bool
nPublishedFileID ulong
punSizeOnDisk ulong
pchFolder string
punTimeStamp uint
Результат bool

GetItemState() публичный Метод

public GetItemState ( ulong nPublishedFileID ) : uint
nPublishedFileID ulong
Результат uint

GetItemUpdateProgress() публичный Метод

public GetItemUpdateProgress ( ulong handle, ulong &punBytesProcessed, ulong &punBytesTotal ) : uint
handle ulong
punBytesProcessed ulong
punBytesTotal ulong
Результат uint

GetNumSubscribedItems() публичный Метод

public GetNumSubscribedItems ( ) : uint
Результат uint

GetQueryUGCAdditionalPreview() публичный Метод

public GetQueryUGCAdditionalPreview ( ulong handle, uint index, uint previewIndex, string &pchURLOrVideoID, bool &pbIsImage ) : bool
handle ulong
index uint
previewIndex uint
pchURLOrVideoID string
pbIsImage bool
Результат bool

GetQueryUGCChildren() публичный Метод

public GetQueryUGCChildren ( ulong handle, uint index, ulong &pvecPublishedFileID, uint cMaxEntries ) : bool
handle ulong
index uint
pvecPublishedFileID ulong
cMaxEntries uint
Результат bool

GetQueryUGCKeyValueTag() публичный Метод

public GetQueryUGCKeyValueTag ( ulong handle, uint index, uint keyValueTagIndex, string &pchKey, string &pchValue ) : bool
handle ulong
index uint
keyValueTagIndex uint
pchKey string
pchValue string
Результат bool

GetQueryUGCMetadata() публичный Метод

public GetQueryUGCMetadata ( ulong handle, uint index, string &pchMetadata ) : bool
handle ulong
index uint
pchMetadata string
Результат bool

GetQueryUGCNumAdditionalPreviews() публичный Метод

public GetQueryUGCNumAdditionalPreviews ( ulong handle, uint index ) : uint
handle ulong
index uint
Результат uint

GetQueryUGCNumKeyValueTags() публичный Метод

public GetQueryUGCNumKeyValueTags ( ulong handle, uint index ) : uint
handle ulong
index uint
Результат uint

GetQueryUGCPreviewURL() публичный Метод

public GetQueryUGCPreviewURL ( ulong handle, uint index, string &pchURL ) : bool
handle ulong
index uint
pchURL string
Результат bool

GetQueryUGCResult() публичный Метод

public GetQueryUGCResult ( ulong handle, uint index, SteamUGCDetails_t &pDetails ) : bool
handle ulong
index uint
pDetails SteamUGCDetails_t
Результат bool

GetQueryUGCStatistic() публичный Метод

public GetQueryUGCStatistic ( ulong handle, uint index, uint eStatType, uint &pStatValue ) : bool
handle ulong
index uint
eStatType uint
pStatValue uint
Результат bool

GetSubscribedItems() публичный Метод

public GetSubscribedItems ( ulong &pvecPublishedFileID, uint cMaxEntries ) : uint
pvecPublishedFileID ulong
cMaxEntries uint
Результат uint

GetUserItemVote() публичный Метод

public GetUserItemVote ( ulong nPublishedFileID ) : ulong
nPublishedFileID ulong
Результат ulong

ReleaseQueryUGCRequest() публичный Метод

public ReleaseQueryUGCRequest ( ulong handle ) : bool
handle ulong
Результат bool

RemoveItemFromFavorites() публичный Метод

public RemoveItemFromFavorites ( uint nAppId, ulong nPublishedFileID ) : ulong
nAppId uint
nPublishedFileID ulong
Результат ulong

RemoveItemKeyValueTags() публичный Метод

public RemoveItemKeyValueTags ( ulong handle, string pchKey ) : bool
handle ulong
pchKey string
Результат bool

RequestUGCDetails() публичный Метод

public RequestUGCDetails ( ulong nPublishedFileID, uint unMaxAgeSeconds ) : ulong
nPublishedFileID ulong
unMaxAgeSeconds uint
Результат ulong

SendQueryUGCRequest() публичный Метод

public SendQueryUGCRequest ( ulong handle ) : ulong
handle ulong
Результат ulong

SetAllowCachedResponse() публичный Метод

public SetAllowCachedResponse ( ulong handle, uint unMaxAgeSeconds ) : bool
handle ulong
unMaxAgeSeconds uint
Результат bool

SetCloudFileNameFilter() публичный Метод

public SetCloudFileNameFilter ( ulong handle, string pMatchCloudFileName ) : bool
handle ulong
pMatchCloudFileName string
Результат bool

SetItemContent() публичный Метод

public SetItemContent ( ulong handle, string pszContentFolder ) : bool
handle ulong
pszContentFolder string
Результат bool

SetItemDescription() публичный Метод

public SetItemDescription ( ulong handle, string pchDescription ) : bool
handle ulong
pchDescription string
Результат bool

SetItemMetadata() публичный Метод

public SetItemMetadata ( ulong handle, string pchMetaData ) : bool
handle ulong
pchMetaData string
Результат bool

SetItemPreview() публичный Метод

public SetItemPreview ( ulong handle, string pszPreviewFile ) : bool
handle ulong
pszPreviewFile string
Результат bool

SetItemTags() публичный Метод

public SetItemTags ( ulong updateHandle, SteamParamStringArray_t &pTags ) : bool
updateHandle ulong
pTags SteamParamStringArray_t
Результат bool

SetItemTitle() публичный Метод

public SetItemTitle ( ulong handle, string pchTitle ) : bool
handle ulong
pchTitle string
Результат bool

SetItemUpdateLanguage() публичный Метод

public SetItemUpdateLanguage ( ulong handle, string pchLanguage ) : bool
handle ulong
pchLanguage string
Результат bool

SetItemVisibility() публичный Метод

public SetItemVisibility ( ulong handle, uint eVisibility ) : bool
handle ulong
eVisibility uint
Результат bool

SetLanguage() публичный Метод

public SetLanguage ( ulong handle, string pchLanguage ) : bool
handle ulong
pchLanguage string
Результат bool

SetMatchAnyTag() публичный Метод

public SetMatchAnyTag ( ulong handle, bool bMatchAnyTag ) : bool
handle ulong
bMatchAnyTag bool
Результат bool

SetRankedByTrendDays() публичный Метод

public SetRankedByTrendDays ( ulong handle, uint unDays ) : bool
handle ulong
unDays uint
Результат bool

SetReturnAdditionalPreviews() публичный Метод

public SetReturnAdditionalPreviews ( ulong handle, bool bReturnAdditionalPreviews ) : bool
handle ulong
bReturnAdditionalPreviews bool
Результат bool

SetReturnChildren() публичный Метод

public SetReturnChildren ( ulong handle, bool bReturnChildren ) : bool
handle ulong
bReturnChildren bool
Результат bool

SetReturnKeyValueTags() публичный Метод

public SetReturnKeyValueTags ( ulong handle, bool bReturnKeyValueTags ) : bool
handle ulong
bReturnKeyValueTags bool
Результат bool

SetReturnLongDescription() публичный Метод

public SetReturnLongDescription ( ulong handle, bool bReturnLongDescription ) : bool
handle ulong
bReturnLongDescription bool
Результат bool

SetReturnMetadata() публичный Метод

public SetReturnMetadata ( ulong handle, bool bReturnMetadata ) : bool
handle ulong
bReturnMetadata bool
Результат bool

SetReturnTotalOnly() публичный Метод

public SetReturnTotalOnly ( ulong handle, bool bReturnTotalOnly ) : bool
handle ulong
bReturnTotalOnly bool
Результат bool

SetSearchText() публичный Метод

public SetSearchText ( ulong handle, string pSearchText ) : bool
handle ulong
pSearchText string
Результат bool

SetUserItemVote() публичный Метод

public SetUserItemVote ( ulong nPublishedFileID, bool bVoteUp ) : ulong
nPublishedFileID ulong
bVoteUp bool
Результат ulong

StartItemUpdate() публичный Метод

public StartItemUpdate ( uint nConsumerAppId, ulong nPublishedFileID ) : ulong
nConsumerAppId uint
nPublishedFileID ulong
Результат ulong

SubmitItemUpdate() публичный Метод

public SubmitItemUpdate ( ulong handle, string pchChangeNote ) : ulong
handle ulong
pchChangeNote string
Результат ulong

SubscribeItem() публичный Метод

public SubscribeItem ( ulong nPublishedFileID ) : ulong
nPublishedFileID ulong
Результат ulong

SuspendDownloads() публичный Метод

public SuspendDownloads ( bool bSuspend ) : void
bSuspend bool
Результат void

UnsubscribeItem() публичный Метод

public UnsubscribeItem ( ulong nPublishedFileID ) : ulong
nPublishedFileID ulong
Результат ulong