A wrapper class for handling moving on the ground that proxies the movement function to the desired implementation. More...

Inheritance diagram for PlatformerPro.AirMovement:

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

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	DoJump ()
	Do the jump. More...

virtual void	DoOverridenJump (float newHeight, int jumpCount, bool skipPowerUps=false)
	Does a jump with overriden values for the key variables. Primarily used to allow platforms and wall jumps to affect jump height in non-physics based jumps. 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...

Protected Member Functions
virtual void	MoveInX (float horizontalAxis, int horizontalAxisDigital, ButtonState runButton)
	Moves in x. More...

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

Properties
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

A wrapper class for handling moving on the ground that proxies the movement function to the desired implementation.

Member Function Documentation

◆ AddGravityFlipHandler()

virtual void PlatformerPro.AirMovement.AddGravityFlipHandler ( )

protectedvirtual

Add handler for the gravity flip event

◆ DoJump()

virtual void PlatformerPro.AirMovement.DoJump ( )

virtual

Do the jump.

◆ DoOverridenJump()

virtual void PlatformerPro.AirMovement.DoOverridenJump	(	float	newHeight,
		int	jumpCount,
		bool	skipPowerUps = `false`
	)

virtual

Does a jump with overriden values for the key variables. Primarily used to allow platforms and wall jumps to affect jump height in non-physics based jumps.

Reimplemented in PlatformerPro.AirMovement_Wrapper, PlatformerPro.AirMovement_MecanimDrivenAnimation, PlatformerPro.AirMovement_Fly, PlatformerPro.AirMovement_DigitalNoDirChange, PlatformerPro.AirMovement_Digital, PlatformerPro.AirMovement_DelayedJump, PlatformerPro.AirMovement_Physics, PlatformerPro.AirMovement_VariableWithDoubleJump, PlatformerPro.AirMovement_VariableDoubleJumpOnly, and PlatformerPro.AirMovement_Variable.

◆ DoOverridenMove()

virtual void PlatformerPro.AirMovement.DoOverridenMove	(	bool	moveInX,
		bool	moveInY,
		float	xInput,
		ButtonState	runButton
	)

virtual

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.

Parameters

moveInX	If set to `true` move in x.
moveInY	If set to `true` move in y.
xInput	Simulated X input.
runButton	Simulated Run button.

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.

Reimplemented in PlatformerPro.AirMovement_Wrapper.

◆ GetAcceleration()

virtual float PlatformerPro.AirMovement.GetAcceleration ( float baseAcceleration )

virtual

Gets the acceleration.

Returns: The acceleration.

Parameters

baseSpeed Base acceleration.

◆ GetDoubleJumpHeightOrForce()

virtual float PlatformerPro.AirMovement.GetDoubleJumpHeightOrForce ( float baseHeight )

virtual

Gets the double jump height or the double jump force.

Returns: The acceleration.

Parameters

baseHeight Base double jump height.

◆ GetJumpHeightOrForce()

virtual float PlatformerPro.AirMovement.GetJumpHeightOrForce ( float baseHeight )

virtual

Gets the jump height or the jump force.

Returns: The acceleration.

Parameters

baseSpeed Base acceleration.

◆ GetRunSpeed()

virtual float PlatformerPro.AirMovement.GetRunSpeed ( float baseRunSpeed )

virtual

Gets the run speed.

Returns: The run speed.

Parameters

baseSpeed Base run speed.

◆ GetSpeed()

virtual float PlatformerPro.AirMovement.GetSpeed ( float baseSpeed )

virtual

Gets the air speed.

Returns: The ground speed.

Parameters

baseSpeed Base speed.

◆ HandleGravityFlipped()

virtual void PlatformerPro.AirMovement.HandleGravityFlipped	(	object	sender,
		System.EventArgs	e
	)

protectedvirtual

Handles the gravity being flipped.

Parameters

sender	Sender.
e	E.

Reimplemented in PlatformerPro.AirMovement_Digital.

◆ MoveInX()

virtual void PlatformerPro.AirMovement.MoveInX	(	float	horizontalAxis,
		int	horizontalAxisDigital,
		ButtonState	runButton
	)

protectedvirtual

Moves in x.

Parameters

horizontalAxis	Horizontal axis.
horizontalAxisDigital	Horizontal axis digital.
runButton	Run button.

◆ MoveInY()

virtual void PlatformerPro.AirMovement.MoveInY ( )

protectedvirtual

Moves in y.

Reimplemented in PlatformerPro.AirMovement_VariableWithDoubleJump, PlatformerPro.AirMovement_VariableDoubleJumpOnly, PlatformerPro.AirMovement_Variable, PlatformerPro.AirMovement_Physics, PlatformerPro.AirMovement_Parachute, PlatformerPro.AirMovement_JetPack, PlatformerPro.AirMovement_Fly, PlatformerPro.AirMovement_Float, PlatformerPro.AirMovement_DigitalNoDirChange, and PlatformerPro.AirMovement_Digital.

◆ WantsAirControl()

virtual bool PlatformerPro.AirMovement.WantsAirControl ( )

virtual

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.

true if this instance wants control; otherwise, false.

Reimplemented in PlatformerPro.AirMovement_Wrapper, PlatformerPro.AirMovement_VariableDoubleJumpOnly, PlatformerPro.AirMovement_TeleportJump, PlatformerPro.AirMovement_Parachute, PlatformerPro.AirMovement_JetPack, PlatformerPro.AirMovement_Fly, PlatformerPro.AirMovement_Float, PlatformerPro.AirMovement_Digital, and PlatformerPro.AirMovement_CrouchJump.

◆ WantsJump()

virtual bool PlatformerPro.AirMovement.WantsJump ( )

virtual

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

true if this instance can jump; otherwise, false.

Member Data Documentation

◆ flippableGravity

FlippableGravity PlatformerPro.AirMovement.flippableGravity

protected

Cached reference to a flippable gravity.

Property Documentation

◆ Info

new static MovementInfo PlatformerPro.AirMovement.Info

staticget

Static movement info used by the editor.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ AddGravityFlipHandler()

◆ DoJump()

◆ DoOverridenJump()

◆ DoOverridenMove()

◆ GetAcceleration()

◆ GetDoubleJumpHeightOrForce()

◆ GetJumpHeightOrForce()

◆ GetRunSpeed()

◆ GetSpeed()

◆ HandleGravityFlipped()

◆ MoveInX()

◆ MoveInY()

◆ WantsAirControl()

◆ WantsJump()

Member Data Documentation

◆ flippableGravity

Property Documentation

◆ Info