Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.StandardInputData Class Reference

Static Public Member Functions

static StandardInputData LoadFromResource (string resourceName)
 Loads input data from Unity resource folder More...
 
static StandardInputData LoadFromFile (string fullPath)
 Loads input data from file. More...
 
static void SaveToFile (string fullPath, StandardInputData data)
 

Public Attributes

bool enableController
 Should the controller input be enabled. More...
 
bool enableKeyboard
 Should the keyboard input be enabled. More...
 
string horizontalAxisName = "Joystick1Axis1"
 The horizontal joystick axis. More...
 
bool reverseHorizontalAxis
 Should we reverse the values of the horizontal axis. More...
 
float digitalHorizontalThreshold = 0.25f
 Threshold for digital input to be considered non-zero. More...
 
string verticalAxisName = "Joystick1Axis2"
 The vertical joystick axis. More...
 
bool reverseVerticalAxis
 Should we reverse the values of the vertival axis. More...
 
float digitalVerticalThreshold = 0.25f
 Threshold for digital input to be considered non-zero. More...
 
string altHorizontalAxisName = "Joystick1Axis7"
 The alternateHorizontal joystick axis. More...
 
bool reverseAltHorizontalAxis
 Should we reverse the values of the horizontal axis. More...
 
float digitalAltHorizontalThreshold = 0.25f
 Threshold for digital input to be considered non-zero. More...
 
string altVerticalAxisName = "Joystick1Axis8"
 The alternate vertical joystick axis. More...
 
bool reverseAltVerticalAxis
 Should we reverse the values of the vertival axis. More...
 
float digitalAltVerticalThreshold = 0.25f
 Threshold for digital input to be considered non-zero. More...
 
KeyCode right = KeyCode.RightArrow
 The right key. More...
 
KeyCode left = KeyCode.LeftArrow
 The left key. More...
 
KeyCode up = KeyCode.UpArrow
 The up key. More...
 
KeyCode down = KeyCode.DownArrow
 The down key. More...
 
KeyCode jump = KeyCode.Z
 The jump key. More...
 
KeyCode run = KeyCode.X
 The run key. More...
 
KeyCode pause = KeyCode.P
 The pause key. More...
 
KeyCode[] actionButtons
 The action buttons with the first value in the array being the default. More...
 

Member Function Documentation

◆ LoadFromFile()

static StandardInputData PlatformerPro.StandardInputData.LoadFromFile ( string  fullPath)
static

Loads input data from file.

Returns
The loaded data or null if data not loaded.
Parameters
fullPathFull path.

◆ LoadFromResource()

static StandardInputData PlatformerPro.StandardInputData.LoadFromResource ( string  resourceName)
static

Loads input data from Unity resource folder

Returns
The loaded data or null if data not loaded.
Parameters
resourceNameResource name.

◆ SaveToFile()

static void PlatformerPro.StandardInputData.SaveToFile ( string  fullPath,
StandardInputData  data 
)
static

Member Data Documentation

◆ actionButtons

KeyCode [] PlatformerPro.StandardInputData.actionButtons

The action buttons with the first value in the array being the default.

◆ altHorizontalAxisName

string PlatformerPro.StandardInputData.altHorizontalAxisName = "Joystick1Axis7"

The alternateHorizontal joystick axis.

◆ altVerticalAxisName

string PlatformerPro.StandardInputData.altVerticalAxisName = "Joystick1Axis8"

The alternate vertical joystick axis.

◆ digitalAltHorizontalThreshold

float PlatformerPro.StandardInputData.digitalAltHorizontalThreshold = 0.25f

Threshold for digital input to be considered non-zero.

◆ digitalAltVerticalThreshold

float PlatformerPro.StandardInputData.digitalAltVerticalThreshold = 0.25f

Threshold for digital input to be considered non-zero.

◆ digitalHorizontalThreshold

float PlatformerPro.StandardInputData.digitalHorizontalThreshold = 0.25f

Threshold for digital input to be considered non-zero.

◆ digitalVerticalThreshold

float PlatformerPro.StandardInputData.digitalVerticalThreshold = 0.25f

Threshold for digital input to be considered non-zero.

◆ down

KeyCode PlatformerPro.StandardInputData.down = KeyCode.DownArrow

The down key.

◆ enableController

bool PlatformerPro.StandardInputData.enableController

Should the controller input be enabled.

◆ enableKeyboard

bool PlatformerPro.StandardInputData.enableKeyboard

Should the keyboard input be enabled.

◆ horizontalAxisName

string PlatformerPro.StandardInputData.horizontalAxisName = "Joystick1Axis1"

The horizontal joystick axis.

◆ jump

KeyCode PlatformerPro.StandardInputData.jump = KeyCode.Z

The jump key.

◆ left

KeyCode PlatformerPro.StandardInputData.left = KeyCode.LeftArrow

The left key.

◆ pause

KeyCode PlatformerPro.StandardInputData.pause = KeyCode.P

The pause key.

◆ reverseAltHorizontalAxis

bool PlatformerPro.StandardInputData.reverseAltHorizontalAxis

Should we reverse the values of the horizontal axis.

◆ reverseAltVerticalAxis

bool PlatformerPro.StandardInputData.reverseAltVerticalAxis

Should we reverse the values of the vertival axis.

◆ reverseHorizontalAxis

bool PlatformerPro.StandardInputData.reverseHorizontalAxis

Should we reverse the values of the horizontal axis.

◆ reverseVerticalAxis

bool PlatformerPro.StandardInputData.reverseVerticalAxis

Should we reverse the values of the vertival axis.

◆ right

KeyCode PlatformerPro.StandardInputData.right = KeyCode.RightArrow

The right key.

◆ run

KeyCode PlatformerPro.StandardInputData.run = KeyCode.X

The run key.

◆ up

KeyCode PlatformerPro.StandardInputData.up = KeyCode.UpArrow

The up key.

◆ verticalAxisName

string PlatformerPro.StandardInputData.verticalAxisName = "Joystick1Axis2"

The vertical joystick axis.


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