2D Platform Controller  v1.7.0
Autogenerated code documentation for the 2D Platform Controller.
 All Classes Functions Variables Properties
ClimbDetails Class Reference

Climb details. More...

Public Attributes

bool autoStick = false
 If true you will autoamtically stick to climables when you touch them. Otherwise you will need to press up or down to stick. More...
 
bool allowClimbing = true
 ALlow climbing if true. More...
 
float speed = 2.5f
 The vertical speed at which ladders are climbed. More...
 
float horizontalSpeed = 1.5f
 If the ladder allows climbing horizontally use this speed. More...
 
int collidersRequired = 3
 How many feet colliders are required to be on the ladder before it can be climbed. cannot be larger than total eet colliders. Larger numbers make ladders "thinner", i.e. you have to be closer to the centre of the ladder to climb them. More...
 
float ropeVelocityFactor = 1.33f
 How much to accentuate the x velocity of the rope when you launch off of it. More...
 
float ropeSwingForce = 1.5f
 How much force to impart to the rope when swinging. More...
 
float climbTopAnimationTime = 1.5f
 The time it takes to play the climbing the ladder top animation More...
 
float climbTopDownAnimationTime = 1.5f
 The time it takes to play the climbing the ladder top downanimation More...
 
Vector3 climbOffset
 The difference between the characters root position at the top of a climb, and during the normal state (idle, walking, etc). More...
 

Detailed Description

Climb details.

Member Data Documentation

bool ClimbDetails.allowClimbing = true

ALlow climbing if true.

bool ClimbDetails.autoStick = false

If true you will autoamtically stick to climables when you touch them. Otherwise you will need to press up or down to stick.

Vector3 ClimbDetails.climbOffset

The difference between the characters root position at the top of a climb, and during the normal state (idle, walking, etc).

float ClimbDetails.climbTopAnimationTime = 1.5f

The time it takes to play the climbing the ladder top animation

float ClimbDetails.climbTopDownAnimationTime = 1.5f

The time it takes to play the climbing the ladder top downanimation

int ClimbDetails.collidersRequired = 3

How many feet colliders are required to be on the ladder before it can be climbed. cannot be larger than total eet colliders. Larger numbers make ladders "thinner", i.e. you have to be closer to the centre of the ladder to climb them.

float ClimbDetails.horizontalSpeed = 1.5f

If the ladder allows climbing horizontally use this speed.

float ClimbDetails.ropeSwingForce = 1.5f

How much force to impart to the rope when swinging.

float ClimbDetails.ropeVelocityFactor = 1.33f

How much to accentuate the x velocity of the rope when you launch off of it.

float ClimbDetails.speed = 2.5f

The vertical speed at which ladders are climbed.


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