Interface IScenario

A scenario that runs within a quality pass.

Inherited Members
Namespace: Microsoft.XboxStudios.BotBrain.Overmind
Assembly: BotBrain.Overmind.dll
Syntax
public interface IScenario : IEquatable<IScenario?>, IBasedOn<IScenario>, IBasedOn

Properties

View Source

AssignedDevices

Gets an enumeration of devices assigned to this scenario.

Declaration
IEnumerable<IDevice> AssignedDevices { get; }
Property Value
Type Description
IEnumerable<IDevice>
View Source

IsConcurrent

Gets or sets a value indicating whether or not this scenario can run concurrently.

Declaration
bool IsConcurrent { get; set; }
Property Value
Type Description
bool
View Source

Name

Gets or sets the scenario name.

Declaration
string Name { get; set; }
Property Value
Type Description
string
View Source

NumDevicesAssigned

Gets a value indicating how many devices this scenario has assigned.

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

NumDevicesRequired

Gets a value indicating how many devices this scenario requires.

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

Status

Gets a value indicating whether this scenario is queued, started or finished.

Declaration
ScenarioStatus Status { get; }
Property Value
Type Description
ScenarioStatus
View Source

Type

Gets the type name.

Declaration
string Type { get; }
Property Value
Type Description
string

Methods

View Source

FlagFailedIfUnfinished(OvermindState)

Checks the scenario to see if it finished, and if not then flag it as failed.

Declaration
void FlagFailedIfUnfinished(OvermindState state)
Parameters
Type Name Description
OvermindState state

The overmind state.
View Source

Update(OvermindState)

Called to update the scenario based on the overmind state.

Declaration
void Update(OvermindState state)
Parameters
Type Name Description
OvermindState state

The overmind state.

Extension Methods