An air movement that lets mecanim to most of the work. More...

Inheritance diagram for PlatformerPro.AirMovement_MecanimDrivenAnimation:

Public Member Functions
override bool	WantsJump ()
	Gets a value indicating whether this movement wants to intiate the jump. More...

override void	DoMove ()
	Moves the character. More...

override Movement	Init (Character character, MovementVariable[] movementData)
	Initialise the movement with the given movement data. More...

override bool	ForceMaintainControl ()
	If the jump just started force control. More...

override void	LosingControl ()
	Called when the movement loses control. Reset the jump count. More...

override void	DoJump ()
	Do the jump by translating and applying velocity. More...

override void	DoOverridenJump (float newHeight, int newJumpCount, bool skipPowerUps=false)
	Do the jump with overriden height and jumpCount. More...

Public Member Functions inherited from PlatformerPro.AirMovement
virtual bool	WantsAirControl ()
	Gets a value indicating whether this movement wants to control the movement in the air. Default is false with movement falling back to default air. Override if you want control. More...

virtual void	DoOverridenMove (bool moveInX, bool moveInY, float xInput, ButtonState runButton)
	Partially moves the character. A lot of movements (e.g. wall movements) require partial air movement. This allows them to use the air movement instead of re-implementing the movement. More...

virtual float	GetSpeed (float baseSpeed)
	Gets the air speed. More...

virtual float	GetRunSpeed (float baseRunSpeed)
	Gets the run speed. More...

virtual float	GetAcceleration (float baseAcceleration)
	Gets the acceleration. More...

virtual float	GetJumpHeightOrForce (float baseHeight)
	Gets the jump height or the jump force. More...

virtual float	GetDoubleJumpHeightOrForce (float baseHeight)
	Gets the double jump height or the double jump force. More...

Public Member Functions inherited from PlatformerPro.BaseMovement< AirMovement >
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	airSpeed
	The (horizontal) speed the character moves at in the air. Sets velocity only. More...

float	groundedLeeway
	After the user leaves the ground how much additional time do we give the user to press jump and still consider them grounded. More...

Protected Member Functions
override void	MoveInX (float horizontalAxis, int horizontalAxisDigital, ButtonState runButton)
	Does the X movement. More...

Protected Member Functions inherited from PlatformerPro.AirMovement
virtual void	MoveInY ()
	Moves in y. More...

virtual void	AddGravityFlipHandler ()
	Add handler for the gravity flip event More...

virtual void	HandleGravityFlipped (object sender, System.EventArgs e)
	Handles the gravity being flipped. More...

Protected Attributes
float	readyToJumpTimer
	Character can only jump if this timer is less than zero. More...

bool	jumpStart
	True before the jump leaves the ground. More...

bool	isJumping

int	jumpCount
	Jump count, set to 0 while not jumping, 1 while jumping, 2 while double More...

Animator	myAnimator

bool	isFalling

Protected Attributes inherited from PlatformerPro.AirMovement
FlippableGravity	flippableGravity
	Cached reference to a flippable gravity. More...

Protected Attributes inherited from PlatformerPro.BaseMovement< AirMovement >
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...

Static Protected Attributes
const float	DefaultAirSpeed = 5.0f
	The default air speed. More...

const float	DefaultJumpHeight = 2.0f
	The default height of the jump. More...

const float	DefaultRelativeJumpGravity = 1.0f
	The default relative jump gravity. More...

const float	DefaultGroundedLeeway = 0.1f
	The default grounded leeway. More...

const bool	DefaultCanDoubleJump = false
	The default can double jump value. More...

const float	DefaultDoubleJumpHeight = 2.0f
	The default height of the double jump. More...

const int	AirSpeedIndex = 0
	The index for the air speed value in the movement data. More...

const int	JumpHeightIndex = 1
	The index for the air speed value in the movement data. More...

const int	JumpCurveIndex = 2
	The index for the jump curve value in the movement data. More...

const int	ShowJumpDetailsIndex = 3
	The index for the value of show jumped details. Only used by editor. More...

const int	JumpRelativeGravityIndex = 4
	The index for the relative jump gravity in the movement data. More...

const int	GroundedLeewayIndex = 5
	The index for the ground leeway in the movement data. More...

const int	CanDoubleJumpIndex = 6
	The index for can double jump in the movement data. More...

