Funzioni per creare, consumare e interagire con il Workshop di Steam.

Funzioni membro

Le funzioni membro per ISteamUGC vengono chiamate tramite la funzione globale di accesso SteamUGC().

AddAppDependency

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto.
nAppID	AppId_t	L'app/DLC richiesti.

Aggiunge una dipendenza tra l'oggetto e l'appID. La lista delle dipendenze può essere recuperata chiamando GetAppDependencies. Si tratta di una dipendenza leggera mostrata sul web. Sta all'applicazione determinare se l'oggetto possa essere utilizzato o meno.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a AddAppDependencyResult_t.

Vedi anche: RemoveAppDependency

AddDependency

Nome	Tipo	Descrizione
nParentPublishedFileID	PublishedFileId_t	L'oggetto del Workshop a cui aggiungere una dipendenza.
nChildPublishedFileID	PublishedFileId_t	La dipendenza da aggiungere all'elemento principale.

Aggiunge un oggetto del Workshop come dipendenza all'oggetto specificato. Se l'oggetto nParentPublishedFileID è di tipo k_EWorkshopFileTypeCollection, allora il nChildPublishedFileID viene semplicemente aggiunto alla collezione. In caso contrario, si tratta di una dipendenza leggera mostrata sul web che può essere recuperata tramite l'API ISteamUGC utilizzando una combinazione della variabile membro m_unNumChildren della struttura SteamUGCDetails_t e di GetQueryUGCChildren.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a AddUGCDependencyResult_t.


Vedi anche: RemoveDependency

AddExcludedTag

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
pTagName	const char *	L'etichetta che NON deve essere allegata all'UGC per riceverlo.

Aggiunge una tag esclusa a una query UGC in sospeso, che restituirà solo gli UGC senza l'etichetta specificata.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido, se proviene da CreateQueryUGCDetailsRequest, o se pTagName era NULL.

Vedi anche: AddRequiredTag, SetMatchAnyTag, SetItemTags

AddItemKeyValueTag

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pchKey	const char *	La chiave da impostare sull'oggetto.
pchValue	const char *	Un valore da mappare sulla chiave.

Aggiunge una coppia di etichette chiave/valore a un oggetto. Le chiavi possono mappare a più valori diversi (rapporto di 1 a molti).

I nomi delle chiavi devono essere espressi in caratteri alfanumerici e il simbolo "_".

Nè le chiavi nè i valori possono essere più lunghi di 255 caratteri.

Le etichette chiave/valore possono essere trovate solo in caso di corrispondenza esatta.

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido, se pchKey o pchValue non sono validi in quanto NULL o se sono più lunghi del limite dei caratteri consentiti, o se stai provando ad aggiungere più di 100 etichette chiave/valore in un singolo aggiornamento.

Vedi anche: RemoveItemKeyValueTags, SetReturnKeyValueTags, GetQueryUGCNumKeyValueTags, GetQueryUGCKeyValueTag

AddItemPreviewFile

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pszPreviewFile	const char *	Percorso completo dell'immagine locale.
tipo	EItemPreviewType	Il tipo di questa anteprima.

Aggiunge un ulteriore file di anteprima dell'oggetto.

L'immagine dovrebbe essere in un formato visualizzabile sia da web che sull'applicazione (se necessario) e deve avere dimensioni inferiori a 1 MB. Suggeriamo i formati JPG, PNG e GIF.

NOTA: l'utilizzo di k_EItemPreviewType_YouTubeVideo o k_EItemPreviewType_Sketchfab non è al momento supportato con questa API. Per i video di YouTube, utilizza AddItemPreviewVideo.

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

Vedi anche: GetQueryUGCNumAdditionalPreviews, GetQueryUGCAdditionalPreview, SetReturnAdditionalPreviews, UpdateItemPreviewFile, AddItemPreviewVideo, RemoveItemPreview

AddItemPreviewVideo

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pszVideoID	const char *	L'ID del video di YouTube da aggiungere. (e.g. "jHgZh4GV9G0")

Aggiunge un ulteriore video di anteprima dell'oggetto da YouTube.

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

Vedi anche: GetQueryUGCNumAdditionalPreviews, GetQueryUGCAdditionalPreview, SetReturnAdditionalPreviews, UpdateItemPreviewVideo, AddItemPreviewFile, RemoveItemPreview

AddItemToFavorites

Nome	Tipo	Descrizione
nAppId	AppId_t	L'ID dell'app a cui appartiene questo oggetto.
nPublishedFileID	PublishedFileId_t	L'oggetto del Workshop da aggiungere alla lista dei preferiti dell'utente.

Aggiunge un oggetto del Workshop alla lista dei preferiti dell'utente.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a UserFavoriteItemsListChanged_t.


Vedi anche: RemoveItemFromFavorites

AddRequiredKeyValueTag

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
pKey	const char *	La chiave della coppia chiave/valore da allegare all'UGC per riceverlo.
pValue	const char *	Il valore della coppia chiave/valore associato con pKey da allegare all'UGC per riceverlo.

Aggiunge un'etichetta chiave/valore obbligatoria a una query UGC in sospeso, che restituirà solamente gli oggetti del Workshop dotati di una chiave pKey e un valore pValue.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido o se pKey o pValue sono NULL.

AddRequiredTag

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
pTagName	const char *	L'etichetta deve essere allegata all'UGC per riceverlo.

Aggiunge un'etichetta obbligatoria a una query UGC in sospeso, che restituirà solo UGC con l'etichetta specificata.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido, se proviene da CreateQueryUGCDetailsRequest, o se pTagName era NULL.

Vedi anche: AddExcludedTag, SetMatchAnyTag, SetItemTags

AddRequiredTagGroup

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
pTags	const SteamParamStringArray_t *	Un insieme di etichette, di cui almeno una deve essere allegata all'UGC.

Aggiunge il requisito che gli oggetti restituiti dalla query UGC in corso abbiano almeno una delle etichette nell'insieme specificato ("or" logico). Per ciascun gruppo di etichette aggiunto, almeno un'etichetta di ciascun gruppo deve appartenere agli oggetti corrispondenti.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido, se proviene da CreateQueryUGCDetailsRequest o se pTagName era NULL.

Vedi anche: AddRequiredTag, AddExcludedTag

BInitWorkshopForGameServer

Nome	Tipo	Descrizione
unWorkshopDepotID	DepotId_t	L'ID del depot del server di gioco.
pszFolder	const char *	Il percorso completo in cui memorizzare il contenuto del Workshop.

Consente ai server di gioco di impostare una cartella specifica per il Workshop prima di inviare comandi UGC.

È utile per supportare l'utilizzo della stessa cartella di installazione da parte di diversi server di gioco.

Restituisce: bool
true se valido. Restituisce false se l'utente che effettua la chiamata non è un server di gioco o se il Workshop sta aggiornando il suo contenuto.

CreateItem

Nome	Tipo	Descrizione
nConsumerAppId	AppId_t	L'appID che utilizzerà questo oggetto.
eFileType	EWorkshopFileType	Il tipo di UGC da creare.

Crea un nuovo oggetto del Workshop senza alcun contenuto allegato.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a CreateItemResult_t.


Vedi anche: Creazione di un contenuto per il Workshop

CreateQueryAllUGCRequest

Nome	Tipo	Descrizione
eQueryType	EUGCQuery	Utilizzata per specificare l'organizzazione e i filtri di questa chiamata.
eMatchingeMatchingUGCTypeFileType	EUGCMatchingUGCType	Utilizzata per specificare il tipo di UGC oggetto della query.
nCreatorAppID	AppId_t	Dovrebbe contenere l'appID dell'applicazione in cui è stato creato l'oggetto. Potrebbe essere diverso da nConsumerAppID se lo strumento con cui hai creato l'oggetto ha un appID separato.
nConsumerAppID	AppId_t	Dovrebbe contenere l'appID del gioco o applicazione correnti. Se l'appID dello strumento di creazione del contenuto del Workshop è separato, non passarlo al metodo!
unPage	uint32	Il numero di pagina dei risultati da ricevere. Dovrebbe cominciare da 1 nella prima chiamata.

Query per tutti gli UGC corrispondenti. Puoi utilizzare questo metodo per ottenere l'elenco di tutti gli UGC disponibili per l'applicazione.

Restituirà fino a 50 risultati, come dichiarati da kNumUGCResultsPerPage. Puoi chiamare questa funzione altre volte successivamente, aumentando ogni volta unPage per ottenere l'insieme di risultati seguente.

NOTA: nConsumerAppID o nCreatorAppID devono avere un appID valido!

NOTA: quando hai finito, devi rilasciare l'handle restituito da questa funzione chiamando ReleaseQueryUGCRequest!

Per le query agli UGC associati a un singolo utente, puoi utilizzare CreateQueryUserUGCRequest.

Restituisce: UGCQueryHandle_t
restituisce una nuova UGCQueryHandle_t in caso di esito positivo e k_UGCQueryHandleInvalid nelle seguenti situazioni:

• nCreatorAppID o nConsumerAppID non sono impostati nell'app al momento in esecuzione.
  
• unPage era minore di 1.
  
• Errore interno.

Questo handle può essere utilizzato per personalizzare ulteriormente la query prima di inviarla con SendQueryUGCRequest.

Vedi anche: ISteamUtils::GetAppID

CreateQueryUGCDetailsRequest

Nome	Tipo	Descrizione
pvecPublishedFileID	PublishedFileId_t *	La listsa degli oggetti del Workshop di cui ottenere i dettagli.
unNumPublishedFileIDs	uint32	Il numero di oggetti in pvecPublishedFileID.

Query per i dettagli di specifici oggetti degli UGC. Al momento è possibile richiedere un massimo di 1.000 oggetti, ma questo limite potrebbe essere rimosso in futuro.

Nota: questa API è normalmente usata per recuperare i metadati relativi agli UGC a scopo di visualizzazione. È buona prassi tenere la lista degli oggetti corta, in modo che corrisponda alla tua interfaccia utente. Gli oggetti a cui ci si iscrive dovrebbero avere abbastanza informazioni per essere usati, disponibili tramite:

• GetNumSubscribedItems
  
• GetSubscribedItems
  
• GetItemState
  
• GetItemInstallInfo

NOTA: nConsumerAppID o nCreatorAppID devono avere un appID valido!

NOTA: quando hai finito, devi rilasciare l'handle restituito da questa funzione chiamando ReleaseQueryUGCRequest!

Per effettuare una query a tutti gli UGC della tua app, puoi usare CreateQueryAllUGCRequest.

Restituisce: UGCQueryHandle_t
restituisce una nuova UGCQueryHandle_t in caso di esito positivo e k_UGCQueryHandleInvalid nelle seguenti situazioni:

• unNumPublishedFileIDs è minore di 1.
  
• Errore interno.

Questo handle può essere utilizzato per personalizzare ulteriormente la query prima di inviarla con SendQueryUGCRequest.

CreateQueryUserUGCRequest

Nome	Tipo	Descrizione
unAccountID	AccountID_t	L'ID dell'account per cui effettuare la query dell'UGC. Puoi utilizzare CSteamID.GetAccountID per ottenere l'ID dell'account da un'ID di Steam.
eListType	EUserUGCList	Utilizzata per specificare il tipo di lista da ottenere. Se l'utente che ha effettuato l'accesso è diverso da quello specificato in unAccountID, alcune opzioni non saranno consentite. (k_EUserUGCList_VotedOn, k_EUserUGCList_VotedUp, k_EUserUGCList_VotedDown, k_EUserUGCList_WillVoteLater, k_EUserUGCList_Subscribed)
eMatchingUGCType	EUGCMatchingUGCType	Utilizzata per specificare il tipo di UGC oggetto della query.
eSortOrder	EUserUGCListSortOrder	Utilizzata per specificare in quale ordine sarà ordinata la lista.
nCreatorAppID	AppId_t	Dovrebbe contenere l'appID dell'applicazione in cui è stato creato l'oggetto. Potrebbe essere diverso da nConsumerAppID se lo strumento con cui hai creato l'oggetto ha un appID separato.
nConsumerAppID	AppId_t	Dovrebbe contenere l'appID del gioco o applicazione correnti. Non trasmettere l'appID dello strumento di creazione del contenuto del Workshop se ha un appID diverso!
unPage	uint32	Il numero di pagina dei risultati da ricevere. Dovrebbe cominciare da 1 nella prima chiamata.

Query UGC associata a un utente. Puoi utilizzare questo metodo per ottenere l'elenco degli UGC a cui l'utente si è sottoscritto.

Restituirà fino a 50 risultati, come dichiarati da kNumUGCResultsPerPage. Puoi chiamare questa funzione altre volte successivamente, aumentando ogni volta unPage per ottenere l'insieme di risultati seguente.

NOTA: nConsumerAppID o nCreatorAppID devono avere un appID valido!

NOTA: quando hai finito, devi rilasciare l'handle restituito da questa funzione chiamando ReleaseQueryUGCRequest!

Per effettuare una query a tutti gli UGC della tua app, puoi usare CreateQueryAllUGCRequest.

Restituisce: UGCQueryHandle_t
restituisce una nuova UGCQueryHandle_t in caso di esito positivo e k_UGCQueryHandleInvalid nelle seguenti situazioni:

• nCreatorAppID o nConsumerAppID non sono impostati nell'app al momento in esecuzione.
  
• unPage era minore di 1.
  
• L'eListType fornito non è supportati per utenti diversi da quello che ha richiesto i dettagli.
  
• Errore interno.

Questo handle può essere utilizzato per personalizzare ulteriormente la query prima di inviarla con SendQueryUGCRequest.

Vedi anche: ISteamUtils::GetAppID

DeleteItem

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto da eliminare.

Eliminare l'oggetto senza avvertire l'utente.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a DeleteItemResult_t.

DownloadItem

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto del Workshop da scaricare.
bHighPriority	bool	Inizia il download in modalità ad alta priorità, mettendo in pausa eventuali altri download di Steam in corso e iniziando a scaricare immediatamente questo oggetto del Workshop.

Scarica o aggiorna un oggetto del Workshop.

Se il valore restituito è true, registra e attendi la callback DownloadItemResult_t prima di effettuare la chiamata a GetItemInstallInfo o di accedere all'oggetto del Workshop su disco.

Se l'utente non si è sottoscritto all'oggetto (se si tratta ad esempio di un server di gioco con accesso anonimo), l'oggetto del Workshop verrà scaricato e memorizzato temporaneamente nella cache.

Se l'oggetto del Workshop presenta uno stato dell'oggetto di k_EItemStateNeedsUpdate, questa funzione può essere chiamata per avviare l'aggiornamento. Non accedere all'oggetto del Workshop su disco finché la callback DownloadItemResult_t non viene inviata.

La callback DownloadItemResult_t contiene l'appID associato all'oggetto del Workshop. Deve essere confrontato con l'ID dell'applicazione in esecuzione in quanto l'handler verrà chiamato per tutti i download degli oggetti indipendentemente dall'applicazione in esecuzione.

Restituisce: bool
provoca una callback DownloadItemResult_t.
true se il download si è avviato correttamente, altrimenti false se nPublishedFileID non è valido o se l'utente non ha effettuato l'accesso.

GetAppDependencies

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto del Workshop per cui ottenere le dipendenze dell'app.

Ottiene le dipendenze dell'app associate al dato PublishedFileId_t. Si tratta di dipendenze "leggere" che vengono mostrate sul web. Sta all'applicazione determinare se un oggetto possa essere utilizzato o meno.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a GetAppDependenciesResult_t.

Vedi anche: AddAppDependency, RemoveAppDependency

GetItemDownloadInfo

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto del Workshop per cui ottenere le informazioni di download.
punBytesDownloaded	uint64 *	Restistuisce i byte scaricati al momento.
punBytesTotal	uint64 *	Restituisce i byte totali. Valido solo dopo l'inizio del download.

Ottiene informazioni su un download in attesa di un oggetto del Workshop con k_EItemStateNeedsUpdate impostato.

Restituisce: bool
true se le informazioni sul download erano disponibili. Altrimenti, false.

GetItemInstallInfo

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto del Workshop per cui ottenere le informazioni sull'installazione.
punSizeOnDisk	uint64 *	Restituisce le dimensioni in byte dell'oggetto del Workshop.
pchFolder	char *	Restituisce, copiandolo, il percorso completo della cartella dei contenuti.
cchFolderSize	uint32	Le dimensioni in byte di pchFolder.
punTimeStamp	uint32 *	Restituisce l'orario in cui l'oggetto del Workshop è stato aggiornato per l'ultima volta.

Ottiene informazioni sui contenuti al momento installati sul disco per gli oggetti del Workshop con k_EItemStateInstalled impostato.

Questa chiamata imposta il contrassegno "used" sull'oggetto del Workshop dell'utente corrente e lo aggiunge alla sua lista k_EUserUGCList_UsedOrPlayed.

Se k_EItemStateLegacyItem è impostato, allora pchFolder contiene il percorso del file legacy stesso, non della cartella.

Restituisce: bool
true se l'oggetto del Workshop è già installato.
false nei seguenti casi:

• cchFolderSize è 0.
  
• L'oggetto del Workshop non presenta contenuti.
  
• L'oggetto del Workshop non è installato.

GetItemState

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto del Worskhop per cui ottenere lo stato.

Ottiene lo stato corrente di un oggetto del Workshop su questo client.

Restituisce: uint32
Restituisce lo stato dell'oggetto. Dovrebbe essere utilizzato con i contrassegni EItemState per determinare lo stato dell'oggetto del Workshop.

Esempio:

GetItemUpdateProgress

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento per cui ottenere i progressi.
punBytesProcessed	uint64 *	Restituisce il numero di byte caricati al momento.
punBytesTotal	uint64 *	Restituisce il numero totale di byte che saranno caricati.

Ottiene il progresso dell'aggiornamento di un oggetto.

Restituisce: EItemUpdateStatus
lo stato corrente.

Vedi anche: SubmitItemUpdate

GetNumSubscribedItems

Ottiene il numero totale di oggetti di un gioco o di un'applicazione a cui l'utente attuale si è sottoscritto.

Restituisce: uint32
restituisce 0 se chiamato da un server di gioco.

GetQueryUGCAdditionalPreview

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
previewIndex	uint32	L'indice dell'anteprima addizionale per cui ottenere i dettagli.
pchURLOrVideoID	char *	Restituisce un URL o un ID di un video copiandoli in questa stringa.
cchURLSize	uint32	Le dimensioni in byte di pchURLOrVideoID.
pchOriginalFileName	char *	Restituisce il nome originale del file. Può essere impostato su NULL per non riceverlo.
cchOriginalFileNameSize	uint32	Le dimensioni in byte di pchOriginalFileName.
pPreviewType	EItemPreviewType *	Il tipo di anteprima restituita.

Recupera i dettagli di un'anteprima aggiuntiva associata a un oggetto del Workshop individuale dopo aver ricevuto il risultato di una chiamata query UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Prima di effettuare questa chiamata, chiama GetQueryUGCNumAdditionalPreviews per ottenere il numero di anteprime aggiuntive.

Restituisce: bool
true se ha esito positivo, indica che pchURLOrVideoID e pPreviewType sono stati riempiti.
Altrimenti, false se l'handle della query UGC non è valido, se index è oltre il limite o se previewIndex è oltre il limite.

GetQueryUGCChildren

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
pvecPublishedFileID	PublishedFileId_t *	Restituisce gli UGC secondari impostando questa matrice.
cMaxEntries	uint32	La lunghezza di pvecPublishedFileID.

Recupera gli ID di eventuali oggetti secondari di un oggetto individuale del Workshop dopo aver ricevuto un risultato della chiamata di query degli UGC. Questi oggetti possono fare parte di una collezione o di qualche altra dipendenza (vedi AddDependency).

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Crea pvecPublishedFileID con m_unNumChildren inserito in SteamUGCDetails_t dopo aver ottenuto i dettagli UGC con GetQueryUGCResult.

