Class BlackboardVariable<DataType>

A base class for blackboard variables serialized by value.

Inheritance

object

BlackboardVariable

BlackboardVariable<DataType>

Inherited Members

BlackboardVariable.GUID

BlackboardVariable.Name

BlackboardVariable.OnValueChanged

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Muse.Behavior

Assembly: Unity.Muse.Behavior.dll

Syntax

[JsonObject(IsReference = true)]
[Serializable]
public class BlackboardVariable<DataType> : BlackboardVariable

Type Parameters

Name	Description
DataType	The type of value stored in the variable.

Constructors

BlackboardVariable()

BlackboardVariable constructor.

Declaration

public BlackboardVariable()

BlackboardVariable(DataType)

BlackboardVariable constructor.

Declaration

public BlackboardVariable(DataType value)

Parameters

Type	Name	Description
DataType	value	Datatype

Fields

m_Value

The value of the blackboard variable.

Declaration

[JsonProperty(IsReference = true, NullValueHandling = NullValueHandling.Ignore)]
[SerializeReference]
protected DataType m_Value

Field Value

Type	Description
DataType

Properties

ObjectValue

see ObjectValue

Declaration

[JsonIgnore]
public override sealed object ObjectValue { get; set; }

Property Value

Type	Description
object

Overrides

BlackboardVariable.ObjectValue

Type

see Type

Declaration

[JsonIgnore]
public override Type Type { get; }

Property Value

Type	Description
Type

Overrides

BlackboardVariable.Type

Value

see ObjectValue

Declaration

[JsonIgnore]
public DataType Value { get; set; }

Property Value

Type	Description
DataType

Methods

Equals(BlackboardVariable)

Declaration

public override bool Equals(BlackboardVariable other)

Parameters

Type	Name	Description
BlackboardVariable	other

Returns

Type	Description
bool

Overrides

BlackboardVariable.Equals(BlackboardVariable)

ValueEquals(BlackboardVariable)

Returns true if the values of the two variables are equal and false otherwise.

Declaration

public override bool ValueEquals(BlackboardVariable other)

Parameters

Type	Name	Description
BlackboardVariable	other	The variable whose value is compared to.

Returns

Type	Description
bool	Returns true if the values of the two variables are equal and false otherwise.

Overrides

BlackboardVariable.ValueEquals(BlackboardVariable)

ValueEquals(BlackboardVariable<DataType>)

Returns true if the values of the two variables are equal and false otherwise.

Declaration

public bool ValueEquals(BlackboardVariable<DataType> other)

Parameters

Type	Name	Description
BlackboardVariable<DataType>	other	The variable whose value is compared to.

Returns

Type	Description
bool	Returns true if the values of the two variables are equal and false otherwise.

Operators

explicit operator BlackboardVariable<DataType>(DataType)

Implicit conversion from DataType to BlackboardVariable.

Declaration

public static explicit operator BlackboardVariable<DataType>(DataType value)

Parameters

Type	Name	Description
DataType	value	Datatype value used to create a BlackboardVariable

Returns

Type	Description
BlackboardVariable<DataType>	Returns a Blackboard Variable with the given value.

implicit operator DataType(BlackboardVariable<DataType>)

Implicit conversion from BlackboardVariable to DataType.

Declaration

public static implicit operator DataType(BlackboardVariable<DataType> value)

Parameters

Type	Name	Description
BlackboardVariable<DataType>	value	The variable holding the DataType value

Returns

Type	Description
DataType	Returns the value stored in the Blackboard Variable.