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

Ground movement with three state digital movement ans liding. More...

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

Public Member Functions

override Movement Init (Character character, MovementVariable[] movementData)
 Initialise the mvoement with the given movement data. More...
 
override void DoMove ()
 Moves the character. More...
 
override void PostCollisionDoMove ()
 Does any movement that MUST be done after collissions are calculated. 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...
 

Public Attributes

float friction
 Characters friction. More...
 
float quiesceSpeed
 The quiesce speed. More...
 
- Public Attributes inherited from PlatformerPro.GroundMovement_Digital
float speed
 The speed the character moves at. More...
 

Static Public Attributes

const float DefaultFriction = 5.0f
 The default friction. More...
 

Static Protected Attributes

const int FrictionIndex = 1
 The index for the drag value in the movement data. More...
 
const int QuiesceSpeedIndex = 2
 The index of the queisce speed in the movement data. More...
 
new const int MovementVariableCount = 3
 The size of the movement variable array. More...
 
const float DefaultQuiesceSpeed = 0.5f
 The default quiesce speed. 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...
 

Properties

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...
 
- 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

- Protected Member Functions inherited from PlatformerPro.GroundMovement
virtual void SnapToGround ()
 Snaps the character to the ground. 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...
 

Detailed Description

Ground movement with three state digital movement ans liding.

Member Function Documentation

◆ DoMove()

override void PlatformerPro.GroundMovement_DigitalWithSlide.DoMove ( )

Moves the character.

◆ Init()

override Movement PlatformerPro.GroundMovement_DigitalWithSlide.Init ( Character  character,
MovementVariable[]  movementData 
)

Initialise the mvoement with the given movement data.

Parameters
characterCharacter.
movementDataMovement data.

◆ PostCollisionDoMove()

override void PlatformerPro.GroundMovement_DigitalWithSlide.PostCollisionDoMove ( )

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

Member Data Documentation

◆ DefaultFriction

const float PlatformerPro.GroundMovement_DigitalWithSlide.DefaultFriction = 5.0f
static

The default friction.

◆ DefaultQuiesceSpeed

const float PlatformerPro.GroundMovement_DigitalWithSlide.DefaultQuiesceSpeed = 0.5f
staticprotected

The default quiesce speed.

◆ friction

float PlatformerPro.GroundMovement_DigitalWithSlide.friction

Characters friction.

◆ FrictionIndex

const int PlatformerPro.GroundMovement_DigitalWithSlide.FrictionIndex = 1
staticprotected

The index for the drag value in the movement data.

◆ MovementVariableCount

new const int PlatformerPro.GroundMovement_DigitalWithSlide.MovementVariableCount = 3
staticprotected

The size of the movement variable array.

◆ quiesceSpeed

float PlatformerPro.GroundMovement_DigitalWithSlide.quiesceSpeed

The quiesce speed.

◆ QuiesceSpeedIndex

const int PlatformerPro.GroundMovement_DigitalWithSlide.QuiesceSpeedIndex = 2
staticprotected

The index of the queisce speed in the movement data.

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.GroundMovement_DigitalWithSlide.AnimationState
get

Gets the animation state that this movement wants to set.

◆ Info

new static MovementInfo PlatformerPro.GroundMovement_DigitalWithSlide.Info
staticget

Static movement info used by the editor.


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