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

Top step platform, this script should be attached to the top step of a ladder. More...

Inherits LadderCollider.

Public Member Functions

override Transform ParentOnStand (RaycastCharacterController character)
 Does this platform want to have this platform become the characters parent. Used for moving platforms. More...
 
- Public Member Functions inherited from LadderCollider
override void DoAction (RaycastCollider collider, RaycastCharacterController character)
 This is called when a platform is hit. Override to implement platform behaviour. More...
 

Properties

override bool overrideX [get]
 
- Properties inherited from LadderCollider
override bool overrideX [get]
 
override bool overrideY [get]
 
- Properties inherited from Ladder
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 Attributes inherited from Ladder
LadderControl control
 The control for the ladder. More...
 
- Protected Member Functions inherited from LadderCollider
override void Move ()
 Override with custom move code. More...
 

Detailed Description

Top step platform, this script should be attached to the top step of a ladder.

Member Function Documentation

override Transform TopStepPlatform.ParentOnStand ( RaycastCharacterController  character)
virtual

Does this platform want to have this platform become the characters parent. Used for moving platforms.

Returns
Return a transform if you want to reparent the character.

Reimplemented from LadderCollider.


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