Class OvermindActionCompound

Represents multiple bot actions to run within the overmind.

Inheritance
object
CancellableOperationBase<OvermindBot>
OvermindAction
OvermindActionCompound
Implements
Inherited Members
Namespace: Microsoft.XboxStudios.BotBrain.Overmind
Assembly: BotBrain.Overmind.dll
Syntax
public class OvermindActionCompound : OvermindAction, ICancellableOperation<OvermindBot>, IOperation<OvermindBot>, ICancellableOperation, IOperation

Constructors

View Source

OvermindActionCompound(params OvermindAction[])

Initializes a new instance of the OvermindActionCompound class.

Declaration
public OvermindActionCompound(params OvermindAction[] actions)
Parameters
Type Name Description
OvermindAction[] actions

The actions to run.
View Source

OvermindActionCompound(string)

Initializes a new instance of the OvermindActionCompound class.

Declaration
[JsonConstructor]
protected OvermindActionCompound(string name)
Parameters
Type Name Description
string name

The action name.

Properties

View Source

Targets

Gets an enumeration of devices to apply this action to.

Declaration
public override IEnumerable<IDevice> Targets { get; }
Property Value
Type Description
IEnumerable<IDevice>
Overrides

Methods

View Source

ExecuteOn(OvermindBot, CancellationToken)

Runs the operation on an item.

Declaration
protected override Task<bool> ExecuteOn(OvermindBot item, CancellationToken token)
Parameters
Type Name Description
OvermindBot item

The item.
CancellationToken token

A token to monitor for cancellation.
Returns
Type Description
Task<bool>

A task that returns a boolean indicating success or failure when the operation completes.
Overrides

Implements