Kit input

126 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.

As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em tools/list).

Guia

Authoring and testing input for a project: Enhanced Input assets (Input Actions, Input Mapping Contexts, key mappings with modifiers and triggers), Player Mappable Key Settings and user settings, Project Settings > Input (classic mappings, axis config, console keys, mouse/viewport options), Enhanced Input developer settings, PIE-time injection and queries, and Blueprint wiring.

Works on UE 4.27 through 5.8. Tools marked with a minimum engine version are hidden on older engines. The kit is split over four classes (UUeaKit_Input, UUeaKit_InputAssets, UUeaKit_InputSettings, UUeaKit_InputRuntime) that all expose the input. namespace.

Tools

Assets and mappings

Tool	Purpose
input.create_action / input.create_mapping_context	New UInputAction (valueType: bool, axis1d, axis2d, axis3d) / empty UInputMappingContext.
input.list_actions / input.list_contexts	Registry search by folder + name substring.
input.asset_exists / input.mapping_exists	Existence checks (returns kind / mapping index).
input.duplicate_asset / input.rename_asset / input.delete_asset	Asset lifecycle for actions, contexts and mappable configs.
input.get_action / input.set_action_properties / input.set_action_options	Value type, consumeInput, triggerWhenPaused, description, reserveAllMappings, accumulationBehavior (5.3+), any property.
input.get_context / input.set_context_description	Every mapping with indices; description and other context properties.
input.add_mapping / input.remove_mapping / input.clear_mappings	Map one key, unmap one, unmap all.
input.set_mapping_key / input.update_mapping	Change the key (or action+key by index) of an existing mapping, keeping behaviours.
input.remove_action_mappings / input.remove_key_mappings	Remove every mapping of an action / of a key.
input.edit_context	Batch add + remove mappings in one call.
input.build_context_from_spec	Build or fill a context from mappings:[{action, key, modifiers:[{className, properties}], triggers:[...]}], creating missing actions.
input.find_mappings	Find which contexts map an action and/or a key.
input.validate_context	Unbound actions, duplicate mappings, null/duplicate/conflicting triggers, chord without action, key/value-type mismatches, shared keys.
input.create_standard_set	IA_Move/Look/Jump/Sprint/Interact (+Crouch/Fire) and IMC_Default with WASD, mouse, Space, Shift, E and gamepad.
input.migrate_legacy_to_enhanced	Classic Action/Axis mappings -> Input Actions + IMC (scale -1 = Negate, other scales = Scalar).

Modifiers and triggers

Tool	Purpose
input.list_modifier_types / input.list_trigger_types / input.get_type_info	Available classes; per-class editable properties with type, default, tooltip, enum values.
input.add_modifier / input.add_trigger	Generic add by class name to a mapping (Context+Action+Key), with properties.
input.add_action_modifier / input.add_action_trigger / input.remove_action_modifier / input.remove_action_trigger	Same on the Input Action asset (applies to every mapping).
input.remove_modifier / input.remove_trigger	Remove from a mapping by index.
input.set_modifier_properties / input.set_trigger_properties	Set properties by index; key empty = action-level.
input.reorder_modifier / input.reorder_trigger	Move an entry (modifiers run in array order).
Typed modifiers: input.add_negate, add_swizzle, add_scalar, add_dead_zone, add_smooth, add_fov_scaling, add_to_world_space, add_response_curve_exponential, add_response_curve_user, add_scale_by_delta_time (5.1+), add_smooth_delta (5.4+)	Each takes the real properties of its class. key empty = on the action.
Typed triggers: input.add_pressed, add_released, add_down, add_hold, add_hold_and_release, add_tap, add_pulse, add_chord_action, add_combo (5.1+), add_repeated_tap (5.6+)	Same.

Player mappable settings (5.1+/5.3+)

Tool	Purpose
input.set_action_mappable_settings (5.3+)	Player Mappable Key Settings on an action: mapping name, displayName, displayCategory (or clear).
input.set_mapping_mappable_settings (5.3+)	Per-mapping behaviour: inherit / override (own settings) / ignore.
input.list_mappable_names (5.3+)	Every mappable name under a folder.
input.create_mappable_input_config / input.set_mappable_input_config_context / input.get_mappable_input_config (5.1+)	PlayerMappableInputConfig assets (deprecated by Epic from 5.3).

Keys

Tool	Purpose
input.list_keys	FKey names with category, axis type, gamepad/mouse flags (filter substring).
input.find_key	Resolve a name or display name; all flags (touch, gesture, modifier, digital/analog, paired axis, deprecated).
input.list_key_categories	Menu categories with counts.

Project Settings > Input

Tool	Purpose
input.get_input_settings / input.set_input_settings	Any UInputSettings property by name; writes DefaultInput.ini.
input.set_default_input_classes	DefaultPlayerInputClass / DefaultInputComponentClass (EnhancedPlayerInput / EnhancedInputComponent).
input.list_axis_config / input.set_axis_config	Per-axis dead zone, sensitivity, exponent, invert.
input.list_console_keys / input.add_console_key / input.remove_console_key	Console keys.
input.set_viewport_input_settings	Mouse capture/lock modes, smoothing, FOV scaling, double-click time, touch interface, fullscreen toggles.
input.add_action_mapping / input.add_axis_mapping / input.remove_action_mapping / input.remove_axis_mapping / input.list_legacy_mappings	Classic mappings.
input.get_legacy_mapping / input.rename_legacy_mapping / input.set_axis_mapping_scale / input.remove_all_legacy_mappings	Classic mapping extras.
input.get_enhanced_developer_settings / input.set_enhanced_developer_settings (5.1+)	UEnhancedInputDeveloperSettings (user settings on/off, classes, world subsystem, input modes).
input.list_default_mapping_contexts / input.add_default_mapping_context / input.remove_default_mapping_context (5.2+)	Contexts auto-applied to every player (or the world subsystem) with priority / add-immediately / register-with-user-settings.
input.get_enhanced_editor_settings / input.set_enhanced_editor_settings (5.1+)	Editor-side Enhanced Input settings (Project. prefix for the editor project settings).

PIE (runtime)

Tool	Purpose
input.pie_status	Is PIE running, player controller/pawn, input classes, subsystem availability.
input.pie_inject_action	Inject a value for an action for one frame (bool/axis from value.x/y/z).
input.pie_inject_key / input.pie_inject_axis	Raw key events (pressed/released/repeat/doubleclick/tap) and axis deltas through the player controller.
input.pie_list_applied_contexts / pie_add_context / pie_remove_context / pie_clear_contexts	Mapping contexts on the live player (runtime only).
input.pie_get_action_value / input.pie_query_keys_for_action	Current value/trigger state; keys mapped in the active set.
input.pie_list_bound_actions / input.pie_list_legacy_bindings	Bindings on the controller's and pawn's input components.
input.pie_get_user_settings / pie_list_player_key_mappings / pie_map_player_key / pie_unmap_player_key / pie_reset_player_key_row / pie_save_user_settings / pie_set_key_profile / pie_register_context_with_user_settings (5.3+)	Enhanced Input user settings: key profiles and player key rebinding.
input.press_editor_key	Press Ctrl+S-style chords or type text into the focused editor widget.

Blueprint wiring

Tool	Purpose
input.setup_default_context	Adds an InputMappingContext variable with a default value (no graph changes).
input.add_context_to_blueprint_begin_play	Inserts BeginPlay -> (GetController -> Cast) -> GetSubsystem(EnhancedInputLocalPlayerSubsystem) -> AddMappingContext into a PlayerController/Pawn Blueprint and compiles. Idempotent.
input.list_blueprint_input_events	Enhanced action, classic action/axis and key event nodes (+ AddMappingContext calls) in the event graphs.
input.add_enhanced_action_event / input.add_legacy_action_event / input.add_legacy_axis_event / input.add_key_event	Event nodes; existing identical nodes are returned instead of duplicated.
input.remove_input_event	Remove an input event node by GUID.

Recipe: complete Enhanced Input setup in five calls

