Pular para o conteúdo principal

Kit project

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

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

Guia​

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.

PrefixUse it for
project.get_descriptor.uproject metadata, declared target platforms and module declarations
project.get_game_defaultseditor/game default maps, game instance, default modes and configured overrides
project.get_game_mode_for_mapresolving the mode selected by the GameMapsSettings rules for a map
project.get_packaging_settingsbuild-configuration and cook/container defaults without packaging
project.list_target_platformstarget platforms available in this editor and their reported packaging capability
project.list_settings_containers / project.list_settings_sectionssettings pages supplied by the editor and enabled plugins

Start with this discovery sequence:

  1. Call project.info to identify the project, engine, current map and enabled project plugins.
  2. Call project.get_descriptor to inspect .uproject metadata and declared code modules.
  3. Use project.list_descriptor_plugins and project.get_descriptor_module for descriptor-only ownership checks; neither loads modules or plugins.
  4. Use project.audit_startup_maps and project.audit_packaging_paths to find unresolved configuration references without opening a map or packaging.
  5. Call project.get_game_defaults before changing how a game starts; it exposes map, instance and GameMode defaults together.
  6. For a specific map, call project.get_game_mode_for_map with a package path such as /Game/Maps/Arena.
  7. Call project.get_packaging_settings to review build and cook defaults. Treat its warnings as unavailable properties, not an instruction to edit config manually.
  8. Call project.list_target_platforms to see the platforms this editor knows about. A platform's packaging flag does not validate SDK, signing or device readiness.
  9. Call project.list_settings_containers, then project.list_settings_sections, to discover the exact settings class and config file supplied by an enabled plugin.
  10. Read one known property with settings.get. Use settings.set only 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.

Ferramentas​

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

project.audit_packaging_paths (risco 0, smoke)​

Audits configured cook, staging, and non-asset paths without changing config or packaging.

Sem argumentos.

Retorna: paths, missingCount, warnings.

project.audit_startup_maps (risco 0, smoke)​

Audits startup map and class references without opening maps.

Sem argumentos.

Retorna: items, missingCount, notes.

project.get_descriptor (risco 0, smoke)​

Reads metadata, target platforms and module declarations from the active .uproject descriptor.

Sem argumentos.

Retorna: projectFile, engineAssociation, category, description, targetPlatforms, modules, disableEnginePluginsByDefault.

project.get_descriptor_module (risco 0)​

Returns one project-descriptor module declaration without loading that module.

ArgumentoTipoDescrição
modulestringobrigatório. Module name declared in the current .uproject descriptor.

Retorna: module.

project.get_game_defaults (risco 0, smoke)​

Lists configured editor/game maps, game instance, game modes and map/URL override rules.

Sem argumentos.

Retorna: editorStartupMap, gameDefaultMap, gameInstanceClass, defaultGameMode, defaultServerGameMode, mapPrefixRules, classAliases.

project.get_game_mode_for_map (risco 0, smoke)​

Resolves the configured GameMode for one map without opening or changing that map.

ArgumentoTipoDescrição
mapstringobrigatório. Map package or object path, for example /Game/Maps/Entry.

Retorna: map, gameMode.

project.get_packaging_settings (risco 0, smoke)​

Reads selected Project Packaging settings without writing config or starting a package.

Sem argumentos.

Retorna: settingsClass, configFile, values, warnings.

project.list_descriptor_plugins (risco 0, smoke)​

Lists plugin references declared by the active .uproject without loading plugins.

Sem argumentos.

Retorna: plugins, count.

project.list_settings_containers (risco 0, smoke)​

Lists Settings containers registered by the editor and enabled plugins.

Sem argumentos.

Retorna: containers, count.

project.list_settings_sections (risco 0, smoke)​

Lists every visible Settings section, its class and its config file when available.

Sem argumentos.

Retorna: sections, count.

project.list_target_platforms (risco 0, smoke)​

Lists installed target platforms and their packaging capability reported by the editor.

Sem argumentos.

Retorna: platforms, count.