Kit project
11 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
The project.* tools inspect the active Unreal project's durable configuration and editor
capabilities. They are read-only: they never save an INI, rewrite a .uproject, enable a plugin,
open a map, or start packaging.
Use project.info first for the compact core summary. Enable the project kit when you need the
detail below.
| Prefix | Use it for |
|---|---|
project.get_descriptor | .uproject metadata, declared target platforms and module declarations |
project.get_game_defaults | editor/game default maps, game instance, default modes and configured overrides |
project.get_game_mode_for_map | resolving the mode selected by the GameMapsSettings rules for a map |
project.get_packaging_settings | build-configuration and cook/container defaults without packaging |
project.list_target_platforms | target platforms available in this editor and their reported packaging capability |
project.list_settings_containers / project.list_settings_sections | settings pages supplied by the editor and enabled plugins |
Start with this discovery sequence:
- Call
project.infoto identify the project, engine, current map and enabled project plugins. - Call
project.get_descriptorto inspect.uprojectmetadata and declared code modules. - Use
project.list_descriptor_pluginsandproject.get_descriptor_modulefor descriptor-only ownership checks; neither loads modules or plugins. - Use
project.audit_startup_mapsandproject.audit_packaging_pathsto find unresolved configuration references without opening a map or packaging. - Call
project.get_game_defaultsbefore changing how a game starts; it exposes map, instance and GameMode defaults together. - For a specific map, call
project.get_game_mode_for_mapwith a package path such as/Game/Maps/Arena. - Call
project.get_packaging_settingsto review build and cook defaults. Treat itswarningsas unavailable properties, not an instruction to edit config manually. - Call
project.list_target_platformsto see the platforms this editor knows about. A platform's packaging flag does not validate SDK, signing or device readiness. - Call
project.list_settings_containers, thenproject.list_settings_sections, to discover the exact settings class and config file supplied by an enabled plugin. - Read one known property with
settings.get. Usesettings.setonly when a deliberate config change is required; it has project-config risk and persists to disk.
project.get_game_defaults reports configured paths. It does not assert that those maps or classes
exist. Use asset.find or level.list_maps to locate map assets, and use level.* for world-level
game-mode overrides. project.get_game_mode_for_map applies the configured GameMapsSettings rules
without loading the map, so an unrecognized map can still resolve to the global default.
Packaging settings are a summary for planning. This kit never invokes a package, edits cook lists, or claims that a target platform's SDK is installed. Build execution and validation are separate workflows.
The settings inventory intentionally lists visible sections only. It is useful for discovering
plugin-provided settings, then passing the reported settingsClass and a property name to
settings.get. Plugin enablement and arbitrary config editing remain in the edit kit.
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.
project.audit_packaging_paths (riesgo 0, smoke)
Audits configured cook, staging, and non-asset paths without changing config or packaging.
Sin argumentos.
Devuelve: paths, missingCount, warnings.
project.audit_startup_maps (riesgo 0, smoke)
Audits startup map and class references without opening maps.
Sin argumentos.
Devuelve: items, missingCount, notes.
project.get_descriptor (riesgo 0, smoke)
Reads metadata, target platforms and module declarations from the active .uproject descriptor.
Sin argumentos.
Devuelve: projectFile, engineAssociation, category, description, targetPlatforms, modules, disableEnginePluginsByDefault.
project.get_descriptor_module (riesgo 0)
Returns one project-descriptor module declaration without loading that module.
| Argumento | Tipo | Descripción |
|---|---|---|
module | string | obligatorio. Module name declared in the current .uproject descriptor. |
Devuelve: module.
project.get_game_defaults (riesgo 0, smoke)
Lists configured editor/game maps, game instance, game modes and map/URL override rules.
Sin argumentos.
Devuelve: editorStartupMap, gameDefaultMap, gameInstanceClass, defaultGameMode, defaultServerGameMode, mapPrefixRules, classAliases.
project.get_game_mode_for_map (riesgo 0, smoke)
Resolves the configured GameMode for one map without opening or changing that map.
| Argumento | Tipo | Descripción |
|---|---|---|
map | string | obligatorio. Map package or object path, for example /Game/Maps/Entry. |
Devuelve: map, gameMode.
project.get_packaging_settings (riesgo 0, smoke)
Reads selected Project Packaging settings without writing config or starting a package.
Sin argumentos.
Devuelve: settingsClass, configFile, values, warnings.
project.list_descriptor_plugins (riesgo 0, smoke)
Lists plugin references declared by the active .uproject without loading plugins.
Sin argumentos.
Devuelve: plugins, count.
project.list_settings_containers (riesgo 0, smoke)
Lists Settings containers registered by the editor and enabled plugins.
Sin argumentos.
Devuelve: containers, count.
project.list_settings_sections (riesgo 0, smoke)
Lists every visible Settings section, its class and its config file when available.
Sin argumentos.
Devuelve: sections, count.
project.list_target_platforms (riesgo 0, smoke)
Lists installed target platforms and their packaging capability reported by the editor.
Sin argumentos.
Devuelve: platforms, count.