Class RetreatState

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Moves the NPC away from its target until a safe distance is reached, then disengages.

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

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseAIState>

BaseAIState

RetreatState

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)

Remarks

Used both as the flee state for a Pathetic or Cautious personality and as a caster's emergency-retreat hand-off. Enable KeepsCombatTarget on assets of this type: the retreat direction is computed from the target, so clearing it on the way in would leave the NPC with no idea which way to run.

Fleeing is the movement most likely to run out of room — the NPC is by definition being pushed toward whatever is behind it — so every step of it is bounded. A cornered NPC that cannot retreat gives up and re-engages rather than standing against a wall being hit while a "retreating" state reports success.

Fields

MaxRetreatSeconds

Seconds the NPC will keep trying to retreat before accepting that it cannot.

[Tooltip("Seconds spent retreating before giving up. 0 = retreat until safe.")]
public float MaxRetreatSeconds

Field Value

float

RetreatDistance

How far the NPC moves away from its target on each retreat leg.

public float RetreatDistance

Field Value

float

SafeDistance

Distance from the target at which the NPC stops retreating.

public float SafeDistance

Field Value

float

Methods

Enter(AIController)

Picks the first retreat destination.

public override void Enter(AIController controller)

Parameters

controller AIController

The AI controller managing this NPC.

Exit(AIController)

Called when the state is exited.

public override void Exit(AIController controller)

Parameters

controller AIController

The AI controller managing this NPC.

UpdateState(AIController, float)

Keeps backing away until safe, cornered, or out of patience.

public override void UpdateState(AIController controller, float deltaTime)

Parameters

controller AIController

The AI controller managing this NPC.

deltaTime float

Seconds since the previous AI tick.