1. input.create_standard_set {folder:"/Game/Input"} -> IA_* actions + IMC_Default with keyboard/mouse/gamepad.
2. input.set_default_input_classes {playerInputClass:"EnhancedPlayerInput", inputComponentClass:"EnhancedInputComponent"} (5.1+ projects already default to these).
3. input.add_context_to_blueprint_begin_play {blueprint:"BP_PlayerCharacter", context:"IMC_Default", priority:0}.
4. input.add_enhanced_action_event {blueprint:"BP_PlayerCharacter", action:"IA_Jump"} then connect the Triggered pin with bp.connect_pins (repeat for IA_Move etc.).
5. input.validate_context {context:"IMC_Default"} then asset.save_all.

Recipe: hand-built context with a declarative spec

input.build_context_from_spec {
  "name": "IMC_Vehicle", "folder": "/Game/Input",
  "mappings": [
    {"action": "IA_Throttle", "valueType": "axis1d", "key": "W"},
    {"action": "IA_Throttle", "key": "S", "modifiers": [{"className": "Negate"}]},
    {"action": "IA_Throttle", "key": "Gamepad_RightTriggerAxis"},
    {"action": "IA_Handbrake", "key": "SpaceBar", "triggers": [{"className": "Hold", "properties": [{"key": "HoldTimeThreshold", "value": "0.3"}]}]}
  ]
}

Recipe: test without touching the keyboard (PIE)

1. Start PIE (edit kit), input.pie_status.
2. input.pie_list_applied_contexts - if empty, input.pie_add_context {context:"IMC_Default"} for this session.
3. input.pie_inject_action {action:"IA_Jump", value:{x:1}} or input.pie_inject_key {key:"SpaceBar", event:"tap"}.
4. input.pie_get_action_value {action:"IA_Move"} while input.pie_inject_axis {key:"Gamepad_LeftX", delta:1}.

Recipe: player key rebinding (5.3+)

1. input.set_action_mappable_settings {action:"IA_Jump", name:"Jump", displayName:"Jump", displayCategory:"Movement"}.
2. input.set_enhanced_developer_settings {properties:[{key:"bEnableUserSettings", value:"true"}]} and input.add_default_mapping_context {context:"IMC_Default", registerWithUserSettings:true}.
3. In PIE: input.pie_list_player_key_mappings, input.pie_map_player_key {mappingName:"Jump", newKey:"F", slot:"First"}, input.pie_save_user_settings.

Recipe: classic input (4.27 projects without Enhanced Input in the pawn)

1. input.add_axis_mapping {name:"MoveForward", key:"W", scale:1} and {key:"S", scale:-1}
2. input.add_action_mapping {name:"Jump", key:"SpaceBar"}
3. input.add_legacy_axis_event {blueprint:"BP_Pawn", name:"MoveForward"} / input.add_legacy_action_event {..., name:"Jump"}.
4. Later: input.migrate_legacy_to_enhanced {removeLegacy:false} to convert.

Gotchas

• Key names are FKey names, not labels: SpaceBar, LeftMouseButton, Mouse2D, MouseX, Gamepad_LeftX, Gamepad_Left2D, Gamepad_FaceButton_Bottom. Matching is case-insensitive and display names work too (input.find_key shows suggestions).
• A 2D action mapped to a 1D key needs Swizzle to drive Y; Negate inverts. Property values use engine text form (true, 0.5, (X=1,Y=0,Z=0), enum names like YXZ, Radial).
• Typed add tools with key empty target the Input Action asset (applies to all mappings); with context + key they target one mapping. set_*_properties / reorder_* work the same way.
• add_mapping refuses a duplicate Action+Key; edit_context / build_context_from_spec skip duplicates instead. Indices come from get_context and shift after a removal.
• set_action_properties, set_viewport_input_settings, set_axis_config use text tri-states for booleans ("false"); empty means "leave unchanged".
• add_context_to_blueprint_begin_play uses a literal asset reference unless variableName is given; it splices before whatever BeginPlay already executed and returns the created nodes.
• pie_* tools need a running PIE session and affect the live player only (nothing is saved); injected action values last one frame. Legacy key injection goes through the PlayerController so both classic and Enhanced mappings react.
• press_editor_key targets the editor's focused Slate widget (not the game viewport).
• Combo triggers are deprecated by Epic in 5.8 but still work; add_combo sets the steps through reflection so the property names of every 5.x version are handled.
• remove_all_legacy_mappings, delete_asset, clear_mappings and remove_input_event are destructive; asset edits are undoable with edit.undo, settings writes go straight to the .ini.
• New assets are dirty in memory until asset.save / asset.save_all.

Ferramentas

Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de MaxAutoRisk exigem "_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumento dryRun. smoke = coberto por edit.self_test.

input.add_action_mapping (risco 4, altera)

Adds a classic Action Mapping (Name + Key + modifier keys) to Project Settings > Input and saves DefaultInput.ini.

Argumento	Tipo	Descrição
name	string	obrigatório. Action mapping name, e.g. "Jump".
key	string	obrigatório. FKey name, e.g. "SpaceBar".
shift	boolean	Padrão false.
ctrl	boolean	Padrão false.
alt	boolean	Padrão false.
cmd	boolean	Padrão false.

Retorna: actionMappings, axisMappings, message.

input.add_action_modifier (risco 2, altera, smoke)

Adds a modifier class to the Input Action asset itself (applies to every mapping of the action).

Argumento	Tipo	Descrição
action	string	obrigatório. Input Action asset (path or bare name).
className	string	obrigatório. Class: short ("Negate", "Hold"), full ("InputModifierNegate") or display name.
properties	array of UeaKeyValue	Properties to set on the new object, e.g. HoldTimeThreshold=0.5.

Retorna: asset, valueType, consumeInput, triggerWhenPaused, description, triggers, modifiers, note.

input.add_action_trigger (risco 2, altera, smoke)

Adds a trigger class to the Input Action asset itself.

Argumento	Tipo	Descrição
action	string	obrigatório. Input Action asset (path or bare name).
className	string	obrigatório. Class: short ("Negate", "Hold"), full ("InputModifierNegate") or display name.
properties	array of UeaKeyValue	Properties to set on the new object, e.g. HoldTimeThreshold=0.5.

Retorna: asset, valueType, consumeInput, triggerWhenPaused, description, triggers, modifiers, note.

input.add_axis_mapping (risco 4, altera)

Adds a classic Axis Mapping (Name + Key + Scale) to Project Settings > Input and saves DefaultInput.ini.

Argumento	Tipo	Descrição
name	string	obrigatório. Axis mapping name, e.g. "MoveForward".
key	string	obrigatório. FKey name, e.g. "W" or "Gamepad_LeftY".
scale	number	Axis scale (use -1 for the opposite direction). Default 1. Padrão 1.0.

Retorna: actionMappings, axisMappings, message.

input.add_chord_action (risco 2, altera, smoke)

Adds a Chorded Action trigger (only fires while ChordAction is triggering, e.g. Shift+key).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
chordAction	string	obrigatório. Input Action that must be triggering for this one to fire (path or bare name).

Retorna: target, behaviour, behaviours, note.

input.add_combo (risco 2, altera, UE 5.1+, smoke)

Adds a Combo trigger with ordered steps and optional cancel actions (deprecated by Epic in 5.8 but still functional).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
steps	array of UeaInputComboStep	obrigatório. Ordered combo steps.
cancelActions	array of string	Input Actions that cancel the combo (paths or bare names).

Retorna: target, behaviour, behaviours, note.

input.add_console_key (risco 4, altera)

Adds a console key and saves the config.

Argumento	Tipo	Descrição
key	string	obrigatório. FKey name, e.g. "Tilde".

Retorna: keys, message.

input.add_context_to_blueprint_begin_play (risco 2, altera)

Inserts BeginPlay -> (GetController -> Cast to PlayerController) -> GetSubsystem(EnhancedInputLocalPlayerSubsystem) -> AddMappingContext(Context, Priority) into a PlayerController/Pawn Blueprint and compiles it.

Argumento	Tipo	Descrição
blueprint	string	obrigatório. PlayerController or Pawn/Character Blueprint (path or bare name).
context	string	obrigatório.
priority	integer	Padrão 0.
variableName	string	When set, the context is read from this InputMappingContext variable (created with the context as default when missing). Empty = literal asset reference on the node.
compile	boolean	Compile the Blueprint afterwards. Default true. Padrão true.

