Interface IUnrealHookClient

An interface for a game client which can execute generic game state queries.

Inherited Members

IUnrealConsoleCommandClient.ExecuteConsoleCommand(string, bool, CancellationToken)

Namespace: Microsoft.XboxStudios.GameStateTracker.Unreal

Assembly: GameStateTracker.Unreal.dll

Syntax

public interface IUnrealHookClient : IUnrealConsoleCommandClient

Methods

GetActorProperties(ObjectInfo, IReadOnlyCollection<string>, CancellationToken)

Retrieves property values for all actors matching the given query.

Declaration

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

Parameters

Type	Name	Description
ObjectInfo	query	The actors 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 actor and property value.

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.