Class ReturnHomeState

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

AI State for returning the NPC to its home position. Handles healing and movement speed adjustments.

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

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseAIState>

BaseAIState

ReturnHomeState

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

CompleteHealOnReturn

If true, the NPC will be fully healed upon returning home.

public bool CompleteHealOnReturn

Field Value

bool

HomeArrivalRadius

How close to home counts as home. Also the fallback scatter radius when home itself cannot be sampled onto the NavMesh.

[Tooltip("Distance from home that counts as arriving.")]
public float HomeArrivalRadius

Field Value

float

Methods

Enter(AIController)

Called when the state is entered. Sets the NPC's destination to home, increases speed, and heals if applicable.

public override void Enter(AIController controller)

Parameters

controller AIController

The AI controller managing this NPC.

Exit(AIController)

Called when the state is exited. Resets movement speed and optionally disables immortality.

public override void Exit(AIController controller)

Parameters

controller AIController

The AI controller managing this NPC.

UpdateState(AIController, float)

Called every frame while in this state. Checks if the NPC has reached its home destination and transitions to random movement.

public override void UpdateState(AIController controller, float deltaTime)

Parameters

controller AIController

The AI controller managing this NPC.

deltaTime float

Time since last update.