Class KismetInputLibrary

Kismet Input Library

Inheritance
System.Object
UObject
BlueprintFunctionLibrary
KismetInputLibrary
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class KismetInputLibrary : BlueprintFunctionLibrary

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static KismetInputLibrary DefaultObject { get; }
Property Value
Type Description
KismetInputLibrary
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

CalibrateTilt()

Calibrate the tilt for the input device

Declaration
public static void CalibrateTilt()
| Improve this Doc View Source

EqualEqual_InputChordInputChord(InputChord, InputChord)

Test if the input chords are equal (A == B) @

Declaration
public static bool EqualEqual_InputChordInputChord(InputChord A, InputChord B)
Parameters
Type Name Description
InputChord A
InputChord B
Returns
Type Description
System.Boolean
Remarks

param A - The chord to compare against @param B - The chord to compare @returns True if the chords are equal, false otherwise

| Improve this Doc View Source

EqualEqual_KeyKey(Key, Key)

Test if the input key are equal (A == B) @

Declaration
public static bool EqualEqual_KeyKey(Key A, Key B)
Parameters
Type Name Description
Key A
Key B
Returns
Type Description
System.Boolean
Remarks

param A - The key to compare against @param B - The key to compare @returns True if the key are equal, false otherwise

| Improve this Doc View Source

GetAnalogValue(AnalogInputEvent)

Get Analog Value

Declaration
public static float GetAnalogValue(AnalogInputEvent Input)
Parameters
Type Name Description
AnalogInputEvent Input
Returns
Type Description
System.Single
| Improve this Doc View Source

GetKey(KeyEvent)

Returns the key for this event.

Declaration
public static Key GetKey(KeyEvent Input)
Parameters
Type Name Description
KeyEvent Input
Returns
Type Description
Key
Remarks

@return Key name

| Improve this Doc View Source

GetUserIndex(KeyEvent)

Get User Index

Declaration
public static int GetUserIndex(KeyEvent Input)
Parameters
Type Name Description
KeyEvent Input
Returns
Type Description
System.Int32
| Improve this Doc View Source

InputEvent_IsAltDown(InputEvent)

Returns true if either alt key was down when this event occurred @

Declaration
public static bool InputEvent_IsAltDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if alt is pressed

| Improve this Doc View Source

InputEvent_IsCommandDown(InputEvent)

Returns true if either command key was down when this event occurred @

Declaration
public static bool InputEvent_IsCommandDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if command is pressed

| Improve this Doc View Source

InputEvent_IsControlDown(InputEvent)

Returns true if either control key was down when this event occurred @

Declaration
public static bool InputEvent_IsControlDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if control is pressed

| Improve this Doc View Source

InputEvent_IsLeftAltDown(InputEvent)

Returns true if left alt key was down when this event occurred @

Declaration
public static bool InputEvent_IsLeftAltDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if left alt is pressed

| Improve this Doc View Source

InputEvent_IsLeftCommandDown(InputEvent)

Returns true if left command key was down when this event occurred @

Declaration
public static bool InputEvent_IsLeftCommandDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if left command is pressed

| Improve this Doc View Source

InputEvent_IsLeftControlDown(InputEvent)

Returns true if left control key was down when this event occurred @

Declaration
public static bool InputEvent_IsLeftControlDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if left control is pressed

| Improve this Doc View Source

InputEvent_IsLeftShiftDown(InputEvent)

Returns true if left shift key was down when this event occurred @

Declaration
public static bool InputEvent_IsLeftShiftDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if left shift is pressed.

| Improve this Doc View Source

InputEvent_IsRepeat(InputEvent)

Returns whether or not this character is an auto-repeated keystroke @

