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

Ladder collider. Attach this to every collider used in a ladder. This is like a rung of the ladder. More...

Inherits Ladder.

Inherited by TopStepPlatform.

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...
 
override void DoAction (RaycastCollider collider, RaycastCharacterController character)
 This is called when a platform is hit. Override to implement platform behaviour. More...
 

Protected Member Functions

override void Move ()
 Override with custom move code. More...
 

Properties

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

Detailed Description

Ladder collider. Attach this to every collider used in a ladder. This is like a rung of the ladder.

Member Function Documentation

override void LadderCollider.DoAction ( RaycastCollider  collider,
RaycastCharacterController  character 
)
virtual

This is called when a platform is hit. Override to implement platform behaviour.

Parameters
colliderThe collider that did the hitting.
characterThe character that did the hitting.

Reimplemented from Platform.

override void LadderCollider.Move ( )
protectedvirtual

Override with custom move code.

Reimplemented from Platform.

override Transform LadderCollider.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 Platform.

Reimplemented in TopStepPlatform.


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