Retorna: blueprint, nodes, alreadyWired, compiled, compileStatus, message.

input.add_dead_zone (risco 2, altera, smoke)

Adds a Dead Zone modifier (lower/upper thresholds, Axial or Radial).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
lowerThreshold	number	Padrão 0.2.
upperThreshold	number	Padrão 1.0.
type	string	"Axial" or "Radial" (default). Newer engines also accept "UnscaledRadial". Padrão TEXT("Radial").

Retorna: target, behaviour, behaviours, note.

input.add_default_mapping_context (risco 4, altera, UE 5.2+)

Adds or updates a context in the automatic default list with priority / add-immediately / register-with-user-settings flags.

Argumento	Tipo	Descrição
context	string	obrigatório.
priority	integer	Padrão 0.
addImmediately	boolean	Padrão true.
registerWithUserSettings	boolean	5.3+: also register the context with Enhanced Input User Settings. Padrão false.
worldSubsystem	boolean	Padrão false.

Retorna: list, entries, message.

input.add_down (risco 2, altera, smoke)

Adds a Down trigger (fires every frame while actuated).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
actuationThreshold	number	Magnitude at which the trigger considers the input actuated. Default 0.5. Padrão 0.5.

Retorna: target, behaviour, behaviours, note.

input.add_enhanced_action_event (risco 2, altera)

Adds an Enhanced Input Action event node (Triggered/Started/Ongoing/Canceled/Completed pins + ActionValue) for an Input Action.

Argumento	Tipo	Descrição
blueprint	string	obrigatório.
action	string	obrigatório.
graph	string	Event graph name. Empty = the main EventGraph.
x	integer	Padrão 0.
y	integer	Padrão 0.

Retorna: blueprint, node, existing, message.

input.add_fov_scaling (risco 2, altera, smoke)

Adds an FOV Scaling modifier (scales look input by the camera FOV).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
fOVScale	number	Padrão 1.0.
scalingType	string	"Standard" (default) or "UE4_BackCompat". Padrão TEXT("Standard").

Retorna: target, behaviour, behaviours, note.

input.add_hold (risco 2, altera, smoke)

Adds a Hold trigger (fires after HoldTimeThreshold seconds; bIsOneShot to fire once).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
holdTimeThreshold	number	Seconds the input must stay actuated. Default 1 (Hold) / 0.5 (HoldAndRelease). Negative = class default. Padrão -1.0.
isOneShot	boolean	Hold only: fire once instead of every frame after the threshold. Padrão false.
affectedByTimeDilation	boolean	Padrão false.
actuationThreshold	number	Padrão 0.5.

Retorna: target, behaviour, behaviours, note.

input.add_hold_and_release (risco 2, altera, smoke)

Adds a Hold And Release trigger (fires on release after HoldTimeThreshold seconds).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
holdTimeThreshold	number	Seconds the input must stay actuated. Default 1 (Hold) / 0.5 (HoldAndRelease). Negative = class default. Padrão -1.0.
isOneShot	boolean	Hold only: fire once instead of every frame after the threshold. Padrão false.
affectedByTimeDilation	boolean	Padrão false.
actuationThreshold	number	Padrão 0.5.

Retorna: target, behaviour, behaviours, note.

input.add_key_event (risco 2, altera)

Adds a Key event node (Pressed/Released, with modifier requirements) or, for an axis key, an axis-key event node.

Argumento	Tipo	Descrição
blueprint	string	obrigatório.
key	string	obrigatório. FKey name (a digital key for key events, an axis key for axis-key events).
graph	string
x	integer	Padrão 0.
y	integer	Padrão 0.
consumeInput	boolean	Padrão true.
executeWhenPaused	boolean	Padrão false.
overrideParentBinding	boolean	Padrão true.
control	boolean	Modifier requirements (key events only). Padrão false.
alt	boolean	Padrão false.
shift	boolean	Padrão false.
command	boolean	Padrão false.

Retorna: blueprint, node, existing, message.

input.add_legacy_action_event (risco 2, altera)

Adds a classic InputAction event node (Pressed/Released) for a Project Settings action mapping name.

Argumento	Tipo	Descrição
blueprint	string	obrigatório.
name	string	obrigatório. Classic action or axis mapping name from Project Settings.
graph	string
x	integer	Padrão 0.
y	integer	Padrão 0.
consumeInput	boolean	Padrão true.
executeWhenPaused	boolean	Padrão false.
overrideParentBinding	boolean	Padrão true.

Retorna: blueprint, node, existing, message.

input.add_legacy_axis_event (risco 2, altera)

Adds a classic InputAxis event node (Axis Value) for a Project Settings axis mapping name.

Argumento	Tipo	Descrição
blueprint	string	obrigatório.
name	string	obrigatório. Classic action or axis mapping name from Project Settings.
graph	string
x	integer	Padrão 0.
y	integer	Padrão 0.
consumeInput	boolean	Padrão true.
executeWhenPaused	boolean	Padrão false.
overrideParentBinding	boolean	Padrão true.

Retorna: blueprint, node, existing, message.

input.add_mapping (risco 2, altera, smoke)

Maps a key to an action inside a context, optionally adding modifier/trigger classes to the new mapping. Returns the whole context.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).
action	string	obrigatório. Input Action asset (path or bare name).
key	string	obrigatório. FKey name, e.g. "W", "SpaceBar", "LeftMouseButton", "Mouse2D", "Gamepad_LeftX". See input.list_keys.
modifiers	array of string	Modifier class names to add to the new mapping, e.g. ["Negate", "Swizzle"].
triggers	array of string	Trigger class names to add to the new mapping, e.g. ["Hold", "Pressed"].

Retorna: asset, description, mappings, note.

input.add_modifier (risco 2, altera, smoke)

Adds a modifier (Negate, Swizzle, Scalar, DeadZone, Smooth, ...) to the mapping of Action+Key, with optional Properties.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).
action	string	obrigatório. Input Action of the mapping.
key	string	obrigatório. FKey name of the mapping.
className	string	obrigatório. Class: short ("Negate", "Swizzle", "Scalar", "DeadZone", "Smooth", "Hold", "Pressed", "Released", "Tap", "Pulse", "Down") or full ("InputModifierNegate"). See input.list_modifier_types / list_trigger_types.
properties	array of UeaKeyValue	Properties to set on the new object, e.g. Order=YXZ, Scalar=(X=2,Y=1,Z=1), HoldTimeThreshold=0.5, LowerThreshold=0.25.

Retorna: asset, description, mappings, note.

input.add_negate (risco 2, altera, smoke)

Adds a Negate modifier (invert X/Y/Z).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
x	boolean	Padrão true.
y	boolean	Padrão true.
z	boolean	Padrão true.

Retorna: target, behaviour, behaviours, note.

input.add_pressed (risco 2, altera, smoke)

Adds a Pressed trigger (fires once when actuated).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
actuationThreshold	number	Magnitude at which the trigger considers the input actuated. Default 0.5. Padrão 0.5.

Retorna: target, behaviour, behaviours, note.

input.add_pulse (risco 2, altera, smoke)

Adds a Pulse trigger (fires every Interval seconds while held).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
triggerOnStart	boolean	Padrão true.
interval	number	Seconds between pulses. Default 1. Padrão 1.0.
triggerLimit	integer	0 = unlimited. Padrão 0.
affectedByTimeDilation	boolean	Padrão false.

Retorna: target, behaviour, behaviours, note.

input.add_released (risco 2, altera, smoke)

Adds a Released trigger (fires once when actuation stops).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
actuationThreshold	number	Magnitude at which the trigger considers the input actuated. Default 0.5. Padrão 0.5.

Retorna: target, behaviour, behaviours, note.

input.add_repeated_tap (risco 2, altera, UE 5.6+, smoke)

Adds a Repeated Tap trigger (double/triple tap).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
numberOfTaps	integer	Number of taps that trigger. Default 2. Padrão 2.
tapReleaseTimeThreshold	number	Padrão 0.2.

Retorna: target, behaviour, behaviours, note.

input.add_response_curve_exponential (risco 2, altera, smoke)

Adds a Response Curve - Exponential modifier.

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
exponent	{x,y,z}	Per-axis exponent. Default (1,1,1). Padrão FUeaVec3(1.0, 1.0, 1.0).

