Ground movement_ digital. More...

Inheritance diagram for PlatformerPro.GroundMovement_BalanceOnEdge:

Public Member Functions
override 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...

override void	PostCollisionDoMove ()
	Does any movement that MUST be done after collissions are calculated. 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 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
bool	haltMovement
	If true the movement will not allow user to run off an edge. If false balanace animation will only show if velocity = 0 More...

int	numberOfColliders
	The number of colliders that should be hitting the ground in order for balance to be played. More...

Static Protected Attributes
const int	HaltMovementIndex = 0
	The index for the halt movement value in the movement data. More...

const int	NumberOfCollidersIndex = 1
	The index of the number of colliders value in the movement data. More...

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

const float	DefaultColliders = 1
	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
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_ digital.

Member Function Documentation

◆ Init()

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

Initialise the mvoement with the given movement data.

Parameters

character	Character.
movementData	Movement data.

◆ PostCollisionDoMove()

override void PlatformerPro.GroundMovement_BalanceOnEdge.PostCollisionDoMove ( )

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

◆ WantsGroundControl()

override bool PlatformerPro.GroundMovement_BalanceOnEdge.WantsGroundControl ( )

virtual

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.

true

false

Returns: true, if ground control was wantsed, false otherwise.

Reimplemented from PlatformerPro.GroundMovement.

Member Data Documentation

◆ DefaultColliders

const float PlatformerPro.GroundMovement_BalanceOnEdge.DefaultColliders = 1

staticprotected

The default speed.

◆ haltMovement

bool PlatformerPro.GroundMovement_BalanceOnEdge.haltMovement

If true the movement will not allow user to run off an edge. If false balanace animation will only show if velocity = 0

◆ HaltMovementIndex

const int PlatformerPro.GroundMovement_BalanceOnEdge.HaltMovementIndex = 0

staticprotected

The index for the halt movement value in the movement data.

◆ MovementVariableCount

const int PlatformerPro.GroundMovement_BalanceOnEdge.MovementVariableCount = 2

staticprotected

The size of the movement variable array.

◆ numberOfColliders

int PlatformerPro.GroundMovement_BalanceOnEdge.numberOfColliders

The number of colliders that should be hitting the ground in order for balance to be played.

◆ NumberOfCollidersIndex

const int PlatformerPro.GroundMovement_BalanceOnEdge.NumberOfCollidersIndex = 1

staticprotected

The index of the number of colliders value in the movement data.

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.GroundMovement_BalanceOnEdge.AnimationState

get

Gets the animation state that this movement wants to set.

◆ Info

new static MovementInfo PlatformerPro.GroundMovement_BalanceOnEdge.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/Ground/GroundMovement_BalanceOnEdge.cs

Public Member Functions

Public Attributes

Static Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Init()

◆ PostCollisionDoMove()

◆ WantsGroundControl()

Member Data Documentation

◆ DefaultColliders

◆ haltMovement

◆ HaltMovementIndex

◆ MovementVariableCount

◆ numberOfColliders

◆ NumberOfCollidersIndex

Property Documentation

◆ AnimationState

◆ Info