Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.ActiveMovementCondition Class Reference
Inheritance diagram for PlatformerPro.ActiveMovementCondition:
PlatformerPro.AdditionalCondition PlatformerPro.PlatformerProMonoBehaviour

Public Member Functions

override bool CheckCondition (Character character, object other)
 Returns true if required movement is active. More...
 
override bool CheckInverseCondition (Character character, object other)
 Returns true if trigger should trigger exit event. More...
 
- Public Member Functions inherited from PlatformerPro.AdditionalCondition
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

Movement requiredMovement
 Movement that must be active for this condition to be met. 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...
 

Protected Member Functions

void UpdateRequiredMovement ()
 Updates the required movement to be the actual required movement (i.e. get implementation from a base movement). More...
 

Protected Attributes

Movement actualRequiredMovement
 Cached copy to underlying movement implementation. More...
 

Properties

override string Header [get]
 
- 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...
 

Member Function Documentation

◆ CheckCondition()

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

Returns true if required movement is active.

Returns
true

false

Parameters
characterCharacter.
otherOther.

Reimplemented from PlatformerPro.AdditionalCondition.

◆ CheckInverseCondition()

override bool PlatformerPro.ActiveMovementCondition.CheckInverseCondition ( Character  character,
object  other 
)
virtual

Returns true if trigger should trigger exit event.

Reimplemented from PlatformerPro.AdditionalCondition.

◆ UpdateRequiredMovement()

void PlatformerPro.ActiveMovementCondition.UpdateRequiredMovement ( )
protected

Updates the required movement to be the actual required movement (i.e. get implementation from a base movement).

Member Data Documentation

◆ actualRequiredMovement

Movement PlatformerPro.ActiveMovementCondition.actualRequiredMovement
protected

Cached copy to underlying movement implementation.

◆ requiredMovement

Movement PlatformerPro.ActiveMovementCondition.requiredMovement

Movement that must be active for this condition to be met.

Property Documentation

◆ Header

override string PlatformerPro.ActiveMovementCondition.Header
get

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