Class OrbitState

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

Combat sub-state that strafes the NPC in a circle around its current target.

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

Inheritance

object

Object

ScriptableObject

CachedScriptableObject<BaseAIState>

BaseAIState

OrbitState

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

Enable KeepsCombatTarget on assets of this type — see GetBehindState for why. OrbitDuration bounds the manoeuvre so the NPC returns to attacking instead of circling indefinitely.

Fields

OrbitDuration

Seconds to orbit before returning to the attacking state. 0 orbits until something else interrupts, which for a combat sub-state means never attacking again.

[Tooltip("Seconds to orbit before rejoining the attack. 0 = orbit indefinitely.")]
public float OrbitDuration

Field Value

float

OrbitRadius

Radius of the orbit around the target.

public float OrbitRadius

Field Value

float

OrbitSpeed

Speed at which the AI orbits around the target.

public float OrbitSpeed

Field Value

float

RotationSpeed

Speed at which the AI rotates to face the target.

public float RotationSpeed

Field Value

float

Methods

Enter(AIController)

Called when entering the Orbit state. Initializes orbit angle and checks for target.

public override void Enter(AIController controller)

Parameters

controller AIController

The AI controller.

Exit(AIController)

Called when exiting the Orbit state. Can be used to stop movement or reset parameters.

public override void Exit(AIController controller)

Parameters

controller AIController

The AI controller.

UpdateState(AIController, float)

Called every frame to update the Orbit state. Handles orbit movement, rotation, and state transitions.

public override void UpdateState(AIController controller, float deltaTime)

Parameters

controller AIController

The AI controller.

deltaTime float

Frame time.