com.wallstop-studios.unity-helpers
Version:
Treasure chest of Unity developer tools
559 lines • 162 kB
HTML
<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Production-ready Unity utilities: 10-15x faster PRNGs, O(log n) spatial queries, zero-allocation pooling, Odin-level inspector tooling, and data-driven effects."><meta name=author content="Wallstop Studios"><link href=https://wallstop.github.io/unity-helpers/features/utilities/singletons/ rel=canonical><link href=../random-generators/ rel=prev><link href=../reflection-helpers/ rel=next><link rel=icon href=../../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.3"><title>Singletons - Unity Helpers</title><link rel=stylesheet href=../../../assets/stylesheets/main.484c7ddc.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.ab4e12ef.min.css><style>:root{--md-admonition-icon--note:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20448%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M64%20480c-35.3%200-64-28.7-64-64V96c0-35.3%2028.7-64%2064-64h320c35.3%200%2064%2028.7%2064%2064v213.5c0%2017-6.7%2033.3-18.7%2045.3L322.7%20461.3c-12%2012-28.3%2018.7-45.3%2018.7zm325.5-176H296c-13.3%200-24%2010.7-24%2024v93.5z%22/%3E%3C/svg%3E');--md-admonition-icon--abstract:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20448%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M384%20512H96c-53%200-96-43-96-96V96C0%2043%2043%200%2096%200h304c26.5%200%2048%2021.5%2048%2048v288c0%2020.9-13.4%2038.7-32%2045.3V448c17.7%200%2032%2014.3%2032%2032s-14.3%2032-32%2032zM96%20384c-17.7%200-32%2014.3-32%2032s14.3%2032%2032%2032h256v-64zm32-232c0%2013.3%2010.7%2024%2024%2024h176c13.3%200%2024-10.7%2024-24s-10.7-24-24-24H152c-13.3%200-24%2010.7-24%2024m24%2072c-13.3%200-24%2010.7-24%2024s10.7%2024%2024%2024h176c13.3%200%2024-10.7%2024-24s-10.7-24-24-24z%22/%3E%3C/svg%3E');--md-admonition-icon--info:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20512%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M256%20512a256%20256%200%201%200%200-512%20256%20256%200%201%200%200%20512m-32-352a32%2032%200%201%201%2064%200%2032%2032%200%201%201-64%200m-8%2064h48c13.3%200%2024%2010.7%2024%2024v88h8c13.3%200%2024%2010.7%2024%2024s-10.7%2024-24%2024h-80c-13.3%200-24-10.7-24-24s10.7-24%2024-24h24v-64h-24c-13.3%200-24-10.7-24-24s10.7-24%2024-24%22/%3E%3C/svg%3E');--md-admonition-icon--tip:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20384%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M292.9%20384c7.3-22.3%2021.9-42.5%2038.4-59.9C364%20289.7%20384%20243.2%20384%20192%20384%2086%20298%200%20192%200S0%2086%200%20192c0%2051.2%2020%2097.7%2052.7%20132.1%2016.5%2017.4%2031.2%2037.6%2038.4%2059.9h201.7zm-4.9%2048H96v16c0%2044.2%2035.8%2080%2080%2080h32c44.2%200%2080-35.8%2080-80zM184%20112c-39.8%200-72%2032.2-72%2072%200%2013.3-10.7%2024-24%2024s-24-10.7-24-24c0-66.3%2053.7-120%20120-120%2013.3%200%2024%2010.7%2024%2024s-10.7%2024-24%2024%22/%3E%3C/svg%3E');--md-admonition-icon--success:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20448%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M434.8%2070.1c14.3%2010.4%2017.5%2030.4%207.1%2044.7l-256%20352c-5.5%207.6-14%2012.3-23.4%2013.1s-18.5-2.7-25.1-9.3l-128-128c-12.5-12.5-12.5-32.8%200-45.3s32.8-12.5%2045.3%200l101.5%20101.5%20234-321.7c10.4-14.3%2030.4-17.5%2044.7-7.1z%22/%3E%3C/svg%3E');--md-admonition-icon--question:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20512%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M256%20512a256%20256%200%201%200%200-512%20256%20256%200%201%200%200%20512m0-336c-17.7%200-32%2014.3-32%2032%200%2013.3-10.7%2024-24%2024s-24-10.7-24-24c0-44.2%2035.8-80%2080-80s80%2035.8%2080%2080c0%2047.2-36%2067.2-56%2074.5v3.8c0%2013.3-10.7%2024-24%2024s-24-10.7-24-24v-8.1c0-20.5%2014.8-35.2%2030.1-40.2%206.4-2.1%2013.2-5.5%2018.2-10.3%204.3-4.2%207.7-10%207.7-19.6%200-17.7-14.3-32-32-32zm-32%20192a32%2032%200%201%201%2064%200%2032%2032%200%201%201-64%200%22/%3E%3C/svg%3E');--md-admonition-icon--warning:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20512%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M256%200c14.7%200%2028.2%208.1%2035.2%2021l216%20400c6.7%2012.4%206.4%2027.4-.8%2039.5S486.1%20480%20472%20480H40c-14.1%200-27.2-7.4-34.4-19.5s-7.5-27.1-.8-39.5l216-400c7-12.9%2020.5-21%2035.2-21m0%20352a32%2032%200%201%200%200%2064%2032%2032%200%201%200%200-64m0-192c-18.2%200-32.7%2015.5-31.4%2033.7l7.4%20104c.9%2012.5%2011.4%2022.3%2023.9%2022.3%2012.6%200%2023-9.7%2023.9-22.3l7.4-104c1.3-18.2-13.1-33.7-31.4-33.7z%22/%3E%3C/svg%3E');--md-admonition-icon--failure:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20384%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M55.1%2073.4c-12.5-12.5-32.8-12.5-45.3%200s-12.5%2032.8%200%2045.3L147.2%20256%209.9%20393.4c-12.5%2012.5-12.5%2032.8%200%2045.3s32.8%2012.5%2045.3%200l137.3-137.4%20137.4%20137.3c12.5%2012.5%2032.8%2012.5%2045.3%200s12.5-32.8%200-45.3L237.8%20256l137.3-137.4c12.5-12.5%2012.5-32.8%200-45.3s-32.8-12.5-45.3%200L192.5%20210.7z%22/%3E%3C/svg%3E');--md-admonition-icon--danger:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20512%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M416%20427.4c58.5-44%2096-111.6%2096-187.4C512%20107.5%20397.4%200%20256%200S0%20107.5%200%20240c0%2075.8%2037.5%20143.4%2096%20187.4V464c0%2026.5%2021.5%2048%2048%2048h32v-40c0-13.3%2010.7-24%2024-24s24%2010.7%2024%2024v40h64v-40c0-13.3%2010.7-24%2024-24s24%2010.7%2024%2024v40h32c26.5%200%2048-21.5%2048-48zM96%20256a64%2064%200%201%201%20128%200%2064%2064%200%201%201-128%200m256-64a64%2064%200%201%201%200%20128%2064%2064%200%201%201%200-128%22/%3E%3C/svg%3E');--md-admonition-icon--bug:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20576%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M192%2096c0-53%2043-96%2096-96s96%2043%2096%2096v3.6c0%2015.7-12.7%2028.4-28.4%2028.4H220.5c-15.7%200-28.4-12.7-28.4-28.4V96zm345.6%2012.8c10.6%2014.1%207.7%2034.2-6.4%2044.8l-97.8%2073.3c5.3%208.9%209.3%2018.7%2011.8%2029.1H544c17.7%200%2032%2014.3%2032%2032s-14.3%2032-32%2032h-96v32c0%202.6-.1%205.3-.2%207.9l83.4%2062.5c14.1%2010.6%2017%2030.7%206.4%2044.8s-30.7%2017-44.8%206.4l-63.1-47.3c-23.2%2044.2-66.5%2076.2-117.7%2083.9V280c0-13.3-10.7-24-24-24s-24%2010.7-24%2024v230.2c-51.2-7.7-94.5-39.7-117.7-83.9l-63.1%2047.3c-14.1%2010.6-34.2%207.7-44.8-6.4s-7.7-34.2%206.4-44.8l83.4-62.5c-.1-2.6-.2-5.2-.2-7.9v-32H32c-17.7%200-32-14.3-32-32s14.3-32%2032-32h98.8c2.5-10.4%206.5-20.2%2011.8-29.1l-97.8-73.3c-14.1-10.6-17-30.7-6.4-44.8s30.7-17%2044.8-6.4L192%20184c12.3-5.1%2025.8-8%2040-8h112c14.2%200%2027.7%202.8%2040%208l108.8-81.6c14.1-10.6%2034.2-7.7%2044.8%206.4%22/%3E%3C/svg%3E');--md-admonition-icon--example:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20448%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M288%200H128c-17.7%200-32%2014.3-32%2032s14.3%2032%2032%2032v151.5L7.5%20426.3C2.6%20435%200%20444.7%200%20454.7%200%20486.4%2025.6%20512%2057.3%20512h333.4c31.6%200%2057.3-25.6%2057.3-57.3%200-10-2.6-19.8-7.5-28.4L320%20215.5V64c17.7%200%2032-14.3%2032-32S337.7%200%20320%200zm-96%20215.5V64h64v151.5c0%2011.1%202.9%2022.1%208.4%2031.8L306%20320H142l41.6-72.7c5.5-9.7%208.4-20.6%208.4-31.8%22/%3E%3C/svg%3E');--md-admonition-icon--quote:url('data:image/svg+xml;charset=utf-8,%3Csvg%20xmlns%3D%22http%3A//www.w3.org/2000/svg%22%20viewBox%3D%220%200%20448%20512%22%3E%3C%21--%21%20Font%20Awesome%20Free%207.1.0%20by%20%40fontawesome%20-%20https%3A//fontawesome.com%20License%20-%20https%3A//fontawesome.com/license/free%20%28Icons%3A%20CC%20BY%204.0%2C%20Fonts%3A%20SIL%20OFL%201.1%2C%20Code%3A%20MIT%20License%29%20Copyright%202025%20Fonticons%2C%20Inc.--%3E%3Cpath%20d%3D%22M0%20216C0%20149.7%2053.7%2096%20120%2096h8c17.7%200%2032%2014.3%2032%2032s-14.3%2032-32%2032h-8c-30.9%200-56%2025.1-56%2056v8h64c35.3%200%2064%2028.7%2064%2064v64c0%2035.3-28.7%2064-64%2064H64c-35.3%200-64-28.7-64-64zm256%200c0-66.3%2053.7-120%20120-120h8c17.7%200%2032%2014.3%2032%2032s-14.3%2032-32%2032h-8c-30.9%200-56%2025.1-56%2056v8h64c35.3%200%2064%2028.7%2064%2064v64c0%2035.3-28.7%2064-64%2064h-64c-35.3%200-64-28.7-64-64z%22/%3E%3C/svg%3E');}</style><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style><link rel=stylesheet href=../../../css/timeago.css><link rel=stylesheet href=../../../stylesheets/custom.css><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script></head> <body dir=ltr data-md-color-scheme=slate data-md-color-primary=teal data-md-color-accent=deep-orange> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#singleton-utilities-runtime-scriptableobject class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../.. title="Unity Helpers" class="md-header__button md-logo" aria-label="Unity Helpers" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Unity Helpers </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Singletons </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media data-md-color-scheme=slate data-md-color-primary=teal data-md-color-accent=deep-orange aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg> </label> <input class=md-option data-md-color-media data-md-color-scheme=default data-md-color-primary=teal data-md-color-accent=deep-orange aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class=md-search__options aria-label=Search> <a href=javascript:void(0) class="md-search__icon md-icon" title=Share aria-label=Share data-clipboard data-clipboard-text data-md-component=search-share tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg> </a> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> <div class=md-search__suggest data-md-component=search-suggest></div> </form> <div class=md-search__output> <div class=md-search__scrollwrap tabindex=0 data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/wallstop/unity-helpers title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </div> <div class=md-source__repository> wallstop/unity-helpers </div> </a> </div> </nav> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=../../.. class=md-tabs__link> Home </a> </li> <li class=md-tabs__item> <a href=../../../overview/getting-started/ class=md-tabs__link> Getting Started </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../../inspector/inspector-overview/ class=md-tabs__link> Features </a> </li> <li class=md-tabs__item> <a href=../../../performance/random-performance/ class=md-tabs__link> Performance </a> </li> <li class=md-tabs__item> <a href=../../../guides/odin-migration-guide/ class=md-tabs__link> Guides </a> </li> <li class=md-tabs__item> <a href=../../../project/contributing/ class=md-tabs__link> Contributing </a> </li> <li class=md-tabs__item> <a href=../../../project/license/ class=md-tabs__link> Project </a> </li> </ul> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../../.. title="Unity Helpers" class="md-nav__button md-logo" aria-label="Unity Helpers" data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg> </a> Unity Helpers </label> <div class=md-nav__source> <a href=https://github.com/wallstop/unity-helpers title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </div> <div class=md-source__repository> wallstop/unity-helpers </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../.. class=md-nav__link> <span class=md-ellipsis> Home </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2> <div class="md-nav__link md-nav__container"> <a href=../../../overview/ class="md-nav__link "> <span class=md-ellipsis> Getting Started </span> </a> <label class="md-nav__link " for=__nav_2 id=__nav_2_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Getting Started </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../overview/getting-started/ class=md-nav__link> <span class=md-ellipsis> Quick Start </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/glossary/ class=md-nav__link> <span class=md-ellipsis> Glossary </span> </a> </li> <li class=md-nav__item> <a href=../../../overview/roadmap/ class=md-nav__link> <span class=md-ellipsis> Roadmap </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3 checked> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex> <span class=md-ellipsis> Features </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=true> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Features </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3_1> <label class=md-nav__link for=__nav_3_1 id=__nav_3_1_label tabindex> <span class=md-ellipsis> Inspector </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_1_label aria-expanded=false> <label class=md-nav__title for=__nav_3_1> <span class="md-nav__icon md-icon"></span> Inspector </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../inspector/inspector-overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/inspector-button/ class=md-nav__link> <span class=md-ellipsis> Buttons </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/inspector-grouping-attributes/ class=md-nav__link> <span class=md-ellipsis> Grouping Attributes </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/inspector-selection-attributes/ class=md-nav__link> <span class=md-ellipsis> Selection Attributes </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/inspector-conditional-display/ class=md-nav__link> <span class=md-ellipsis> Conditional Display </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/inspector-validation-attributes/ class=md-nav__link> <span class=md-ellipsis> Validation Attributes </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/inspector-inline-editor/ class=md-nav__link> <span class=md-ellipsis> Inline Editor </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/inspector-settings/ class=md-nav__link> <span class=md-ellipsis> Inspector Settings </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/utility-components/ class=md-nav__link> <span class=md-ellipsis> Utility Components </span> </a> </li> <li class=md-nav__item> <a href=../../inspector/visual-components/ class=md-nav__link> <span class=md-ellipsis> Visual Components </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3_2> <label class=md-nav__link for=__nav_3_2 id=__nav_3_2_label tabindex> <span class=md-ellipsis> Relational Components </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_2_label aria-expanded=false> <label class=md-nav__title for=__nav_3_2> <span class="md-nav__icon md-icon"></span> Relational Components </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../relational-components/relational-components/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3_3> <label class=md-nav__link for=__nav_3_3 id=__nav_3_3_label tabindex> <span class=md-ellipsis> Spatial Data Structures </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3_3> <span class="md-nav__icon md-icon"></span> Spatial Data Structures </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../spatial/spatial-trees-2d-guide/ class=md-nav__link> <span class=md-ellipsis> 2D Spatial Trees </span> </a> </li> <li class=md-nav__item> <a href=../../spatial/spatial-trees-3d-guide/ class=md-nav__link> <span class=md-ellipsis> 3D Spatial Trees </span> </a> </li> <li class=md-nav__item> <a href=../../spatial/hulls/ class=md-nav__link> <span class=md-ellipsis> Hull Algorithms </span> </a> </li> <li class=md-nav__item> <a href=../../spatial/spatial-tree-semantics/ class=md-nav__link> <span class=md-ellipsis> Spatial Tree Semantics </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3_4> <label class=md-nav__link for=__nav_3_4 id=__nav_3_4_label tabindex> <span class=md-ellipsis> Effects System </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_4_label aria-expanded=false> <label class=md-nav__title for=__nav_3_4> <span class="md-nav__icon md-icon"></span> Effects System </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../effects/effects-system/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../effects/effects-system-tutorial/ class=md-nav__link> <span class=md-ellipsis> Tutorial </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3_5> <label class=md-nav__link for=__nav_3_5 id=__nav_3_5_label tabindex> <span class=md-ellipsis> Serialization </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_5_label aria-expanded=false> <label class=md-nav__title for=__nav_3_5> <span class="md-nav__icon md-icon"></span> Serialization </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../serialization/serialization/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../serialization/serialization-types/ class=md-nav__link> <span class=md-ellipsis> Serializable Types </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_6 checked> <label class=md-nav__link for=__nav_3_6 id=__nav_3_6_label tabindex> <span class=md-ellipsis> Utilities </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_6_label aria-expanded=true> <label class=md-nav__title for=__nav_3_6> <span class="md-nav__icon md-icon"></span> Utilities </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../math-and-extensions/ class=md-nav__link> <span class=md-ellipsis> Math & Extensions </span> </a> </li> <li class=md-nav__item> <a href=../data-structures/ class=md-nav__link> <span class=md-ellipsis> Data Structures </span> </a> </li> <li class=md-nav__item> <a href=../random-generators/ class=md-nav__link> <span class=md-ellipsis> Random Generators </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Singletons </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Singletons </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#tldr-what-problem-this-solves class=md-nav__link> <span class=md-ellipsis> TL;DR — What Problem This Solves </span> </a> </li> <li class=md-nav__item> <a href=#auto-loading-singletons class=md-nav__link> <span class=md-ellipsis> Auto-loading singletons </span> </a> </li> <li class=md-nav__item> <a href=#quick-start-1-minute class=md-nav__link> <span class=md-ellipsis> Quick Start (1 minute) </span> </a> </li> <li class=md-nav__item> <a href=#odin-compatibility class=md-nav__link> <span class=md-ellipsis> Odin Compatibility </span> </a> </li> <li class=md-nav__item> <a href=#when-to-use class=md-nav__link> <span class=md-ellipsis> When To Use </span> </a> </li> <li class=md-nav__item> <a href=#when-not-to-use class=md-nav__link> <span class=md-ellipsis> When Not To Use </span> </a> </li> <li class=md-nav__item> <a href=#runtimesingletont-overview class=md-nav__link> <span class=md-ellipsis> RuntimeSingleton<T> Overview </span> </a> </li> <li class=md-nav__item> <a href=#scriptableobjectsingletont-overview class=md-nav__link> <span class=md-ellipsis> ScriptableObjectSingleton<T> Overview </span> </a> </li> <li class=md-nav__item> <a href=#scenarios-guidance class=md-nav__link> <span class=md-ellipsis> Scenarios & Guidance </span> </a> <nav class=md-nav aria-label="Scenarios & Guidance"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#data-registries-lookups-single-source-of-truth class=md-nav__link> <span class=md-ellipsis> Data Registries & Lookups (Single Source of Truth) </span> </a> </li> <li class=md-nav__item> <a href=#when-not-to-use-scriptableobject-singletons-as-dbs class=md-nav__link> <span class=md-ellipsis> When Not To Use ScriptableObject Singletons as DBs </span> </a> </li> <li class=md-nav__item> <a href=#choosing-a-data-distribution-strategy class=md-nav__link> <span class=md-ellipsis> Choosing a Data Distribution Strategy </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#testing-patterns class=md-nav__link> <span class=md-ellipsis> Testing Patterns </span> </a> <nav class=md-nav aria-label="Testing Patterns"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#testing-with-runtimesingletont class=md-nav__link> <span class=md-ellipsis> Testing with RuntimeSingleton<T> </span> </a> </li> <li class=md-nav__item> <a href=#testing-with-scriptableobjectsingletont class=md-nav__link> <span class=md-ellipsis> Testing with ScriptableObjectSingleton<T> </span> </a> </li> <li class=md-nav__item> <a href=#key-testing-guidelines class=md-nav__link> <span class=md-ellipsis> Key Testing Guidelines </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#troubleshooting class=md-nav__link> <span class=md-ellipsis> Troubleshooting </span> </a> </li> <li class=md-nav__item> <a href=#best-practices class=md-nav__link> <span class=md-ellipsis> Best Practices </span> </a> </li> <li class=md-nav__item> <a href=#related-docs class=md-nav__link> <span class=md-ellipsis> Related Docs </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../reflection-helpers/ class=md-nav__link> <span class=md-ellipsis> Reflection Helpers </span> </a> </li> <li class=md-nav__item> <a href=../helper-utilities/ class=md-nav__link> <span class=md-ellipsis> Helper Utilities </span> </a> </li> <li class=md-nav__item> <a href=../pooling-guide/ class=md-nav__link> <span class=md-ellipsis> Pooling Guide </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3_7> <label class=md-nav__link for=__nav_3_7 id=__nav_3_7_label tabindex> <span class=md-ellipsis> Logging </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_7_label aria-expanded=false> <label class=md-nav__title for=__nav_3_7> <span class="md-nav__icon md-icon"></span> Logging </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../logging/logging-extensions/ class=md-nav__link> <span class=md-ellipsis> Logging Extensions </span> </a> </li> <li class=md-nav__item> <a href=../../logging/unity-main-thread-dispatcher/ class=md-nav__link> <span class=md-ellipsis> Main Thread Dispatcher </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3_8> <label class=md-nav__link for=__nav_3_8 id=__nav_3_8_label tabindex> <span class=md-ellipsis> Editor Tools </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_3_8_label aria-expanded=false> <label class=md-nav__title for=__nav_3_8> <span class="md-nav__icon md-icon"></span> Editor Tools </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../editor-tools/editor-tools-guide/ class=md-nav__link> <span class=md-ellipsis> Tools Guide </span> </a> </li> <li class=md-nav__item> <a href=../../editor-tools/unity-method-analyzer/ class=md-nav__link> <span class=md-ellipsis> Unity Method Analyzer </span> </a> </li> <li class=md-nav__item> <a href=../../editor-tools/asset-change-detection/ class=md-nav__link> <span class=md-ellipsis> Asset Change Detection </span> </a> </li> <li class=md-nav__item> <a href=../../editor-tools/failed-tests-exporter/ class=md-nav__link> <span class=md-ellipsis> Failed Tests Exporter </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex=0> <span class=md-ellipsis> Performance </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Performance </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../performance/random-performance/ class=md-nav__link> <span class=md-ellipsis> Random Generators </span> </a> </li> <li class=md-nav__item> <a href=../../../performance/spatial-tree-2d-performance/ class=md-nav__link> <span class=md-ellipsis> Spatial Trees 2D </span> </a> </li> <li class=md-nav__item> <a href=../../../performance/spatial-tree-3d-performance/ class=md-nav__link> <span class=md-ellipsis> Spatial Trees 3D </span> </a> </li> <li class=md-nav__item> <a href=../../../performance/relational-components-performance/ class=md-nav__link> <span class=md-ellipsis> Relational Components </span> </a> </li> <li class=md-nav__item> <a href=../../../performance/reflection-performance/ class=md-nav__link> <span class=md-ellipsis> Reflection Helpers </span> </a> </li> <li class=md-nav__item> <a href=../../../performance/ilist-sorting-performance/ class=md-nav__link> <span class=md-ellipsis> IList Sorting </span> </a> </li> <li class=md-nav__item> <a href=../../../performance/baseline-tests-performance/ class=md-nav__link> <span class=md-ellipsis> Baseline Tests </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex=0> <span class=md-ellipsis> Guides </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> Guides </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../guides/odin-migration-guide/ class=md-nav__link> <span class=md-ellipsis> Odin Migration </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6> <label class=md-nav__link for=__nav_6 id=__nav_6_label tabindex=0> <span class=md-ellipsis> Contributing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Contributing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../project/contributing/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../../contributing/testing-patterns/ class=md-nav__link> <span class=md-ellipsis> Testing Patterns </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_7> <label class=md-nav__link for=__nav_7 id=__nav_7_label tabindex=0> <span class=md-ellipsis> Project </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Project </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../project/license/ class=md-nav__link> <span class=md-ellipsis> License </span> </a> </li> <li class=md-nav__item> <a href=../../../project/third-party-notices/ class=md-nav__link> <span class=md-ellipsis> Third-Party Notices </span> </a> </li> <li class=md-nav__item> <a href=../../../project/llms-txt/ class=md-nav__link> <span class=md-ellipsis> LLMs.txt </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <nav class=md-path aria-label=Navigation> <ol class=md-path__list> <li class=md-path__item> <a href=../../.. class=md-path__link> <span class=md-ellipsis> Home </span> </a> </li> <li class=md-path__item> <a href=../../inspector/inspector-overview/ class=md-path__link> <span class=md-ellipsis> Features </span> </a> </li> <li class=md-path__item> <a href=../math-and-extensions/ class=md-path__link> <span class=md-ellipsis> Utilities </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <a href=https://github.com/wallstop/unity-helpers/edit/main/docs/features/utilities/singletons.md title="Edit this page" class="md-content__button md-icon" rel=edit> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75z"/></svg> </a> <a href=https://github.com/wallstop/unity-helpers/raw/main/docs/features/utilities/singletons.md title="View source of this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0 8a5 5 0 0 1-5-5 5 5 0 0 1 5-5 5 5 0 0 1 5 5 5 5 0 0 1-5 5m0-12.5C7 4.5 2.73 7.61 1 12c1.73 4.39 6 7.5 11 7.5s9.27-3.11 11-7.5c-1.73-4.39-6-7.5-11-7.5"/></svg> </a> <h1 id=singleton-utilities-runtime-scriptableobject>Singleton Utilities (Runtime + ScriptableObject)<a class=headerlink href=#singleton-utilities-runtime-scriptableobject title="Permanent link">¶</a></h1> <p>Visual</p> <p><img alt="Singletons Lifecycle" src=../../../images/utilities/singletons/singletons-lifecycle.svg></p> <p>This package includes two lightweight, production‑ready singleton helpers that make global access patterns safe, consistent, and testable:</p> <ul> <li><code>RuntimeSingleton<T></code> — a component singleton that ensures one instance exists in play mode, optionally persists across scenes, and self‑initializes when first accessed.</li> <li><code>ScriptableObjectSingleton<T></code> — a configuration/data singleton backed by a single asset under <code>Resources/</code>, with an editor auto‑creator to keep assets present and correctly placed.</li> </ul> <blockquote> <p>Odin compatibility: When Odin Inspector is present (<code>ODIN_INSPECTOR</code> defined), these types derive from <code>SerializedMonoBehaviour</code> / <code>SerializedScriptableObject</code> for richer serialization. Without Odin, they fall back to Unity base types. No code changes required.</p> </blockquote> <h2 id=tldr-what-problem-this-solves>TL;DR — What Problem This Solves<a class=headerlink href=#tldr-what-problem-this-solves title="Permanent link">¶</a></h2> <ul> <li>Stop hand‑rolling global access. Get a single, safe instance you can call from anywhere.</li> <li>Choose between a scene‑resident component or a project asset for settings/data.</li> <li>No manual setup: instances auto‑create on first use; ScriptableObject assets auto‑create/move under <code>Resources/</code> in the Editor.</li> </ul> <h2 id=auto-loading-singletons>Auto-loading singletons<a class=headerlink href=#auto-loading-singletons title="Permanent link">¶</a></h2> <ul> <li>Add <code>[AutoLoadSingleton]</code> to any <code>RuntimeSingleton<T></code> or <code>ScriptableObjectSingleton<T></code> to have it instantiated automatically.</li> <li>The editor’s Attribute Metadata generator discovers those attributes (via <code>TypeCache</code>) and serializes the type name + load phase into <code>AttributeMetadataCache</code>. No manual registration or code-generation is required.</li> <li>At runtime (play mode only), <code>SingletonAutoLoader</code> reads the serialized entries and uses reflection to touch each singleton’s <code>Instance</code> during the configured <code>RuntimeInitializeLoadType</code> (default <code>BeforeSplashScreen</code>).</li> <li>Prefer auto-loading only for global services/data that every scene requires; optional or level-specific systems should still call <code>Instance</code> manually.</li> <li>Example:</li> </ul> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-0-1>1</a></span>
<span class=normal><a href=#__codelineno-0-2>2</a></span>
<span class=normal><a href=#__codelineno-0-3>3</a></span>
<span class=normal><a href=#__codelineno-0-4>4</a></span>
<span class=normal><a href=#__codelineno-0-5>5</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1></a><span class=na>[AutoLoadSingleton(RuntimeInitializeLoadType.BeforeSceneLoad)]</span>
</span><span id=__span-0-2><a id=__codelineno-0-2 name=__codelineno-0-2></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>GlobalAudioSettings</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>ScriptableObjectSingleton</span><span class=o><</span><span class=n>GlobalAudioSettings</span><span class=o>></span>
</span><span id=__span-0-3><a id=__codelineno-0-3 name=__codelineno-0-3></a><span class=p>{</span>
</span><span id=__span-0-4><a id=__codelineno-0-4 name=__codelineno-0-4></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>float</span><span class=w> </span><span class=n>masterVolume</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0.8f</span><span class=p>;</span>
</span><span id=__span-0-5><a id=__codelineno-0-5 name=__codelineno-0-5></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p>Quick decision guide</p> <ul> <li>Need a behaviour that runs (Update, events, coroutines) and may persist across scenes? Use <code>RuntimeSingleton<T></code>.</li> <li>Need global config/data you edit in the Inspector and load from any scene? Use <code>ScriptableObjectSingleton<T></code>.</li> </ul> <h2 id=quick-start-1-minute>Quick Start (1 minute)<a class=headerlink href=#quick-start-1-minute title="Permanent link">¶</a></h2> <p>RuntimeSingleton</p> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-1-1>1</a></span>
<span class=normal><a href=#__codelineno-1-2>2</a></span>
<span class=normal><a href=#__codelineno-1-3>3</a></span>
<span class=normal><a href=#__codelineno-1-4>4</a></span>
<span class=normal><a href=#__codelineno-1-5>5</a></span>
<span class=normal><a href=#__codelineno-1-6>6</a></span>
<span class=normal><a href=#__codelineno-1-7>7</a></span>
<span class=normal><a href=#__codelineno-1-8>8</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-1-1><a id=__codelineno-1-1 name=__codelineno-1-1></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>GameServices</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>RuntimeSingleton</span><span class=o><</span><span class=n>GameServices</span><span class=o>></span>
</span><span id=__span-1-2><a id=__codelineno-1-2 name=__codelineno-1-2></a><span class=p>{</span>
</span><span id=__span-1-3><a id=__codelineno-1-3 name=__codelineno-1-3></a><span class=w> </span><span class=c1>// Optional: keep across scene loads</span>
</span><span id=__span-1-4><a id=__codelineno-1-4 name=__codelineno-1-4></a><span class=w> </span><span class=k>protected</span><span class=w> </span><span class=k>override</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>Preserve</span><span class=w> </span><span class=o>=></span><span class=w> </span><span class=k>true</span><span class=p>;</span>
</span><span id=__span-1-5><a id=__codelineno-1-5 name=__codelineno-1-5></a><span class=p>}</span>
</span><span id=__span-1-6><a id=__codelineno-1-6 name=__codelineno-1-6></a>
</span><span id=__span-1-7><a id=__codelineno-1-7 name=__codelineno-1-7></a><span class=c1>// Use anywhere</span>
</span><span id=__span-1-8><a id=__codelineno-1-8 name=__codelineno-1-8></a><span class=n>GameServices</span><span class=p>.</span><span class=n>Instance</span><span class=p>.</span><span class=n>DoThing</span><span class=p>();</span>
</span></code></pre></div></td></tr></table></div> <p>ScriptableObjectSingleton</p> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-2-1>1</a></span>
<span class=normal><a href=#__codelineno-2-2>2</a></span>
<span class=normal><a href=#__codelineno-2-3>3</a></span>
<span class=normal><a href=#__codelineno-2-4>4</a></span>
<span class=normal><a href=#__codelineno-2-5>5</a></span>
<span class=normal><a href=#__codelineno-2-6>6</a></span>
<span class=normal><a href=#__codelineno-2-7>7</a></span>
<span class=normal><a href=#__codelineno-2-8>8</a></span>
<span class=normal><a href=#__codelineno-2-9>9</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-2-1><a id=__codelineno-2-1 name=__codelineno-2-1></a><span class=na>[CreateAssetMenu(menuName = "Game/Audio Settings")]</span>
</span><span id=__span-2-2><a id=__codelineno-2-2 name=__codelineno-2-2></a><span class=na>[ScriptableSingletonPath("Settings/Audio")]</span><span class=w> </span><span class=c1>// Assets/Resources/Settings/Audio/AudioSettings.asset</span>
</span><span id=__span-2-3><a id=__codelineno-2-3 name=__codelineno-2-3></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>AudioSettings</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>ScriptableObjectSingleton</span><span class=o><</span><span class=n>AudioSettings</span><span class=o>></span>
</span><span id=__span-2-4><a id=__codelineno-2-4 name=__codelineno-2-4></a><span class=p>{</span>
</span><span id=__span-2-5><a id=__codelineno-2-5 name=__codelineno-2-5></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>float</span><span class=w> </span><span class=n>masterVolume</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0.8f</span><span class=p>;</span>
</span><span id=__span-2-6><a id=__codelineno-2-6 name=__codelineno-2-6></a><span class=p>}</span>
</span><span id=__span-2-7><a id=__codelineno-2-7 name=__codelineno-2-7></a>
</span><span id=__span-2-8><a id=__codelineno-2-8 name=__codelineno-2-8></a><span class=c1>// Use anywhere (asset auto‑created/moved by the editor tool)</span>
</span><span id=__span-2-9><a id=__codelineno-2-9 name=__codelineno-2-9></a><span class=kt>float</span><span class=w> </span><span class=n>vol</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>AudioSettings</span><span class=p>.</span><span class=n>Instance</span><span class=p>.</span><span class=n>masterVolume</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p>Contents</p> <ul> <li>Odin Compatibility</li> <li>When To Use / Not To Use</li> <li>RuntimeSingleton<t></li> <li>Lifecycle diagram, examples, pitfalls</li> <li>ScriptableObjectSingleton<t></li> <li>Lookup + auto‑creator diagrams, examples, tips</li> <li>Scenarios & Guidance</li> <li>Troubleshooting</li> </ul> <p><a id=odin-compatibility></a></p> <h2 id=odin-compatibility>Odin Compatibility<a class=headerlink href=#odin-compatibility title="Permanent link">¶</a></h2> <ul> <li>With Odin installed (symbol <code>ODIN_INSPECTOR</code>), base classes inherit from <code>SerializedMonoBehaviour</code> and <code>SerializedScriptableObject</code> to enable serialization of complex types (dictionaries, polymorphic fields) with Odin drawers.</li> <li>Without Odin, bases inherit from Unity’s <code>MonoBehaviour</code>/<code>ScriptableObject</code> with no behavior change.</li> </ul> <p><a id=when-to-use></a></p> <h2 id=when-to-use>When To Use<a class=headerlink href=#when-to-use title="Permanent link">¶</a></h2> <ul> <li><code>RuntimeSingleton<T></code></li> <li>Cross‑scene services (thread dispatcher, audio router, global managers).</li> <li>Utility components that should always be available via <code>T.Instance</code>.</li> <li> <p>Creating the instance on demand when not found in the scene.</p> </li> <li> <p><code>ScriptableObjectSingleton<T></code></p> </li> <li>Global settings/configuration (graphics, audio, feature flags).</li> <li>Data that should be edited as an asset and loaded via <code>Resources</code>.</li> <li>Consistent project setup for teams (auto‑created asset on editor load).</li> </ul> <p><a id=when-not-to-use></a></p> <h2 id=when-not-to-use>When Not To Use<a class=headerlink href=#when-not-to-use title="Permanent link">¶</a></h2> <ul> <li>Prefer DI/service locators for heavily decoupled architectures requiring multiple implementations per environment, or for test seams where global state is undesirable.</li> <li>Avoid <code>RuntimeSingleton<T></code> for ephemeral, per‑scene logic or objects that should be duplicated in additive scenes.</li> <li>Avoid <code>ScriptableObjectSingleton<T></code> for save data or level‑specific data that should not live in Resources or should have multiple instances.</li> </ul> <p><a id=runtime-singleton></a></p> <h2 id=runtimesingletont-overview><code>RuntimeSingleton<T></code> Overview<a class=headerlink href=#runtimesingletont-overview title="Permanent link">¶</a></h2> <ul> <li>Access via <code>T.Instance</code> (creates a new <code>GameObject</code> named <code>"<Type>-Singleton"</code> and adds <code>T</code> if none exists; otherwise finds an existing active instance).</li> <li><code>HasInstance</code> lets you check for an existing instance without creating one.</li> <li><code>Preserve</code> (virtual, default <code>true</code>) controls <code>DontDestroyOnLoad</code>.</li> <li>Handles duplicate detection and cleans up instance reference on destroy. Instance is cleared on domain reload before scene load.</li> </ul> <p>Example: Simple service</p> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-3-1> 1</a></span>
<span class=normal><a href=#__codelineno-3-2> 2</a></span>
<span class=normal><a href=#__codelineno-3-3> 3</a></span>
<span class=normal><a href=#__codelineno-3-4> 4</a></span>
<span class=normal><a href=#__codelineno-3-5> 5</a></span>
<span class=normal><a href=#__codelineno-3-6> 6</a></span>
<span class=normal><a href=#__codelineno-3-7> 7</a></span>
<span class=normal><a href=#__codelineno-3-8> 8</a></span>
<span class=normal><a href=#__codelineno-3-9> 9</a></span>
<span class=normal><a href=#__codelineno-3-10>10</a></span>
<span class=normal><a href=#__codelineno-3-11>11</a></span>
<span class=normal><a href=#__codelineno-3-12>12</a></span>
<span class=normal><a href=#__codelineno-3-13>13</a></span>
<span class=normal><a href=#__codelineno-3-14>14</a></span>
<span class=normal><a href=#__codelineno-3-15>15</a></span>
<span class=normal><a href=#__codelineno-3-16>16</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-3-1><a id=__codelineno-3-1 name=__codelineno-3-1></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-3-2><a id=__codelineno-3-2 name=__codelineno-3-2></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Utils</span><span class=p>;</span>
</span><span id=__span-3-3><a id=__codelineno-3-3 name=__codelineno-3-3></a>
</span><span id=__span-3-4><a id=__codelineno-3-4 name=__codelineno-3-4></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>GameServices</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>RuntimeSingleton</span><span class=o><</span><span class=n>GameServices</span><span class=o>></span>
</span><span id=__span-3-5><a id=__codelineno-3-5 name=__codelineno-3-5></a><span class=p>{</span>
</span><span id=__span-3-6><a id=__codelineno-3-6 name=__codelineno-3-6></a><span class=w> </span><span class=c1>// Disable cross‑scene persistence if desired</span>
</span><span id=__span-3-7><a id=__codelineno-3-7 name=__codelineno-3-7></a><span class=w> </span><span class=k>protected</span><span class=w> </span><span class=k>override</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>Preserve</span><span class=w> </span><span class=o>=></span><span class=w> </span><span class=k>false</span><span class=p>;</span>
</span><span id=__span-3-8><a id=__codelineno-3-8 name=__codelineno-3-8></a>
</span><span id=__span-3-9><a id=__codelineno-3-9 name=__codelineno-3-9></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>Log</span><span class=p>(</span><span class=kt>string</span><span class=w> </span><span class=n>message</span><span class=p>)</span>
</span><span id=__span-3-10><a id=__codelineno-3-10 name=__codelineno-3-10></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-3-11><a id=__codelineno-3-11 name=__codelineno-3-11></a><span class=w> </span><span class=n>Debug</span><span class=p>.</span><span class=n>Log</span><span class=p>(</span><span class=s>$"[GameServices] {message}"</span><span class=p>);</span>
</span><span id=__span-3-12><a id=__codelineno-3-12 name=__codelineno-3-12></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-3-13><a id=__codelineno-3-13 name=__codelineno-3-13></a><span class=p>}</span>
</span><span id=__span-3-14><a id=__codelineno-3-14 name=__codelineno-3-14></a>
</span><span id=__span-3-15><a id=__codelineno-3-15 name=__codelineno-3-15></a><span class=c1>// Usage from anywhere</span>
</span><span id=__span-3-16><a id=__codelineno-3-16 name=__codelineno-3-16></a><span class=n>GameServices</span><span class=p>.</span><span class=n>Instance</span><span class=p>.</span><span class=n>Log</span><span class=p>(</span><span class=s>"Hello world"</span><span class=p>);</span>
</span></code></pre></div></td></tr></table></div> <p>Odin note: With Odin installed, the class inherits <code>SerializedMonoBehaviour</code>, enabling dictionaries and other complex serialized types.</p> <p>Common pitfalls:</p> <ul> <li>If an inactive instance exists in the scene, <code>Instance</code> won’t find it (search excludes inactive objects) and will create a new one.</li> <li>If two active instances exist, the newer one logs an error and destroys itself.</li> <li>If <code>Preserve</code> is <code>true</code>, the instance is detached and marked <code>DontDestroyOnLoad</code>.</li> </ul> <p>Lifecycle diagram:</p> <div class="language-text highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>Text Only</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-4-1>1</a></span>
<span class=normal><a href=#__codelineno-4-2>2</a></span>
<span class=normal><a href=#__codelineno-4-3>3</a></span>
<span class=normal><a href=#__codelineno-4-4>4</a></span>
<span class=normal><a href=#__codelineno-4-5>5</a></span>
<span class=normal><a href=#__codelineno-4-6>6</a></span>
<span class=normal><a href=#__codelineno-4-7>7</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-4-1><a id=__codelineno-4-1 name=__codelineno-4-1></a>T.Instance ─┬─ Has _instance? ──▶ return
</span><span id=__span-4-2><a id=__codelineno-4-2 name=__codelineno-4-2></a> │
</span><span id=__span-4-3><a id=__codelineno-4-3 name=__codelineno-4-3></a> ├─ Find active T in scene? ──▶ set _instance, return
</span><span id=__span-4-4><a id=__codelineno-4-4 name=__codelineno-4-4></a> │
</span><span id=__span-4-5><a id=__codelineno-4-5 name=__codelineno-4-5></a> └─ Create GameObject("T-Singleton") + Add T
</span><span id=__span-4-6><a id=__codelineno-4-6 name=__codelineno-4-6></a> └─ Awake(): assign _instance, if Preserve: DontDestroyOnLoad
</span><span id=__span-4-7><a id=__codelineno-4-7 name=__codelineno-4-7></a> └─ Start(): if duplicate, log + destroy self
</span></code></pre></div></td></tr></table></div> <p>Notes:</p> <ul> <li>To avoid creation during a sensitive frame, place a pre‑made instance in your bootstrap scene.</li> <li>For scene‑local managers, override <code>Preserve => false</code>.</li> </ul> <p><a id=scriptableobject-singleton></a></p> <h2 id=scriptableobjectsingletont-overview><code>ScriptableObjectSingleton<T></code> Overview<a class=headerlink href=#scriptableobjectsingletont-overview title="Permanent link">¶</a></h2> <ul> <li>Access via <code>T.Instance</code> (lazy‑loads from <code>Resources/</code> using either a custom path or the type name; warns if multiple assets found and chooses the first by name).</li> <li><code>HasInstance</code> indicates whether the lazy value exists and is not null.</li> <li>Optional <code>[ScriptableSingletonPath("Sub/Folder")]</code> to control the <code>Resources</code> subfolder.</li> <li>Editor utility auto‑creates and relocates assets: see the “ScriptableObject Singleton Creator” in the Editor Tools Guide.</li> </ul> <p>Example: Settings asset</p> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-5-1> 1</a></span>
<span class=normal><a href=#__codelineno-5-2> 2</a></span>
<span class=normal><a href=#__codelineno-5-3> 3</a></span>
<span class=normal><a href=#__codelineno-5-4> 4</a></span>
<span class=normal><a href=#__codelineno-5-5> 5</a></span>
<span class=normal><a href=#__codelineno-5-6> 6</a></span>
<span class=normal><a href=#__codelineno-5-7> 7</a></span>
<span class=normal><a href=#__codelineno-5-8> 8</a></span>
<span class=normal><a href=#__codelineno-5-9> 9</a></span>
<span class=normal><a href=#__codelineno-5-10>10</a></span>
<span class=normal><a href=#__codelineno-5-11>11</a></span>
<span class=normal><a href=#__codelineno-5-12>12</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-5-1><a id=__codelineno-5-1 name=__codelineno-5-1></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Utils</span><span class=p>;</span>
</span><span id=__span-5-2><a id=__codelineno-5-2 name=__codelineno-5-2></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Core.Attributes</span><span class=p>;</span>
</span><span id=__span-5-3><a id=__codelineno-5-3 name=__codelineno-5-3></a>
</span><span id=__span-5-4><a id=__codelineno-5-4 name=__codelineno-5-4></a><span class=na>[ScriptableSingletonPath("Settings/Audio")]</span>
</span><span id=__span-5-5><a id=__codelineno-5-5 name=__codelineno-5-5></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>AudioSettings</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>ScriptableObjectSingleton</span><span class=o><</span><span class=n>AudioSettings</span><span class=o>></span>
</span><span id=__span-5-6><a id=__codelineno-5-6 name=__codelineno-5-6></a><span class=p>{</span>
</span><span id=__span-5-7><a id=__codelineno-5-7 name=__codelineno-5-7></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>float</span><span class=w> </span><span class=n>musicVolume</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0.8f</span><span class=p>;</span>
</span><span id=__span-5-8><a id=__codelineno-5-8 name=__codelineno-5-8></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>enableSpatialAudio</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>true</span><span class=p>;</span>
</span><span id=__span-5-9><a id=__codelineno-5-9 name=__codelineno-5-9></a><span class=p>}</span>
</span><span id=__span-5-10><a id=__codelineno-5-10 name=__codelineno-5-10></a>
</span><span id=__span-5-11><a id=__codelineno-5-11 name=__codelineno-5-11></a><span class=c1>// Usage at runtime</span>
</span><span id=__span-5-12><a id=__codelineno-5-12 name=__codelineno-5-12></a><span class=kt>float</span><span class=w> </span><span class=n>vol</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>AudioSettings</span><span class=p>.</span><span class=n>Instance</span><span class=p>.</span><span class=n>musicVolume</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p>Odin note: With Odin installed, the class inherits <code>SerializedScriptableObject</code>, so you can safely serialize complex collections without custom drawers.</p> <p>Asset management tips:</p> <ul> <li>Place the asset under <code>Assets/Resources/</code> (or under the path from <code>[ScriptableSingletonPath]</code>).</li> <li>The Editor’s “ScriptableObject Singleton Creator” runs on load to create missing assets and move misplaced ones. It also supports a test‑assembly toggle used by our test suite.</li> </ul> <p>Lookup order diagram:</p> <div class="language-text highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>Text Only</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-6-1>1</a></span>
<span class=normal><a href=#__codelineno-6-2>2</a></span>
<span class=normal><a href=#__codelineno-6-3>3</a></span>
<span class=normal><a href=#__codelineno-6-4>4</a></span>
<span class=normal><a href=#__codelineno-6-5>5</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-6-1><a id=__codelineno-6-1 name=__codelineno-6-1></a>Instance access:
</span><span id=__span-6-2><a id=__codelineno-6-2 name=__codelineno-6-2></a> [1] Resources.LoadAll<T>(custom path from [ScriptableSingletonPath])
</span><span id=__span-6-3><a id=__codelineno-6-3 name=__codelineno-6-3></a> [2] if none: Resources.Load<T>(type name)
</span><span id=__span-6-4><a id=__codelineno-6-4 name=__codelineno-6-4></a> [3] if none: Resources.LoadAll<T>(root)
</span><span id=__span-6-5><a id=__codelineno-6-5 name=__codelineno-6-5></a> [4] if multiple: warn + pick first by name (sorted)
</span></code></pre></div></td></tr></table></div> <p>Auto‑creator flow (Editor):</p> <div class="language-text highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>Text Only</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-7-1>1</a></span>
<span class=normal><a href=#__codelineno-7-2>2</a></span>
<span class=normal><a href=#__codelineno-7-3>3</a></span>
<span class=normal><a href=#__codelineno-7-4>4</a></span>
<span class=normal><a href=#__codelineno-7-5>5</a></span>
<span class=normal><a href=#__codelineno-7-6>6</a></span>
<span class=normal><a href=#__codelineno-7-7>7</a></span>
<span class=normal><a href=#__codelineno-7-8>8</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-7-1><a id=__codelineno-7-1 name=__codelineno-7-1></a>On editor load:
</span><span id=__span-7-2><a id=__codelineno-7-2 name=__codelineno-7-2></a> - Scan all ScriptableObjectSingleton<T> types
</span><span id=__span-7-3><a id=__codelineno-7-3 name=__codelineno-7-3></a> - For each non-abstract type:
</span><span id=__span-7-4><a id=__codelineno-7-4 name=__codelineno-7-4></a> - Determine Resources path (attribute or type name)
</span><span id=__span-7-5><a id=__codelineno-7-5 name=__codelineno-7-5></a> - Ensure folder under Assets/Resources
</span><span id=__span-7-6><a id=__codelineno-7-6 name=__codelineno-7-6></a> - If asset exists elsewhere: move to target path
</span><span id=__span-7-7><a id=__codelineno-7-7 name=__codelineno-7-7></a> - Else: create new asset at target path
</span><span id=__span-7-8><a id=__codelineno-7-8 name=__codelineno-7-8></a> - Save & Refresh if changes
</span></code></pre></div></td></tr></table></div> <p>Asset structure diagram:</p> <div class="language-text highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>Text Only</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-8-1> 1</a></span>
<span class=normal><a href=#__codelineno-8-2> 2</a></span>
<span class=normal><a href=#__codelineno-8-3> 3</a></span>
<span class=normal><a href=#__codelineno-8-4> 4</a></span>
<span class=normal><a href=#__codelineno-8-5> 5</a></span>
<span class=normal><a href=#__codelineno-8-6> 6</a></span>
<span class=normal><a href=#__codelineno-8-7> 7</a></span>
<span class=normal><a href=#__codelineno-8-8> 8</a></span>
<span class=normal><a href=#__codelineno-8-9> 9</a></span>
<span class=normal><a href=#__codelineno-8-10>10</a></span>
<span class=normal><a href=#__codelineno-8-11>11</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-8-1><a id=__codelineno-8-1 name=__codelineno-8-1></a>Default (no attribute):
</span><span id=__span-8-2><a id=__codelineno-8-2 name=__codelineno-8-2></a>Assets/
</span><span id=__span-8-3><a id=__codelineno-8-3 name=__codelineno-8-3></a> Resources/
</span><span id=__span-8-4><a id=__codelineno-8-4 name=__codelineno-8-4></a> AudioSettings.asset // type name
</span><span id=__span-8-5><a id=__codelineno-8-5 name=__codelineno-8-5></a>
</span><span id=__span-8-6><a id=__codelineno-8-6 name=__codelineno-8-6></a>With [ScriptableSingletonPath("Settings/Audio")]:
</span><span id=__span-8-7><a id=__codelineno-8-7 name=__codelineno-8-7></a>Assets/
</span><span id=__span-8-8><a id=__codelineno-8-8 name=__codelineno-8-8></a> Resources/
</span><span id=__span-8-9><a id=__codelineno-8-9 name=__codelineno-8-9></a> Settings/
</span><span id=__span-8-10><a id=__codelineno-8-10 name=__codelineno-8-10></a> Audio/
</span><span id=__span-8-11><a id=__codelineno-8-11 name=__codelineno-8-11></a> AudioSettings.asset
</span></code></pre></div></td></tr></table></div> <p><a id=scenarios></a></p> <h2 id=scenarios-guidance>Scenarios & Guidance<a class=headerlink href=#scenarios-guidance title="Permanent link">¶</a></h2> <ul> <li>Global dispatcher: See <code>UnityMainThreadDispatcher</code> which derives from <code>RuntimeSingleton<UnityMainThreadDispatcher></code>.</li> <li>Global data caches or registries: Use <code>ScriptableObjectSingleton<T></code> so data lives in a single editable asset and loads fast.</li> <li>Cross‑scene managers: Keep <code>Preserve = true</code> to avoid duplicates across scene loads.</li> </ul> <h3 id=data-registries-lookups-single-source-of-truth>Data Registries & Lookups (Single Source of Truth)<a class=headerlink href=#data-registries-lookups-single-source-of-truth title="Permanent link">¶</a></h3> <p>ScriptableObject singletons excel as in‑project “databases” for content/config:</p> <ul> <li>Centralize definitions (items, abilities, buffs, NPCs, localization) in one asset.</li> <li>Build fast lookup indices (by ID/tag/category) at load or validation time.</li> <li>Keep workflows simple: edit in Inspector, no runtime bootstrapping needed.</li> </ul> <p>Example: Items DB with indices</p> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-9-1> 1</a></span>
<span class=normal><a href=#__codelineno-9-2> 2</a></span>
<span class=normal><a href=#__codelineno-9-3> 3</a></span>
<span class=normal><a href=#__codelineno-9-4> 4</a></span>
<span class=normal><a href=#__codelineno-9-5> 5</a></span>
<span class=normal><a href=#__codelineno-9-6> 6</a></span>
<span class=normal><a href=#__codelineno-9-7> 7</a></span>
<span class=normal><a href=#__codelineno-9-8> 8</a></span>
<span class=normal><a href=#__codelineno-9-9> 9</a></span>
<span class=normal><a href=#__codelineno-9-10>10</a></span>
<span class=normal><a href=#__codelineno-9-11>11</a></span>
<span class=normal><a href=#__codelineno-9-12>12</a></span>
<span class=normal><a href=#__codelineno-9-13>13</a></span>
<span class=normal><a href=#__codelineno-9-14>14</a></span>
<span class=normal><a href=#__codelineno-9-15>15</a></span>
<span class=normal><a href=#__codelineno-9-16>16</a></span>
<span class=normal><a href=#__codelineno-9-17>17</a></span>
<span class=normal><a href=#__codelineno-9-18>18</a></span>
<span class=normal><a href=#__codelineno-9-19>19</a></span>
<span class=normal><a href=#__codelineno-9-20>20</a></span>
<span class=normal><a href=#__codelineno-9-21>21</a></span>
<span class=normal><a href=#__codelineno-9-22>22</a></span>
<span class=normal><a href=#__codelineno-9-23>23</a></span>
<span class=normal><a href=#__codelineno-9-24>24</a></span>
<span class=normal><a href=#__codelineno-9-25>25</a></span>
<span class=normal><a href=#__codelineno-9-26>26</a></span>
<span class=normal><a href=#__codelineno-9-27>27</a></span>
<span class=normal><a href=#__codelineno-9-28>28</a></span>
<span class=normal><a href=#__codelineno-9-29>29</a></span>
<span class=normal><a href=#__codelineno-9-30>30</a></span>
<span class=normal><a href=#__codelineno-9-31>31</a></span>
<span class=normal><a href=#__codelineno-9-32>32</a></span>
<span class=normal><a href=#__codelineno-9-33>33</a></span>
<span class=normal><a href=#__codelineno-9-34>34</a></span>
<span class=normal><a href=#__codelineno-9-35>35</a></span>
<span class=normal><a href=#__codelineno-9-36>36</a></span>
<span class=normal><a href=#__codelineno-9-37>37</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-9-1><a id=__codelineno-9-1 name=__codelineno-9-1></a><span class=k>using</span><span class=w> </span><span class=nn>System.Collections.Generic</span><span class=p>;</span>
</span><span id=__span-9-2><a id=__codelineno-9-2 name=__codelineno-9-2></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-9-3><a id=__codelineno-9-3 name=__codelineno-9-3></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Utils</span><span class=p>;</span>
</span><span id=__span-9-4><a id=__codelineno-9-4 name=__codelineno-9-4></a>
</span><span id=__span-9-5><a id=__codelineno-9-5 name=__codelineno-9-5></a><span class=na>[CreateAssetMenu(menuName = "Game/Items DB")]</span>
</span><span id=__span-9-6><a id=__codelineno-9-6 name=__codelineno-9-6></a><span class=na>[ScriptableSingletonPath("DB")]</span><span class=w> </span><span class=c1>// Assets/Resources/DB/ItemsDb.asset</span>
</span><span id=__span-9-7><a id=__codelineno-9-7 name=__codelineno-9-7></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>ItemsDb</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>ScriptableObjectSingleton</span><span class=o><</span><span class=n>ItemsDb</span><span class=o>></span>
</span><span id=__span-9-8><a id=__codelineno-9-8 name=__codelineno-9-8></a><span class=p>{</span>
</span><span id=__span-9-9><a id=__codelineno-9-9 name=__codelineno-9-9></a><span class=w> </span><span class=na>[System.Serializable]</span>
</span><span id=__span-9-10><a id=__codelineno-9-10 name=__codelineno-9-10></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>ItemDef</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>id</span><span class=p>;</span><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>name</span><span class=p>;</span><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>Sprite</span><span class=w> </span><span class=n>icon</span><span class=p>;</span><span class=w> </span><span class=p>}</span>
</span><span id=__span-9-11><a id=__codelineno-9-11 name=__codelineno-9-11></a>
</span><span id=__span-9-12><a id=__codelineno-9-12 name=__codelineno-9-12></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>List</span><span class=o><</span><span class=n>ItemDef</span><span class=o>></span><span class=w> </span><span class=n>items</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>();</span>
</span><span id=__span-9-13><a id=__codelineno-9-13 name=__codelineno-9-13></a>
</span><span id=__span-9-14><a id=__codelineno-9-14 name=__codelineno-9-14></a><span class=w> </span><span class=c1>// Non-serialized runtime indices</span>
</span><span id=__span-9-15><a id=__codelineno-9-15 name=__codelineno-9-15></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=n>Dictionary</span><span class=o><</span><span class=kt>int</span><span class=p>,</span><span class=w> </span><span class=n>ItemDef</span><span class=o>></span><span class=w> </span><span class=n>_byId</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>();</span>
</span><span id=__span-9-16><a id=__codelineno-9-16 name=__codelineno-9-16></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=n>Dictionary</span><span class=o><</span><span class=kt>string</span><span class=p>,</span><span class=w> </span><span class=n>List</span><span class=o><</span><span class=n>ItemDef</span><span class=o>>></span><span class=w> </span><span class=n>_byName</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>();</span>
</span><span id=__span-9-17><a id=__codelineno-9-17 name=__codelineno-9-17></a>
</span><span id=__span-9-18><a id=__codelineno-9-18 name=__codelineno-9-18></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>OnEnable</span><span class=p>()</span><span class=w> </span><span class=o>=></span><span class=w> </span><span class=n>RebuildIndices</span><span class=p>();</span>
</span><span id=__span-9-19><a id=__codelineno-9-19 name=__codelineno-9-19></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>OnValidate</span><span class=p>()</span><span class=w> </span><span class=o>=></span><span class=w> </span><span class=n>RebuildIndices</span><span class=p>();</span>
</span><span id=__span-9-20><a id=__codelineno-9-20 name=__codelineno-9-20></a>
</span><span id=__span-9-21><a id=__codelineno-9-21 name=__codelineno-9-21></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>RebuildIndices</span><span class=p>()</span>
</span><span id=__span-9-22><a id=__codelineno-9-22 name=__codelineno-9-22></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-9-23><a id=__codelineno-9-23 name=__codelineno-9-23></a><span class=w> </span><span class=n>_byId</span><span class=p>.</span><span class=n>Clear</span><span class=p>();</span>
</span><span id=__span-9-24><a id=__codelineno-9-24 name=__codelineno-9-24></a><span class=w> </span><span class=n>_byName</span><span class=p>.</span><span class=n>Clear</span><span class=p>();</span>
</span><span id=__span-9-25><a id=__codelineno-9-25 name=__codelineno-9-25></a><span class=w> </span><span class=k>foreach</span><span class=w> </span><span class=p>(</span><span class=kt>var</span><span class=w> </span><span class=n>it</span><span class=w> </span><span class=k>in</span><span class=w> </span><span class=n>items</span><span class=p>)</span>
</span><span id=__span-9-26><a id=__codelineno-9-26 name=__codelineno-9-26></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-9-27><a id=__codelineno-9-27 name=__codelineno-9-27></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>it</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=k>null</span><span class=p>)</span><span class=w> </span><span class=k>continue</span><span class=p>;</span>
</span><span id=__span-9-28><a id=__codelineno-9-28 name=__codelineno-9-28></a><span class=w> </span><span class=n>_byId</span><span class=p>[</span><span class=n>it</span><span class=p>.</span><span class=n>id</span><span class=p>]</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>it</span><span class=p>;</span>
</span><span id=__span-9-29><a id=__codelineno-9-29 name=__codelineno-9-29></a><span class=w> </span><span class=p>(</span><span class=n>_byName</span><span class=p>.</span><span class=n>TryGetValue</span><span class=p>(</span><span class=n>it</span><span class=p>.</span><span class=n>name</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>list</span><span class=p>)</span><span class=w> </span><span class=o>?</span><span class=w> </span><span class=n>list</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=p>(</span><span class=n>_byName</span><span class=p>[</span><span class=n>it</span><span class=p>.</span><span class=n>name</span><span class=p>]</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>())).</span><span class=n>Add</span><span class=p>(</span><span class=n>it</span><span class=p>);</span>
</span><span id=__span-9-30><a id=__codelineno-9-30 name=__codelineno-9-30></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-9-31><a id=__codelineno-9-31 name=__codelineno-9-31></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-9-32><a id=__codelineno-9-32 name=__codelineno-9-32></a>
</span><span id=__span-9-33><a id=__codelineno-9-33 name=__codelineno-9-33></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>static</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=nf>TryGetById</span><span class=p>(</span><span class=kt>int</span><span class=w> </span><span class=n>id</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=n>ItemDef</span><span class=w> </span><span class=n>def</span><span class=p>)</span><span class=w> </span><span class=o>=></span><span class=w> </span><span class=n>Instance</span><span class=p>.</span><span class=n>_byId</span><span class=p>.</span><span class=n>TryGetValue</span><span class=p>(</span><span class=n>id</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=n>def</span><span class=p>);</span>
</span><span id=__span-9-34><a id=__codelineno-9-34 name=__codelineno-9-34></a><span class=p>}</span>
</span><span id=__span-9-35><a id=__codelineno-9-35 name=__codelineno-9-35></a>
</span><span id=__span-9-36><a id=__codelineno-9-36 name=__codelineno-9-36></a><span class=c1>// Usage</span>
</span><span id=__span-9-37><a id=__codelineno-9-37 name=__codelineno-9-37></a><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>ItemsDb</span><span class=p>.</span><span class=n>TryGetById</span><span class=p>(</span><span class=mi>42</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>sword</span><span class=p>))</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=cm>/* equip sword */</span><span class=w> </span><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p>Tips</p> <ul> <li>The auto-creator now maintains <code>Assets/Resources/Wallstop Studios/Unity Helpers/ScriptableObjectSingletonMetadata.asset</code>, which records the exact <code>Resources</code> load path + GUID for every singleton asset. At runtime, <code>ScriptableObjectSingleton<T></code> consults this metadata so it can call <code>Resources.Load("Folder/MySingleton")</code> directly (or <code>Resources.LoadAll</code> scoped to <code>Folder/</code> when it needs to detect duplicates) and never falls back to <code>Resources.LoadAll(string.Empty)</code>.</li> <li>When metadata is missing or stale (e.g., if you deleted the metadata asset in a test project), the runtime logs a warning once per type and falls back to a bounded search (<code>Resources.Load<T>(typeName)</code> + editor-only <code>AssetDatabase</code> lookups) instead of scanning the entire <code>Resources</code> tree.</li> <li>Keep serialized lists as your source of truth; build dictionaries at load/validate.</li> <li>Use <code>[ScriptableSingletonPath]</code> to place the asset predictably under <code>Resources/</code>.</li> <li>Split huge DBs into themed sub‑assets and cross‑reference via indices.</li> <li>Consider GUIDs or string IDs for modding; validate uniqueness in <code>OnValidate</code>.</li> </ul> <h4 id=example-content-db-with-tags-categories-guids-addressables>Example: Content DB with tags, categories, GUIDs (Addressables)<a class=headerlink href=#example-content-db-with-tags-categories-guids-addressables title="Permanent link">¶</a></h4> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-10-1> 1</a></span>
<span class=normal><a href=#__codelineno-10-2> 2</a></span>
<span class=normal><a href=#__codelineno-10-3> 3</a></span>
<span class=normal><a href=#__codelineno-10-4> 4</a></span>
<span class=normal><a href=#__codelineno-10-5> 5</a></span>
<span class=normal><a href=#__codelineno-10-6> 6</a></span>
<span class=normal><a href=#__codelineno-10-7> 7</a></span>
<span class=normal><a href=#__codelineno-10-8> 8</a></span>
<span class=normal><a href=#__codelineno-10-9> 9</a></span>
<span class=normal><a href=#__codelineno-10-10>10</a></span>
<span class=normal><a href=#__codelineno-10-11>11</a></span>
<span class=normal><a href=#__codelineno-10-12>12</a></span>
<span class=normal><a href=#__codelineno-10-13>13</a></span>
<span class=normal><a href=#__codelineno-10-14>14</a></span>
<span class=normal><a href=#__codelineno-10-15>15</a></span>
<span class=normal><a href=#__codelineno-10-16>16</a></span>
<span class=normal><a href=#__codelineno-10-17>17</a></span>
<span class=normal><a href=#__codelineno-10-18>18</a></span>
<span class=normal><a href=#__codelineno-10-19>19</a></span>
<span class=normal><a href=#__codelineno-10-20>20</a></span>
<span class=normal><a href=#__codelineno-10-21>21</a></span>
<span class=normal><a href=#__codelineno-10-22>22</a></span>
<span class=normal><a href=#__codelineno-10-23>23</a></span>
<span class=normal><a href=#__codelineno-10-24>24</a></span>
<span class=normal><a href=#__codelineno-10-25>25</a></span>
<span class=normal><a href=#__codelineno-10-26>26</a></span>
<span class=normal><a href=#__codelineno-10-27>27</a></span>
<span class=normal><a href=#__codelineno-10-28>28</a></span>
<span class=normal><a href=#__codelineno-10-29>29</a></span>
<span class=normal><a href=#__codelineno-10-30>30</a></span>
<span class=normal><a href=#__codelineno-10-31>31</a></span>
<span class=normal><a href=#__codelineno-10-32>32</a></span>
<span class=normal><a href=#__codelineno-10-33>33</a></span>
<span class=normal><a href=#__codelineno-10-34>34</a></span>
<span class=normal><a href=#__codelineno-10-35>35</a></span>
<span class=normal><a href=#__codelineno-10-36>36</a></span>
<span class=normal><a href=#__codelineno-10-37>37</a></span>
<span class=normal><a href=#__codelineno-10-38>38</a></span>
<span class=normal><a href=#__codelineno-10-39>39</a></span>
<span class=normal><a href=#__codelineno-10-40>40</a></span>
<span class=normal><a href=#__codelineno-10-41>41</a></span>
<span class=normal><a href=#__codelineno-10-42>42</a></span>
<span class=normal><a href=#__codelineno-10-43>43</a></span>
<span class=normal><a href=#__codelineno-10-44>44</a></span>
<span class=normal><a href=#__codelineno-10-45>45</a></span>
<span class=normal><a href=#__codelineno-10-46>46</a></span>
<span class=normal><a href=#__codelineno-10-47>47</a></span>
<span class=normal><a href=#__codelineno-10-48>48</a></span>
<span class=normal><a href=#__codelineno-10-49>49</a></span>
<span class=normal><a href=#__codelineno-10-50>50</a></span>
<span class=normal><a href=#__codelineno-10-51>51</a></span>
<span class=normal><a href=#__codelineno-10-52>52</a></span>
<span class=normal><a href=#__codelineno-10-53>53</a></span>
<span class=normal><a href=#__codelineno-10-54>54</a></span>
<span class=normal><a href=#__codelineno-10-55>55</a></span>
<span class=normal><a href=#__codelineno-10-56>56</a></span>
<span class=normal><a href=#__codelineno-10-57>57</a></span>
<span class=normal><a href=#__codelineno-10-58>58</a></span>
<span class=normal><a href=#__codelineno-10-59>59</a></span>
<span class=normal><a href=#__codelineno-10-60>60</a></span>
<span class=normal><a href=#__codelineno-10-61>61</a></span>
<span class=normal><a href=#__codelineno-10-62>62</a></span>
<span class=normal><a href=#__codelineno-10-63>63</a></span>
<span class=normal><a href=#__codelineno-10-64>64</a></span>
<span class=normal><a href=#__codelineno-10-65>65</a></span>
<span class=normal><a href=#__codelineno-10-66>66</a></span>
<span class=normal><a href=#__codelineno-10-67>67</a></span>
<span class=normal><a href=#__codelineno-10-68>68</a></span>
<span class=normal><a href=#__codelineno-10-69>69</a></span>
<span class=normal><a href=#__codelineno-10-70>70</a></span>
<span class=normal><a href=#__codelineno-10-71>71</a></span>
<span class=normal><a href=#__codelineno-10-72>72</a></span>
<span class=normal><a href=#__codelineno-10-73>73</a></span>
<span class=normal><a href=#__codelineno-10-74>74</a></span>
<span class=normal><a href=#__codelineno-10-75>75</a></span>
<span class=normal><a href=#__codelineno-10-76>76</a></span>
<span class=normal><a href=#__codelineno-10-77>77</a></span>
<span class=normal><a href=#__codelineno-10-78>78</a></span>
<span class=normal><a href=#__codelineno-10-79>79</a></span>
<span class=normal><a href=#__codelineno-10-80>80</a></span>
<span class=normal><a href=#__codelineno-10-81>81</a></span>
<span class=normal><a href=#__codelineno-10-82>82</a></span>
<span class=normal><a href=#__codelineno-10-83>83</a></span>
<span class=normal><a href=#__codelineno-10-84>84</a></span>
<span class=normal><a href=#__codelineno-10-85>85</a></span>
<span class=normal><a href=#__codelineno-10-86>86</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-10-1><a id=__codelineno-10-1 name=__codelineno-10-1></a><span class=k>using</span><span class=w> </span><span class=nn>System.Collections.Generic</span><span class=p>;</span>
</span><span id=__span-10-2><a id=__codelineno-10-2 name=__codelineno-10-2></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-10-3><a id=__codelineno-10-3 name=__codelineno-10-3></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Utils</span><span class=p>;</span>
</span><span id=__span-10-4><a id=__codelineno-10-4 name=__codelineno-10-4></a><span class=cp>#if UNITY_EDITOR</span>
</span><span id=__span-10-5><a id=__codelineno-10-5 name=__codelineno-10-5></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEditor</span><span class=p>;</span>
</span><span id=__span-10-6><a id=__codelineno-10-6 name=__codelineno-10-6></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEditor.AddressableAssets</span><span class=p>;</span>
</span><span id=__span-10-7><a id=__codelineno-10-7 name=__codelineno-10-7></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEditor.AddressableAssets.Settings</span><span class=p>;</span>
</span><span id=__span-10-8><a id=__codelineno-10-8 name=__codelineno-10-8></a><span class=cp>#endif</span>
</span><span id=__span-10-9><a id=__codelineno-10-9 name=__codelineno-10-9></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine.AddressableAssets</span><span class=p>;</span>
</span><span id=__span-10-10><a id=__codelineno-10-10 name=__codelineno-10-10></a>
</span><span id=__span-10-11><a id=__codelineno-10-11 name=__codelineno-10-11></a><span class=k>public</span><span class=w> </span><span class=k>enum</span><span class=w> </span><span class=n>ContentCategory</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>Weapon</span><span class=p>,</span><span class=w> </span><span class=n>Armor</span><span class=p>,</span><span class=w> </span><span class=n>Consumable</span><span class=p>,</span><span class=w> </span><span class=n>Quest</span><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-12><a id=__codelineno-10-12 name=__codelineno-10-12></a>
</span><span id=__span-10-13><a id=__codelineno-10-13 name=__codelineno-10-13></a><span class=na>[CreateAssetMenu(menuName = "Game/Content DB")]</span>
</span><span id=__span-10-14><a id=__codelineno-10-14 name=__codelineno-10-14></a><span class=na>[ScriptableSingletonPath("DB")]</span><span class=w> </span><span class=c1>// Assets/Resources/DB/ContentDb.asset</span>
</span><span id=__span-10-15><a id=__codelineno-10-15 name=__codelineno-10-15></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>ContentDb</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>ScriptableObjectSingleton</span><span class=o><</span><span class=n>ContentDb</span><span class=o>></span>
</span><span id=__span-10-16><a id=__codelineno-10-16 name=__codelineno-10-16></a><span class=p>{</span>
</span><span id=__span-10-17><a id=__codelineno-10-17 name=__codelineno-10-17></a><span class=w> </span><span class=na>[System.Serializable]</span>
</span><span id=__span-10-18><a id=__codelineno-10-18 name=__codelineno-10-18></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>ContentDef</span>
</span><span id=__span-10-19><a id=__codelineno-10-19 name=__codelineno-10-19></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-10-20><a id=__codelineno-10-20 name=__codelineno-10-20></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>guid</span><span class=p>;</span><span class=w> </span><span class=c1>// stable ID for saves/mods</span>
</span><span id=__span-10-21><a id=__codelineno-10-21 name=__codelineno-10-21></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>displayName</span><span class=p>;</span>
</span><span id=__span-10-22><a id=__codelineno-10-22 name=__codelineno-10-22></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>ContentCategory</span><span class=w> </span><span class=n>category</span><span class=p>;</span>
</span><span id=__span-10-23><a id=__codelineno-10-23 name=__codelineno-10-23></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=p>[]</span><span class=w> </span><span class=n>tags</span><span class=p>;</span><span class=w> </span><span class=c1>// e.g., "fire", "ranged"</span>
</span><span id=__span-10-24><a id=__codelineno-10-24 name=__codelineno-10-24></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>AssetReferenceGameObject</span><span class=w> </span><span class=n>prefab</span><span class=p>;</span><span class=w> </span><span class=c1>// addressable ref (optional)</span>
</span><span id=__span-10-25><a id=__codelineno-10-25 name=__codelineno-10-25></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-26><a id=__codelineno-10-26 name=__codelineno-10-26></a>
</span><span id=__span-10-27><a id=__codelineno-10-27 name=__codelineno-10-27></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>List</span><span class=o><</span><span class=n>ContentDef</span><span class=o>></span><span class=w> </span><span class=n>entries</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>();</span>
</span><span id=__span-10-28><a id=__codelineno-10-28 name=__codelineno-10-28></a>
</span><span id=__span-10-29><a id=__codelineno-10-29 name=__codelineno-10-29></a><span class=w> </span><span class=c1>// Indices (runtime only)</span>
</span><span id=__span-10-30><a id=__codelineno-10-30 name=__codelineno-10-30></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=n>Dictionary</span><span class=o><</span><span class=kt>string</span><span class=p>,</span><span class=w> </span><span class=n>ContentDef</span><span class=o>></span><span class=w> </span><span class=n>_byGuid</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>();</span>
</span><span id=__span-10-31><a id=__codelineno-10-31 name=__codelineno-10-31></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=n>Dictionary</span><span class=o><</span><span class=n>ContentCategory</span><span class=p>,</span><span class=w> </span><span class=n>List</span><span class=o><</span><span class=n>ContentDef</span><span class=o>>></span><span class=w> </span><span class=n>_byCategory</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>();</span>
</span><span id=__span-10-32><a id=__codelineno-10-32 name=__codelineno-10-32></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=n>Dictionary</span><span class=o><</span><span class=kt>string</span><span class=p>,</span><span class=w> </span><span class=n>List</span><span class=o><</span><span class=n>ContentDef</span><span class=o>>></span><span class=w> </span><span class=n>_byTag</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>();</span>
</span><span id=__span-10-33><a id=__codelineno-10-33 name=__codelineno-10-33></a>
</span><span id=__span-10-34><a id=__codelineno-10-34 name=__codelineno-10-34></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>OnEnable</span><span class=p>()</span><span class=w> </span><span class=o>=></span><span class=w> </span><span class=n>RebuildIndices</span><span class=p>();</span>
</span><span id=__span-10-35><a id=__codelineno-10-35 name=__codelineno-10-35></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>OnValidate</span><span class=p>()</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>RebuildIndices</span><span class=p>();</span><span class=w> </span><span class=n>ValidateEditor</span><span class=p>();</span><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-36><a id=__codelineno-10-36 name=__codelineno-10-36></a>
</span><span id=__span-10-37><a id=__codelineno-10-37 name=__codelineno-10-37></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>RebuildIndices</span><span class=p>()</span>
</span><span id=__span-10-38><a id=__codelineno-10-38 name=__codelineno-10-38></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-10-39><a id=__codelineno-10-39 name=__codelineno-10-39></a><span class=w> </span><span class=n>_byGuid</span><span class=p>.</span><span class=n>Clear</span><span class=p>();</span><span class=w> </span><span class=n>_byCategory</span><span class=p>.</span><span class=n>Clear</span><span class=p>();</span><span class=w> </span><span class=n>_byTag</span><span class=p>.</span><span class=n>Clear</span><span class=p>();</span>
</span><span id=__span-10-40><a id=__codelineno-10-40 name=__codelineno-10-40></a><span class=w> </span><span class=k>foreach</span><span class=w> </span><span class=p>(</span><span class=kt>var</span><span class=w> </span><span class=n>e</span><span class=w> </span><span class=k>in</span><span class=w> </span><span class=n>entries</span><span class=p>)</span>
</span><span id=__span-10-41><a id=__codelineno-10-41 name=__codelineno-10-41></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-10-42><a id=__codelineno-10-42 name=__codelineno-10-42></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>e</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=k>null</span><span class=w> </span><span class=o>||</span><span class=w> </span><span class=kt>string</span><span class=p>.</span><span class=n>IsNullOrEmpty</span><span class=p>(</span><span class=n>e</span><span class=p>.</span><span class=n>guid</span><span class=p>))</span><span class=w> </span><span class=k>continue</span><span class=p>;</span>
</span><span id=__span-10-43><a id=__codelineno-10-43 name=__codelineno-10-43></a><span class=w> </span><span class=n>_byGuid</span><span class=p>[</span><span class=n>e</span><span class=p>.</span><span class=n>guid</span><span class=p>]</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>e</span><span class=p>;</span>
</span><span id=__span-10-44><a id=__codelineno-10-44 name=__codelineno-10-44></a><span class=w> </span><span class=p>(</span><span class=n>_byCategory</span><span class=p>.</span><span class=n>TryGetValue</span><span class=p>(</span><span class=n>e</span><span class=p>.</span><span class=n>category</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>listCat</span><span class=p>)</span><span class=w> </span><span class=o>?</span><span class=w> </span><span class=n>listCat</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=p>(</span><span class=n>_byCategory</span><span class=p>[</span><span class=n>e</span><span class=p>.</span><span class=n>category</span><span class=p>]</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>())).</span><span class=n>Add</span><span class=p>(</span><span class=n>e</span><span class=p>);</span>
</span><span id=__span-10-45><a id=__codelineno-10-45 name=__codelineno-10-45></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>e</span><span class=p>.</span><span class=n>tags</span><span class=w> </span><span class=o>!=</span><span class=w> </span><span class=k>null</span><span class=p>)</span>
</span><span id=__span-10-46><a id=__codelineno-10-46 name=__codelineno-10-46></a><span class=w> </span><span class=k>foreach</span><span class=w> </span><span class=p>(</span><span class=kt>var</span><span class=w> </span><span class=n>t</span><span class=w> </span><span class=k>in</span><span class=w> </span><span class=n>e</span><span class=p>.</span><span class=n>tags</span><span class=p>)</span>
</span><span id=__span-10-47><a id=__codelineno-10-47 name=__codelineno-10-47></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=o>!</span><span class=kt>string</span><span class=p>.</span><span class=n>IsNullOrEmpty</span><span class=p>(</span><span class=n>t</span><span class=p>))</span>
</span><span id=__span-10-48><a id=__codelineno-10-48 name=__codelineno-10-48></a><span class=w> </span><span class=p>(</span><span class=n>_byTag</span><span class=p>.</span><span class=n>TryGetValue</span><span class=p>(</span><span class=n>t</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>listTag</span><span class=p>)</span><span class=w> </span><span class=o>?</span><span class=w> </span><span class=n>listTag</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=p>(</span><span class=n>_byTag</span><span class=p>[</span><span class=n>t</span><span class=p>]</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=p>())).</span><span class=n>Add</span><span class=p>(</span><span class=n>e</span><span class=p>);</span>
</span><span id=__span-10-49><a id=__codelineno-10-49 name=__codelineno-10-49></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-50><a id=__codelineno-10-50 name=__codelineno-10-50></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-51><a id=__codelineno-10-51 name=__codelineno-10-51></a>
</span><span id=__span-10-52><a id=__codelineno-10-52 name=__codelineno-10-52></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>static</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=nf>TryGetByGuid</span><span class=p>(</span><span class=kt>string</span><span class=w> </span><span class=n>guid</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=n>ContentDef</span><span class=w> </span><span class=n>def</span><span class=p>)</span><span class=w> </span><span class=o>=></span><span class=w> </span><span class=n>Instance</span><span class=p>.</span><span class=n>_byGuid</span><span class=p>.</span><span class=n>TryGetValue</span><span class=p>(</span><span class=n>guid</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=n>def</span><span class=p>);</span>
</span><span id=__span-10-53><a id=__codelineno-10-53 name=__codelineno-10-53></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>static</span><span class=w> </span><span class=n>IReadOnlyList</span><span class=o><</span><span class=n>ContentDef</span><span class=o>></span><span class=w> </span><span class=n>GetByCategory</span><span class=p>(</span><span class=n>ContentCategory</span><span class=w> </span><span class=n>cat</span><span class=p>)</span><span class=w> </span><span class=o>=></span>
</span><span id=__span-10-54><a id=__codelineno-10-54 name=__codelineno-10-54></a><span class=w> </span><span class=n>Instance</span><span class=p>.</span><span class=n>_byCategory</span><span class=p>.</span><span class=n>TryGetValue</span><span class=p>(</span><span class=n>cat</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>list</span><span class=p>)</span><span class=w> </span><span class=o>?</span><span class=w> </span><span class=n>list</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=p>(</span><span class=n>IReadOnlyList</span><span class=o><</span><span class=n>ContentDef</span><span class=o>></span><span class=p>)</span><span class=n>System</span><span class=p>.</span><span class=n>Array</span><span class=p>.</span><span class=n>Empty</span><span class=o><</span><span class=n>ContentDef</span><span class=o>></span><span class=p>();</span>
</span><span id=__span-10-55><a id=__codelineno-10-55 name=__codelineno-10-55></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>static</span><span class=w> </span><span class=n>IReadOnlyList</span><span class=o><</span><span class=n>ContentDef</span><span class=o>></span><span class=w> </span><span class=n>GetByTag</span><span class=p>(</span><span class=kt>string</span><span class=w> </span><span class=n>tag</span><span class=p>)</span><span class=w> </span><span class=o>=></span>
</span><span id=__span-10-56><a id=__codelineno-10-56 name=__codelineno-10-56></a><span class=w> </span><span class=n>Instance</span><span class=p>.</span><span class=n>_byTag</span><span class=p>.</span><span class=n>TryGetValue</span><span class=p>(</span><span class=n>tag</span><span class=p>,</span><span class=w> </span><span class=k>out</span><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>list</span><span class=p>)</span><span class=w> </span><span class=o>?</span><span class=w> </span><span class=n>list</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=p>(</span><span class=n>IReadOnlyList</span><span class=o><</span><span class=n>ContentDef</span><span class=o>></span><span class=p>)</span><span class=n>System</span><span class=p>.</span><span class=n>Array</span><span class=p>.</span><span class=n>Empty</span><span class=o><</span><span class=n>ContentDef</span><span class=o>></span><span class=p>();</span>
</span><span id=__span-10-57><a id=__codelineno-10-57 name=__codelineno-10-57></a>
</span><span id=__span-10-58><a id=__codelineno-10-58 name=__codelineno-10-58></a><span class=cp>#if UNITY_EDITOR</span>
</span><span id=__span-10-59><a id=__codelineno-10-59 name=__codelineno-10-59></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>ValidateEditor</span><span class=p>()</span>
</span><span id=__span-10-60><a id=__codelineno-10-60 name=__codelineno-10-60></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-10-61><a id=__codelineno-10-61 name=__codelineno-10-61></a><span class=w> </span><span class=c1>// Validate GUID uniqueness</span>
</span><span id=__span-10-62><a id=__codelineno-10-62 name=__codelineno-10-62></a><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>seen</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>HashSet</span><span class=o><</span><span class=kt>string</span><span class=o>></span><span class=p>();</span>
</span><span id=__span-10-63><a id=__codelineno-10-63 name=__codelineno-10-63></a><span class=w> </span><span class=k>foreach</span><span class=w> </span><span class=p>(</span><span class=kt>var</span><span class=w> </span><span class=n>e</span><span class=w> </span><span class=k>in</span><span class=w> </span><span class=n>entries</span><span class=p>)</span>
</span><span id=__span-10-64><a id=__codelineno-10-64 name=__codelineno-10-64></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-10-65><a id=__codelineno-10-65 name=__codelineno-10-65></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>e</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=k>null</span><span class=p>)</span><span class=w> </span><span class=k>continue</span><span class=p>;</span>
</span><span id=__span-10-66><a id=__codelineno-10-66 name=__codelineno-10-66></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=kt>string</span><span class=p>.</span><span class=n>IsNullOrEmpty</span><span class=p>(</span><span class=n>e</span><span class=p>.</span><span class=n>guid</span><span class=p>))</span>
</span><span id=__span-10-67><a id=__codelineno-10-67 name=__codelineno-10-67></a><span class=w> </span><span class=n>Debug</span><span class=p>.</span><span class=n>LogWarning</span><span class=p>(</span><span class=s>$"[ContentDb] Entry '{e?.displayName}' has empty GUID"</span><span class=p>,</span><span class=w> </span><span class=k>this</span><span class=p>);</span>
</span><span id=__span-10-68><a id=__codelineno-10-68 name=__codelineno-10-68></a><span class=w> </span><span class=k>else</span><span class=w> </span><span class=nf>if</span><span class=w> </span><span class=p>(</span><span class=o>!</span><span class=n>seen</span><span class=p>.</span><span class=n>Add</span><span class=p>(</span><span class=n>e</span><span class=p>.</span><span class=n>guid</span><span class=p>))</span>
</span><span id=__span-10-69><a id=__codelineno-10-69 name=__codelineno-10-69></a><span class=w> </span><span class=n>Debug</span><span class=p>.</span><span class=n>LogError</span><span class=p>(</span><span class=s>$"[ContentDb] Duplicate GUID '{e.guid}' detected"</span><span class=p>,</span><span class=w> </span><span class=k>this</span><span class=p>);</span>
</span><span id=__span-10-70><a id=__codelineno-10-70 name=__codelineno-10-70></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-71><a id=__codelineno-10-71 name=__codelineno-10-71></a>
</span><span id=__span-10-72><a id=__codelineno-10-72 name=__codelineno-10-72></a><span class=w> </span><span class=c1>// Validate Addressables (if package installed and editor context)</span>
</span><span id=__span-10-73><a id=__codelineno-10-73 name=__codelineno-10-73></a><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>settings</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>AddressableAssetSettingsDefaultObject</span><span class=p>.</span><span class=n>Settings</span><span class=p>;</span>
</span><span id=__span-10-74><a id=__codelineno-10-74 name=__codelineno-10-74></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>settings</span><span class=w> </span><span class=o>!=</span><span class=w> </span><span class=k>null</span><span class=p>)</span>
</span><span id=__span-10-75><a id=__codelineno-10-75 name=__codelineno-10-75></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-10-76><a id=__codelineno-10-76 name=__codelineno-10-76></a><span class=w> </span><span class=k>foreach</span><span class=w> </span><span class=p>(</span><span class=kt>var</span><span class=w> </span><span class=n>e</span><span class=w> </span><span class=k>in</span><span class=w> </span><span class=n>entries</span><span class=p>)</span>
</span><span id=__span-10-77><a id=__codelineno-10-77 name=__codelineno-10-77></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-10-78><a id=__codelineno-10-78 name=__codelineno-10-78></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>e</span><span class=o>?.</span><span class=n>prefab</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=k>null</span><span class=p>)</span><span class=w> </span><span class=k>continue</span><span class=p>;</span>
</span><span id=__span-10-79><a id=__codelineno-10-79 name=__codelineno-10-79></a><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>guid</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>e</span><span class=p>.</span><span class=n>prefab</span><span class=p>.</span><span class=n>AssetGUID</span><span class=p>;</span>
</span><span id=__span-10-80><a id=__codelineno-10-80 name=__codelineno-10-80></a><span class=w> </span><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=kt>string</span><span class=p>.</span><span class=n>IsNullOrEmpty</span><span class=p>(</span><span class=n>guid</span><span class=p>)</span><span class=w> </span><span class=o>||</span><span class=w> </span><span class=n>settings</span><span class=p>.</span><span class=n>FindAssetEntry</span><span class=p>(</span><span class=n>guid</span><span class=p>)</span><span class=w> </span><span class=o>==</span><span class=w> </span><span class=k>null</span><span class=p>)</span>
</span><span id=__span-10-81><a id=__codelineno-10-81 name=__codelineno-10-81></a><span class=w> </span><span class=n>Debug</span><span class=p>.</span><span class=n>LogWarning</span><span class=p>(</span><span class=s>$"[ContentDb] Prefab for '{e.displayName}' is not marked Addressable"</span><span class=p>,</span><span class=w> </span><span class=k>this</span><span class=p>);</span>
</span><span id=__span-10-82><a id=__codelineno-10-82 name=__codelineno-10-82></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-83><a id=__codelineno-10-83 name=__codelineno-10-83></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-84><a id=__codelineno-10-84 name=__codelineno-10-84></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-10-85><a id=__codelineno-10-85 name=__codelineno-10-85></a><span class=cp>#endif</span>
</span><span id=__span-10-86><a id=__codelineno-10-86 name=__codelineno-10-86></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p>Why this works well</p> <ul> <li>One authoritative asset; code reads through stable APIs.</li> <li>Deterministic load path via Resources; Addressables used only for content references.</li> <li>Indices rebuilt automatically to keep lookups fast and in sync while editing.</li> </ul> <h3 id=when-not-to-use-scriptableobject-singletons-as-dbs>When Not To Use ScriptableObject Singletons as DBs<a class=headerlink href=#when-not-to-use-scriptableobject-singletons-as-dbs title="Permanent link">¶</a></h3> <p>Use alternatives when one or more of these apply:</p> <ul> <li>Very large datasets (tens of thousands of records or >10–20 MB serialized)</li> <li>Prefer Addressables catalogs, binary blobs, streaming assets, or an external store; load by page or on demand.</li> <li>Frequent live updates/patches without app updates</li> <li>External data sources (remote JSON/Protobuf), Addressables content updates, or platform DBs are better suited.</li> <li>Strong need for async/background loading or partial paging</li> <li>Addressables + async APIs give finer loading control versus a monolithic Resources asset.</li> <li>Cross‑team/content pipelines that generate data at build time</li> <li>Import raw data into Addressables or assets at build; consider codegen for IDs and indices.</li> <li>Complex versioning/migrations of data formats</li> <li>Store version tags and migrate on load, or keep data outside Resources where migrations are simpler to stage.</li> <li>Sensitive/untrusted inputs</li> <li>Don’t deserialize untrusted data into SOs; use validated formats and sandboxed loaders.</li> <li>Save data</li> <li>Keep save/progression separate from the content DB; reference content by GUID/ID in saves.</li> </ul> <h3 id=choosing-a-data-distribution-strategy>Choosing a Data Distribution Strategy<a class=headerlink href=#choosing-a-data-distribution-strategy title="Permanent link">¶</a></h3> <p>Use this chart to pick an approach based on constraints:</p> <p><img alt="Data Distribution Strategy" src=../../../images/utilities/singletons/data-distribution-decision.svg></p> <p><a id=testing-patterns></a></p> <h2 id=testing-patterns>Testing Patterns<a class=headerlink href=#testing-patterns title="Permanent link">¶</a></h2> <h3 id=testing-with-runtimesingletont>Testing with <code>RuntimeSingleton<T></code><a class=headerlink href=#testing-with-runtimesingletont title="Permanent link">¶</a></h3> <p>Runtime singletons require special handling in tests to avoid leaked GameObjects and unpredictable state across test runs. The recommended pattern uses <code>CommonTestBase</code> which handles cleanup automatically.</p> <h4 id=pattern-1-extend-commontestbase>Pattern 1: Extend CommonTestBase<a class=headerlink href=#pattern-1-extend-commontestbase title="Permanent link">¶</a></h4> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-11-1> 1</a></span>
<span class=normal><a href=#__codelineno-11-2> 2</a></span>
<span class=normal><a href=#__codelineno-11-3> 3</a></span>
<span class=normal><a href=#__codelineno-11-4> 4</a></span>
<span class=normal><a href=#__codelineno-11-5> 5</a></span>
<span class=normal><a href=#__codelineno-11-6> 6</a></span>
<span class=normal><a href=#__codelineno-11-7> 7</a></span>
<span class=normal><a href=#__codelineno-11-8> 8</a></span>
<span class=normal><a href=#__codelineno-11-9> 9</a></span>
<span class=normal><a href=#__codelineno-11-10>10</a></span>
<span class=normal><a href=#__codelineno-11-11>11</a></span>
<span class=normal><a href=#__codelineno-11-12>12</a></span>
<span class=normal><a href=#__codelineno-11-13>13</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-11-1><a id=__codelineno-11-1 name=__codelineno-11-1></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Tests.Core</span><span class=p>;</span>
</span><span id=__span-11-2><a id=__codelineno-11-2 name=__codelineno-11-2></a>
</span><span id=__span-11-3><a id=__codelineno-11-3 name=__codelineno-11-3></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>MyServiceTests</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>CommonTestBase</span>
</span><span id=__span-11-4><a id=__codelineno-11-4 name=__codelineno-11-4></a><span class=p>{</span>
</span><span id=__span-11-5><a id=__codelineno-11-5 name=__codelineno-11-5></a><span class=w> </span><span class=na>[Test]</span>
</span><span id=__span-11-6><a id=__codelineno-11-6 name=__codelineno-11-6></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>MyServiceInitializesCorrectly</span><span class=p>()</span>
</span><span id=__span-11-7><a id=__codelineno-11-7 name=__codelineno-11-7></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-11-8><a id=__codelineno-11-8 name=__codelineno-11-8></a><span class=w> </span><span class=c1>// CommonTestBase automatically manages dispatcher lifecycle</span>
</span><span id=__span-11-9><a id=__codelineno-11-9 name=__codelineno-11-9></a><span class=w> </span><span class=c1>// and cleans up any spawned GameObjects after each test</span>
</span><span id=__span-11-10><a id=__codelineno-11-10 name=__codelineno-11-10></a><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>service</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>MyService</span><span class=p>.</span><span class=n>Instance</span><span class=p>;</span>
</span><span id=__span-11-11><a id=__codelineno-11-11 name=__codelineno-11-11></a><span class=w> </span><span class=n>Assert</span><span class=p>.</span><span class=n>That</span><span class=p>(</span><span class=n>service</span><span class=w> </span><span class=o>!=</span><span class=w> </span><span class=k>null</span><span class=p>);</span>
</span><span id=__span-11-12><a id=__codelineno-11-12 name=__codelineno-11-12></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-11-13><a id=__codelineno-11-13 name=__codelineno-11-13></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <h4 id=pattern-2-manual-scope-management>Pattern 2: Manual Scope Management<a class=headerlink href=#pattern-2-manual-scope-management title="Permanent link">¶</a></h4> <p>For tests that need finer control over singleton lifecycle:</p> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-12-1> 1</a></span>
<span class=normal><a href=#__codelineno-12-2> 2</a></span>
<span class=normal><a href=#__codelineno-12-3> 3</a></span>
<span class=normal><a href=#__codelineno-12-4> 4</a></span>
<span class=normal><a href=#__codelineno-12-5> 5</a></span>
<span class=normal><a href=#__codelineno-12-6> 6</a></span>
<span class=normal><a href=#__codelineno-12-7> 7</a></span>
<span class=normal><a href=#__codelineno-12-8> 8</a></span>
<span class=normal><a href=#__codelineno-12-9> 9</a></span>
<span class=normal><a href=#__codelineno-12-10>10</a></span>
<span class=normal><a href=#__codelineno-12-11>11</a></span>
<span class=normal><a href=#__codelineno-12-12>12</a></span>
<span class=normal><a href=#__codelineno-12-13>13</a></span>
<span class=normal><a href=#__codelineno-12-14>14</a></span>
<span class=normal><a href=#__codelineno-12-15>15</a></span>
<span class=normal><a href=#__codelineno-12-16>16</a></span>
<span class=normal><a href=#__codelineno-12-17>17</a></span>
<span class=normal><a href=#__codelineno-12-18>18</a></span>
<span class=normal><a href=#__codelineno-12-19>19</a></span>
<span class=normal><a href=#__codelineno-12-20>20</a></span>
<span class=normal><a href=#__codelineno-12-21>21</a></span>
<span class=normal><a href=#__codelineno-12-22>22</a></span>
<span class=normal><a href=#__codelineno-12-23>23</a></span>
<span class=normal><a href=#__codelineno-12-24>24</a></span>
<span class=normal><a href=#__codelineno-12-25>25</a></span>
<span class=normal><a href=#__codelineno-12-26>26</a></span>
<span class=normal><a href=#__codelineno-12-27>27</a></span>
<span class=normal><a href=#__codelineno-12-28>28</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-12-1><a id=__codelineno-12-1 name=__codelineno-12-1></a><span class=k>using</span><span class=w> </span><span class=nn>UnityMainThreadDispatcher</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>WallstopStudios</span><span class=p>.</span><span class=n>UnityHelpers</span><span class=p>.</span><span class=n>Core</span><span class=p>.</span><span class=n>Helper</span><span class=p>.</span><span class=n>UnityMainThreadDispatcher</span><span class=p>;</span>
</span><span id=__span-12-2><a id=__codelineno-12-2 name=__codelineno-12-2></a>
</span><span id=__span-12-3><a id=__codelineno-12-3 name=__codelineno-12-3></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>CustomSingletonTests</span>
</span><span id=__span-12-4><a id=__codelineno-12-4 name=__codelineno-12-4></a><span class=p>{</span>
</span><span id=__span-12-5><a id=__codelineno-12-5 name=__codelineno-12-5></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=n>UnityMainThreadDispatcher</span><span class=p>.</span><span class=n>AutoCreationScope</span><span class=w> </span><span class=n>_scope</span><span class=p>;</span>
</span><span id=__span-12-6><a id=__codelineno-12-6 name=__codelineno-12-6></a>
</span><span id=__span-12-7><a id=__codelineno-12-7 name=__codelineno-12-7></a><span class=w> </span><span class=na>[SetUp]</span>
</span><span id=__span-12-8><a id=__codelineno-12-8 name=__codelineno-12-8></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>SetUp</span><span class=p>()</span>
</span><span id=__span-12-9><a id=__codelineno-12-9 name=__codelineno-12-9></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-12-10><a id=__codelineno-12-10 name=__codelineno-12-10></a><span class=w> </span><span class=c1>// Disable auto-creation, destroy any existing instance, then re-enable</span>
</span><span id=__span-12-11><a id=__codelineno-12-11 name=__codelineno-12-11></a><span class=w> </span><span class=n>_scope</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>UnityMainThreadDispatcher</span><span class=p>.</span><span class=n>CreateTestScope</span><span class=p>(</span><span class=n>destroyImmediate</span><span class=p>:</span><span class=w> </span><span class=k>true</span><span class=p>);</span>
</span><span id=__span-12-12><a id=__codelineno-12-12 name=__codelineno-12-12></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-12-13><a id=__codelineno-12-13 name=__codelineno-12-13></a>
</span><span id=__span-12-14><a id=__codelineno-12-14 name=__codelineno-12-14></a><span class=w> </span><span class=na>[TearDown]</span>
</span><span id=__span-12-15><a id=__codelineno-12-15 name=__codelineno-12-15></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>TearDown</span><span class=p>()</span>
</span><span id=__span-12-16><a id=__codelineno-12-16 name=__codelineno-12-16></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-12-17><a id=__codelineno-12-17 name=__codelineno-12-17></a><span class=w> </span><span class=c1>// Restores previous auto-creation state and destroys test-created instances</span>
</span><span id=__span-12-18><a id=__codelineno-12-18 name=__codelineno-12-18></a><span class=w> </span><span class=n>_scope</span><span class=o>?.</span><span class=n>Dispose</span><span class=p>();</span>
</span><span id=__span-12-19><a id=__codelineno-12-19 name=__codelineno-12-19></a><span class=w> </span><span class=n>_scope</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>null</span><span class=p>;</span>
</span><span id=__span-12-20><a id=__codelineno-12-20 name=__codelineno-12-20></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-12-21><a id=__codelineno-12-21 name=__codelineno-12-21></a>
</span><span id=__span-12-22><a id=__codelineno-12-22 name=__codelineno-12-22></a><span class=w> </span><span class=na>[Test]</span>
</span><span id=__span-12-23><a id=__codelineno-12-23 name=__codelineno-12-23></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>DispatcherIsAvailableInTest</span><span class=p>()</span>
</span><span id=__span-12-24><a id=__codelineno-12-24 name=__codelineno-12-24></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-12-25><a id=__codelineno-12-25 name=__codelineno-12-25></a><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>dispatcher</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>UnityMainThreadDispatcher</span><span class=p>.</span><span class=n>Instance</span><span class=p>;</span>
</span><span id=__span-12-26><a id=__codelineno-12-26 name=__codelineno-12-26></a><span class=w> </span><span class=n>Assert</span><span class=p>.</span><span class=n>That</span><span class=p>(</span><span class=n>dispatcher</span><span class=w> </span><span class=o>!=</span><span class=w> </span><span class=k>null</span><span class=p>);</span>
</span><span id=__span-12-27><a id=__codelineno-12-27 name=__codelineno-12-27></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-12-28><a id=__codelineno-12-28 name=__codelineno-12-28></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <h4 id=pattern-3-temporarily-disable-auto-creation>Pattern 3: Temporarily Disable Auto-Creation<a class=headerlink href=#pattern-3-temporarily-disable-auto-creation title="Permanent link">¶</a></h4> <p>For specific tests that need to verify behavior when the singleton doesn't exist:</p> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-13-1> 1</a></span>
<span class=normal><a href=#__codelineno-13-2> 2</a></span>
<span class=normal><a href=#__codelineno-13-3> 3</a></span>
<span class=normal><a href=#__codelineno-13-4> 4</a></span>
<span class=normal><a href=#__codelineno-13-5> 5</a></span>
<span class=normal><a href=#__codelineno-13-6> 6</a></span>
<span class=normal><a href=#__codelineno-13-7> 7</a></span>
<span class=normal><a href=#__codelineno-13-8> 8</a></span>
<span class=normal><a href=#__codelineno-13-9> 9</a></span>
<span class=normal><a href=#__codelineno-13-10>10</a></span>
<span class=normal><a href=#__codelineno-13-11>11</a></span>
<span class=normal><a href=#__codelineno-13-12>12</a></span>
<span class=normal><a href=#__codelineno-13-13>13</a></span>
<span class=normal><a href=#__codelineno-13-14>14</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-13-1><a id=__codelineno-13-1 name=__codelineno-13-1></a><span class=na>[Test]</span>
</span><span id=__span-13-2><a id=__codelineno-13-2 name=__codelineno-13-2></a><span class=k>public</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>CodeHandlesMissingDispatcherGracefully</span><span class=p>()</span>
</span><span id=__span-13-3><a id=__codelineno-13-3 name=__codelineno-13-3></a><span class=p>{</span>
</span><span id=__span-13-4><a id=__codelineno-13-4 name=__codelineno-13-4></a><span class=w> </span><span class=k>using</span><span class=w> </span><span class=p>(</span><span class=n>UnityMainThreadDispatcher</span><span class=p>.</span><span class=n>AutoCreationScope</span><span class=p>.</span><span class=n>Disabled</span><span class=p>(</span>
</span><span id=__span-13-5><a id=__codelineno-13-5 name=__codelineno-13-5></a><span class=w> </span><span class=n>destroyExistingInstanceOnEnter</span><span class=p>:</span><span class=w> </span><span class=k>true</span><span class=p>,</span>
</span><span id=__span-13-6><a id=__codelineno-13-6 name=__codelineno-13-6></a><span class=w> </span><span class=n>destroyInstancesOnDispose</span><span class=p>:</span><span class=w> </span><span class=k>true</span><span class=p>,</span>
</span><span id=__span-13-7><a id=__codelineno-13-7 name=__codelineno-13-7></a><span class=w> </span><span class=n>destroyImmediate</span><span class=p>:</span><span class=w> </span><span class=k>true</span><span class=p>))</span>
</span><span id=__span-13-8><a id=__codelineno-13-8 name=__codelineno-13-8></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-13-9><a id=__codelineno-13-9 name=__codelineno-13-9></a><span class=w> </span><span class=c1>// Inside this scope, accessing Instance won't auto-create</span>
</span><span id=__span-13-10><a id=__codelineno-13-10 name=__codelineno-13-10></a><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>hasInstance</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>UnityMainThreadDispatcher</span><span class=p>.</span><span class=n>HasInstance</span><span class=p>;</span>
</span><span id=__span-13-11><a id=__codelineno-13-11 name=__codelineno-13-11></a><span class=w> </span><span class=n>Assert</span><span class=p>.</span><span class=n>That</span><span class=p>(</span><span class=n>hasInstance</span><span class=p>,</span><span class=w> </span><span class=n>Is</span><span class=p>.</span><span class=n>False</span><span class=p>);</span>
</span><span id=__span-13-12><a id=__codelineno-13-12 name=__codelineno-13-12></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-13-13><a id=__codelineno-13-13 name=__codelineno-13-13></a><span class=w> </span><span class=c1>// Auto-creation restored after scope exits</span>
</span><span id=__span-13-14><a id=__codelineno-13-14 name=__codelineno-13-14></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <h3 id=testing-with-scriptableobjectsingletont>Testing with <code>ScriptableObjectSingleton<T></code><a class=headerlink href=#testing-with-scriptableobjectsingletont title="Permanent link">¶</a></h3> <p>ScriptableObject singletons load from <code>Resources/</code> and are typically tested in Editor tests where asset manipulation is possible.</p> <h4 id=pattern-1-use-editor-test-fixtures>Pattern 1: Use Editor Test Fixtures<a class=headerlink href=#pattern-1-use-editor-test-fixtures title="Permanent link">¶</a></h4> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-14-1> 1</a></span>
<span class=normal><a href=#__codelineno-14-2> 2</a></span>
<span class=normal><a href=#__codelineno-14-3> 3</a></span>
<span class=normal><a href=#__codelineno-14-4> 4</a></span>
<span class=normal><a href=#__codelineno-14-5> 5</a></span>
<span class=normal><a href=#__codelineno-14-6> 6</a></span>
<span class=normal><a href=#__codelineno-14-7> 7</a></span>
<span class=normal><a href=#__codelineno-14-8> 8</a></span>
<span class=normal><a href=#__codelineno-14-9> 9</a></span>
<span class=normal><a href=#__codelineno-14-10>10</a></span>
<span class=normal><a href=#__codelineno-14-11>11</a></span>
<span class=normal><a href=#__codelineno-14-12>12</a></span>
<span class=normal><a href=#__codelineno-14-13>13</a></span>
<span class=normal><a href=#__codelineno-14-14>14</a></span>
<span class=normal><a href=#__codelineno-14-15>15</a></span>
<span class=normal><a href=#__codelineno-14-16>16</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-14-1><a id=__codelineno-14-1 name=__codelineno-14-1></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Tests.Core</span><span class=p>;</span>
</span><span id=__span-14-2><a id=__codelineno-14-2 name=__codelineno-14-2></a><span class=cp>#if UNITY_EDITOR</span>
</span><span id=__span-14-3><a id=__codelineno-14-3 name=__codelineno-14-3></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEditor</span><span class=p>;</span>
</span><span id=__span-14-4><a id=__codelineno-14-4 name=__codelineno-14-4></a><span class=cp>#endif</span>
</span><span id=__span-14-5><a id=__codelineno-14-5 name=__codelineno-14-5></a>
</span><span id=__span-14-6><a id=__codelineno-14-6 name=__codelineno-14-6></a><span class=k>public</span><span class=w> </span><span class=k>sealed</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>AudioSettingsTests</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>CommonTestBase</span>
</span><span id=__span-14-7><a id=__codelineno-14-7 name=__codelineno-14-7></a><span class=p>{</span>
</span><span id=__span-14-8><a id=__codelineno-14-8 name=__codelineno-14-8></a><span class=w> </span><span class=na>[Test]</span>
</span><span id=__span-14-9><a id=__codelineno-14-9 name=__codelineno-14-9></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>AudioSettingsLoadsFromResources</span><span class=p>()</span>
</span><span id=__span-14-10><a id=__codelineno-14-10 name=__codelineno-14-10></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-14-11><a id=__codelineno-14-11 name=__codelineno-14-11></a><span class=w> </span><span class=c1>// ScriptableObjectSingleton loads lazily from Resources</span>
</span><span id=__span-14-12><a id=__codelineno-14-12 name=__codelineno-14-12></a><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>settings</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>AudioSettings</span><span class=p>.</span><span class=n>Instance</span><span class=p>;</span>
</span><span id=__span-14-13><a id=__codelineno-14-13 name=__codelineno-14-13></a><span class=w> </span><span class=n>Assert</span><span class=p>.</span><span class=n>That</span><span class=p>(</span><span class=n>settings</span><span class=w> </span><span class=o>!=</span><span class=w> </span><span class=k>null</span><span class=p>);</span>
</span><span id=__span-14-14><a id=__codelineno-14-14 name=__codelineno-14-14></a><span class=w> </span><span class=n>Assert</span><span class=p>.</span><span class=n>That</span><span class=p>(</span><span class=n>settings</span><span class=p>.</span><span class=n>masterVolume</span><span class=p>,</span><span class=w> </span><span class=n>Is</span><span class=p>.</span><span class=n>InRange</span><span class=p>(</span><span class=mf>0f</span><span class=p>,</span><span class=w> </span><span class=mf>1f</span><span class=p>));</span>
</span><span id=__span-14-15><a id=__codelineno-14-15 name=__codelineno-14-15></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-14-16><a id=__codelineno-14-16 name=__codelineno-14-16></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <h4 id=pattern-2-create-test-specific-assets>Pattern 2: Create Test-Specific Assets<a class=headerlink href=#pattern-2-create-test-specific-assets title="Permanent link">¶</a></h4> <p>For tests that need controlled data:</p> <div class="language-csharp highlight"><table class=highlighttable><tr><th colspan=2 class=filename><span class=filename>C#</span></th></tr><tr><td class=linenos><div class=linenodiv><pre><span></span><span class=normal><a href=#__codelineno-15-1> 1</a></span>
<span class=normal><a href=#__codelineno-15-2> 2</a></span>
<span class=normal><a href=#__codelineno-15-3> 3</a></span>
<span class=normal><a href=#__codelineno-15-4> 4</a></span>
<span class=normal><a href=#__codelineno-15-5> 5</a></span>
<span class=normal><a href=#__codelineno-15-6> 6</a></span>
<span class=normal><a href=#__codelineno-15-7> 7</a></span>
<span class=normal><a href=#__codelineno-15-8> 8</a></span>
<span class=normal><a href=#__codelineno-15-9> 9</a></span>
<span class=normal><a href=#__codelineno-15-10>10</a></span>
<span class=normal><a href=#__codelineno-15-11>11</a></span>
<span class=normal><a href=#__codelineno-15-12>12</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-15-1><a id=__codelineno-15-1 name=__codelineno-15-1></a><span class=cp>#if UNITY_EDITOR</span>
</span><span id=__span-15-2><a id=__codelineno-15-2 name=__codelineno-15-2></a><span class=na>[Test]</span>
</span><span id=__span-15-3><a id=__codelineno-15-3 name=__codelineno-15-3></a><span class=k>public</span><span class=w> </span><span class=k>void</span><span class=w> </span><span class=nf>SettingsWithCustomValuesWork</span><span class=p>()</span>
</span><span id=__span-15-4><a id=__codelineno-15-4 name=__codelineno-15-4></a><span class=p>{</span>
</span><span id=__span-15-5><a id=__codelineno-15-5 name=__codelineno-15-5></a><span class=w> </span><span class=c1>// Create a test instance (tracked by CommonTestBase for cleanup)</span>
</span><span id=__span-15-6><a id=__codelineno-15-6 name=__codelineno-15-6></a><span class=w> </span><span class=kt>var</span><span class=w> </span><span class=n>testSettings</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>CreateScriptableObject</span><span class=o><</span><span class=n>AudioSettings</span><span class=o>></span><span class=p>();</span>
</span><span id=__span-15-7><a id=__codelineno-15-7 name=__codelineno-15-7></a><span class=w> </span><span class=n>testSettings</span><span class=p>.</span><span class=n>masterVolume</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0.5f</span><span class=p>;</span>
</span><span id=__span-15-8><a id=__codelineno-15-8 name=__codelineno-15-8></a>
</span><span id=__span-15-9><a id=__codelineno-15-9 name=__codelineno-15-9></a><span class=w> </span><span class=c1>// Test logic using the instance directly (not via Instance property)</span>
</span><span id=__span-15-10><a id=__codelineno-15-10 name=__codelineno-15-10></a><span class=w> </span><span class=n>Assert</span><span class=p>.</span><span class=n>That</span><span class=p>(</span><span class=n>testSettings</span><span class=p>.</span><span class=n>masterVolume</span><span class=p>,</span><span class=w> </span><span class=n>Is</span><span class=p>.</span><span class=n>EqualTo</span><span class=p>(</span><span class=mf>0.5f</span><span class=p>));</span>
</span><span id=__span-15-11><a id=__codelineno-15-11 name=__codelineno-15-11></a><span class=p>}</span>
</span><span id=__span-15-12><a id=__codelineno-15-12 name=__codelineno-15-12></a><span class=cp>#endif</span>
</span></code></pre></div></td></tr></table></div> <h3 id=key-testing-guidelines>Key Testing Guidelines<a class=headerlink href=#key-testing-guidelines title="Permanent link">¶</a></h3> <ol> <li> <p><strong>Inherit from <code>CommonTestBase</code></strong>: This handles most singleton cleanup automatically, including dispatcher scope management.</p> </li> <li> <p><strong>Use <code>CreateTestScope</code> for dispatcher</strong>: The <code>UnityMainThreadDispatcher.CreateTestScope()</code> method packages the common test setup pattern: disable auto-creation → destroy existing → re-enable auto-creation.</p> </li> <li> <p><strong>Prefer <code>destroyImmediate: true</code> in EditMode</strong>: EditMode tests should use <code>DestroyImmediate</code> to ensure synchronous cleanup without Unity's delayed destruction.</p> </li> <li> <p><strong>Track created objects</strong>: Use <code>Track<T>()</code> or <code>TrackDisposable<T>()</code> to ensure objects are cleaned up after tests.</p> </li> <li> <p><strong>Clear singleton state between tests</strong>: Domain reloads clear singleton instances, but within a test run you may need explicit cleanup.</p> </li> </ol> <p><a id=troubleshooting></a></p> <h2 id=troubleshooting>Troubleshooting<a class=headerlink href=#troubleshooting title="Permanent link">¶</a></h2> <h2 id=best-practices>Best Practices<a class=headerlink href=#best-practices title="Permanent link">¶</a></h2> <ul> <li>Prefer placing a pre-made runtime singleton in a bootstrap scene when construction order matters; avoid first-access implicit creation during critical frames.</li> <li>For scene-local managers, override <code>Preserve => false</code> to prevent cross-scene persistence.</li> <li>Keep exactly one singleton asset under <code>Resources/</code> for each <code>ScriptableObjectSingleton<T></code>; let the auto-creator relocate any strays.</li> <li>Use <code>[ScriptableSingletonPath]</code> to group related settings; avoid deep nesting that hurts discoverability.</li> <li> <p>With Odin installed, take advantage of <code>Serialized*</code> bases for complex serialized fields; without Odin, keep fields Unity-serializable.</p> </li> <li> <p>Multiple ScriptableObject assets found: a warning is logged and the first by name is used. Resolve by keeping only one asset in Resources or by letting the auto‑creator relocate the correct one.</p> </li> <li><code>Instance</code> returns null for ScriptableObject: Ensure the asset exists under <code>Resources/</code> and the type name or custom path matches.</li> <li>Domain reloads: Both singletons clear cached instances before scene load.</li> <li>Leaked GameObjects in tests: Use <code>CommonTestBase</code> or wrap test code with <code>AutoCreationScope.Disabled()</code> to ensure cleanup.</li> </ul> <h2 id=related-docs>Related Docs<a class=headerlink href=#related-docs title="Permanent link">¶</a></h2> <ul> <li>Editor tool: <a href=../../editor-tools/editor-tools-guide/#scriptableobject-singleton-creator>ScriptableObject Singleton Creator</a>.</li> <li>Tests: <code>Tests/Runtime/Utils/RuntimeSingletonTests.cs</code> and <code>Tests/Editor/Utils/ScriptableObjectSingletonTests.cs</code>.</li> <li>Dispatcher testing: <a href=../../logging/unity-main-thread-dispatcher/#test-bootstrap-workflow>Unity Main Thread Dispatcher Guide</a>.</li> </ul> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 26, 2026 05:34:01 UTC"><span class=timeago datetime=2026-01-26T05:34:01+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 26, 2026 05:34:01 UTC">2026-01-26</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="October 11, 2025 22:50:56 UTC"><span class=timeago datetime=2025-10-11T22:50:56+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="October 11, 2025 22:50:56 UTC">2025-10-11</span> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type=button class="md-top md-icon" data-md-component=top hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../random-generators/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Random Generators"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Random Generators </div> </div> </a> <a href=../reflection-helpers/ class="md-footer__link md-footer__link--next" aria-label="Next: Reflection Helpers"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Reflection Helpers </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright © 2024-2026 Wallstop Studios - MIT License </div> </div> <div class=md-social> <a href=https://github.com/wallstop/unity-helpers target=_blank rel=noopener title="Unity Helpers on GitHub" class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <div class=md-progress data-md-component=progress role=progressbar></div> <script id=__config type=application/json>{"annotate": null, "base": "../../..", "features": ["navigation.instant", "navigation.instant.prefetch", "navigation.instant.progress", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "navigation.path", "navigation.indexes", "navigation.top", "navigation.footer", "toc.follow", "toc.integrate", "search.suggest", "search.highlight", "search.share", "header.autohide", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.tooltips", "content.action.edit", "content.action.view"], "search": "../../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script> <script src=../../../assets/javascripts/bundle.79ae519e.min.js></script> <script src=../../../js/timeago.min.js></script> <script src=../../../js/timeago_mkdocs_material.js></script> <script src=https://unpkg.com/mermaid@10/dist/mermaid.min.js></script> </body> </html>