Class KaijuUtilityBrain

Base brain class to implement for utility AI.

Inheritance
System.Object
KaijuBehaviour
KaijuUtilityBrain
Inherited Members
Namespace: KaijuSolutions.Agents.Utility
Syntax
public abstract class KaijuUtilityBrain : KaijuBehaviour

Fields

actions

The KaijuUtilityActions this brain can choose to perform.

Declaration
public List<KaijuUtilityAction> actions
Field Value
Type Description
System.Collections.Generic.List<KaijuUtilityAction>

Properties

Agent

The agent this brain is controlling.

Declaration
public KaijuAgent Agent { get; }
Property Value
Type Description
KaijuAgent

Current

The KaijuUtilityAction currently being performed.

Declaration
public KaijuUtilityAction Current { get; }
Property Value
Type Description
KaijuUtilityAction

Utilities

Get the utility scores for all actions.

Declaration
public List<(KaijuUtilityAction action, float utility)> Utilities { get; }
Property Value
Type Description
System.Collections.Generic.List<System.ValueTuple<KaijuUtilityAction, System.Single>>

Methods

Get<T>(String)

Get data from the blackboard.

Declaration
public T Get<T>(string key)
Parameters
Type Name Description
System.String key

The key.
Returns
Type Description
T

The found data in the blackboard.
Type Parameters
Name Description
T

The type of data to get.

Set(String, Object)

Set data in the blackboard.

Declaration
public void Set(string key, object value)
Parameters
Type Name Description
System.String key

The key.
System.Object value

The value.

SetBool(String, Object)

Set data as a boolean in the blackboard. This will attempt to convert non-Boolean values into a Boolean, treating non-zero values as true.

Declaration
public void SetBool(string key, object value)
Parameters
Type Name Description
System.String key

The key.
System.Object value

The value.

SetFloat(String, Object)

Set data as a float in the blackboard. This will attempt to convert non-float values into floats.

Declaration
public void SetFloat(string key, object value)
Parameters
Type Name Description
System.String key

The key.
System.Object value

The value.

SetFloatClamp(String, Object, Single, Single)

Set data as a float in the blackboard, clamped between a min and max value. This will attempt to convert non-float values into floats.

Declaration
public void SetFloatClamp(string key, object value, float min = 0F, float max = 1F)
Parameters
Type Name Description
System.String key

The key.
System.Object value

The value.
System.Single min

The minimum value.
System.Single max

The maximum value.

SetInteger(String, Object)

Set data as an integer in the blackboard. This will attempt to convert noninteger values into integers.

Declaration
public void SetInteger(string key, object value)
Parameters
Type Name Description
System.String key

The key.
System.Object value

The value.

SetIntegerClamp(String, Object, Int32, Int32)

Set data as an integer in the blackboard, clamped between a min and max value. This will attempt to convert noninteger values into integers.

Declaration
public void SetIntegerClamp(string key, object value, int min = 0, int max = 1)
Parameters
Type Name Description
System.String key

The key.
System.Object value

The value.
System.Int32 min

The minimum value.
System.Int32 max

The maximum value.

SetScaled(String, Object, Single, Single)

Set data as a float in the blackboard, scaled to [0, 1] based on a given min and max value. This will attempt to convert non-float values into floats.

Declaration
public void SetScaled(string key, object value, float min = 0F, float max = 1F)
Parameters
Type Name Description
System.String key

The key.
System.Object value

The value.
System.Single min

The minimum value to scale on.
System.Single max

The maximum value to scale on.

UpdateBlackboard()

Set any needed blackboard variables for choosing an action to perform.

Declaration
protected virtual void UpdateBlackboard()