Interface IAutomatedBot
The interface for an automated bot.
Namespace: Microsoft.XboxStudios.BotBrain
Assembly: BotBrain.Abstractions.dll
Syntax
public interface IAutomatedBotProperties
View SourceCurrentAction
Gets the bot's current action.
Declaration
object? CurrentAction { get; }Property Value
| Type | Description |
|---|---|
| object |
CurrentUrge
Gets or sets the bot's current urge.
Declaration
object? CurrentUrge { get; set; }Property Value
| Type | Description |
|---|---|
| object |
IsRunning
Gets a value indicating whether the bot is executing an action.
Declaration
bool IsRunning { get; }Property Value
| Type | Description |
|---|---|
| bool |
Name
Gets or sets the name of the bot.
Declaration
string? Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
View SourceReset()
Resets the bot's current action and stops the bot.
Declaration
Task Reset()Returns
| Type | Description |
|---|---|
| Task | A task that completes once the bot is reset. |
Start()
Starts executing the bot's current action.
Declaration
Task Start()Returns
| Type | Description |
|---|---|
| Task | A task that completes once the action begins. |
Stop()
Stops executing the bot's current action.
Declaration
Task Stop()Returns
| Type | Description |
|---|---|
| Task | A task that completes once the action stops. |