Class Entity

Character class of the game. Provides an interface for health/damage system. Entities will be disabled when their health goes down to or below 0.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

Entity

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

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

Namespace: LobsterFramework

Assembly: LobsterFramework.dll

Syntax

[AddComponentMenu("Entity")]
public class Entity : MonoBehaviour

Fields

onDamaged

Declaration

public UnityAction<Damage> onDamaged

Field Value

Type	Description
UnityAction<Damage>

onPostureStatusChange

Declaration

public UnityAction<bool> onPostureStatusChange

Field Value

Type	Description
UnityAction<bool>

Properties

Health

Declaration

public float Health { get; }

Property Value

Type	Description
float

IsDead

Declaration

public bool IsDead { get; }

Property Value

Type	Description
bool

LatestDamageInfo

Declaration

public Damage LatestDamageInfo { get; }

Property Value

Type	Description
Damage

MaxHealth

Declaration

public float MaxHealth { get; }

Property Value

Type	Description
float

MaxPosture

Declaration

public float MaxPosture { get; }

Property Value

Type	Description
float

Posture

Declaration

public float Posture { get; }

Property Value

Type	Description
float

PostureBroken

Declaration

public bool PostureBroken { get; }

Property Value

Type	Description
bool

RegenSuppressed

Declaration

public bool RegenSuppressed { get; }

Property Value

Type	Description
bool

Methods

Damage(Damage)

Declaration

public void Damage(Damage damage)

Parameters

Type	Name	Description
Damage	damage

Damage(float, float, Entity, DamageType)

Add damage to the entity, the damage will be dealt on update of next frame

Declaration

public void Damage(float health, float posture, Entity source = null, DamageType type = DamageType.General)

Parameters

Type	Name	Description
float	health	The amount of health damage
float	posture	The amount of posture damage
Entity	source	The source of this attack
DamageType	type	The type of the damage

Defense(Damage)

Add a flat damage reduction to the entity, the damage taken will be reduced by the specified amount on update of next frame

Declaration

public void Defense(Damage defense)

Parameters

Type	Name	Description
Damage	defense

Heal(Damage)

Declaration

public void Heal(Damage heal)

Parameters

Type	Name	Description
Damage	heal

ResetStatus()

Reset the entity to its full health and posture and clear all of the damage and effects

Declaration

public void ResetStatus()