Retorna: target, behaviour, behaviours, note.

input.add_response_curve_user (risco 2, altera, smoke)

Adds a Response Curve - User Defined modifier with CurveFloat assets per axis.

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
curveX	string	CurveFloat asset for X (path or bare name). Empty leaves it unset.
curveY	string
curveZ	string

Retorna: target, behaviour, behaviours, note.

input.add_scalar (risco 2, altera, smoke)

Adds a Scalar modifier (per-axis multiplier).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
scalar	{x,y,z}	Per-axis multiplier. Default (1,1,1). Padrão FUeaVec3(1.0, 1.0, 1.0).

Retorna: target, behaviour, behaviours, note.

input.add_scale_by_delta_time (risco 2, altera, UE 5.1+, smoke)

Adds a Scale By Delta Time modifier (frame-rate independent axis values).

Argumento	Tipo	Descrição
context	string	Input Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset.
action	string	obrigatório. Input Action (path or bare name).
key	string	FKey name of the mapping. Empty = action-level behaviour.

Retorna: target, behaviour, behaviours, note.

input.add_smooth (risco 2, altera, smoke)

Adds a Smooth modifier (averages input across frames).

Argumento	Tipo	Descrição
context	string	Input Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset.
action	string	obrigatório. Input Action (path or bare name).
key	string	FKey name of the mapping. Empty = action-level behaviour.

Retorna: target, behaviour, behaviours, note.

input.add_smooth_delta (risco 2, altera, UE 5.4+, smoke)

Adds a Smooth Delta modifier (interpolates towards the new value with Speed / EasingExponent).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
smoothingMethod	string	Smoothing method enum name (e.g. Linear, Interp, InterpConstant, InterpCircularIn, ...). Empty keeps the class default.
speed	number	Padrão 0.5.
easingExponent	number	Padrão 2.0.

Retorna: target, behaviour, behaviours, note.

input.add_swizzle (risco 2, altera, smoke)

Adds a Swizzle Input Axis Values modifier (default YXZ: routes a 1D key to the Y axis of a 2D action).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
order	string	Axis order: YXZ (default, swaps X/Y), ZYX, XZY, YZX, ZXY. Padrão TEXT("YXZ").

Retorna: target, behaviour, behaviours, note.

input.add_tap (risco 2, altera, smoke)

Adds a Tap trigger (press and release within TapReleaseTimeThreshold).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string
tapReleaseTimeThreshold	number	Release must happen within this many seconds. Default 0.2. Padrão 0.2.
actuationThreshold	number	Padrão 0.5.

Retorna: target, behaviour, behaviours, note.

input.add_to_world_space (risco 2, altera, smoke)

Adds a To World Space modifier (X forward / Y right / Z up axis convention).

Argumento	Tipo	Descrição
context	string	Input Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset.
action	string	obrigatório. Input Action (path or bare name).
key	string	FKey name of the mapping. Empty = action-level behaviour.

Retorna: target, behaviour, behaviours, note.

input.add_trigger (risco 2, altera, smoke)

Adds a trigger (Pressed, Released, Hold, Tap, Pulse, Down, ...) to the mapping of Action+Key, with optional Properties.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).
action	string	obrigatório. Input Action of the mapping.
key	string	obrigatório. FKey name of the mapping.
className	string	obrigatório. Class: short ("Negate", "Swizzle", "Scalar", "DeadZone", "Smooth", "Hold", "Pressed", "Released", "Tap", "Pulse", "Down") or full ("InputModifierNegate"). See input.list_modifier_types / list_trigger_types.
properties	array of UeaKeyValue	Properties to set on the new object, e.g. Order=YXZ, Scalar=(X=2,Y=1,Z=1), HoldTimeThreshold=0.5, LowerThreshold=0.25.

Retorna: asset, description, mappings, note.

input.asset_exists (risco 0, smoke)

Whether an input asset exists for a path or bare name, and which kind it is (action/context/mappable_config).

Argumento	Tipo	Descrição
asset	string	obrigatório. Object path (/Game/Input/IA_Jump.IA_Jump), package path or unique bare name of the asset.

Retorna: exists, kind, asset.

input.build_context_from_spec (risco 2, altera, smoke)

Builds (or fills) a mapping context from a declarative list of {action, key, modifiers[], triggers[]}, creating missing actions.

Argumento	Tipo	Descrição
context	string	Existing Mapping Context to fill (path or bare name). Empty = create Name in Folder.
name	string	Name of the context to create when Context is empty, e.g. "IMC_Default".
folder	string	Folder for the new context and for actions created on the fly. Default "/Game/Input".
description	string
clearExisting	boolean	Remove existing mappings before applying the spec. Padrão false.
createMissingActions	boolean	Create Input Actions referenced by name that do not exist yet. Default true. Padrão true.
skipDuplicates	boolean	Skip (instead of failing on) mappings that already exist. Default true. Padrão true.
mappings	array of UeaInputSpecMapping	obrigatório.

Retorna: context, createdActions, mappingsAdded, mappingsSkipped, note.

input.clear_mappings (risco 5, altera, destrutivo, smoke)

Removes every mapping from a context.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).

Retorna: asset, description, mappings, note.

input.create_action (risco 2, altera, smoke)

Creates an Input Action asset (value type bool/axis1d/axis2d/axis3d) in a folder and returns its state.

Argumento	Tipo	Descrição
name	string	obrigatório. Asset name, e.g. "IA_Jump". No spaces or slashes.
folder	string	Destination content folder. Default "/Game/Input".
valueType	string	"bool" (digital), "axis1d" (float), "axis2d" (Vector2D) or "axis3d" (Vector). Default "bool". Padrão TEXT("bool").
consumeInput	boolean	Whether the action swallows the input so lower-priority mappings do not see it. Default true. Padrão true.
description	string	Localised description (stored on 5.1+, ignored on older engines).

Retorna: asset, valueType, consumeInput, triggerWhenPaused, description, triggers, modifiers, note.

input.create_mappable_input_config (risco 2, altera, UE 5.1+, smoke)

Creates a PlayerMappableInputConfig asset (5.1-5.2 user-settings model; deprecated by Epic from 5.3 in favour of EnhancedInputUserSettings).

Argumento	Tipo	Descrição
name	string	obrigatório.
folder	string	Default "/Game/Input".
configName	string	ConfigName (FName) shown to players. Default = asset name.
displayName	string

Retorna: asset, configName, displayName, contexts, note.

input.create_mapping_context (risco 2, altera, smoke)

Creates an empty Input Mapping Context asset in a folder.

Argumento	Tipo	Descrição
name	string	obrigatório. Asset name, e.g. "IMC_Default".
folder	string	Destination content folder. Default "/Game/Input".
description	string	Localised description of the context.

Retorna: asset, description, mappings, note.

input.create_standard_set (risco 2, altera, smoke)

Creates IA_Move/IA_Look/IA_Jump/IA_Sprint/IA_Interact (+ optional Crouch/Fire) and IMC_Default with WASD, mouse, Space, Shift, E and gamepad equivalents.

Argumento	Tipo	Descrição
folder	string	Destination folder. Default "/Game/Input".
actionPrefix	string	Prefix for action assets. Default "IA_". Padrão TEXT("IA_").
contextName	string	Mapping context name. Default "IMC_Default". Padrão TEXT("IMC_Default").
includeGamepad	boolean	Also map gamepad sticks/buttons. Default true. Padrão true.
includeCrouch	boolean	Add a Crouch action (Ctrl / gamepad right thumbstick button). Default false. Padrão false.
includeFire	boolean	Add a Fire action (left mouse / right trigger). Default false. Padrão false.
reuseExisting	boolean	Reuse existing assets with the same names instead of failing. Default true. Padrão true.

Retorna: actions, context, message.

input.delete_asset (risco 3, altera, destrutivo, smoke)

Deletes an Input Action or Mapping Context asset. Fails when other assets still reference it.

Argumento	Tipo	Descrição
asset	string	obrigatório. Object path (/Game/Input/IA_Jump.IA_Jump), package path or unique bare name of the asset.

Retorna: asset, message.

input.duplicate_asset (risco 2, altera, smoke)

