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

A touch input for the 2D Platform controller More...

Inherits RaycastCharacterInput.

Public Attributes

List< TouchControllerButtonbuttons
 The buttons this controller manages. More...
 
bool predictiveMode
 If true then the controller will try to predict what the user meant to do instead of relying on the user to clearly press each button. More...
 
Camera uiCamera
 Assign the camera used to render the buttons here. More...
 
int buttonLayer = -1
 Assign the layer that the buttons ar eon, it should be different to the controllers layers so the button don't effect the character. More...
 
float xButtonValue = 1.0f
 The amount to set the x input to when a button is pressed. Typically use 0.5f for walk and 1.0f for run. More...
 
float yButtonValue = 1.0f
 The amount to set the y input to when a button is pressed. Typically use 1.0f; More...
 
bool allowRun
 If true the run button will double the button value for left and right buttons. More...
 

Additional Inherited Members

- Public Member Functions inherited from RaycastCharacterInput
virtual void CancelJump ()
 Stop jump from happening, useful for platforms that don't let you jump (or special jump behaviour). More...
 
- Properties inherited from RaycastCharacterInput
virtual float x [get, set]
 The x movement. Use 1.0f or -1.0f to run. Smaller values to walk. More...
 
virtual float y [get, set]
 The y movement. 1.0f = up, -1.0f = down. More...
 
virtual bool jumpButtonHeld [get, set]
 Is the jump button being held down. More...
 
virtual bool jumpButtonDown [get, set]
 Was the jump button pressed this frame. More...
 

Detailed Description

A touch input for the 2D Platform controller

Member Data Documentation

bool TouchController.allowRun

If true the run button will double the button value for left and right buttons.

int TouchController.buttonLayer = -1

Assign the layer that the buttons ar eon, it should be different to the controllers layers so the button don't effect the character.

List<TouchControllerButton> TouchController.buttons

The buttons this controller manages.

bool TouchController.predictiveMode

If true then the controller will try to predict what the user meant to do instead of relying on the user to clearly press each button.

Camera TouchController.uiCamera

Assign the camera used to render the buttons here.

float TouchController.xButtonValue = 1.0f

The amount to set the x input to when a button is pressed. Typically use 0.5f for walk and 1.0f for run.

float TouchController.yButtonValue = 1.0f

The amount to set the y input to when a button is pressed. Typically use 1.0f;


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