Restituisce: bool
true se ha esito positivo, indica che pvecPublishedFileID è stato riempito.
Altrimenti restituisce false se l'handle della query UGC non è valido o se l'index è oltre il limite.

GetQueryUGCNumTags

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.

Disponibile in SDK v1.51.

Recupera il numero di etichette di un oggetto individuale del Workshop dopo aver ricevuto un risultato della chiamata di query degli UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

A questo punto puoi chiamare GetQueryUGCTag per ottenere il nome dell'etichetta o GetQueryUGCTagDisplayName per ottenere la stringa dell'etichetta tradotta (se esistente).

Restituisce: uint32
il numero di etichette chiave/valore associate all'oggetto del Workshop specificato.
Restituisce 0 se l'handle della query UGC non è valido o se l'index è oltre il limite.

GetQueryUGCTag

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
tagIndex	uint32	L'indice dell'etichetta.
pchValue	char *	Restituisce il valore copiandolo in questa stringa.
cchValueSize	uint32	Le dimensioni in byte di pchValue (alloca almeno 64 byte).

Disponibile in SDK v1.51.

Recupera l'etichetta "nth" associata a un oggetto individuale del Workshop dopo aver ricevuto il risultato di una chiamata query UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Prima di effettuare questa chiamata, chiama GetQueryUGCNumTags per ottenere il numero di etichette.

GetQueryUGCTagDisplayName

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
tagIndex	uint32	L'indice dell'etichetta.
pchValue	char *	Restituisce il valore copiandolo in questa stringa.
cchValueSize	uint32	Le dimensioni in byte di pchValue (alloca almeno 256 byte).

Disponibile in SDK v1.51.

Recupera la stringa di visualizzazione "nth" (solitamente localizzata) per un'etichetta, associata a un oggetto individuale del Workshop dopo aver ricevuto il risultato di una chiamata query UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Prima di effettuare questa chiamata, chiama GetQueryUGCNumTags per ottenere il numero di etichette.

GetQueryUGCKeyValueTag

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
keyValueTagIndex	uint32	L'indice dell'etichetta per cui ottenere i dettagli.
pchKey	char *	Restituisce la chiave copiandola in questsa stringa.
cchKeySize	uint32	Le dimensioni in byte di pchKey.
pchValue	char *	Restituisce il valore copiandolo in questa stringa.
cchValueSize	uint32	Le dimensioni in byte di pchValue.

Recupera i dettagli di un'etichetta chiave/valore associata a un oggetto individuale del Workshop dopo aver ricevuto il risultato di una chiamata query UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Prima di effettuare questa chiamata, chiama GetQueryUGCNumKeyValueTags per ottenere il numero di etichette.

Restituisce: bool
true se ha esito positivo, indica che pchKey e pchValue sono stati riempiti.
Altrimenti, false se l'handle della query UGC non è valido, se index è oltre il limite o se keyValueTagIndex è oltre il limite.

GetQueryUGCContentDescriptors

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
pvecDescriptors	EUGCContentDescriptorID	Un array di EUGCContentDescriptorID da riempire.
cMaxEntries	uint32	Dimensione dell'array pvecDescriptors

Recupera un array di EUGCContentDescriptorID impostato sull'elemento.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Restituisce: uint32
Restituisce il numero di EUGCContentDescriptorID impostato sull'elemento.

Vedi anche: AddContentDescriptor, RemoveContentDescriptor

GetQueryUGCMetadata

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
pchMetadata	char *	Restituisce l'URL copiandolo in questa stringa.
cchMetadatasize	uint32	Le dimensioni in byte di pchMetadata.

Recupera i metadati impostati dallo sviluppatore di un oggetto individuale del Workshop dopo aver ricevuto un risultato della chiamata di query degli UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Restituisce: bool
true se ha esito positivo, indica che pchMetadata è stato riempito.
Altrimenti, false se l'handle della query UGC non è valido o se l'index è oltre il limite.

Vedi anche: SetItemMetadata

GetQueryUGCNumAdditionalPreviews

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.

Recupera il numero di anteprime aggiuntive di un oggetto individuale del Workshop dopo aver ricevuto un risultato della chiamata di query degli UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Potrai quindi chiamare GetQueryUGCAdditionalPreview per ottenere i dettagli di ciascuna anteprima aggiuntiva.

Restituisce: uint32
il numero di anteprime aggiuntive associate all'oggetto del Workshop specificato.
Restituisce 0 se l'handle della query UGC non è valido o se l'index è oltre il limite.

GetQueryUGCNumKeyValueTags

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.

Recupera il numero di etichette chiave/valore di un oggetto individuale del Workshop dopo aver ricevuto un risultato della chiamata di query degli UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Potrai quindi chiamare GetQueryUGCKeyValueTag per ottenere i dettagli di ciascuna etichetta.

Restituisce: uint32
il numero di etichette chiave/valore associate all'oggetto del Workshop specificato.
Restituisce 0 se l'handle della query UGC non è valido o se l'index è oltre il limite.

GetQueryUGCPreviewURL

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
pchURL	char *	Restituisce i metadati copiandoli in questa stringa.
cchURLSize	uint32	Le dimensioni in byte di pchURL.

Recupera l'URL dell'immagine di anteprima di un oggetto individuale del Workshop dopo aver ricevuto un risultato della chiamata di query degli UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Puoi utilizzare questo URL per scaricare e mostrare l'immagine di anteprima invece di doverla scaricare utilizzando m_hPreviewFile nella struttura ISteamUGC::SteamUGCDetails_t.

Restituisce: bool
true se ha esito positivo, indica che pchURL è stato riempito.
Altrimenti restituisce false se l'handle della query UGC non è valido o se l'index è oltre il limite.

GetQueryUGCResult

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
pDetails	SteamUGCDetails_t *	Restituisce i dettagli degli UGC.

Recupera i dettagli di un oggetto individuale del Workshop dopo aver ricevuto un risultato della chiamata di query degli UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Restituisce: bool
true se ha esito positivo, indica che pDetails è stato riempito.
Altrimenti, false se l'handle della query UGC non è valido o se l'index è oltre il limite.

GetQueryUGCStatistic

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della query UGC da cui ottenere i risultati.
index	uint32	L'indice dell'oggetto per cui ottenere i dettagli.
eStatType	EItemStatistic	La statistica da recuperare.
pStatValue	uint64 *	Restituisce il valore associato alla statistica specificata.

Recupera varie statistiche di un oggetto individuale del Workshop dopo aver ricevuto un risultato della chiamata di query degli UGC.

Ripeti questa chiamata più volte per ottenere i dettagli di tutti gli oggetti del Workshop restituiti.

NOTA: chiamata da effettuare solo con l'handle ottenuto da una chiamata a SteamUGCQueryCompleted_t dall'esito positivo.

Restituisce: bool
true se ha esito positivo, indica che pStatValue è stato riempito.
Altrimenti, false se l'handle della query UGC non è valido, se index è oltre i limiti o se eStatType non è valido.

GetSubscribedItems

Nome	Tipo	Descrizione
pvecPublishedFileID	PublishedFileId_t *	La matrice in cui verranno copiati gli ID dell'oggetto.
cMaxEntries	uint32	Il numero massimo di oggetti da restituire. Dovrebbe essere lo stesso di GetNumSubscribedItems e le stesse dimensioni di pvecPublishedFileID.

Ottiene un elenco di tutti gli oggetti a cui l'utente attuale si è sottoscritto per il gioco in questione.

Puoi creare una matrice con la dimensione fornita da GetNumSubscribedItems prima di effettuare questa chiamata.

Restituisce: uint32
il numero di oggetti del Worskhop a cui si è sottoscritti che sono stati inseriti in pvecPublishedFileID.
Restituisce 0 se chiamato da un server di gioco.

GetUserItemVote

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'ID dell'oggetto del Workshop per cui ottenere il voto dell'utente.

Ottiene lo stato del voto dell'utente per un oggetto del Workshop.

Restituisce: SteamAPICall_t da utilizzare con risultato della chiamata a GetUserItemVoteResult_t.


Vedi anche: SetUserItemVote

ReleaseQueryUGCRequest

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da rilasciare.

Rilascia un handle di una query UGC quando hai finito di usarlo per liberare memoria.

Restituisce: bool
Restituisce sempre true.

RemoveAppDependency

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto.
nAppID	AppId_t	L'applicazione/DLC.

Rimuove la dipendenza tra l'oggetto e l'appID. La lista delle dipendenze può essere recuperata chiamando GetAppDependencies.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a RemoveAppDependencyResult_t.

Vedi anche: AddAppDependency

RemoveDependency

Nome	Tipo	Descrizione
nParentPublishedFileID	PublishedFileId_t	L'oggetto del Workshop da cui rimuovere una dipendenza.
nChildPublishedFileID	PublishedFileId_t	La dipendenza da rimuovere dall'elemento principale.

Rimuove un oggetto del Workshop come dipendenza dall'oggetto specificato.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a RemoveUGCDependencyResult_t.


Vedi anche: AddDependency

RemoveItemFromFavorites

Nome	Tipo	Descrizione
nAppId	AppId_t	L'appID a cui appartiene questo oggetto.
nPublishedFileID	PublishedFileId_t	L'oggetto del Workshop da rimuovere dalla lista dei preferiti dell'utente.

Rimuove un oggetto del Workshop dalla lista dei preferiti dell'utente.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a UserFavoriteItemsListChanged_t.


Vedi anche: AddItemToFavorites

RemoveItemKeyValueTags

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pchKey	const char *	La chiave da rimuovere dall'oggetto.

Rimuove un'etichetta chiave-valore da un oggetto.

Puoi effettuare questa chiamata fino a 100 volte per aggiornamento. Se devi rimuovere più etichette, dovrai effettuare ulteriori aggiornamenti dell'oggetto.

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle non è valido o se stai cercando di rimuovere più di 100 etichette chiave/valore in un singolo aggiornamento.

Vedi anche: AddItemKeyValueTag

