UGC Query Manager

Like what your seeing?

Consider supporting us as a GitHub Sponsor and get instant access to all our Unity 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!

Introduction

Search for and browse Steam Workshop items.
public class UserGeneratedContentQueryManager : MonoBehaviour

Workshop Browser

User Generated Content (Workshop)
Heathen KB
The UGC Workshop article includes a step by step guide on the use of UGC Query Manager to create an In-Game Workshop browser.

User Generated Content API

User Generated Content
Heathen KB
The User Generated Content API is the underlying tool set used by the query manager.

Definition

Fields and Attributes

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

Events

Results Returned

Occurs when the results are ready

Query Prepared

Occurs when the query is ready to return results

Results Updated

Occurs when the result list is updated

Methods

Search All

public void SearchAll(filter);
Search for all the items that match the input fiter.

Prepare Search All

public void PrepareSearchAll(filter);
Prepares a search but doesn't execute it

Search Favorites

public void SearchFavorites(filter);
Search for favorited items that match the input filter.

Prepare Search Favorites

public void PrepareSearchFavorites(filter);
Prepares a search for favorited items that match the input filter but doens't execute it

Search Followed

public void SearchFollowed(filter);
Search for followed items that match the input filter.

Prepare Search Followed

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

Set Next Search Page

public void SetNextSearchPage();
Moves the page forward and executes the updated query

Set Previous Search Page

public void SetPreviousSearchPage();
Moves the page back and executes the updated query

Set Search Page

public void SetSearchPage(page);
Sets a specific page and exuecutes the query