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

A platform that moves left and right. Note that it returns true for parent on stand. More...

Inherits Platform.

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 Platform
virtual void DoAction (RaycastCollider collider, RaycastCharacterController character)
 This is called when a platform is hit. Override to implement platform behaviour. More...
 
virtual CharacterState GetAnimationState (RaycastCharacterController character)
 Gets the animation for the character. Only called if you have set overrideAnimation to true. More...
 

Public Attributes

float leftBound
 
float rightBound
 
float speed
 

Protected Member Functions

override void DoStart ()
 Override and add custom initialisation here. More...
 
override void DoUpdate ()
 Override with custom update code here. More...
 
- Protected Member Functions inherited from Platform
virtual void Move ()
 Override with custom move code. More...
 

Additional Inherited Members

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

Detailed Description

A platform that moves left and right. Note that it returns true for parent on stand.

Member Function Documentation

override void BackAndForthPlatform.DoStart ( )
protectedvirtual

Override and add custom initialisation here.

Reimplemented from Platform.

override void BackAndForthPlatform.DoUpdate ( )
protectedvirtual

Override with custom update code here.

Reimplemented from Platform.

override Transform BackAndForthPlatform.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.


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