Copies an Input Action or Mapping Context asset to NewName (optionally another folder). Returns the copy.

Argumento	Tipo	Descrição
asset	string	obrigatório. Input Action or Mapping Context asset to copy (path or bare name).
newName	string	obrigatório. Name of the copy, e.g. "IA_Jump_Alt".
folder	string	Destination folder. Empty = same folder as the source.

Retorna: asset, message.

input.edit_context (risco 2, altera, smoke)

Adds and removes several mappings of a context in one call (add: {action,key,modifiers[],triggers[]}, remove: {action,key}).

Argumento	Tipo	Descrição
context	string	obrigatório.
add	array of UeaInputSpecMapping	Mappings to add ({action, key, modifiers[], triggers[]}); existing action+key pairs are skipped.
remove	array of UeaInputMappingArgs	Mappings to remove, as {action, key}.
createMissingActions	boolean	Create Input Actions referenced by name in Add that do not exist yet (in the context's folder). Default false. Padrão false.

Retorna: context, createdActions, mappingsAdded, mappingsSkipped, note.

input.find_key (risco 0, smoke)

Resolves a key by name or display name and returns all its flags (gamepad, touch, gesture, axis, paired axis, deprecated...).

Argumento	Tipo	Descrição
name	string	obrigatório. FKey name or display name (case-insensitive), e.g. "Space Bar", "Gamepad Face Button Bottom".

Retorna: key, modifierKey, touch, gesture, digital, analog, buttonAxis, bindableInBlueprints, bindableToActions, deprecated, pairedAxis, pairedAxisKey, suggestions.

input.find_mappings (risco 0, smoke)

Searches every mapping context under a folder for mappings of an action and/or a key.

Argumento	Tipo	Descrição
action	string	Input Action to look for (path or bare name). Empty = any action.
key	string	FKey name to look for. Empty = any key.
folder	string	Folder whose mapping contexts are searched (recursive). Default "/Game".

Retorna: matches, contextsSearched.

input.get_action (risco 0, smoke)

Value type, consume/pause flags, description and action-level triggers/modifiers of an Input Action.

Argumento	Tipo	Descrição
asset	string	obrigatório. Object path (/Game/Input/IA_Jump.IA_Jump), package path or unique bare name of the asset.

Retorna: asset, valueType, consumeInput, triggerWhenPaused, description, triggers, modifiers, note.

input.get_context (risco 0, smoke)

All key mappings of a mapping context with their action, key, modifiers and triggers.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).

Retorna: asset, description, mappings, note.

input.get_enhanced_developer_settings (risco 0, UE 5.1+, smoke)

Reads UEnhancedInputDeveloperSettings (default mapping contexts, user settings class, world subsystem, input modes...).

Argumento	Tipo	Descrição
filter	string	Substring filter on property names (case-insensitive). Empty = all.

Retorna: class, configFile, properties, message.

input.get_enhanced_editor_settings (risco 0, UE 5.1+, smoke)

Reads UEnhancedInputEditorSettings (log all input, auto-consume, visible event pins) and the editor project settings when present.

Argumento	Tipo	Descrição
filter	string	Substring filter on property names (case-insensitive). Empty = all.

Retorna: class, configFile, properties, message.

input.get_input_settings (risco 0, smoke)

Reads every editable/config property of UInputSettings (DefaultPlayerInputClass, bEnableMouseSmoothing, ConsoleKeys, ...).

Argumento	Tipo	Descrição
filter	string	Substring filter on property names (case-insensitive). Empty = all.

Retorna: class, configFile, properties, message.

input.get_legacy_mapping (risco 0, smoke)

Returns the classic action and axis mappings with a given name (empty Name returns all of them).

Argumento	Tipo	Descrição
name	string	Action or axis mapping name. Empty returns every classic mapping.

Retorna: actionMappings, axisMappings, message.

input.get_mappable_input_config (risco 0, UE 5.1+, smoke)

Reads a PlayerMappableInputConfig: name, display name and contexts with priorities.

Argumento	Tipo	Descrição
config	string	obrigatório.

Retorna: asset, configName, displayName, contexts, note.

input.get_type_info (risco 0, smoke)

Editable properties (type, default, tooltip, enum values) of one modifier or trigger class.

Argumento	Tipo	Descrição
className	string	obrigatório. Modifier or trigger class: short ("Hold"), full ("InputTriggerHold") or display name.

Retorna: class, displayName, kind, parent, tooltip, triggerType, properties.

input.list_actions (risco 0, smoke)

Lists Input Action assets under a folder, optionally filtered by name substring.

Argumento	Tipo	Descrição
folder	string	Root folder to search. Default "/Game".
name	string	Substring of the asset name (case-insensitive).
recursive	boolean	Padrão true.
limit	integer	Padrão 200.

Retorna: assets, total.

input.list_axis_config (risco 0, smoke)

Lists the per-axis config (dead zone, sensitivity, exponent, invert) of Project Settings > Input.

Sem argumentos.

Retorna: entries, message.

input.list_blueprint_input_events (risco 0)

Lists the Enhanced Input Action, classic InputAction/InputAxis and Key event nodes in a Blueprint's event graphs, plus AddMappingContext calls.

Argumento	Tipo	Descrição
blueprint	string	obrigatório.

Retorna: blueprint, events, mappingContextCalls.

input.list_console_keys (risco 0, smoke)

Lists the keys that open the in-game console.

Sem argumentos.

Retorna: keys, message.

input.list_contexts (risco 0, smoke)

Lists Input Mapping Context assets under a folder, optionally filtered by name substring.

Argumento	Tipo	Descrição
folder	string	Root folder to search. Default "/Game".
name	string	Substring of the asset name (case-insensitive).
recursive	boolean	Padrão true.
limit	integer	Padrão 200.

Retorna: assets, total.

input.list_default_mapping_contexts (risco 0, UE 5.2+, smoke)

Lists the mapping contexts applied to every player (or the world subsystem) automatically by Enhanced Input.

Argumento	Tipo	Descrição
worldSubsystem	boolean	Read the world-subsystem list instead of the player list. Padrão false.

Retorna: list, entries, message.

input.list_key_categories (risco 0, smoke)

Lists the key menu categories (Keyboard, Mouse, Gamepad, Touch, Gesture, ...) with key counts.

Sem argumentos.

Retorna: categories.

input.list_keys (risco 0, smoke)

Lists engine FKey names (keyboard, mouse, gamepad, touch) with category and axis type; Filter is a substring.

Argumento	Tipo	Descrição
filter	string	Substring filter on the key name or display name (case-insensitive), e.g. "Gamepad", "Mouse".
limit	integer	Padrão 300.

Retorna: keys, total.

input.list_legacy_mappings (risco 0, smoke)

Lists the classic Action and Axis mappings of Project Settings > Input.

Sem argumentos.

Retorna: actionMappings, axisMappings, message.

input.list_mappable_names (risco 0, UE 5.3+, smoke)

Lists every player-mappable name declared on actions and mapping overrides under a folder.

Argumento	Tipo	Descrição
folder	string	Folder searched for Input Actions and Mapping Contexts. Default "/Game".

Retorna: names.

input.list_modifier_types (risco 0, smoke)

Lists the available Input Modifier classes and their editable properties.

Sem argumentos.

Retorna: types.

input.list_trigger_types (risco 0, smoke)

Lists the available Input Trigger classes and their editable properties.

Sem argumentos.

Retorna: types.

input.mapping_exists (risco 0, smoke)

Whether a context maps Key to Action; returns the mapping with its index when present.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).
action	string	obrigatório. Input Action asset (path or bare name).
key	string	obrigatório. FKey name of the mapping.

Retorna: exists, index, mapping.

input.migrate_legacy_to_enhanced (risco 4, altera)

Converts classic Action/Axis mappings from Project Settings into Input Actions and one mapping context (axis scale -1 becomes Negate, other scales Scalar).

Argumento	Tipo	Descrição
folder	string	Destination folder. Default "/Game/Input".
actionPrefix	string	Padrão TEXT("IA_").
contextName	string	Padrão TEXT("IMC_Legacy").
includeActionMappings	boolean	Padrão true.
includeAxisMappings	boolean	Padrão true.
removeLegacy	boolean	Remove the classic mappings from Project Settings once converted. Default false. Padrão false.
reuseExisting	boolean	Reuse existing assets with the same names instead of failing. Default true. Padrão true.

