Saltar al contenido principal

Kit input

126 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.

Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en tools/list).

Guía​

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​

ToolPurpose
input.create_action / input.create_mapping_contextNew UInputAction (valueType: bool, axis1d, axis2d, axis3d) / empty UInputMappingContext.
input.list_actions / input.list_contextsRegistry search by folder + name substring.
input.asset_exists / input.mapping_existsExistence checks (returns kind / mapping index).
input.duplicate_asset / input.rename_asset / input.delete_assetAsset lifecycle for actions, contexts and mappable configs.
input.get_action / input.set_action_properties / input.set_action_optionsValue type, consumeInput, triggerWhenPaused, description, reserveAllMappings, accumulationBehavior (5.3+), any property.
input.get_context / input.set_context_descriptionEvery mapping with indices; description and other context properties.
input.add_mapping / input.remove_mapping / input.clear_mappingsMap one key, unmap one, unmap all.
input.set_mapping_key / input.update_mappingChange the key (or action+key by index) of an existing mapping, keeping behaviours.
input.remove_action_mappings / input.remove_key_mappingsRemove every mapping of an action / of a key.
input.edit_contextBatch add + remove mappings in one call.
input.build_context_from_specBuild or fill a context from mappings:[{action, key, modifiers:[{className, properties}], triggers:[...]}], creating missing actions.
input.find_mappingsFind which contexts map an action and/or a key.
input.validate_contextUnbound actions, duplicate mappings, null/duplicate/conflicting triggers, chord without action, key/value-type mismatches, shared keys.
input.create_standard_setIA_Move/Look/Jump/Sprint/Interact (+Crouch/Fire) and IMC_Default with WASD, mouse, Space, Shift, E and gamepad.
input.migrate_legacy_to_enhancedClassic Action/Axis mappings -> Input Actions + IMC (scale -1 = Negate, other scales = Scalar).

Modifiers and triggers​

ToolPurpose
input.list_modifier_types / input.list_trigger_types / input.get_type_infoAvailable classes; per-class editable properties with type, default, tooltip, enum values.
input.add_modifier / input.add_triggerGeneric 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_triggerSame on the Input Action asset (applies to every mapping).
input.remove_modifier / input.remove_triggerRemove from a mapping by index.
input.set_modifier_properties / input.set_trigger_propertiesSet properties by index; key empty = action-level.
input.reorder_modifier / input.reorder_triggerMove 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+)​

ToolPurpose
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​

ToolPurpose
input.list_keysFKey names with category, axis type, gamepad/mouse flags (filter substring).
input.find_keyResolve a name or display name; all flags (touch, gesture, modifier, digital/analog, paired axis, deprecated).
input.list_key_categoriesMenu categories with counts.

Project Settings > Input​

ToolPurpose
input.get_input_settings / input.set_input_settingsAny UInputSettings property by name; writes DefaultInput.ini.
input.set_default_input_classesDefaultPlayerInputClass / DefaultInputComponentClass (EnhancedPlayerInput / EnhancedInputComponent).
input.list_axis_config / input.set_axis_configPer-axis dead zone, sensitivity, exponent, invert.
input.list_console_keys / input.add_console_key / input.remove_console_keyConsole keys.
input.set_viewport_input_settingsMouse 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_mappingsClassic mappings.
input.get_legacy_mapping / input.rename_legacy_mapping / input.set_axis_mapping_scale / input.remove_all_legacy_mappingsClassic 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)​

ToolPurpose
input.pie_statusIs PIE running, player controller/pawn, input classes, subsystem availability.
input.pie_inject_actionInject a value for an action for one frame (bool/axis from value.x/y/z).
input.pie_inject_key / input.pie_inject_axisRaw 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_contextsMapping contexts on the live player (runtime only).
input.pie_get_action_value / input.pie_query_keys_for_actionCurrent value/trigger state; keys mapped in the active set.
input.pie_list_bound_actions / input.pie_list_legacy_bindingsBindings 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_keyPress Ctrl+S-style chords or type text into the focused editor widget.

Blueprint wiring​

ToolPurpose
input.setup_default_contextAdds an InputMappingContext variable with a default value (no graph changes).
input.add_context_to_blueprint_begin_playInserts BeginPlay -> (GetController -> Cast) -> GetSubsystem(EnhancedInputLocalPlayerSubsystem) -> AddMappingContext into a PlayerController/Pawn Blueprint and compiles. Idempotent.
input.list_blueprint_input_eventsEnhanced 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_eventEvent nodes; existing identical nodes are returned instead of duplicated.
input.remove_input_eventRemove 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.

Herramientas​

Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de MaxAutoRisk requieren "_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumento dryRun. smoke = cubierto por edit.self_test.

