Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.ActionButtonCondition Class Reference

COndition which is true if user is pressing or holding jump. More...

Inheritance diagram for PlatformerPro.ActionButtonCondition:
PlatformerPro.AdditionalCondition PlatformerPro.PlatformerProMonoBehaviour

Public Member Functions

override bool CheckCondition (Character character, object other)
 Returns true if jump is being pressed. 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

int button
 Index of the action button to check. More...
 
bool mustBePressNotHold = false
 Set to true if the user must press jump while at the trigger. Otherwise holding jump will work 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 is true if user is pressing or holding jump.

Member Function Documentation

◆ CheckCondition()

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

Returns true if jump is being pressed.

Returns
true

false

Parameters
characterCharacter.
otherOther.

Reimplemented from PlatformerPro.AdditionalCondition.

Member Data Documentation

◆ button

int PlatformerPro.ActionButtonCondition.button

Index of the action button to check.

◆ mustBePressNotHold

bool PlatformerPro.ActionButtonCondition.mustBePressNotHold = false

Set to true if the user must press jump while at the trigger. Otherwise holding jump will work too.


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