Class ParameterMetadata

Contains metadata for a parameter.

Inheritance

object

ParameterMetadata

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Microsoft.XboxStudios.BotBrain

Assembly: BotBrain.Abstractions.dll

Syntax

public class ParameterMetadata

Constructors

ParameterMetadata()

Initializes a new instance of the ParameterMetadata class.

Declaration

public ParameterMetadata()

ParameterMetadata(string, string?, string?)

Initializes a new instance of the ParameterMetadata class.

Declaration

public ParameterMetadata(string name, string? displayType = null, string? comment = null)

Parameters

Type	Name	Description
string	name	The parameter name.
string	displayType	The parameter display type.
string	comment	The comment, which may be used as a tooltip.

Properties

Category

Gets or sets the parameter's category name.

Declaration

public string? Category { get; set; }

Property Value

Type	Description
string

Comment

Gets or sets the comment, which may be used as a tooltip.

Declaration

public string? Comment { get; set; }

Property Value

Type	Description
string

DisplayName

Gets or sets the display name.

Declaration

public string? DisplayName { get; set; }

Property Value

Type	Description
string

DisplayType

Gets or sets the display type, which may be used to display a control.

Declaration

public string? DisplayType { get; set; }

Property Value

Type	Description
string

EnumName

Gets or sets the parameter's enumeration type name, which is used to look up its allowed values.

Declaration

public string? EnumName { get; set; }

Property Value

Type	Description
string

InitialValue

Gets or sets the initial value to set when the parameter is added to a brain.

Declaration

public object? InitialValue { get; set; }

Property Value

Type	Description
object

Remarks

This only affects UI; it does not actually set a default value for the parameter.

Name

Gets or sets the name.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Range

Gets or sets the range of allowed values.

Declaration

public ParameterRange? Range { get; set; }

Property Value

Type	Description
ParameterRange