Kit edit
266 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
Editor essentials every other kit assumes: server info and undo/redo, reflection over any object,
Play-In-Editor control with input injection, the level viewport and selection, console variables
and rendering, log capture, ini/settings classes, plugins and the project descriptor. The kit is
split over nine classes (UUeaKit_Edit, _EditCheckpoint, _EditObject, _EditPlay, _EditView,
_EditConsole, _EditConfig, _EditTools, _EditWorkflow) that all register as kit edit; the
tools are spread over eleven prefixes. Content-browser asset tools (asset.* / import.*) live in
the asset kit (see Docs/guides/asset.md); the only asset. tool of this kit is asset.preview.
| Prefix | Tools | What it covers |
|---|---|---|
edit. | 67 | ping/discovery, undo/redo/transactions, checkpoints and rollback, workflows, level load/save/build, world settings, editor utilities, automation tests, Live Coding, source control, actor selection, batched calls |
object. | 22 | read/write any reflected property on any object or CDO, diff/copy/reset, call UFUNCTIONs, class/enum/struct introspection |
play. | 41 | PIE start/stop/status, actor state and function calls, spawn/teleport/possess, key/axis/mouse injection, frame stepping, traces, stats, players/worlds, widgets, captures |
view. | 33 | level viewport camera, view modes, show flags, realtime/game view, bookmarks, projection, visible actors, pilot, snapping, screenshots, before/after captures |
asset. | 1 | asset.preview (thumbnail image of any asset) |
console. | 10 | console commands with captured output, cvars get/set/search/persist |
render. | 13 | scalability, screen percentage, AA, shadows, Lumen/Nanite/GI/reflection method, ray tracing, vsync, max FPS |
log. | 12 | editor log read, categories/verbosity, in-memory capture with markers, log file markers |
settings. | 21 | settings.get/set, raw ini files (get/set/search/diff/flush), settings classes (schema, get_many/set_many, save/reload/reset) |
project. | 22 | project info/paths/descriptor/version, default maps and game mode classes, modules/targets/maps/platforms, capabilities, text files, header search |
plugin. | 13 | list/find/info, enable/disable, dependencies/dependents, content plugins, modules, .uplugin descriptor edits |
276 tools in total on UE 5.x (272 on 4.27). Every tool takes JSON arguments named after the C++ struct fields in camelCase
without the b prefix (bRecursive -> recursive). Asset references accept an object path
(/Game/Folder/Asset.Asset), a package path (/Game/Folder/Asset) or a unique bare name.
Start here
edit.ping-> engine version, project and tool count.edit.get_state-> PIE, active transaction, dirty packages, selection, builds, focus.project.info/project.get_capabilities-> current map, default game mode/maps, plugins, Nanite/Lumen/ray tracing availability, kits and tool count.edit.search_tools {query:"screenshot viewport"}finds tools by words in name + description;edit.get_tool_schema {tool:"asset.rename_many"}gives the full input/output JSON schema;edit.get_tool_countsshows counts per prefix/kit and how many tools are hidden on this engine.
Tools
edit. (server, transactions, level, utilities, tests, discovery)
| Tool | Purpose |
|---|---|
edit.ping / edit.list_kits / edit.get_state | Server + engine + project identification; loaded kits with tool names; editor state at a glance. |
edit.undo / edit.redo (steps) / edit.history (limit) / edit.undo_to_index / edit.get_undo_state | Undo/redo N transactions, list the history (newest first), jump to a history index, counts and next titles. |
edit.begin_transaction {title} / edit.end_transaction / edit.cancel_transaction | Group the following calls into one undo step, or throw them all away. |
edit.reset_undo_buffer | Clears the undo/redo buffer (destructive, cannot be undone). |
edit.load_map {map, saveCurrent} / edit.new_map {template, savePath} / edit.save_map {savePath, saveAll} | Open, create (blank or from a template) and save the current level. |
edit.get_map_info / edit.list_streaming_levels / edit.set_streaming_level {level, loaded, visible} | Level summary (actors, class counts, streaming levels, bounds, lighting state); sub-level load/visibility (-1 keeps, 0/1 sets). |
edit.get_world_settings {properties} / edit.set_world_settings {values} | World Settings of the current level (game mode override, gravity, kill Z...). |
edit.build {type, quality} / edit.is_building / edit.get_lighting_info | Builds: lighting (preview/medium/high/production), geometry, visible_geometry, navigation, hlod, all; lighting state and light counts. |
edit.get_level_bounds / edit.map_check | Bounding box of every actor; Map Check errors/warnings per actor. |
edit.run_utility_widget / edit.close_utility_widget / edit.run_utility_blueprint | Editor Utility Widgets as tabs; run an Editor Utility Blueprint. |
edit.run_editor_function {class, function, args} | Call a static/BlueprintCallable function on a class CDO (function libraries, editor utilities). |
edit.show_notification {message, type, duration} | Toast in the editor (info/success/fail). |
edit.list_dirty_packages / edit.set_background_throttling {enabled} | Unsaved packages; disable "use less CPU in background" for unattended PIE runs. |
edit.gc {fullPurge} / edit.get_memory | Force garbage collection; process memory and object counts. |
edit.list_tests {contains, filter, limit} / edit.run_test {test, maxFrames} / edit.run_tests {test, maxTests, stopOnFailure} / edit.get_test_results | Automation tests: list (smoke/engine/product/perf/stress/negative), run one synchronously, run every match, re-read the last results. |
edit.live_coding_status / edit.live_coding_enable {enabled} / edit.live_coding_compile {waitFrames} | Live Coding (Windows): state, enable for the session, compile and wait. |
edit.sc_info / edit.sc_checkout {files} / edit.sc_add / edit.sc_revert | Source control on arbitrary files (/Game/... paths are converted to package files). |
edit.select_actors {actors, class, nameContains, tag, layer, folder, add} / edit.deselect_actors / edit.select_all {class} / edit.invert_selection / edit.clear_selection / edit.get_selected_actors | Editor actor selection by name list or filters. |
edit.select_component {actor, component, add} / edit.save_selection {slot} / edit.restore_selection {slot} | Details-panel component selection; named selection slots. |
edit.search_tools {query, kit, limit} / edit.get_tool_schema {tool} / edit.get_tool_counts | Tool discovery: word search, full JSON schema (with availableOnThisEngine), counts. |
edit.call_many {calls:[{tool, argsJson}], stopOnError, atomic} | Runs several tools in sequence in one round trip; per-call ok, resultJson, milliseconds. atomic:true takes an implicit checkpoint and, when a call fails, rolls every earlier call back (rolledBack, rollback report). |
edit.checkpoint_create {name, note, replace, withPreview} / edit.checkpoint_list / edit.checkpoint_diff {name} / edit.checkpoint_delete {name} | Named positions in the undo history (session only): what changed since (transactions, newly dirty packages, mutating calls, what cannot be undone). withPreview stores a 256 px viewport capture. |
edit.checkpoint_rollback {name, dryRun} | Undoes every transaction after the checkpoint, newest first; lists undone titles and issues it cannot revert (saved_to_disk, missing_on_disk, non_undoable_call, inside_active_transaction, history_reset, undo_failed, behind_checkpoint). |
edit.list_workflows {category} / edit.get_workflow {id} / edit.validate_workflow {id | json, arguments} / edit.run_workflow {id | json, arguments, atomic, dryRun, runCleanup} | Cross-kit recipes (JSON, Resources/Workflows + <Project>/Saved/UEAMCP/Workflows); also served as MCP prompts. |
object. (reflection over anything)
Object references: full object path, asset path or unique name, cdo:<Class> / class:<Class>
(class default object of a native class or Blueprint), actor:<Label> (PIE world when running,
else editor world), settings:<Class> (a config/settings CDO). Property paths support nesting,
components, arrays and maps: Movement.MaxWalkSpeed, Items[2].Name, RootComponent.RelativeLocation.X, MyMap[KeyName].
| Tool | Purpose |
|---|---|
object.resolve {object} | Resolves a reference and describes it (class, outer, package, CDO/asset/actor flags). |
object.list_properties {object, contains, category, editableOnly, includeInherited, maxValueLength} | Reflected properties with type, category, flags, tooltip and value. |
object.get_property {object, property} / object.get_properties {object, properties} | One or many values by path. |
object.set_property {object, property, value} / object.set_properties {object, values} | Write from text (ImportText rules: structs (X=1,Y=2), arrays (a,b,c), objects by full path); runs PostEditChange. |
object.reset_property / object.diff_from_default {object, other} / object.copy_properties {source, target, properties, editableOnly} | Reset to archetype; list overrides vs CDO (or another object); copy between compatible objects. |
object.get_container_size / object.array_add {object, property, value, index} / object.array_remove {index} / object.array_clear | Array property editing. |
object.call_function {object, function, args:[{key, value}]} / object.list_functions {object, contains, callableOnly} | Call any UFUNCTION with text args (statics on cdo:<Class>); returns return value + out params. |
object.get_class_info {class} / object.list_subclasses {class, nativeOnly, concreteOnly} / object.find {class, contains, pathContains, skipDefaults} | Class ancestry/interfaces/module; loaded subclasses; loaded objects (TObjectIterator). |
object.get_property_metadata {class, property} / object.get_enum_values {class} / object.get_struct_fields {class} | ClampMin/Categories/AllowedClasses...; enum names and numeric values; struct fields with types. |
object.export_text {object} | T3D text export as the editor copies it. |
play. (Play-In-Editor)
| Tool | Purpose |
|---|---|
play.start {map, mode:viewport|window, players, dedicatedServer} / play.stop / play.status | Start (session begins on the next editor tick), stop, running/paused/map/pawn/location. |
play.start_simulate / play.toggle_simulate / play.toggle_pause / play.set_paused {paused} | Simulate-In-Editor, possess/eject, pause. |
play.exec_console {command} | Console command in PIE (editor when not running); prefer console.exec for captured output. |
play.list_actors {class, name, limit} / play.get_actor {actor, property} / play.get_actor_components {actor} / play.find_actors_by_tag {tag} / play.actors_near_player {radius, class} | Live actor queries (Component.Property paths work). Without PIE they read the editor world. |
play.set_actor_property {actor, property, value} / play.call_function {actor, component, function, args} | Write live state; call a UFUNCTION on an actor or one of its components. |
play.spawn_actor {class, location, rotation, label, properties} / play.destroy_actor {actor} | Spawn (with properties applied) and destroy in the running world. |
play.teleport_player {location, rotation, playerIndex} / play.teleport_actor {actor, location, rotation, scale, sweep} | Move the pawn or any actor. |
play.possess {pawn} / play.unpossess / play.set_view_target {actor, blendTime} | Possession and camera view target. |
play.press_key {key} / play.release_key / play.tap_key {key, holdFrames} | Key injection through the player controller (press stays down until release). |
play.set_axis {key, value, frames} / play.mouse_delta {deltaX, deltaY, frames} | Axis and mouse deltas fed for N frames (each frame is ticked). |
play.is_key_pressed {key} / play.get_input_state | Current key state / every pressed key with value. |
play.advance_frames {frames, deltaSeconds} | Tick N frames with a fixed delta (1-600) instead of waiting. |
play.get_stats | FPS, game/render/RHI/GPU ms, draw calls, memory, object/actor counts, boundBy. |
play.line_trace {fromCamera, start, end, distance, channel, ignorePlayer} | Trace from the player camera (or explicit points) with hit actor/component/normal. |
play.get_player_state {playerIndex} / play.list_players / play.list_worlds / play.get_game_mode_info | Controller/pawn/velocity/movement mode; every player controller (multiplayer PIE); world contexts with net mode; game mode/state classes and match state. |
play.get_visible_widgets {textOnly, visibleOnly} | User widgets on screen with names, classes, texts, visibility. |
play.set_time_dilation {value} / play.get_time_dilation | Global time dilation (0.0001-20). |
play.screenshot {savePath, maxSize} / play.screenshot_from_actor {actor, width, height, fov} | PNG of the PIE viewport; render from an actor's camera component (or transform). |
view. (level viewport)
| Tool | Purpose |
|---|---|
view.get_info / view.get_camera / view.set_camera {location, rotation | lookAt | focusActor} | Full viewport state (plus every other viewport); camera pose; move or frame. |
view.set_view_mode {mode} | lit, unlit, wireframe, detail_lighting, lighting_only, shader_complexity, lightmap_density, lod_coloration, path_tracing, buffer_visualization... or a VMI_* name. |
view.get_show_flags {contains, enabledOnly} / view.set_show_flag {flag, enabled} | Engine show flags (Grid, Bounds, Collision, Navigation, Fog, PostProcessing...). |
view.set_realtime {enabled} / view.set_game_view / view.set_immersive | Realtime rendering (needed for Niagara/animation previews), hide editor icons, maximise. |
view.set_fov {fov} / view.set_type {type} / view.set_ortho_zoom {zoom} / view.set_clip_planes {near, far, clearFar} / view.set_camera_speed {setting, scalar} | FOV, perspective/top/front/..., ortho zoom, clip planes, fly speed notch 1-8. |
view.set_bookmark {index} / view.jump_to_bookmark / view.clear_bookmark / view.list_bookmarks | Camera bookmarks 0-9 stored in the level. |
view.focus_actors {actors, instant} / view.focus_point {location, distance} / view.pilot_actor {actors} / view.eject_pilot | Frame actors or a point; lock the camera to an actor. |
view.world_to_screen {position} / view.screen_to_world {u, v, trace, distance} / view.get_visible_actors {class, includeHidden} | Projection both ways (normalised 0..1, origin top-left); actors in the frustum nearest first with screen coordinates. |
view.get_snap / view.set_snap {gridSnap, rotationSnap, scaleSnap, surfaceSnap, gridSizeIndex, ...} | Snapping toggles and grid indices (-1 keeps). |
view.set_active_viewport {index} / view.redraw | Pick the active viewport (index from view.get_info); redraw all. |
view.screenshot {maxSize, width, height, frameActors, showFlags, format, savePath} | Canonical capture: active level viewport (PIE viewport while playing) as PNG/JPG, optionally framed on actors and with temporary show flags (both restored). |
view.capture_compare {checkpoint, format} / asset.preview {asset, size, format} | Before/after pair for a checkpoint created with withPreview:true (+ changedPixelRatio); thumbnail of any asset. |
view.screenshot_from {location, rotation | lookAt, fov, gameView} / view.screenshot_editor {maxSize} | PNG from a temporary camera pose (restored afterwards); the whole editor window with Slate UI. |
console. and render.
| Tool | Purpose |
|---|---|
console.exec {command, world:auto|editor|pie} / console.exec_many {commands} | Run commands and get what they printed (stat, obj list, help, cvar queries). |
console.get_cvar {name} / console.set_cvar {name, value} / console.get_many {names} / console.set_many {variables, persist, iniFile, section} | Value, type, help, flags and setBy layer; set with SetByConsole priority (previous value returned); persist:true writes [ConsoleVariables] in Default |
console.search {query, includeCommands} / console.list_prefix {query} / console.list_commands / console.list_categories | Discover cvars by substring or prefix (r.Shadow.), commands only, prefix categories with counts. |
render.get_scalability / render.set_scalability {group, level, resolutionQuality, persist} | Per-group levels (-1 = group missing on this engine); set one group or all to 0-4 / low..cinematic, optionally into GameUserSettings.ini. |
render.get_settings | Snapshot of the common rendering cvars, AA method, screen percentage, RHI, adapter, GI/reflection method, Nanite. |
render.set_screen_percentage {value} / render.set_anti_aliasing {method} / render.set_shadow_quality {maxResolution, maxCascades, distanceScale, qualityLevel} / render.set_vsync {enabled} / render.set_max_fps {value} | Runtime cvars (AA: none, fxaa, taa, msaa, tsr). |
render.set_lumen {globalIllumination, reflections, hardwareRayTracing, qualityLevel} / render.set_nanite {enabled, maxPixelsPerEdge} / render.set_gi_method {method} / render.set_reflection_method {method} (5.0+) | UE 5 features; GI: none/lumen/ssgi/plugin, reflections: none/lumen/ssr. |
render.set_ray_tracing {enabled} | Project setting (restart required) plus the runtime toggle where available. |
log.
| Tool | Purpose |
|---|---|
log.read {lines, contains} | Last lines of the editor log. |
log.list_categories {contains} / log.get_verbosity {category} / log.set_verbosity {category, verbosity} | Categories and verbosity (NoLogging ... VeryVerbose, All). |
log.start_capture / log.stop_capture / log.clear_capture / log.get_marker | In-memory capture of every line (category, verbosity, message); the marker is the current index. |
log.read_capture {sinceIndex, category, minVerbosity, contains, regex, limit} | Captured entries after an index; reply carries lastIndex, error and warning counts. |
log.write {message, verbosity} | Write a line to the Output Log (marker between test steps). |
log.get_file_marker / log.read_file_since {marker, contains, regex} | Line count of the log file on disk; lines written after it. |
settings.
| Tool | Purpose |
|---|---|
settings.get {section, property} / settings.set {section, property, value} | Any settings class by name (GameMapsSettings, InputSettings, RendererSettings, any UDeveloperSettings); set writes the Default*.ini. Object values use full paths (/Game/Core/BP_GameMode.BP_GameMode_C). |
settings.list_containers / settings.list_categories {container} / settings.list_sections {container, category} / settings.list_classes {contains, container, category} | The Project/Editor settings tree as the settings windows show it, down to class names. |
settings.get_class_schema {section, includeValues, configOnly, category} | Properties of a settings class with type, tooltip, enum values and current value. |
settings.get_many {section, properties} / settings.set_many {section, values} | Several properties at once (set_many saves the ini). |
settings.save {section} / settings.reload {section} / settings.reset_to_defaults {section} | Save after object.set_property on settings:<Class>; discard in-memory edits; remove the project overrides (destructive). |
settings.list_files | Config branches (Engine, Game, Input, Editor, ...) with project Default*.ini and user files. |
settings.get_ini {file, section, key} / settings.set_ini {file, section, key, value, writeDefault} / settings.remove_ini_key | Raw ini values as the engine resolves them (all layers merged); write to memory + Default |
settings.get_ini_section {file, section} / settings.list_ini_sections {file, contains} / settings.search_ini {query, file} / settings.diff_from_default {file, sectionContains} / settings.flush {file} | Whole sections, section names, full-text search, project-vs-engine-Base diff, flush a branch to disk. |
project. and plugin.
| Tool | Purpose |
|---|---|
project.info / project.get_paths / project.get_build_info / project.get_capabilities | Name/map/defaults/plugins; every project and engine directory + log file; engine version/changelist/branch/RHI/compiler; feature detection (UE5, Nanite, Lumen, ray tracing, World Partition, Chaos, Enhanced Input, source control, Live Coding). |
project.get_descriptor / project.set_descriptor_field {field, value} | The .uproject (engine association, modules, plugin references, target platforms); edit Category, Description or EngineAssociation. |
project.get_version / project.set_version {projectName, projectVersion, companyName, ...} | GeneralProjectSettings fields in DefaultGame.ini (only non-empty fields applied). |
project.get_default_maps / project.set_default_maps {gameDefaultMap, editorStartupMap, serverDefaultMap, transitionMap, globalDefaultGameMode, globalDefaultServerGameMode, gameInstanceClass} | GameMapsSettings in DefaultEngine.ini (only non-empty fields applied). |
project.set_game_mode_classes {gameMode, defaultPawnClass, playerControllerClass, hudClass, gameStateClass, playerStateClass, spectatorClass, save} | Default classes on a GameMode class or Blueprint. |
project.list_modules / project.list_targets / project.list_maps {folder, includeEngine} / project.list_platforms | Game modules with loaded state; *.Target.cs; level assets + cook list; platforms with SDK/support flags. |
project.read_file {path, maxChars} / project.write_file {path, content, append} / project.list_files {directory, pattern, recursive} / project.rename_file {path, newPath} / project.delete_file {path} | Text files inside the project (read also inside the engine). Never touches .uasset/.umap. |
project.search_headers {pattern, regex, pathContains, engine, project, contextLines, limit} / project.find_class_header {class} | Grep over engine + project headers; the declaration block of a class. |
plugin.list {contains, includeEngine, enabledOnly, contentOnly} / plugin.find {plugin} / plugin.get_info {plugin} | Discovered plugins with enabled state, version, category, origin; full descriptor, modules, dependencies. |
plugin.set_enabled {plugin, enabled, save} | Writes the .uproject; reply has restartRequired:true. |
plugin.get_dependencies {plugin, recursive} / plugin.get_dependents {plugin} / plugin.for_asset {asset} / plugin.list_content_plugins / plugin.list_modules {plugin} | Dependency graph with found/active flags; which plugin mounts a path; /PluginName/ mount points; modules with loading phase. |
plugin.get_descriptor_json / plugin.set_descriptor_field {plugin, field, value} / plugin.add_dependency {plugin, dependency, enabled, optional} / plugin.remove_dependency | Raw and field-level .uplugin edits. |
Recipe: inspect and edit any object property
object.resolve {object:"cdo:/Game/BP/BP_Enemy"}(oractor:Enemy_3,settings:RendererSettings,/Game/Data/DT_Items.DT_Items) to confirm what you are pointing at.object.list_properties {object:"cdo:BP_Enemy", editableOnly:true, contains:"Health"}for exact names and types;object.get_property_metadata {class:"BP_Enemy", property:"MaxHealth"}for ClampMin/ClampMax.object.set_property {object:"cdo:BP_Enemy", property:"MaxHealth", value:"250"}or several withobject.set_properties {values:[{key:"MaxHealth", value:"250"}, {key:"Mesh.RelativeScale3D", value:"(X=2,Y=2,Z=2)"}]}.object.diff_from_default {object:"cdo:BP_Enemy"}shows every override;asset.save {asset:"BP_Enemy"}writes the Blueprint. For a settings CDO finish withsettings.save {section:"RendererSettings"}instead.
Recipe: batch calls in one round trip
edit.call_many {
"calls": [
{"tool": "edit.begin_transaction", "argsJson": "{\"title\":\"Rename actor\"}"},
{"tool": "object.set_property", "argsJson": "{\"object\":\"actor:Door_1\",\"property\":\"IsOpen\",\"value\":\"True\"}"},
{"tool": "edit.end_transaction", "argsJson": "{}"}
],
"stopOnError": true
}
argsJson is a JSON object string; each result carries ok, resultJson and milliseconds.
Wrap the batch in edit.begin_transaction {title:"..."} ... edit.end_transaction when the user
should be able to undo it in one step. See Docs/guides/asset.md for an asset-import batch.
Recipe: checkpoint, try, roll back
edit.checkpoint_create {name:"before-lighting", withPreview:true}(fails if the name exists;replace:trueoverwrites). It records the undo position, dirty packages and a 256 px capture.- Do the work with any tools. Each mutating reply carries
undoable(false for tools that write files, save/delete packages on disk or write config: those areNonUndoable). edit.checkpoint_diff {name:"before-lighting"}lists the transactions, newly dirty packages and mutating calls since;view.capture_compare {checkpoint:"before-lighting"}returns the before/after images andchangedPixelRatio.- Keep it (
edit.checkpoint_delete) or undo it all:edit.checkpoint_rollback {name:"before-lighting", dryRun:true}first, then withoutdryRun. Readrollback.issues:saved_to_disk(the file keeps the saved content),missing_on_disk,non_undoable_call,history_reset(a map load or asset deletion cleared the undo buffer),inside_active_transaction.
For a single batch use edit.call_many {atomic:true, calls:[...]}: the first failed call rolls every
earlier call back (rolledBack, rollback). Atomic batches, workflows and rollbacks refuse to run
while edit.begin_transaction (or any editor transaction) is open. Atomic batches and atomic
workflows also refuse up front (nothing runs) when a call or main step is a NonUndoable tool
(saves, asset deletes, file writes); run those separately or with atomic:false. A checkpoint
rollback with a non_undoable_call issue never reports complete:true.
Recipe: see what a call did (_preview)
Add "_preview" to the arguments of any tool; it is not part of any schema and is stripped before
the tool runs.
actor.spawn_mesh {mesh:"/Engine/BasicShapes/Cube", name:"Crate_1", _preview:"viewport"}-> the reply gets an image of the level viewport framed on the changed actors (or the selection) pluspreview {kind, subject, width, height}; the camera is restored afterwards.material.set_settings {..., _preview:"asset"}-> the thumbnail of the first changed asset._preview:"auto"picks asset for asset changes and viewport for level changes.- On failure you get
previewError(no viewport in unattended/-nullrhi runs, asset without a thumbnail renderer) and the tool result is unchanged. During PIE the play viewport is captured. - Direct captures:
view.screenshot {width:640, height:360, frameActors:["Crate_1"], showFlags:{"Grid":false}, format:"jpg"}andasset.preview {asset:"/Game/Materials/M_Rock", size:256}.
Recipe: run a workflow
edit.list_workflows(or MCPprompts/list) -> ids, arguments with defaults, availability on this engine.edit.get_workflow {id}shows the JSON and the exact step list as prompt text.edit.validate_workflow {id:"actor.blockout_basic", arguments:{prefix:"Block"}}checks tools, argument names against schemas, plugins/min engine and${...}substitutions.edit.run_workflow {id:"actor.blockout_basic", arguments:{prefix:"Block"}, dryRun:true}lists the resolved steps; run it withoutdryRun(and with_preview:"viewport"for a final image). Atomic by default: a failed step rolls everything back; the checkpointworkflow:<id>stays soedit.checkpoint_rollback {name:"workflow:actor.blockout_basic"}can undo a successful run later.runCleanup:trueruns the workflow's cleanup steps (they may delete assets on disk).
Workflow files: {id, title, description, category, minEngine, requiresPlugins[], arguments[{name, type, description, default}], steps[{id, tool, args, expect?, optional?}], verify[{tool, args, expect}], cleanup[...]}. ${arg} and ${stepId.field.path} are substituted (a string that is only
one token keeps the value's JSON type); expect maps reply paths to values ("*" = present and not
empty). Put your own in <Project>/Saved/UEAMCP/Workflows/*.json (same id overrides a shipped one).
Recipe: PIE test loop with input injection, screenshots and log markers
asset.save_all,edit.set_background_throttling {enabled:false},log.start_capture.play.start {map:"/Game/Maps/Arena", mode:"viewport"}thenplay.statusuntilrunning:true(the session starts on the next tick);play.advance_frames {frames:30}lets BeginPlay settle.log.write {message:"STEP jump"}andmark = log.get_markerbefore each step, then drive the player:play.tap_key {key:"SpaceBar", holdFrames:5},play.set_axis {key:"Gamepad_LeftY", value:1, frames:60},play.mouse_delta {deltaX:200, frames:10}, orplay.call_function {actor:"BP_Player_C_0", function:"Fire"}.- Observe:
play.get_player_state(velocity, movement mode, falling),play.get_actor {actor:"Door_1", property:"IsOpen"},play.line_trace,play.get_visible_widgets {textOnly:true},play.screenshot. log.read_capture {sinceIndex:mark, minVerbosity:"Warning"}for errors since the marker (regexfor patterns);play.get_statsfor frame time andboundBy.play.stop, thenlog.stop_capture. Stop PIE before editing Blueprints again.
play.press_key keeps the key down until play.release_key; play.set_axis / mouse_delta tick
one frame per step. Enhanced Input actions can also be driven with input.pie_inject_action.
Recipe: config and scalability change
- Quick cvar:
console.set_cvar {name:"r.ScreenPercentage", value:"75"}(runtime only) orconsole.set_many {variables:[{key:"r.Shadow.MaxResolution", value:"4096"}], persist:true}to write[ConsoleVariables]in DefaultEngine.ini. - Quality:
render.set_scalability {group:"Shadow", level:"epic"}or{group:"all", level:2, persist:true};render.set_anti_aliasing {method:"tsr"},render.set_lumen {globalIllumination:true, reflections:true}(5.0+). - Project setting:
settings.get_class_schema {section:"RendererSettings", category:"Lumen"}to find the exact property, thensettings.set {section:"RendererSettings", property:"bSupportSkyAtmosphere", value:"True"}orsettings.set_many.settings.diff_from_default {file:"Engine"}shows every project override afterwards. - Raw ini:
settings.search_ini {query:"MaxFPS"}->settings.set_ini {file:"Engine", section:"/Script/Engine.RendererSettings", key:"...", value:"..."}. - Game defaults:
project.set_default_maps {gameDefaultMap:"/Game/Maps/Arena", globalDefaultGameMode:"/Game/Core/BP_GameMode.BP_GameMode_C"}.
Recipe: enable a plugin
plugin.find {plugin:"Niagara"}-> exact name and whether it is already enabled;plugin.get_dependencies {plugin:"MyPlugin", recursive:true}lists prerequisites withfound/activeflags.plugin.set_enabled {plugin:"MyPlugin", enabled:true}writes the .uproject; the reply saysrestartRequired:true. Modules load only after the editor restarts, so tell the user to restart before using content or classes from the plugin (plugin.list_modulesshowsloaded:falseuntil then).- After the restart:
project.get_capabilities/plugin.list_content_pluginsto confirm the mount point.
Recipe: run automation tests
edit.list_tests {contains:"Project.Functional", filter:"product"}-> full test paths.edit.run_test {test:"Project.Functional.Doors.OpenClose", maxFrames:3000}runs synchronously, pumping latent commands, and returns pass/fail, duration, frames used and every event with file/line.edit.run_tests {test:"Project.Functional", maxTests:20, stopOnFailure:true}for a suite;edit.get_test_resultsre-reads the last run. Pair withlog.get_marker/log.read_captureto collect warnings emitted during the run.
Recipe: level and lighting
edit.load_map {map:"/Game/Maps/Arena", saveCurrent:true};edit.get_map_infofor actor counts, streaming levels, bounds andunbuiltLightingObjects.edit.set_world_settings {values:[{key:"DefaultGameMode", value:"BP_GameMode"}, {key:"KillZ", value:"-5000"}]}.edit.build {type:"lighting", quality:"preview"}and polledit.is_building;edit.get_lighting_infoafterwards.edit.map_checkfor actor errors;view.focus_actors {actors:["BadActor_1"]}+view.screenshotto show them.edit.save_map {saveAll:true}.
Gotchas
- Everything runs on the editor game thread, synchronously: long tools (
edit.build,edit.run_tests,play.advance_frameswith many frames,edit.live_coding_compile, deepasset.get_dependencieswalks,project.search_headers) block the editor until they return. Keepframes,maxDepth,maxFramesandlimitreasonable;edit.buildreturns as soon as the build has started, so polledit.is_building. - Tools marked
Mutatesin the schema run inside an editor transaction and are undoable withedit.undo;edit.begin_transactiongroups several into one step andedit.cancel_transactionreverts them. Not transactional:settings.*,console.set_*withpersist,plugin.*,project.write_file/set_*(they write ini, .uproject or .uplugin files directly),play.*runtime state, source control (asset.checkout/revert,edit.sc_*) and file imports on disk. - Destructive tools:
asset.delete,asset.delete_many(force:truenulls references),asset.delete_folder,asset.consolidate,asset.revert,edit.sc_revert,edit.reset_undo_buffer(cannot be undone),settings.remove_ini_key,settings.reset_to_defaults,project.delete_file.asset.deleterefuses while referencers exist; checkasset.get_referencersfirst. - MinEngine-gated tools are hidden on older engines:
render.set_lumen,render.set_nanite,render.set_gi_method,render.set_reflection_methodneed UE 5.0+.edit.get_tool_schemareportsavailableOnThisEngine;render.get_scalabilityreturns-1for groups the engine lacks (GlobalIllumination, Reflection, Landscape on 4.27).view.set_camera_speed.scalaris ignored on 5.7+. - Nothing is auto-saved:
asset.save/asset.save_many/asset.save_all(orsave:trueon the create/import tools) write to disk.asset.save_allbeforeplay.startso PIE sees the latest compiled state.settings.set/set_many/set_inisave immediately;object.set_propertyon asettings:<Class>object needssettings.save. play.*actor tools fall back to the editor world when PIE is not running; input injection, teleport, spawn, possess, stats and widgets need a running session and affect only the live world.play.startreturns before the world exists: pollplay.status. Stop PIE before editing Blueprints.- Actor references (every kit): the exact label or object name of exactly one actor, or
class:<ClassName>for the only actor of a class (class:WorldSettings). Prefixes and "first match" are not accepted; ambiguous references answerE_NOT_FOUND. - Checkpoints live in memory for the editor session only. Loading a map, deleting assets or
edit.reset_undo_bufferclears the undo buffer: older checkpoints then reporthistory_reset. view.*needs a level viewport; screenshots need the editor visible and, on some drivers, in the foreground.view.screenshot_fromrestores the camera afterwards;view.set_realtimeis required for Niagara/animation previews to advance.console.set_cvaruses SetByConsole priority, which overrides scalability and project settings until restart;console.get_cvar.setBytells you which layer currently owns a value.console.execcaptures output;play.exec_consoledoes not.plugin.set_enabledandrender.set_ray_tracingonly take effect after an editor restart.project.write_file/delete_file/rename_filerefuse .uasset/.umap files and paths outside the project;project.read_filealso reads inside the engine directory.object.set_propertyvalues follow ImportText: booleansTrue/False, enums by name, structs(X=1,Y=2,Z=3), arrays(a,b,c), object references as full paths. Writing to a CDO changes the class defaults for every instance; writing toactor:<Label>during PIE is lost when PIE stops.asset.rename_manyandasset.find_unusedcan touch hundreds of assets: usedryRun:trueand afolderfilter first. Bulk tools (*_many,asset.validate,settings.set_many,object.set_properties) report per-itemfailedentries instead of aborting.- Source control tools do nothing useful when
edit.sc_inforeportsenabled:false; Live Coding tools are Windows only and reportavailable:falseelsewhere.
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.
console.exec (riesgo 1, smoke)
Runs a console command and returns what it printed (cvar queries, "stat", "obj list", "help", ...).
| Argumento | Tipo | Descripción |
|---|---|---|
command | string | obligatorio. |
world | string | "auto" (PIE when running, else editor), "editor" or "pie". Valor predeterminado TEXT("auto"). |
Devuelve: command, output, handled, world.
console.exec_many (riesgo 1, smoke)
Runs several console commands in order.
| Argumento | Tipo | Descripción |
|---|---|---|
commands | array of string | obligatorio. |
world | string | Valor predeterminado TEXT("auto"). |
Devuelve: results.
console.get_cvar (riesgo 0, smoke)
Value, type, help text, flags and who last set a console variable.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Console variable name, e.g. "r.ScreenPercentage". |
value | string | New value (console.set_cvar). |
Devuelve: variable, previousValue.
console.get_many (riesgo 0, smoke)
Values of several console variables.
| Argumento | Tipo | Descripción |
|---|---|---|
names | array of string | obligatorio. |
Devuelve: variables, total.
console.list_categories (riesgo 0, smoke)
Console variable categories (name prefix before the first dot) with counts.
Sin argumentos.
Devuelve: categories, totalVariables, totalCommands.
console.list_commands (riesgo 0, smoke)
Console commands (not variables) matching a substring.
| Argumento | Tipo | Descripción |
|---|---|---|
query | string | obligatorio. Substring (console.search) or prefix (console.list_prefix). |
includeCommands | boolean | Valor predeterminado false. |
includeHelp | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 100. |
Devuelve: variables, total.
console.list_prefix (riesgo 0, smoke)
Console objects whose name starts with a prefix (e.g. "r.Shadow.").
| Argumento | Tipo | Descripción |
|---|---|---|
query | string | obligatorio. Substring (console.search) or prefix (console.list_prefix). |
includeCommands | boolean | Valor predeterminado false. |
includeHelp | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 100. |
Devuelve: variables, total.
console.search (riesgo 0, smoke)
Console variables (and optionally commands) whose name contains a substring.
| Argumento | Tipo | Descripción |
|---|---|---|
query | string | obligatorio. Substring (console.search) or prefix (console.list_prefix). |
includeCommands | boolean | Valor predeterminado false. |
includeHelp | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 100. |
Devuelve: variables, total.
console.set_cvar (riesgo 1, smoke)
Sets a console variable (SetByConsole priority) and returns the previous and new value.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Console variable name, e.g. "r.ScreenPercentage". |
value | string | New value (console.set_cvar). |
Devuelve: variable, previousValue.
console.set_many (riesgo 1, smoke)
Sets many console variables; persist=true also writes them to Default
| Argumento | Tipo | Descripción |
|---|---|---|
variables | array of UeaKeyValue | obligatorio. Name -> value. |
persist | boolean | Also write them to Defaultfalse. |
iniFile | string | Config branch for persist (default "Engine"). Valor predeterminado TEXT("Engine"). |
section | string | Valor predeterminado TEXT("ConsoleVariables"). |
Devuelve: variables, total.
edit.begin_transaction (riesgo 1, smoke)
Opens a named transaction that groups the following tool calls into one undo step. Close it with edit.end_transaction.
| Argumento | Tipo | Descripción |
|---|---|---|
title | string | obligatorio. Title shown in the editor's undo history. |
Devuelve: message.
edit.build (riesgo 4, modifica, requiere mundo)
Starts a build: lighting (with quality), geometry, navigation, HLOD or all. Not smoke-tested: long running build.
| Argumento | Tipo | Descripción |
|---|---|---|
type | string | lighting, geometry, visible_geometry, navigation, hlod, all. Valor predeterminado TEXT("lighting"). |
quality | string | Lighting quality: preview, medium, high, production. Valor predeterminado TEXT("preview"). |
Devuelve: type, started, running, message.
edit.call_many (riesgo 0, smoke)
Runs several tools in sequence with JSON arguments (one round trip). atomic:true takes an implicit checkpoint and rolls every call back when one fails (rolledBack + rollback report in the reply).
| Argumento | Tipo | Descripción |
|---|---|---|
calls | array of UeaToolCall | obligatorio. |
stopOnError | boolean | Stop at the first failed call (always true when atomic). Valor predeterminado true. |
atomic | boolean | Take an implicit checkpoint and roll every call back when one fails (needs no open transaction). Valor predeterminado false. |
Devuelve: results, succeeded, failed, rolledBack, rollback.
edit.cancel_transaction (riesgo 1)
Cancels the transaction opened by edit.begin_transaction, reverting everything done since.
Sin argumentos.
Devuelve: message.
edit.checkpoint_create (riesgo 1, smoke)
Records a named checkpoint for this editor session: undo-history position, dirty packages, time and (withPreview) a 256 px viewport capture. Roll back to it with edit.checkpoint_rollback.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Unique checkpoint name for this editor session. |
note | string | Free text stored with the checkpoint. |
replace | boolean | Overwrite an existing checkpoint with the same name instead of failing. Valor predeterminado false. |
withPreview | boolean | Also store a low-resolution (256 px) capture of the viewport for view.capture_compare. Valor predeterminado false. |
Devuelve: checkpoint, message.
edit.checkpoint_delete (riesgo 1, smoke)
Forgets a checkpoint (the undo history is not touched).
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Checkpoint name (edit.checkpoint_list). |
Devuelve: checkpoints, count.
edit.checkpoint_diff (riesgo 0, smoke)
What changed since a checkpoint: transactions (oldest first), newly dirty packages, mutating tool calls and what a rollback could not revert.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Checkpoint name (edit.checkpoint_list). |
Devuelve: checkpoint, transactions, newDirtyPackages, calls, issues.
edit.checkpoint_list (riesgo 0, smoke)
Checkpoints of this session with the number of transactions and tool calls recorded since each one.
Sin argumentos.
Devuelve: checkpoints, count.
edit.checkpoint_rollback (riesgo 3, dryRun, smoke)
Undoes every transaction recorded after the checkpoint, newest first, and lists each undone title plus what cannot be rolled back (packages saved to disk, deleted/renamed assets, files or config written, calls inside a still-open transaction). dryRun lists without undoing. Never touches older transactions.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Checkpoint name (edit.checkpoint_list). |
dryRun | boolean | Only list what would be undone and what cannot be rolled back. Valor predeterminado false. |
Devuelve: rollback, message.
edit.clear_selection (riesgo 0, smoke)
Clears the actor and component selection.
Sin argumentos.
Devuelve: actors, count, components, center.
edit.close_utility_widget (riesgo 1)
Closes the tab of an Editor Utility Widget. Not smoke-tested: needs a project-authored widget Blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Devuelve: message.
edit.deselect_actors (riesgo 0, smoke)
Removes actors from the selection.
| Argumento | Tipo | Descripción |
|---|---|---|
actors | array of string | Actor labels or names. |
class | string | Class filter (native name or Blueprint). |
nameContains | string | Label substring filter. |
tag | string | Actor tag filter. |
layer | string | Layer filter. |
folder | string | Outliner folder path filter (prefix match). |
add | boolean | Add to the current selection instead of replacing it. Valor predeterminado false. |
selectHidden | boolean | Valor predeterminado false. |
limit | integer | Valor predeterminado 1000. |
Devuelve: actors, count, components, center.
edit.disable_kits (riesgo 1, smoke)
Deactivates kits for this session (their tools leave tools/list but stay callable); sends notifications/tools/list_changed.
| Argumento | Tipo | Descripción |
|---|---|---|
kits | array of string | obligatorio. Kit names, e.g. ["bp", "input"]. "edit" exposes every edit.* / asset.* / play.* ... tool. |
Devuelve: activeKits, changed, unknown, exposureMode, listedToolCount, message.
edit.enable_kits (riesgo 1, smoke)
Activates kits for this session so tools/list advertises their tools (Adaptive mode); sends notifications/tools/list_changed. Tools can be called without this.
| Argumento | Tipo | Descripción |
|---|---|---|
kits | array of string | obligatorio. Kit names, e.g. ["bp", "input"]. "edit" exposes every edit.* / asset.* / play.* ... tool. |
Devuelve: activeKits, changed, unknown, exposureMode, listedToolCount, message.
edit.end_transaction (riesgo 1, smoke)
Closes the transaction opened by edit.begin_transaction.
Sin argumentos.
Devuelve: message.
edit.gc (riesgo 1)
Forces a garbage collection and reports object counts before/after. Not smoke-tested: GC inside the self-test transaction is unsafe.
| Argumento | Tipo | Descripción |
|---|---|---|
fullPurge | boolean | Valor predeterminado true. |
Devuelve: usedPhysicalMB, peakPhysicalMB, availablePhysicalMB, totalPhysicalMB, usedVirtualMB, peakVirtualMB, objectCount, objectCountBefore, actorCount, message.
edit.get_level_bounds (riesgo 0, requiere mundo, smoke)
World bounding box of every actor in the current level.
Sin argumentos.
Devuelve: min, max, center, extent, actorsIncluded.
edit.get_lighting_info (riesgo 0, requiere mundo, smoke)
Lighting build state: unbuilt objects, lightmap sizes, configured quality, light counts by mobility.
Sin argumentos.
Devuelve: building, unbuiltObjects, unbuiltReflectionCaptures, needsRebuild, lightmapTotalSizeKB, shadowmapTotalSizeKB, lightingScenario, forceNoPrecomputedLighting, configuredQuality, lightCount, lightsByMobility.
edit.get_map_info (riesgo 0, requiere mundo, smoke)
Name, package, dirty state, actor counts, class distribution, streaming levels, bounds and lighting state of the current level.
Sin argumentos.
Devuelve: name, package, path, dirty, untitled, persistentActorCount, totalActorCount, streamingLevelCount, levelCount, gameModeOverride, unbuiltLightingObjects, partitioned, pieRunning, boundsMin, boundsMax, streamingLevels, classCounts.
edit.get_memory (riesgo 0, smoke)
Process memory and object counts.
Sin argumentos.
Devuelve: usedPhysicalMB, peakPhysicalMB, availablePhysicalMB, totalPhysicalMB, usedVirtualMB, peakVirtualMB, objectCount, objectCountBefore, actorCount, message.
edit.get_selected_actors (riesgo 0, smoke)
Currently selected actors with their transforms and the selection centre.
Sin argumentos.
Devuelve: actors, count, components, center.
edit.get_state (riesgo 0, smoke)
Editor state at a glance: PIE, transactions, dirty packages, selection, builds, focus, FPS.
Sin argumentos.
Devuelve: engine, project, currentMap, pieRunning, simulating, paused, transactionActive, activeTransaction, dirtyContentPackages, dirtyMapPackages, selectedActors, lightingBuildRunning, buildRunning, liveCodingCompiling, editorHasFocus, activeWindow, fps, uptimeSeconds, unattended, openAssetEditors, toolCount, listedToolCount, exposureMode, activeKits, maxAutoRisk.
edit.get_test_results (riesgo 0)
Results of the last edit.run_test / edit.run_tests call. Not smoke-tested: no test has run in a fresh session, so it always reports "no tests have run yet".
Sin argumentos.
Devuelve: results, passed, failed, totalSeconds.
edit.get_tool_counts (riesgo 0, smoke)
Tool counts per prefix (asset, play, view, ...) and per kit.
Sin argumentos.
Devuelve: prefixes, kits, total, hidden.
edit.get_tool_schema (riesgo 0, smoke)
Full input/output JSON schema and description of one tool.
| Argumento | Tipo | Descripción |
|---|---|---|
tool | string | obligatorio. |
Devuelve: tool, inputSchema, outputSchema, availableOnThisEngine, note.
edit.get_undo_state (riesgo 0, smoke)
Undo/redo counts, next undo/redo titles and whether a transaction is being recorded.
Sin argumentos.
Devuelve: undoCount, redoCount, queueLength, currentIndex, canUndo, canRedo, nextUndo, nextRedo, transactionActive, activeTransaction.
edit.get_workflow (riesgo 0, smoke)
One workflow: summary, JSON text and the prompt text (goal, arguments, exact step list).
| Argumento | Tipo | Descripción |
|---|---|---|
id | string | obligatorio. Workflow id (edit.list_workflows). |
Devuelve: workflow, json, promptText.
edit.get_world_settings (riesgo 0, requiere mundo, smoke)
World Settings values (game mode override, gravity, kill Z, bounds checks, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of string | Property names to read (edit.get_world_settings); empty = the common ones. |
values | array of UeaKeyValue | Property -> value to write (edit.set_world_settings). GameMode accepts a class name or Blueprint. |
Devuelve: entries, count.
edit.history (riesgo 0, smoke)
Shows the editor's transaction history (newest first) with undo/redo counts.
| Argumento | Tipo | Descripción |
|---|---|---|
limit | integer | Maximum entries to return, newest first. Valor predeterminado 20. |
Devuelve: entries, undoCount, redoCount.
edit.invert_selection (riesgo 0, smoke)
Inverts the actor selection of the editor world.
Sin argumentos.
Devuelve: actors, count, components, center.
edit.is_building (riesgo 0, smoke)
Whether a build (lighting or other) is currently running.
Sin argumentos.
Devuelve: type, started, running, message.
edit.list_active_kits (riesgo 0, smoke)
Kits currently activated for the session, the exposure mode and how many tools are listed.
Sin argumentos.
Devuelve: activeKits, changed, unknown, exposureMode, listedToolCount, message.
edit.list_dirty_packages (riesgo 0, smoke)
Unsaved content and map packages.
Sin argumentos.
Devuelve: contentPackages, mapPackages, total.
edit.list_kits (riesgo 0, smoke)
Lists the kits loaded on this engine with tool counts, active flag, tool names and the exposure mode.
Sin argumentos.
Devuelve: exposureMode, activeKits, availableToolCount, listedToolCount, kits.
edit.list_streaming_levels (riesgo 0, requiere mundo, smoke)
Streaming (sub) levels of the current world with loaded/visible state.
Sin argumentos.
Devuelve: levels.
edit.list_tests (riesgo 0, smoke)
Automation tests available in this editor, filtered by substring and category.
| Argumento | Tipo | Descripción |
|---|---|---|
contains | string | Substring of the test path/name. |
filter | string | smoke, engine, product, perf, stress, negative or empty for all. |
limit | integer | Valor predeterminado 300. |
Devuelve: tests, total.
edit.list_workflows (riesgo 0, smoke)
Workflows available to this project (shipped + project), with arguments, step counts and whether this engine/plugin set can run them.
| Argumento | Tipo | Descripción |
|---|---|---|
category | string | Only workflows of this category (empty = all). |
Devuelve: workflows, count, searchDirs, errors.
edit.live_coding_compile (riesgo 4)
Triggers a Live Coding compile and optionally waits for it to finish (Windows). Not smoke-tested: long running compile.
| Argumento | Tipo | Descripción |
|---|---|---|
waitFrames | integer | Frames to wait for the compile to finish (0 = return immediately). Valor predeterminado 1800. |
Devuelve: available, enabledForSession, enabledByDefault, started, compiling, compileRequested, framesWaited, message.
edit.live_coding_enable (riesgo 1)
Enables/disables Live Coding for this session (Windows). Not smoke-tested: starts/stops the Live Coding console and cannot be reverted within the session.
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
Devuelve: available, enabledForSession, enabledByDefault, started, compiling, compileRequested, framesWaited, message.
edit.live_coding_status (riesgo 0, smoke)
Live Coding availability and state (Windows).
Sin argumentos.
Devuelve: available, enabledForSession, enabledByDefault, started, compiling, compileRequested, framesWaited, message.
edit.load_map (riesgo 2)
Opens a level in the editor (optionally saving dirty packages first). Not smoke-tested: swapping the open level is not undoable and would disturb every other tool in the run.
| Argumento | Tipo | Descripción |
|---|---|---|
map | string | obligatorio. Level asset (object/package path or unique name). |
saveCurrent | boolean | Save dirty packages before switching. Valor predeterminado false. |
Devuelve: name, package, path, dirty, untitled, persistentActorCount, totalActorCount, streamingLevelCount, levelCount, gameModeOverride, unbuiltLightingObjects, partitioned, pieRunning, boundsMin, boundsMax, streamingLevels, classCounts.
edit.map_check (riesgo 0, requiere mundo, smoke)
Runs Map Check on every actor and reports the actors that produced errors/warnings.
Sin argumentos.
Devuelve: actorsChecked, errors, warnings, actorsWithIssues.
edit.new_map (riesgo 2)
Creates and opens a new level (blank or from a template), optionally saving it to a path. Not smoke-tested: replaces the open level and may prompt to save.
| Argumento | Tipo | Descripción |
|---|---|---|
template | string | Optional template level to copy (object/package path). |
savePath | string | Optional package path to save the new level to, e.g. "/Game/Maps/NewLevel". |
saveCurrent | boolean | Valor predeterminado false. |
Devuelve: name, package, path, dirty, untitled, persistentActorCount, totalActorCount, streamingLevelCount, levelCount, gameModeOverride, unbuiltLightingObjects, partitioned, pieRunning, boundsMin, boundsMax, streamingLevels, classCounts.
edit.ping (riesgo 0, smoke)
Server, engine and project identification plus the number of tools available.
Sin argumentos.
Devuelve: server, version, engine, project, toolCount.
edit.recommend_kits (riesgo 0, smoke)
Ranks kits for a plain-text task description using tool names, descriptions and kit summaries. Does not activate anything.
| Argumento | Tipo | Descripción |
|---|---|---|
query | string | obligatorio. What you want to do, in plain words (e.g. "create a character blueprint with a jump input"). |
limit | integer | Maximum kits returned (default 5). Valor predeterminado 5. |
Devuelve: recommendations, note.
edit.redo (riesgo 1)
Redoes the last N undone transactions.
| Argumento | Tipo | Descripción |
|---|---|---|
steps | integer | How many transactions to undo (or redo). Valor predeterminado 1. |
Devuelve: stepsDone, transactions.
edit.reset_undo_buffer (riesgo 5, destructivo)
Clears the whole undo/redo buffer (cannot be undone).
| Argumento | Tipo | Descripción |
|---|---|---|
reason | string | Valor predeterminado TEXT("Reset by MCP"). |
Devuelve: undoCount, redoCount, queueLength, currentIndex, canUndo, canRedo, nextUndo, nextRedo, transactionActive, activeTransaction.
edit.restore_selection (riesgo 0, smoke)
Restores a selection saved with edit.save_selection.
| Argumento | Tipo | Descripción |
|---|---|---|
slot | string | Named slot (default "default"). Valor predeterminado TEXT("default"). |
Devuelve: actors, count, components, center.
edit.run_editor_function (riesgo 2, modifica, smoke)
Calls a static/BlueprintCallable function on the class default object of a class (function libraries, editor utilities).
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Class (native, path or Blueprint function library) whose CDO receives the call. |
function | string | obligatorio. |
args | array of UeaKeyValue |
Devuelve: function, returnValue, returnType, outputs.
edit.run_test (riesgo 1)
Runs one automation test and returns its events (latent commands are pumped while real editor frames pass). Not smoke-tested: tests may open maps or PIE.
| Argumento | Tipo | Descripción |
|---|---|---|
test | string | obligatorio. Full test name/path (edit.run_test) or a substring matching several tests (edit.run_tests). |
maxFrames | integer | Maximum frames to pump per test before giving up on latent commands. Valor predeterminado 3000. |
maxTests | integer | edit.run_tests: maximum number of tests to run. Valor predeterminado 20. |
stopOnFailure | boolean | edit.run_tests: stop after the first failure. Valor predeterminado false. |
Devuelve: results, passed, failed, totalSeconds.
edit.run_tests (riesgo 1)
Runs every test whose path contains the substring (bounded by maxTests). Not smoke-tested: tests may open maps or PIE.
| Argumento | Tipo | Descripción |
|---|---|---|
test | string | obligatorio. Full test name/path (edit.run_test) or a substring matching several tests (edit.run_tests). |
maxFrames | integer | Maximum frames to pump per test before giving up on latent commands. Valor predeterminado 3000. |
maxTests | integer | edit.run_tests: maximum number of tests to run. Valor predeterminado 20. |
stopOnFailure | boolean | edit.run_tests: stop after the first failure. Valor predeterminado false. |
Devuelve: results, passed, failed, totalSeconds.
edit.run_utility_blueprint (riesgo 2, modifica)
Runs an Editor Utility Blueprint (its Run event) or any asset the editor utility subsystem can run. Not smoke-tested: needs a project-authored runnable Blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Devuelve: message.
edit.run_utility_widget (riesgo 1)
Opens an Editor Utility Widget as a tab. Not smoke-tested: spawns a UI tab and needs a project-authored widget Blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Devuelve: message.
edit.run_workflow (riesgo 3, dryRun)
Runs a workflow through the tool table: steps in order (stop at the first failure; atomic rolls everything back), then verify, optionally cleanup. Replies per-step results; add "_preview" for a final image. Not smoke-tested here: Tools/workflow_smoke.py runs every workflow end to end with direct calls.
| Argumento | Tipo | Descripción |
|---|---|---|
id | string | Workflow id (edit.list_workflows); or pass json instead. |
json | string | Inline workflow JSON text (runs without saving it). |
arguments | TMap<FString, FString> | Argument values as text (converted to the declared types). |
argumentsJson | string | Same as arguments but as one JSON object text, for array/object values. |
atomic | boolean | Take a checkpoint first and roll every step back when one fails. The checkpoint stays as "workflow:true. |
dryRun | boolean | Validate and list the resolved steps without running anything. Valor predeterminado false. |
runCleanup | boolean | Run the workflow's cleanup steps at the end (removes what it created; may delete assets on disk). Valor predeterminado false. |
Devuelve: workflowId, dryRun, succeeded, failedStep, error, warnings, steps, verify, verified, cleanup, resolvedArguments, checkpoint, rolledBack, rollback, changedActors.
edit.save_map (riesgo 2)
Saves the current level (optionally "save as" and every dirty package). Not smoke-tested: an untitled level opens a modal Save As dialog.
| Argumento | Tipo | Descripción |
|---|---|---|
savePath | string | Optional package path for "save as", e.g. "/Game/Maps/Copy". |
saveAll | boolean | Also save every dirty content package. Valor predeterminado false. |
Devuelve: name, package, path, dirty, untitled, persistentActorCount, totalActorCount, streamingLevelCount, levelCount, gameModeOverride, unbuiltLightingObjects, partitioned, pieRunning, boundsMin, boundsMax, streamingLevels, classCounts.
edit.save_selection (riesgo 0, smoke)
Remembers the current actor selection under a slot name.
| Argumento | Tipo | Descripción |
|---|---|---|
slot | string | Named slot (default "default"). Valor predeterminado TEXT("default"). |
Devuelve: actors, count, components, center.
edit.sc_add (riesgo 4)
Marks files for add. Not smoke-tested: needs a connected source-control provider and would touch the user's working copy.
| Argumento | Tipo | Descripción |
|---|---|---|
files | array of string | obligatorio. Absolute file paths (or /Game/... asset paths, converted to package files). |
Devuelve: succeeded, failed, succeededCount, failedCount.
edit.sc_checkout (riesgo 4)
Checks out (or marks for add) arbitrary files in source control. Not smoke-tested: needs a connected source-control provider and would touch the user's working copy.
| Argumento | Tipo | Descripción |
|---|---|---|
files | array of string | obligatorio. Absolute file paths (or /Game/... asset paths, converted to package files). |
Devuelve: succeeded, failed, succeededCount, failedCount.
edit.sc_info (riesgo 0, smoke)
Source control provider name, enabled and available flags.
Sin argumentos.
Devuelve: enabled, available, provider, message.
edit.sc_revert (riesgo 5, destructivo)
Reverts files (local changes are lost). Not smoke-tested: destructive and needs a connected source-control provider.
| Argumento | Tipo | Descripción |
|---|---|---|
files | array of string | obligatorio. Absolute file paths (or /Game/... asset paths, converted to package files). |
Devuelve: succeeded, failed, succeededCount, failedCount.
edit.search_tools (riesgo 0, smoke)
Finds tools by words in their names and descriptions.
| Argumento | Tipo | Descripción |
|---|---|---|
query | string | obligatorio. Words searched in tool names and descriptions (all words must match). |
kit | string | Restrict to a kit ("edit", "bp", ...) or a prefix ("asset", "play"). |
limit | integer | Valor predeterminado 30. |
Devuelve: tools, total.
edit.select_actors (riesgo 0)
Selects actors by name list, class, label substring, tag, layer or folder (replaces or adds). Fails when nothing matches; the self-test level is empty.
| Argumento | Tipo | Descripción |
|---|---|---|
actors | array of string | Actor labels or names. |
class | string | Class filter (native name or Blueprint). |
nameContains | string | Label substring filter. |
tag | string | Actor tag filter. |
layer | string | Layer filter. |
folder | string | Outliner folder path filter (prefix match). |
add | boolean | Add to the current selection instead of replacing it. Valor predeterminado false. |
selectHidden | boolean | Valor predeterminado false. |
limit | integer | Valor predeterminado 1000. |
Devuelve: actors, count, components, center.
edit.select_all (riesgo 0, smoke)
Selects every actor (optionally only of a class).
| Argumento | Tipo | Descripción |
|---|---|---|
actors | array of string | Actor labels or names. |
class | string | Class filter (native name or Blueprint). |
nameContains | string | Label substring filter. |
tag | string | Actor tag filter. |
layer | string | Layer filter. |
folder | string | Outliner folder path filter (prefix match). |
add | boolean | Add to the current selection instead of replacing it. Valor predeterminado false. |
selectHidden | boolean | Valor predeterminado false. |
limit | integer | Valor predeterminado 1000. |
Devuelve: actors, count, components, center.
edit.select_component (riesgo 0)
Selects a component of an actor (Details panel component selection). Needs an actor; the self-test level is empty.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. |
component | string | obligatorio. |
add | boolean | Valor predeterminado false. |
Devuelve: actors, count, components, center.
edit.self_test (riesgo 4)
Runs every available tool that declares Smoke args inside a cancelled transaction and a transient /Game/UeaSmoke_
| Argumento | Tipo | Descripción |
|---|---|---|
kits | array of string | Restrict to these kits (empty = every kit). |
includeMutating | boolean | Also run tools flagged Mutates (they only touch the transient sandbox folder). Default true. Valor predeterminado true. |
limit | integer | Stop after running this many tools (0 = no limit). Valor predeterminado 0. |
listNoArgs | boolean | Include tools without Smoke args in Results with status "no_args" (default true; totals count them either way). Valor predeterminado true. |
Devuelve: sandbox, sandboxDeleted, results, passed, failed, skipped, noArgs, total, totalMilliseconds, failedTools, engine.
edit.set_background_throttling (riesgo 4)
Enables/disables "Use less CPU when in background" (disable for unattended PIE runs). Not smoke-tested: SaveConfig permanently rewrites the user's editor ini.
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
Devuelve: message.
edit.set_streaming_level (riesgo 2, modifica, requiere mundo)
Loads/unloads or shows/hides a streaming level. Not smoke-tested: an empty project has no streaming levels to target.
| Argumento | Tipo | Descripción |
|---|---|---|
level | string | obligatorio. Streaming level package name or substring. |
loaded | integer | -1 keeps, 0/1 sets. Valor predeterminado -1. |
visible | integer | Valor predeterminado -1. |
Devuelve: levels.
edit.set_world_settings (riesgo 2, modifica, requiere mundo, smoke)
Writes World Settings values of the current level.
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of string | Property names to read (edit.get_world_settings); empty = the common ones. |
values | array of UeaKeyValue | Property -> value to write (edit.set_world_settings). GameMode accepts a class name or Blueprint. |
Devuelve: entries, count.
edit.show_notification (riesgo 1, smoke)
Shows a toast notification in the editor.
| Argumento | Tipo | Descripción |
|---|---|---|
message | string | obligatorio. |
type | string | info, success or fail. Valor predeterminado TEXT("info"). |
duration | number | Valor predeterminado 4.0. |
Devuelve: message.
edit.undo (riesgo 1)
Undoes the last N editor transactions (including changes made by other tools).
| Argumento | Tipo | Descripción |
|---|---|---|
steps | integer | How many transactions to undo (or redo). Valor predeterminado 1. |
Devuelve: stepsDone, transactions.
edit.undo_to_index (riesgo 1)
Undoes or redoes until the history entry with the given index is current.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | Index from edit.history (0 = oldest). The buffer is undone/redone until that entry is current. Valor predeterminado 0. |
Devuelve: undoCount, redoCount, queueLength, currentIndex, canUndo, canRedo, nextUndo, nextRedo, transactionActive, activeTransaction.
edit.validate_workflow (riesgo 0, smoke)
Checks a workflow (by id or JSON text): every tool exists on this engine, args match the tool schemas, plugins/min engine satisfied, "${...}" substitutions resolve.
| Argumento | Tipo | Descripción |
|---|---|---|
id | string | Workflow id; or pass json instead. |
json | string | Workflow JSON text to validate (not saved). |
arguments | TMap<FString, FString> | Argument values (text, converted to the declared types) used to check substitutions. |
Devuelve: id, valid, problems, warnings, stepCount.
log.clear_capture (riesgo 1, smoke)
Clears the captured entries.
Sin argumentos.
Devuelve: marker, capturing, file.
log.get_file_marker (riesgo 0, smoke)
Current line count of the log file on disk (marker for log.read_file_since).
Sin argumentos.
Devuelve: marker, capturing, file.
log.get_marker (riesgo 0, smoke)
Current capture index (pass it later as sinceIndex to read only newer entries).
Sin argumentos.
Devuelve: marker, capturing, file.
log.get_verbosity (riesgo 0, smoke)
Verbosity of one log category.
| Argumento | Tipo | Descripción |
|---|---|---|
category | string | obligatorio. |
verbosity | string | NoLogging, Fatal, Error, Warning, Display, Log, Verbose, VeryVerbose, All (log.set_verbosity). |
Devuelve: category, verbosity, output.
log.list_categories (riesgo 0, smoke)
Registered log categories with their verbosity.
| Argumento | Tipo | Descripción |
|---|---|---|
contains | string | |
limit | integer | Valor predeterminado 500. |
Devuelve: entries, count.
log.read (riesgo 0, smoke)
Last lines of the editor log, optionally filtered by substring.
| Argumento | Tipo | Descripción |
|---|---|---|
lines | integer | Valor predeterminado 100. |
contains | string | Substring filter (e.g. "Error", "LogBlueprint"). |
Devuelve: lines.
log.read_capture (riesgo 0, smoke)
Captured entries since an index, filtered by category, verbosity, substring or regex.
| Argumento | Tipo | Descripción |
|---|---|---|
sinceIndex | integer | Return entries with an index greater than this (from a previous reply's LastIndex or log.get_marker). Valor predeterminado -1. |
category | string | |
minVerbosity | string | Minimum verbosity to include: Error, Warning, Display, Log, Verbose (default all). |
contains | string | |
regex | string | Regular expression applied to the message. |
limit | integer | Valor predeterminado 200. |
Devuelve: capturing, entries, lastIndex, totalCaptured, errors, warnings.
log.read_file_since (riesgo 0, smoke)
Log file lines written after a marker, filtered by substring or regex.
| Argumento | Tipo | Descripción |
|---|---|---|
marker | integer | Line count returned by log.get_file_marker. Valor predeterminado 0. |
contains | string | |
regex | string | |
limit | integer | Valor predeterminado 500. |
Devuelve: lines, marker, totalLines.
log.set_verbosity (riesgo 1, smoke)
Sets the verbosity of a log category (NoLogging, Error, Warning, Display, Log, Verbose, VeryVerbose, All).
| Argumento | Tipo | Descripción |
|---|---|---|
category | string | obligatorio. |
verbosity | string | NoLogging, Fatal, Error, Warning, Display, Log, Verbose, VeryVerbose, All (log.set_verbosity). |
Devuelve: category, verbosity, output.
log.start_capture (riesgo 1, smoke)
Starts capturing every log line in memory (category, verbosity, message) for log.read_capture.
Sin argumentos.
Devuelve: marker, capturing, file.
log.stop_capture (riesgo 1, smoke)
Stops the in-memory capture (entries stay readable).
Sin argumentos.
Devuelve: marker, capturing, file.
log.write (riesgo 1, smoke)
Writes a line to the Output Log (handy as a marker between test steps).
| Argumento | Tipo | Descripción |
|---|---|---|
message | string | obligatorio. |
verbosity | string | Log, Display, Warning or Error. Valor predeterminado TEXT("Display"). |
Devuelve: marker, capturing, file.
object.array_add (riesgo 2, modifica, smoke)
Appends (or inserts at Index) an element parsed from text to an array property.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
property | string | obligatorio. Path of an array property. |
value | string | Value for object.array_add / insert; index for object.array_remove (insert at Index when >= 0). |
index | integer | Valor predeterminado -1. |
Devuelve: object, property, type, value, containerSize.
object.array_clear (riesgo 3, modifica, smoke)
Empties an array property.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
property | string | obligatorio. Path of an array property. |
value | string | Value for object.array_add / insert; index for object.array_remove (insert at Index when >= 0). |
index | integer | Valor predeterminado -1. |
Devuelve: object, property, type, value, containerSize.
object.array_remove (riesgo 2, modifica, smoke)
Removes the element at Index from an array property.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
property | string | obligatorio. Path of an array property. |
value | string | Value for object.array_add / insert; index for object.array_remove (insert at Index when >= 0). |
index | integer | Valor predeterminado -1. |
Devuelve: object, property, type, value, containerSize.
object.call_function (riesgo 2, modifica, smoke)
Calls a UFUNCTION (native or Blueprint) on the object with text arguments; returns the return value and out params.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. Object reference (see object.get_property). Static functions can be called on "cdo: |
function | string | obligatorio. UFUNCTION name (native or Blueprint). |
args | array of UeaKeyValue | Parameter name -> value as text. Missing parameters keep their defaults. |
Devuelve: function, returnValue, returnType, outputs.
object.copy_properties (riesgo 2, modifica, smoke)
Copies property values from one object to another (same or compatible classes).
| Argumento | Tipo | Descripción |
|---|---|---|
source | string | obligatorio. |
target | string | obligatorio. |
properties | array of string | Property names to copy; empty = every property that exists on both classes. |
editableOnly | boolean | Only editable (EditAnywhere/EditDefaultsOnly) properties. Valor predeterminado true. |
Devuelve: succeeded, failed, succeededCount, failedCount.
object.create_asset (riesgo 2, modifica, smoke)
Creates an asset of any concrete, non-actor UObject class (data assets, PrimaryAssetLabel, ...) at folder/name with default values; edit it with object.set_property.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Class name or path (must be concrete, not an Actor, not a Blueprint-only type). |
folder | string | obligatorio. Destination folder, e.g. "/Game/Data". |
name | string | obligatorio. Asset name. |
Devuelve: path, name, class, classPath, outer, package, isCDO, isAsset, isActor, isDirty, flags.
object.diff_from_default (riesgo 0, smoke)
Properties whose value differs from the archetype/CDO (or from another object).
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
other | string | Compare against this object instead of the archetype/CDO. |
limit | integer | Valor predeterminado 200. |
Devuelve: object, comparedTo, differences, total.
object.export_text (riesgo 0, smoke)
Full text export (T3D) of an object's properties, as the editor copies it.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
Devuelve: text, lines, savedTo, problems.
object.find (riesgo 0, smoke)
Finds loaded objects by class, name and path substring (TObjectIterator).
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | Class filter (any UObject class). |
contains | string | Substring of the object name. |
pathContains | string | Substring of the outer/package path (e.g. "/Game/" or "UEDPIE"). |
skipDefaults | boolean | Skip class default objects and archetypes. Valor predeterminado true. |
limit | integer | Valor predeterminado 100. |
Devuelve: objects, total.
object.get_class_info (riesgo 0, smoke)
Parent chain, interfaces, flags, module and counts of a class.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Class name, path or Blueprint asset. |
Devuelve: class, path, parent, ancestors, interfaces, flags, isBlueprint, blueprintAsset, module, configName, propertyCount, functionCount, cdoPath, tooltip.
object.get_container_size (riesgo 0, smoke)
Element count of an array/map/set property.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
property | string | obligatorio. Property path: "Health", "Movement.MaxWalkSpeed", "Items[2].Name", "Tags[0]", "RootComponent.RelativeLocation.X", "MyMap[KeyName]". |
value | string | New value as text (object.set_property). Object refs use full paths, structs use (X=1,Y=2), arrays use (a,b,c). |
Devuelve: object, property, type, value, containerSize.
object.get_enum_values (riesgo 0, smoke)
Values of an enum (native or user-defined).
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Class name, path or Blueprint asset. |
Devuelve: enum, path, values, numericValues.
object.get_properties (riesgo 0, smoke)
Reads several properties by path in one call.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
properties | array of string | obligatorio. Property paths to read. |
Devuelve: entries, count.
object.get_property (riesgo 0, smoke)
Reads one property by path (nested structs, components, arrays [i], maps [key]).
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
property | string | obligatorio. Property path: "Health", "Movement.MaxWalkSpeed", "Items[2].Name", "Tags[0]", "RootComponent.RelativeLocation.X", "MyMap[KeyName]". |
value | string | New value as text (object.set_property). Object refs use full paths, structs use (X=1,Y=2), arrays use (a,b,c). |
Devuelve: object, property, type, value, containerSize.
object.get_property_metadata (riesgo 0, smoke)
Editor metadata of a property (ClampMin, Categories, AllowedClasses, ToolTip, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Class name or object reference. |
property | string | obligatorio. |
Devuelve: entries, count.
object.get_struct_fields (riesgo 0, smoke)
Fields of a struct (native or user-defined) with types.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Class name, path or Blueprint asset. |
Devuelve: struct, path, fields, sizeBytes.
object.list_functions (riesgo 0, smoke)
Lists the UFUNCTIONs of an object or class with their parameters.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. Object reference or class name. |
contains | string | |
callableOnly | boolean | Only BlueprintCallable/BlueprintPure functions. Valor predeterminado false. |
includeInherited | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: class, functions, total.
object.list_properties (riesgo 0, smoke)
Lists the reflected properties of an object with type, category, flags, tooltip and value.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
contains | string | Substring filter on the property name. |
category | string | Category filter (exact, case-insensitive). |
editableOnly | boolean | Only properties editable in the Details panel. Valor predeterminado false. |
includeValues | boolean | Include the current value as text. Valor predeterminado true. |
includeInherited | boolean | Include properties declared on parent classes. Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
maxValueLength | integer | Truncate values longer than this many characters (0 = no truncation). Valor predeterminado 300. |
Devuelve: object, class, properties, total.
object.list_subclasses (riesgo 0, smoke)
Loaded subclasses of a class (native and Blueprint generated).
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. |
nativeOnly | boolean | Skip Blueprint generated classes. Valor predeterminado false. |
concreteOnly | boolean | Skip abstract classes. Valor predeterminado false. |
contains | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: classes, total.
object.reset_property (riesgo 2, modifica, smoke)
Resets a property to the value of the archetype / class default object.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
property | string | obligatorio. Property path: "Health", "Movement.MaxWalkSpeed", "Items[2].Name", "Tags[0]", "RootComponent.RelativeLocation.X", "MyMap[KeyName]". |
value | string | New value as text (object.set_property). Object refs use full paths, structs use (X=1,Y=2), arrays use (a,b,c). |
Devuelve: object, property, type, value, containerSize.
object.resolve (riesgo 0, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
Devuelve: path, name, class, classPath, outer, package, isCDO, isAsset, isActor, isDirty, flags.
object.set_properties (riesgo 2, modifica, smoke)
Writes several properties in one call; reports per-property failures.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
values | array of UeaKeyValue | obligatorio. Property path -> value. |
Devuelve: succeeded, failed, succeededCount, failedCount.
object.set_property (riesgo 2, modifica, smoke)
Writes one property by path from text (ImportText rules) and runs PostEditChange.
| Argumento | Tipo | Descripción |
|---|---|---|
object | string | obligatorio. |
property | string | obligatorio. Property path: "Health", "Movement.MaxWalkSpeed", "Items[2].Name", "Tags[0]", "RootComponent.RelativeLocation.X", "MyMap[KeyName]". |
value | string | New value as text (object.set_property). Object refs use full paths, structs use (X=1,Y=2), arrays use (a,b,c). |
Devuelve: object, property, type, value, containerSize.
play.actors_near_player (riesgo 0, requiere PIE, smoke)
Actors within a radius of the player pawn, closest first.
| Argumento | Tipo | Descripción |
|---|---|---|
radius | number | Valor predeterminado 1000.0. |
class | string | |
limit | integer | Valor predeterminado 50. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: center, actors, total.
play.advance_frames (riesgo 0, smoke)
Lets the editor/PIE run N frames before returning (real frame timing; deltaSeconds only sizes the timeout). Returns the game and real time afterwards.
| Argumento | Tipo | Descripción |
|---|---|---|
frames | integer | Frames to tick (1-600). Valor predeterminado 1. |
deltaSeconds | number | Delta time per frame in seconds. Valor predeterminado 0.016666. |
Devuelve: framesTicked, gameTimeSeconds, realTimeSeconds, pieRunning.
play.call_function (riesgo 0, smoke)
Calls a UFUNCTION on a PIE actor or one of its components with text arguments.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. |
component | string | Optional component name to call the function on instead of the actor. |
function | string | obligatorio. |
args | array of UeaKeyValue |
Devuelve: target, function, returnValue, outputs.
play.destroy_actor (riesgo 0, smoke)
Destroys an actor of the PIE world.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label or name in the PIE world (editor world when PIE is not running). |
Devuelve: message.
play.exec_console (riesgo 1, smoke)
Runs a console command in PIE (or in the editor when PIE is not running).
| Argumento | Tipo | Descripción |
|---|---|---|
command | string | obligatorio. Console command, e.g. "stat fps" or "r.ScreenPercentage 50". Runs in PIE when active, else in the editor. |
Devuelve: message.
play.find_actors_by_tag (riesgo 0, smoke)
Actors carrying an actor tag.
| Argumento | Tipo | Descripción |
|---|---|---|
tag | string | obligatorio. |
limit | integer | Valor predeterminado 100. |
Devuelve: actors, total.
play.get_actor (riesgo 0, smoke)
Reads a property (or the transform summary) of an actor in the PIE/editor world.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label or name (PIE world when running, else editor world). |
property | string | Property path, e.g. "Health" or "CharacterMovement.MaxWalkSpeed". Empty returns transform + class summary only. |
Devuelve: actor, property, value, components.
play.get_actor_components (riesgo 0, smoke)
Components of an actor with class, parent, location and active/visible state.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label or name in the PIE world (editor world when PIE is not running). |
Devuelve: actor, components.
play.get_game_mode_info (riesgo 0, requiere PIE, smoke)
Game mode, game state, default classes, player count, match state and net mode of the running world.
Sin argumentos.
Devuelve: gameMode, gameState, playerControllerClass, defaultPawnClass, hUDClass, playerStateClass, spectatorClass, numPlayers, matchState, gameInstance, netMode, authority.
play.get_input_state (riesgo 0, requiere PIE, smoke)
Every key currently pressed for the player (name -> value).
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local player index (0 = first player). Valor predeterminado 0. |
Devuelve: entries, count.
play.get_player_state (riesgo 0, requiere PIE, smoke)
Controller, pawn, transform, velocity, view point, movement mode, score and tags of a player.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local player index (0 = first player). Valor predeterminado 0. |
Devuelve: controller, controllerClass, pawn, pawnClass, location, rotation, controlRotation, velocity, speed, viewLocation, viewRotation, playerName, score, movementMode, crouched, falling, paused, timeDilation, tags, viewTarget.
play.get_stats (riesgo 0, smoke)
FPS, frame/game/render/RHI/GPU milliseconds, draw calls, memory, object and actor counts.
Sin argumentos.
Devuelve: fps, frameMs, gameThreadMs, renderThreadMs, rhiThreadMs, gpuMs, drawCalls, primitivesDrawn, deltaSeconds, usedPhysicalMB, peakPhysicalMB, availablePhysicalMB, totalPhysicalMB, usedVirtualMB, objectCount, actorCount, pieRunning, boundBy.
play.get_time_dilation (riesgo 0, requiere PIE, smoke)
Current global time dilation.
Sin argumentos.
Devuelve: value.
play.get_visible_widgets (riesgo 0, requiere PIE, smoke)
Widgets of the user widgets on screen: names, classes, texts, visibility.
| Argumento | Tipo | Descripción |
|---|---|---|
textOnly | boolean | Only widgets that carry text (TextBlock, RichText, EditableText). Valor predeterminado false. |
visibleOnly | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: widgets, total, userWidgetCount.
play.is_key_pressed (riesgo 0, requiere PIE, smoke)
Whether a key is currently down for the player, with its axis value.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. FKey name, e.g. "SpaceBar", "W", "LeftMouseButton", "Gamepad_FaceButton_Bottom". |
holdFrames | integer | play.tap_key: frames to hold before releasing (1-600). Valor predeterminado 1. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: key, pressed, value, message.
play.line_trace (riesgo 0, smoke)
Line trace from the player camera (or explicit start/end) with hit actor, location and normal.
| Argumento | Tipo | Descripción |
|---|---|---|
fromCamera | boolean | Trace from the player camera along its view direction (default). Valor predeterminado true. |
start | {x,y,z} | |
end | {x,y,z} | |
distance | number | Distance when tracing from the camera (cm). Valor predeterminado 10000.0. |
channel | string | Collision channel: "Visibility", "Camera", "WorldStatic", "Pawn", ... (ECC_ prefix optional). Valor predeterminado TEXT("Visibility"). |
ignorePlayer | boolean | Valor predeterminado true. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: hit, hitActor, hitActorClass, hitComponent, location, normal, distance, traceStart, traceEnd, physicalMaterial.
play.list_actors (riesgo 0, smoke)
Lists actors of the PIE world (or the editor world when PIE is not running).
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | Substring of the class name (e.g. "Character"). |
name | string | Substring of the label/name. |
limit | integer | Valor predeterminado 100. |
Devuelve: actors, total.
play.list_players (riesgo 0, requiere PIE, smoke)
Every player controller of the running world (multiplayer PIE lists all clients).
Sin argumentos.
Devuelve: players.
play.list_worlds (riesgo 0, smoke)
World contexts (editor, PIE clients, dedicated server) with net mode and counts.
Sin argumentos.
Devuelve: worlds.
play.mouse_delta (riesgo 0, requiere PIE, smoke)
Feeds mouse movement (MouseX/MouseY deltas) for N frames.
| Argumento | Tipo | Descripción |
|---|---|---|
deltaX | number | Valor predeterminado 0.0. |
deltaY | number | Valor predeterminado 0.0. |
frames | integer | Valor predeterminado 1. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: key, pressed, value, message.
play.possess (riesgo 0, requiere PIE, smoke)
Makes the player controller possess a pawn.
| Argumento | Tipo | Descripción |
|---|---|---|
pawn | string | obligatorio. Pawn label/name. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
play.press_key (riesgo 0, requiere PIE, smoke)
Injects a key press into the player controller (stays pressed until play.release_key).
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. FKey name, e.g. "SpaceBar", "W", "LeftMouseButton", "Gamepad_FaceButton_Bottom". |
holdFrames | integer | play.tap_key: frames to hold before releasing (1-600). Valor predeterminado 1. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: key, pressed, value, message.
play.release_key (riesgo 0, requiere PIE, smoke)
Injects a key release.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. FKey name, e.g. "SpaceBar", "W", "LeftMouseButton", "Gamepad_FaceButton_Bottom". |
holdFrames | integer | play.tap_key: frames to hold before releasing (1-600). Valor predeterminado 1. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: key, pressed, value, message.
play.screenshot (riesgo 0, requiere PIE, smoke)
Screenshot of the PIE viewport returned as an image (PNG).
| Argumento | Tipo | Descripción |
|---|---|---|
savePath | string | Optional absolute PNG path to also write on disk. |
maxSize | integer | Longest side in pixels for the returned image (0 = native). Valor predeterminado 1280. |
Devuelve: width, height, savedTo, imageBase64, imageMimeType.
play.screenshot_from_actor (riesgo 0, smoke)
Renders the scene from an actor's camera (or transform) into a PNG image block.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor whose camera component (or transform) is used as the view point. |
width | integer | Valor predeterminado 960. |
height | integer | Valor predeterminado 540. |
fov | number | 0 = use the camera component FOV (or 90). Valor predeterminado 0.0. |
savePath | string |
Devuelve: width, height, savedTo, imageBase64, imageMimeType.
play.set_actor_property (riesgo 0, smoke)
Sets a property on a PIE actor (or a component with "Component.Property").
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. |
property | string | obligatorio. Property path; "Component.Property" targets a component. |
value | string | obligatorio. |
Devuelve: actor, property, value, components.
play.set_axis (riesgo 0, requiere PIE, smoke)
Feeds an axis value (gamepad stick, mouse axis) for N frames.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. Axis key, e.g. "Gamepad_LeftX", "MouseX", or a digital key to feed as 1.0. |
value | number | Valor predeterminado 1.0. |
frames | integer | Frames to keep feeding the axis (each frame is ticked). Valor predeterminado 1. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: key, pressed, value, message.
play.set_paused (riesgo 0, requiere PIE, smoke)
Pauses or resumes PIE explicitly.
| Argumento | Tipo | Descripción |
|---|---|---|
paused | boolean | Valor predeterminado true. |
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
play.set_time_dilation (riesgo 0, requiere PIE, smoke)
Sets the global time dilation of the running world (slow motion / fast forward).
| Argumento | Tipo | Descripción |
|---|---|---|
value | number | 0.0001 - 20. Valor predeterminado 1.0. |
Devuelve: value.
play.set_view_target (riesgo 0, requiere PIE, smoke)
Sets the camera view target of a player to an actor.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. |
blendTime | number | Valor predeterminado 0.0. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: message.
play.spawn_actor (riesgo 0, smoke)
Spawns an actor of a class at a location in the PIE world and applies properties.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Actor class (native name, path or Blueprint). |
location | {x,y,z} | |
rotation | {x,y,z} | |
label | string | Editor label (also used as name hint). |
properties | array of UeaKeyValue | Property -> value applied after spawn. |
Devuelve: actor, message.
play.start (riesgo 1, requiere mundo)
Starts Play-In-Editor (optionally loading a map first, with N players / dedicated server).
| Argumento | Tipo | Descripción |
|---|---|---|
map | string | Optional map to load before playing (object or package path). Empty = current level. |
mode | string | "viewport" (selected viewport) or "window" (new editor window). Valor predeterminado TEXT("viewport"). |
players | integer | Number of clients (1 = single player). Valor predeterminado 1. |
dedicatedServer | boolean | Run a dedicated server alongside the clients. Valor predeterminado false. |
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
play.start_simulate (riesgo 0)
Starts Simulate-In-Editor (no player, editor camera free).
Sin argumentos.
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
play.status (riesgo 0, smoke)
Whether PIE is running, elapsed time, map, player pawn and location.
Sin argumentos.
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
play.stop (riesgo 1)
Stops Play-In-Editor.
Sin argumentos.
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
play.tap_key (riesgo 0, requiere PIE, smoke)
Press, let HoldFrames frames pass, release.
| Argumento | Tipo | Descripción |
|---|---|---|
key | string | obligatorio. FKey name, e.g. "SpaceBar", "W", "LeftMouseButton", "Gamepad_FaceButton_Bottom". |
holdFrames | integer | play.tap_key: frames to hold before releasing (1-600). Valor predeterminado 1. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: key, pressed, value, message.
play.teleport_actor (riesgo 0, smoke)
Teleports any actor (location, rotation, scale) in the running world.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | Actor label/name (play.teleport_actor). Ignored by play.teleport_player. |
location | {x,y,z} | |
rotation | {x,y,z} | |
hasRotation | boolean | Valor predeterminado false. |
scale | {x,y,z} | Optional uniform/explicit scale (0 = keep). |
hasScale | boolean | Valor predeterminado false. |
sweep | boolean | Stop at collisions on the way. Valor predeterminado false. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: actor, message.
play.teleport_player (riesgo 0, requiere PIE, smoke)
Teleports the player pawn (location, optional rotation).
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | Actor label/name (play.teleport_actor). Ignored by play.teleport_player. |
location | {x,y,z} | |
rotation | {x,y,z} | |
hasRotation | boolean | Valor predeterminado false. |
scale | {x,y,z} | Optional uniform/explicit scale (0 = keep). |
hasScale | boolean | Valor predeterminado false. |
sweep | boolean | Stop at collisions on the way. Valor predeterminado false. |
playerIndex | integer | Valor predeterminado 0. |
Devuelve: actor, message.
play.toggle_pause (riesgo 1, requiere PIE, smoke)
Pauses or resumes the running PIE session.
Sin argumentos.
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
play.toggle_simulate (riesgo 0)
Toggles between Play and Simulate (possess / eject).
Sin argumentos.
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
play.unpossess (riesgo 0, requiere PIE, smoke)
Unpossesses the current pawn of a player controller.
| Argumento | Tipo | Descripción |
|---|---|---|
playerIndex | integer | Local player index (0 = first player). Valor predeterminado 0. |
Devuelve: running, paused, map, elapsedSeconds, actorCount, playerPawn, playerLocation, gameMode.
plugin.add_dependency (riesgo 4, modifica)
Adds (or updates) a dependency entry in a plugin's .uplugin Plugins array.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
dependency | string | obligatorio. |
enabled | boolean | Valor predeterminado true. |
optional | boolean | Valor predeterminado false. |
Devuelve: plugin, dependencies.
plugin.find (riesgo 0, smoke)
Finds plugins by name substring (engine plugins included).
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
Devuelve: plugins, total.
plugin.for_asset (riesgo 0, smoke)
Which plugin (or the project/engine) mounts an asset or content path.
| Argumento | Tipo | Descripción |
|---|---|---|
asset | string | obligatorio. Object path (/Game/Foo/Bar.Bar), package path (/Game/Foo/Bar) or unique bare name. |
Devuelve: asset, mountPoint, source, plugin, contentDir.
plugin.get_dependencies (riesgo 0, smoke)
Plugins a plugin depends on (from its .uplugin), with found/enabled state; optionally transitive.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
recursive | boolean | Walk transitively. Valor predeterminado false. |
Devuelve: plugin, dependencies.
plugin.get_dependents (riesgo 0, smoke)
Discovered plugins that declare a dependency on the plugin.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
Devuelve: plugin, dependencies.
plugin.get_descriptor_json (riesgo 0, smoke)
Raw .uplugin JSON text.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
Devuelve: text, lines, savedTo, problems.
plugin.get_info (riesgo 0, smoke)
Descriptor, paths, modules and dependencies of one plugin.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
Devuelve: info, description, createdBy, createdByURL, docsURL, marketplaceURL, supportURL, engineVersion, contentDir, mountedAssetPath, descriptorFile, installed, explicitlyLoaded, requiresBuildPlatform, supportedTargetPlatforms, modules, dependencies.
plugin.list (riesgo 0, smoke)
Discovered plugins with enabled state, version, category and origin.
| Argumento | Tipo | Descripción |
|---|---|---|
contains | string | |
includeEngine | boolean | Include engine plugins (default false lists project + external plugins only). Valor predeterminado false. |
enabledOnly | boolean | Valor predeterminado false. |
contentOnly | boolean | Only plugins that can contain content. Valor predeterminado false. |
limit | integer | Valor predeterminado 500. |
Devuelve: plugins, total.
plugin.list_content_plugins (riesgo 0, smoke)
Enabled plugins that mount content, with their /PluginName/ mount points.
Sin argumentos.
Devuelve: plugins, total.
plugin.list_modules (riesgo 0, smoke)
Modules declared by a plugin with type, loading phase and loaded state.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
Devuelve: modules, loadedModuleCount.
plugin.remove_dependency (riesgo 4, modifica)
Removes a dependency entry from a plugin's .uplugin.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
dependency | string | obligatorio. |
enabled | boolean | Valor predeterminado true. |
optional | boolean | Valor predeterminado false. |
Devuelve: plugin, dependencies.
plugin.set_descriptor_field (riesgo 4, modifica)
Edits one descriptor field of a plugin and writes its .uplugin.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
field | string | obligatorio. FriendlyName, Description, Category, VersionName, Version, CreatedBy, CreatedByURL, DocsURL, MarketplaceURL, SupportURL, EngineVersion, CanContainContent, IsBetaVersion, IsExperimentalVersion, Installed, ExplicitlyLoaded, EnabledByDefault (true/false/unknown). |
value | string | obligatorio. |
Devuelve: info, description, createdBy, createdByURL, docsURL, marketplaceURL, supportURL, engineVersion, contentDir, mountedAssetPath, descriptorFile, installed, explicitlyLoaded, requiresBuildPlatform, supportedTargetPlatforms, modules, dependencies.
plugin.set_enabled (riesgo 4, modifica)
Enables or disables a plugin in the .uproject (takes effect after an editor restart). Not smoked: rewrites the .uproject.
| Argumento | Tipo | Descripción |
|---|---|---|
plugin | string | obligatorio. |
enabled | boolean | Valor predeterminado true. |
save | boolean | Write the .uproject immediately (default true). Valor predeterminado true. |
Devuelve: plugin, enabled, saved, restartRequired, message.
project.delete_file (riesgo 4, modifica, destructivo, smoke)
Deletes a file inside the project directory (not .uasset/.umap; use asset.delete for those).
| Argumento | Tipo | Descripción |
|---|---|---|
path | string | obligatorio. Absolute path, or relative to the project directory. Must stay inside the project or engine directory. |
content | string | project.write_file: content. |
append | boolean | project.write_file: append instead of overwrite. Valor predeterminado false. |
maxChars | integer | project.read_file: maximum characters returned (0 = 200k). Valor predeterminado 0. |
Devuelve: message.
project.find_class_header (riesgo 0)
Finds the header that declares a class and returns its declaration block. Not smoked: scans the whole engine Source tree (minutes on the game thread).
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Class name, path or Blueprint asset. |
Devuelve: class, file, line, declaration, truncated.
project.get_build_info (riesgo 0, smoke)
Engine version, changelist, branch, build configuration/date, platform, RHI, engine dir and association.
Sin argumentos.
Devuelve: engineVersion, engineVersionFull, changelist, branch, buildConfiguration, buildDate, buildVersion, engineInstalled, promotedBuild, platform, rhi, engineDir, engineAssociation, projectFile, projectHasCode, compiler.
project.get_capabilities (riesgo 0, smoke)
Feature detection: engine generation, Nanite/Lumen/ray tracing availability, plugins, kits and tool count.
Sin argumentos.
Devuelve: engine, uE5, naniteAvailable, lumenAvailable, rayTracingEnabled, worldPartition, chaos, enhancedInput, sourceControl, liveCoding, rhi, kits, toolCount, enabledProjectPlugins.
project.get_default_maps (riesgo 0, smoke)
Default maps, game modes and game instance class (GameMapsSettings).
Sin argumentos.
Devuelve: gameDefaultMap, editorStartupMap, serverDefaultMap, transitionMap, globalDefaultGameMode, globalDefaultServerGameMode, gameInstanceClass, configFile.
project.get_descriptor (riesgo 0, smoke)
The .uproject descriptor: engine association, category, modules, plugin references, target platforms.
Sin argumentos.
Devuelve: file, engineAssociation, category, description, isEnterprise, disableEnginePluginsByDefault, modules, plugins, targetPlatforms, additionalPluginDirectories, dirty.
project.get_paths (riesgo 0, smoke)
Absolute project and engine directories.
Sin argumentos.
Devuelve: projectFile, projectDir, contentDir, configDir, savedDir, logDir, intermediateDir, pluginsDir, sourceDir, engineDir, engineContentDir, engineConfigDir, enginePluginsDir, engineSourceDir, logFile.
project.get_version (riesgo 0, smoke)
Project name, version, company and legal fields (GeneralProjectSettings).
Sin argumentos.
Devuelve: projectName, projectVersion, projectID, companyName, companyDistinguishedName, description, homepage, copyrightNotice, supportContact, licensingTerms, privacyPolicy.
project.info (riesgo 0, smoke)
Project name, paths, engine version, current map, default maps and game mode, enabled plugins.
Sin argumentos.
Devuelve: projectName, projectDir, contentDir, engineVersion, currentMap, defaultGameMode, gameDefaultMap, editorStartupMap, enabledPlugins.
project.list_files (riesgo 0, smoke)
Lists files in a directory inside the project or engine (wildcard, recursive).
| Argumento | Tipo | Descripción |
|---|---|---|
directory | string | obligatorio. Directory (absolute or relative to the project). |
pattern | string | Wildcard, e.g. ".ini" or ".h". Valor predeterminado TEXT("*"). |
recursive | boolean | Valor predeterminado false. |
limit | integer | Valor predeterminado 500. |
Devuelve: files, total.
project.list_maps (riesgo 0, smoke)
Level assets of the project (and optionally engine) with the cook list from packaging settings.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | |
includeEngine | boolean | Valor predeterminado false. |
limit | integer | Valor predeterminado 300. |
Devuelve: maps, mapsToCook, cookAll, total.
project.list_modules (riesgo 0, smoke)
Modules of the project descriptor (game modules) with loaded state, plus the loaded-module count.
Sin argumentos.
Devuelve: modules, loadedModuleCount.
project.list_platforms (riesgo 0, smoke)
Target platforms known to the editor with SDK installed and project-supported flags.
Sin argumentos.
Devuelve: platforms, hostPlatform.
project.list_targets (riesgo 0, smoke)
.Target.cs files in the project Source folder.
Sin argumentos.
Devuelve: targets, hasSourceCode, sourceDir.
project.read_file (riesgo 0, smoke)
Reads a text file inside the project or engine directory.
| Argumento | Tipo | Descripción |
|---|---|---|
path | string | obligatorio. Absolute path, or relative to the project directory. Must stay inside the project or engine directory. |
content | string | project.write_file: content. |
append | boolean | project.write_file: append instead of overwrite. Valor predeterminado false. |
maxChars | integer | project.read_file: maximum characters returned (0 = 200k). Valor predeterminado 0. |
Devuelve: path, content, sizeBytes, truncated, modifiedUtc.
project.rename_file (riesgo 4, modifica, smoke)
Renames or moves a file inside the project directory.
| Argumento | Tipo | Descripción |
|---|---|---|
path | string | obligatorio. |
newPath | string | obligatorio. |
Devuelve: message.
project.search_headers (riesgo 0, smoke)
Grep-like search over engine and project C++ headers (.h).
| Argumento | Tipo | Descripción |
|---|---|---|
pattern | string | obligatorio. Text or regex searched in engine and project headers. |
regex | boolean | Valor predeterminado false. |
pathContains | string | Substring the file path must contain (e.g. "Runtime/Engine/Classes/GameFramework"). |
engine | boolean | Search project Source and Plugins too (default true) and engine Source (default true). Valor predeterminado true. |
project | boolean | Valor predeterminado true. |
contextLines | integer | Valor predeterminado 0. |
limit | integer | Valor predeterminado 50. |
maxFiles | integer | Maximum number of files scanned (safety cap). Valor predeterminado 20000. |
Devuelve: matches, filesScanned, truncated.
project.set_default_maps (riesgo 4, modifica)
Sets default maps / game modes / game instance in DefaultEngine.ini (only non-empty fields are applied).
| Argumento | Tipo | Descripción |
|---|---|---|
gameDefaultMap | string | Each field is applied only when non-empty. Maps accept /Game/... paths, classes accept names, paths or Blueprints. |
editorStartupMap | string | |
serverDefaultMap | string | |
transitionMap | string | |
globalDefaultGameMode | string | |
globalDefaultServerGameMode | string | |
gameInstanceClass | string |
Devuelve: gameDefaultMap, editorStartupMap, serverDefaultMap, transitionMap, globalDefaultGameMode, globalDefaultServerGameMode, gameInstanceClass, configFile.
project.set_descriptor_field (riesgo 4, modifica)
Edits Category, Description or EngineAssociation in the .uproject.
| Argumento | Tipo | Descripción |
|---|---|---|
field | string | obligatorio. Category, Description or EngineAssociation. |
value | string | obligatorio. |
Devuelve: file, engineAssociation, category, description, isEnterprise, disableEnginePluginsByDefault, modules, plugins, targetPlatforms, additionalPluginDirectories, dirty.
project.set_game_mode_classes (riesgo 4, modifica)
Sets the default classes of a GameMode (pawn, controller, HUD, game state, player state, spectator).
| Argumento | Tipo | Descripción |
|---|---|---|
gameMode | string | obligatorio. Game mode class or Blueprint whose defaults are edited. |
defaultPawnClass | string | |
playerControllerClass | string | |
hUDClass | string | |
gameStateClass | string | |
playerStateClass | string | |
spectatorClass | string | |
save | boolean | Valor predeterminado false. |
Devuelve: entries, count.
project.set_version (riesgo 4, modifica)
Sets project name/version/company/description fields in DefaultGame.ini.
| Argumento | Tipo | Descripción |
|---|---|---|
projectName | string | Each field is applied only when non-empty. |
projectVersion | string | |
companyName | string | |
companyDistinguishedName | string | |
description | string | |
homepage | string | |
copyrightNotice | string | |
supportContact | string | |
licensingTerms | string | |
privacyPolicy | string |
Devuelve: projectName, projectVersion, projectID, companyName, companyDistinguishedName, description, homepage, copyrightNotice, supportContact, licensingTerms, privacyPolicy.
project.write_file (riesgo 4, modifica, smoke)
Writes (or appends to) a text file inside the project directory. Never touches .uasset/.umap files.
| Argumento | Tipo | Descripción |
|---|---|---|
path | string | obligatorio. Absolute path, or relative to the project directory. Must stay inside the project or engine directory. |
content | string | project.write_file: content. |
append | boolean | project.write_file: append instead of overwrite. Valor predeterminado false. |
maxChars | integer | project.read_file: maximum characters returned (0 = 200k). Valor predeterminado 0. |
Devuelve: path, content, sizeBytes, truncated, modifiedUtc.
render.get_scalability (riesgo 0, smoke)
Current scalability level per group plus resolution quality.
Sin argumentos.
Devuelve: resolutionQuality, viewDistance, antiAliasing, shadow, globalIllumination, reflection, postProcess, texture, effects, foliage, shading, landscape, overall.
render.get_settings (riesgo 0, smoke)
Snapshot of the common rendering cvars, AA method, screen percentage, RHI and adapter.
Sin argumentos.
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_anti_aliasing (riesgo 1, smoke)
Sets the anti-aliasing method: none, fxaa, taa, msaa, tsr (UE 5).
| Argumento | Tipo | Descripción |
|---|---|---|
method | string | obligatorio. none, fxaa, taa, msaa, tsr (tsr needs UE 5). |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_gi_method (riesgo 1, UE 5.0+, smoke)
Dynamic global illumination method: none, lumen, ssgi, plugin (UE 5).
| Argumento | Tipo | Descripción |
|---|---|---|
method | string | obligatorio. GI: none, lumen, ssgi, plugin. Reflections: none, lumen, ssr. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_lumen (riesgo 1, UE 5.0+, smoke)
Lumen for GI and reflections, hardware ray tracing and GI quality (UE 5).
| Argumento | Tipo | Descripción |
|---|---|---|
globalIllumination | boolean | Use Lumen for global illumination. Valor predeterminado true. |
reflections | boolean | Use Lumen for reflections. Valor predeterminado true. |
hardwareRayTracing | integer | -1 keeps, 0/1 sets r.Lumen.HardwareRayTracing. Valor predeterminado -1. |
qualityLevel | integer | Scalability GI group 0-4 (-1 keeps). Valor predeterminado -1. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_max_fps (riesgo 1, smoke)
t.MaxFPS (0 = uncapped).
| Argumento | Tipo | Descripción |
|---|---|---|
value | number | Valor predeterminado 100.0. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_nanite (riesgo 1, UE 5.0+, smoke)
Nanite on/off and pixels-per-edge (UE 5).
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
maxPixelsPerEdge | number | r.Nanite.MaxPixelsPerEdge (0 = keep). Valor predeterminado 0.0. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_ray_tracing (riesgo 4, modifica)
Enables/disables ray tracing in the project settings (restart required) and the runtime toggle where available.
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_reflection_method (riesgo 1, UE 5.0+, smoke)
Reflection method: none, lumen, ssr (UE 5).
| Argumento | Tipo | Descripción |
|---|---|---|
method | string | obligatorio. GI: none, lumen, ssgi, plugin. Reflections: none, lumen, ssr. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_scalability (riesgo 1)
Sets one scalability group (or all) to a level 0-4 / low..cinematic and optionally persists it. Not smoke-tested: it would override the user's scalability settings.
| Argumento | Tipo | Descripción |
|---|---|---|
group | string | Group: ViewDistance, AntiAliasing, Shadow, GlobalIllumination, Reflection, PostProcess, Texture, Effects, Foliage, Shading, Landscape or "all". Valor predeterminado TEXT("all"). |
level | string | 0 low, 1 medium, 2 high, 3 epic, 4 cinematic (or the words). Valor predeterminado TEXT("3"). |
resolutionQuality | number | Resolution quality percentage (0 = keep). Valor predeterminado 0.0. |
persist | boolean | Save to GameUserSettings.ini. Valor predeterminado false. |
Devuelve: resolutionQuality, viewDistance, antiAliasing, shadow, globalIllumination, reflection, postProcess, texture, effects, foliage, shading, landscape, overall.
render.set_screen_percentage (riesgo 1, smoke)
Sets r.ScreenPercentage (10-200).
| Argumento | Tipo | Descripción |
|---|---|---|
value | number | Valor predeterminado 100.0. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_shadow_quality (riesgo 1, smoke)
Shadow map resolution, cascade count, distance scale and scalability group.
| Argumento | Tipo | Descripción |
|---|---|---|
maxResolution | integer | r.Shadow.MaxResolution (0 = keep). Valor predeterminado 0. |
maxCascades | integer | r.Shadow.CSM.MaxCascades (0 = keep). Valor predeterminado 0. |
distanceScale | number | r.Shadow.DistanceScale (0 = keep). Valor predeterminado 0.0. |
qualityLevel | integer | Scalability shadow group 0-4 (-1 = keep). Valor predeterminado -1. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
render.set_vsync (riesgo 1, smoke)
r.VSync.
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
Devuelve: values, antiAliasingMethod, screenPercentage, rhi, adapter, rayTracingProjectSetting, globalIlluminationMethod, reflectionMethod, nanite, lumenHardwareRayTracing.
settings.diff_from_default (riesgo 0, smoke)
Keys the project Default
| Argumento | Tipo | Descripción |
|---|---|---|
file | string | obligatorio. Config branch ("Engine", "Game", ...). |
sectionContains | string | |
limit | integer | Valor predeterminado 500. |
Devuelve: projectFile, baseFile, entries, total.
settings.flush (riesgo 4)
Writes the in-memory state of a config branch to disk. Not smoked: writes ini files to disk.
| Argumento | Tipo | Descripción |
|---|---|---|
file | string | obligatorio. Config branch: "Engine", "Game", "Input", "Editor", "EditorPerProjectUserSettings", "GameUserSettings", "Scalability", "DeviceProfiles" or an absolute .ini path. |
section | string | Section name, e.g. "/Script/Engine.RendererSettings" or "ConsoleVariables". |
key | string | |
value | string | Used by settings.set_ini. |
writeDefault | boolean | settings.set_ini: also write to the project Defaulttrue. |
Devuelve: message.
settings.get (riesgo 0, smoke)
Reads a project/engine setting (GameMapsSettings, InputSettings, RendererSettings, any UDeveloperSettings).
| Argumento | Tipo | Descripción |
|---|---|---|
section | string | obligatorio. Settings class: "GameMapsSettings", "EngineSettings", "InputSettings", "RendererSettings", "CollisionProfile" or any UDeveloperSettings / config class name. |
property | string | obligatorio. Property name, e.g. "GlobalDefaultGameMode". |
value | string | New value in text form (used by settings.set). Object references use full paths. |
Devuelve: section, property, value, configFile.
settings.get_class_schema (riesgo 0, smoke)
Properties of a settings class: type, category, tooltip, enum values and current value.
| Argumento | Tipo | Descripción |
|---|---|---|
section | string | obligatorio. Settings class (see settings.list_classes), e.g. "RendererSettings", "GameMapsSettings", "EditorPerProjectUserSettings". |
includeValues | boolean | Valor predeterminado true. |
configOnly | boolean | Only properties saved to config. Valor predeterminado true. |
category | string | |
limit | integer | Valor predeterminado 300. |
Devuelve: class, configFile, defaultConfigFile, properties, total.
settings.get_game_maps (riesgo 0, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
fields | array of UeaKeyValue | Property assignments from the tool's documented allowlist; setters require at least one. |
dryRun | boolean | Report changes without saving config. Valor predeterminado false. |
Devuelve: fields, warnings, dryRun.
settings.get_general_project (riesgo 0, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
fields | array of UeaKeyValue | Property assignments from the tool's documented allowlist; setters require at least one. |
dryRun | boolean | Report changes without saving config. Valor predeterminado false. |
Devuelve: fields, warnings, dryRun.
settings.get_ini (riesgo 0, smoke)
Reads one ini value as the engine resolves it (all layers merged).
| Argumento | Tipo | Descripción |
|---|---|---|
file | string | obligatorio. Config branch: "Engine", "Game", "Input", "Editor", "EditorPerProjectUserSettings", "GameUserSettings", "Scalability", "DeviceProfiles" or an absolute .ini path. |
section | string | Section name, e.g. "/Script/Engine.RendererSettings" or "ConsoleVariables". |
key | string | |
value | string | Used by settings.set_ini. |
writeDefault | boolean | settings.set_ini: also write to the project Defaulttrue. |
Devuelve: file, section, key, value, found, writtenTo.
settings.get_ini_section (riesgo 0, smoke)
Every key/value of an ini section (merged view).
| Argumento | Tipo | Descripción |
|---|---|---|
file | string | obligatorio. Config branch: "Engine", "Game", "Input", "Editor", "EditorPerProjectUserSettings", "GameUserSettings", "Scalability", "DeviceProfiles" or an absolute .ini path. |
section | string | Section name, e.g. "/Script/Engine.RendererSettings" or "ConsoleVariables". |
key | string | |
value | string | Used by settings.set_ini. |
writeDefault | boolean | settings.set_ini: also write to the project Defaulttrue. |
Devuelve: file, section, entries, exists.
settings.get_many (riesgo 0, smoke)
Reads several properties of a settings class.
| Argumento | Tipo | Descripción |
|---|---|---|
section | string | obligatorio. |
properties | array of string | settings.get_many: property names. |
values | array of UeaKeyValue | settings.set_many: property -> value. |
Devuelve: entries, count.
settings.get_ui (riesgo 0, smoke)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
fields | array of UeaKeyValue | Property assignments from the tool's documented allowlist; setters require at least one. |
dryRun | boolean | Report changes without saving config. Valor predeterminado false. |
Devuelve: fields, warnings, dryRun.
settings.list_categories (riesgo 0, smoke)
Categories of a settings container (Game, Engine, Editor, Plugins, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
container | string | "Project" or "Editor" (empty = both). |
category | string | Category inside the container (settings.list_sections). |
Devuelve: items, total.
settings.list_classes (riesgo 0, smoke)
Every settings/config class with container, category, section, config file and module.
| Argumento | Tipo | Descripción |
|---|---|---|
contains | string | Substring filter on class, section or category name. |
container | string | "Project", "Editor" or empty for both. |
category | string | |
limit | integer | Valor predeterminado 300. |
Devuelve: classes, total.
settings.list_containers (riesgo 0, smoke)
Settings containers ("Project", "Editor") as shown in the settings windows.
Sin argumentos.
Devuelve: items, total.
settings.list_files (riesgo 0, smoke)
Known config branches (Engine, Game, Input, Editor, ...) with the project Default*.ini and user files.
Sin argumentos.
Devuelve: files, projectConfigDir, engineConfigDir.
settings.list_ini_sections (riesgo 0, smoke)
Section names of a config branch.
| Argumento | Tipo | Descripción |
|---|---|---|
file | string | obligatorio. |
contains | string | |
limit | integer | Valor predeterminado 500. |
Devuelve: items, total.
settings.list_sections (riesgo 0, smoke)
Sections (settings classes) of a container/category with their class names.
| Argumento | Tipo | Descripción |
|---|---|---|
container | string | "Project" or "Editor" (empty = both). |
category | string | Category inside the container (settings.list_sections). |
Devuelve: classes, total.
settings.reload (riesgo 4)
Reloads a settings class from the ini files, discarding unsaved in-memory changes.
| Argumento | Tipo | Descripción |
|---|---|---|
section | string | obligatorio. |
Devuelve: message.
settings.remove_ini_key (riesgo 4, modifica, destructivo)
Removes a key from the in-memory config and the project Default
| Argumento | Tipo | Descripción |
|---|---|---|
file | string | obligatorio. Config branch: "Engine", "Game", "Input", "Editor", "EditorPerProjectUserSettings", "GameUserSettings", "Scalability", "DeviceProfiles" or an absolute .ini path. |
section | string | Section name, e.g. "/Script/Engine.RendererSettings" or "ConsoleVariables". |
key | string | |
value | string | Used by settings.set_ini. |
writeDefault | boolean | settings.set_ini: also write to the project Defaulttrue. |
Devuelve: file, section, key, value, found, writtenTo.
settings.reset_to_defaults (riesgo 5, modifica, destructivo)
Removes the project overrides of a settings class from Default*.ini and reloads it (engine defaults apply).
| Argumento | Tipo | Descripción |
|---|---|---|
section | string | obligatorio. |
Devuelve: message.
settings.save (riesgo 4)
Saves a settings class to its Default*.ini (after edits made through object.set_property).
| Argumento | Tipo | Descripción |
|---|---|---|
section | string | obligatorio. |
Devuelve: message.
settings.search_ini (riesgo 0, smoke)
Full-text search over sections, keys and values of the loaded ini files.
| Argumento | Tipo | Descripción |
|---|---|---|
query | string | obligatorio. Substring searched in section names, keys and values (case-insensitive). |
file | string | Restrict to one config branch. Empty = every loaded ini. |
limit | integer | Valor predeterminado 200. |
Devuelve: matches, total.
settings.set (riesgo 4, modifica)
Writes a project/engine setting and saves its config file. Not smoke-tested: it would permanently change the user's project config.
| Argumento | Tipo | Descripción |
|---|---|---|
section | string | obligatorio. Settings class: "GameMapsSettings", "EngineSettings", "InputSettings", "RendererSettings", "CollisionProfile" or any UDeveloperSettings / config class name. |
property | string | obligatorio. Property name, e.g. "GlobalDefaultGameMode". |
value | string | New value in text form (used by settings.set). Object references use full paths. |
Devuelve: section, property, value, configFile.
settings.set_game_maps_fields (riesgo 4, modifica, dryRun)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
fields | array of UeaKeyValue | Property assignments from the tool's documented allowlist; setters require at least one. |
dryRun | boolean | Report changes without saving config. Valor predeterminado false. |
Devuelve: fields, warnings, dryRun.
settings.set_general_project_fields (riesgo 4, modifica, dryRun)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
fields | array of UeaKeyValue | Property assignments from the tool's documented allowlist; setters require at least one. |
dryRun | boolean | Report changes without saving config. Valor predeterminado false. |
Devuelve: fields, warnings, dryRun.
settings.set_ini (riesgo 4, modifica)
Writes an ini value to the in-memory config and (by default) to the project Default
| Argumento | Tipo | Descripción |
|---|---|---|
file | string | obligatorio. Config branch: "Engine", "Game", "Input", "Editor", "EditorPerProjectUserSettings", "GameUserSettings", "Scalability", "DeviceProfiles" or an absolute .ini path. |
section | string | Section name, e.g. "/Script/Engine.RendererSettings" or "ConsoleVariables". |
key | string | |
value | string | Used by settings.set_ini. |
writeDefault | boolean | settings.set_ini: also write to the project Defaulttrue. |
Devuelve: file, section, key, value, found, writtenTo.
settings.set_many (riesgo 4, modifica)
Writes several properties of a settings class and saves the Default*.ini.
| Argumento | Tipo | Descripción |
|---|---|---|
section | string | obligatorio. |
properties | array of string | settings.get_many: property names. |
values | array of UeaKeyValue | settings.set_many: property -> value. |
Devuelve: succeeded, failed, succeededCount, failedCount.
settings.set_ui_fields (riesgo 4, modifica, dryRun)
Sin descripción.
| Argumento | Tipo | Descripción |
|---|---|---|
fields | array of UeaKeyValue | Property assignments from the tool's documented allowlist; setters require at least one. |
dryRun | boolean | Report changes without saving config. Valor predeterminado false. |
Devuelve: fields, warnings, dryRun.
view.capture_compare (riesgo 0, smoke)
Before/after image pair: the capture stored by edit.checkpoint_create {withPreview:true} and a capture of the same view now (same size), plus the fraction of changed pixels.
| Argumento | Tipo | Descripción |
|---|---|---|
checkpoint | string | obligatorio. Checkpoint created with withPreview:true. |
format | string | png or jpg. Valor predeterminado TEXT("png"). |
Devuelve: checkpoint, images, changedPixelRatio, beforeKind, afterKind, notes.
view.clear_bookmark (riesgo 0, smoke)
Clears a bookmark slot.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | Bookmark slot 0-9. Valor predeterminado 0. |
Devuelve: bookmarks, maxBookmarks.
view.eject_pilot (riesgo 0, smoke)
Stops piloting.
Sin argumentos.
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.focus_actors (riesgo 0)
Frames the given actors (or the current selection) in the viewport. Needs an actor; the self-test level is empty.
| Argumento | Tipo | Descripción |
|---|---|---|
actors | array of string | Actor labels/names; empty = current selection. |
instant | boolean | Valor predeterminado true. |
Devuelve: location, rotation, fov, width, height.
view.focus_point (riesgo 0, smoke)
Frames a world point at a distance.
| Argumento | Tipo | Descripción |
|---|---|---|
location | {x,y,z} | obligatorio. |
distance | number | Distance from the point (cm). Valor predeterminado 500.0. |
instant | boolean | Valor predeterminado true. |
Devuelve: location, rotation, fov, width, height.
view.get_camera (riesgo 0, smoke)
Level viewport camera location, rotation, FOV and size.
Sin argumentos.
Devuelve: location, rotation, fov, width, height.
view.get_info (riesgo 0, smoke)
Everything about the active level viewport: type, view mode, realtime, game view, FOV, clip planes, speed, pilot, snapping, plus every other viewport.
Sin argumentos.
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.get_show_flags (riesgo 0, smoke)
Lists engine show flags with their state in the active viewport.
| Argumento | Tipo | Descripción |
|---|---|---|
contains | string | |
enabledOnly | boolean | Valor predeterminado false. |
limit | integer | Valor predeterminado 400. |
Devuelve: flags, total.
view.get_snap (riesgo 0, smoke)
Grid / rotation / scale / surface snapping state and sizes.
Sin argumentos.
Devuelve: gridSnap, rotationSnap, scaleSnap, surfaceSnap, gridSize, rotationGridDegrees, scaleGridSize, gridSizes.
view.get_visible_actors (riesgo 0, smoke)
Actors whose bounds intersect the viewport frustum, nearest first, with screen coordinates.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | |
includeHidden | boolean | Valor predeterminado false. |
limit | integer | Valor predeterminado 200. |
Devuelve: actors, total.
view.jump_to_bookmark (riesgo 0, smoke)
Jumps the camera to a bookmark slot.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | Bookmark slot 0-9. Valor predeterminado 0. |
Devuelve: location, rotation, fov, width, height.
view.list_bookmarks (riesgo 0, smoke)
Bookmark slots of the current level with their camera poses.
Sin argumentos.
Devuelve: bookmarks, maxBookmarks.
view.pilot_actor (riesgo 0)
Makes the viewport follow an actor (pilot / lock camera to actor). Needs an actor; the self-test level is empty.
| Argumento | Tipo | Descripción |
|---|---|---|
actors | array of string | Actor labels/names; empty = current selection. |
instant | boolean | Valor predeterminado true. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.redraw (riesgo 0, smoke)
Redraws every level viewport.
Sin argumentos.
Devuelve: message.
view.screen_to_world (riesgo 0, smoke)
Deprojects normalised viewport coordinates and optionally traces into the level.
| Argumento | Tipo | Descripción |
|---|---|---|
u | number | Normalised 0..1 (origin top-left). Valor predeterminado 0.5. |
v | number | Valor predeterminado 0.5. |
trace | boolean | Trace into the level and report the hit. Valor predeterminado true. |
distance | number | Valor predeterminado 100000.0. |
Devuelve: origin, direction, hit, hitLocation, hitNormal, hitActor, distance.
view.screenshot (riesgo 0, smoke)
Canonical viewport capture returned as an image: the active level viewport (or the PIE viewport while playing), optionally framed on actors and with temporary show-flag overrides, bounded by width/height/maxSize, PNG or JPG.
| Argumento | Tipo | Descripción |
|---|---|---|
savePath | string | Optional absolute path to also write the image on disk. |
maxSize | integer | Longest side in pixels for the returned image (0 = native). Valor predeterminado 1280. |
width | integer | Maximum width in pixels (0 = no limit); the aspect ratio is kept and nothing is upscaled. Valor predeterminado 0. |
height | integer | Maximum height in pixels (0 = no limit). Valor predeterminado 0. |
frameActors | array of string | Frame these actors (label, name or class: |
showFlags | TMap<FString, bool> | Temporary show-flag overrides for the capture, e.g. {"Grid":false,"Fog":true}; restored afterwards. |
format | string | png or jpg. Valor predeterminado TEXT("png"). |
Devuelve: width, height, savedTo, imageBase64, imageMimeType.
view.screenshot_editor (riesgo 0)
Captures the whole editor window (Slate UI included) as a PNG image block. Needs a real editor window.
| Argumento | Tipo | Descripción |
|---|---|---|
maxSize | integer | Longest side in pixels for the returned image (0 = native). Valor predeterminado 1600. |
savePath | string |
Devuelve: width, height, savedTo, imageBase64, imageMimeType.
view.screenshot_from (riesgo 0)
Captures the level viewport from a temporary camera pose (restored afterwards) as a PNG image block. Needs a real rendered viewport.
| Argumento | Tipo | Descripción |
|---|---|---|
location | {x,y,z} | |
rotation | {x,y,z} | |
hasLookAt | boolean | Valor predeterminado false. |
lookAt | {x,y,z} | |
fov | number | 0 = keep the viewport FOV. Valor predeterminado 0.0. |
gameView | boolean | Hide editor gizmos/icons while capturing. Valor predeterminado true. |
maxSize | integer | Valor predeterminado 1280. |
savePath | string |
Devuelve: width, height, savedTo, imageBase64, imageMimeType.
view.set_active_viewport (riesgo 0, smoke)
Makes viewport N the active one (see view.get_info AllViewports).
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | Valor predeterminado 0. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_bookmark (riesgo 0, smoke)
Stores the current camera in bookmark slot 0-9.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | Bookmark slot 0-9. Valor predeterminado 0. |
Devuelve: bookmarks, maxBookmarks.
view.set_camera (riesgo 1, smoke)
Moves the level viewport camera (location + rotation, look-at point, or frame an actor).
| Argumento | Tipo | Descripción |
|---|---|---|
location | {x,y,z} | |
rotation | {x,y,z} | Pitch, Yaw, Roll. Ignored when LookAt is set. |
lookAt | {x,y,z} | Point the camera at this world position. |
hasLocation | boolean | Valor predeterminado true. |
hasRotation | boolean | Valor predeterminado false. |
hasLookAt | boolean | Valor predeterminado false. |
focusActor | string | Frame this actor (label/name) instead of using Location/Rotation. |
Devuelve: location, rotation, fov, width, height.
view.set_camera_speed (riesgo 0, smoke)
Sets the fly-camera speed notch (1-8) and, before 5.7, the speed scalar.
| Argumento | Tipo | Descripción |
|---|---|---|
setting | integer | Toolbar notch 1-8 (0 = keep). Valor predeterminado 0. |
scalar | number | Speed scalar (0 = keep). Ignored on 5.7+ where only the notch applies. Valor predeterminado 0.0. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_clip_planes (riesgo 0, smoke)
Overrides the near/far clip planes (cm).
| Argumento | Tipo | Descripción |
|---|---|---|
near | number | Near clip plane in cm (0 = keep). Valor predeterminado 0.0. |
far | number | Far clip plane in cm (0 = keep). Valor predeterminado 0.0. |
clearFar | boolean | Remove the far clip override. Valor predeterminado false. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_fov (riesgo 0, smoke)
Sets the viewport FOV in degrees.
| Argumento | Tipo | Descripción |
|---|---|---|
fov | number | Horizontal FOV in degrees (5-170). Valor predeterminado 90.0. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_game_view (riesgo 0, smoke)
Toggles Game View (hides editor icons, gizmos and editor-only actors).
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_immersive (riesgo 0, smoke)
Toggles immersive (maximised) mode of the active level viewport.
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_ortho_zoom (riesgo 0, smoke)
Ortho zoom of the active viewport (orthographic types only).
| Argumento | Tipo | Descripción |
|---|---|---|
zoom | number | Valor predeterminado 10000.0. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_realtime (riesgo 0, smoke)
Toggles realtime rendering (needed for Niagara, animation and material previews).
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_show_flag (riesgo 0, smoke)
Turns one engine show flag on or off by name (Grid, Bounds, Collision, Navigation, Fog, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
flag | string | obligatorio. Show flag name, e.g. "Grid", "Bounds", "Collision", "Navigation", "PostProcessing", "Fog", "Particles", "StaticMeshes", "Landscape", "BSP", "Wireframe". |
enabled | boolean | Valor predeterminado true. |
Devuelve: flags, total.
view.set_snap (riesgo 0, smoke)
Sets snapping toggles and grid size indices.
| Argumento | Tipo | Descripción |
|---|---|---|
gridSnap | integer | -1 keeps, 0/1 sets. Valor predeterminado -1. |
rotationSnap | integer | Valor predeterminado -1. |
scaleSnap | integer | Valor predeterminado -1. |
surfaceSnap | integer | Valor predeterminado -1. |
gridSizeIndex | integer | Index into the grid size list (0 = keep). Valor predeterminado -1. |
rotationGridIndex | integer | Valor predeterminado -1. |
scaleGridIndex | integer | Valor predeterminado -1. |
Devuelve: gridSnap, rotationSnap, scaleSnap, surfaceSnap, gridSize, rotationGridDegrees, scaleGridSize, gridSizes.
view.set_type (riesgo 0, smoke)
Switches the projection: perspective, top, bottom, left, right, front, back.
| Argumento | Tipo | Descripción |
|---|---|---|
type | string | obligatorio. perspective, top, bottom, left, right, front, back (or free ortho). |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.set_view_mode (riesgo 0, smoke)
Switches the view mode (lit, unlit, wireframe, detail_lighting, shader_complexity, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
mode | string | obligatorio. lit, unlit, wireframe, brush_wireframe, detail_lighting, lighting_only, light_complexity, shader_complexity, lightmap_density, stationary_light_overlap, reflections, player_collision, visibility_collision, lod_coloration, hlod_coloration, path_tracing, ray_tracing_debug, buffer_visualization, quad_overdraw, or a VMI_* name. |
Devuelve: viewport, nearClip, farClip, cameraSpeedSetting, cameraSpeed, immersive, pilotActor, gridSnap, rotationSnap, scaleSnap, gridSize, rotationGridDegrees, scaleGridSize, allViewports.
view.world_to_screen (riesgo 0, smoke)
Projects a world position to normalised viewport coordinates and pixels.
| Argumento | Tipo | Descripción |
|---|---|---|
position | {x,y,z} | obligatorio. |
Devuelve: u, v, pixelX, pixelY, onScreen, inFront.