# UGC Query Manager

{% hint style="success" %}

#### Like what your seeing?

Support us as a [GitHub Sponsor](/old-kb/where-to-buy/become-a-sponsor.md) 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](/old-kb/where-to-buy/become-a-sponsor.md) ... become a sponsor today!
{% endhint %}

## &#x20;Introduction

Search for and browse Steam Workshop items.

```csharp
public class UserGeneratedContentQueryManager : MonoBehaviour
```

### Related Topics

#### Workshop Browser

{% embed url="<https://kb.heathenengineering.com/assets/steamworks/learning/core-concepts/user-generated-content-workshop>" %}

The UGC Workshop article includes a step by step guide on the use of UGC Query Manager to create an [In-Game Workshop browser](/old-kb/steam/workshop/in-game-browser.md).

#### User Generated Content API

{% embed url="<https://kb.heathenengineering.com/assets/steamworks/api/user-generated-content>" %}

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

## Definition

## Fields and Attributes

<table><thead><tr><th width="217.91333012691814">Type</th><th>Name</th><th width="316.8664058133036">Comments</th></tr></thead><tbody><tr><td>AppId_t</td><td>creatorAppId</td><td>The ID of the app that creates the items</td></tr><tr><td>UserGeneratedContentItemQuery</td><td>activeQuerry</td><td>Settings to search for</td></tr><tr><td>int</td><td>CurrentFrom</td><td>the index of the first item in the current list</td></tr><tr><td>int</td><td>CurrentTo</td><td>the index of the last item in the current list</td></tr><tr><td>int</td><td>TotalCount</td><td>how many items are in the current query</td></tr><tr><td>int</td><td>CurrentPage</td><td>which page is currently loaded</td></tr></tbody></table>

## 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

```csharp
public void SearchAll(filter);
```

Search for all the items that match the input fiter.

### Prepare Search All

```csharp
public void PrepareSearchAll(filter);
```

Prepares a search but doesn't execute it

### Search Favorites

```csharp
public void SearchFavorites(filter);
```

Search for favorited items that match the input filter.

### Prepare Search Favorites

```csharp
public void PrepareSearchFavorites(filter);
```

Prepares a search for favorited items that match the input filter but doens't execute it

### Search Followed

```csharp
public void SearchFollowed(filter);
```

Search for followed items that match the input filter.

### Prepare Search Followed

```csharp
public void PrepareSearchFollowed(filter);
```

Prepares a search for followed items that match the input filter but doens't execute it

### Execute Search

```csharp
public void ExecuteSearch();
```

Executes a prepared search

### Set Next Search Page

```csharp
public void SetNextSearchPage();
```

Moves the page forward and executes the updated query

### Set Previous Search Page

```csharp
public void SetPreviousSearchPage();
```

Moves the page back and executes the updated query

### Set Search Page

```csharp
public void SetSearchPage(page);
```

Sets a specific page and exuecutes the query


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kb.heathen.group/old-kb/old-toolkit-for-steamworks/unity/objects/components/ugc-query-manager.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
