Condition which requires a specific amount of health. More...

Inheritance diagram for PlatformerPro.MinimumHealthCondition:

Public Member Functions
override bool	CheckCondition (Character character, object other)
	Checks the condition. For example a check when entering a trigger. More...

override void	Activated (Character character, object other)
	Applies any activation effects. More...

Public Member Functions inherited from PlatformerPro.AdditionalCondition
virtual bool	CheckInverseCondition (Character character, object other)
	Checks the inverse condition. For example a check when leaving a trigger. More...

Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual void	Validate (PlatformerProMonoBehaviour myTarget)
	Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...

Public Attributes
int	requiredHealth
	If this is not empty require the character to have an item with the matching type before triggering. More...

int	numberConsumed = 0
	The optional number of the item to consume when the effect is activated. More...

bool	cacheCharacterHealth = true
	If only one character will ever use this, save a reference to the cached health. More...

Public Attributes inherited from PlatformerPro.AdditionalCondition
bool	applyOnInverse
	If true condition will be applied on inverse (for example trigger exit as well as enter). More...

Protected Attributes
CharacterHealth	characterHealth
	The character health More...

Additional Inherited Members
Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string	Header `[get]`
	Gets the header string used to describe the component. More...

virtual string	DocLink `[get]`
	Gets a link to documentation site. More...

virtual string	VideoLink `[get]`
	Gets a link to a youtube video. More...

virtual string	Deprecated `[get]`
	If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...

Detailed Description

Condition which requires a specific amount of health.

Member Function Documentation

◆ Activated()

override void PlatformerPro.MinimumHealthCondition.Activated	(	Character	character,
		object	other
	)

virtual

Applies any activation effects.

Parameters

character	Character.
other	Other object supporting the condition.

Reimplemented from PlatformerPro.AdditionalCondition.

◆ CheckCondition()

override bool PlatformerPro.MinimumHealthCondition.CheckCondition	(	Character	character,
		object	other
	)

virtual

Checks the condition. For example a check when entering a trigger.

Returns: true, if enter trigger was shoulded, false otherwise.

Parameters

character	Character.
other	Other.

Reimplemented from PlatformerPro.AdditionalCondition.

Member Data Documentation

◆ cacheCharacterHealth

bool PlatformerPro.MinimumHealthCondition.cacheCharacterHealth = true

If only one character will ever use this, save a reference to the cached health.

◆ characterHealth

CharacterHealth PlatformerPro.MinimumHealthCondition.characterHealth

protected

The character health

◆ numberConsumed

int PlatformerPro.MinimumHealthCondition.numberConsumed = 0

The optional number of the item to consume when the effect is activated.

◆ requiredHealth

int PlatformerPro.MinimumHealthCondition.requiredHealth

If this is not empty require the character to have an item with the matching type before triggering.

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Conditions/MinimumHealthCondition.cs

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members