Declaration
public static bool InputEvent_IsRepeat(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if this character is a repeat

| Improve this Doc View Source

InputEvent_IsRightAltDown(InputEvent)

Returns true if right alt key was down when this event occurred @

Declaration
public static bool InputEvent_IsRightAltDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if right alt is pressed

| Improve this Doc View Source

InputEvent_IsRightCommandDown(InputEvent)

Returns true if right command key was down when this event occurred @

Declaration
public static bool InputEvent_IsRightCommandDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if right command is pressed

| Improve this Doc View Source

InputEvent_IsRightControlDown(InputEvent)

Returns true if left control key was down when this event occurred @

Declaration
public static bool InputEvent_IsRightControlDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if left control is pressed

| Improve this Doc View Source

InputEvent_IsRightShiftDown(InputEvent)

Returns true if right shift key was down when this event occurred @

Declaration
public static bool InputEvent_IsRightShiftDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if right shift is pressed.

| Improve this Doc View Source

InputEvent_IsShiftDown(InputEvent)

Returns true if either shift key was down when this event occurred @

Declaration
public static bool InputEvent_IsShiftDown(InputEvent Input)
Parameters
Type Name Description
InputEvent Input
Returns
Type Description
System.Boolean
Remarks

return True if shift is pressed

| Improve this Doc View Source

Key_GetDisplayName(Key)

@returns The display name of the key.

Declaration
public static byte Key_GetDisplayName(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Byte
| Improve this Doc View Source

Key_IsFloatAxis(Key)

@returns True if the key is a float axis

Declaration
public static bool Key_IsFloatAxis(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Key_IsGamepadKey(Key)

@returns True if the key is a gamepad button

Declaration
public static bool Key_IsGamepadKey(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Key_IsKeyboardKey(Key)

@returns True if the key is a keyboard button

Declaration
public static bool Key_IsKeyboardKey(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Key_IsModifierKey(Key)

@returns True if the key is a modifier key: Ctrl, Command, Alt, Shift

Declaration
public static bool Key_IsModifierKey(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Key_IsMouseButton(Key)

@returns True if the key is a mouse button

Declaration
public static bool Key_IsMouseButton(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Key_IsValid(Key)

@returns True if this is a valid key.

Declaration
public static bool Key_IsValid(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Key_IsVectorAxis(Key)

@returns True if the key is a vector axis

Declaration
public static bool Key_IsVectorAxis(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static KismetInputLibrary New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
KismetInputLibrary
| Improve this Doc View Source

PointerEvent_GetCursorDelta(PointerEvent)

@return the distance the mouse traveled since the last event was handled.

Declaration
public static Vector2D PointerEvent_GetCursorDelta(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
Vector2D
| Improve this Doc View Source

PointerEvent_GetEffectingButton(PointerEvent)

Mouse button that caused this event to be raised (possibly EB_None)

Declaration
public static Key PointerEvent_GetEffectingButton(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
Key
| Improve this Doc View Source

PointerEvent_GetGestureDelta(PointerEvent)

@return The change in gesture value since the last gesture event of the same type.

Declaration
public static Vector2D PointerEvent_GetGestureDelta(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
Vector2D
| Improve this Doc View Source

PointerEvent_GetGestureType(PointerEvent)

@return The type of touch gesture

Declaration
public static ESlateGesture PointerEvent_GetGestureType(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
ESlateGesture
| Improve this Doc View Source

PointerEvent_GetLastScreenSpacePosition(PointerEvent)

@return The position of the cursor in screen space last time we handled an input event

Declaration
public static Vector2D PointerEvent_GetLastScreenSpacePosition(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
Vector2D
| Improve this Doc View Source

PointerEvent_GetPointerIndex(PointerEvent)

@return The unique identifier of the pointer (e.g., finger index)

Declaration
public static int PointerEvent_GetPointerIndex(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
System.Int32
| Improve this Doc View Source

PointerEvent_GetScreenSpacePosition(PointerEvent)

@return The position of the cursor in screen space

Declaration
public static Vector2D PointerEvent_GetScreenSpacePosition(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
Vector2D
| Improve this Doc View Source

PointerEvent_GetTouchpadIndex(PointerEvent)

@return The index of the touch pad that generated this event (for platforms with multiple touch pads per user)

Declaration
public static int PointerEvent_GetTouchpadIndex(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
System.Int32
| Improve this Doc View Source

PointerEvent_GetUserIndex(PointerEvent)

@return The index of the user that caused the event

Declaration
public static int PointerEvent_GetUserIndex(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
System.Int32
| Improve this Doc View Source

PointerEvent_GetWheelDelta(PointerEvent)

How much did the mouse wheel turn since the last mouse event

Declaration
public static float PointerEvent_GetWheelDelta(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
System.Single
| Improve this Doc View Source

PointerEvent_IsMouseButtonDown(PointerEvent, Key)

Mouse buttons that are currently pressed

Declaration
public static bool PointerEvent_IsMouseButtonDown(PointerEvent Input, Key MouseButton)
Parameters
Type Name Description
PointerEvent Input
Key MouseButton
Returns
Type Description
System.Boolean
| Improve this Doc View Source

PointerEvent_IsTouchEvent(PointerEvent)

@return Is this event a result from a touch (as opposed to a mouse)

Declaration
public static bool PointerEvent_IsTouchEvent(PointerEvent Input)
Parameters
Type Name Description
PointerEvent Input
Returns
Type Description
System.Boolean

Operators

| Improve this Doc View Source

Implicit(IntPtr to KismetInputLibrary)

Convert from IntPtr to UObject

Declaration
public static implicit operator KismetInputLibrary(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
KismetInputLibrary