Class PatrolState

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Waypoint patrol. Walks the spawner-supplied waypoint ring in order.

[CreateAssetMenu(fileName = "New AI Patrol State", menuName = "FishMMO/Character/NPC/AI/Patrol State", order = 0)]
public class PatrolState : BaseAIState, ICachedObject

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseAIState>

BaseAIState

PatrolState

Implements

ICachedObject

Inherited Members

BaseAIState.LeashUpdateRate

BaseAIState.MinLeashRange

BaseAIState.MaxLeashRange

BaseAIState.DetectionRadius

BaseAIState.EnemyLayers

BaseAIState.LineOfSightBlockingLayers

BaseAIState.KeepsCombatTarget

BaseAIState.GetUpdateRate()

BaseAIState.GetUpdateRate(AIController)

BaseAIState.RandomizeRate(AIController, float, float)

BaseAIState.ReturnToCombatOrIdle(AIController)

BaseAIState.HasLineOfSight(AIController, ICharacter)

BaseAIState.SweepForEnemies(AIController, List<ICharacter>)

CachedScriptableObject<BaseAIState>.ID

CachedScriptableObject<BaseAIState>.AddToCache(string)

CachedScriptableObject<BaseAIState>.RemoveFromCache()

CachedScriptableObject<BaseAIState>.OnLoad(string, string, int)

CachedScriptableObject<BaseAIState>.OnUnload(string, string, int)

CachedScriptableObject<BaseAIState>.Get<U>(int)

CachedScriptableObject<BaseAIState>.GetFirst<U>()

CachedScriptableObject<BaseAIState>.GetCache<U>()

CachedScriptableObject<BaseAIState>.Get<U>(HashSet<int>)

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetEntityId()

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.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

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.FindObjectsByType<T>()

Object.FindObjectsByType<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)

Fields

MaxSkippedWaypoints

Consecutive unreachable waypoints tolerated before the NPC gives up on patrolling.

[Tooltip("Consecutive unreachable waypoints before the NPC abandons its patrol.")]
public int MaxSkippedWaypoints

Field Value

int

Remarks

Guards against a waypoint ring where every entry has drifted off the NavMesh: without a bound the NPC would advance through the whole ring every tick forever, never moving.

WaypointTolerance

How close the NPC must get to a waypoint before moving on to the next one.

[Tooltip("Distance from a waypoint that counts as reaching it.")]
public float WaypointTolerance

Field Value

float

Methods

Enter(AIController)

Starts patrolling from the nearest waypoint.

public override void Enter(AIController controller)

Parameters

controller AIController

The AI controller.

Exit(AIController)

Called when exiting the Patrol state.

public override void Exit(AIController controller)

Parameters

controller AIController

The AI controller.

UpdateState(AIController, float)

Advances to the next waypoint on arrival, and recovers when a waypoint cannot be reached.

public override void UpdateState(AIController controller, float deltaTime)

Parameters

controller AIController

The AI controller.

deltaTime float

Seconds since the previous AI tick.

Remarks

The previous arrival test was !pathPending && remainingDistance < 1, which is also exactly what an agent with no path at all reports. A patrol whose first waypoint failed to sample onto the NavMesh therefore "arrived" at every waypoint in the ring, once per tick, without taking a single step.