RemoveItemPreview

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t
index	uint32

Restituisce: bool

AddContentDescriptor

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t
descid	EUGCContentDescriptorID

Imposta EUGCContentDescriptorID sull'elemento.

Restituisce: bool

Vedi anche: GetQueryUGCContentDescriptors, RemoveContentDescriptor

RemoveContentDescriptor

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t
descid	EUGCContentDescriptorID

Rimuove EUGCContentDescriptorID dall'elemento.

Restituisce: bool

Vedi anche: GetQueryUGCContentDescriptors, AddContentDescriptor

RequestUGCDetails

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	Non più in uso!
unMaxAgeSeconds	uint32	Non più in uso!

NON PIÙ IN USO! Usa invece CreateQueryUGCDetailsRequest!

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a SteamUGCRequestUGCDetailsResult_t.

SendQueryUGCRequest

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle della richiesta della query UGC da inviare.

Invia una query UGC a Steam.

Deve essere chiamata con un handle ottenuto da CreateQueryUserUGCRequest, CreateQueryAllUGCRequest o CreateQueryUGCDetailsRequest per inviare la richiesta a Steam. Prima di chiamare, utilizza una o più delle seguenti API per personalizzare la tua query:
AddRequiredTag, AddExcludedTag, SetReturnOnlyIDs, SetReturnKeyValueTags, SetReturnLongDescription, SetReturnMetadata, SetReturnChildren, SetReturnAdditionalPreviews, SetReturnTotalOnly, SetLanguage, SetAllowCachedResponse, SetCloudFileNameFilter, SetMatchAnyTag, SetSearchText, SetRankedByTrendDays, AddRequiredKeyValueTag

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a SteamUGCQueryCompleted_t.
Restituisce k_uAPICallInvalid se l'handle della query UGC non era valido.

SetAllowCachedResponse

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
unMaxAgeSeconds	uint32	Il numero massimo di volte in cui un oggetto può essere restituito senza che la cache venga invalidata.

Imposta una query di ricerca degli UGC in sospeso affinché restituisca i risultati dalla cache per il periodo di tempo specificato.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido.

SetCloudFileNameFilter

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
pMatchCloudFileName	const char *	Il nome del file che deve corrispondere.

Imposta per restituire solo i risultati con uno specifico nome del file da una query UGC in sospeso.

NOTA: può essere utilizzata solo con CreateQueryUserUGCRequest!

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido, se non proviene da CreateQueryUserUGCRequest, o se pMatchCloudFileName è NULL.

SetItemContent

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pszContentFolder	const char *	Il percorso completo di una cartella locale che contiene i contenuti per l'oggetto.

Imposta la cartella che sarà memorizzata come contenuti per l'oggetto.

Per caricamenti e download efficienti, i file non devono essere uniti o compressi in file singolo (ad esempio file .zip).

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

SetItemDescription

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pchDescription	const char *	La nuova descrizione dell'oggetto.

Imposta una nuova descrizione per un oggetto.

La descrizione deve avere la lunghezza massima definita da k_cchPublishedDocumentDescriptionMax.

La lingua della descrizione può essere indicata utilizzando SetItemUpdateLanguage. Se non viene specificata una lingua, la descrizione verrà considerata essere "english".

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

Vedi anche: SetReturnLongDescription

SetItemMetadata

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pchMetaData	const char *	I nuovi metadati per questo oggetto.

Imposta metadati arbitrari per un oggetto. I metadati possono essere restituiti dalle query di ricerca senza dover scaricare e installare il contenuto effettivo.

I metadati devono avere la lunghezza massima definita da k_cchDeveloperMetadataMax.

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido o se pchMetadata ha una lunghezza maggiore di k_cchDeveloperMetadataMax.

Vedi anche: SetReturnMetadata

SetItemPreview

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pszPreviewFile	const char *	Il percorso completo di un'immagine di anteprima locale per l'oggetto.

Imposta l'immagine di anteprima principale per l'oggetto.

Il formato dovrebbe essere compatibile per la visualizzazione sia tramite web the tramite l'applicazione (se necessario). Suggeriamo i formati JPG, PNG e GIF.

Assicurati che il limite di Steam Cloud e il numero di file dell'applicazione siano impostati, poiché le immagini di anteprima sono archiviate nel Cloud dell'utente. Se i valori del Cloud della tua applicazione non sono impostati, questa chiamata avrà esito negativo.

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

SetItemTags

Nome	Tipo	Descrizione
updateHandle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pTags	const SteamParamStringArray_t *	La lista di etichette da impostare su questo oggetto.

Imposta etichette arbitrarie impostate dallo sviluppatore su un oggetto.

La lunghezza massima di ogni etichetta è di 255 caratteri. I nomi delle etichette possono includere solo caratteri stampabili, con l'eccezione di ",". Per una lista completa dei caratteri consentiti, vedi http://en.cppreference.com/w/c/string/byte/isprint

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido o se una delle etichette non è valida perché il suo nome eccede la lunghezza massima o perché è NULL.

Vedi anche: AddRequiredTag, AddExcludedTag, SetMatchAnyTag

SetItemTitle

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pchTitle	const char *	Il nuovo titolo dell'oggetto.

Imposta un nuovo titolo per un oggetto.

Il titolo deve avere la lunghezza massima definita da k_cchPublishedDocumentTitleMax.

La lingua della descrizione può essere indicata utilizzando SetItemUpdateLanguage. Se non viene specificata una lingua, la descrizione verrà considerata essere "english".

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

SetItemUpdateLanguage

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
pchLanguage	const char *	La lingua del titolo e della descrizione che saranno impostati in questo aggiornamento.

Imposta la lingua e il titolo della descrizione che saranno impostati in questo aggiornamento dell'oggetto.

Deve essere nel formato del codice della lingua dell'API.

Se non viene impostata, verrà considerata essere "english".

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

Vedi anche: SetItemTitle, SetItemDescription, SetLanguage

SetItemVisibility

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
eVisibility	ERemoteStoragePublishedFileVisibility	La visibilità da impostare.

Imposta la visibilità di un oggetto.

NOTA: deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

SetLanguage

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
pchLanguage	const char *	La lingua da restituire.

Imposta la lingua in cui restituire il titolo e la descrizione degli oggetti in una query UGC in sospeso.

Deve essere nel formato del codice della lingua dell'API.

Se non viene impostata, verrà considerata essere "english".

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido.

Vedi anche: SetItemUpdateLanguage

SetMatchAnyTag

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
bMatchAnyTag	bool	L'oggetto deve avere solo un'etichetta specificata (true) o tutte? (false)?

Imposta se gli oggetti del Workshop vanno restituiti se hanno una o più etichette corrispondenti o solo se corrispondono tutte le etichette su una query UGC in sospeso.

NOTA: può essere utilizzata solo con CreateQueryAllUGCRequest!

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido o non proviene da CreateQueryAllUGCRequest.

Vedi anche: AddRequiredTag, AddExcludedTag, SetItemTags

SetRankedByTrendDays

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
unDays	uint32	Imposta il numero di giorni per cui classificare gli oggetti. I valori vanno da 1 a 365.

Imposta se l'ordine dei risultati sarà aggiornato in base alla classificazione degli oggetti in un certo numero di giorni su una query UGC in sospeso.

NOTA: può essere utilizzata solo con CreateQueryAllUGCRequest!

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido, se non proviene da CreateQueryAllUGCRequest o se la EUGCQuery della query non è una delle seguenti:
k_PublishedFileQueryType_RankedByTrend, k_PublishedFileQueryType_RankedByPlaytimeTrend, k_PublishedFileQueryType_RankedByAveragePlaytimeTrend, k_PublishedFileQueryType_RankedByVotesUp o k_PublishedFileQueryType_RankedByPlaytimeSessionsTrend

SetReturnAdditionalPreviews

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
bReturnAdditionalPreviews	bool	Restituire le anteprime aggiuntive per gli oggetti?

Imposta se restituire immagini o video aggiuntivi allegati a una query UGC in sospeso.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido.

SetReturnChildren

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
bReturnChildren	bool	Restituire gli ID degli elementi secondari degli oggetti?

Imposta se restituire o meno gli ID degli elementi secondari degli oggetti di una query UGC in sospeso.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido.

SetReturnKeyValueTags

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
bReturnKeyValueTags	bool	Restituire etichette chiave/valore per gli oggetti?

Imposta se restituire etichette chiave/valore per gli oggetti di una query UGC in sospeso.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido.

SetReturnLongDescription

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
bReturnLongDescription	bool	Restituire la descrizione completa degli oggetti?

Imposta se restituire o meno la descrizione completa degli oggetti di una query UGC in sospeso.

Se non viene impostata, riceverai una descrizione sintetica che viene troncata a 255 byte.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido.

Vedi anche: SetItemDescription

SetReturnMetadata

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
bReturnMetadata	bool	Restituire i metadati degli oggetti?

Imposta se restituire o meno i metadati specificati dallo sviluppatore per gli oggetti di una query UGC in sospeso.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido.

Vedi anche: SetItemMetadata

SetReturnOnlyIDs

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
bReturnOnlyIDs	bool	Restituire solamente gli ID degli oggetti?

Imposta se restituire o meno solamente gli ID invece che tutti i dettagli da una query UGC in sospeso.

Questa chiamata è utile per quando non sono necessarie tutte le informazioni, come nel caso in cui tu voglia ottenere solo gli ID degli oggetti aggiunti ai preferiti da un utente.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido o proviene da CreateQueryUGCDetailsRequest.

SetReturnPlaytimeStats

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
unDays	uint32	Il tempo di gioco in giorni delle statistiche da restituire.

Imposta se restituire o meno il tempo di gioco in una query UGC in sospeso.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido.

SetReturnTotalOnly

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
bReturnTotalOnly	bool	Restituire solamente il numero totale degli oggetti?

Imposta se restituire o meno solamente il totale degli oggetti corrispondenti in una query UGC in sospeso.

