Show / Hide Table of Contents

Interface IRequirement

An interface for a requirement for a scenario, such as its stop conditions.

Inherited Members
IEquatable<IRequirement>.Equals(IRequirement)
Namespace: Microsoft.XboxStudios.BotBrain.Overmind
Assembly: BotBrain.Overmind.dll
Syntax
public interface IRequirement : IEquatable<IRequirement?>

Properties

View Source

Type

Gets the type name.

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

Methods

View Source

OnStarted(IRoleBasedScenario, OvermindState)

Called when the scenario starts.

Declaration
void OnStarted(IRoleBasedScenario scenario, OvermindState state)
Parameters
Type Name Description
IRoleBasedScenario scenario

The scenario.

OvermindState state

The overmind state.

View Source

Update(IRoleBasedScenario, OvermindState)

Determines if the requirement is satisfied.

Declaration
bool Update(IRoleBasedScenario scenario, OvermindState state)
Parameters
Type Name Description
IRoleBasedScenario scenario

The scenario.

OvermindState state

The overmind state.

Returns
Type Description
bool

True if it's satisfied.

  • View Source
In this article
Back to top Generated by DocFX