Class Input

Class that handles various types of user input

Inheritance
Object
Input
Inherited Members
Namespace: Slipe.Client.IO
Assembly: SlipeClient.dll
Syntax
public static class Input

Methods

| Improve this Doc View Source

BindKey(String, KeyState, Action<String, KeyState>)

Binds a key to a method

Declaration
public static bool BindKey(string key, KeyState state, Action<string, KeyState> handler)
Parameters
Type Name Description
String key
KeyState state
Action<String, KeyState> handler
Returns
Type Description
Boolean
| Improve this Doc View Source

BindKey(String, KeyState, String)

Binds a key to a command

Declaration
public static bool BindKey(string key, KeyState state, string command)
Parameters
Type Name Description
String key
KeyState state
String command
Returns
Type Description
Boolean
| Improve this Doc View Source

GetAnalogControlState(String)

Gets analog control state

Declaration
public static float GetAnalogControlState(string control)
Parameters
Type Name Description
String control
Returns
Type Description
Single
| Improve this Doc View Source

IsControlEnabled(String)

Gets whether a control is currently enabled

Declaration
public static bool IsControlEnabled(string control)
Parameters
Type Name Description
String control
Returns
Type Description
Boolean
| Improve this Doc View Source

IsKeyPressed(String)

Returns current state of a key

Declaration
public static bool IsKeyPressed(string keyName)
Parameters
Type Name Description
String keyName
Returns
Type Description
Boolean
| Improve this Doc View Source

KeyboardReadingLayout()

This method gets the player's keyboard layout settings, which they are currently (keyboard layout can be changed at any moment) using at the time of invocation.

Declaration
public static string KeyboardReadingLayout()
Returns
Type Description
String

A string "ltr", "rtl", "ttb-rtl-ltr" or "ttb-ltr"
| Improve this Doc View Source

SetAllControlsEnabled(Boolean, Boolean, Boolean)

Enables / disables all controls

Declaration
public static bool SetAllControlsEnabled(bool value, bool mtaControls = true, bool gtaControls = false)
Parameters
Type Name Description
Boolean value
Boolean mtaControls
Boolean gtaControls
Returns
Type Description
Boolean
| Improve this Doc View Source

SetAnalogControlState(String, Single)

Sets analog control state

Declaration
public static bool SetAnalogControlState(string control, float value)
Parameters
Type Name Description
String control
Single value
Returns
Type Description
Boolean
| Improve this Doc View Source

SetControlEnabled(String, Boolean)

Enables / disabled a control

Declaration
public static bool SetControlEnabled(string control, bool value)
Parameters
Type Name Description
String control
Boolean value
Returns
Type Description
Boolean
| Improve this Doc View Source

UnbindKey(String, KeyState, Action<String, KeyState>)

Unbinds a key from a method

Declaration
public static bool UnbindKey(string key, KeyState state, Action<string, KeyState> handler)
Parameters
Type Name Description
String key
KeyState state
Action<String, KeyState> handler
Returns
Type Description
Boolean
| Improve this Doc View Source

UnbindKey(String, KeyState, String)

Unbinds a key from a command

Declaration
public static bool UnbindKey(string key, KeyState state, string command = null)
Parameters
Type Name Description
String key
KeyState state
String command
Returns
Type Description
Boolean

Events

| Improve this Doc View Source

OnCharacter

Declaration
public static event Input.OnCharacterHandler OnCharacter
Event Type
Type Description
Input.OnCharacterHandler
| Improve this Doc View Source

OnKey

Declaration
public static event Input.OnKeyHandler OnKey
Event Type
Type Description
Input.OnKeyHandler