Retorna: actions, context, actionMappingsConverted, axisMappingsConverted, skipped, message.

input.pie_add_context (risco 0, requer PIE, smoke)

Adds a mapping context to the PIE player at runtime (not persisted).

Argumento	Tipo	Descrição
context	string	obrigatório.
priority	integer	Padrão 0.
playerIndex	integer	Padrão 0.

Retorna: contexts, message.

input.pie_clear_contexts (risco 0, requer PIE, smoke)

Removes every mapping context from the PIE player.

Argumento	Tipo	Descrição
playerIndex	integer	Local player index in the PIE session. Default 0. Padrão 0.

Retorna: contexts, message.

input.pie_get_action_value (risco 0, requer PIE, smoke)

Current value, trigger state and mapped keys of an Input Action on the PIE player.

Argumento	Tipo	Descrição
action	string	obrigatório.
playerIndex	integer	Padrão 0.

Retorna: action, valueType, value, magnitude, triggerEvent, elapsedSeconds, triggeredSeconds, mappedKeys.

input.pie_get_user_settings (risco 0, UE 5.3+, requer PIE, smoke)

Enhanced Input user settings of the PIE player: active key profile, profiles and registered contexts.

Argumento	Tipo	Descrição
playerIndex	integer	Local player index in the PIE session. Default 0. Padrão 0.

Retorna: settingsClass, activeProfileId, profiles, registeredContexts, message.

input.pie_inject_action (risco 0, requer PIE, smoke)

Injects a value for an Input Action into the running PIE player for one frame (bool/axis1d/2d/3d from Value).

Argumento	Tipo	Descrição
action	string	obrigatório.
value	{x,y,z}	Value: X for bool (non-zero = true) and axis1d; X,Y for axis2d; X,Y,Z for axis3d. Padrão FUeaVec3(1.0, 0.0, 0.0).
modifiers	array of string	Modifier class names applied to the injected value (optional).
triggers	array of string	Trigger class names evaluated for the injected value (optional).
playerIndex	integer	Padrão 0.

Retorna: target, message.

input.pie_inject_axis (risco 0, requer PIE, smoke)

Sends an axis delta (MouseX, Gamepad_LeftY, ...) to the PIE player controller for one frame.

Argumento	Tipo	Descrição
key	string	obrigatório. Axis FKey name, e.g. "MouseX", "Gamepad_LeftY".
delta	number	obrigatório.
deltaTime	number	Seconds the delta covers. Default 1/60. Padrão 1.0 / 60.0.
numSamples	integer	Padrão 1.
playerIndex	integer	Padrão 0.

Retorna: target, message.

input.pie_inject_key (risco 0, requer PIE, smoke)

Sends a raw key event (pressed/released/repeat/doubleclick/tap) to the PIE player controller, as if the key was hit.

Argumento	Tipo	Descrição
key	string	obrigatório. FKey name, e.g. "SpaceBar", "Gamepad_FaceButton_Bottom".
event	string	"pressed" (default), "released", "repeat", "doubleclick" or "tap" (press then release). Padrão TEXT("pressed").
amount	number	Amount depressed for analog buttons. Default 1. Padrão 1.0.
playerIndex	integer	Padrão 0.

Retorna: target, message.

input.pie_list_applied_contexts (risco 0, requer PIE, smoke)

Lists the mapping contexts currently applied to the PIE player with their priorities.

Argumento	Tipo	Descrição
playerIndex	integer	Local player index in the PIE session. Default 0. Padrão 0.

Retorna: contexts, message.

input.pie_list_bound_actions (risco 0, requer PIE, smoke)

Enhanced Input action bindings (action + trigger event) on the PIE player controller's and pawn's input components.

Argumento	Tipo	Descrição
playerIndex	integer	Local player index in the PIE session. Default 0. Padrão 0.

Retorna: bindings, message.

input.pie_list_legacy_bindings (risco 0, requer PIE, smoke)

Classic action/axis/key bindings on the PIE player controller's and pawn's input components.

Argumento	Tipo	Descrição
playerIndex	integer	Local player index in the PIE session. Default 0. Padrão 0.

Retorna: bindings, message.

input.pie_list_player_key_mappings (risco 0, UE 5.3+, requer PIE, smoke)

Player-mappable key rows of a key profile (mapping name, slot, default and current key).

Argumento	Tipo	Descrição
profileId	string	Key profile id. Empty = active profile.
filter	string	Filter on mapping name (substring).
playerIndex	integer	Padrão 0.

Retorna: profileId, mappings, failureReason, message.

input.pie_map_player_key (risco 0, UE 5.3+, requer PIE)

Rebinds a player-mappable row to NewKey in a slot (the "key rebinding" UI operation).

Argumento	Tipo	Descrição
mappingName	string	obrigatório. Mapping name from Player Mappable Key Settings (see input.list_mappable_names / pie_list_player_key_mappings).
newKey	string	FKey name to assign (ignored by unmap/reset).
slot	string	Slot: First (default), Second, Third, ... Seventh. Padrão TEXT("First").
profileId	string	Key profile id. Empty = active profile.
playerIndex	integer	Padrão 0.

Retorna: profileId, mappings, failureReason, message.

input.pie_query_keys_for_action (risco 0, requer PIE, smoke)

Keys mapped to an action in the PIE player's active context set.

Argumento	Tipo	Descrição
action	string	obrigatório.
playerIndex	integer	Padrão 0.

Retorna: action, keys.

input.pie_register_context_with_user_settings (risco 0, UE 5.3+, requer PIE, smoke)

Registers (or unregisters) a mapping context with the user settings so its mappable rows appear.

Argumento	Tipo	Descrição
context	string	obrigatório.
unregister	boolean	Unregister instead. Padrão false.
playerIndex	integer	Padrão 0.

Retorna: settingsClass, activeProfileId, profiles, registeredContexts, message.

input.pie_remove_context (risco 0, requer PIE, smoke)

Removes a mapping context from the PIE player at runtime.

Argumento	Tipo	Descrição
context	string	obrigatório.
priority	integer	Padrão 0.
playerIndex	integer	Padrão 0.

Retorna: contexts, message.

input.pie_reset_player_key_row (risco 0, UE 5.3+, requer PIE)

Resets every slot of a player-mappable row to its default keys.

Argumento	Tipo	Descrição
mappingName	string	obrigatório. Mapping name from Player Mappable Key Settings (see input.list_mappable_names / pie_list_player_key_mappings).
newKey	string	FKey name to assign (ignored by unmap/reset).
slot	string	Slot: First (default), Second, Third, ... Seventh. Padrão TEXT("First").
profileId	string	Key profile id. Empty = active profile.
playerIndex	integer	Padrão 0.

Retorna: profileId, mappings, failureReason, message.

input.pie_save_user_settings (risco 0, UE 5.3+, requer PIE, smoke)

Applies and saves the Enhanced Input user settings (SaveGame slot).

Argumento	Tipo	Descrição
apply	boolean	Apply the settings to the live player input before saving. Default true. Padrão true.
playerIndex	integer	Padrão 0.

Retorna: settingsClass, activeProfileId, profiles, registeredContexts, message.

input.pie_set_key_profile (risco 0, UE 5.3+, requer PIE)

Switches the active key profile of the PIE player.

Argumento	Tipo	Descrição
profileId	string	obrigatório.
playerIndex	integer	Padrão 0.

Retorna: settingsClass, activeProfileId, profiles, registeredContexts, message.

input.pie_status (risco 0, smoke)

Whether PIE is running and what input classes/subsystems the local player has.

Argumento	Tipo	Descrição
playerIndex	integer	Local player index in the PIE session. Default 0. Padrão 0.

Retorna: pieRunning, world, playerController, pawn, playerInputClass, playerControllerInputComponentClass, pawnInputComponentClass, enhancedSubsystem, userSettings, appliedContexts, message.

input.pie_unmap_player_key (risco 0, UE 5.3+, requer PIE)

Clears the key of a player-mappable row/slot.

