A climb movement for ladder climbing with strict digital style controls. More...

Inheritance diagram for PlatformerPro.LadderMovement_Digital:

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	WantsClimb ()
	The digital ladder controller can only work with 2D Box Colliders. More...

override bool	ForceMaintainControl ()
	Keep control until dismount. More...

Public Member Functions inherited from PlatformerPro.BaseMovement< ClimbMovement >
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	climbSpeed
	The speed the character climbs at. More...

float	leeway
	The character can only engage the ladder if the distance in X between their transform and the ladders transform is smaller than this. More...

float	centeringRate
	The speed at which the character moves towards the centre of the ladder. More...

int	availableDismounts
	Enum mask More...

Protected Attributes
BoxCollider2D	ladderCollider
	Reference to the box2D collider defining the ladder. More...

bool	centered
	Has the character centered on the ladder yet? More...

bool	dismount
	If the user is dismounting we will relinquish control. More...

bool	jumpDismount
	When a character jumps while holding up or down you don't want them to automatically stick back on the ladder. We track if the way they dismounted was a jump, and if it was we only stick back to the ladder when the velocity is smaller than 0. More...

LadderFacingDirectionOverride	facingDirectionOverride
	Nullable reference to a facing direciton override. More...

ParentOnStandPlatform	parentPlatform
	Stores parent platform if one is found. More...

Protected Attributes inherited from PlatformerPro.BaseMovement< ClimbMovement >
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	MovementVariableCount = 6
	The size of the movement variable array. More...

const float	DefaultClimbSpeed = 3.0f
	The default climb speed. More...

const float	DefaultLeeway = 0.5f
	The default leeway. More...

const float	DefaultCenteringRate = 1.0f
	The default leeway. More...

const int	DefaultAvailableDismounts = (int)LadderDismountType.TOP_BOTTOM_AND_JUMP_AND_LEFT_RIGHT
	The default available dismounts. More...

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

override bool	ShouldApplyGravity `[get]`
	No gravity when climbing. More...

override RaycastType	ShouldDoBaseCollisions `[get]`
	Ignore collisions when climbing. More...

override AnimationState	AnimationState `[get]`
	Gets the animation state that this movement wants to set. More...

Properties inherited from PlatformerPro.ClimbMovement
virtual bool	DetectLaddersByTag `[get, protected set]`
	Should we find ladders by tag or by layer. If true we will use tags, if false we will use layers. Tags are easier to use but come with an allocation cost. More...

virtual string	LadderLayerOrTagName `[get, protected set]`
	The name of the ladder lyaer if we find by layers, or the tag name if we find by tags. More...

override bool	ShouldDoRotations `[get]`
	Gets a value indicating whether this PlatformerPro.Movement expects the rotations to be calculated and applied by the character. By default ladders don't do this. More...

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

Properties inherited from PlatformerPro.BaseMovement< ClimbMovement >
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 climb movement for ladder climbing with strict digital style controls.

Member Function Documentation

◆ DoMove()

override void PlatformerPro.LadderMovement_Digital.DoMove ( )

Moves the character.

◆ ForceMaintainControl()

override bool PlatformerPro.LadderMovement_Digital.ForceMaintainControl ( )

Keep control until dismount.

◆ Init()

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

Initialise the mvoement with the given movement data.

Parameters

character	Character.
movementData	Movement data.

◆ WantsClimb()

override bool PlatformerPro.LadderMovement_Digital.WantsClimb ( )

virtual

The digital ladder controller can only work with 2D Box Colliders.

true if the character should climb; otherwise, false.

Reimplemented from PlatformerPro.ClimbMovement.

Member Data Documentation

◆ availableDismounts

int PlatformerPro.LadderMovement_Digital.availableDismounts

Enum mask

◆ centered

bool PlatformerPro.LadderMovement_Digital.centered

protected

Has the character centered on the ladder yet?

◆ centeringRate

float PlatformerPro.LadderMovement_Digital.centeringRate

The speed at which the character moves towards the centre of the ladder.

◆ climbSpeed

float PlatformerPro.LadderMovement_Digital.climbSpeed

The speed the character climbs at.

◆ DefaultAvailableDismounts

const int PlatformerPro.LadderMovement_Digital.DefaultAvailableDismounts = (int)LadderDismountType.TOP_BOTTOM_AND_JUMP_AND_LEFT_RIGHT

staticprotected

The default available dismounts.

◆ DefaultCenteringRate

const float PlatformerPro.LadderMovement_Digital.DefaultCenteringRate = 1.0f

staticprotected

The default leeway.

◆ DefaultClimbSpeed

const float PlatformerPro.LadderMovement_Digital.DefaultClimbSpeed = 3.0f

staticprotected

The default climb speed.

◆ DefaultLeeway

const float PlatformerPro.LadderMovement_Digital.DefaultLeeway = 0.5f

staticprotected

The default leeway.

◆ dismount

bool PlatformerPro.LadderMovement_Digital.dismount

protected

If the user is dismounting we will relinquish control.

◆ facingDirectionOverride

LadderFacingDirectionOverride PlatformerPro.LadderMovement_Digital.facingDirectionOverride

protected

Nullable reference to a facing direciton override.

◆ jumpDismount

bool PlatformerPro.LadderMovement_Digital.jumpDismount

protected

When a character jumps while holding up or down you don't want them to automatically stick back on the ladder. We track if the way they dismounted was a jump, and if it was we only stick back to the ladder when the velocity is smaller than 0.

◆ ladderCollider

BoxCollider2D PlatformerPro.LadderMovement_Digital.ladderCollider

protected

Reference to the box2D collider defining the ladder.

◆ leeway

float PlatformerPro.LadderMovement_Digital.leeway

The character can only engage the ladder if the distance in X between their transform and the ladders transform is smaller than this.

◆ MovementVariableCount

const int PlatformerPro.LadderMovement_Digital.MovementVariableCount = 6

staticprotected

The size of the movement variable array.

◆ parentPlatform

ParentOnStandPlatform PlatformerPro.LadderMovement_Digital.parentPlatform

protected

Stores parent platform if one is found.

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.LadderMovement_Digital.AnimationState

get

Gets the animation state that this movement wants to set.

◆ Info

new static MovementInfo PlatformerPro.LadderMovement_Digital.Info

staticget

Static movement info used by the editor.

◆ ShouldApplyGravity

override bool PlatformerPro.LadderMovement_Digital.ShouldApplyGravity

get

No gravity when climbing.

◆ ShouldDoBaseCollisions

override RaycastType PlatformerPro.LadderMovement_Digital.ShouldDoBaseCollisions

get

Ignore collisions when climbing.

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Movement/Climbing/LadderMovement_Digital.cs

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ DoMove()

◆ ForceMaintainControl()

◆ Init()

◆ WantsClimb()

Member Data Documentation

◆ availableDismounts

◆ centered

◆ centeringRate

◆ climbSpeed

◆ DefaultAvailableDismounts

◆ DefaultCenteringRate

◆ DefaultClimbSpeed

◆ DefaultLeeway

◆ dismount

◆ facingDirectionOverride

◆ jumpDismount

◆ ladderCollider

◆ leeway

◆ MovementVariableCount

◆ parentPlatform

Property Documentation

◆ AnimationState

◆ Info

◆ ShouldApplyGravity

◆ ShouldDoBaseCollisions