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

Friction condition. Activates when friction is above or below a given threshold. More...

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

Public Member Functions

override bool CheckCondition (Character character, object other)
 Checks the condition. For example a check when entering a trigger. 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 requiredFriction
 What friction do we activate on. More...
 
bool frictionMustBeLessThan
 If true friction must be less than or equal to provided number, else it must be more than or equal to. 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

Friction condition. Activates when friction is above or below a given threshold.

Member Function Documentation

◆ CheckCondition()

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

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

Returns
true

false

Parameters
characterCharacter.
otherOther.

Reimplemented from PlatformerPro.AdditionalCondition.

Member Data Documentation

◆ frictionMustBeLessThan

bool PlatformerPro.FrictionCondition.frictionMustBeLessThan

If true friction must be less than or equal to provided number, else it must be more than or equal to.

◆ requiredFriction

float PlatformerPro.FrictionCondition.requiredFriction

What friction do we activate on.


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