unreal.InputLibrary

class unreal.InputLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Kismet Input Library

C++ Source:

  • Module: Engine

  • File: KismetInputLibrary.h

classmethod calibrate_tilt() → None

Calibrate the tilt for the input device

classmethod equal_equal_input_chord_input_chord(a, b) → bool

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

Parameters:

  • a (InputChord) – The chord to compare against

  • b (InputChord) – The chord to compare Returns true if the chords are equal, false otherwise

Return type:

bool

classmethod equal_equal_key_key(a, b) → bool

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

Parameters:

  • a (Key) – The key to compare against

  • b (Key) – The key to compare Returns true if the key are equal, false otherwise

Return type:

bool

classmethod get_analog_value(input) → float

Get Analog Value

Parameters:

input (AnalogInputEvent) –

Return type:

float

classmethod get_key(input) → Key

Returns the key for this event.

Parameters:

input (KeyEvent) –

Returns:

Key name

Return type:

Key

classmethod get_modifier_keys_state() → SlateModifierKeysState

Returns a snapshot of the cached modifier-keys state for the application.

Return type:

SlateModifierKeysState

classmethod get_user_index(input) → int32

Get User Index

Parameters:

input (KeyEvent) –

Return type:

int32

classmethod input_chord_get_display_name(key) → Text
Parameters:

key (InputChord) –

Returns:

The display name of the input chord

Return type:

Text

classmethod input_event_is_alt_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_command_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_control_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_left_alt_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_left_command_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_left_control_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_left_shift_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_repeat(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_right_alt_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_right_command_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_right_control_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_right_shift_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod input_event_is_shift_down(input) → bool

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

Parameters:

input (InputEvent) –

Return type:

bool

classmethod key_get_display_name(key, long_display_name=True) → Text

Returns the display name of the key.

Parameters:

  • key (Key) –

  • long_display_name (bool) –

Return type:

Text

classmethod key_get_navigation_action(key) → UINavigationAction

Key Get Navigation Action deprecated: Use Get Key Event Navigation Action instead

Parameters:

key (Key) –

Return type:

UINavigationAction

classmethod key_get_navigation_action_from_key(key_event) → UINavigationAction

Returns the navigation action corresponding to this key, or Invalid if not found

Parameters:

key_event (KeyEvent) –

Return type:

UINavigationAction

classmethod key_get_navigation_direction_from_analog(analog_event) → UINavigation

Returns the navigation action corresponding to this key, or Invalid if not found

Parameters:

analog_event (AnalogInputEvent) –

Return type:

UINavigation

classmethod key_get_navigation_direction_from_key(key_event) → UINavigation

Returns the navigation action corresponding to this key, or Invalid if not found

Parameters:

key_event (KeyEvent) –

Return type:

UINavigation

classmethod key_is_analog(key) → bool

Returns true if the key is an analog axis

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_axis1d(key) → bool

Returns true if the key is a 1D (float) axis

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_axis2d(key) → bool

Returns true if the key is a 2D (vector) axis

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_axis3d(key) → bool

Returns true if the key is a 3D (vector) axis

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_button_axis(key) → bool

Returns true if the key is a 1D axis emulating a digital button press.

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_digital(key) → bool

Returns true if the key is a digital button press

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_float_axis(key: Key) → bool

deprecated: ‘key_is_float_axis’ was renamed to ‘key_is_axis1d’.

classmethod key_is_gamepad_key(key) → bool

Returns true if the key is a gamepad button

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_keyboard_key(key) → bool

Returns true if the key is a keyboard button

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_modifier_key(key) → bool

Returns true if the key is a modifier key: Ctrl, Command, Alt, Shift

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_mouse_button(key) → bool

Returns true if the key is a mouse button

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_valid(key) → bool

Returns true if this is a valid key.

Parameters:

key (Key) –

Return type:

bool

classmethod key_is_vector_axis(key) → bool

Returns true if the key is a vector axis deprecated: Use Is Axis 2D/3D instead. note: Deprecated. Use Is Axis 2D/3D instead.

Parameters:

key (Key) –

Return type:

bool

classmethod modifier_keys_state_is_alt_down(keys_state) → bool

Returns true if either alt key was down when the key state was captured

Parameters:

keys_state (SlateModifierKeysState) –

Return type:

bool

classmethod modifier_keys_state_is_command_down(keys_state) → bool

Returns true if either command key was down when the key state was captured

Parameters:

keys_state (SlateModifierKeysState) –

Return type:

bool

classmethod modifier_keys_state_is_control_down(keys_state) → bool

Returns true if either control key was down when the key state was captured

Parameters:

keys_state (SlateModifierKeysState) –

Return type:

bool

classmethod modifier_keys_state_is_shift_down(keys_state) → bool

Returns true if either shift key was down when the key state was captured

Parameters:

keys_state (SlateModifierKeysState) –

Return type:

bool

classmethod pointer_event_get_cursor_delta(input) → Vector2D

Returns the distance the mouse traveled since the last event was handled.

Parameters:

input (PointerEvent) –

Return type:

Vector2D

classmethod pointer_event_get_effecting_button(input) → Key

Mouse button that caused this event to be raised (possibly FKey::Invalid)

Parameters:

input (PointerEvent) –

Return type:

Key

classmethod pointer_event_get_gesture_delta(input) → Vector2D

Returns the change in gesture value since the last gesture event of the same type.

Parameters:

input (PointerEvent) –

Return type:

Vector2D

classmethod pointer_event_get_gesture_type(input) → SlateGesture

Returns the type of touch gesture

Parameters:

input (PointerEvent) –

Return type:

SlateGesture

classmethod pointer_event_get_last_screen_space_position(input) → Vector2D

Returns the position of the cursor in screen space last time we handled an input event

Parameters:

input (PointerEvent) –

Return type:

Vector2D

classmethod pointer_event_get_pointer_index(input) → int32

Returns the unique identifier of the pointer (e.g., finger index)

Parameters:

input (PointerEvent) –

Return type:

int32

classmethod pointer_event_get_screen_space_position(input) → Vector2D

Returns The position of the cursor in screen space

Parameters:

input (PointerEvent) –

Return type:

Vector2D

classmethod pointer_event_get_touchpad_index(input) → int32

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

Parameters:

input (PointerEvent) –

Return type:

int32

classmethod pointer_event_get_user_index(input) → int32

Returns the index of the user that caused the event

Parameters:

input (PointerEvent) –

Return type:

int32

classmethod pointer_event_get_wheel_delta(input) → float

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

Parameters:

input (PointerEvent) –

Return type:

float

classmethod pointer_event_is_mouse_button_down(input, mouse_button) → bool

Mouse buttons that are currently pressed

Parameters:
Return type:

bool

classmethod pointer_event_is_touch_event(input) → bool

Returns true if this event a result from a touch (as opposed to a mouse)

Parameters:

input (PointerEvent) –

Return type:

bool