Fix: Unity Assembly Definition Circular Reference

Here is how to fix Unity Assembly Definition circular reference. You have Player.asmdef and Enemy.asmdef. Player references Enemy (to call Enemy.TakeDamage). Enemy references Player (to call Player.AddScore on kill). Unity errors: “Cyclic reference detected between assemblies: Player and Enemy.” Your project stops compiling. Remove the reference and half your calls fail to resolve. The fix is not to shuffle references but to rethink the architecture.

The Symptom

Unity console shows one of:

• Cyclic references detected in asmdef graph
• Assembly X references Y, which itself references X
• Compiler errors about types not existing despite the type clearly being in the referenced asmdef

All scripts fail to compile until the cycle is broken, even scripts unrelated to the cycle.

What Causes This

Two-way references. The classic case: A calls B, B calls A. Each side needs to see the other’s types. Neither direction is “wrong” intuitively, but the compiler cannot build either without the other.

Transitive cycles. A -> B -> C -> A. No direct two-way ref, but through a third party, it loops. Harder to spot because you have to trace multi-step paths.

Feature growth over time. A used to be independent. Later, you added a reference from A to B for a new feature. The original B->A reference is forgotten until compile fails.

Shared types in wrong asmdef. A type used by both A and B lives in one of them. Both need to reference the other to use it. Moving the type to a shared asmdef removes the cycle.

The Fix

Step 1: Identify the cycle. Read the error message carefully — it names the two or more asmdefs involved. For transitive cycles, use the Assembly Definition window:

// Unity 2023.2+ has Window > Analysis > Assembly Definition Dependency Graph
// Older versions: inspect each asmdef's References field and trace manually

Draw the graph on paper if needed. Find the cycle.

Step 2: Extract shared types. Create a new asmdef, MyGame.Shared, that contains types used by both sides of the cycle:

// Before: Player references Enemy, Enemy references Player

// After: Both reference Shared
Player.asmdef  -> Shared.asmdef
Enemy.asmdef   -> Shared.asmdef

// In Shared:
public interface IDamageable
{
    void TakeDamage(int amount);
}

public interface IScoreContributor
{
    int GetScoreValue();
}

Player and Enemy now depend on interfaces in Shared instead of each other. Player iterates IDamageable references; Enemy implements both IDamageable and IScoreContributor.

Step 3: Use events for decoupled communication. Instead of direct calls, raise events defined in Shared:

// In Shared.asmdef
public static class GameEvents
{
    public static Action<int> EnemyKilled;
}

// In Enemy.asmdef
void Die()
{
    GameEvents.EnemyKilled?.Invoke(scoreValue);
    Destroy(gameObject);
}

// In Player.asmdef
void OnEnable() { GameEvents.EnemyKilled += HandleKill; }
void OnDisable() { GameEvents.EnemyKilled -= HandleKill; }

void HandleKill(int score) { totalScore += score; }

Enemy raises events without knowing Player exists. Player subscribes without knowing which Enemy fired. Fully decoupled.

Step 4: Consider if the cycle is a design smell. Sometimes the correct answer is not “break the cycle” but “why do these two modules know about each other so deeply?” A Player asmdef that needs to know about Enemy specifics is tightly coupled. Refactor so the common behavior is a contract (interface) and each side only knows the abstract contract.

Recommended asmdef Hierarchy

A clean architecture for a medium-sized game:

MyGame.Core           # utilities, math, no dependencies
MyGame.Data           # data structures, references Core
MyGame.Shared         # interfaces, events; references Data
MyGame.Gameplay       # gameplay systems; references Shared
MyGame.UI             # UI; references Shared, Gameplay
MyGame.Main           # scene bootstrap; references everything below

Dependencies flow downward. No asmdef depends on something above it in the stack. Adding a new feature means adding types to the appropriate layer, not plumbing new references between unrelated layers.

Runtime vs Editor

If a circular reference only appears when you add editor code (asmdef with Editor platform only), the editor asmdef can reference the runtime asmdef but not vice versa. Put editor-only extensions in a dedicated .Editor asmdef.

Understanding the issue

This bug class falls into a pattern that's worth understanding beyond the specific case. In Unity Engine, the underlying behavior is shaped by how the engine layers its abstractions - the public API you call, the runtime systems that respond, and the platform-specific implementations underneath. A bug at any layer can produce symptoms that look like they originate at a different layer. Triaging effectively means recognizing which layer the symptom belongs to, even when the gameplay code is what's visible.

The specific bug described above is the kind that surfaces during integration rather than unit testing. It depends on a combination of factors: the asset configuration, the runtime state, the platform's specific behavior. In isolation, each piece looks correct; in combination, the bug emerges. This is why thorough integration testing - playing the actual game in realistic conditions - catches things that automated tests miss.

Why this happens

