LadderControl Class Reference

The main control class for a ladder. Put this at the root of your ladder. Can also be used for vine like climbable or extended for other climbable behaviour. More...

Inherits MonoBehaviour.

Public Member Functions
virtual bool	ShouldPlayLedgeClimb (RaycastCharacterController character)
	Is the character at the appropriate height to trigger the climb top of ladder state. More...

Public Attributes
bool	dismountWithArrows = true
	Does pressing left or right dismount the ladder or do you need to jump? More...
bool	canMoveSideWays = false
	Can the character move sideways on the ladder? More...
bool	snapToMiddle = true
	Should the character nsap to the middle of the ladder? More...
bool	disableLedgeClimb
	Convenience method. Stop the character climbing the top of the ladder like a ledge climb. More...
float	ledgeClimbOffset
	At what point on the ladder do we trigger the special ledge climb animation state. Setting the value for this heavily depends on your animations. See the HeroSample for one way of doing it. More...

Properties
float	LedgeClimbHeight [get]
	The height the climb to ladder top state is triggereda at. Used by the character controller rto ensure climb animation is correcty lined up. More...

Detailed Description

The main control class for a ladder. Put this at the root of your ladder. Can also be used for vine like climbable or extended for other climbable behaviour.

Member Function Documentation

virtual bool LadderControl.ShouldPlayLedgeClimb ( RaycastCharacterController  character)

virtual

Is the character at the appropriate height to trigger the climb top of ladder state.

Member Data Documentation

bool LadderControl.canMoveSideWays = false

Can the character move sideways on the ladder?

bool LadderControl.disableLedgeClimb

Convenience method. Stop the character climbing the top of the ladder like a ledge climb.

bool LadderControl.dismountWithArrows = true

Does pressing left or right dismount the ladder or do you need to jump?

float LadderControl.ledgeClimbOffset

At what point on the ladder do we trigger the special ledge climb animation state. Setting the value for this heavily depends on your animations. See the HeroSample for one way of doing it.

bool LadderControl.snapToMiddle = true

Should the character nsap to the middle of the ladder?

Property Documentation

float LadderControl.LedgeClimbHeight

get

The height the climb to ladder top state is triggereda at. Used by the character controller rto ensure climb animation is correcty lined up.

---

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

• /Users/john/Desktop/PC3.5Test/Assets/2DPlatformController/Scripts/Platforms/Ladders/LadderControl.cs