Shooter Template  1.2.3
Public Member Functions | Public Attributes | Properties | List of all members
Invector.vCharacterController.GenericInput Class Reference

Public Member Functions

 GenericInput (string keyboard, string joystick, string mobile)
 Initialise a new GenericInput More...
 
 GenericInput (string keyboard, bool keyboardAxis, string joystick, bool joystickAxis, string mobile, bool mobileAxis)
 Initialise a new GenericInput More...
 
 GenericInput (string keyboard, bool keyboardAxis, bool keyboardInvert, string joystick, bool joystickAxis, bool joystickInvert, string mobile, bool mobileAxis, bool mobileInvert)
 Initialise a new GenericInput More...
 
bool GetButton ()
 Get Button More...
 
bool GetButtonDown ()
 Get ButtonDown More...
 
bool GetButtonUp ()
 Get Button Up More...
 
float GetAxis ()
 Get Axis More...
 
float GetAxisRaw ()
 Get Axis Raw More...
 
bool GetDoubleButtonDown (float inputTime=1)
 Get Double Button Down Check if button is pressed Within the defined time More...
 
bool GetButtonTimer (float inputTime=2)
 Get Buttom Timer Check if button is pressed for defined time More...
 
bool GetAxisButton (float value=0.5f)
 Get Axis like a button
More...
 
bool GetAxisButtonDown (float value=0.5f)
 Get Axis like a buttonDown
More...
 
bool GetAxisButtonUp ()
 Get Axis like a buttonUp Check if Axis is zero after press

Returns
More...
 

Public Attributes

bool useInput = true
 

Properties

InputDevice inputDevice [get]
 
bool isAxis [get]
 
bool isAxisInvert [get]
 
string buttonName [get]
 Button Name More...
 
bool isKey [get]
 Check if button is a Key More...
 
KeyCode key [get]
 Get KeyCode value More...
 

Constructor & Destructor Documentation

◆ GenericInput() [1/3]

Invector.vCharacterController.GenericInput.GenericInput ( string  keyboard,
string  joystick,
string  mobile 
)

Initialise a new GenericInput

Parameters
keyboard
joystick
mobile

◆ GenericInput() [2/3]

Invector.vCharacterController.GenericInput.GenericInput ( string  keyboard,
bool  keyboardAxis,
string  joystick,
bool  joystickAxis,
string  mobile,
bool  mobileAxis 
)

Initialise a new GenericInput

Parameters
keyboard
joystick
mobile

◆ GenericInput() [3/3]

Invector.vCharacterController.GenericInput.GenericInput ( string  keyboard,
bool  keyboardAxis,
bool  keyboardInvert,
string  joystick,
bool  joystickAxis,
bool  joystickInvert,
string  mobile,
bool  mobileAxis,
bool  mobileInvert 
)

Initialise a new GenericInput

Parameters
keyboard
joystick
mobile

Member Function Documentation

◆ GetAxis()

float Invector.vCharacterController.GenericInput.GetAxis ( )

Get Axis

Returns

◆ GetAxisButton()

bool Invector.vCharacterController.GenericInput.GetAxisButton ( float  value = 0.5f)

Get Axis like a button

Parameters
valueValue to check need to be diferent 0
Returns

◆ GetAxisButtonDown()

bool Invector.vCharacterController.GenericInput.GetAxisButtonDown ( float  value = 0.5f)

Get Axis like a buttonDown

Parameters
valueValue to check need to be diferent 0
Returns

◆ GetAxisButtonUp()

bool Invector.vCharacterController.GenericInput.GetAxisButtonUp ( )

Get Axis like a buttonUp Check if Axis is zero after press

Returns

◆ GetAxisRaw()

float Invector.vCharacterController.GenericInput.GetAxisRaw ( )

Get Axis Raw

Returns

◆ GetButton()

bool Invector.vCharacterController.GenericInput.GetButton ( )

Get Button

Returns

◆ GetButtonDown()

bool Invector.vCharacterController.GenericInput.GetButtonDown ( )

Get ButtonDown

Returns

◆ GetButtonTimer()

bool Invector.vCharacterController.GenericInput.GetButtonTimer ( float  inputTime = 2)

Get Buttom Timer Check if button is pressed for defined time

Parameters
inputTimetime to check button press
Returns

◆ GetButtonUp()

bool Invector.vCharacterController.GenericInput.GetButtonUp ( )

Get Button Up

Returns

◆ GetDoubleButtonDown()

bool Invector.vCharacterController.GenericInput.GetDoubleButtonDown ( float  inputTime = 1)

Get Double Button Down Check if button is pressed Within the defined time

Parameters
inputTime
Returns

Member Data Documentation

◆ useInput

bool Invector.vCharacterController.GenericInput.useInput = true

Property Documentation

◆ buttonName

string Invector.vCharacterController.GenericInput.buttonName
get

Button Name

◆ inputDevice

InputDevice Invector.vCharacterController.GenericInput.inputDevice
getprotected

◆ isAxis

bool Invector.vCharacterController.GenericInput.isAxis
get

◆ isAxisInvert

bool Invector.vCharacterController.GenericInput.isAxisInvert
get

◆ isKey

bool Invector.vCharacterController.GenericInput.isKey
get

Check if button is a Key

◆ key

KeyCode Invector.vCharacterController.GenericInput.key
get

Get KeyCode value


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