Class RunBrainRole

A role to launch a game or application and run a bot brain.

Inheritance
object
RoleBase
RunBrainRole
CrashyRunBrainRole
Implements
Inherited Members
Namespace: Microsoft.XboxStudios.BotBrain.Overmind
Assembly: BotBrain.Overmind.dll
Syntax
public class RunBrainRole : RoleBase, IMetadataAccess, ILaunchGameRole, IRole, IEquatable<IRole>, IBasedOn<IRole>, IBasedOn
Remarks

Initializes a new instance of the RunBrainRole class.

Constructors

View Source

RunBrainRole(string?, GameConfiguration?, string?, int)

A role to launch a game or application and run a bot brain.

Declaration
public RunBrainRole(string? name = null, GameConfiguration? launch = null, string? brainName = null, int numDevices = 1)
Parameters
Type Name Description
string name

The role name.
GameConfiguration launch

The game to launch.
string brainName

The brain to run.
int numDevices

The number of devices in this role.
Remarks

Initializes a new instance of the RunBrainRole class.

Properties

View Source

BrainName

Gets or sets the name of the brain to run.

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

Launch

Gets the game to launch.

Declaration
public GameConfiguration Launch { get; set; }
Property Value
Type Description
GameConfiguration

Methods

View Source

CreateMetadata()

Used to create parameter metadata.

Declaration
protected override MetadataContainer CreateMetadata()
Returns
Type Description
MetadataContainer

A metadata container.
Overrides
View Source

Equals(IRole?)

Indicates whether the current object is equal to another object of the same type.

Declaration
public override bool Equals(IRole? other)
Parameters
Type Name Description
IRole other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
Overrides

Implements