Manages the "vitals" of an object (health, regeneration, damage). More...

Inherits MonoBehaviour.

Static Public Member Functions
static bool	ApplyHit (Component targetObject, Vector3 location, float value=0f, GameObject sourceObject=null, string hitTag="", UJeli details=null)
	Apply a hit to a given object. More...

static bool	ApplyHit (Component targetObject, Vector3 location, float value=0f, Component sourceObject=null, string hitTag="", UJeli details=null)
	Apply a hit to a given object. More...

static bool	ApplyHit (GameObject targetObject, Vector3 location, float value=0f, Component sourceObject=null, string hitTag="", UJeli details=null)
	Apply a hit to a given object. More...

static bool	ApplyHit (GameObject targetObject, Vector3 location, float value=0f, GameObject sourceObject=null, string hitTag="", UJeli details=null)
	Apply a hit to a given object. More...

Public Attributes
float	BaseMaxHealth = 100f
	The base max health this object is allowed to have (before any boosts/penalties are applied). More...

string	VitalTag
	The vital "tag" of this object. Used by Hitter to selectively apply damage. More...

bool	HealthRegenEnabled = false
	Whether or not health regeneration is enabled. More...

float	HealthRegen = 0f
	The rate at which health is regenerated, in health units per second. More...

float	HealthRegenInterval = .5f
	The interval between each health regeneration tick, i.e. the granularity of regeneration. More...

float	HitTimeout = 0f
	The length of time after being hit that this object is invulnerable. More...

bool	DespawnWhenKilled = false
	Whether or not to automatically despawn this object when its health reaches zero. More...

MeterSticker	HealthMeter
	An optional health meter to render the health. More...

Vitals	RedirectHitsTo
	An optional Vitals component to which all incoming hits to this component are redirected. More...

Timeline< float >	Health
	The current health this object has. More...

Timeline< float >	MaxHealth
	The maximum health this object is allowed to have. More...

Properties
bool	IsInvulnerable `[get, set]`
	Whether or not the object is currently invulnerable. Note that this is not affected by the hit timeout. More...

bool	IsVulnerable `[get, set]`
	Whether or not the object is currently vulnerable. Note that this is not affected by the hit timeout. More...

float	CurrentHealth `[get, set]`
	The current health of the object. More...

float	CurrentNormalizedHealth `[get, set]`
	The current health of the object as a ratio of its maximum health. More...

bool	IsAlive `[get]`
	Whether or not the object's health is currently over zero. More...

bool	IsDead `[get]`
	Whether or not the object's health is currently zero. More...

Events
VitalsHitHandler	Hit = delegate {}
	Event fired whenever this object is hit. More...

VitalsKilledHandler	Killed = delegate {}
	Event fired whenever this object's health reaches zero. More...

VitalsRevivedHandler	Revived = delegate {}
	Event fired whenever this object's health changes from zero to non-zero. More...

Detailed Description

Manages the "vitals" of an object (health, regeneration, damage).

Definition at line 17 of file Vitals.cs.

Member Function Documentation

static bool Vitals.ApplyHit	(	Component	targetObject,
		Vector3	location,
		float	value = `0f`,
		GameObject	sourceObject = `null`,
		string	hitTag = `""`,
		UJeli	details = `null`
	)

inlinestatic

Apply a hit to a given object.

Parameters

targetObject	The object to hit.
location	The location of the hit.
value	The amount of damage.
sourceObject	An optional object that is the "source" of the hit.
hitTag	Optional, simple string tag to describe this hit.
details	Optional details about this hit.

Returns

Definition at line 192 of file Vitals.cs.

static bool Vitals.ApplyHit	(	Component	targetObject,
		Vector3	location,
		float	value = `0f`,
		Component	sourceObject = `null`,
		string	hitTag = `""`,
		UJeli	details = `null`
	)

inlinestatic

Apply a hit to a given object.

Parameters

targetObject	The object to hit.
location	The location of the hit.
value	The amount of damage.
sourceObject	An optional object that is the "source" of the hit.
hitTag	Optional, simple string tag to describe this hit.
details	Optional details about this hit.

Returns

Definition at line 208 of file Vitals.cs.

