Interface IConsideration<TState, TBot, TAction>

Represents a function that gives a score to actions recommended by urges.

Inherited Members

IConsideration.Name

IConsideration.Type

IEquatable<IConsideration>.Equals(IConsideration)

Namespace: Microsoft.XboxStudios.BotBrain

Assembly: BotBrain.Core.dll

Syntax

public interface IConsideration<TState, TBot, TAction> : IConsideration, IEquatable<IConsideration> where TBot : IAutomatedBot<TAction>

Type Parameters

Name	Description
TState	A title-specific state object.
TBot	A title-specific bot object that implements IAutomatedBot<TAction>.
TAction	The title-specific bot action that implements IEquatable<T>.

Properties

Brain

Gets or sets the brain using this consideration.

Declaration

IBotBrain<TState, TBot, TAction>? Brain { get; set; }

Property Value

Type	Description
IBotBrain<TState, TBot, TAction>

Methods

Evaluate(TState, TBot, IReadOnlyCollection<IUrge<TState, TBot, TAction>>, in UrgeResult<TState, TBot, TAction>, out ConsiderationResult)

Evaluates the consideration given an urge result.

Declaration

double? Evaluate(TState state, TBot bot, IReadOnlyCollection<IUrge<TState, TBot, TAction>> urges, in UrgeResult<TState, TBot, TAction> urgeResult, out ConsiderationResult considerationResult)

Parameters

Type	Name	Description
TState	state	The state.
TBot	bot	The bot.
IReadOnlyCollection<IUrge<TState, TBot, TAction>>	urges	The urges which were active given this state.
UrgeResult<TState, TBot, TAction>	urgeResult	The urge result to evaluate.
ConsiderationResult	considerationResult	Outputs the intermediate values used during evaluation.

Returns

Type	Description
double?	A score for the urge result, between 0 and 1, or null.