UGC Query Manager
Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude.
These articles are made possible by our GitHub Sponsors ... become a sponsor today!
Search for and browse Steam Workshop items.
public class UserGeneratedContentQueryManager : MonoBehaviour
The UGC Workshop article includes a step by step guide on the use of UGC Query Manager to create an In-Game Workshop browser.
The User Generated Content API is the underlying tool set used by the query manager.
Type | Name | Comments |
|---|---|---|
AppId_t | creatorAppId | The ID of the app that creates the items |
UserGeneratedContentItemQuery | activeQuerry | Settings to search for |
int | CurrentFrom | the index of the first item in the current list |
int | CurrentTo | the index of the last item in the current list |
int | TotalCount | how many items are in the current query |
int | CurrentPage | which page is currently loaded |
Occurs when the results are ready
Occurs when the query is ready to return results
Occurs when the result list is updated
public void SearchAll(filter);
Search for all the items that match the input fiter.
public void PrepareSearchAll(filter);
Prepares a search but doesn't execute it
public void SearchFavorites(filter);
Search for favorited items that match the input filter.
public void PrepareSearchFavorites(filter);
Prepares a search for favorited items that match the input filter but doens't execute it
public void SearchFollowed(filter);
Search for followed items that match the input filter.
public void PrepareSearchFollowed(filter);
Prepares a search for followed items that match the input filter but doens't execute it
public void ExecuteSearch();
Executes a prepared search
public void SetNextSearchPage();
Moves the page forward and executes the updated query
public void SetPreviousSearchPage();
Moves the page back and executes the updated query
public void SetSearchPage(page);
Sets a specific page and exuecutes the query
Last modified 1mo ago