Class BehaviorGraphAgent

Behavior agent component.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

BehaviorGraphAgent

Implements

ISerializationCallbackReceiver

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Unity.Behavior

Assembly: Unity.Behavior.dll

Syntax

[AddComponentMenu("AI/Behavior Agent")]
public class BehaviorGraphAgent : MonoBehaviour, ISerializationCallbackReceiver

Properties

BlackboardReference

The blackboard associated with the agent's graph.

Declaration

public BlackboardReference BlackboardReference { get; }

Property Value

Type	Description
BlackboardReference

Graph

The graph of behaviours to be executed by the agent.

Declaration

public BehaviorGraph Graph { get; set; }

Property Value

Type	Description
BehaviorGraph

Methods

Deserialize<TSerializedFormat>(TSerializedFormat, IBehaviorSerializer<TSerializedFormat>, IUnityObjectResolver<string>)

Deserializes data on to the associated BehaviorGraph.

Declaration

public void Deserialize<TSerializedFormat>(TSerializedFormat serialized, RuntimeSerializationUtility.IBehaviorSerializer<TSerializedFormat> serializer, RuntimeSerializationUtility.IUnityObjectResolver<string> resolver)

Parameters

Type	Name	Description
TSerializedFormat	serialized	Serialized data.
RuntimeSerializationUtility.IBehaviorSerializer<TSerializedFormat>	serializer	Serializer to use.
RuntimeSerializationUtility.IUnityObjectResolver<string>	resolver	Object resolver to use.

Type Parameters

Name	Description
TSerializedFormat	Type of serialized data.

End()

Ends the execution of the agent's behavior graph.

Declaration

public void End()

GetVariable(string, out BlackboardVariable)

Gets the variable associated with the specified name.

Declaration

public bool GetVariable(string variableName, out BlackboardVariable variable)

Parameters

Type	Name	Description
string	variableName	The name of the variable
BlackboardVariable	variable	Contains the value associated with the specified name, if the named variable is found; otherwise, the default value is assigned.

Returns

Type	Description
bool	Returns true if a variable matching the name and type is found. Returns false otherwise.

GetVariable(SerializableGUID, out BlackboardVariable)

Gets a variable associated with the specified GUID.

Declaration

public bool GetVariable(SerializableGUID guid, out BlackboardVariable variable)

Parameters

Type	Name	Description
SerializableGUID	guid	The GUID of the variable to get
BlackboardVariable	variable	The variable associated with the specified GUID.

Returns

Type	Description
bool	Returns true if a variable with a matching GUID was found and false otherwise.

GetVariableID(string, out SerializableGUID)

Gets the ID of the variable associated with the specified name.

Declaration

public bool GetVariableID(string variableName, out SerializableGUID id)

Parameters

Type	Name	Description
string	variableName
SerializableGUID	id	Contains the ID associated with the specified name, if the named variable is found; otherwise, the default value is assigned.

Returns

Type	Description
bool	Returns true if a variable matching the name and type is found. Returns false otherwise.

GetVariable<TValue>(string, out BlackboardVariable<TValue>)

Gets a variable associated with the specified name and value type. For values of type subclassed from UnityEngine.Object, use the non-generic method.

Declaration

public bool GetVariable<TValue>(string variableName, out BlackboardVariable<TValue> variable)

Parameters

Type	Name	Description
string	variableName	The name of the variable
BlackboardVariable<TValue>	variable	The blackboard variable matching the name and value type

Returns

Type	Description
bool	Returns true if a variable matching the name and type is found. Returns false otherwise.

Type Parameters

Name	Description
TValue	The type of value stored by the variable

GetVariable<TValue>(SerializableGUID, out BlackboardVariable<TValue>)

Gets a variable associated with the specified GUID and value type.

Declaration

public bool GetVariable<TValue>(SerializableGUID guid, out BlackboardVariable<TValue> variable)

Parameters

Type	Name	Description
SerializableGUID	guid	The GUID of the variable to get
BlackboardVariable<TValue>	variable	The variable associated with the specified GUID.

Returns

Type	Description
bool	Returns true if a variable with a matching GUID and type was found and false otherwise.

Type Parameters

Name	Description
TValue	The value type of the variable

Init()

Initializes a new instance of the agent's behavior graph.

Declaration

public void Init()

OnAfterDeserialize()

Declaration

public void OnAfterDeserialize()

OnBeforeSerialize()

Declaration

public void OnBeforeSerialize()

Restart()

Restarts the execution of the agent's behavior graph.

Declaration

public void Restart()

Serialize<TSerializedFormat>(IBehaviorSerializer<TSerializedFormat>, IUnityObjectResolver<string>)

Serializes the associated BehaviorGraph to data of TSerializedFormat type.

Declaration

public TSerializedFormat Serialize<TSerializedFormat>(RuntimeSerializationUtility.IBehaviorSerializer<TSerializedFormat> serializer, RuntimeSerializationUtility.IUnityObjectResolver<string> resolver)

Parameters

Type	Name	Description
RuntimeSerializationUtility.IBehaviorSerializer<TSerializedFormat>	serializer	Serializer to use.
RuntimeSerializationUtility.IUnityObjectResolver<string>	resolver	Object resolver to use.

Returns

Type	Description
TSerializedFormat	Serialized data.

Type Parameters

Name	Description
TSerializedFormat	Type of serialized output.

SetVariableValue<TValue>(string, TValue)

Sets the value of a blackboard variable matching the specified name and value type.

Declaration

public bool SetVariableValue<TValue>(string variableName, TValue value)

Parameters

Type	Name	Description
string	variableName	The name of the variable
TValue	value	The value to assign to the variable

Returns

Type	Description
bool	Returns true if a variable matching the name and type is found and set. Returns false otherwise.

Type Parameters

Name	Description
TValue	The type of value stored by the variable

SetVariableValue<TValue>(SerializableGUID, TValue)

Sets the value of the variable associated with the specified GUID.

Declaration

public bool SetVariableValue<TValue>(SerializableGUID guid, TValue value)

Parameters

Type	Name	Description
SerializableGUID	guid	The guid associated with the variable
TValue	value	The value to assign to the variable

Returns

Type	Description
bool	Returns true if the value was set successfully and false otherwise.

Type Parameters

Name	Description
TValue	The value type of the variable

Start()

Begins execution of the agent's behavior graph.

Declaration

public void Start()

Update()

Ticks the agent's behavior graph and initializes and starts the graph if necessary.

Declaration

public void Update()

Implements

ISerializationCallbackReceiver