const int	DoubleJumpHeightIndex = 7
	The index for the double jump height in the movement data. More...

const int	JumpWhenButtonHeldIndex = 8
	The index for the Jump When Button Held in the movement data. More...

const int	MovementVariableCount = 9
	The size of the movement variable array. More...

Properties
new static MovementInfo	Info `[get]`
	Static movement info used by the editor. More...

override bool	ShouldApplyGravity `[get]`
	It is expected movements will have gravity built in. More...

override float	CurrentGravity `[get]`
	Gets a value indicating the current gravity, only used if this movement doesn't apply the default gravity. See also ShouldApplyGravity() 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.AirMovement
new static MovementInfo	Info `[get]`
	Static movement info used by the editor. More...

Properties inherited from PlatformerPro.BaseMovement< AirMovement >
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...

Detailed Description

An air movement that lets mecanim to most of the work.

Member Function Documentation

◆ DoJump()

override void PlatformerPro.AirMovement_MecanimDrivenAnimation.DoJump ( )

virtual

Do the jump by translating and applying velocity.

Reimplemented from PlatformerPro.AirMovement.

◆ DoMove()

override void PlatformerPro.AirMovement_MecanimDrivenAnimation.DoMove ( )

Moves the character.

◆ DoOverridenJump()

override void PlatformerPro.AirMovement_MecanimDrivenAnimation.DoOverridenJump	(	float	newHeight,
		int	newJumpCount,
		bool	skipPowerUps = `false`
	)

virtual

Do the jump with overriden height and jumpCount.

Reimplemented from PlatformerPro.AirMovement.

◆ ForceMaintainControl()

override bool PlatformerPro.AirMovement_MecanimDrivenAnimation.ForceMaintainControl ( )

If the jump just started force control.

◆ Init()

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

Initialise the movement with the given movement data.

Parameters

character	Character.
movementData	Movement data.

◆ LosingControl()

override void PlatformerPro.AirMovement_MecanimDrivenAnimation.LosingControl ( )

Called when the movement loses control. Reset the jump count.

◆ MoveInX()

override void PlatformerPro.AirMovement_MecanimDrivenAnimation.MoveInX	(	float	horizontalAxis,
		int	horizontalAxisDigital,
		ButtonState	runButton
	)

protectedvirtual

Does the X movement.

Reimplemented from PlatformerPro.AirMovement.

◆ WantsJump()

override bool PlatformerPro.AirMovement_MecanimDrivenAnimation.WantsJump ( )

virtual

Gets a value indicating whether this movement wants to intiate the jump.

true if this instance should jump; otherwise, false.

Reimplemented from PlatformerPro.AirMovement.

Member Data Documentation

◆ airSpeed

float PlatformerPro.AirMovement_MecanimDrivenAnimation.airSpeed

The (horizontal) speed the character moves at in the air. Sets velocity only.

◆ AirSpeedIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.AirSpeedIndex = 0

staticprotected

The index for the air speed value in the movement data.

◆ CanDoubleJumpIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.CanDoubleJumpIndex = 6

staticprotected

The index for can double jump in the movement data.

◆ DefaultAirSpeed

const float PlatformerPro.AirMovement_MecanimDrivenAnimation.DefaultAirSpeed = 5.0f

staticprotected

The default air speed.

◆ DefaultCanDoubleJump

const bool PlatformerPro.AirMovement_MecanimDrivenAnimation.DefaultCanDoubleJump = false

staticprotected

The default can double jump value.

◆ DefaultDoubleJumpHeight

const float PlatformerPro.AirMovement_MecanimDrivenAnimation.DefaultDoubleJumpHeight = 2.0f

staticprotected

The default height of the double jump.

◆ DefaultGroundedLeeway

const float PlatformerPro.AirMovement_MecanimDrivenAnimation.DefaultGroundedLeeway = 0.1f

staticprotected

The default grounded leeway.

◆ DefaultJumpHeight

const float PlatformerPro.AirMovement_MecanimDrivenAnimation.DefaultJumpHeight = 2.0f

staticprotected

The default height of the jump.

◆ DefaultRelativeJumpGravity

const float PlatformerPro.AirMovement_MecanimDrivenAnimation.DefaultRelativeJumpGravity = 1.0f

