TaleWorlds.InputSystem.InputContext Class Reference

Inherits TaleWorlds.InputSystem.IInputContext.

Public Member Functions
	InputContext ()
int	GetPointerX ()
int	GetPointerY ()
Vector2	GetPointerPosition ()
Vec2	GetPointerPositionVec2 ()
void	RegisterHotKeyCategory (GameKeyContext category)
bool	IsCategoryRegistered (GameKeyContext category)
void	UpdateLastDownKeys ()
void	ResetLastDownKeys ()
bool	IsHotKeyDown (string hotKey)
bool	IsGameKeyDown (int gameKey)
bool	IsGameKeyDownImmediate (int gameKey)
bool	IsHotKeyDownAndReleased (string hotkey)
	Represents if the key was down while the Input was active and released.
bool	IsHotKeyPressed (string hotKey)
bool	IsGameKeyDownAndReleased (int gameKey)
	Represents if the key was down while the Input was active and released.
bool	IsGameKeyPressed (int gameKey)
bool	IsHotKeyReleased (string hotKey)
bool	IsGameKeyReleased (int gameKey)
float	GetGameKeyState (int gameKey)
bool	IsHotKeyDoublePressed (string hotKey)
float	GetGameKeyAxis (GameAxisKey gameKey)
float	GetGameKeyAxis (string gameKey)
Vec2	GetKeyState (InputKey key)
bool	IsKeyDown (InputKey key)
bool	IsKeyPressed (InputKey key)
bool	IsKeyReleased (InputKey key)
float	GetMouseMoveX ()
float	GetMouseMoveY ()
Vec2	GetControllerRightStickState ()
Vec2	GetControllerLeftStickState ()
bool	GetIsMouseActive ()
bool	GetIsMouseDown ()
Vec2	GetMousePositionPixel ()
float	GetDeltaMouseScroll ()
bool	GetIsControllerConnected ()
Vec2	GetMousePositionRanged ()
float	GetMouseSensitivity ()
bool	IsControlDown ()
bool	IsShiftDown ()
bool	IsAltDown ()
InputKey	GetControllerClickKey ()
	Represents the click key for controller. In some regional builds the click key is different.
int	GetPointerX ()
int	GetPointerY ()
Vector2	GetPointerPosition ()
bool	IsGameKeyDown (int gameKey)
bool	IsGameKeyDownImmediate (int gameKey)
bool	IsGameKeyReleased (int gameKey)
bool	IsGameKeyPressed (int gameKey)
bool	IsGameKeyDownAndReleased (int gameKey)
	Represents if the key was down while the Input was active and released.
float	GetGameKeyAxis (string gameKey)
bool	IsHotKeyDown (string gameKey)
bool	IsHotKeyReleased (string gameKey)
bool	IsHotKeyPressed (string gameKey)
bool	IsHotKeyDownAndReleased (string gameKey)
	Represents if the key was down while the Input was active and released.
bool	IsHotKeyDoublePressed (string gameKey)
bool	IsKeyDown (InputKey key)
bool	IsKeyPressed (InputKey key)
bool	IsKeyReleased (InputKey key)
Vec2	GetKeyState (InputKey key)
float	GetMouseMoveX ()
float	GetMouseMoveY ()
Vec2	GetControllerRightStickState ()
Vec2	GetControllerLeftStickState ()
float	GetDeltaMouseScroll ()
bool	GetIsControllerConnected ()
bool	GetIsMouseActive ()
Vec2	GetMousePositionRanged ()
Vec2	GetMousePositionPixel ()
float	GetMouseSensitivity ()
bool	IsControlDown ()
bool	IsShiftDown ()
bool	IsAltDown ()
InputKey	GetControllerClickKey ()
	Represents the click key for controller. In some regional builds the click key is different.

Protected Member Functions
bool	IsMouseButton (InputKey key)

Properties
bool	IsKeysAllowed [get, set]
bool	IsMouseButtonAllowed [get, set]
bool	IsMouseWheelAllowed [get, set]
bool	IsControllerAllowed [get]
bool	MouseOnMe [get, set]

Constructor & Destructor Documentation

InputContext()

TaleWorlds.InputSystem.InputContext.InputContext

(

)

Member Function Documentation

GetPointerX()

int TaleWorlds.InputSystem.InputContext.GetPointerX

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetPointerY()

int TaleWorlds.InputSystem.InputContext.GetPointerY

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetPointerPosition()

Vector2 TaleWorlds.InputSystem.InputContext.GetPointerPosition

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetPointerPositionVec2()

Vec2 TaleWorlds.InputSystem.InputContext.GetPointerPositionVec2

(

)

RegisterHotKeyCategory()

void TaleWorlds.InputSystem.InputContext.RegisterHotKeyCategory

(

GameKeyContext

category

)

IsCategoryRegistered()

bool TaleWorlds.InputSystem.InputContext.IsCategoryRegistered

(

GameKeyContext

category

)

UpdateLastDownKeys()

void TaleWorlds.InputSystem.InputContext.UpdateLastDownKeys

(

)

ResetLastDownKeys()

void TaleWorlds.InputSystem.InputContext.ResetLastDownKeys

(

)

IsHotKeyDown()

bool TaleWorlds.InputSystem.InputContext.IsHotKeyDown

(

string

hotKey

)

Implements TaleWorlds.InputSystem.IInputContext.

IsGameKeyDown()

bool TaleWorlds.InputSystem.InputContext.IsGameKeyDown

(

int

gameKey

)

Implements TaleWorlds.InputSystem.IInputContext.

IsGameKeyDownImmediate()

