Condition which only passes if character is above/below a certain height. More...

Inheritance diagram for PlatformerPro.HeightCondition:

Public Member Functions
override bool	CheckCondition (Character character, object other)
	Returns true if character is above/below given height. 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...

virtual void	Activated (Character character, object other)
	Applies any activation effects. 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	height
	Y position of character. Character must be higher than this to pass. More...

bool	isRelative = true
	If true condition is relative to current transform, false for an absolute world position. More...

bool	mustBeBelow
	If true character must be at or below given height, false they must be at or above. 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 only passes if character is above/below a certain height.

Member Function Documentation

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

virtual

Returns true if character is above/below given height.

false

Parameters

character	Character.
other	Other.

float PlatformerPro.HeightCondition.height

Y position of character. Character must be higher than this to pass.

bool PlatformerPro.HeightCondition.isRelative = true

If true condition is relative to current transform, false for an absolute world position.

bool PlatformerPro.HeightCondition.mustBeBelow

If true character must be at or below given height, false they must be at or above.

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

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