Class DecisionRequester

The DecisionRequester component automatically request decisions for an Agent instance at regular intervals.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

DecisionRequester

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.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.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

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.MLAgents

Assembly: Unity.ML-Agents.dll

Syntax

[AddComponentMenu("ML Agents/Decision Requester", 0)]
[RequireComponent(typeof(Agent))]
[DefaultExecutionOrder(-10)]
public class DecisionRequester : MonoBehaviour

Remarks

Attach a DecisionRequester component to the same [GameObject] as the Agent component.

The DecisionRequester component provides a convenient and flexible way to trigger the agent decision making process. Without a DecisionRequester, your Agent implementation must manually call its RequestDecision() function.

Fields

DecisionPeriod

The frequency with which the agent requests a decision. A DecisionPeriod of 5 means that the Agent will request a decision every 5 Academy steps. ///

Declaration

[Range(1, 20)]
[Tooltip("The frequency with which the agent requests a decision. A DecisionPeriod of 5 means that the Agent will request a decision every 5 Academy steps.")]
public int DecisionPeriod

Field Value

Type	Description
int

DecisionStep

Indicates when to requests a decision. By changing this value, the timing of decision can be shifted even among agents with the same decision period. The value can be from 0 to DecisionPeriod - 1.

Declaration

[Range(0, 19)]
[Tooltip("Indicates when to requests a decision. By changing this value, the timing of decision can be shifted even among agents with the same decision period. The value can be from 0 to DecisionPeriod - 1.")]
public int DecisionStep

Field Value

Type	Description
int

TakeActionsBetweenDecisions

Indicates whether or not the agent will take an action during the Academy steps where it does not request a decision. Has no effect when DecisionPeriod is set to 1.

Declaration

[Tooltip("Indicates whether or not the agent will take an action during the Academy steps where it does not request a decision. Has no effect when DecisionPeriod is set to 1.")]
[FormerlySerializedAs("RepeatAction")]
public bool TakeActionsBetweenDecisions

Field Value

Type	Description
bool

Properties

Agent

Get the Agent attached to the DecisionRequester.

Declaration

public Agent Agent { get; }

Property Value

Type	Description
Agent

Methods

ShouldRequestAction(DecisionRequestContext)

Whether Agent.RequestAction should be called on this update step.

Declaration

protected virtual bool ShouldRequestAction(DecisionRequester.DecisionRequestContext context)

Parameters

Type	Name	Description
DecisionRequester.DecisionRequestContext	context	RequestDecision context.

Returns

Type	Description
bool	True if the agent RequestAction should be called on this update step, False if not.

ShouldRequestDecision(DecisionRequestContext)

Whether Agent.RequestDecision should be called on this update step.

Declaration

protected virtual bool ShouldRequestDecision(DecisionRequester.DecisionRequestContext context)

Parameters

Type	Name	Description
DecisionRequester.DecisionRequestContext	context	RequestDecision context.

Returns

Type	Description
bool	True if the agent RequestDecision should be called on this update step, False if not.