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

Ground movement_ digital in facing direction. More...

Inheritance diagram for GroundMovement_DigitalInFacingDirection:
PlatformerPro.GroundMovement_Digital PlatformerPro.GroundMovement PlatformerPro.IFlippableGravityMovement PlatformerPro.BaseMovement< GroundMovement >

Public Member Functions

override void DoMove ()
 
override void PostCollisionDoMove ()
 Does any movement that MUST be done after collissions are calculated. More...
 
override void GainControl ()
 Called when the movement gets control. Typically used to do initialisation of velocity and the like. More...
 
- Public Member Functions inherited from PlatformerPro.GroundMovement_Digital
override void DoMove ()
 Moves the character. More...
 
override void PostCollisionDoMove ()
 Snap to ground if set. More...
 
override Movement Init (Character character, MovementVariable[] movementData)
 Initialise the mvoement with the given movement data. More...
 
- Public Member Functions inherited from PlatformerPro.GroundMovement
virtual bool WantsGroundControl ()
 Gets a value indicating whether this movement wants to control the movement on the ground. Default is false, with control falling back to default ground. Override if you want particular control. More...
 
virtual void ApplySlopeForce ()
 Applies slope force. More...
 
virtual float ApplySlopeSpeedModifier (float speed)
 Adjusts speed to cater for vertical movement More...
 
virtual float GetSpeed (float baseSpeed)
 Gets the ground speed. More...
 
virtual float GetRunSpeed (float baseRunSpeed)
 Gets the run speed. More...
 
virtual float GetAcceleration (float baseAcceleration)
 Gets the acceleration. More...
 
- Public Member Functions inherited from PlatformerPro.BaseMovement< GroundMovement >
sealed override Movement Init (Character character)
 Initialise this movement. More...
 
bool IsMovementDataDifferent (MovementVariable[] originalMovementData)
 Determines whether this instances movement data is different from the supplied originalMovementData. More...
 

Protected Attributes

int facingDirection
 Direction we are facing. More...
 
- Protected Attributes inherited from PlatformerPro.BaseMovement< GroundMovement >
Movement implementation
 The class that will do the movement. More...
 
string movementType
 The type of movement as a string. More...
 
MovementVariable[] movementData
 Data that should be applied to the movement type on init. More...
 

Properties

new static MovementInfo Info [get]
 Static movement info used by the editor. More...
 
override int FacingDirection [get]
 Returns the direction the character is facing. 0 for none, 1 for right, -1 for left. This overriden version always returns the input direction. More...
 
override PlatformerPro.AnimationState AnimationState [get]
 Gets the animation state that this movement wants to set. More...
 
- Properties inherited from PlatformerPro.GroundMovement_Digital
new static MovementInfo Info [get]
 Static movement info used by the editor. More...
 
override AnimationState AnimationState [get]
 Gets the animation state that this movement wants to set. More...
 
override int FacingDirection [get]
 Returns the direction the character is facing. 0 for none, 1 for right, -1 for left. This overriden version always returns the input direction. More...
 
- Properties inherited from PlatformerPro.GroundMovement
new static MovementInfo Info [get]
 Static movement info used by the editor. More...
 
virtual bool SupportsSlidingOnSlopes [get]
 Gets a value indicating whether this PlatformerPro.Movement can support automatic sliding based on the characters slope. More...
 
- Properties inherited from PlatformerPro.BaseMovement< GroundMovement >
virtual string MovementType [get, set]
 The type of movement as a string. More...
 
virtual MovementVariable[] MovementData [get, set]
 Data that should be applied to the movement type on init. More...
 
new static MovementInfo Info [get]
 Static movement info used by the editor. More...
 
override bool Enabled [get, set]
 A custom enable which base movements can use to pass on enable values. More...
 
override Movement Implementation [get]
 Gets the underlying implementation. More...
 

Additional Inherited Members

- Public Attributes inherited from PlatformerPro.GroundMovement_Digital
float speed
 The speed the character moves at. More...
 
- Protected Member Functions inherited from PlatformerPro.GroundMovement
virtual void SnapToGround ()
 Snaps the character to the ground. More...
 
- Static Protected Attributes inherited from PlatformerPro.GroundMovement_Digital
const int SpeedIndex = 0
 The index for the speed value in the movement data. More...
 
const int MovementVariableCount = 1
 The size of the movement variable array. More...
 
const float DefaultSpeed = 5.0f
 The default speed. More...
 

Detailed Description

Ground movement_ digital in facing direction.

Member Function Documentation

◆ DoMove()

override void GroundMovement_DigitalInFacingDirection.DoMove ( )

◆ GainControl()

override void GroundMovement_DigitalInFacingDirection.GainControl ( )

Called when the movement gets control. Typically used to do initialisation of velocity and the like.

◆ PostCollisionDoMove()

override void GroundMovement_DigitalInFacingDirection.PostCollisionDoMove ( )

Does any movement that MUST be done after collissions are calculated.

Member Data Documentation

◆ facingDirection

int GroundMovement_DigitalInFacingDirection.facingDirection
protected

Direction we are facing.

Property Documentation

◆ AnimationState

override PlatformerPro.AnimationState GroundMovement_DigitalInFacingDirection.AnimationState
get

Gets the animation state that this movement wants to set.

◆ FacingDirection

override int GroundMovement_DigitalInFacingDirection.FacingDirection
get

Returns the direction the character is facing. 0 for none, 1 for right, -1 for left. This overriden version always returns the input direction.

◆ Info

new static MovementInfo GroundMovement_DigitalInFacingDirection.Info
staticget

Static movement info used by the editor.


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