bool TaleWorlds.InputSystem.InputContext.IsGameKeyDownImmediate

(

int

gameKey

)

Implements TaleWorlds.InputSystem.IInputContext.

IsHotKeyDownAndReleased()

bool TaleWorlds.InputSystem.InputContext.IsHotKeyDownAndReleased

(

string

gameKey

)

Implements TaleWorlds.InputSystem.IInputContext.

IsHotKeyPressed()

bool TaleWorlds.InputSystem.InputContext.IsHotKeyPressed

(

string

hotKey

)

Implements TaleWorlds.InputSystem.IInputContext.

IsGameKeyDownAndReleased()

bool TaleWorlds.InputSystem.InputContext.IsGameKeyDownAndReleased

(

int

gameKey

)

Implements TaleWorlds.InputSystem.IInputContext.

IsGameKeyPressed()

bool TaleWorlds.InputSystem.InputContext.IsGameKeyPressed

(

int

gameKey

)

Implements TaleWorlds.InputSystem.IInputContext.

IsHotKeyReleased()

bool TaleWorlds.InputSystem.InputContext.IsHotKeyReleased

(

string

hotKey

)

Implements TaleWorlds.InputSystem.IInputContext.

IsGameKeyReleased()

bool TaleWorlds.InputSystem.InputContext.IsGameKeyReleased

(

int

gameKey

)

Implements TaleWorlds.InputSystem.IInputContext.

GetGameKeyState()

float TaleWorlds.InputSystem.InputContext.GetGameKeyState

(

int

gameKey

)

IsHotKeyDoublePressed()

bool TaleWorlds.InputSystem.InputContext.IsHotKeyDoublePressed

(

string

hotKey

)

Implements TaleWorlds.InputSystem.IInputContext.

GetGameKeyAxis() [1/2]

float TaleWorlds.InputSystem.InputContext.GetGameKeyAxis

(

GameAxisKey

gameKey

)

GetGameKeyAxis() [2/2]

float TaleWorlds.InputSystem.InputContext.GetGameKeyAxis

(

string

gameKey

)

Implements TaleWorlds.InputSystem.IInputContext.

GetKeyState()

Vec2 TaleWorlds.InputSystem.InputContext.GetKeyState

(

InputKey

key

)

Implements TaleWorlds.InputSystem.IInputContext.

IsMouseButton()

bool TaleWorlds.InputSystem.InputContext.IsMouseButton ( InputKey  key )

protected

IsKeyDown()

bool TaleWorlds.InputSystem.InputContext.IsKeyDown

(

InputKey

key

)

Implements TaleWorlds.InputSystem.IInputContext.

IsKeyPressed()

bool TaleWorlds.InputSystem.InputContext.IsKeyPressed

(

InputKey

key

)

Implements TaleWorlds.InputSystem.IInputContext.

IsKeyReleased()

bool TaleWorlds.InputSystem.InputContext.IsKeyReleased

(

InputKey

key

)

Implements TaleWorlds.InputSystem.IInputContext.

GetMouseMoveX()

float TaleWorlds.InputSystem.InputContext.GetMouseMoveX

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetMouseMoveY()

float TaleWorlds.InputSystem.InputContext.GetMouseMoveY

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetControllerRightStickState()

Vec2 TaleWorlds.InputSystem.InputContext.GetControllerRightStickState

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetControllerLeftStickState()

Vec2 TaleWorlds.InputSystem.InputContext.GetControllerLeftStickState

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetIsMouseActive()

bool TaleWorlds.InputSystem.InputContext.GetIsMouseActive

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetIsMouseDown()

bool TaleWorlds.InputSystem.InputContext.GetIsMouseDown

(

)

GetMousePositionPixel()

Vec2 TaleWorlds.InputSystem.InputContext.GetMousePositionPixel

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetDeltaMouseScroll()

float TaleWorlds.InputSystem.InputContext.GetDeltaMouseScroll

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetIsControllerConnected()

bool TaleWorlds.InputSystem.InputContext.GetIsControllerConnected

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetMousePositionRanged()

Vec2 TaleWorlds.InputSystem.InputContext.GetMousePositionRanged

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetMouseSensitivity()

float TaleWorlds.InputSystem.InputContext.GetMouseSensitivity

(

)

Implements TaleWorlds.InputSystem.IInputContext.

IsControlDown()

bool TaleWorlds.InputSystem.InputContext.IsControlDown

(

)

Implements TaleWorlds.InputSystem.IInputContext.

IsShiftDown()

bool TaleWorlds.InputSystem.InputContext.IsShiftDown

(

)

Implements TaleWorlds.InputSystem.IInputContext.

IsAltDown()

bool TaleWorlds.InputSystem.InputContext.IsAltDown

(

)

Implements TaleWorlds.InputSystem.IInputContext.

GetControllerClickKey()

InputKey TaleWorlds.InputSystem.InputContext.GetControllerClickKey

(

)

Implements TaleWorlds.InputSystem.IInputContext.

Property Documentation

IsKeysAllowed

bool TaleWorlds.InputSystem.InputContext.IsKeysAllowed

getset

IsMouseButtonAllowed

bool TaleWorlds.InputSystem.InputContext.IsMouseButtonAllowed

getset

IsMouseWheelAllowed

bool TaleWorlds.InputSystem.InputContext.IsMouseWheelAllowed

getset

IsControllerAllowed

bool TaleWorlds.InputSystem.InputContext.IsControllerAllowed

get

MouseOnMe

bool TaleWorlds.InputSystem.InputContext.MouseOnMe

getset