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

Rope platform. Attach this to every collider used in a rope. Note that rope colliders must be the child of a rigidbody. More...

Inherits Rope.

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...
 
override CharacterState GetAnimationState (RaycastCharacterController character)
 Gets the animation for the character. Only called if you have set overrideAnimation to true. More...
 

Protected Member Functions

override void DoStart ()
 Override and add custom initialisation here. More...
 
override void Move ()
 Override with custom move code. More...
 

Properties

override bool overrideX [get]
 
override bool overrideY [get]
 
override bool overrideAnimation [get]
 

Additional Inherited Members

- Public Attributes inherited from Rope
RopeControl control
 

Detailed Description

Rope platform. Attach this to every collider used in a rope. Note that rope colliders must be the child of a rigidbody.

Member Function Documentation

override void RopeCollider.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 RopeCollider.DoStart ( )
protectedvirtual

Override and add custom initialisation here.

Reimplemented from Platform.

override CharacterState RopeCollider.GetAnimationState ( RaycastCharacterController  character)
virtual

Gets the animation for the character. Only called if you have set overrideAnimation to true.

Returns
The animation state.

Reimplemented from Platform.

override void RopeCollider.Move ( )
protectedvirtual

Override with custom move code.

Reimplemented from Platform.

override Transform RopeCollider.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: