Ground movement which rolls when you press a button. More...

Inheritance diagram for PlatformerPro.GroundMovement_RollOnButton:

Public Member Functions
override void	DoMove ()
	Moves the character. More...

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

override bool	WantsGroundControl ()
	Gets a value indicating whether this movement wants to control the movement on the ground. We want this if roll timer is set and user hasn't put in a counter input. More...

override void	GainControl ()
	Called when the movement gets control. Typically used to do initialisation of velocity and the like. More...

override void	LosingControl ()
	Called when the movement loses control. Override to do any reset type actions. More...

override bool	ForceMaintainControl ()
	If this is true then the movement wants to maintain control of the character even if default transition conditions suggest it shouldn't. More...

Public Member Functions inherited from PlatformerPro.GroundMovement_Crouch
override Movement	Init (Character character, MovementVariable[] movementData)
	Initialise the movement with the given movement data. More...

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

virtual bool	CheckInputAndToggle ()
	Check crouching and crouch toggle More...

virtual bool	CheckInput ()
	Check for crouch input. More...

virtual void	Shrink ()
	Shrink the characters colliders. More...

virtual void	Grow ()
	Grow the characters colliders back to original size. 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
float	speed
	The speed the character rolls at. More...

float	rollTime
	How long to roll for if no interrupt is given. More...

int	rollButton
	Which button starts the roll? More...

Public Attributes inherited from PlatformerPro.GroundMovement_Crouch
bool	shrinkHurtBox
	Should we shrink the hit box? More...

float	shrinkHurtBoxFactor
	How much should we shrink the hit box by? More...

bool	shrinkHeadAndSides
	Should we shrink the head and ignore some sides? More...

float	newHeadHeight
	The new height of the head (side colliders higher than this will be ignored). More...

int	actionButton
	Action button to use for crouch, -1 means use DOWN instead. More...

bool	crouchToggle
	If true pressing down toggles the crouch rather than requigin crouch to be held. More...

Protected Attributes
int	currentRollDirection
	Stores the direction the roll started in. More...

float	rollTimer
	How long till we stop rolling More...

Protected Attributes inherited from PlatformerPro.GroundMovement_Crouch
Collider2D	hurtBoxCollider
	Cached reference to the hitboxes collider. More...

Vector2[]	originalHeadExtents
	The original extents of the head colliders of the character. More...

Vector2[]	newHeadExtents
	Cached copy of the calculated head extents. More...

bool	showColliderSettings
	Should we show colldier settings in inspetor? More...

bool	crouchToggled
	Stores crouch state. 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...

Static Protected Attributes
const int	SpeedIndex = 6
	The index for the speed value in the movement data. More...

const int	RollTimeIndex =7
	The index for the role time in the data. More...

const int	RollButtonIndex = 8
	The index for the role time in the data. More...

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

const float	DefaultSpeed = 4.0f
	The default speed. More...

const float	DefaultRollTime = 1.0f
	The default roll time. More...

const float	DefaultRollButton = 1
	The default Y velocity for roll. More...

Static Protected Attributes inherited from PlatformerPro.GroundMovement_Crouch
const int	ShrinkHurtBoxIndex = 0
	The index of shrink hit box in the movement data. More...

const int	ShrinkHurtBoxFactorIndex = 1
	The index of the shrink hit box factor in the movement data. More...

const int	ShrinkHeadAndSidesIndex = 2
	The index of shrink head and sides in the movement data. More...

const int	NewHeadHeightIndex = 3
	The index of the head height in the movement data. More...

const int	ActionButtonIndex = 4
	The index of the action button in the movement data. More...

const int	CrouchToggleIndex = 5
	The index of the crouch toggle setting in the movement data. More...

const float	DefaultShrinkHurtBoxFactor = 2.0f
	The default shrink hit box factor. More...

const float	DefaultNewHeadHeight = 0.5f
	The default height of the new head. More...

const int	DefaultActionButton = -1
	The default action button. More...

const int	MovementVariableCount = 6
	The size of the movement variable array. 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...

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_Crouch
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_Crouch
virtual void	ShrinkHurtBox ()
	Shrinks the hit box. More...

