新增文档
This commit is contained in:
@@ -0,0 +1,125 @@
|
||||
---
|
||||
name: editor-application-get-state
|
||||
description: Return the current state of `UnityEditor.EditorApplication` — playmode, paused state, compilation state, and related flags.
|
||||
---
|
||||
|
||||
# Editor / Application / Get State
|
||||
|
||||
Returns available information about 'UnityEditor.EditorApplication'. Use it to get information about the current state of the Unity Editor application. Such as: playmode, paused state, compilation state, etc.
|
||||
|
||||
## Behavior
|
||||
|
||||
Snapshots Editor state via `EditorStatsData.FromEditor()` on the main thread and returns the result.
|
||||
|
||||
## How to Call
|
||||
|
||||
```bash
|
||||
unity-mcp-cli run-tool editor-application-get-state --input '{
|
||||
"nothing": "string_value"
|
||||
}'
|
||||
```
|
||||
|
||||
> For complex input (multi-line strings, code), save the JSON to a file and use:
|
||||
> ```bash
|
||||
> unity-mcp-cli run-tool editor-application-get-state --input-file args.json
|
||||
> ```
|
||||
>
|
||||
> Or pipe via stdin (recommended):
|
||||
> ```bash
|
||||
> unity-mcp-cli run-tool editor-application-get-state --input-file - <<'EOF'
|
||||
> {"param": "value"}
|
||||
> EOF
|
||||
> ```
|
||||
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
If `unity-mcp-cli` is not found, either install it globally (`npm install -g unity-mcp-cli`) or use `npx unity-mcp-cli` instead.
|
||||
Read the /unity-initial-setup skill for detailed installation instructions.
|
||||
|
||||
## Input
|
||||
|
||||
| Name | Type | Required | Description |
|
||||
|------|------|----------|-------------|
|
||||
| `nothing` | `string` | No | |
|
||||
|
||||
### Input JSON Schema
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"nothing": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Output
|
||||
|
||||
### Output JSON Schema
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"result": {
|
||||
"$ref": "#/$defs/AIGD.EditorStatsData",
|
||||
"description": "Available information about 'UnityEditor.EditorApplication'."
|
||||
}
|
||||
},
|
||||
"$defs": {
|
||||
"AIGD.EditorStatsData": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"IsPlaying": {
|
||||
"type": "boolean",
|
||||
"description": "Whether the Editor is in Play mode."
|
||||
},
|
||||
"IsPaused": {
|
||||
"type": "boolean",
|
||||
"description": "Whether the Editor is paused."
|
||||
},
|
||||
"IsCompiling": {
|
||||
"type": "boolean",
|
||||
"description": "Is editor currently compiling scripts? (Read Only)"
|
||||
},
|
||||
"IsPlayingOrWillChangePlaymode": {
|
||||
"type": "boolean",
|
||||
"description": "Editor application state which is true only when the Editor is currently in or about to enter Play mode. (Read Only)"
|
||||
},
|
||||
"IsUpdating": {
|
||||
"type": "boolean",
|
||||
"description": "True if the Editor is currently refreshing the AssetDatabase. (Read Only)"
|
||||
},
|
||||
"ApplicationContentsPath": {
|
||||
"type": "string",
|
||||
"description": "Path to the Unity editor contents folder. (Read Only)"
|
||||
},
|
||||
"ApplicationPath": {
|
||||
"type": "string",
|
||||
"description": "Gets the path to the Unity Editor application. (Read Only)"
|
||||
},
|
||||
"TimeSinceStartup": {
|
||||
"type": "number",
|
||||
"description": "The time since the editor was started. (Read Only)"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"IsPlaying",
|
||||
"IsPaused",
|
||||
"IsCompiling",
|
||||
"IsPlayingOrWillChangePlaymode",
|
||||
"IsUpdating",
|
||||
"TimeSinceStartup"
|
||||
],
|
||||
"description": "Available information about 'UnityEditor.EditorApplication'."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"result"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user