staticprotected

The default relative jump gravity.

◆ DoubleJumpHeightIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.DoubleJumpHeightIndex = 7

staticprotected

The index for the double jump height in the movement data.

◆ groundedLeeway

float PlatformerPro.AirMovement_MecanimDrivenAnimation.groundedLeeway

After the user leaves the ground how much additional time do we give the user to press jump and still consider them grounded.

◆ GroundedLeewayIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.GroundedLeewayIndex = 5

staticprotected

The index for the ground leeway in the movement data.

◆ isFalling

bool PlatformerPro.AirMovement_MecanimDrivenAnimation.isFalling

protected

◆ isJumping

bool PlatformerPro.AirMovement_MecanimDrivenAnimation.isJumping

protected

◆ jumpCount

int PlatformerPro.AirMovement_MecanimDrivenAnimation.jumpCount

protected

Jump count, set to 0 while not jumping, 1 while jumping, 2 while double

◆ JumpCurveIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.JumpCurveIndex = 2

staticprotected

The index for the jump curve value in the movement data.

◆ JumpHeightIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.JumpHeightIndex = 1

staticprotected

The index for the air speed value in the movement data.

◆ JumpRelativeGravityIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.JumpRelativeGravityIndex = 4

staticprotected

The index for the relative jump gravity in the movement data.

◆ jumpStart

bool PlatformerPro.AirMovement_MecanimDrivenAnimation.jumpStart

protected

True before the jump leaves the ground.

◆ JumpWhenButtonHeldIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.JumpWhenButtonHeldIndex = 8

staticprotected

The index for the Jump When Button Held in the movement data.

◆ MovementVariableCount

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.MovementVariableCount = 9

staticprotected

The size of the movement variable array.

◆ myAnimator

Animator PlatformerPro.AirMovement_MecanimDrivenAnimation.myAnimator

protected

◆ readyToJumpTimer

float PlatformerPro.AirMovement_MecanimDrivenAnimation.readyToJumpTimer

protected

Character can only jump if this timer is less than zero.

◆ ShowJumpDetailsIndex

const int PlatformerPro.AirMovement_MecanimDrivenAnimation.ShowJumpDetailsIndex = 3

staticprotected

The index for the value of show jumped details. Only used by editor.

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.AirMovement_MecanimDrivenAnimation.AnimationState

get

Gets the animation state that this movement wants to set.

◆ CurrentGravity

override float PlatformerPro.AirMovement_MecanimDrivenAnimation.CurrentGravity

get

Gets a value indicating the current gravity, only used if this movement doesn't apply the default gravity.

See also: ShouldApplyGravity()

◆ FacingDirection

override int PlatformerPro.AirMovement_MecanimDrivenAnimation.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 PlatformerPro.AirMovement_MecanimDrivenAnimation.Info

staticget

Static movement info used by the editor.

◆ ShouldApplyGravity

override bool PlatformerPro.AirMovement_MecanimDrivenAnimation.ShouldApplyGravity

get

It is expected movements will have gravity built in.

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Movement/Air/AirMovement_MecanimDrivenAnimation.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ DoJump()

◆ DoMove()

◆ DoOverridenJump()

◆ ForceMaintainControl()

◆ Init()

◆ LosingControl()

◆ MoveInX()

◆ WantsJump()

Member Data Documentation

◆ airSpeed

◆ AirSpeedIndex

◆ CanDoubleJumpIndex

◆ DefaultAirSpeed

◆ DefaultCanDoubleJump

◆ DefaultDoubleJumpHeight

◆ DefaultGroundedLeeway

◆ DefaultJumpHeight

◆ DefaultRelativeJumpGravity

◆ DoubleJumpHeightIndex

◆ groundedLeeway

◆ GroundedLeewayIndex

◆ isFalling

◆ isJumping

◆ jumpCount

◆ JumpCurveIndex

◆ JumpHeightIndex

◆ JumpRelativeGravityIndex

◆ jumpStart

◆ JumpWhenButtonHeldIndex

◆ MovementVariableCount

◆ myAnimator

◆ readyToJumpTimer

◆ ShowJumpDetailsIndex

Property Documentation

◆ AnimationState

◆ CurrentGravity

◆ FacingDirection

◆ Info

◆ ShouldApplyGravity