How needle-mirror/com.unity.addressables works
Project Type and Purpose
• This is an open-source Unity package (Unity Addressables) that provides a framework for managing, building, and loading asset bundles in Unity projects.
• Key features:
• Editor extension (under “Editor/…”) that integrates into the Unity build pipeline and UI.
• Runtime library (under “Runtime/…”) that implements asynchronous loading, caching, and resource‐provider abstractions.
• Documentation (under “Documentation~/…”) and extensive automated tests.
High-Level Components
a. Editor Module
– Build scripts and hooks (Editor/Build/…, AddressablesBuildScriptHooks)
– Asset-group and profile inspectors and windows (Editor/GUI/…, Editor/Settings/…)
– Analyze and reporting tools (Editor/AnalyzeRules, BuildReportVisualizer, Diagnostics/Profiler)
b. Runtime Module
– Public API façade (Runtime/Addressables.cs)
– Internal implementation (Runtime/AddressablesImpl, ResourceManager)
– Initialization pipeline (Runtime/Initialization/…)
– Resource locators (Runtime/ResourceLocators/…)
– Async operation system (Runtime/ResourceManager/AsyncOperations/…)
– Resource providers (Runtime/ResourceManager/ResourceProviders/…)
– Utility classes (Runtime/Utility/SerializationUtilities, AssetReferenceUtilities, etc.)
c. Tests
– Editor tests (Tests/Editor/…) and Runtime tests (Tests/Runtime/…)
– Sample projects (Samples~/…)
Component Relationships & Data Flow
• Editor time:
1. User configures Addressable Groups & Profiles in the Unity Editor UI
2. Build pipeline scripts (AddressablesDataBuilders) run, invoking BuildPipelineTasks to produce AssetBundles and ContentCatalogs
3. AnalyzeRules modules generate build reports and diagnostics
• Runtime:
1. Game code calls Addressables.LoadAssetAsync or Other API
2. AddressablesImpl forwards request to ResourceManager
3. ResourceManager queries IResourceLocator instances to find asset locations in the ContentCatalog
4. ResourceManager dispatches AsyncOperations and delegates to the appropriate IResourceProvider (e.g., AssetBundleProvider, JSONAssetProvider, SceneProvider, WebRequestOperation)
5. AsyncOperationHandle completes, asset is returned to game code
6. CcdManager handles remote catalog management if enabled
Architectural Patterns & Principles
• Modularity: separate Editor vs. Runtime assemblies via asmdef files
• Provider pattern: pluggable IResourceProvider implementations
• Chain of responsibility / pipeline for AsyncOperations
• Data‐driven: ContentCatalogs generated at build time drive runtime behavior
• Dependency inversion: high‐level ResourceManager uses abstractions (IResourceLocator, IResourceProvider)