static bool Vitals.ApplyHit	(	GameObject	targetObject,
		Vector3	location,
		float	value = `0f`,
		Component	sourceObject = `null`,
		string	hitTag = `""`,
		UJeli	details = `null`
	)

inlinestatic

Apply a hit to a given object.

Parameters

targetObject	The object to hit.
location	The location of the hit.
value	The amount of damage.
sourceObject	An optional object that is the "source" of the hit.
hitTag	Optional, simple string tag to describe this hit.
details	Optional details about this hit.

Returns

Definition at line 224 of file Vitals.cs.

static bool Vitals.ApplyHit	(	GameObject	targetObject,
		Vector3	location,
		float	value = `0f`,
		GameObject	sourceObject = `null`,
		string	hitTag = `""`,
		UJeli	details = `null`
	)

inlinestatic

Apply a hit to a given object.

Parameters

targetObject	The object to hit.
location	The location of the hit.
value	The amount of damage.
sourceObject	An optional object that is the "source" of the hit.
hitTag	Optional, simple string tag to describe this hit.
details	Optional details about this hit.

Returns

Definition at line 240 of file Vitals.cs.

Member Data Documentation

float Vitals.BaseMaxHealth = 100f

The base max health this object is allowed to have (before any boosts/penalties are applied).

Definition at line 95 of file Vitals.cs.

bool Vitals.DespawnWhenKilled = false

Whether or not to automatically despawn this object when its health reaches zero.

Definition at line 119 of file Vitals.cs.

Timeline<float> Vitals.Health

The current health this object has.

Definition at line 132 of file Vitals.cs.

MeterSticker Vitals.HealthMeter

An optional health meter to render the health.

Definition at line 123 of file Vitals.cs.

float Vitals.HealthRegen = 0f

The rate at which health is regenerated, in health units per second.

Definition at line 107 of file Vitals.cs.

bool Vitals.HealthRegenEnabled = false

Whether or not health regeneration is enabled.

Definition at line 103 of file Vitals.cs.

float Vitals.HealthRegenInterval = .5f

The interval between each health regeneration tick, i.e. the granularity of regeneration.

Definition at line 111 of file Vitals.cs.

float Vitals.HitTimeout = 0f

The length of time after being hit that this object is invulnerable.

Definition at line 115 of file Vitals.cs.

Timeline<float> Vitals.MaxHealth

The maximum health this object is allowed to have.

Definition at line 136 of file Vitals.cs.

Vitals Vitals.RedirectHitsTo

An optional Vitals component to which all incoming hits to this component are redirected.

Definition at line 127 of file Vitals.cs.

string Vitals.VitalTag

The vital "tag" of this object. Used by Hitter to selectively apply damage.

Definition at line 99 of file Vitals.cs.

Property Documentation

float Vitals.CurrentHealth

getset

The current health of the object.

Definition at line 56 of file Vitals.cs.

float Vitals.CurrentNormalizedHealth

getset

The current health of the object as a ratio of its maximum health.

Definition at line 65 of file Vitals.cs.

bool Vitals.IsAlive

get

Whether or not the object's health is currently over zero.

Definition at line 80 of file Vitals.cs.

bool Vitals.IsDead

get

Whether or not the object's health is currently zero.

Definition at line 88 of file Vitals.cs.

bool Vitals.IsInvulnerable

getset

Whether or not the object is currently invulnerable. Note that this is not affected by the hit timeout.

Definition at line 37 of file Vitals.cs.

bool Vitals.IsVulnerable

getset

Whether or not the object is currently vulnerable. Note that this is not affected by the hit timeout.

Definition at line 47 of file Vitals.cs.

Event Documentation

VitalsHitHandler Vitals.Hit = delegate {}

Event fired whenever this object is hit.

Definition at line 22 of file Vitals.cs.

VitalsKilledHandler Vitals.Killed = delegate {}

Event fired whenever this object's health reaches zero.

Definition at line 26 of file Vitals.cs.

VitalsRevivedHandler Vitals.Revived = delegate {}

Event fired whenever this object's health changes from zero to non-zero.

Definition at line 30 of file Vitals.cs.

The documentation for this class was generated from the following file:

C:/Users/Dan/Documents/Doomsday/Liberi/Assets/Scripts/Components/Vitals.cs

Static Public Member Functions

Public Attributes

Properties

Events

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation