Class WanderState

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Wandering behaviour. The NPC drifts to random points around its home, pausing at idle now and then.

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

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseAIState>

BaseAIState

WanderState

Implements

ICachedObject

Inherited Members

BaseAIState.LeashUpdateRate

BaseAIState.MinLeashRange

BaseAIState.MaxLeashRange

BaseAIState.DetectionRadius

BaseAIState.EnemyLayers

BaseAIState.LineOfSightBlockingLayers

BaseAIState.KeepsCombatTarget

BaseAIState.GetUpdateRate()

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

For a pet, Home is its owner, so the same state produces "mill about near the player" without any pet-specific code.

Fields

AlwaysPickNewDestination

If true, the NPC picks a new destination on every update instead of walking to the current one.

public bool AlwaysPickNewDestination

Field Value

bool

IdleChance

Chance (0-1) of standing idle instead of picking another destination on arrival.

[Range(0, 1)]
[Tooltip("Chance to pause at idle on arrival instead of wandering on.")]
public float IdleChance

Field Value

float

MaxUpdateRate

If greater than the base update rate, the update rate is randomized between the two.

[Tooltip("If max update rate is greater than the update rate it will return a random range between the two.")]
public float MaxUpdateRate

Field Value

float

WanderRadius

The radius within which the NPC will wander from its home position.

public float WanderRadius

Field Value

float

Methods

Enter(AIController)

Sets off toward a first destination.

public override void Enter(AIController controller)

Parameters

controller AIController

The AI controller managing this NPC.

Remarks

Entering used to do nothing at all, leaving the NPC pathless until UpdateState happened to notice — and the check it used to notice with could not distinguish "no path" from "arrived".

Exit(AIController)

Called when the state is exited.

public override void Exit(AIController controller)

Parameters

controller AIController

The AI controller managing this NPC.

GetUpdateRate(AIController)

Returns the update rate for this state, randomized when MaxUpdateRate exceeds the base rate.

public override float GetUpdateRate(AIController controller)

Parameters

controller AIController

The AI controller running this state.

Returns

float

Update rate in seconds.

UpdateState(AIController, float)

Walks to the current destination, then decides whether to idle or wander on.

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.