Gli oggetti effettivi non verranno restituiti quando viene effettuata la chiamata a SteamUGCQueryCompleted_t.

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido o proviene da CreateQueryUGCDetailsRequest

SetSearchText

Nome	Tipo	Descrizione
handle	UGCQueryHandle_t	L'handle UGC della query da personalizzare.
pSearchText	const char *	Il testo da ricercare.

Imposta una stringa che deve corrispondere nel titolo o nella descrizione di un oggetto parte di una query UGC in sospeso.

NOTA: può essere utilizzata solo con CreateQueryAllUGCRequest!

NOTA: deve essere definita prima di inviare l'handle della query UGC utilizzando SendQueryUGCRequest.

Restituisce: bool
true se ha esito positivo.
false se l'handle della query UGC non è valido, se non proviene da CreateQueryAllUGCRequest o se pSearchText è NULL.

SetUserItemVote

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'ID dell'oggetto del Workshop per cui votare.
bVoteUp	bool	Voto positivo (true) o negativo (false)?

Consente all'utente di votare positivamente o negativamente un oggetto del Workshop.

Restituisce: SteamAPICall_t da utilizzare con il risultato di una chiamata a SetUserItemVoteResult_t.


Vedi anche: GetUserItemVote

StartItemUpdate

Nome	Tipo	Descrizione
nConsumerAppId	AppId_t	L'appID che utilizzerà questo oggetto.
nPublishedFileID	PublishedFileId_t	L'oggetto da aggiornare.

Inizia il processo di aggiornamento dell'oggetto.

Ottiene un handle che puoi utilizzare per modificare l'oggetto prima di inviare l'aggiornamento al server tramite SubmitItemUpdate.

Restituisce: UGCUpdateHandle_t
Un handle che puoi utilizzare con chiamate future per modificare l'oggetto prima di inviare l'aggiornamento.

Vedi anche: Caricamento di un contenuto per il Workshop, SetItemTitle, SetItemDescription, SetItemUpdateLanguage, SetItemMetadata, SetItemVisibility, SetItemTags, SetItemContent, SetItemPreview, RemoveItemKeyValueTags, AddItemKeyValueTag, AddItemPreviewFile, AddItemPreviewVideo, UpdateItemPreviewFile, UpdateItemPreviewVideo, RemoveItemPreview

StartPlaytimeTracking

Nome	Tipo	Descrizione
pvecPublishedFileID	PublishedFileId_t *	La matrice degli oggetti del Workshop di cui vuoi iniziare a tenere traccia. Limite massimo: 100 oggetti.
unNumPublishedFileIDs	uint32	Il numero di elementi in pvecPublishedFileID.

Inizia a tenere traccia del tempo di gioco su un insieme di oggetti del Workshop.

Quando la tua applicazione viene chiusa, il tracciamento del tempo di gioco verrà automaticamente sospeso.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a StartPlaytimeTrackingResult_t.
Restituisce k_uAPICallInvalid se pvecPublishedFileID è NULL, unNumPublishedFileIDs inferiore a 1 o maggiore di 100.

Vedi anche: StopPlaytimeTracking, StopPlaytimeTrackingForAllItems

StopPlaytimeTracking

Nome	Tipo	Descrizione
pvecPublishedFileID	PublishedFileId_t *	La matrice degli oggetti del Workshop di cui vuoi smettere di tenere traccia. Limite massimo: 100 oggetti.
unNumPublishedFileIDs	uint32	Il numero di elementi in pvecPublishedFileID.

Smette di tenere traccia del tempo di gioco su un insieme di oggetti del Workshop.

Quando la tua applicazione viene chiusa, il tracciamento del tempo di gioco verrà automaticamente sospeso.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a StopPlaytimeTrackingResult_t.

StopPlaytimeTrackingForAllItems

Smette di tenere traccia del tempo di gioco di tutti gli oggetti del Workshop.

Quando la tua applicazione viene chiusa, il tracciamento del tempo di gioco verrà automaticamente sospeso.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a StopPlaytimeTrackingResult_t.
Restituisce k_uAPICallInvalid se pvecPublishedFileID è NULL, unNumPublishedFileIDs inferiore a 1 o maggiore di 100.

GetAppDependencies

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto.

Restituisce tutte le dipendenze delle applicazioni associate al dato oggetto.

Restituisce: SteamAPICall_t da utilizzare con il risultato di una chiamata a GetAppDependenciesResult_t.

SubmitItemUpdate

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento da inviare.
pchChangeNote	const char *	Una breve descrizione dei cambiamenti effettuati. Opzionale. Imposta su NULL per non impostarla.

Carica i cambiamenti effettuati a un oggetto del Workshop di Steam.

Puoi tenere traccia dei progressi di un aggiornamento di un oggetto con GetItemUpdateProgress.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a SubmitItemUpdateResult_t.
Restituisce k_uAPICallInvalid se l'handle non è valido.

SubscribeItem

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto del Workshop a cui effettuare la sottoscrizione.

Effettua la sottoscrizione a un oggetto del Workshop. che verrà scaricato e installato non appena possibile.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a RemoteStorageSubscribePublishedFileResult_t.


Vedi anche: SubscribeItem

SuspendDownloads

Nome	Tipo	Descrizione
bSuspend	bool	Sospendi (true) o riavvia (false) i download dal Workshop?

Sospende e riavvia tutti i download dal Workshop.

Se effettui questa chiamata con bSuspend impostato su true, i download saranno sospesi fino a che non li riprenderai impostando bSuspend su false o finché il gioco non finisce.

UnsubscribeItem

Nome	Tipo	Descrizione
nPublishedFileID	PublishedFileId_t	L'oggetto del Workshop da cui rimuovere la sottoscrizione.

Rimuove la sottoscrizione da un oggetto del Workshop, causando la sua rimozione alla chiusura del gioco.

Restituisce: SteamAPICall_t da utilizzare con un risultato della chiamata a RemoteStorageUnsubscribePublishedFileResult_t.


Vedi anche: UnsubscribeItem

UpdateItemPreviewFile

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
index	uint32	L'indice dell'anteprima del file da 0 a GetQueryUGCNumAdditionalPreviews.
pszPreviewFile	const char *	Percorso completo dell'immagine locale.

Aggiorna un'ulteriore anteprima esistente di un file per l'oggetto.

Se il tipo di anteprima è un'immagine, questa dovrebbe essere in un formato visualizzabile sia dal web che sull'applicazione (se necessario) e deve avere dimensioni inferiori a 1 MB. Suggeriamo i formati JPG, PNG e GIF.

NOTA: deve essere impostato prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

Vedi anche: AddItemPreviewFile

UpdateItemPreviewVideo

Nome	Tipo	Descrizione
handle	UGCUpdateHandle_t	L'handle dell'aggiornamento dell'oggetto del Workshop da personalizzare.
index	uint32	L'indice dell'anteprima del file da 0 a GetQueryUGCNumAdditionalPreviews.
pszVideoID	const char *	Il video di YouTube da aggiungere. Esempio: "jHgZh4GV9G0".

Aggiorna un ulteriore video di anteprima dell'oggetto da YouTube.

NOTA: Deve essere impostata prima di inviare l'handle dell'aggiornamento UGC utilizzando SubmitItemUpdate.

Restituisce: bool
true se ha esito positivo.
false se l'handle dell'aggiornamento UGC non è valido.

Vedi anche: AddItemPreviewVideo

ShowWorkshopEULA

Mostra all'utente l'ultimo EULA del Workshop in una finestra overlay, da cui potrà accettarlo o meno

Restituisce: bool
true se ha esito positivo.
false se la finestra non può essere mostrata.

Vedi anche: GetWorkshopEULAStatus

GetWorkshopEULAStatus

Stabilisce in modo asincrono se l'utente ha accettato l'EULA del Workshop per l'applicazione attuale.

Restituisce: SteamAPICall_t

Vedi anche: WorkshopEULAStatus_t, ShowWorkshopEULA

Callback

Queste sono callback che possono essere attivate chiamando SteamAPI_RunCallbacks. Molte di esse saranno attivate direttamente in risposta alle funzioni membro di ISteamUGC.

AddAppDependencyResult_t

Il risultato di una chiamata a AddAppDependency.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione.
m_nPublishedFileId	PublishedFileId_t	L'oggetto primario del Workshop a cui è stata aggiunta la dipendenza.
m_nAppID	AppId_t	L'applicazione/DLC.

Funzioni associate: AddAppDependency

AddUGCDependencyResult_t

Il risultato di una chiamata a AddDependency.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione.
m_nPublishedFileId	PublishedFileId_t	L'oggetto primario del Workshop a cui è stata aggiunta la dipendenza.
m_nChildPublishedFileId	PublishedFileId_t	L'oggetto del Workshop secondario che è stato aggiunto come dipendenza all'oggetto principale.

Funzioni associate: AddDependency

CreateItemResult_t

Viene chiamata quando è stato creato un nuovo oggetto del Workshop.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione. Alcuni dei possibili valori restituiti includono: k_EResultOK - Operazione completata con successo. k_EResultInsufficientPrivilege - L'utente ha al momento delle restrizioni sul caricamento di contenuti a causa di ban da un hub, account bloccato o ban dalla Comunità. In questo caso, dovranno contattare l'assistenza di Steam. k_EResultBanned - L'utente non ha il permesso di caricare contenuti su questo hub a causa di un ban del VAC attivo o di un ban di gioco. k_EResultTimeout - L'operazione ha impiegato più a lungo del previsto. Richiedi all'utente di ritentare il processo di creazione. k_EResultNotLoggedOn - L'utente non ha effettuato l'accesso a Steam. k_EResultServiceUnavailable - Il server del Workshop su cui sono caricati i contenuti sta riscontrando dei problemi. Chiedi all'utente di riprovare. k_EResultInvalidParam - Uno dei campi di invio contiene elementi non validi. k_EResultAccessDenied - Si è verificato un problema nel salvataggio del titolo e della descrizione. Accesso negato. k_EResultLimitExceeded - L'utente non ha più spazio a disposizione su Steam Cloud. Chiedi loro di rimuovere degli oggetti e riprovare. k_EResultFileNotFound - Impossibile trovare il file caricato. k_EResultDuplicateRequest - Il file è già stato caricato con successo. L'utente deve semplicemente aggiornare. k_EResultDuplicateName - L'utente ha già un oggetto del Workshop di Steam con quel nome. k_EResultServiceReadOnly - Per via di un recente cambiamento alla sua password o e-mail, all'utente non è permesso caricare nuovi contenuti. Questa restrizione dura di solito per 5 giorni, ma può durarne fino a 30 se l'account non è stato attivo di recente.
m_nPublishedFileId	PublishedFileId_t	L'ID unico del nuovo oggetto.
m_bUserNeedsToAcceptWorkshopLegalAgreement	bool	L'utente ha bisogno di accettare il contratto legale del Workshop di Steam (true) o no (false)? Per maggiori informazioni, vedi: doclink=features/workshop/implementation#Legal][/doclink]

