Condition which requires a cooldown timer to expire; More...

Inheritance diagram for PlatformerPro.CoolDownCondition:

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
float	coolDownTime = 1.0f
	The cool down time. More...

bool	startEnabled = true
	Should we start with the timer expired, or do we need to charge for first use too? 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...

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 cooldown timer to expire;

Member Function Documentation

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

virtual

Applies any activation effects.

Parameters

character	Character.
other	Other object supporting the condition.

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

virtual

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

Parameters

character	Character.
other	Other.

float PlatformerPro.CoolDownCondition.coolDownTime = 1.0f

The cool down time.

float PlatformerPro.CoolDownCondition.currentTimer = 0.0f

protected

Current cool down timer.

bool PlatformerPro.CoolDownCondition.startEnabled = true

Should we start with the timer expired, or do we need to charge for first use too?

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

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