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

Condition that is met only when character is standing on a certain type of ground. More...

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

Public Member Functions

override bool CheckCondition (Character character, object other)
 Returns true if character is standing on correct layer. 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

LayerMask groundLayer
 Layers character must be standing on. More...
 
bool resultIfNotGrounded
 The result if not grounded. 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 that is met only when character is standing on a certain type of ground.

Member Function Documentation

◆ CheckCondition()

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

Returns true if character is standing on correct layer.

Returns
true

false

Parameters
characterCharacter.
otherOther.

Reimplemented from PlatformerPro.AdditionalCondition.

Member Data Documentation

◆ groundLayer

LayerMask PlatformerPro.GroundLayerCondition.groundLayer

Layers character must be standing on.

◆ resultIfNotGrounded

bool PlatformerPro.GroundLayerCondition.resultIfNotGrounded

The result if not grounded.


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