Funzioni associate: CreateItem

DownloadItemResult_t

Viene chiamata quando è stato scaricato un oggetto del Workshop.

NOTA: questa callback arriva a tutte le applicazioni in esecuzione, quindi assicurati che l'appID associato all'oggetto corrisponda a ciò che ti aspetti.

Nome	Tipo	Descrizione
m_unAppID	AppId_t	L'appID associato a questo oggetto del Workshop.
m_nPublishedFileId	PublishedFileId_t	L'oggetto del Workshop che si è finito di scaricare.
m_eResult	EResult	Il risultato dell'operazione.

Funzioni associate: DownloadItem

GetAppDependenciesResult_t

Viene chiamata quando si ottengono le dipendenze dell'applicazione di un oggetto.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione.
m_nPublishedFileId	PublishedFileId_t	L'oggetto del Workshop per cui ottenere le dipendenze dell'applicazione.
m_rgAppIDs	AppId_t	Matrice delle dipendenze dell'applicazione.
m_nNumAppDependencies	uint32	Numero di dipendenze dell'applicazione restituite in m_rgAppIDs.
m_nTotalNumAppDependencies	uint32	Totale delle dipendenze dell'applicazione trovate.

Funzioni associate: GetAppDependencies

DeleteItemResult_t

Viene chiamata al completamento di un tentativo di eliminazione di un oggetto.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione.
m_nPublishedFileId	PublishedFileId_t	L'oggetto del Workshop che era in corso di eliminazione.

Funzioni associate: DeleteItem

GetUserItemVoteResult_t

Viene chiamata quando si ottiene lo stato del voto dell'utente su un oggetto.

Nome	Tipo	Descrizione
m_nPublishedFileId	PublishedFileId_t	L'oggetto del Workshop per cui ottenere lo stato del voto.
m_eResult	EResult	Il risultato dell'operazione.
m_bVotedUp	bool	L'utente ha votato l'oggetto positivamente?
m_bVotedDown	bool	L'utente ha votato l'oggetto negativamente?
m_bVoteSkipped	bool	L'utente non ha votato l'oggetto?

Funzioni associate: GetUserItemVote

ItemInstalled_t

Viene chiamata quando un oggetto del Workshop è stato installato o aggiornato.

NOTA: questa callback arriva a tutte le applicazioni in esecuzione, quindi assicurati che l'appID associato all'oggetto corrisponda a ciò che ti aspetti.

Nome	Tipo	Descrizione
m_unAppID	AppId_t	L'appID associato a questo oggetto del Workshop.
m_nPublishedFileId	PublishedFileId_t	L'oggetto del Workshop che si è finito di installare. Può essere utilizzata con GetItemInstallInfo per avere accesso alle informazioni sull'oggetto.

RemoveAppDependencyResult_t

Scopo: il risultato di una chiamata a RemoveAppDependency.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione.
m_nPublishedFileId	PublishedFileId_t	L'oggetto primario del Workshop da cui è stata rimossa la dipendenza.
m_nAppID	AppId_t	L'applicazione/DLC.

Funzioni associate: RemoveAppDependency

RemoveUGCDependencyResult_t

Scopo: il risultato di una chiamata a RemoveDependency.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione.
m_nPublishedFileId	PublishedFileId_t	L'oggetto primario del Workshop da cui è stata rimossa la dipendenza.
m_nChildPublishedFileId	PublishedFileId_t	L'oggetto secondario del Workshop che è stato rimosso come dipendenza dall'oggetto principale.

Funzioni associate: RemoveDependency

SetUserItemVoteResult_t

Viene chiamata quando l'utente ha valutato un oggetto.

Nome	Tipo	Descrizione
m_nPublishedFileId	PublishedFileId_t	L'oggetto del Workshop per cui l'utente ha votato.
m_eResult	EResult	Il risultato dell'operazione.
m_bVoteUp	bool	Il voto era positivo (true) o negativo (false)?

Funzioni associate: SetUserItemVote

StartPlaytimeTrackingResult_t

Viene chiamata all'avvio del tracciamento del tempo di gioco dell'oggetto del Workshop.

Nome	Scrivi	Descrizione
m_eResult	EResult	Il risultato dell'operazione.

Funzioni associate: StartPlaytimeTracking

SteamUGCQueryCompleted_t

Viene chiamata al completamento di una richiesta di query UGC.

Nome	Tipo	Descrizione
m_handle	UGCQueryHandle_t	L'handle della query UGC associato a questo risultato della chiamata.
m_eResult	EResult	Il risultato dell'operazione.
m_unNumResultsReturned	uint32	Il numero di oggetti restituiti in questo set di risultati.
m_unTotalMatchingResults	uint32	Il numero totale di oggetti che corrispondono alla query nel database.
m_bCachedData	bool	Indica se questi dati sono stati recuperati dalla cache locale sul disco.

Funzioni associate: SendQueryUGCRequest

SteamUGCRequestUGCDetailsResult_t

NON PIÙ IN USO - Risultato precedente di una chiamata a RequestUGCDetails.

Nome	Tipo	Descrizione
m_details	SteamUGCDetails_t	Non più in uso.
m_bCachedData	bool	Non più in uso.

Funzioni associate: RequestUGCDetails

StopPlaytimeTrackingResult_t

Viene chiamata al termine del tracciamento del tempo di gioco dell'oggetto del Workshop.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione.

Funzioni associate: StopPlaytimeTracking, StopPlaytimeTrackingForAllItems

SubmitItemUpdateResult_t

Viene chiamata quando è stato completato l'aggiornamento di un oggetto.

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione. Alcuni dei possibili valori restituiti includono: k_EResultOK - Operazione completata con successo. k_EResultFail - Errore generico. k_EResultInvalidParam - L'appID fornito non è valido, non corrisponde all'appID dell'utente o non hai abilitato ISteamUGC per l'app fornita sulla https://partner.steamgames.com/apps/workshop/ Pagina di amministrazione dell'app. Il file di anteprima è più piccolo di 16 byte. k_EResultAccessDenied - L'utente non possiede una licenza per l'appID fornito. k_EResultFileNotFound - Impossibile recuperare le informazioni del Workshop per l'oggetto o impossibile leggere il file di anteprima. k_EResultLockingFailed - Impossibile acquisire il blocco UGC. k_EResultFileNotFound - La cartella dei contenuti fornita non è valida. k_EResultLimitExceeded - L'immagine di anteprima è troppo grande (deve essere al massimo di 1 MB) o l'utente non ha abbastanza spazio libero sul Steam Cloud.
m_bUserNeedsToAcceptWorkshopLegalAgreement	bool	L'utente deve accettare il contratto legale del Workshop di Steam? Per maggiori informazioni, vedi: doclink=features/workshop/implementation#Legal][/doclink]

Funzioni associate: SubmitItemUpdate

UserFavoriteItemsListChanged_t

Viene chiamata quando l'utente aggiunge o rimuove un oggetto dai suoi preferiti.

Nome	Tipo	Descrizione
m_nPublishedFileId	PublishedFileId_t	L'oggetto che è stato aggiunto/rimosso.
m_eResult	EResult	Il risultato dell'operazione.
m_bWasAddRequest	bool	L'oggetto è stato aggiunto (true) o rimosso (false) dai preferiti dell'utente?

Funzioni associate: AddItemToFavorites, RemoveItemFromFavorites

UserSubscribedItemsListChanged_t

Viene chiamata quando l'utente aggiunge o rimuove un oggetto dalle sue sottoscrizioni, relativamente all'appID restituito.

Nome	Tipo	Descrizione
m_nAppID	AppId_t	Il relativo appID.

Funzioni associate: SubscribeItem, UnsubscribeItem

WorkshopEULAStatus_t

Callback restituita GetWorkshopEULAStatus

Nome	Tipo	Descrizione
m_eResult	EResult	Il risultato dell'operazione.
m_nAppID	AppId_t	Il relativo appID.
m_unVersion	uint32	La versione dell'EULA firmato, se applicabile.
m_rtAction	RTime32	Timestamp in formato Unix di quando l'utente ha firmato l'EULA, se applicabile.
m_bAccepted	boolean	True se l'utente ha accettato la versione specificata, false altrimenti. Nota: può essere true anche se l'utente ha accettato una versione meno recente dell'EULA.
m_bNeedsAction	boolean	True se l'utente deve accettare l'ultimo EULA del Workshop, false altrimenti.

Funzioni associate: GetWorkshopEULAStatus

Strutture

Queste sono strutture con cui le funzioni all'interno di ISteamUGC possono interagire o che possono restituire.

SteamUGCDetails_t

Dettagli di un singolo oggetto/UGC pubblicato. Restituita da GetQueryUGCResult.