virtual void	GrowHurtBox ()
	Grows the hit box. More...

virtual void	ShrinkHeadAndSides ()
	Shrinks the head and sides. More...

virtual void	GrowHeadAndSides ()
	Grows the head and sides. More...

Protected Member Functions inherited from PlatformerPro.GroundMovement
virtual void	SnapToGround ()
	Snaps the character to the ground. More...

Detailed Description

Ground movement which rolls when you press a button.

Member Function Documentation

◆ DoMove()

override void PlatformerPro.GroundMovement_RollOnButton.DoMove ( )

Moves the character.

◆ ForceMaintainControl()

override bool PlatformerPro.GroundMovement_RollOnButton.ForceMaintainControl ( )

If this is true then the movement wants to maintain control of the character even if default transition conditions suggest it shouldn't.

◆ GainControl()

override void PlatformerPro.GroundMovement_RollOnButton.GainControl ( )

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

◆ Init()

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

Initialise the mvoement with the given movement data.

Parameters

character	Character.
movementData	Movement data.

◆ LosingControl()

override void PlatformerPro.GroundMovement_RollOnButton.LosingControl ( )

Called when the movement loses control. Override to do any reset type actions.

◆ WantsGroundControl()

override bool PlatformerPro.GroundMovement_RollOnButton.WantsGroundControl ( )

virtual

Gets a value indicating whether this movement wants to control the movement on the ground. We want this if roll timer is set and user hasn't put in a counter input.

true if this instance wants control; otherwise, false.

Reimplemented from PlatformerPro.GroundMovement_Crouch.

Member Data Documentation

◆ currentRollDirection

int PlatformerPro.GroundMovement_RollOnButton.currentRollDirection

protected

Stores the direction the roll started in.

◆ DefaultRollButton

const float PlatformerPro.GroundMovement_RollOnButton.DefaultRollButton = 1

staticprotected

The default Y velocity for roll.

◆ DefaultRollTime

const float PlatformerPro.GroundMovement_RollOnButton.DefaultRollTime = 1.0f

staticprotected

The default roll time.

◆ DefaultSpeed

const float PlatformerPro.GroundMovement_RollOnButton.DefaultSpeed = 4.0f

staticprotected

The default speed.

◆ MovementVariableCount

new const int PlatformerPro.GroundMovement_RollOnButton.MovementVariableCount = 9

staticprotected

The size of the movement variable array.

◆ rollButton

int PlatformerPro.GroundMovement_RollOnButton.rollButton

Which button starts the roll?

◆ RollButtonIndex

const int PlatformerPro.GroundMovement_RollOnButton.RollButtonIndex = 8

staticprotected

The index for the role time in the data.

◆ rollTime

float PlatformerPro.GroundMovement_RollOnButton.rollTime

How long to roll for if no interrupt is given.

◆ RollTimeIndex

const int PlatformerPro.GroundMovement_RollOnButton.RollTimeIndex =7

staticprotected

The index for the role time in the data.

◆ rollTimer

float PlatformerPro.GroundMovement_RollOnButton.rollTimer

protected

How long till we stop rolling

◆ speed

float PlatformerPro.GroundMovement_RollOnButton.speed

The speed the character rolls at.

◆ SpeedIndex

const int PlatformerPro.GroundMovement_RollOnButton.SpeedIndex = 6

staticprotected

The index for the speed value in the movement data.

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.GroundMovement_RollOnButton.AnimationState

get

Gets the animation state that this movement wants to set.

◆ FacingDirection

override int PlatformerPro.GroundMovement_RollOnButton.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.GroundMovement_RollOnButton.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_RollOnButton.cs

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DoMove()

◆ ForceMaintainControl()

◆ GainControl()

◆ Init()

◆ LosingControl()

◆ WantsGroundControl()

Member Data Documentation

◆ currentRollDirection

◆ DefaultRollButton

◆ DefaultRollTime

◆ DefaultSpeed

◆ MovementVariableCount

◆ rollButton

◆ RollButtonIndex

◆ rollTime

◆ RollTimeIndex

◆ rollTimer

◆ speed

◆ SpeedIndex

Property Documentation

◆ AnimationState

◆ FacingDirection

◆ Info