Argumento	Tipo	Descrição
mappingName	string	obrigatório. Mapping name from Player Mappable Key Settings (see input.list_mappable_names / pie_list_player_key_mappings).
newKey	string	FKey name to assign (ignored by unmap/reset).
slot	string	Slot: First (default), Second, Third, ... Seventh. Padrão TEXT("First").
profileId	string	Key profile id. Empty = active profile.
playerIndex	integer	Padrão 0.

Retorna: profileId, mappings, failureReason, message.

input.press_editor_key (risco 0)

Presses and releases a key (with Ctrl/Shift/Alt/Cmd prefixes) on the focused editor widget, or types Text as characters.

Argumento	Tipo	Descrição
key	string	Key with optional modifier prefixes, e.g. "Ctrl+S", "Shift+Alt+F", "Enter", "Escape". FKey names or display names.
text	string	Text to type as character events into the focused widget (used when Key is empty).

Retorna: key, handledDown, handledUp, charactersTyped, message.

input.remove_action_mapping (risco 4, altera)

Removes a classic Action Mapping matching Name + Key + modifier keys.

Argumento	Tipo	Descrição
name	string	obrigatório. Action mapping name, e.g. "Jump".
key	string	obrigatório. FKey name, e.g. "SpaceBar".
shift	boolean	Padrão false.
ctrl	boolean	Padrão false.
alt	boolean	Padrão false.
cmd	boolean	Padrão false.

Retorna: actionMappings, axisMappings, message.

input.remove_action_mappings (risco 2, altera, smoke)

Removes every mapping of one action from a context.

Argumento	Tipo	Descrição
context	string	obrigatório.
action	string	obrigatório.

Retorna: asset, description, mappings, note.

input.remove_action_modifier (risco 2, altera, smoke)

Removes the modifier at Index from the Input Action asset.

Argumento	Tipo	Descrição
action	string	obrigatório.
index	integer	obrigatório. Index in the action's Modifiers/Triggers array (see input.get_action).

Retorna: asset, valueType, consumeInput, triggerWhenPaused, description, triggers, modifiers, note.

input.remove_action_trigger (risco 2, altera, smoke)

Removes the trigger at Index from the Input Action asset.

Argumento	Tipo	Descrição
action	string	obrigatório.
index	integer	obrigatório. Index in the action's Modifiers/Triggers array (see input.get_action).

Retorna: asset, valueType, consumeInput, triggerWhenPaused, description, triggers, modifiers, note.

input.remove_all_legacy_mappings (risco 5, altera, destrutivo)

Removes every classic Action and/or Axis mapping from Project Settings and saves DefaultInput.ini.

Argumento	Tipo	Descrição
actionMappings	boolean	Padrão true.
axisMappings	boolean	Padrão true.

Retorna: actionMappings, axisMappings, message.

input.remove_axis_mapping (risco 4, altera)

Removes a classic Axis Mapping matching Name + Key + Scale.

Argumento	Tipo	Descrição
name	string	obrigatório. Axis mapping name, e.g. "MoveForward".
key	string	obrigatório. FKey name, e.g. "W" or "Gamepad_LeftY".
scale	number	Axis scale (use -1 for the opposite direction). Default 1. Padrão 1.0.

Retorna: actionMappings, axisMappings, message.

input.remove_console_key (risco 4, altera)

Removes a console key and saves the config.

Argumento	Tipo	Descrição
key	string	obrigatório. FKey name, e.g. "Tilde".

Retorna: keys, message.

input.remove_default_mapping_context (risco 4, altera, UE 5.2+)

Removes a context from the automatic default list.

Argumento	Tipo	Descrição
context	string	obrigatório.
worldSubsystem	boolean	Padrão false.

Retorna: list, entries, message.

input.remove_input_event (risco 3, altera, destrutivo)

Removes an input event node (by GUID) from a Blueprint.

Argumento	Tipo	Descrição
blueprint	string	obrigatório.
nodeGuid	string	obrigatório. Node GUID from input.list_blueprint_input_events.

Retorna: blueprint, removed, message.

input.remove_key_mappings (risco 2, altera, smoke)

Removes every mapping that uses a key from a context.

Argumento	Tipo	Descrição
context	string	obrigatório.
key	string	obrigatório. FKey name.

Retorna: asset, description, mappings, note.

input.remove_mapping (risco 2, altera, smoke)

Removes the mapping of one key to one action from a context.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).
action	string	obrigatório. Input Action asset (path or bare name).
key	string	obrigatório. FKey name of the mapping.

Retorna: asset, description, mappings, note.

input.remove_modifier (risco 2, altera, smoke)

Removes the modifier at Index from the mapping of Action+Key.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).
action	string	obrigatório. Input Action of the mapping.
key	string	obrigatório. FKey name of the mapping.
index	integer	obrigatório. Index in the mapping's Modifiers/Triggers array (see input.get_context).

Retorna: asset, description, mappings, note.

input.remove_trigger (risco 2, altera, smoke)

Removes the trigger at Index from the mapping of Action+Key.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).
action	string	obrigatório. Input Action of the mapping.
key	string	obrigatório. FKey name of the mapping.
index	integer	obrigatório. Index in the mapping's Modifiers/Triggers array (see input.get_context).

Retorna: asset, description, mappings, note.

input.rename_asset (risco 2, altera, smoke)

Renames (and optionally moves) an Input Action or Mapping Context asset; references are fixed up by the editor.

Argumento	Tipo	Descrição
asset	string	obrigatório. Input Action or Mapping Context asset (path or bare name).
newName	string	obrigatório. New asset name.
folder	string	Destination folder (moves the asset). Empty = keep the current folder.

Retorna: asset, message.

input.rename_legacy_mapping (risco 4, altera)

Renames every classic action or axis mapping called Name to NewName.

Argumento	Tipo	Descrição
kind	string	obrigatório. "action" or "axis".
name	string	obrigatório.
newName	string	obrigatório.

Retorna: actionMappings, axisMappings, message.

input.reorder_modifier (risco 2, altera, smoke)

Moves a modifier from Index to NewIndex (modifiers run in array order). Key empty = action-level.

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string	FKey name of the mapping. Empty = action-level behaviour.
index	integer	obrigatório.
newIndex	integer	obrigatório.

Retorna: target, behaviour, behaviours, note.

input.reorder_trigger (risco 2, altera, smoke)

Moves a trigger from Index to NewIndex. Key empty = action-level.

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string	FKey name of the mapping. Empty = action-level behaviour.
index	integer	obrigatório.
newIndex	integer	obrigatório.

Retorna: target, behaviour, behaviours, note.

input.set_action_mappable_settings (risco 2, altera, UE 5.3+, smoke)

Creates/updates (or clears) the Player Mappable Key Settings of an Input Action: mapping Name, DisplayName, DisplayCategory.

Argumento	Tipo	Descrição
action	string	obrigatório.
name	string	Unique mapping name used by user settings (e.g. "Jump").
displayName	string
displayCategory	string
clear	boolean	Remove the settings object from the action instead. Padrão false.

Retorna: target, hasSettings, behavior, name, displayName, displayCategory, note.

input.set_action_options (risco 2, altera, smoke)

Sets bReserveAllMappings, AccumulationBehavior (5.3+) or any other Input Action property.

Argumento	Tipo	Descrição
action	string	obrigatório.
reserveAllMappings	string	"true"/"false" for bReserveAllMappings (player mappable UIs reserve slots). Empty keeps.
accumulationBehavior	string	5.3+: "TakeHighestAbsoluteValue" or "Cumulative". Empty keeps; ignored below 5.3.
properties	array of UeaKeyValue	Any other UInputAction property as name=value.

Retorna: asset, valueType, consumeInput, triggerWhenPaused, description, triggers, modifiers, note.

input.set_action_properties (risco 2, altera, smoke)

Changes value type, consume-input, trigger-when-paused and description of an Input Action; returns the new state.

Argumento	Tipo	Descrição
action	string	obrigatório. Input Action asset (path or bare name).
valueType	string	New value type: "bool", "axis1d", "axis2d", "axis3d". Empty keeps the current one.
consumeInput	string	"true" / "false" to change bConsumeInput; empty keeps the current value.
triggerWhenPaused	string	"true" / "false" to change bTriggerWhenPaused; empty keeps the current value.
description	string	New description (5.1+; ignored below). Empty keeps the current one.

