A wrapper class for handling moving on ladders and other climbables that proxies the movement function to the desired implementation. More...

Inheritance diagram for PlatformerPro.ClimbMovement:

Public Member Functions
virtual bool	WantsClimb ()
	Gets a value indicating whether this movement wants to intiate the climbing. 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...

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

Additional Inherited Members
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...

Detailed Description

A wrapper class for handling moving on ladders and other climbables that proxies the movement function to the desired implementation.

Member Function Documentation

◆ WantsClimb()

virtual bool PlatformerPro.ClimbMovement.WantsClimb ( )

virtual

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

Reimplemented in PlatformerPro.LadderMovement_WithTopClimb, PlatformerPro.LadderMovement_DigitalForTiles, PlatformerPro.LadderMovement_Digital, PlatformerPro.ClimbMovement_Rope, PlatformerPro.ClimbMovement_HorizontalOnly, and PlatformerPro.ClimbMovement_FourWay.

Property Documentation

◆ DetectLaddersByTag

virtual bool PlatformerPro.ClimbMovement.DetectLaddersByTag

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

◆ Info

new static MovementInfo PlatformerPro.ClimbMovement.Info

staticget

Static movement info used by the editor.

◆ LadderLayerOrTagName

virtual string PlatformerPro.ClimbMovement.LadderLayerOrTagName

getprotected set

The name of the ladder lyaer if we find by layers, or the tag name if we find by tags.

◆ ShouldDoRotations

override bool PlatformerPro.ClimbMovement.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.

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

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

Public Member Functions

Properties

Additional Inherited Members