Nome	Tipo	Descrizione
m_nPublishedFileId	PublishedFileId_t	L'handle globalmente unico dell'oggetto di questo UGC.
m_eResult	EResult	Il risultato dell'operazione.
m_eFileType	EWorkshopFileType	Il tipo di oggetto.
m_nCreatorAppID	AppId_t	L'appID dell'applicazione che ha creato questo oggetto.
m_nConsumerAppID	AppId_t	L'appID dell'applicazione che consumerà questo oggetto.
m_rgchTitle	char[[apitype]ISteamRemoteStorage::k_cchPublishedDocumentTitleMax[/apitype]]	Il titolo dell'oggetto.
m_rgchDescription	char[[apitype]ISteamRemoteStorage::k_cchPublishedDocumentDescriptionMax[/apitype]]	La descrizione dell'oggetto.
m_ulSteamIDOwner	uint64	L'ID di Steam dell'utente che ha creato questo contenuto.
m_rtimeCreated	uint32	L'ora di creazione dell'oggetto pubblicato, in formato epoch Unix (a partire dal 1° gennaio 1970).
m_rtimeUpdated	uint32	L'ora dell'ultimo aggiornamento dell'oggetto pubblicato, in formato epoch Unix (a partire dal 1° gennaio 1970).
m_rtimeAddedToUserList	uint32	L'ora in cui l'utente ha aggiunto l'oggetto pubblicato alla sua lista (non sempre applicabile), in formato epoch Unix (a partire dal 1° gennaio 1970).
m_eVisibility	ERemoteStoragePublishedFileVisibility	La visibilità dell'oggetto.
m_bBanned	bool	Indica se l'oggetto è stato bandito.
m_bAcceptedForUse	bool	Indica se lo sviluppatore di questa applicazione ha contrassegnato specificatamente l'oggetto come accettato nel Workshop. Vedi: Workshop curato
m_bTagsTruncated	bool	Indica se la lista di etichette era troppo lunga per essere restituita nel buffer fornito ed è stata troncata di conseguenza.
m_rgchTags	char[[apitype]ISteamRemoteStorage::k_cchTagListMax[/apitype]]	Lista separata da virgole di tutte le etichette associate a questo oggetto.
m_hFile	UGCHandle_t	L'handle del file principale.
m_hPreviewFile	UGCHandle_t	L'handle del file di anteprima.
m_pchFileName	char[[apitype]ISteamRemoteStorage::k_cchFilenameMax[/apitype]]	Il nome del file sul cloud del file primario.
m_nFileSize	int32	Le dimensioni del file principale.
m_nPreviewFileSize	int32	Le dimensioni del file di anteprima.
m_rgchURL	char[[apitype]ISteamRemoteStorage::k_cchPublishedFileURLMax[/apitype]]	L'URL associato a questo oggetto (per un video o un sito web).
m_unVotesUp	uint32	Il numero di voti positivi.
m_unVotesDown	uint32	Il numero di voti negativi.
m_flScore	float	La media bayesiana tra i voti positivi e quelli totali, nell'intervallo [0,1].
m_unNumChildren	uint32	Il numero di oggetti nella collezione se m_eFileType è k_EWorkshopFileTypeCollection, oppure il numero di oggetti con cui questo specifico oggetto presenta una dipendenza. Vedi: AddDependency.

Enums

Queste sono le enumerazioni definite per l'utilizzo con ISteamUGC.

EItemPreviewType

Contrassegni che specificano il tipo di anteprima di un oggetto. Impostato con AddItemPreviewFile e ricevuto con GetQueryUGCAdditionalPreview.

Nome	Valore	Descrizione
k_EItemPreviewType_Image	0	File d'immagine standard visibile sul web. Tipi supportati: PNG, JPG e GIF.
k_EItemPreviewType_YouTubeVideo	1	ID del video di YouTube. Esempio: "jHgZh4GV9G0".
k_EItemPreviewType_Sketchfab	2	ID del modello sketchfab.
k_EItemPreviewType_EnvironmentMap_HorizontalCross	3	File d'immagine standard contenente una mappa di un ambiente in una disposizione a croce orizzontale (vedi sotto). Tipi supportati: PNG, JPG e GIF. +---+---+-------+ | |Su | | +---+---+---+---+ | Sinistra | Avanti | Destra | Indietro | +---+---+---+---+ | |Giù| | +---+---+---+---+ Al momento non è usato per le visualizzazioni via web.
k_EItemPreviewType_EnvironmentMap_LatLong	4	File d'immagine standard contenente una mappa di un ambiente in una disposizione LatLong. Tipi supportati: PNG, JPG e GIF. Al momento non è usato per le visualizzazioni via web.
k_EItemPreviewType_ReservedMax	255	Riservato. Puoi specificare i tuoi tipi al di sopra di questo valore.

EItemState

Specifica lo stato di un oggetto. Questi sono contrassegni che possono essere combinati. Restituiti da GetItemState.

Nome	Valore	Descrizione
k_EItemStateNone	0	L'oggetto non è tracciato sul client.
k_EItemStateSubscribed	1	L'utente corrente ha effettuato la sottoscrizione a questo oggetto, che non è semplicemente memorizzato nella cache.
k_EItemStateLegacyItem	2	L'oggetto è stato creato con le vecchie funzionalità del Workshop in ISteamRemoteStorage.
k_EItemStateInstalled	4	L'oggetto è installato e utilizzabile (ma potrebbe non essere aggiornato).
k_EItemStateNeedsUpdate	8	L'oggetto deve essere aggiornato, forse perché non è ancora installato o forse perché il suo autore ne ha aggiornato i contenuti.
k_EItemStateDownloading	16	L'aggiornamento dell'oggetto è in fase di download.
k_EItemStateDownloadPending	32	DownloadItem è stata chiamata per questo oggetto, il contenuto non sarà disponibile fino all'attivazione di DownloadItemResult_t.

EItemStatistic

Utilizzata per recuperare le statistiche dell'oggetto con GetQueryUGCStatistic.

Nome	Valore	Descrizione
k_EItemStatistic_NumSubscriptions	0	Ottiene il numero di sottoscrizioni.
k_EItemStatistic_NumFavorites	1	Ottiene il numero di utenti che lo hanno aggiunto ai preferiti.
k_EItemStatistic_NumFollowers	2	Ottiene il numero di follower.
k_EItemStatistic_NumUniqueSubscriptions	3	Ottiene il numero di sottoscrizioni uniche.
k_EItemStatistic_NumUniqueFavorites	4	Ottiene il numero di utenti unici che lo hanno aggiunto ai preferiti.
k_EItemStatistic_NumUniqueFollowers	5	Ottiene il numero di follower unici.
k_EItemStatistic_NumUniqueWebsiteViews	6	Ottiene il numero di visualizzazioni uniche che l'oggetto ha sulla sua pagina del Workshop di Steam.
k_EItemStatistic_ReportScore	7	Ottiene il numero di segnalazioni dell'oggetto.
k_EItemStatistic_NumSecondsPlayed	8	Ottiene il numero totale di secondi per cui questo oggetto è stato utilizzato da tutti i giocatori.
k_EItemStatistic_NumPlaytimeSessions	9	Ottiene il numero totale di sessioni di gioco in cui è stato usato questo oggetto.
k_EItemStatistic_NumComments	10	Ottiene il numero di commenti che l'oggetto ha ricevuto sulla sua pagina del Workshop di Steam.
k_EItemStatistic_NumSecondsPlayedDuringTimePeriod	11	Ottiene il numero di secondi per cui questo oggetto è stato utilizzato in un dato intervallo di tempo.
k_EItemStatistic_NumPlaytimeSessionsDuringTimePeriod	12	Ottiene il numero di sessioni di gioco in cui questo oggetto è stato utilizzato in un dato intervallo di tempo.

EItemUpdateStatus

Specifica lo stato di un'istanza di UGCUpdateHandle_t dopo una chiamata a GetItemUpdateProgress. Viene restituita da GetItemUpdateProgress.

Nome	Valore	Descrizione
k_EItemUpdateStatusInvalid	0	L'handle dell'aggiornamento dell'oggetto non era valido, il processo potrebbe essere completato, avrebbe dovuto essere restituito un risultato della chiamata SubmitItemUpdateResult_t.
k_EItemUpdateStatusPreparingConfig	1	L'aggiornamento dell'oggetto sta elaborando i dati di configurazione.
k_EItemUpdateStatusPreparingContent	2	L'aggiornamento dell'oggetto sta leggendo ed elaborando i file dei contenuti.
k_EItemUpdateStatusUploadingContent	3	L'aggiornamento dell'oggetto sta caricando le modifiche dei contenuti su Steam.
k_EItemUpdateStatusUploadingPreviewFile	4	L'aggiornamento dell'oggetto sta caricando la nuova immagine di anteprima.
k_EItemUpdateStatusCommittingChanges	5	L'aggiornamento dell'oggetto sta finalizzando tutti i cambiamenti.

EUGCMatchingUGCType

Specifica i tipi di UGC da ottenere da una chiamata a CreateQueryUserUGCRequest o a CreateQueryAllUGCRequest.

Nome	Valore	Descrizione
k_EUGCMatchingUGCType_Items	0	Sia gli oggetti inclusi nelle microtransazioni che quelli pronti all'utilizzo.
k_EUGCMatchingUGCType_Items_Mtx	1	Oggetti parte di una microtransazione. Vedi: Workshop curato.
k_EUGCMatchingUGCType_Items_ReadyToUse	2	Normali oggetti di gioco caricati dai giocatori. Vedi: Workshop pronto all'uso.
k_EUGCMatchingUGCType_Collections	3	Collezioni condivise di UGC.
k_EUGCMatchingUGCType_Artwork	4	Le illustrazioni che sono state condivise.
k_EUGCMatchingUGCType_Videos	5	I video che sono stati condivisi.
k_EUGCMatchingUGCType_Screenshots	6	Gli screenshot che sono stati condivisi.
k_EUGCMatchingUGCType_AllGuides	7	Sia le guide web che quelle integrate.
k_EUGCMatchingUGCType_WebGuides	8	Guide disponibili solo nella Comunità di Steam.
k_EUGCMatchingUGCType_IntegratedGuides	9	Guide che puoi utilizzare all'interno del tuo gioco. Esempio: le guide di gioco sui personaggi di Dota 2.
k_EUGCMatchingUGCType_UsableInGame	10	Oggetti pronti all'uso e guide integrate.
k_EUGCMatchingUGCType_ControllerBindings	11	Assegnazioni del controller che sono state condivise.
k_EUGCMatchingUGCType_GameManagedItems	12	Oggetti gestiti dal gioco e non dagli utenti
k_EUGCMatchingUGCType_All	~0	Restituisce tutto.