input.add_action_mapping (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
namestringobligatorio. Action mapping name, e.g. "Jump".
keystringobligatorio. FKey name, e.g. "SpaceBar".
shiftbooleanValor predeterminado false.
ctrlbooleanValor predeterminado false.
altbooleanValor predeterminado false.
cmdbooleanValor predeterminado false.

Devuelve: actionMappings, axisMappings, message.

input.add_action_modifier (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
actionstringobligatorio. Input Action asset (path or bare name).
classNamestringobligatorio. Class: short ("Negate", "Hold"), full ("InputModifierNegate") or display name.
propertiesarray of UeaKeyValueProperties to set on the new object, e.g. HoldTimeThreshold=0.5.

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

input.add_action_trigger (riesgo 2, modifica, smoke)​

Adds a trigger class to the Input Action asset itself.

ArgumentoTipoDescripción
actionstringobligatorio. Input Action asset (path or bare name).
classNamestringobligatorio. Class: short ("Negate", "Hold"), full ("InputModifierNegate") or display name.
propertiesarray of UeaKeyValueProperties to set on the new object, e.g. HoldTimeThreshold=0.5.

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

input.add_axis_mapping (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
namestringobligatorio. Axis mapping name, e.g. "MoveForward".
keystringobligatorio. FKey name, e.g. "W" or "Gamepad_LeftY".
scalenumberAxis scale (use -1 for the opposite direction). Default 1. Valor predeterminado 1.0.

Devuelve: actionMappings, axisMappings, message.

input.add_chord_action (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
chordActionstringobligatorio. Input Action that must be triggering for this one to fire (path or bare name).

Devuelve: target, behaviour, behaviours, note.

input.add_combo (riesgo 2, modifica, UE 5.1+, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
stepsarray of UeaInputComboStepobligatorio. Ordered combo steps.
cancelActionsarray of stringInput Actions that cancel the combo (paths or bare names).

Devuelve: target, behaviour, behaviours, note.

input.add_console_key (riesgo 4, modifica)​

Adds a console key and saves the config.

ArgumentoTipoDescripción
keystringobligatorio. FKey name, e.g. "Tilde".

Devuelve: keys, message.

input.add_context_to_blueprint_begin_play (riesgo 2, modifica)​

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

ArgumentoTipoDescripción
blueprintstringobligatorio. PlayerController or Pawn/Character Blueprint (path or bare name).
contextstringobligatorio.
priorityintegerValor predeterminado 0.
variableNamestringWhen set, the context is read from this InputMappingContext variable (created with the context as default when missing). Empty = literal asset reference on the node.
compilebooleanCompile the Blueprint afterwards. Default true. Valor predeterminado true.

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

input.add_dead_zone (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
lowerThresholdnumberValor predeterminado 0.2.
upperThresholdnumberValor predeterminado 1.0.
typestring"Axial" or "Radial" (default). Newer engines also accept "UnscaledRadial". Valor predeterminado TEXT("Radial").

Devuelve: target, behaviour, behaviours, note.

input.add_default_mapping_context (riesgo 4, modifica, UE 5.2+)​

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

ArgumentoTipoDescripción
contextstringobligatorio.
priorityintegerValor predeterminado 0.
addImmediatelybooleanValor predeterminado true.
registerWithUserSettingsboolean5.3+: also register the context with Enhanced Input User Settings. Valor predeterminado false.
worldSubsystembooleanValor predeterminado false.

Devuelve: list, entries, message.

input.add_down (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
actuationThresholdnumberMagnitude at which the trigger considers the input actuated. Default 0.5. Valor predeterminado 0.5.

Devuelve: target, behaviour, behaviours, note.

input.add_enhanced_action_event (riesgo 2, modifica)​

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

ArgumentoTipoDescripción
blueprintstringobligatorio.
actionstringobligatorio.
graphstringEvent graph name. Empty = the main EventGraph.
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.

Devuelve: blueprint, node, existing, message.

input.add_fov_scaling (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
fOVScalenumberValor predeterminado 1.0.
scalingTypestring"Standard" (default) or "UE4_BackCompat". Valor predeterminado TEXT("Standard").

Devuelve: target, behaviour, behaviours, note.

input.add_hold (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
holdTimeThresholdnumberSeconds the input must stay actuated. Default 1 (Hold) / 0.5 (HoldAndRelease). Negative = class default. Valor predeterminado -1.0.
isOneShotbooleanHold only: fire once instead of every frame after the threshold. Valor predeterminado false.
affectedByTimeDilationbooleanValor predeterminado false.
actuationThresholdnumberValor predeterminado 0.5.

Devuelve: target, behaviour, behaviours, note.

input.add_hold_and_release (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
holdTimeThresholdnumberSeconds the input must stay actuated. Default 1 (Hold) / 0.5 (HoldAndRelease). Negative = class default. Valor predeterminado -1.0.
isOneShotbooleanHold only: fire once instead of every frame after the threshold. Valor predeterminado false.
affectedByTimeDilationbooleanValor predeterminado false.
actuationThresholdnumberValor predeterminado 0.5.

Devuelve: target, behaviour, behaviours, note.

input.add_key_event (riesgo 2, modifica)​

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

ArgumentoTipoDescripción
blueprintstringobligatorio.
keystringobligatorio. FKey name (a digital key for key events, an axis key for axis-key events).
graphstring
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
consumeInputbooleanValor predeterminado true.
executeWhenPausedbooleanValor predeterminado false.
overrideParentBindingbooleanValor predeterminado true.
controlbooleanModifier requirements (key events only). Valor predeterminado false.
altbooleanValor predeterminado false.
shiftbooleanValor predeterminado false.
commandbooleanValor predeterminado false.

Devuelve: blueprint, node, existing, message.

input.add_legacy_action_event (riesgo 2, modifica)​

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

ArgumentoTipoDescripción
blueprintstringobligatorio.
namestringobligatorio. Classic action or axis mapping name from Project Settings.
graphstring
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
consumeInputbooleanValor predeterminado true.
executeWhenPausedbooleanValor predeterminado false.
overrideParentBindingbooleanValor predeterminado true.

Devuelve: blueprint, node, existing, message.

input.add_legacy_axis_event (riesgo 2, modifica)​

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

ArgumentoTipoDescripción
blueprintstringobligatorio.
namestringobligatorio. Classic action or axis mapping name from Project Settings.
graphstring
xintegerValor predeterminado 0.
yintegerValor predeterminado 0.
consumeInputbooleanValor predeterminado true.
executeWhenPausedbooleanValor predeterminado false.
overrideParentBindingbooleanValor predeterminado true.

Devuelve: blueprint, node, existing, message.

input.add_mapping (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).
actionstringobligatorio. Input Action asset (path or bare name).
keystringobligatorio. FKey name, e.g. "W", "SpaceBar", "LeftMouseButton", "Mouse2D", "Gamepad_LeftX". See input.list_keys.
modifiersarray of stringModifier class names to add to the new mapping, e.g. ["Negate", "Swizzle"].
triggersarray of stringTrigger class names to add to the new mapping, e.g. ["Hold", "Pressed"].

Devuelve: asset, description, mappings, note.

input.add_modifier (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).
actionstringobligatorio. Input Action of the mapping.
keystringobligatorio. FKey name of the mapping.
classNamestringobligatorio. Class: short ("Negate", "Swizzle", "Scalar", "DeadZone", "Smooth", "Hold", "Pressed", "Released", "Tap", "Pulse", "Down") or full ("InputModifierNegate"). See input.list_modifier_types / list_trigger_types.
propertiesarray of UeaKeyValueProperties to set on the new object, e.g. Order=YXZ, Scalar=(X=2,Y=1,Z=1), HoldTimeThreshold=0.5, LowerThreshold=0.25.

Devuelve: asset, description, mappings, note.

input.add_negate (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
xbooleanValor predeterminado true.
ybooleanValor predeterminado true.
zbooleanValor predeterminado true.

Devuelve: target, behaviour, behaviours, note.

input.add_pressed (riesgo 2, modifica, smoke)​

Adds a Pressed trigger (fires once when actuated).

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
actuationThresholdnumberMagnitude at which the trigger considers the input actuated. Default 0.5. Valor predeterminado 0.5.

Devuelve: target, behaviour, behaviours, note.

input.add_pulse (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
triggerOnStartbooleanValor predeterminado true.
intervalnumberSeconds between pulses. Default 1. Valor predeterminado 1.0.
triggerLimitinteger0 = unlimited. Valor predeterminado 0.
affectedByTimeDilationbooleanValor predeterminado false.

Devuelve: target, behaviour, behaviours, note.

input.add_released (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
actuationThresholdnumberMagnitude at which the trigger considers the input actuated. Default 0.5. Valor predeterminado 0.5.

Devuelve: target, behaviour, behaviours, note.

input.add_repeated_tap (riesgo 2, modifica, UE 5.6+, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
numberOfTapsintegerNumber of taps that trigger. Default 2. Valor predeterminado 2.
tapReleaseTimeThresholdnumberValor predeterminado 0.2.

Devuelve: target, behaviour, behaviours, note.

input.add_response_curve_exponential (riesgo 2, modifica, smoke)​

Adds a Response Curve - Exponential modifier.

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
exponent{x,y,z}Per-axis exponent. Default (1,1,1). Valor predeterminado FUeaVec3(1.0, 1.0, 1.0).

Devuelve: target, behaviour, behaviours, note.

input.add_response_curve_user (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
curveXstringCurveFloat asset for X (path or bare name). Empty leaves it unset.
curveYstring
curveZstring

Devuelve: target, behaviour, behaviours, note.

input.add_scalar (riesgo 2, modifica, smoke)​

Adds a Scalar modifier (per-axis multiplier).

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
scalar{x,y,z}Per-axis multiplier. Default (1,1,1). Valor predeterminado FUeaVec3(1.0, 1.0, 1.0).

Devuelve: target, behaviour, behaviours, note.

input.add_scale_by_delta_time (riesgo 2, modifica, UE 5.1+, smoke)​

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

ArgumentoTipoDescripción
contextstringInput Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset.
actionstringobligatorio. Input Action (path or bare name).
keystringFKey name of the mapping. Empty = action-level behaviour.

Devuelve: target, behaviour, behaviours, note.

input.add_smooth (riesgo 2, modifica, smoke)​

Adds a Smooth modifier (averages input across frames).

ArgumentoTipoDescripción
contextstringInput Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset.
actionstringobligatorio. Input Action (path or bare name).
keystringFKey name of the mapping. Empty = action-level behaviour.

Devuelve: target, behaviour, behaviours, note.

input.add_smooth_delta (riesgo 2, modifica, UE 5.4+, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
smoothingMethodstringSmoothing method enum name (e.g. Linear, Interp, InterpConstant, InterpCircularIn, ...). Empty keeps the class default.
speednumberValor predeterminado 0.5.
easingExponentnumberValor predeterminado 2.0.

Devuelve: target, behaviour, behaviours, note.

input.add_swizzle (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
orderstringAxis order: YXZ (default, swaps X/Y), ZYX, XZY, YZX, ZXY. Valor predeterminado TEXT("YXZ").

Devuelve: target, behaviour, behaviours, note.

input.add_tap (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystring
tapReleaseTimeThresholdnumberRelease must happen within this many seconds. Default 0.2. Valor predeterminado 0.2.
actuationThresholdnumberValor predeterminado 0.5.

Devuelve: target, behaviour, behaviours, note.

input.add_to_world_space (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringInput Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset.
actionstringobligatorio. Input Action (path or bare name).
keystringFKey name of the mapping. Empty = action-level behaviour.

Devuelve: target, behaviour, behaviours, note.

input.add_trigger (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).
actionstringobligatorio. Input Action of the mapping.
keystringobligatorio. FKey name of the mapping.
classNamestringobligatorio. Class: short ("Negate", "Swizzle", "Scalar", "DeadZone", "Smooth", "Hold", "Pressed", "Released", "Tap", "Pulse", "Down") or full ("InputModifierNegate"). See input.list_modifier_types / list_trigger_types.
propertiesarray of UeaKeyValueProperties to set on the new object, e.g. Order=YXZ, Scalar=(X=2,Y=1,Z=1), HoldTimeThreshold=0.5, LowerThreshold=0.25.

Devuelve: asset, description, mappings, note.

input.asset_exists (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
assetstringobligatorio. Object path (/Game/Input/IA_Jump.IA_Jump), package path or unique bare name of the asset.

Devuelve: exists, kind, asset.

input.build_context_from_spec (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringExisting Mapping Context to fill (path or bare name). Empty = create Name in Folder.
namestringName of the context to create when Context is empty, e.g. "IMC_Default".
folderstringFolder for the new context and for actions created on the fly. Default "/Game/Input".
descriptionstring
clearExistingbooleanRemove existing mappings before applying the spec. Valor predeterminado false.
createMissingActionsbooleanCreate Input Actions referenced by name that do not exist yet. Default true. Valor predeterminado true.
skipDuplicatesbooleanSkip (instead of failing on) mappings that already exist. Default true. Valor predeterminado true.
mappingsarray of UeaInputSpecMappingobligatorio.

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

input.clear_mappings (riesgo 5, modifica, destructivo, smoke)​

Removes every mapping from a context.

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).

Devuelve: asset, description, mappings, note.

input.create_action (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
namestringobligatorio. Asset name, e.g. "IA_Jump". No spaces or slashes.
folderstringDestination content folder. Default "/Game/Input".
valueTypestring"bool" (digital), "axis1d" (float), "axis2d" (Vector2D) or "axis3d" (Vector). Default "bool". Valor predeterminado TEXT("bool").
consumeInputbooleanWhether the action swallows the input so lower-priority mappings do not see it. Default true. Valor predeterminado true.
descriptionstringLocalised description (stored on 5.1+, ignored on older engines).

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

input.create_mappable_input_config (riesgo 2, modifica, 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).

ArgumentoTipoDescripción
namestringobligatorio.
folderstringDefault "/Game/Input".
configNamestringConfigName (FName) shown to players. Default = asset name.
displayNamestring

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

input.create_mapping_context (riesgo 2, modifica, smoke)​

Creates an empty Input Mapping Context asset in a folder.

ArgumentoTipoDescripción
namestringobligatorio. Asset name, e.g. "IMC_Default".
folderstringDestination content folder. Default "/Game/Input".
descriptionstringLocalised description of the context.

Devuelve: asset, description, mappings, note.

input.create_standard_set (riesgo 2, modifica, 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.

ArgumentoTipoDescripción
folderstringDestination folder. Default "/Game/Input".
actionPrefixstringPrefix for action assets. Default "IA_". Valor predeterminado TEXT("IA_").
contextNamestringMapping context name. Default "IMC_Default". Valor predeterminado TEXT("IMC_Default").
includeGamepadbooleanAlso map gamepad sticks/buttons. Default true. Valor predeterminado true.
includeCrouchbooleanAdd a Crouch action (Ctrl / gamepad right thumbstick button). Default false. Valor predeterminado false.
includeFirebooleanAdd a Fire action (left mouse / right trigger). Default false. Valor predeterminado false.
reuseExistingbooleanReuse existing assets with the same names instead of failing. Default true. Valor predeterminado true.

Devuelve: actions, context, message.

input.delete_asset (riesgo 3, modifica, destructivo, smoke)​

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

ArgumentoTipoDescripción
assetstringobligatorio. Object path (/Game/Input/IA_Jump.IA_Jump), package path or unique bare name of the asset.

Devuelve: asset, message.

input.duplicate_asset (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
assetstringobligatorio. Input Action or Mapping Context asset to copy (path or bare name).
newNamestringobligatorio. Name of the copy, e.g. "IA_Jump_Alt".
folderstringDestination folder. Empty = same folder as the source.

Devuelve: asset, message.

input.edit_context (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio.
addarray of UeaInputSpecMappingMappings to add ({action, key, modifiers[], triggers[]}); existing action+key pairs are skipped.
removearray of UeaInputMappingArgsMappings to remove, as {action, key}.
createMissingActionsbooleanCreate Input Actions referenced by name in Add that do not exist yet (in the context's folder). Default false. Valor predeterminado false.

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

input.find_key (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
namestringobligatorio. FKey name or display name (case-insensitive), e.g. "Space Bar", "Gamepad Face Button Bottom".

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

input.find_mappings (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
actionstringInput Action to look for (path or bare name). Empty = any action.
keystringFKey name to look for. Empty = any key.
folderstringFolder whose mapping contexts are searched (recursive). Default "/Game".

Devuelve: matches, contextsSearched.

input.get_action (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
assetstringobligatorio. Object path (/Game/Input/IA_Jump.IA_Jump), package path or unique bare name of the asset.

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

input.get_context (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).

Devuelve: asset, description, mappings, note.

input.get_enhanced_developer_settings (riesgo 0, UE 5.1+, smoke)​

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

ArgumentoTipoDescripción
filterstringSubstring filter on property names (case-insensitive). Empty = all.

Devuelve: class, configFile, properties, message.

input.get_enhanced_editor_settings (riesgo 0, UE 5.1+, smoke)​

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

ArgumentoTipoDescripción
filterstringSubstring filter on property names (case-insensitive). Empty = all.

Devuelve: class, configFile, properties, message.

input.get_input_settings (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
filterstringSubstring filter on property names (case-insensitive). Empty = all.

Devuelve: class, configFile, properties, message.

input.get_legacy_mapping (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
namestringAction or axis mapping name. Empty returns every classic mapping.

Devuelve: actionMappings, axisMappings, message.

input.get_mappable_input_config (riesgo 0, UE 5.1+, smoke)​

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

ArgumentoTipoDescripción
configstringobligatorio.

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

input.get_type_info (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
classNamestringobligatorio. Modifier or trigger class: short ("Hold"), full ("InputTriggerHold") or display name.

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

input.list_actions (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
folderstringRoot folder to search. Default "/Game".
namestringSubstring of the asset name (case-insensitive).
recursivebooleanValor predeterminado true.
limitintegerValor predeterminado 200.

Devuelve: assets, total.

input.list_axis_config (riesgo 0, smoke)​

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

Sin argumentos.

Devuelve: entries, message.

input.list_blueprint_input_events (riesgo 0)​

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

ArgumentoTipoDescripción
blueprintstringobligatorio.

Devuelve: blueprint, events, mappingContextCalls.

input.list_console_keys (riesgo 0, smoke)​

Lists the keys that open the in-game console.

Sin argumentos.

Devuelve: keys, message.

input.list_contexts (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
folderstringRoot folder to search. Default "/Game".
namestringSubstring of the asset name (case-insensitive).
recursivebooleanValor predeterminado true.
limitintegerValor predeterminado 200.

Devuelve: assets, total.

input.list_default_mapping_contexts (riesgo 0, UE 5.2+, smoke)​

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

ArgumentoTipoDescripción
worldSubsystembooleanRead the world-subsystem list instead of the player list. Valor predeterminado false.

Devuelve: list, entries, message.

input.list_key_categories (riesgo 0, smoke)​

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

Sin argumentos.

Devuelve: categories.

input.list_keys (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
filterstringSubstring filter on the key name or display name (case-insensitive), e.g. "Gamepad", "Mouse".
limitintegerValor predeterminado 300.

Devuelve: keys, total.

input.list_legacy_mappings (riesgo 0, smoke)​

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

Sin argumentos.

Devuelve: actionMappings, axisMappings, message.

input.list_mappable_names (riesgo 0, UE 5.3+, smoke)​

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

ArgumentoTipoDescripción
folderstringFolder searched for Input Actions and Mapping Contexts. Default "/Game".

Devuelve: names.

input.list_modifier_types (riesgo 0, smoke)​

Lists the available Input Modifier classes and their editable properties.

Sin argumentos.

Devuelve: types.

input.list_trigger_types (riesgo 0, smoke)​

Lists the available Input Trigger classes and their editable properties.

Sin argumentos.

Devuelve: types.

input.mapping_exists (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).
actionstringobligatorio. Input Action asset (path or bare name).
keystringobligatorio. FKey name of the mapping.

Devuelve: exists, index, mapping.

input.migrate_legacy_to_enhanced (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
folderstringDestination folder. Default "/Game/Input".
actionPrefixstringValor predeterminado TEXT("IA_").
contextNamestringValor predeterminado TEXT("IMC_Legacy").
includeActionMappingsbooleanValor predeterminado true.
includeAxisMappingsbooleanValor predeterminado true.
removeLegacybooleanRemove the classic mappings from Project Settings once converted. Default false. Valor predeterminado false.
reuseExistingbooleanReuse existing assets with the same names instead of failing. Default true. Valor predeterminado true.

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

input.pie_add_context (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio.
priorityintegerValor predeterminado 0.
playerIndexintegerValor predeterminado 0.

Devuelve: contexts, message.

input.pie_clear_contexts (riesgo 0, requiere PIE, smoke)​

Removes every mapping context from the PIE player.

ArgumentoTipoDescripción
playerIndexintegerLocal player index in the PIE session. Default 0. Valor predeterminado 0.

Devuelve: contexts, message.

input.pie_get_action_value (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
actionstringobligatorio.
playerIndexintegerValor predeterminado 0.

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

input.pie_get_user_settings (riesgo 0, UE 5.3+, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
playerIndexintegerLocal player index in the PIE session. Default 0. Valor predeterminado 0.

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

input.pie_inject_action (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
actionstringobligatorio.
value{x,y,z}Value: X for bool (non-zero = true) and axis1d; X,Y for axis2d; X,Y,Z for axis3d. Valor predeterminado FUeaVec3(1.0, 0.0, 0.0).
modifiersarray of stringModifier class names applied to the injected value (optional).
triggersarray of stringTrigger class names evaluated for the injected value (optional).
playerIndexintegerValor predeterminado 0.

Devuelve: target, message.

input.pie_inject_axis (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
keystringobligatorio. Axis FKey name, e.g. "MouseX", "Gamepad_LeftY".
deltanumberobligatorio.
deltaTimenumberSeconds the delta covers. Default 1/60. Valor predeterminado 1.0 / 60.0.
numSamplesintegerValor predeterminado 1.
playerIndexintegerValor predeterminado 0.

Devuelve: target, message.

input.pie_inject_key (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
keystringobligatorio. FKey name, e.g. "SpaceBar", "Gamepad_FaceButton_Bottom".
eventstring"pressed" (default), "released", "repeat", "doubleclick" or "tap" (press then release). Valor predeterminado TEXT("pressed").
amountnumberAmount depressed for analog buttons. Default 1. Valor predeterminado 1.0.
playerIndexintegerValor predeterminado 0.

Devuelve: target, message.

input.pie_list_applied_contexts (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
playerIndexintegerLocal player index in the PIE session. Default 0. Valor predeterminado 0.

Devuelve: contexts, message.

input.pie_list_bound_actions (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
playerIndexintegerLocal player index in the PIE session. Default 0. Valor predeterminado 0.

Devuelve: bindings, message.

input.pie_list_legacy_bindings (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
playerIndexintegerLocal player index in the PIE session. Default 0. Valor predeterminado 0.

Devuelve: bindings, message.

input.pie_list_player_key_mappings (riesgo 0, UE 5.3+, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
profileIdstringKey profile id. Empty = active profile.
filterstringFilter on mapping name (substring).
playerIndexintegerValor predeterminado 0.

Devuelve: profileId, mappings, failureReason, message.

input.pie_map_player_key (riesgo 0, UE 5.3+, requiere PIE)​

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

ArgumentoTipoDescripción
mappingNamestringobligatorio. Mapping name from Player Mappable Key Settings (see input.list_mappable_names / pie_list_player_key_mappings).
newKeystringFKey name to assign (ignored by unmap/reset).
slotstringSlot: First (default), Second, Third, ... Seventh. Valor predeterminado TEXT("First").
profileIdstringKey profile id. Empty = active profile.
playerIndexintegerValor predeterminado 0.

Devuelve: profileId, mappings, failureReason, message.

input.pie_query_keys_for_action (riesgo 0, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
actionstringobligatorio.
playerIndexintegerValor predeterminado 0.

Devuelve: action, keys.

input.pie_register_context_with_user_settings (riesgo 0, UE 5.3+, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio.
unregisterbooleanUnregister instead. Valor predeterminado false.
playerIndexintegerValor predeterminado 0.

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

input.pie_remove_context (riesgo 0, requiere PIE, smoke)​

Removes a mapping context from the PIE player at runtime.

ArgumentoTipoDescripción
contextstringobligatorio.
priorityintegerValor predeterminado 0.
playerIndexintegerValor predeterminado 0.

Devuelve: contexts, message.

input.pie_reset_player_key_row (riesgo 0, UE 5.3+, requiere PIE)​

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

ArgumentoTipoDescripción
mappingNamestringobligatorio. Mapping name from Player Mappable Key Settings (see input.list_mappable_names / pie_list_player_key_mappings).
newKeystringFKey name to assign (ignored by unmap/reset).
slotstringSlot: First (default), Second, Third, ... Seventh. Valor predeterminado TEXT("First").
profileIdstringKey profile id. Empty = active profile.
playerIndexintegerValor predeterminado 0.

Devuelve: profileId, mappings, failureReason, message.

input.pie_save_user_settings (riesgo 0, UE 5.3+, requiere PIE, smoke)​

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

ArgumentoTipoDescripción
applybooleanApply the settings to the live player input before saving. Default true. Valor predeterminado true.
playerIndexintegerValor predeterminado 0.

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

input.pie_set_key_profile (riesgo 0, UE 5.3+, requiere PIE)​

Switches the active key profile of the PIE player.

ArgumentoTipoDescripción
profileIdstringobligatorio.
playerIndexintegerValor predeterminado 0.

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

input.pie_status (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
playerIndexintegerLocal player index in the PIE session. Default 0. Valor predeterminado 0.

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

input.pie_unmap_player_key (riesgo 0, UE 5.3+, requiere PIE)​

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

ArgumentoTipoDescripción
mappingNamestringobligatorio. Mapping name from Player Mappable Key Settings (see input.list_mappable_names / pie_list_player_key_mappings).
newKeystringFKey name to assign (ignored by unmap/reset).
slotstringSlot: First (default), Second, Third, ... Seventh. Valor predeterminado TEXT("First").
profileIdstringKey profile id. Empty = active profile.
playerIndexintegerValor predeterminado 0.

Devuelve: profileId, mappings, failureReason, message.

input.press_editor_key (riesgo 0)​

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

ArgumentoTipoDescripción
keystringKey with optional modifier prefixes, e.g. "Ctrl+S", "Shift+Alt+F", "Enter", "Escape". FKey names or display names.
textstringText to type as character events into the focused widget (used when Key is empty).

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

input.remove_action_mapping (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
namestringobligatorio. Action mapping name, e.g. "Jump".
keystringobligatorio. FKey name, e.g. "SpaceBar".
shiftbooleanValor predeterminado false.
ctrlbooleanValor predeterminado false.
altbooleanValor predeterminado false.
cmdbooleanValor predeterminado false.

Devuelve: actionMappings, axisMappings, message.

input.remove_action_mappings (riesgo 2, modifica, smoke)​

Removes every mapping of one action from a context.

ArgumentoTipoDescripción
contextstringobligatorio.
actionstringobligatorio.

Devuelve: asset, description, mappings, note.

input.remove_action_modifier (riesgo 2, modifica, smoke)​

Removes the modifier at Index from the Input Action asset.

ArgumentoTipoDescripción
actionstringobligatorio.
indexintegerobligatorio. Index in the action's Modifiers/Triggers array (see input.get_action).

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

input.remove_action_trigger (riesgo 2, modifica, smoke)​

Removes the trigger at Index from the Input Action asset.

ArgumentoTipoDescripción
actionstringobligatorio.
indexintegerobligatorio. Index in the action's Modifiers/Triggers array (see input.get_action).

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

input.remove_all_legacy_mappings (riesgo 5, modifica, destructivo)​

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

ArgumentoTipoDescripción
actionMappingsbooleanValor predeterminado true.
axisMappingsbooleanValor predeterminado true.

Devuelve: actionMappings, axisMappings, message.

input.remove_axis_mapping (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
namestringobligatorio. Axis mapping name, e.g. "MoveForward".
keystringobligatorio. FKey name, e.g. "W" or "Gamepad_LeftY".
scalenumberAxis scale (use -1 for the opposite direction). Default 1. Valor predeterminado 1.0.

Devuelve: actionMappings, axisMappings, message.

input.remove_console_key (riesgo 4, modifica)​

Removes a console key and saves the config.

ArgumentoTipoDescripción
keystringobligatorio. FKey name, e.g. "Tilde".

Devuelve: keys, message.

input.remove_default_mapping_context (riesgo 4, modifica, UE 5.2+)​

Removes a context from the automatic default list.

ArgumentoTipoDescripción
contextstringobligatorio.
worldSubsystembooleanValor predeterminado false.

Devuelve: list, entries, message.

input.remove_input_event (riesgo 3, modifica, destructivo)​

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

ArgumentoTipoDescripción
blueprintstringobligatorio.
nodeGuidstringobligatorio. Node GUID from input.list_blueprint_input_events.

Devuelve: blueprint, removed, message.

input.remove_key_mappings (riesgo 2, modifica, smoke)​

Removes every mapping that uses a key from a context.

ArgumentoTipoDescripción
contextstringobligatorio.
keystringobligatorio. FKey name.

Devuelve: asset, description, mappings, note.

input.remove_mapping (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).
actionstringobligatorio. Input Action asset (path or bare name).
keystringobligatorio. FKey name of the mapping.

Devuelve: asset, description, mappings, note.

input.remove_modifier (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).
actionstringobligatorio. Input Action of the mapping.
keystringobligatorio. FKey name of the mapping.
indexintegerobligatorio. Index in the mapping's Modifiers/Triggers array (see input.get_context).

Devuelve: asset, description, mappings, note.

input.remove_trigger (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).
actionstringobligatorio. Input Action of the mapping.
keystringobligatorio. FKey name of the mapping.
indexintegerobligatorio. Index in the mapping's Modifiers/Triggers array (see input.get_context).

Devuelve: asset, description, mappings, note.

input.rename_asset (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
assetstringobligatorio. Input Action or Mapping Context asset (path or bare name).
newNamestringobligatorio. New asset name.
folderstringDestination folder (moves the asset). Empty = keep the current folder.

Devuelve: asset, message.

input.rename_legacy_mapping (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
kindstringobligatorio. "action" or "axis".
namestringobligatorio.
newNamestringobligatorio.

Devuelve: actionMappings, axisMappings, message.

input.reorder_modifier (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystringFKey name of the mapping. Empty = action-level behaviour.
indexintegerobligatorio.
newIndexintegerobligatorio.

Devuelve: target, behaviour, behaviours, note.

input.reorder_trigger (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystringFKey name of the mapping. Empty = action-level behaviour.
indexintegerobligatorio.
newIndexintegerobligatorio.

Devuelve: target, behaviour, behaviours, note.

input.set_action_mappable_settings (riesgo 2, modifica, UE 5.3+, smoke)​

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

ArgumentoTipoDescripción
actionstringobligatorio.
namestringUnique mapping name used by user settings (e.g. "Jump").
displayNamestring
displayCategorystring
clearbooleanRemove the settings object from the action instead. Valor predeterminado false.

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

input.set_action_options (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
actionstringobligatorio.
reserveAllMappingsstring"true"/"false" for bReserveAllMappings (player mappable UIs reserve slots). Empty keeps.
accumulationBehaviorstring5.3+: "TakeHighestAbsoluteValue" or "Cumulative". Empty keeps; ignored below 5.3.
propertiesarray of UeaKeyValueAny other UInputAction property as name=value.

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

input.set_action_properties (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
actionstringobligatorio. Input Action asset (path or bare name).
valueTypestringNew value type: "bool", "axis1d", "axis2d", "axis3d". Empty keeps the current one.
consumeInputstring"true" / "false" to change bConsumeInput; empty keeps the current value.
triggerWhenPausedstring"true" / "false" to change bTriggerWhenPaused; empty keeps the current value.
descriptionstringNew description (5.1+; ignored below). Empty keeps the current one.

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

input.set_axis_config (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
keystringobligatorio. Axis key name, e.g. "MouseX", "Gamepad_LeftX". Added when missing.
deadZonestringValues as text; empty keeps the current one.
sensitivitystring
exponentstring
invertstring"true" / "false".

Devuelve: entries, message.

input.set_axis_mapping_scale (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
namestringobligatorio.
keystringobligatorio.
scalenumberCurrent scale of the mapping to change (a name+key pair may exist with several scales). Default 1. Valor predeterminado 1.0.
newScalenumberobligatorio.

Devuelve: actionMappings, axisMappings, message.

input.set_context_description (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio.
descriptionstring
propertiesarray of UeaKeyValueAny other UInputMappingContext property as name=value.

Devuelve: asset, description, mappings, note.

input.set_default_input_classes (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
playerInputClassstringPlayerInput subclass (e.g. "EnhancedPlayerInput", a Blueprint path or "/Script/EnhancedInput.EnhancedPlayerInput"). Empty keeps.
inputComponentClassstringInputComponent subclass (e.g. "EnhancedInputComponent"). Empty keeps.

Devuelve: class, configFile, properties, message.

input.set_enhanced_developer_settings (riesgo 4, modifica, UE 5.1+)​

Sets UEnhancedInputDeveloperSettings properties by name and writes DefaultInput.ini.

ArgumentoTipoDescripción
propertiesarray of UeaKeyValueobligatorio. Properties to set as name=value in engine text form (true/false, 0.5, enum name, class path, (X=1,Y=2)).

Devuelve: class, configFile, properties, message.

input.set_enhanced_editor_settings (riesgo 4, modifica, UE 5.1+)​

Sets UEnhancedInputEditorSettings properties by name and saves them.

ArgumentoTipoDescripción
propertiesarray of UeaKeyValueobligatorio. Properties to set as name=value in engine text form (true/false, 0.5, enum name, class path, (X=1,Y=2)).

Devuelve: class, configFile, properties, message.

input.set_input_settings (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
propertiesarray of UeaKeyValueobligatorio. Properties to set as name=value in engine text form (true/false, 0.5, enum name, class path, (X=1,Y=2)).

Devuelve: class, configFile, properties, message.

input.set_mappable_input_config_context (riesgo 2, modifica, UE 5.1+, smoke)​

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

ArgumentoTipoDescripción
configstringobligatorio. PlayerMappableInputConfig asset (path or bare name).
contextstringobligatorio.
priorityintegerValor predeterminado 0.
removebooleanRemove the context instead of adding/updating it. Valor predeterminado false.

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

input.set_mapping_key (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio.
actionstringobligatorio.
keystringobligatorio. Current FKey name of the mapping.
newKeystringobligatorio. New FKey name. Modifiers and triggers are kept.

Devuelve: asset, description, mappings, note.

input.set_mapping_mappable_settings (riesgo 2, modifica, UE 5.3+, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio.
actionstringobligatorio.
keystringobligatorio.
behaviorstring"inherit" (from the action, default), "override" (own settings on this mapping) or "ignore" (not player mappable). Valor predeterminado TEXT("inherit").
namestringUsed with "override".
displayNamestring
displayCategorystring

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

input.set_modifier_properties (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystringFKey name of the mapping. Empty = action-level behaviour.
indexintegerobligatorio. Index in the Modifiers/Triggers array.
propertiesarray of UeaKeyValueobligatorio. Properties to set, name=value (engine text form).

Devuelve: target, behaviour, behaviours, note.

input.set_trigger_properties (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstring
actionstringobligatorio.
keystringFKey name of the mapping. Empty = action-level behaviour.
indexintegerobligatorio. Index in the Modifiers/Triggers array.
propertiesarray of UeaKeyValueobligatorio. Properties to set, name=value (engine text form).

Devuelve: target, behaviour, behaviours, note.

input.set_viewport_input_settings (riesgo 4, modifica)​

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

ArgumentoTipoDescripción
captureMouseOnLaunchstringAll values are text tri-states: empty keeps the current value.
mouseCaptureModestringNoCapture, CapturePermanently, CapturePermanently_IncludingInitialMouseDown, CaptureDuringMouseDown, CaptureDuringRightMouseDown.
mouseLockModestringDoNotLock, LockOnCapture, LockAlways, LockInFullscreen.
useMouseForTouchstring
enableMouseSmoothingstring
enableFOVScalingstring
fOVScalestring
doubleClickTimestring
alwaysShowTouchInterfacestring
showConsoleOnFourFingerTapstring
enableGestureRecognizerstring
altEnterTogglesFullscreenstring
f11TogglesFullscreenstring
defaultTouchInterfacestringDefault touch interface asset path (mobile). "None" clears.

Devuelve: class, configFile, properties, message.

input.setup_default_context (riesgo 2, modifica)​

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).

ArgumentoTipoDescripción
blueprintstringobligatorio. PlayerController or Character/Pawn Blueprint (path or bare name).
contextstringobligatorio. Input Mapping Context asset to assign.
variableNamestringName of the object variable created on the Blueprint. Default "DefaultMappingContext". Valor predeterminado TEXT("DefaultMappingContext").
priorityintegerPriority value stored in an int variable "DefaultMappingPriority" next to it (created when bCreatePriorityVariable). Valor predeterminado 0.
createPriorityVariablebooleanAlso create an integer variable "DefaultMappingPriority" with Priority as default. Valor predeterminado false.

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

input.update_mapping (riesgo 2, modifica, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio.
indexintegerobligatorio. Index of the mapping (see input.get_context).
actionstringNew Input Action (path or bare name). Empty keeps the current one.
keystringNew FKey name. Empty keeps the current one.

Devuelve: asset, description, mappings, note.

input.validate_context (riesgo 0, smoke)​

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

ArgumentoTipoDescripción
contextstringobligatorio. Input Mapping Context asset (path or bare name).

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