Interface IBotWithQueue

The interface for an automated bot with a queue of actions.

Inherited Members
Namespace: Microsoft.XboxStudios.BotBrain
Assembly: BotBrain.Abstractions.dll
Syntax
public interface IBotWithQueue : IAutomatedBot

Properties

View Source

QueueCount

Gets the number of actions in the queue.

Declaration
int QueueCount { get; }
Property Value
Type Description
int
View Source

QueueIndex

Gets the index of the current action in the queue.

Declaration
int QueueIndex { get; }
Property Value
Type Description
int

Methods

View Source

Start(int)

Starts executing the bot's queue from the given index.

Declaration
Task Start(int queueIndex)
Parameters
Type Name Description
int queueIndex

The queue index.
Returns
Type Description
Task

A task that completes once the queue begins.

Events

View Source

QueueStarted

Occurs when the bot queue is started.

Declaration
event EventHandler QueueStarted
Event Type
Type Description
EventHandler
View Source

QueueStopped

Occurs when the bot queue is finished.

Declaration
event EventHandler QueueStopped
Event Type
Type Description
EventHandler

Extension Methods