Interface IOvermindSerializer

An interface used to save and load overmind resources.

Inherited Members

IBrainSerializer.BrainsFolder

IBrainSerializer.BotBrainFileExtension

IBrainSerializer.Initialize()

IBrainSerializer.IsReservedBrainFilename(string)

IBrainSerializer.LoadBrain(string)

IBrainSerializer.DeserializeBrain(string)

IBrainSerializer.SerializeBrain(IBotBrain, bool)

IBrainSerializer.LoadDefaultBrainParameters()

IMetadataAccess.ParameterNames

IMetadataAccess.GetParameterMetadata(string)

ITitleResourceHelper.GetTitleResourcePath(string)

IResourceHelper.GetResourcePath(string)

Namespace: Microsoft.XboxStudios.BotBrain.Overmind

Assembly: BotBrain.Overmind.dll

Syntax

public interface IOvermindSerializer : IBrainSerializer, IMetadataAccess, ITitleResourceHelper, IResourceHelper

Properties

RoleFileExtension

Gets the file extension for role files.

Declaration

string RoleFileExtension { get; }

Property Value

Type	Description
string

RolesOutputFolder

Gets the path to the folder containing role files.

Declaration

string RolesOutputFolder { get; }

Property Value

Type	Description
string

ScenarioFileExtension

Gets the file extension for scenario files.

Declaration

string ScenarioFileExtension { get; }

Property Value

Type	Description
string

ScenariosOutputFolder

Gets the path to the folder containing scenario files.

Declaration

string ScenariosOutputFolder { get; }

Property Value

Type	Description
string

Methods

DeserializeRequirement(string)

Deserializes a requirement from a string.

Declaration

IRequirement DeserializeRequirement(string contents)

Parameters

Type	Name	Description
string	contents	A string representation of a requirement.

Returns

Type	Description
IRequirement	The requirement.

DeserializeRole(string)

Deserializes a role from a string.

Declaration

IRole DeserializeRole(string contents)

Parameters

Type	Name	Description
string	contents	A string representation of a role.

Returns

Type	Description
IRole	The role.

DeserializeRoleFile(string)

Creates a role from a file.

Declaration

IRole DeserializeRoleFile(string file)

Parameters

Type	Name	Description
string	file	The file path.

Returns

Type	Description
IRole	The role.

DeserializeScenario(string)

Deserializes a scenario from a string.

Declaration

IScenario DeserializeScenario(string contents)

Parameters

Type	Name	Description
string	contents	A string representation of a scenario.

Returns

Type	Description
IScenario	The scenario.

DeserializeScenarioFile(string)

Creates a scenario from a file.

Declaration

IScenario DeserializeScenarioFile(string file)

Parameters

Type	Name	Description
string	file	The file path.

Returns

Type	Description
IScenario	The scenario.

LoadRole(string)

Loads the role instance.

Declaration

IRole? LoadRole(string name)

Parameters

Type	Name	Description
string	name	The role name.

Returns

Type	Description
IRole	The role.

LoadScenario(string)

Loads a scenario instance.

Declaration

IScenario? LoadScenario(string name)

Parameters

Type	Name	Description
string	name	The scenario name.

Returns

Type	Description
IScenario	The scenario.

LoadSettings(IParameterManager)

Loads the overmind settings.

Declaration

OvermindSettings LoadSettings(IParameterManager parameters)

Parameters

Type	Name	Description
IParameterManager	parameters	The parameters to load.

Returns

Type	Description
OvermindSettings	The overmind settings.

LoadSettings(string)

Loads the overmind settings.

Declaration

OvermindSettings LoadSettings(string parameters)

Parameters

Type	Name	Description
string	parameters	The parameters to load.

Returns

Type	Description
OvermindSettings	The overmind settings.

SaveSettings(OvermindSettings)

Saves the overmind settings to a string.

Declaration

string SaveSettings(OvermindSettings settings)

Parameters

Type	Name	Description
OvermindSettings	settings	The overmind settings.

Returns

Type	Description
string	The serialized settings.

SerializeRequirement(IRequirement, bool)

Serializes a requirement to a string.

Declaration

string SerializeRequirement(IRequirement requirement, bool indented = true)

Parameters

Type	Name	Description
IRequirement	requirement	The requirement.
bool	indented	If true, the output is indented.

Returns

Type	Description
string	A string representation of a requirement.

SerializeRole(IRole, bool)

Serializes a role to a string.

Declaration

string SerializeRole(IRole role, bool indented = true)

Parameters

Type	Name	Description
IRole	role	The role.
bool	indented	If true, the output is indented.

Returns

Type	Description
string	A string representation of a role.

SerializeScenario(IScenario, bool)

Serializes a scenario to a string.

Declaration

string SerializeScenario(IScenario scenario, bool indented = true)

Parameters

Type	Name	Description
IScenario	scenario	The scenario.
bool	indented	If true, the output is indented.

Returns

Type	Description
string	A string representation of a scenario.

Extension Methods

IOvermindSerializerExtensions.Clone(IOvermindSerializer, IRequirement)

IOvermindSerializerExtensions.Clone(IOvermindSerializer, IScenario)