EUGCQuery

Utilizzata con CreateQueryAllUGCRequest per specificare l'ordine e i filtri per le query di tutti gli UGC disponibili.

Nome	Valore	Descrizione
k_EUGCQuery_RankedByVote	0	Ordina per la popolarità storica dei voti
k_EUGCQuery_RankedByPublicationDate	1	Ordina per data di pubblicazione decrescente
k_EUGCQuery_AcceptedForGameRankedByAcceptanceDate	2	Ordina per data di accettazione (per oggetti mtx)
k_EUGCQuery_RankedByTrend	3	Ordina per popolarità dei voti all'interno di un certo intervallo di "popolarità" impostato in SetRankedByTrendDays
k_EUGCQuery_FavoritedByFriendsRankedByPublicationDate	4	Filtra per gli oggetti nella lista dei preferiti degli amici dell'utente, in ordine decrescente per data di pubblicazione
k_EUGCQuery_CreatedByFriendsRankedByPublicationDate	5	Filtra per gli oggetti creati dagli amici, in ordine decrescente per data di pubblicazione
k_EUGCQuery_RankedByNumTimesReported	6	Ordina per numero decrescente di segnalazioni
k_EUGCQuery_CreatedByFollowedUsersRankedByPublicationDate	7	Filtra per gli oggetti creati dagli utenti seguiti dall'utente corrente, in ordine decrescente per data di pubblicazione
k_EUGCQuery_NotYetRated	8	Filtra per la coda di valutazione dell'utente
k_EUGCQuery_RankedByTotalVotesAsc	9	Ordina in modo crescente in base al numero totale dei voti (utilizzato internamente per creare la coda di valutazione dell'utente)
k_EUGCQuery_RankedByVotesUp	10	Ordine decrescente per numero di voti positivi. Utilizzerà il periodo di "popolarità" se specificato (impostato in SetRankedByTrendDays)
k_EUGCQuery_RankedByTextSearch	11	Ordina per rilevanza delle parole chiave nella ricerca
k_EUGCQuery_RankedByTotalUniqueSubscriptions	12	Ordina per numero decrescente di utenti unici iscritti totali
k_EUGCQuery_RankedByPlaytimeTrend	13	Ordina per tempo di gioco totale decrescente nel periodo di "popolarità" (impostato con SetRankedByTrendDays)
k_EUGCQuery_RankedByTotalPlaytime	14	Ordina per tempo di gioco ​decrescente totale.
k_EUGCQuery_RankedByAveragePlaytimeTrend	15	Ordina per tempo di gioco medio decrescente nel periodo di "popolarità" (impostato in SetRankedByTrendDays)
k_EUGCQuery_RankedByLifetimeAveragePlaytime	16	Ordina per tempo di gioco medio decrescente totale.
k_EUGCQuery_RankedByPlaytimeSessionsTrend	17	Ordina per numero decrescente di sessioni di gioco nel periodo di "popolarità" (impostato in SetRankedByTrendDays)
k_EUGCQuery_RankedByLifetimePlaytimeSessions	18	Ordina per numero decrescente di sessioni di gioco totali.
k_EUGCQuery_RankedByLastUpdatedDate	19	Ordina per ora dell'ultimo aggiornamento.

EUserUGCList

Utilizzata con CreateQueryUserUGCRequest per ottenere diverse liste di UGC pubblicati da un utente.

Nome	Valore	Descrizione
k_EUserUGCList_Published	0	Lista dei file pubblicati dall'utente. Equivale a http://steamcommunity.com/my/myworkshopfiles/?browsesort=myfiles
k_EUserUGCList_VotedOn	1	Lista dei file che l'utente ha votato. Include sia VotedUp (votati positivamente) che VotedDown (votati negativamente).
k_EUserUGCList_VotedUp	2	Lista dei file che l'utente ha votato positivamente (limitata solo all'utente attuale).
k_EUserUGCList_VotedDown	3	Lista dei file che l'utente ha votato negativamente (limitata solo all'utente attuale).
k_EUserUGCList_WillVoteLater	4	Non più in uso. Non usare! Limitata solo all'utente attuale.
k_EUserUGCList_Favorited	5	Lista dei file preferiti dell'utente. Equivale a http://steamcommunity.com/my/myworkshopfiles/?browsesort=myfavorites.
k_EUserUGCList_Subscribed	6	Lista dei file a cui l'utente è sottoscritto (limitata solo all'utente attuale). Equivale a http://steamcommunity.com/my/myworkshopfiles/?browsesort=mysubscriptions.
k_EUserUGCList_UsedOrPlayed	7	Lista dei file con cui l'utente ha trascorso del tempo di gioco. Equivale a http://steamcommunity.com/my/myworkshopfiles/?browsesort=myplayedfiles.
k_EUserUGCList_Followed	8	Lista dei file di cui l'utente segue gli aggiornamenti.

EUserUGCListSortOrder

Utilizzata con CreateQueryUserUGCRequest per specificare l'ordine delle liste degli UGC pubblicati dagli utenti. L'ordine predefinito è decrescente in base alla data di creazione.

Nome	Valore	Descrizione
k_EUserUGCListSortOrder_CreationOrderDesc	0	Restituisce oggetti in base alla data di creazione. Decrescente (nuovi oggetti per primi). Corrisponde a "sortmethod=newestfirst" sulla pagina del Workshop.
k_EUserUGCListSortOrder_CreationOrderAsc	1	Restituisce oggetti in base alla data di creazione. Crescente (oggetti più vecchi per primi). Corrisponde a "sortmethod=oldestfirst" sulla pagina del Workshop.
k_EUserUGCListSortOrder_TitleAsc	2	Restituisce gli oggetti in base al nome. Corrisponde a "sortmethod=alpha" sulla pagina del Workshop.
k_EUserUGCListSortOrder_LastUpdatedDesc	3	Restituisce prima gli oggetti aggiornati più di recente. Corrisponde a "sortmethod=lastupdated" sulla pagina del Workshop.
k_EUserUGCListSortOrder_SubscriptionDateDesc	4	Restituisce prima gli oggetti a cui è stata effettuata la sottoscrizione più di recente. Corrisponde a "sortmethod=subscriptiondate" sulla pagina del Workshop.
k_EUserUGCListSortOrder_VoteScoreDesc	5	Restituisce prima gli oggetti con i punteggi aggiornati più recenti. Corrisponde a "sortmethod=score" sulla pagina del Workshop.
k_EUserUGCListSortOrder_ForModeration	6	Restituisce gli oggetti che sono stati segnalati per la moderazione. Corrisponde a "sortmethod=formoderation" sulla pagina del Workshop.

EUGCContentDescriptorID

Gli utenti possono controllare quali contenuti generati dagli utenti desiderano visualizzare nella sezione Filtro dei contenuti per adulti delle loro preferenze. Questo filtro viene eseguito automaticamente dai server di Steam, ma prima i contenuti generati dagli utenti devono essere etichettati in modo appropriato. Gli sviluppatori possono utilizzare le chiamate a AddContentDescriptor e RemoveContentDescriptor per gestire i descrittori di contenuto di una parte di UGC. È possibile recuperarli dai risultati di una query tramite GetQueryUGCContentDescriptors.

Nome	Valore	Descrizione
k_EUGCContentDescriptor_NudityOrSexualContent	1	Alcuni contenuti di nudità o di natura sessuale: include contenuti che hanno alcuni temi di nudità o sessuali, ma non come aspetto principale.
k_EUGCContentDescriptor_FrequentViolenceOrGore	2	Violenza o contenuti cruenti frequenti: include contenuti che presentano violenza o contenuti cruenti estremi.
k_EUGCContentDescriptor_AdultOnlySexualContent	3	Contenuti di natura sessuale solo per adulti: include contenuti sessualmente espliciti o crudi pensati solo per un pubblico adulto. Gli utenti devono dichiarare di avere almeno diciotto anni prima di poter visualizzare i contenuti con questo descrittore di contenuto.
k_EUGCContentDescriptor_GratuitousSexualContent	4	Nudità o contenuti di natura sessuale frequenti: include contenuti incentrati principalmente su temi sessuali o di nudità. Gli utenti devono dichiarare di avere almeno diciotto anni prima di poter visualizzare i contenuti con questo descrittore di contenuto.
k_EUGCContentDescriptor_AnyMatureContent	5	Contenuti generali per adulti: include contenuti per adulti che potrebbero non essere appropriati per tutti i tipi di pubblico.

Typedefs

Queste sono typedef definite per l'utilizzo con ISteamUGC.

Nome	Tipo base	Descrizione
UGCQueryHandle_t	uint64	Un handle unico per una singola query UGC. Utilizzato quando si richiede una lista di oggetti dal Workshop.
UGCUpdateHandle_t	uint64	Un handle unico per un singolo aggiornamento di un oggetto. Utilizzato quando si carica o si aggiorna un oggetto sul Workshop.

Costanti

Queste sono costanti definite per l'utilizzo con ISteamUGC.

Nome	Tipo	Valore	Descrizione
kNumUGCResultsPerPage	uint32	50	Il numero massimo di risultati che riceverai da una query.
k_cchDeveloperMetadataMax	uint32	5000	Il numero massimo di byte che puoi impostare con SetItemMetadata.
k_UGCQueryHandleInvalid	UGCQueryHandle_t	0xffffffffffffffffull	Utilizzata per specificare un handle non valido di una query. Viene restituita di frequente se una chiamata ha esito negativo.
k_UGCUpdateHandleInvalid	UGCUpdateHandle_t	0xffffffffffffffffull	Utilizzata per specificare un handle non valido dell'aggiornamento di un oggetto. Viene restituita di frequente se una chiamata ha esito negativo.
STEAMUGC_INTERFACE_VERSION	const char *	"STEAMUGC_INTERFACE_VERSION015"