Class IUsesSetQueryResultsExtensionMethods

Inheritance

Object

IUsesSetQueryResultsExtensionMethods

Namespace: Unity.MARS.Query

Syntax

public static class IUsesSetQueryResultsExtensionMethods

Methods

RegisterSetQuery(IUsesSetQueryResults, QueryMatchID, SetQueryArgs)

Called to get set event(s) from the MARS backend Allows a user to specify a custom query ID to use - make sure it is unique!

Declaration

public static void RegisterSetQuery(this IUsesSetQueryResults caller, QueryMatchID queryMatchID, SetQueryArgs queryArgs)

Parameters

Type	Name	Description
IUsesSetQueryResults	caller	The object making the query
QueryMatchID	queryMatchID	The identifier to use for this query
SetQueryArgs	queryArgs	The different specified data requirements we are querying for

RegisterSetQuery(IUsesSetQueryResults, SetQueryArgs)

Called to get set event(s) from the MARS backend

Declaration

public static QueryMatchID RegisterSetQuery(this IUsesSetQueryResults caller, SetQueryArgs queryArgs)

Parameters

Type	Name	Description
IUsesSetQueryResults	caller	The object making the query
SetQueryArgs	queryArgs	The different specified data requirements we are querying for

Returns

Type	Description
QueryMatchID	A ID that identifies this series of queries

UnregisterSetQuery(IUsesSetQueryResults, QueryMatchID, Boolean)

Notifies the MARS backend that a particular set query is no longer needed. This function is not required if the Registration was oneShot - the query will be unregistered automatically

Declaration

public static bool UnregisterSetQuery(this IUsesSetQueryResults caller, QueryMatchID eventMatchId, bool allMatches = false)

Parameters

Type	Name	Description
IUsesSetQueryResults	caller	The object that had made a query
QueryMatchID	eventMatchId	The identifier of the query
Boolean	allMatches	Whether to unregister all matches referring to the same query as eventMatchId

Returns

Type	Description
Boolean	True if the query was stopped, false if the query was not currently running