The triage path for this kind of bug is long. The symptom appears in gameplay, but the cause is in a different system. The reporter describes the gameplay effect; the engineer has to translate that into a hypothesis about the underlying cause. Misdirection is common.

At the engine level, the behavior comes from a deliberate design decision in Unity. The engine team chose a particular trade-off - usually performance versus convenience, or generality versus specificity - and that trade-off has consequences when you push against it. Understanding the trade-off is what turns 'this bug is mysterious' into 'this bug is the expected consequence of this design'.

Verifying the fix

For shipping games, the safest verification is a staged rollout. Apply the fix to 1% of players for 24 hours; watch the affected metric; expand if green. Skipping the staged rollout means the verification is the entire player base, which is too high a stakes for most fixes.

Reproducibility is the prerequisite for verification. If you can't reliably reproduce the bug pre-fix, you can't reliably verify it post-fix. Spend time getting a clean reproduction before you write any fix code. The fix is fast once you understand the reproduction; the reproduction is the slow part.

Variations to watch for

Related bug classes often share the same root cause. If you find yourself fixing this issue, look for cousins: similar symptoms in adjacent systems, the same data flow but a different value, or the same fix pattern in another module. The catalog of 'we've seen this before' becomes valuable institutional knowledge.

Adjacent bugs often share a root cause. After fixing the case you've found, spend an hour searching the codebase for similar patterns. What's the same call with different arguments? The same data flow with a different entity type? The same lifecycle issue in a sibling system? Each match is a candidate for the same fix, or a related fix that prevents future bugs of the same class.

In production

For shipping titles with a long support window, watch for this issue resurfacing after dependency updates. Engine upgrades, driver updates, OS releases - each one can resurface a bug class you thought you'd fixed because the underlying behavior changed slightly. Regression tests catch the obvious ones; player reports catch the rest.

When triaging a similar issue in production, prioritize gathering data over hypothesizing causes. A player report describes a symptom; what you need is a build SHA, a session timestamp, and ideally a screen recording or session replay. With those, the bug becomes tractable. Without them, you're guessing at hypothetical reproductions that may not match what the player actually hit.

Performance considerations

Performance implications matter when this bug class scales with player count or asset count. A bug that fires once per session is annoying; a bug that fires once per frame compounds. After fixing, profile the affected code path under realistic load. The fix that's correct for one entity may be too slow for ten thousand.

Diagnostic approach

Diagnosing this class of bug benefits from a structured approach: confirm the symptom, isolate the variables, hypothesize the cause, and verify the hypothesis before writing fix code. Skipping the isolation step is the most common mistake; without it, fixes often address symptoms while the underlying cause continues to produce other variations.

For Unity-specific diagnostics, the editor's profiler is the canonical starting point. Capture a representative frame with the symptom present; compare against a frame without the symptom; the diff often points directly at the cause. If the symptom is non-deterministic, capture multiple frames and look for the pattern - the cause is usually a state transition or a specific input value rather than a continuous effect.

Tooling and ecosystem

Third-party plugins often provide better diagnostics for their own behavior than the engine does. If the affected code is in a plugin, check the plugin's documentation for debug modes, verbose logging, or inspector tools - these can save hours of investigation when they exist.

Within Unity, the relevant diagnostic surfaces include the standard frame debugger, memory profiler, and engine-specific debug overlays. Each one shows a different facet of what's happening. The frame debugger reveals draw call ordering and state transitions; the memory profiler shows allocation patterns; the debug overlay reveals per-system state. Bugs that resist one tool usually surrender to another - the trick is knowing which tool to reach for first.

Edge cases and pitfalls

Platform-specific edge cases are worth enumerating explicitly. iOS handles backgrounding differently than Android; Windows handles focus changes differently than macOS. A fix that works on the development platform may not work on every target. Test on each shipping platform deliberately.

When writing a regression test for this fix, focus on the boundary conditions that surfaced the original bug. Tests that exercise the happy path catch obvious regressions; tests that exercise the boundary catch the subtler regressions that look like new bugs but are really the original returning. The latter are the tests that earn their keep over the long life of the project.

Team communication

Document the fix and its rationale in the commit message or attached engineering doc. Future engineers will encounter related issues; the rationale tells them whether your fix is reusable or specific to the case at hand. Without rationale, the fix gets reverted or copied incorrectly.

If this fix touches a system several engineers work in, a short writeup in the team's engineering channel helps. Not a full design doc - a paragraph explaining what was wrong, what's fixed, and what to watch for. Future engineers encountering similar symptoms will search for the fix; making it findable is a small investment that pays back later.

“Circular references are a design smell, not a technical limit. The compiler is telling you your architecture has a loop.”

Related Issues

For asmdef test-related issues, see Play Mode Tests Not Running. For Addressables and asmdef interaction, Addressables Build Cache Corrupt covers related build-pipeline issues.

Extract to Shared asmdef. Use interfaces and events. Dependencies flow one way.