Kit tests
10 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
Use tests to observe the Automation Controller without starting or waiting for tests, and to author level AFunctionalTest actors. Use edit.list_tests to enumerate the framework registry and edit.run_test or edit.run_tests only when execution is intended.
Start by checking whether the editor has an Automation Controller and whether it has workers or prior reports:
tests.get_automation_status {}
tests.inspect_automation_reports {"contains":"Project","limit":25}
The status tool never loads the controller. If the module is available but has not discovered workers, request discovery once and poll status; the request returns immediately and does not start a test:
tests.request_automation_discovery {}
tests.get_automation_status {}
tests.inspect_automation_reports reads the controller's filtered report tree. It does not export files, clear history, or run a test. Use includeGroups:true only when you need hierarchy nodes as well as leaf reports. Empty state/result fields mean the controller has not received a result from a device; they do not mean success.
Use tests.get_automation_report {fullPath} after discovery for a single exact report. In an editor world, tests.get_functional_test_details {actor} returns current configuration and tests.audit_functional_tests {} reports disabled, running, undocumented, and unbounded tests without executing them.
Functional Tests are level actors. To add a small configured fixture to the current editor world, then inspect it:
tests.create_functional_test {
"name":"FT_OpenDoor",
"location":{"x":0,"y":0,"z":100},
"description":"Door opens after the trigger is entered",
"enabled":true,
"setTimeLimit":true,
"timeLimit":10
}
tests.list_functional_tests {"contains":"OpenDoor"}
Update only the fields that need changing. setDescription and setTimeLimit distinguish an intentional empty description or zero timeout from leaving those values alone:
tests.update_functional_test {
"actor":"FT_OpenDoor",
"enabled":true,
"setDescription":true,
"description":"Opens after one trigger entry",
"setTimeLimit":true,
"timeLimit":8
}
AFunctionalTest itself is an actor, not a standalone asset. Use bp.* to create a Functional Test Blueprint when its behaviour needs Blueprint events, and use level.*/asset.* for the map that contains it. Generic actor operations remain in actor.*.
Do not call test-execution tools from edit.self_test: automation and Functional Tests can require frames, maps, PIE, or worker messaging while the self-test holds the game thread. This kit deliberately provides no run, stop, clear, or export operation.
tests.get_functional_test_details {actor} inspects one Functional Test actor without running it, and
tests.remove_functional_test {actor} deletes one from the editor level (refused while it runs).
tests.request_automation_discovery and tests.get_automation_report need Automation Controller
workers, so they are not part of the unattended self-test.
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
MaxAutoRiskexigem"_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 argumentodryRun. smoke = coberto poredit.self_test.
tests.audit_functional_tests (risco 0, requer mundo, smoke)
Audits loaded Functional Test actors without executing, stopping, or changing them.
| Argumento | Tipo | Descrição |
|---|---|---|
contains | string | Case-insensitive substring of the actor label or object name. |
includeDisabled | boolean | Include disabled Functional Test actors. Padrão true. |
limit | integer | Padrão 100. |
Retorna: total, issues, message.
tests.create_functional_test (risco 2, altera, requer mundo, smoke)
Adds a configured AFunctionalTest actor to the editor world; it does not execute the test.
| Argumento | Tipo | Descrição |
|---|---|---|
name | string | obrigatório. Unique editor label for the new AFunctionalTest actor. |
location | {x,y,z} | World location in centimetres. |
description | string | Editable Functional Testing description. |
enabled | boolean | Enable the actor for Functional Testing discovery. Padrão true. |
setTimeLimit | boolean | Apply timeLimit; zero means no test timeout. Padrão false. |
timeLimit | number | Padrão 0.0f. |
Retorna: test, message.
tests.get_automation_report (risco 0)
Finds one current Automation Controller report without starting, exporting, or clearing tests.
| Argumento | Tipo | Descrição |
|---|---|---|
fullPath | string | obrigatório. Full report path reported by tests.inspect_automation_reports. |
Retorna: reports, total, message.
tests.get_automation_status (risco 0, smoke)
Returns the loaded Automation Controller state without starting tests or waiting for workers.
Sem argumentos.
Retorna: moduleLoaded, state, resultsAvailable, hasErrors, hasWarnings, hasLogs, deviceClusters, enabledTests, passes, reportOutputPath, message.
tests.get_functional_test_details (risco 0, requer mundo, smoke)
Returns one loaded Functional Test actor's configuration and last result without executing it.
| Argumento | Tipo | Descrição |
|---|---|---|
actor | string | obrigatório. Functional Test actor label, object name, or object path. |
Retorna: test, message.
tests.inspect_automation_reports (risco 0, smoke)
Inspects the controller's current filtered report tree; it does not run, export, or clear tests.
| Argumento | Tipo | Descrição |
|---|---|---|
contains | string | Case-insensitive substring of the report path or display name. |
limit | integer | Maximum matching entries returned. Padrão 100. |
includeGroups | boolean | Include group nodes as well as leaf test reports. Padrão false. |
Retorna: reports, total, message.
tests.list_functional_tests (risco 0, requer mundo, smoke)
Lists loaded AFunctionalTest actors in the editor world.
| Argumento | Tipo | Descrição |
|---|---|---|
contains | string | Case-insensitive substring of the actor label or object name. |
includeDisabled | boolean | Include disabled Functional Test actors. Padrão true. |
limit | integer | Padrão 100. |
Retorna: tests, count, total, message.
tests.remove_functional_test (risco 3, altera, destrutivo, requer mundo, smoke)
Deletes one Functional Test actor from the editor world; the test is not executed.
| Argumento | Tipo | Descrição |
|---|---|---|
actor | string | obrigatório. Functional Test actor label, object name, or object path. |
Retorna: test, message.
tests.request_automation_discovery (risco 1)
Requests worker test discovery and returns immediately; call tests.get_automation_status to observe it.
Sem argumentos.
Retorna: moduleLoaded, state, resultsAvailable, hasErrors, hasWarnings, hasLogs, deviceClusters, enabledTests, passes, reportOutputPath, message.
tests.update_functional_test (risco 2, altera, requer mundo, smoke)
Updates the enabled flag, description, or timeout of an existing AFunctionalTest actor.
| Argumento | Tipo | Descrição |
|---|---|---|
actor | string | obrigatório. Actor label, object name, or object path. |
enabled | boolean | Padrão true. |
setDescription | boolean | Padrão false. |
description | string | |
setTimeLimit | boolean | Padrão false. |
timeLimit | number | Padrão 0.0f. |
Retorna: test, message.