editor-application-get-state

Retrieve Unity Editor state including play mode, compile status, and paths.

Updated Feb 4, 2024
One-click install
npx skills add https://github.com/sprillion/gem_td --skill editor-application-get-state-sprillion
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: editor-application-get-state
Source: https://github.com/sprillion/gem_td/tree/main/SKILLS/editor-application-get-state
Command: npx skills add https://github.com/sprillion/gem_td --skill editor-application-get-state-sprillion

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates retrieval of real-time information about UnityEditor.EditorApplication to enable tooling, automation, and monitoring workflows. Capture data such as play mode, pause state, compilation status, and startup timing to drive automated checks and dashboards.

Core Features & Use Cases

  • Live state data: Exposes key booleans (IsPlaying, IsPaused, IsCompiling, IsPlayingOrWillChangePlaymode, IsUpdating) and startup timing (TimeSinceStartup) for integration with CI, editor scripts, and dashboards.
  • Path information: Returns ApplicationPath and ApplicationContentsPath for environment-aware tooling.
  • Use Case: Example: Use in automated Unity editor pipelines to verify readiness before triggering tests or builds.

Quick Start

Call the editor-application-get-state tool via HTTP API to retrieve the current Unity Editor state.

Frequently Asked Questions about editor-application-get-state

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if the Unity Editor is in play mode from an automated script?

To check Unity Editor play mode from an automated script, request EditorApplication state data. This returns a structured result containing IsPlaying, IsPaused, and IsPlayingOrWillChangePlaymode booleans to verify the current editor state for CI workflows.

Can I monitor Unity compilation status remotely during automated toolchain workflows?

You can monitor Unity compilation status remotely by requesting EditorApplication data. The returned state includes the IsCompiling boolean, enabling automated pipelines and dashboards to wait for compilation to finish before triggering subsequent build steps.

What is the best way to get Unity Editor startup timing for environment-aware tooling?

Getting Unity Editor startup timing for environment-aware tooling involves requesting EditorApplication state. The response includes TimeSinceStartup alongside ApplicationPath and ApplicationContentsPath, providing the necessary startup metrics and environment paths for automation scripts.

Does querying editor state work for verifying Unity pipeline readiness before triggering builds?

Querying editor state works for verifying Unity pipeline readiness before triggering builds. By checking the IsUpdating and IsCompiling flags in the returned EditorApplication data, automated workflows can confirm the editor is idle and ready for build execution.

Why does my Unity editor script execute before the editor is fully initialized in CI?

Unity editor scripts may execute before full initialization in CI because startup timing varies. Requesting EditorApplication state provides TimeSinceStartup to measure elapsed time, allowing automation pipelines to implement delays and wait for a stable editor state.

How do I retrieve the application path of the Unity Editor for automated tooling setup?

To retrieve the Unity Editor application path for automated tooling setup, request the EditorApplication state. The structured result includes ApplicationPath and ApplicationContentsPath, enabling scripts to locate the editor installation directory dynamically.