Class PlannerSettings
Settings for the control of the planning algorithm iterating on the current plan
Namespace: Unity.AI.Planner
Syntax
[Serializable]
public class PlannerSettingsFields
CapPlanSize
Enables setting a maximum plan size.
Declaration
[Tooltip("Enables setting a maximum plan size.")]
public bool CapPlanSizeField Value
| Type | Description |
|---|---|
| Boolean |
CapPlanUpdates
Enables setting a maximum number of planning updates per plan.
Declaration
[Tooltip("Enables setting a maximum number of planning updates per plan.")]
public bool CapPlanUpdatesField Value
| Type | Description |
|---|---|
| Boolean |
GraphBackpropagationJobMode
Specifies the job type to run for updating state values in the plan.
Declaration
[Tooltip("Specifies the job type to run for updating state values in the plan. [Sequential or Parallel]")]
public BackpropagationJobMode GraphBackpropagationJobModeField Value
| Type | Description |
|---|---|
| BackpropagationJobMode |
GraphSelectionJobMode
Specifies the job type to run for selecting states to expand.
Declaration
[Tooltip("Specifies the job type to run for selecting states to expand. [Sequential or Parallel]")]
public SelectionJobMode GraphSelectionJobModeField Value
| Type | Description |
|---|---|
| SelectionJobMode |
MaxStatesInPlan
The maximum number of states in the plan.
Declaration
[Tooltip("The maximum number of states in the plan.")]
public int MaxStatesInPlanField Value
| Type | Description |
|---|---|
| Int32 |
MaxUpdates
The maximum number of planning updates per plan.
Declaration
[Tooltip("The maximum number of planning updates per plan.")]
public int MaxUpdatesField Value
| Type | Description |
|---|---|
| Int32 |
MinFramesPerPlanningUpdate
The number of frames to delay between each planning update.
Declaration
[FormerlySerializedAs("MinFramesPerSearchUpdate")]
[Tooltip("The number of frames to delay between each planning update.")]
public int MinFramesPerPlanningUpdateField Value
| Type | Description |
|---|---|
| Int32 |
PlanningIterationsPerUpdate
The number of planning iterations to be completed by each update.
Declaration
[FormerlySerializedAs("SearchIterationsPerUpdate")]
[Tooltip("The number of planning iterations to be completed by each update.")]
public int PlanningIterationsPerUpdateField Value
| Type | Description |
|---|---|
| Int32 |
RootEstimatedRewardTolerance
The maximum tolerance required before the planning process ceases.
Declaration
[FormerlySerializedAs("RootPolicyValueTolerance")]
[Tooltip("The maximum tolerance required before the planning process ceases.")]
public float RootEstimatedRewardToleranceField Value
| Type | Description |
|---|---|
| Single |
StateExpansionBudgetPerIteration
The number of states to expand within each planning iteration.
Declaration
[Tooltip("The number of states to expand within each planning iteration.")]
public int StateExpansionBudgetPerIterationField Value
| Type | Description |
|---|---|
| Int32 |
StopPlanningWhenToleranceAchieved
Enables setting a tolerance for the next immediate decision of the plan.
Declaration
[Tooltip("Enables setting a tolerance for the next immediate decision of the plan.")]
public bool StopPlanningWhenToleranceAchievedField Value
| Type | Description |
|---|---|
| Boolean |
UseCustomPlanningFrequency
Enables the delay of planning update by a fixed number of frames.
Declaration
[FormerlySerializedAs("UseCustomSearchFrequency")]
[Tooltip("Enables the delay of planning update by a fixed number of frames.")]
public bool UseCustomPlanningFrequencyField Value
| Type | Description |
|---|---|
| Boolean |