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

Base class for ladder colliders. Extend this to create your own ladder functions. More...

Inherits Platform.

Inherited by LadderCollider.

Public Attributes

LadderControl control
 The control for the ladder. More...
 

Properties

float LedgeClimbHeight [get]
 Pass through value from the control. More...
 
- Properties inherited from Platform
Vector3 velocity [get, set]
 
Transform myTransform [get, set]
 
virtual bool overrideX [get]
 If you override and return true for this, your platform will stop the character moving in the x direction. Instead you will need to the move the character from your platform code. See the ropes classes as an example. More...
 
virtual bool overrideY [get]
 If you override and return true for this, your platform will stop the character moving in the y direction. Instead you will need to the move the character from your platform code. See the ropes classes as an example. More...
 
virtual bool overrideAnimation [get]
 If you override and return true for this, your platform will stop the character moving in the x direction. instead you will need to the move character. See the ropes classes as an example. More...
 

Additional Inherited Members

- Public Member Functions inherited from Platform
virtual void DoAction (RaycastCollider collider, RaycastCharacterController character)
 This is called when a platform is hit. Override to implement platform behaviour. More...
 
virtual Transform ParentOnStand (RaycastCharacterController character)
 Does this platform want to have this platform become the characters parent. Used for moving platforms. More...
 
virtual CharacterState GetAnimationState (RaycastCharacterController character)
 Gets the animation for the character. Only called if you have set overrideAnimation to true. More...
 
- Protected Member Functions inherited from Platform
virtual void DoStart ()
 Override and add custom initialisation here. More...
 
virtual void Move ()
 Override with custom move code. More...
 
virtual void DoUpdate ()
 Override with custom update code here. More...
 

Detailed Description

Base class for ladder colliders. Extend this to create your own ladder functions.

Member Data Documentation

LadderControl Ladder.control

The control for the ladder.

Property Documentation

float Ladder.LedgeClimbHeight
get

Pass through value from the control.


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