Retorna: asset, valueType, consumeInput, triggerWhenPaused, description, triggers, modifiers, note.

input.set_axis_config (risco 4, altera)

Sets dead zone / sensitivity / exponent / invert for one axis key (entry created when missing) and saves the config.

Argumento	Tipo	Descrição
key	string	obrigatório. Axis key name, e.g. "MouseX", "Gamepad_LeftX". Added when missing.
deadZone	string	Values as text; empty keeps the current one.
sensitivity	string
exponent	string
invert	string	"true" / "false".

Retorna: entries, message.

input.set_axis_mapping_scale (risco 4, altera)

Changes the scale of one classic axis mapping (Name + Key + current Scale -> NewScale).

Argumento	Tipo	Descrição
name	string	obrigatório.
key	string	obrigatório.
scale	number	Current scale of the mapping to change (a name+key pair may exist with several scales). Default 1. Padrão 1.0.
newScale	number	obrigatório.

Retorna: actionMappings, axisMappings, message.

input.set_context_description (risco 2, altera, smoke)

Sets the description (and optionally other properties) of a Mapping Context.

Argumento	Tipo	Descrição
context	string	obrigatório.
description	string
properties	array of UeaKeyValue	Any other UInputMappingContext property as name=value.

Retorna: asset, description, mappings, note.

input.set_default_input_classes (risco 4, altera)

Sets DefaultPlayerInputClass / DefaultInputComponentClass (e.g. EnhancedPlayerInput / EnhancedInputComponent) and saves the config.

Argumento	Tipo	Descrição
playerInputClass	string	PlayerInput subclass (e.g. "EnhancedPlayerInput", a Blueprint path or "/Script/EnhancedInput.EnhancedPlayerInput"). Empty keeps.
inputComponentClass	string	InputComponent subclass (e.g. "EnhancedInputComponent"). Empty keeps.

Retorna: class, configFile, properties, message.

input.set_enhanced_developer_settings (risco 4, altera, UE 5.1+)

Sets UEnhancedInputDeveloperSettings properties by name and writes DefaultInput.ini.

Argumento	Tipo	Descrição
properties	array of UeaKeyValue	obrigatório. Properties to set as name=value in engine text form (true/false, 0.5, enum name, class path, (X=1,Y=2)).

Retorna: class, configFile, properties, message.

input.set_enhanced_editor_settings (risco 4, altera, UE 5.1+)

Sets UEnhancedInputEditorSettings properties by name and saves them.

Argumento	Tipo	Descrição
properties	array of UeaKeyValue	obrigatório. Properties to set as name=value in engine text form (true/false, 0.5, enum name, class path, (X=1,Y=2)).

Retorna: class, configFile, properties, message.

input.set_input_settings (risco 4, altera)

Sets UInputSettings properties by name (engine text form) and writes DefaultInput.ini.

Argumento	Tipo	Descrição
properties	array of UeaKeyValue	obrigatório. Properties to set as name=value in engine text form (true/false, 0.5, enum name, class path, (X=1,Y=2)).

Retorna: class, configFile, properties, message.

input.set_mappable_input_config_context (risco 2, altera, UE 5.1+, smoke)

Adds, updates or removes a mapping context (with priority) in a PlayerMappableInputConfig.

Argumento	Tipo	Descrição
config	string	obrigatório. PlayerMappableInputConfig asset (path or bare name).
context	string	obrigatório.
priority	integer	Padrão 0.
remove	boolean	Remove the context instead of adding/updating it. Padrão false.

Retorna: asset, configName, displayName, contexts, note.

input.set_mapping_key (risco 2, altera, smoke)

Changes the key of an existing mapping (Action+Key -> NewKey) keeping its modifiers and triggers.

Argumento	Tipo	Descrição
context	string	obrigatório.
action	string	obrigatório.
key	string	obrigatório. Current FKey name of the mapping.
newKey	string	obrigatório. New FKey name. Modifiers and triggers are kept.

Retorna: asset, description, mappings, note.

input.set_mapping_mappable_settings (risco 2, altera, UE 5.3+, smoke)

Sets the mappable behaviour of one mapping: inherit from the action, override with its own Name/DisplayName/Category, or ignore.

Argumento	Tipo	Descrição
context	string	obrigatório.
action	string	obrigatório.
key	string	obrigatório.
behavior	string	"inherit" (from the action, default), "override" (own settings on this mapping) or "ignore" (not player mappable). Padrão TEXT("inherit").
name	string	Used with "override".
displayName	string
displayCategory	string

Retorna: target, hasSettings, behavior, name, displayName, displayCategory, note.

input.set_modifier_properties (risco 2, altera, smoke)

Sets properties on the modifier at Index of a mapping (Context+Action+Key) or of the action (Key empty).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string	FKey name of the mapping. Empty = action-level behaviour.
index	integer	obrigatório. Index in the Modifiers/Triggers array.
properties	array of UeaKeyValue	obrigatório. Properties to set, name=value (engine text form).

Retorna: target, behaviour, behaviours, note.

input.set_trigger_properties (risco 2, altera, smoke)

Sets properties on the trigger at Index of a mapping (Context+Action+Key) or of the action (Key empty).

Argumento	Tipo	Descrição
context	string
action	string	obrigatório.
key	string	FKey name of the mapping. Empty = action-level behaviour.
index	integer	obrigatório. Index in the Modifiers/Triggers array.
properties	array of UeaKeyValue	obrigatório. Properties to set, name=value (engine text form).

Retorna: target, behaviour, behaviours, note.

input.set_viewport_input_settings (risco 4, altera)

Sets mouse capture/lock modes, mouse smoothing, FOV scaling, double-click time, touch interface and fullscreen toggles.

Argumento	Tipo	Descrição
captureMouseOnLaunch	string	All values are text tri-states: empty keeps the current value.
mouseCaptureMode	string	NoCapture, CapturePermanently, CapturePermanently_IncludingInitialMouseDown, CaptureDuringMouseDown, CaptureDuringRightMouseDown.
mouseLockMode	string	DoNotLock, LockOnCapture, LockAlways, LockInFullscreen.
useMouseForTouch	string
enableMouseSmoothing	string
enableFOVScaling	string
fOVScale	string
doubleClickTime	string
alwaysShowTouchInterface	string
showConsoleOnFourFingerTap	string
enableGestureRecognizer	string
altEnterTogglesFullscreen	string
f11TogglesFullscreen	string
defaultTouchInterface	string	Default touch interface asset path (mobile). "None" clears.

Retorna: class, configFile, properties, message.

input.setup_default_context (risco 2, altera)

Adds an InputMappingContext object variable (default "DefaultMappingContext") to a PlayerController/Character Blueprint with the context as default value and compiles it. The BeginPlay graph must still call AddMappingContext (use the bp kit).

Argumento	Tipo	Descrição
blueprint	string	obrigatório. PlayerController or Character/Pawn Blueprint (path or bare name).
context	string	obrigatório. Input Mapping Context asset to assign.
variableName	string	Name of the object variable created on the Blueprint. Default "DefaultMappingContext". Padrão TEXT("DefaultMappingContext").
priority	integer	Priority value stored in an int variable "DefaultMappingPriority" next to it (created when bCreatePriorityVariable). Padrão 0.
createPriorityVariable	boolean	Also create an integer variable "DefaultMappingPriority" with Priority as default. Padrão false.

Retorna: blueprint, variableName, context, variableCreated, message.

input.update_mapping (risco 2, altera, smoke)

Changes the action and/or key of the mapping at Index in a context (modifiers/triggers preserved).

Argumento	Tipo	Descrição
context	string	obrigatório.
index	integer	obrigatório. Index of the mapping (see input.get_context).
action	string	New Input Action (path or bare name). Empty keeps the current one.
key	string	New FKey name. Empty keeps the current one.

Retorna: asset, description, mappings, note.

input.validate_context (risco 0, smoke)

Checks a context for unbound actions, duplicate mappings, null or conflicting triggers, key/value type mismatches and shared keys.

Argumento	Tipo	Descrição
context	string	obrigatório. Input Mapping Context asset (path or bare name).

Retorna: context, valid, errors, warnings, issues.