Interface IUnityHookClient

An interface that represents a unity hook client, which executes unity object queries.

Namespace: Microsoft.XboxStudios.GameStateTracker.Unity

Assembly: GameStateTracker.Unity.dll

Syntax

public interface IUnityHookClient

Methods

GetAllPropertiesOfClass(string)

Gets all properties of the given class name.

Declaration

Task<IEnumerable<string>> GetAllPropertiesOfClass(string className)

Parameters

Type	Name	Description
string	className	The name of the class to get properties from.

Returns

Type	Description
Task<IEnumerable<string>>	An enumeration of the names of all properties in the class.

GetClassTree()

Creates the "class" tree in Unity. Instead this creates the tree of objects that are seen in the Unity editor. Root game objects sit at the base.

Declaration

Task<ILookup<string?, string>> GetClassTree()

Returns

Type	Description
Task<ILookup<string, string>>	A lookup table from root object names to its attached object names.

GetObjectProperties(ObjectInfo, IReadOnlyCollection<string>, CancellationToken)

Retrieves property values for all objects matching the given query.

Declaration

Task<IEnumerable<QueryResult>> GetObjectProperties(ObjectInfo query, IReadOnlyCollection<string> properties, CancellationToken token = default)

Parameters

Type	Name	Description
ObjectInfo	query	The objects to look for.
IReadOnlyCollection<string>	properties	The properties to retrieve.
CancellationToken	token	The cancellation token.

Returns

Type	Description
Task<IEnumerable<QueryResult>>	An enumeration of each matching object and property value.