Interface IUnrealGameHooks
An interface for tools to interact with UnrealToolkit's RPC game hooks.
Namespace: Microsoft.XboxStudios.UnrealToolkit
Assembly: UnrealToolkit.Abstractions.dll
Syntax
public interface IUnrealGameHooksMethods
View SourceGetAutoCompleteCommandsAsync(CancellationToken)
Gets the auto complete data from the console in game.
Declaration
Task<IEnumerable<(string Command, string Description)>> GetAutoCompleteCommandsAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A cancellation token for the operation. |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<(string Command, string Description)>> | List of console commands from the console auto complete. |
GetCurrentMapAsync(CancellationToken)
Get some data of the current map.
Declaration
Task<(string Name, string Url)> GetCurrentMapAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A cancellation token for the operation. |
Returns
| Type | Description |
|---|---|
| Task<(string Name, string Url)> | Data of the current map. |
LoadMapAsync(string, CancellationToken)
Load the specified map.
Declaration
Task LoadMapAsync(string mapFilePath, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | mapFilePath | The path to the map. |
| CancellationToken | cancellationToken | A cancellation token for the operation. |
Returns
| Type | Description |
|---|---|
| Task | A Task representing the asynchronous operation. |