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
| 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
input.create_standard_set{folder:"/Game/Input"}-> IA_* actions + IMC_Default with keyboard/mouse/gamepad.input.set_default_input_classes{playerInputClass:"EnhancedPlayerInput", inputComponentClass:"EnhancedInputComponent"}(5.1+ projects already default to these).input.add_context_to_blueprint_begin_play{blueprint:"BP_PlayerCharacter", context:"IMC_Default", priority:0}.input.add_enhanced_action_event{blueprint:"BP_PlayerCharacter", action:"IA_Jump"}then connect theTriggeredpin withbp.connect_pins(repeat for IA_Move etc.).input.validate_context{context:"IMC_Default"}thenasset.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)
- Start PIE (edit kit),
input.pie_status. input.pie_list_applied_contexts- if empty,input.pie_add_context {context:"IMC_Default"}for this session.input.pie_inject_action {action:"IA_Jump", value:{x:1}}orinput.pie_inject_key {key:"SpaceBar", event:"tap"}.input.pie_get_action_value {action:"IA_Move"}whileinput.pie_inject_axis {key:"Gamepad_LeftX", delta:1}.
Recipe: player key rebinding (5.3+)
input.set_action_mappable_settings {action:"IA_Jump", name:"Jump", displayName:"Jump", displayCategory:"Movement"}.input.set_enhanced_developer_settings {properties:[{key:"bEnableUserSettings", value:"true"}]}andinput.add_default_mapping_context {context:"IMC_Default", registerWithUserSettings:true}.- 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)
input.add_axis_mapping {name:"MoveForward", key:"W", scale:1}and{key:"S", scale:-1}input.add_action_mapping {name:"Jump", key:"SpaceBar"}input.add_legacy_axis_event {blueprint:"BP_Pawn", name:"MoveForward"}/input.add_legacy_action_event {..., name:"Jump"}.- 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_keyshows suggestions). - A 2D action mapped to a 1D key needs
Swizzleto drive Y;Negateinverts. Property values use engine text form (true,0.5,(X=1,Y=0,Z=0), enum names likeYXZ,Radial). - Typed add tools with
keyempty target the Input Action asset (applies to all mappings); withcontext+keythey target one mapping.set_*_properties/reorder_*work the same way. add_mappingrefuses a duplicate Action+Key;edit_context/build_context_from_specskip duplicates instead. Indices come fromget_contextand shift after a removal.set_action_properties,set_viewport_input_settings,set_axis_configuse text tri-states for booleans ("false"); empty means "leave unchanged".add_context_to_blueprint_begin_playuses a literal asset reference unlessvariableNameis 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_keytargets the editor's focused Slate widget (not the game viewport).- Combo triggers are deprecated by Epic in 5.8 but still work;
add_combosets the steps through reflection so the property names of every 5.x version are handled. remove_all_legacy_mappings,delete_asset,clear_mappingsandremove_input_eventare destructive; asset edits are undoable withedit.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
MaxAutoRiskrequieren"_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 argumentodryRun. smoke = cubierto poredit.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.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Action mapping name, e.g. "Jump". |
key | string | obligatorio. FKey name, e.g. "SpaceBar". |
shift | boolean | Valor predeterminado false. |
ctrl | boolean | Valor predeterminado false. |
alt | boolean | Valor predeterminado false. |
cmd | boolean | Valor 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).
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. Input Action asset (path or bare name). |
className | string | obligatorio. 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. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. Input Action asset (path or bare name). |
className | string | obligatorio. 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. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Axis mapping name, e.g. "MoveForward". |
key | string | obligatorio. FKey name, e.g. "W" or "Gamepad_LeftY". |
scale | number | Axis 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
chordAction | string | obligatorio. 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
steps | array of UeaInputComboStep | obligatorio. Ordered combo steps. |
cancelActions | array of string | Input 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.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
blueprint | string | obligatorio. PlayerController or Pawn/Character Blueprint (path or bare name). |
context | string | obligatorio. |
priority | integer | Valor predeterminado 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. 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
lowerThreshold | number | Valor predeterminado 0.2. |
upperThreshold | number | Valor predeterminado 1.0. |
type | string | "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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
priority | integer | Valor predeterminado 0. |
addImmediately | boolean | Valor predeterminado true. |
registerWithUserSettings | boolean | 5.3+: also register the context with Enhanced Input User Settings. Valor predeterminado false. |
worldSubsystem | boolean | Valor predeterminado false. |
Devuelve: list, entries, message.
input.add_down (riesgo 2, modifica, smoke)
Adds a Down trigger (fires every frame while actuated).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
actuationThreshold | number | Magnitude 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.
| Argumento | Tipo | Descripción |
|---|---|---|
blueprint | string | obligatorio. |
action | string | obligatorio. |
graph | string | Event graph name. Empty = the main EventGraph. |
x | integer | Valor predeterminado 0. |
y | integer | Valor 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
fOVScale | number | Valor predeterminado 1.0. |
scalingType | string | "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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
holdTimeThreshold | number | Seconds the input must stay actuated. Default 1 (Hold) / 0.5 (HoldAndRelease). Negative = class default. Valor predeterminado -1.0. |
isOneShot | boolean | Hold only: fire once instead of every frame after the threshold. Valor predeterminado false. |
affectedByTimeDilation | boolean | Valor predeterminado false. |
actuationThreshold | number | Valor 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
holdTimeThreshold | number | Seconds the input must stay actuated. Default 1 (Hold) / 0.5 (HoldAndRelease). Negative = class default. Valor predeterminado -1.0. |
isOneShot | boolean | Hold only: fire once instead of every frame after the threshold. Valor predeterminado false. |
affectedByTimeDilation | boolean | Valor predeterminado false. |
actuationThreshold | number | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
blueprint | string | obligatorio. |
key | string | obligatorio. FKey name (a digital key for key events, an axis key for axis-key events). |
graph | string | |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
consumeInput | boolean | Valor predeterminado true. |
executeWhenPaused | boolean | Valor predeterminado false. |
overrideParentBinding | boolean | Valor predeterminado true. |
control | boolean | Modifier requirements (key events only). Valor predeterminado false. |
alt | boolean | Valor predeterminado false. |
shift | boolean | Valor predeterminado false. |
command | boolean | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
blueprint | string | obligatorio. |
name | string | obligatorio. Classic action or axis mapping name from Project Settings. |
graph | string | |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
consumeInput | boolean | Valor predeterminado true. |
executeWhenPaused | boolean | Valor predeterminado false. |
overrideParentBinding | boolean | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
blueprint | string | obligatorio. |
name | string | obligatorio. Classic action or axis mapping name from Project Settings. |
graph | string | |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
consumeInput | boolean | Valor predeterminado true. |
executeWhenPaused | boolean | Valor predeterminado false. |
overrideParentBinding | boolean | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. Input Mapping Context asset (path or bare name). |
action | string | obligatorio. Input Action asset (path or bare name). |
key | string | obligatorio. 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"]. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. Input Mapping Context asset (path or bare name). |
action | string | obligatorio. Input Action of the mapping. |
key | string | obligatorio. FKey name of the mapping. |
className | string | obligatorio. 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. |
Devuelve: asset, description, mappings, note.
input.add_negate (riesgo 2, modifica, smoke)
Adds a Negate modifier (invert X/Y/Z).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
x | boolean | Valor predeterminado true. |
y | boolean | Valor predeterminado true. |
z | boolean | Valor predeterminado true. |
Devuelve: target, behaviour, behaviours, note.
input.add_pressed (riesgo 2, modifica, smoke)
Adds a Pressed trigger (fires once when actuated).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
actuationThreshold | number | Magnitude 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
triggerOnStart | boolean | Valor predeterminado true. |
interval | number | Seconds between pulses. Default 1. Valor predeterminado 1.0. |
triggerLimit | integer | 0 = unlimited. Valor predeterminado 0. |
affectedByTimeDilation | boolean | Valor predeterminado false. |
Devuelve: target, behaviour, behaviours, note.
input.add_released (riesgo 2, modifica, smoke)
Adds a Released trigger (fires once when actuation stops).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
actuationThreshold | number | Magnitude 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
numberOfTaps | integer | Number of taps that trigger. Default 2. Valor predeterminado 2. |
tapReleaseTimeThreshold | number | Valor predeterminado 0.2. |
Devuelve: target, behaviour, behaviours, note.
input.add_response_curve_exponential (riesgo 2, modifica, smoke)
Adds a Response Curve - Exponential modifier.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
curveX | string | CurveFloat asset for X (path or bare name). Empty leaves it unset. |
curveY | string | |
curveZ | string |
Devuelve: target, behaviour, behaviours, note.
input.add_scalar (riesgo 2, modifica, smoke)
Adds a Scalar modifier (per-axis multiplier).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | Input Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset. |
action | string | obligatorio. Input Action (path or bare name). |
key | string | FKey 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | Input Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset. |
action | string | obligatorio. Input Action (path or bare name). |
key | string | FKey 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
smoothingMethod | string | Smoothing method enum name (e.g. Linear, Interp, InterpConstant, InterpCircularIn, ...). Empty keeps the class default. |
speed | number | Valor predeterminado 0.5. |
easingExponent | number | Valor 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
order | string | Axis 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | |
tapReleaseTimeThreshold | number | Release must happen within this many seconds. Default 0.2. Valor predeterminado 0.2. |
actuationThreshold | number | Valor 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | Input Mapping Context (path or bare name). Leave empty together with Key to target the Input Action asset. |
action | string | obligatorio. Input Action (path or bare name). |
key | string | FKey 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. Input Mapping Context asset (path or bare name). |
action | string | obligatorio. Input Action of the mapping. |
key | string | obligatorio. FKey name of the mapping. |
className | string | obligatorio. 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. |
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).
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
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. Valor predeterminado false. |
createMissingActions | boolean | Create Input Actions referenced by name that do not exist yet. Default true. Valor predeterminado true. |
skipDuplicates | boolean | Skip (instead of failing on) mappings that already exist. Default true. Valor predeterminado true. |
mappings | array of UeaInputSpecMapping | obligatorio. |
Devuelve: context, createdActions, mappingsAdded, mappingsSkipped, note.
input.clear_mappings (riesgo 5, modifica, destructivo, smoke)
Removes every mapping from a context.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. 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". Valor predeterminado TEXT("bool"). |
consumeInput | boolean | Whether the action swallows the input so lower-priority mappings do not see it. Default true. Valor predeterminado true. |
description | string | Localised 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).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
folder | string | Default "/Game/Input". |
configName | string | ConfigName (FName) shown to players. Default = asset name. |
displayName | string |
Devuelve: asset, configName, displayName, contexts, note.
input.create_mapping_context (riesgo 2, modifica, smoke)
Creates an empty Input Mapping Context asset in a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Asset name, e.g. "IMC_Default". |
folder | string | Destination content folder. Default "/Game/Input". |
description | string | Localised 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.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Destination folder. Default "/Game/Input". |
actionPrefix | string | Prefix for action assets. Default "IA_". Valor predeterminado TEXT("IA_"). |
contextName | string | Mapping context name. Default "IMC_Default". Valor predeterminado TEXT("IMC_Default"). |
includeGamepad | boolean | Also map gamepad sticks/buttons. Default true. Valor predeterminado true. |
includeCrouch | boolean | Add a Crouch action (Ctrl / gamepad right thumbstick button). Default false. Valor predeterminado false. |
includeFire | boolean | Add a Fire action (left mouse / right trigger). Default false. Valor predeterminado false. |
reuseExisting | boolean | Reuse 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.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Input Action or Mapping Context asset to copy (path or bare name). |
newName | string | obligatorio. Name of the copy, e.g. "IA_Jump_Alt". |
folder | string | Destination 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}).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
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. 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...).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
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". |
Devuelve: matches, contextsSearched.
input.get_action (riesgo 0, smoke)
Value type, consume/pause flags, description and action-level triggers/modifiers of an Input Action.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. 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...).
| Argumento | Tipo | Descripción |
|---|---|---|
filter | string | Substring 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.
| Argumento | Tipo | Descripción |
|---|---|---|
filter | string | Substring 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, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
filter | string | Substring 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).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | Action 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.
| Argumento | Tipo | Descripción |
|---|---|---|
config | string | obligatorio. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
className | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Root folder to search. Default "/Game". |
name | string | Substring of the asset name (case-insensitive). |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
blueprint | string | obligatorio. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Root folder to search. Default "/Game". |
name | string | Substring of the asset name (case-insensitive). |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
worldSubsystem | boolean | Read 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.
| Argumento | Tipo | Descripción |
|---|---|---|
filter | string | Substring filter on the key name or display name (case-insensitive), e.g. "Gamepad", "Mouse". |
limit | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Folder 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. Input Mapping Context asset (path or bare name). |
action | string | obligatorio. Input Action asset (path or bare name). |
key | string | obligatorio. 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).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Destination folder. Default "/Game/Input". |
actionPrefix | string | Valor predeterminado TEXT("IA_"). |
contextName | string | Valor predeterminado TEXT("IMC_Legacy"). |
includeActionMappings | boolean | Valor predeterminado true. |
includeAxisMappings | boolean | Valor predeterminado true. |
removeLegacy | boolean | Remove the classic mappings from Project Settings once converted. Default false. Valor predeterminado false. |
reuseExisting | boolean | Reuse 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
priority | integer | Valor predeterminado 0. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: contexts, message.
input.pie_clear_contexts (riesgo 0, requiere PIE, smoke)
Removes every mapping context from the PIE player.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local 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.
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local 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).
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. |
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). |
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 | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. Axis FKey name, e.g. "MouseX", "Gamepad_LeftY". |
delta | number | obligatorio. |
deltaTime | number | Seconds the delta covers. Default 1/60. Valor predeterminado 1.0 / 60.0. |
numSamples | integer | Valor predeterminado 1. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. FKey name, e.g. "SpaceBar", "Gamepad_FaceButton_Bottom". |
event | string | "pressed" (default), "released", "repeat", "doubleclick" or "tap" (press then release). Valor predeterminado TEXT("pressed"). |
amount | number | Amount depressed for analog buttons. Default 1. Valor predeterminado 1.0. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local 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.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local 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.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local 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).
| Argumento | Tipo | Descripción |
|---|---|---|
profileId | string | Key profile id. Empty = active profile. |
filter | string | Filter on mapping name (substring). |
playerIndex | integer | Valor 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).
| Argumento | Tipo | Descripción |
|---|---|---|
mappingName | string | obligatorio. 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. Valor predeterminado TEXT("First"). |
profileId | string | Key profile id. Empty = active profile. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
unregister | boolean | Unregister instead. Valor predeterminado false. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
priority | integer | Valor predeterminado 0. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
mappingName | string | obligatorio. 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. Valor predeterminado TEXT("First"). |
profileId | string | Key profile id. Empty = active profile. |
playerIndex | integer | Valor 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).
| Argumento | Tipo | Descripción |
|---|---|---|
apply | boolean | Apply the settings to the live player input before saving. Default true. Valor predeterminado true. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
profileId | string | obligatorio. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local 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.
| Argumento | Tipo | Descripción |
|---|---|---|
mappingName | string | obligatorio. 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. Valor predeterminado TEXT("First"). |
profileId | string | Key profile id. Empty = active profile. |
playerIndex | integer | Valor 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.
| Argumento | Tipo | Descripción |
|---|---|---|
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). |
Devuelve: key, handledDown, handledUp, charactersTyped, message.
input.remove_action_mapping (riesgo 4, modifica)
Removes a classic Action Mapping matching Name + Key + modifier keys.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Action mapping name, e.g. "Jump". |
key | string | obligatorio. FKey name, e.g. "SpaceBar". |
shift | boolean | Valor predeterminado false. |
ctrl | boolean | Valor predeterminado false. |
alt | boolean | Valor predeterminado false. |
cmd | boolean | Valor predeterminado false. |
Devuelve: actionMappings, axisMappings, message.
input.remove_action_mappings (riesgo 2, modifica, smoke)
Removes every mapping of one action from a context.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
action | string | obligatorio. |
Devuelve: asset, description, mappings, note.
input.remove_action_modifier (riesgo 2, modifica, smoke)
Removes the modifier at Index from the Input Action asset.
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. |
index | integer | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. |
index | integer | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
actionMappings | boolean | Valor predeterminado true. |
axisMappings | boolean | Valor predeterminado true. |
Devuelve: actionMappings, axisMappings, message.
input.remove_axis_mapping (riesgo 4, modifica)
Removes a classic Axis Mapping matching Name + Key + Scale.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Axis mapping name, e.g. "MoveForward". |
key | string | obligatorio. FKey name, e.g. "W" or "Gamepad_LeftY". |
scale | number | Axis 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.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
worldSubsystem | boolean | Valor predeterminado false. |
Devuelve: list, entries, message.
input.remove_input_event (riesgo 3, modifica, destructivo)
Removes an input event node (by GUID) from a Blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
blueprint | string | obligatorio. |
nodeGuid | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
key | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. Input Mapping Context asset (path or bare name). |
action | string | obligatorio. Input Action asset (path or bare name). |
key | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. Input Mapping Context asset (path or bare name). |
action | string | obligatorio. Input Action of the mapping. |
key | string | obligatorio. FKey name of the mapping. |
index | integer | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. Input Mapping Context asset (path or bare name). |
action | string | obligatorio. Input Action of the mapping. |
key | string | obligatorio. FKey name of the mapping. |
index | integer | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Input Action or Mapping Context asset (path or bare name). |
newName | string | obligatorio. New asset name. |
folder | string | Destination 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.
| Argumento | Tipo | Descripción |
|---|---|---|
kind | string | obligatorio. "action" or "axis". |
name | string | obligatorio. |
newName | string | obligatorio. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | FKey name of the mapping. Empty = action-level behaviour. |
index | integer | obligatorio. |
newIndex | integer | obligatorio. |
Devuelve: target, behaviour, behaviours, note.
input.reorder_trigger (riesgo 2, modifica, smoke)
Moves a trigger from Index to NewIndex. Key empty = action-level.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | FKey name of the mapping. Empty = action-level behaviour. |
index | integer | obligatorio. |
newIndex | integer | obligatorio. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. |
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. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. |
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. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
action | string | obligatorio. 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. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. 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". |
Devuelve: entries, message.
input.set_axis_mapping_scale (riesgo 4, modifica)
Changes the scale of one classic axis mapping (Name + Key + current Scale -> NewScale).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
key | string | obligatorio. |
scale | number | Current scale of the mapping to change (a name+key pair may exist with several scales). Default 1. Valor predeterminado 1.0. |
newScale | number | obligatorio. |
Devuelve: actionMappings, axisMappings, message.
input.set_context_description (riesgo 2, modifica, smoke)
Sets the description (and optionally other properties) of a Mapping Context.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
description | string | |
properties | array of UeaKeyValue | Any 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.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
config | string | obligatorio. PlayerMappableInputConfig asset (path or bare name). |
context | string | obligatorio. |
priority | integer | Valor predeterminado 0. |
remove | boolean | Remove 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
action | string | obligatorio. |
key | string | obligatorio. Current FKey name of the mapping. |
newKey | string | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
action | string | obligatorio. |
key | string | obligatorio. |
behavior | string | "inherit" (from the action, default), "override" (own settings on this mapping) or "ignore" (not player mappable). Valor predeterminado TEXT("inherit"). |
name | string | Used with "override". |
displayName | string | |
displayCategory | string |
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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | FKey name of the mapping. Empty = action-level behaviour. |
index | integer | obligatorio. Index in the Modifiers/Triggers array. |
properties | array of UeaKeyValue | obligatorio. 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | |
action | string | obligatorio. |
key | string | FKey name of the mapping. Empty = action-level behaviour. |
index | integer | obligatorio. Index in the Modifiers/Triggers array. |
properties | array of UeaKeyValue | obligatorio. 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.
| Argumento | Tipo | Descripción |
|---|---|---|
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. |
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).
| Argumento | Tipo | Descripción |
|---|---|---|
blueprint | string | obligatorio. PlayerController or Character/Pawn Blueprint (path or bare name). |
context | string | obligatorio. Input Mapping Context asset to assign. |
variableName | string | Name of the object variable created on the Blueprint. Default "DefaultMappingContext". Valor predeterminado TEXT("DefaultMappingContext"). |
priority | integer | Priority value stored in an int variable "DefaultMappingPriority" next to it (created when bCreatePriorityVariable). Valor predeterminado 0. |
createPriorityVariable | boolean | Also 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).
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. |
index | integer | obligatorio. 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. |
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.
| Argumento | Tipo | Descripción |
|---|---|---|
context | string | obligatorio. Input Mapping Context asset (path or bare name). |
Devuelve: context, valid, errors, warnings, issues.