s&box docs
API Referenceglobal

Queryclass

Query the Steam Workshop for items

object→Query
Namespace
global
Assembly
Sandbox.Engine
Declaration
public class Sandbox.Storage.Query

Constructors1

Showing 1 constructors

public Query()PUBLICCONSTRUCTOR

Methods1

Showing 1 methods

public System.Threading.Tasks.Task`1<Sandbox.Storage.QueryResult> Run(System.Threading.CancellationToken token = null)PUBLIC

Run the query

ParameterTypeDescription
token = nullCancellationToken—
Returns:Task<QueryResult>—

Properties9

Showing 9 properties

public Sandbox.SteamId Sandbox.Storage.Query.Author { get; set; }PUBLICGETSET

Filter results to items published by this Steam ID. When set, uses a user-specific query instead of a global one.

Returns:SteamId—

public System.Collections.Generic.List`1<ulong> Sandbox.Storage.Query.FileIds { get; set; }PUBLICGETSET

Specific workshop file IDs to query. When set, other filters are ignored and the query returns details for these specific items.

Returns:List<ulong>—

public System.Collections.Generic.Dictionary`2<string,string> Sandbox.Storage.Query.KeyValues { get; set; }PUBLICGETSET

KeyValues that the item must match to be included in results.

Returns:Dictionary<string,string>—

public int Sandbox.Storage.Query.MaxCacheAge { get; set; }PUBLICGETSET

Max Cache Age in seconds

Returns:int—

public int Sandbox.Storage.Query.RankTrendDays { get; set; }PUBLICGETSET

Number of days to consider for rank trend calculations

Returns:int—

public string Sandbox.Storage.Query.SearchText { get; set; }PUBLICGETSET

Search Text

Returns:string—

public System.Collections.Generic.HashSet`1<string> Sandbox.Storage.Query.TagsExcluded { get; set; }PUBLICGETSET

Tags that the item must not have any of to be included in results.

Returns:HashSet<string>—

public System.Collections.Generic.HashSet`1<string> Sandbox.Storage.Query.TagsRequired { get; set; }PUBLICGETSET

Tags that the item must have all of to be included in results.

Returns:HashSet<string>—

Related Guides

→Controller Input→Storage (UGC)

SetThumbnail()

Previous Page

Author

Next Page

On this page

Constructorspublic Query()Methodspublic System.Threading.Tasks.Task`1<Sandbox.Storage.QueryResult> Run(System.Threading.CancellationToken token = null)Propertiespublic Sandbox.SteamId Sandbox.Storage.Query.Author { get; set; }public System.Collections.Generic.List`1<System.UInt64> Sandbox.Storage.Query.FileIds { get; set; }public System.Collections.Generic.Dictionary`2<System.String,System.String> Sandbox.Storage.Query.KeyValues { get; set; }public System.Int32 Sandbox.Storage.Query.MaxCacheAge { get; set; }public System.Int32 Sandbox.Storage.Query.RankTrendDays { get; set; }public System.String Sandbox.Storage.Query.SearchText { get; set; }public Sandbox.Storage.SortOrder Sandbox.Storage.Query.SortOrder { get; set; }public System.Collections.Generic.HashSet`1<System.String> Sandbox.Storage.Query.TagsExcluded { get; set; }public System.Collections.Generic.HashSet`1<System.String> Sandbox.Storage.Query.TagsRequired { get; set; }Metadata