com.wallstop-studios.unity-helpers
Version:
Treasure chest of Unity developer tools
1,227 lines • 308 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/editor-tools/editor-tools-guide/ rel=canonical><link href=../../logging/unity-main-thread-dispatcher/ rel=prev><link href=../unity-method-analyzer/ rel=next><link rel=icon href=../../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.3"><title>Tools Guide - 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=#wallstop-studios-unity-helpers-editor-tools-guide 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> Tools Guide </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--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3_6> <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=false> <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=../../utilities/math-and-extensions/ class=md-nav__link> <span class=md-ellipsis> Math & Extensions </span> </a> </li> <li class=md-nav__item> <a href=../../utilities/data-structures/ class=md-nav__link> <span class=md-ellipsis> Data Structures </span> </a> </li> <li class=md-nav__item> <a href=../../utilities/random-generators/ class=md-nav__link> <span class=md-ellipsis> Random Generators </span> </a> </li> <li class=md-nav__item> <a href=../../utilities/singletons/ class=md-nav__link> <span class=md-ellipsis> Singletons </span> </a> </li> <li class=md-nav__item> <a href=../../utilities/reflection-helpers/ class=md-nav__link> <span class=md-ellipsis> Reflection Helpers </span> </a> </li> <li class=md-nav__item> <a href=../../utilities/helper-utilities/ class=md-nav__link> <span class=md-ellipsis> Helper Utilities </span> </a> </li> <li class=md-nav__item> <a href=../../utilities/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--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_3_8 checked> <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=true> <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 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> Tools Guide </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Tools Guide </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-you-get class=md-nav__link> <span class=md-ellipsis> TL;DR — What You Get </span> </a> </li> <li class=md-nav__item> <a href=#what-do-you-want-to-do-task-based-index class=md-nav__link> <span class=md-ellipsis> What Do You Want To Do? (Task-Based Index) </span> </a> <nav class=md-nav aria-label="What Do You Want To Do? (Task-Based Index)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#optimize-sprite-memory-performance class=md-nav__link> <span class=md-ellipsis> Optimize Sprite Memory & Performance </span> </a> </li> <li class=md-nav__item> <a href=#create-edit-animations class=md-nav__link> <span class=md-ellipsis> Create & Edit Animations </span> </a> </li> <li class=md-nav__item> <a href=#build-sprite-atlases class=md-nav__link> <span class=md-ellipsis> Build Sprite Atlases </span> </a> </li> <li class=md-nav__item> <a href=#validate-fix-prefabs class=md-nav__link> <span class=md-ellipsis> Validate & Fix Prefabs </span> </a> </li> <li class=md-nav__item> <a href=#analyze-code-quality class=md-nav__link> <span class=md-ellipsis> Analyze Code Quality </span> </a> </li> <li class=md-nav__item> <a href=#apply-visual-effects class=md-nav__link> <span class=md-ellipsis> Apply Visual Effects </span> </a> </li> <li class=md-nav__item> <a href=#automate-setup-maintenance class=md-nav__link> <span class=md-ellipsis> Automate Setup & Maintenance </span> </a> </li> <li class=md-nav__item> <a href=#enhance-inspector-workflows class=md-nav__link> <span class=md-ellipsis> Enhance Inspector Workflows </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#table-of-contents class=md-nav__link> <span class=md-ellipsis> Table of Contents </span> </a> </li> <li class=md-nav__item> <a href=#texture-sprite-tools class=md-nav__link> <span class=md-ellipsis> Texture & Sprite Tools </span> </a> <nav class=md-nav aria-label="Texture & Sprite Tools"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#image-blur-tool class=md-nav__link> <span class=md-ellipsis> Image Blur Tool </span> </a> </li> <li class=md-nav__item> <a href=#sprite-cropper class=md-nav__link> <span class=md-ellipsis> Sprite Cropper </span> </a> </li> <li class=md-nav__item> <a href=#texture-settings-applier class=md-nav__link> <span class=md-ellipsis> Texture Settings Applier </span> </a> </li> <li class=md-nav__item> <a href=#sprite-pivot-adjuster class=md-nav__link> <span class=md-ellipsis> Sprite Pivot Adjuster </span> </a> </li> <li class=md-nav__item> <a href=#sprite-settings-applier class=md-nav__link> <span class=md-ellipsis> Sprite Settings Applier </span> </a> </li> <li class=md-nav__item> <a href=#texture-resizer class=md-nav__link> <span class=md-ellipsis> Texture Resizer </span> </a> </li> <li class=md-nav__item> <a href=#fit-texture-size class=md-nav__link> <span class=md-ellipsis> Fit Texture Size </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#animation-tools class=md-nav__link> <span class=md-ellipsis> Animation Tools </span> </a> <nav class=md-nav aria-label="Animation Tools"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#sprite-animation-editor-animation-viewer-window class=md-nav__link> <span class=md-ellipsis> Sprite Animation Editor (Animation Viewer Window) </span> </a> </li> <li class=md-nav__item> <a href=#animation-creator class=md-nav__link> <span class=md-ellipsis> Animation Creator </span> </a> </li> <li class=md-nav__item> <a href=#animation-copier class=md-nav__link> <span class=md-ellipsis> Animation Copier </span> </a> </li> <li class=md-nav__item> <a href=#sprite-sheet-animation-creator class=md-nav__link> <span class=md-ellipsis> Sprite Sheet Animation Creator </span> </a> </li> <li class=md-nav__item> <a href=#sprite-sheet-extractor class=md-nav__link> <span class=md-ellipsis> Sprite Sheet Extractor </span> </a> </li> <li class=md-nav__item> <a href=#animation-event-editor class=md-nav__link> <span class=md-ellipsis> Animation Event Editor </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#sprite-atlas-tools class=md-nav__link> <span class=md-ellipsis> Sprite Atlas Tools </span> </a> <nav class=md-nav aria-label="Sprite Atlas Tools"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#sprite-atlas-generator class=md-nav__link> <span class=md-ellipsis> Sprite Atlas Generator </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#validation-quality-tools class=md-nav__link> <span class=md-ellipsis> Validation & Quality Tools </span> </a> <nav class=md-nav aria-label="Validation & Quality Tools"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#prefab-checker class=md-nav__link> <span class=md-ellipsis> Prefab Checker </span> </a> </li> <li class=md-nav__item> <a href=#unity-method-analyzer class=md-nav__link> <span class=md-ellipsis> Unity Method Analyzer </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#custom-component-editors class=md-nav__link> <span class=md-ellipsis> Custom Component Editors </span> </a> <nav class=md-nav aria-label="Custom Component Editors"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#matchcollidertosprite-editor class=md-nav__link> <span class=md-ellipsis> MatchColliderToSprite Editor </span> </a> </li> <li class=md-nav__item> <a href=#polygoncollider2doptimizer-editor class=md-nav__link> <span class=md-ellipsis> PolygonCollider2DOptimizer Editor </span> </a> </li> <li class=md-nav__item> <a href=#enhancedimage-editor class=md-nav__link> <span class=md-ellipsis> EnhancedImage Editor </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#property-drawers-attributes class=md-nav__link> <span class=md-ellipsis> Property Drawers & Attributes </span> </a> <nav class=md-nav aria-label="Property Drawers & Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#winlineeditor-property-drawer class=md-nav__link> <span class=md-ellipsis> WInLineEditor Property Drawer </span> </a> </li> <li class=md-nav__item> <a href=#wshowif-property-drawer class=md-nav__link> <span class=md-ellipsis> WShowIf Property Drawer </span> </a> </li> <li class=md-nav__item> <a href=#stringinlist-property-drawer class=md-nav__link> <span class=md-ellipsis> StringInList Property Drawer </span> </a> </li> <li class=md-nav__item> <a href=#intdropdown-property-drawer class=md-nav__link> <span class=md-ellipsis> IntDropdown Property Drawer </span> </a> </li> <li class=md-nav__item> <a href=#wvaluedropdown-property-drawer class=md-nav__link> <span class=md-ellipsis> WValueDropDown Property Drawer </span> </a> </li> <li class=md-nav__item> <a href=#wreadonly-property-drawer class=md-nav__link> <span class=md-ellipsis> WReadOnly Property Drawer </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#automation-utilities class=md-nav__link> <span class=md-ellipsis> Automation & Utilities </span> </a> <nav class=md-nav aria-label="Automation & Utilities"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#scriptableobject-singleton-creator class=md-nav__link> <span class=md-ellipsis> ScriptableObject Singleton Creator </span> </a> </li> <li class=md-nav__item> <a href=#sprite-label-processor class=md-nav__link> <span class=md-ellipsis> Sprite Label Processor </span> </a> </li> <li class=md-nav__item> <a href=#request-script-compilation class=md-nav__link> <span class=md-ellipsis> Request Script Compilation </span> </a> </li> <li class=md-nav__item> <a href=#project-settings-unity-helpers class=md-nav__link> <span class=md-ellipsis> Project Settings: Unity Helpers </span> </a> </li> <li class=md-nav__item> <a href=#attribute-metadata-cache-generator class=md-nav__link> <span class=md-ellipsis> Attribute Metadata Cache Generator </span> </a> </li> <li class=md-nav__item> <a href=#editor-utilities class=md-nav__link> <span class=md-ellipsis> Editor Utilities </span> </a> </li> <li class=md-nav__item> <a href=#failed-tests-exporter class=md-nav__link> <span class=md-ellipsis> Failed Tests Exporter </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#quick-reference class=md-nav__link> <span class=md-ellipsis> Quick Reference </span> </a> <nav class=md-nav aria-label="Quick Reference"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#tools-by-category class=md-nav__link> <span class=md-ellipsis> Tools by Category </span> </a> </li> <li class=md-nav__item> <a href=#all-menu-items class=md-nav__link> <span class=md-ellipsis> All Menu Items </span> </a> </li> <li class=md-nav__item> <a href=#common-workflows class=md-nav__link> <span class=md-ellipsis> Common Workflows </span> </a> </li> <li class=md-nav__item> <a href=#keyboard-shortcuts-tips class=md-nav__link> <span class=md-ellipsis> Keyboard Shortcuts & Tips </span> </a> </li> <li class=md-nav__item> <a href=#performance-considerations class=md-nav__link> <span class=md-ellipsis> Performance Considerations </span> </a> </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=#additional-resources class=md-nav__link> <span class=md-ellipsis> Additional Resources </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#version-information class=md-nav__link> <span class=md-ellipsis> Version Information </span> </a> </li> <li class=md-nav__item> <a href=#summary class=md-nav__link> <span class=md-ellipsis> Summary </span> </a> <nav class=md-nav aria-label=Summary> <ul class=md-nav__list> <li class=md-nav__item> <a href=#multifile-selector-ui-toolkit class=md-nav__link> <span class=md-ellipsis> MultiFile Selector (UI Toolkit) </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../unity-method-analyzer/ class=md-nav__link> <span class=md-ellipsis> Unity Method Analyzer </span> </a> </li> <li class=md-nav__item> <a href=../asset-change-detection/ class=md-nav__link> <span class=md-ellipsis> Asset Change Detection </span> </a> </li> <li class=md-nav__item> <a href=../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=./ class=md-path__link> <span class=md-ellipsis> Editor Tools </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <a href=https://github.com/wallstop/unity-helpers/edit/main/docs/features/editor-tools/editor-tools-guide.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/rawor-tools/rawor-tools-guide.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=wallstop-studios-unity-helpers-editor-tools-guide>Wallstop Studios Unity Helpers - Editor Tools Guide<a class=headerlink href=#wallstop-studios-unity-helpers-editor-tools-guide title="Permanent link">¶</a></h1> <h2 id=tldr-what-you-get>TL;DR — What You Get<a class=headerlink href=#tldr-what-you-get title="Permanent link">¶</a></h2> <ul> <li>One‑click utilities for sprites, textures, validation, and automation.</li> <li>Clear menus, step‑by‑step workflows, and safe previews before destructive actions.</li> <li>Start with: Sprite Cropper, Image Blur, Animation Creator, Prefab Checker, and the ScriptableObject Singleton Creator.</li> </ul> <p>Comprehensive documentation for all editor wizards, windows, and automation tools.</p> <hr> <h2 id=what-do-you-want-to-do-task-based-index>What Do You Want To Do? (Task-Based Index)<a class=headerlink href=#what-do-you-want-to-do-task-based-index title="Permanent link">¶</a></h2> <h3 id=optimize-sprite-memory-performance>Optimize Sprite Memory & Performance<a class=headerlink href=#optimize-sprite-memory-performance title="Permanent link">¶</a></h3> <ul> <li>Remove transparent padding → <a href=#sprite-cropper>Sprite Cropper</a></li> <li>Adjust texture size automatically → <a href=#fit-texture-size>Fit Texture Size</a></li> <li>Batch apply import settings → <a href=#texture-settings-applier>Texture Settings Applier</a></li> <li>Standardize sprite settings → <a href=#sprite-settings-applier>Sprite Settings Applier</a></li> <li>Adjust sprite pivots → <a href=#sprite-pivot-adjuster>Sprite Pivot Adjuster</a></li> </ul> <h3 id=create-edit-animations>Create & Edit Animations<a class=headerlink href=#create-edit-animations title="Permanent link">¶</a></h3> <ul> <li>Edit animation timing/frames visually → <a href=#sprite-animation-editor-animation-viewer-window>Sprite Animation Editor</a></li> <li>Bulk-create animations from sprites → <a href=#animation-creator>Animation Creator</a></li> <li>Convert sprite sheets to clips → <a href=#sprite-sheet-animation-creator>Sprite Sheet Animation Creator</a></li> <li>Add/edit animation events → <a href=#animation-event-editor>Animation Event Editor</a></li> <li>Copy/sync animations between folders → <a href=#animation-copier>Animation Copier</a></li> </ul> <h3 id=build-sprite-atlases>Build Sprite Atlases<a class=headerlink href=#build-sprite-atlases title="Permanent link">¶</a></h3> <ul> <li>Create atlases with regex/labels → <a href=#sprite-atlas-generator>Sprite Atlas Generator</a></li> </ul> <h3 id=validate-fix-prefabs>Validate & Fix Prefabs<a class=headerlink href=#validate-fix-prefabs title="Permanent link">¶</a></h3> <ul> <li>Check prefabs for errors → <a href=#prefab-checker>Prefab Checker</a></li> </ul> <h3 id=analyze-code-quality>Analyze Code Quality<a class=headerlink href=#analyze-code-quality title="Permanent link">¶</a></h3> <ul> <li>Detect inheritance and Unity method issues → <a href=#unity-method-analyzer>Unity Method Analyzer</a></li> </ul> <h3 id=apply-visual-effects>Apply Visual Effects<a class=headerlink href=#apply-visual-effects title="Permanent link">¶</a></h3> <ul> <li>Blur textures (backgrounds, DOF) → <a href=#image-blur-tool>Image Blur Tool</a></li> <li>Resize textures with filtering → <a href=#texture-resizer>Texture Resizer</a></li> </ul> <h3 id=automate-setup-maintenance>Automate Setup & Maintenance<a class=headerlink href=#automate-setup-maintenance title="Permanent link">¶</a></h3> <ul> <li>Auto-create singleton assets → <a href=#scriptableobject-singleton-creator>ScriptableObject Singleton Creator</a></li> <li>Respond to asset changes → <a href=../asset-change-detection/ >Asset Change Detection</a></li> <li>Cache attribute metadata → <a href=#attribute-metadata-cache-generator>Attribute Metadata Cache Generator</a></li> <li>Track sprite labels → <a href=#sprite-label-processor>Sprite Label Processor</a></li> <li>Capture and export test failures → <a href=#failed-tests-exporter>Failed Tests Exporter</a></li> <li>Manually trigger script recompilation → <a href=#request-script-recompilation>Request Script Compilation</a></li> <li>Configure buffer settings → <a href=#project-settings-unity-helpers>Project Settings: Unity Helpers</a></li> </ul> <h3 id=enhance-inspector-workflows>Enhance Inspector Workflows<a class=headerlink href=#enhance-inspector-workflows title="Permanent link">¶</a></h3> <p>See the <strong><a href=../../inspector/inspector-overview/ >Inspector Attributes documentation</a></strong> for:</p> <ul> <li><code>[WInLineEditor]</code> — Embed nested object inspectors inline</li> <li><code>[WShowIf]</code> — Conditional field visibility</li> <li><code>[WEnumToggleButtons]</code> — Visual toggle buttons for enums</li> <li><code>[WValueDropDown]</code>, <code>[IntDropDown]</code>, <code>[StringInList]</code> — Selection dropdowns</li> <li><code>[WReadOnly]</code>, <code>[WNotNull]</code> — Validation attributes</li> <li><code>[WGroup]</code>, <code>[WButton]</code> — Layout and method invocation</li> </ul> <hr> <h2 id=table-of-contents>Table of Contents<a class=headerlink href=#table-of-contents title="Permanent link">¶</a></h2> <ol> <li><a href=#texture--sprite-tools>Texture & Sprite Tools</a></li> <li><a href=#animation-tools>Animation Tools</a></li> <li><a href=#sprite-atlas-tools>Sprite Atlas Tools</a></li> <li><a href=#validation--quality-tools>Validation & Quality Tools</a></li> <li><a href=#prefab-checker>Prefab Checker</a></li> <li><a href=#unity-method-analyzer>Unity Method Analyzer</a></li> <li><a href=#custom-component-editors>Custom Component Editors</a></li> <li><a href=#property-drawers--attributes>Property Drawers & Attributes</a></li> <li><a href=#automation--utilities>Automation & Utilities</a></li> <li><a href=#scriptableobject-singleton-creator>ScriptableObject Singleton Creator</a></li> <li><a href=../asset-change-detection/ >Asset Change Detection</a></li> <li><a href=#quick-reference>Quick Reference</a></li> </ol> <hr> <p><a id=texture--sprite-tools></a> <a id=texture-sprite-tools></a></p> <h2 id=texture-sprite-tools>Texture & Sprite Tools<a class=headerlink href=#texture-sprite-tools title="Permanent link">¶</a></h2> <h3 id=image-blur-tool>Image Blur Tool<a class=headerlink href=#image-blur-tool title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Image Blur</code></p> <p><strong>Purpose:</strong> Apply Gaussian blur effects to textures in batch for backgrounds, depth-of-field, or softened sprites.</p> <p><strong>Key Features:</strong></p> <ul> <li>Configurable blur radius (1-200 pixels)</li> <li>Batch processing support</li> <li>Drag-and-drop folders/files</li> <li>Preserves original files</li> <li>Parallel processing for speed</li> </ul> <p><strong>Common Workflow:</strong></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-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>1. Open Image Blur Tool
</span><span id=__span-0-2><a id=__codelineno-0-2 name=__codelineno-0-2></a>2. Drag sprite folder into designated area
</span><span id=__span-0-3><a id=__codelineno-0-3 name=__codelineno-0-3></a>3. Set blur radius (e.g., 10 for subtle, 50 for heavy)
</span><span id=__span-0-4><a id=__codelineno-0-4 name=__codelineno-0-4></a>4. Click "Apply Blur"
</span><span id=__span-0-5><a id=__codelineno-0-5 name=__codelineno-0-5></a>5. Find blurred versions with "_blurred_[radius]" suffix
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>UI background blur effects</li> <li>Depth-of-field texture generation</li> <li>Post-processing texture preparation</li> </ul> <blockquote> <p><strong>Visual Demo</strong></p> <p><img alt="Image Blur Tool showing before/after comparison as blur radius slider is adjusted" src=../../../images/editor-tools/image-blur-before-after.gif></p> <p><em>Adjusting blur radius from 0 to 200 pixels on a UI background texture</em></p> </blockquote> <hr> <h3 id=sprite-cropper>Sprite Cropper<a class=headerlink href=#sprite-cropper title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Sprite Cropper</code></p> <p><strong>Purpose:</strong> Automatically remove transparent padding from sprites to optimize memory and atlas packing.</p> <p><strong>Key Features:</strong></p> <ul> <li>Alpha threshold detection (0.01)</li> <li>Configurable padding preservation</li> <li>Batch directory processing</li> <li>"Only Necessary" mode to skip optimal sprites</li> <li>Pivot point preservation in normalized coordinates</li> </ul> <p><strong>Common Workflow:</strong></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-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>
<span class=normal><a href=#__codelineno-1-9> 9</a></span>
<span class=normal><a href=#__codelineno-1-10>10</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>1. Open Sprite Cropper
</span><span id=__span-1-2><a id=__codelineno-1-2 name=__codelineno-1-2></a>2. Add sprite directories to "Input Directories"
</span><span id=__span-1-3><a id=__codelineno-1-3 name=__codelineno-1-3></a>3. Set padding (e.g., 2px on all sides for outlines)
</span><span id=__span-1-4><a id=__codelineno-1-4 name=__codelineno-1-4></a>4. Enable "Only Necessary" to skip already-cropped sprites
</span><span id=__span-1-5><a id=__codelineno-1-5 name=__codelineno-1-5></a>5. Click "Find Sprites To Process" to preview
</span><span id=__span-1-6><a id=__codelineno-1-6 name=__codelineno-1-6></a>6. Click "Process X Sprites"
</span><span id=__span-1-7><a id=__codelineno-1-7 name=__codelineno-1-7></a>7. Replace originals with "Cropped_*" versions
</span><span id=__span-1-8><a id=__codelineno-1-8 name=__codelineno-1-8></a>
</span><span id=__span-1-9><a id=__codelineno-1-9 name=__codelineno-1-9></a>**Danger Zone — Reference Replacement:**
</span><span id=__span-1-10><a id=__codelineno-1-10 name=__codelineno-1-10></a>- After cropping into `Cropped_*` outputs, you can optionally replace references to original sprites across assets with their cropped counterparts. This is powerful but destructive; review the preview output and ensure you have version control backups before applying.
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Sprites exported with excessive padding</li> <li>Character animation optimization</li> <li>Sprite atlas memory reduction</li> <li>Preparing assets for efficient packing</li> </ul> <p><strong>Performance Impact:</strong> Can reduce texture memory by 30-70% on padded sprites.</p> <blockquote> <p><strong>Visual Demo</strong></p> <p><img alt="Sprite Cropper showing original sprite with padding, then cropped result side-by-side" src=../../../images/editor-tools/sprite-cropper-comparison.gif></p> <p><em>Before and after: transparent padding removed while preserving sprite content and pivot</em></p> </blockquote> <p><strong>Related Tools:</strong></p> <ul> <li>After cropping, use <a href=#texture-settings-applier>Texture Settings Applier</a> to batch apply import settings</li> <li>Before creating atlases, run Sprite Cropper → <a href=#sprite-atlas-generator>Sprite Atlas Generator</a></li> <li>Use <a href=#sprite-pivot-adjuster>Sprite Pivot Adjuster</a> after cropping to fix pivot points</li> </ul> <hr> <h3 id=texture-settings-applier>Texture Settings Applier<a class=headerlink href=#texture-settings-applier title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Texture Settings Applier</code></p> <p><strong>Purpose:</strong> Batch apply standardized texture import settings across multiple assets.</p> <p><strong>Configurable Settings:</strong></p> <ul> <li>Read/Write enabled</li> <li>Mipmap generation</li> <li>Wrap Mode (Clamp/Repeat/Mirror)</li> <li>Filter Mode (Point/Bilinear/Trilinear)</li> <li>Compression (CompressedHQ/LQ/Uncompressed)</li> <li>Crunch compression</li> <li>Max texture size (32-8192)</li> <li>Texture format</li> </ul> <p><strong>Common Configurations:</strong></p> <p><strong>UI Sprites (Pixel-Perfect):</strong></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-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></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>Filter Mode: Point
</span><span id=__span-2-2><a id=__codelineno-2-2 name=__codelineno-2-2></a>Wrap Mode: Clamp
</span><span id=__span-2-3><a id=__codelineno-2-3 name=__codelineno-2-3></a>Compression: CompressedHQ or None
</span><span id=__span-2-4><a id=__codelineno-2-4 name=__codelineno-2-4></a>Generate Mip Maps: false
</span><span id=__span-2-5><a id=__codelineno-2-5 name=__codelineno-2-5></a>Max Size: 2048 or match source
</span></code></pre></div></td></tr></table></div> <p><strong>Environment Textures:</strong></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-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></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>Filter Mode: Trilinear
</span><span id=__span-3-2><a id=__codelineno-3-2 name=__codelineno-3-2></a>Wrap Mode: Repeat
</span><span id=__span-3-3><a id=__codelineno-3-3 name=__codelineno-3-3></a>Compression: CompressedHQ
</span><span id=__span-3-4><a id=__codelineno-3-4 name=__codelineno-3-4></a>Generate Mip Maps: true
</span><span id=__span-3-5><a id=__codelineno-3-5 name=__codelineno-3-5></a>Crunch Compression: true
</span></code></pre></div></td></tr></table></div> <p><strong>Character Sprites:</strong></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></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>Filter Mode: Bilinear
</span><span id=__span-4-2><a id=__codelineno-4-2 name=__codelineno-4-2></a>Wrap Mode: Clamp
</span><span id=__span-4-3><a id=__codelineno-4-3 name=__codelineno-4-3></a>Compression: CompressedHQ
</span><span id=__span-4-4><a id=__codelineno-4-4 name=__codelineno-4-4></a>Generate Mip Maps: false
</span></code></pre></div></td></tr></table></div> <p><strong>Workflow:</strong></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-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></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>1. Open Texture Settings Applier
</span><span id=__span-5-2><a id=__codelineno-5-2 name=__codelineno-5-2></a>2. Configure desired settings with checkboxes
</span><span id=__span-5-3><a id=__codelineno-5-3 name=__codelineno-5-3></a>3. Add textures individually OR add directories
</span><span id=__span-5-4><a id=__codelineno-5-4 name=__codelineno-5-4></a>4. Click "Set" to apply
</span><span id=__span-5-5><a id=__codelineno-5-5 name=__codelineno-5-5></a>5. Unity reimports affected textures
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Standardizing settings after art imports</li> <li>Fixing texture quality issues across directories</li> <li>Maintaining performance standards</li> <li>Team consistency enforcement</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Texture Settings Applier window showing configuration options" src=../../../images/editor-tools/texture-settings-applier.png></p> <p><em>Texture Settings Applier with filter mode, wrap mode, and compression options</em></p> </blockquote> <p><strong>Related Tools:</strong></p> <ul> <li>After setting texture settings, use <a href=#sprite-settings-applier>Sprite Settings Applier</a> for sprite-specific options</li> <li>Use <a href=#sprite-cropper>Sprite Cropper</a> first to optimize memory before applying settings</li> <li>Combine with <a href=#fit-texture-size>Fit Texture Size</a> to auto-adjust max texture sizes</li> </ul> <hr> <h3 id=sprite-pivot-adjuster>Sprite Pivot Adjuster<a class=headerlink href=#sprite-pivot-adjuster title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Sprite Pivot Adjuster</code></p> <p><strong>Purpose:</strong> Compute and apply alpha‑weighted center‑of‑mass pivots in bulk. Produces perceptually centered pivots (ignoring near‑transparent pixels) and speeds re‑imports by skipping unchanged results.</p> <p><strong>Key Features:</strong></p> <ul> <li>Alpha‑weighted center‑of‑mass pivot (configurable cutoff)</li> <li>Optional sprite name regex filter</li> <li>Skip unchanged (fuzzy threshold) and Force Reimport</li> <li>Directory picker with recursive processing</li> </ul> <p><strong>Workflow:</strong></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>
<span class=normal><a href=#__codelineno-6-6>6</a></span>
<span class=normal><a href=#__codelineno-6-7>7</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>1) Open Sprite Pivot Adjuster
</span><span id=__span-6-2><a id=__codelineno-6-2 name=__codelineno-6-2></a>2) Add one or more directories
</span><span id=__span-6-3><a id=__codelineno-6-3 name=__codelineno-6-3></a>3) (Optional) Set Sprite Name Regex to filter
</span><span id=__span-6-4><a id=__codelineno-6-4 name=__codelineno-6-4></a>4) Adjust Alpha Cutoff (e.g., 0.01 to ignore fringe pixels)
</span><span id=__span-6-5><a id=__codelineno-6-5 name=__codelineno-6-5></a>5) Enable “Skip Unchanged” to reimport only when pivot changes
</span><span id=__span-6-6><a id=__codelineno-6-6 name=__codelineno-6-6></a>6) (Optional) Enable “Force Reimport” to override skip
</span><span id=__span-6-7><a id=__codelineno-6-7 name=__codelineno-6-7></a>7) Run the adjuster to write importer pivot values
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Ground‑aligning characters while keeping lateral centering</li> <li>Consistent pivots across varied silhouettes</li> <li>Normalizing pivots before animation creation</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Sprite Pivot Adjuster window showing alpha-weighted pivot calculation" src=../../../images/editor-tools/sprite-pivot-adjuster.png></p> <p><em>Sprite Pivot Adjuster with alpha cutoff slider and directory selection</em></p> </blockquote> <hr> <h3 id=sprite-settings-applier>Sprite Settings Applier<a class=headerlink href=#sprite-settings-applier title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Sprite Settings Applier</code></p> <p><strong>Purpose:</strong> Apply sprite‑specific importer settings in bulk, driven by matchable “profiles” (Any/NameContains/PathContains/Regex/Extension) with priorities. Great for standardizing PPU, pivots, modes, and compression rules across large folders.</p> <p><strong>Profiles & Matching:</strong></p> <ul> <li>Create a <code>SpriteSettingsProfileCollection</code> ScriptableObject</li> <li>Add one or more profiles (with priority) and choose a match mode:</li> <li>Any, NameContains, PathContains, Extension, Regex</li> <li>Higher priority wins when multiple profiles match</li> </ul> <p><strong>Key Settings (per profile):</strong></p> <ul> <li>Pixels Per Unit, Pivot, Sprite Mode</li> <li>Generate Mip Maps, Read/Write, Alpha is Transparency</li> <li>Extrude Edges, Wrap Mode, Filter Mode</li> <li>Compression Level and Crunch Compression</li> <li>Texture Type override (ensure Sprite)</li> </ul> <p><strong>Workflow:</strong></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></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>1) Create a SpriteSettingsProfileCollection (Assets > Create > … if available) or configure profiles in the window
</span><span id=__span-7-2><a id=__codelineno-7-2 name=__codelineno-7-2></a>2) Open Sprite Settings Applier
</span><span id=__span-7-3><a id=__codelineno-7-3 name=__codelineno-7-3></a>3) Add directories and/or explicit sprites
</span><span id=__span-7-4><a id=__codelineno-7-4 name=__codelineno-7-4></a>4) Choose which profile(s) to apply and click Set
</span><span id=__span-7-5><a id=__codelineno-7-5 name=__codelineno-7-5></a>5) Unity reimports affected sprites
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Enforcing project‑wide sprite import standards</li> <li>Fixing inconsistent PPU/pivots automatically</li> <li>Applying different settings per folder/pattern (via Regex/Path)</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Sprite Settings Applier window showing profile configuration" src=../../../images/editor-tools/sprite-settings-applier.png></p> <p><em>Sprite Settings Applier with profile matching modes and import settings</em></p> </blockquote> <hr> <h3 id=texture-resizer>Texture Resizer<a class=headerlink href=#texture-resizer title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Texture Resizer</code></p> <p><strong>Purpose:</strong> Batch resize textures using bilinear or point filtering algorithms with configurable scaling multipliers.</p> <p><strong>Configuration Options:</strong></p> <ul> <li><strong>textures:</strong> Manually selected textures to resize</li> <li><strong>textureSourcePaths:</strong> Drag folders to process all textures within</li> <li><strong>numResizes:</strong> Number of resize iterations to apply</li> <li><strong>scalingResizeAlgorithm:</strong> Bilinear (smooth) or Point (pixel-perfect)</li> <li><strong>pixelsPerUnit:</strong> Base PPU for scaling calculations</li> <li><strong>widthMultiplier:</strong> Width scaling factor (default: 0.54)</li> <li><strong>heightMultiplier:</strong> Height scaling factor (default: 0.245)</li> </ul> <p><strong>How It Works:</strong></p> <ol> <li>For each texture, calculates: <code>extraWidth = width / (PPU * widthMultiplier)</code></li> <li>Resizes to <code>newSize = (width + extraWidth, height + extraHeight)</code></li> <li>Repeats for <code>numResizes</code> iterations</li> <li>Overwrites original PNG files</li> </ol> <p><strong>Workflow:</strong></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></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>1. Open Texture Resizer wizard
</span><span id=__span-8-2><a id=__codelineno-8-2 name=__codelineno-8-2></a>2. Add textures manually OR drag texture folders
</span><span id=__span-8-3><a id=__codelineno-8-3 name=__codelineno-8-3></a>3. Set algorithm (Bilinear for smooth, Point for pixel art)
</span><span id=__span-8-4><a id=__codelineno-8-4 name=__codelineno-8-4></a>4. Configure PPU and multipliers
</span><span id=__span-8-5><a id=__codelineno-8-5 name=__codelineno-8-5></a>5. Set number of resize passes
</span><span id=__span-8-6><a id=__codelineno-8-6 name=__codelineno-8-6></a>6. Click "Resize" to apply
</span></code></pre></div></td></tr></table></div> <p><strong>Resize Algorithms:</strong></p> <p><strong>Bilinear:</strong></p> <ul> <li>Smooth interpolation</li> <li>Good for photographic/realistic textures</li> <li>Prevents harsh edges</li> <li>Slight blur on upscaling</li> </ul> <p><strong>Point:</strong></p> <ul> <li>Nearest-neighbor sampling</li> <li>Perfect for pixel art</li> <li>Maintains sharp edges</li> <li>No interpolation blur</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Batch upscaling sprites</li> <li>Standardizing texture dimensions</li> <li>Preparing assets for specific PPU</li> <li>Pixel art scaling (use Point)</li> <li>Multiple resize passes for gradual scaling</li> </ul> <p><strong>Important Notes:</strong></p> <ul> <li><strong>Destructive operation:</strong> Overwrites original files</li> <li>Textures are made readable automatically</li> <li>Changes are permanent (backup originals!)</li> <li>AssetDatabase refreshes after completion</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Texture Resizer window showing resize algorithm options" src=../../../images/editor-tools/texture-resizer.png></p> <p><em>Texture Resizer with bilinear/point algorithm selection and multiplier settings</em></p> </blockquote> <hr> <h3 id=fit-texture-size>Fit Texture Size<a class=headerlink href=#fit-texture-size title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Fit Texture Size</code></p> <p><strong>Purpose:</strong> Automatically adjust texture max size import settings to match actual source dimensions (power-of-two).</p> <p><strong>Key Features:</strong></p> <ul> <li><strong>Grow and Shrink:</strong> Adjust to perfect fit (default)</li> <li><strong>Grow Only:</strong> Only increase max size if too small</li> <li><strong>Shrink Only:</strong> Only decrease max size if too large</li> <li><strong>Preview mode:</strong> Calculate changes before applying</li> <li><strong>Batch processing:</strong> Process entire directories at once</li> </ul> <p><strong>Fit Modes:</strong></p> <p><strong>GrowAndShrink:</strong></p> <ul> <li>Sets max texture size to the nearest power-of-2 that fits the source</li> <li>Example: 1500x800 source → 2048 max size</li> <li>Prevents both over-allocation and quality loss</li> </ul> <p><strong>GrowOnly:</strong></p> <ul> <li>Increases max size if the source is larger</li> <li>Never decreases size</li> <li>Useful for preventing quality loss on imports</li> </ul> <p><strong>ShrinkOnly:</strong></p> <ul> <li>Decreases max size if the source is smaller</li> <li>Never increases size</li> <li>Useful for reducing memory usage</li> </ul> <p><strong>Workflow:</strong></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-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></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>1. Open Fit Texture Size
</span><span id=__span-9-2><a id=__codelineno-9-2 name=__codelineno-9-2></a>2. Select Fit Mode (GrowAndShrink/GrowOnly/ShrinkOnly)
</span><span id=__span-9-3><a id=__codelineno-9-3 name=__codelineno-9-3></a>3. Add texture folders to process
</span><span id=__span-9-4><a id=__codelineno-9-4 name=__codelineno-9-4></a>4. Click "Calculate Potential Changes" to preview
</span><span id=__span-9-5><a id=__codelineno-9-5 name=__codelineno-9-5></a>5. Review how many textures will be modified
</span><span id=__span-9-6><a id=__codelineno-9-6 name=__codelineno-9-6></a>6. Click "Run Fit Texture Size" to apply
</span></code></pre></div></td></tr></table></div> <p><strong>Example:</strong></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-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></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>Source Texture: 1920x1080 pixels
</span><span id=__span-10-2><a id=__codelineno-10-2 name=__codelineno-10-2></a>Current Max Size: 512
</span><span id=__span-10-3><a id=__codelineno-10-3 name=__codelineno-10-3></a>Fit Mode: GrowAndShrink
</span><span id=__span-10-4><a id=__codelineno-10-4 name=__codelineno-10-4></a>Result: Max Size → 2048 (fits source dimensions)
</span><span id=__span-10-5><a id=__codelineno-10-5 name=__codelineno-10-5></a>
</span><span id=__span-10-6><a id=__codelineno-10-6 name=__codelineno-10-6></a>Source Texture: 64x64 pixels
</span><span id=__span-10-7><a id=__codelineno-10-7 name=__codelineno-10-7></a>Current Max Size: 2048
</span><span id=__span-10-8><a id=__codelineno-10-8 name=__codelineno-10-8></a>Fit Mode: ShrinkOnly
</span><span id=__span-10-9><a id=__codelineno-10-9 name=__codelineno-10-9></a>Result: Max Size → 64 (matches source)
</span></code></pre></div></td></tr></table></div> <p><strong>Algorithm:</strong></p> <ul> <li>Reads actual source width/height (not imported size)</li> <li>Calculates required power-of-2: <code>size = max(width, height)</code></li> <li>Rounds up to the next power-of-2 (32, 64, 128, 256, 512, 1024, 2048, 4096, 8192)</li> <li>Applies based on fit mode constraints</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Fixing texture import settings after bulk imports</li> <li>Optimizing memory usage automatically</li> <li>Ensuring quality matches source resolution</li> <li>Standardizing texture settings across the project</li> <li>Build size optimization</li> </ul> <p><strong>Performance:</strong></p> <ul> <li>Non-destructive (only changes import settings)</li> <li>Uses AssetDatabase batch editing for speed</li> <li>Progress bar for large operations</li> <li>Cancellable during processing</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Fit Texture Size window showing fit mode options and preview" src=../../../images/editor-tools/fit-texture-size.png></p> <p><em>Fit Texture Size with GrowAndShrink/GrowOnly/ShrinkOnly mode selection</em></p> </blockquote> <hr> <h2 id=animation-tools>Animation Tools<a class=headerlink href=#animation-tools title="Permanent link">¶</a></h2> <h3 id=sprite-animation-editor-animation-viewer-window>Sprite Animation Editor (Animation Viewer Window)<a class=headerlink href=#sprite-animation-editor-animation-viewer-window title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Sprite Animation Editor</code></p> <p><strong>Purpose:</strong> Visual editor for 2D sprite animations with real-time preview and frame manipulation.</p> <p><strong>Key Features:</strong></p> <ul> <li><strong>Real-time preview:</strong> See animations as you edit</li> <li><strong>Multi-layer support:</strong> Preview multiple clips simultaneously</li> <li><strong>Drag-and-drop reordering:</strong> Intuitive frame organization</li> <li><strong>FPS control:</strong> Adjust playback speed independently</li> <li><strong>Frame management:</strong> Add/remove/reorder/duplicate frames</li> <li><strong>Multi-file browser:</strong> Quick batch loading</li> <li><strong>Binding preservation:</strong> Maintains SpriteRenderer paths</li> </ul> <p><strong>Typical Workflow:</strong></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-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></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>1. Open Sprite Animation Editor
</span><span id=__span-11-2><a id=__codelineno-11-2 name=__codelineno-11-2></a>2. Click "Browse Clips (Multi)..." to select animations
</span><span id=__span-11-3><a id=__codelineno-11-3 name=__codelineno-11-3></a>3. Click a loaded clip in left panel to edit
</span><span id=__span-11-4><a id=__codelineno-11-4 name=__codelineno-11-4></a>4. Drag frames in "Frames" panel to reorder
</span><span id=__span-11-5><a id=__codelineno-11-5 name=__codelineno-11-5></a>5. Adjust FPS field and click "Apply FPS"
</span><span id=__span-11-6><a id=__codelineno-11-6 name=__codelineno-11-6></a>6. Preview updates in real-time
</span><span id=__span-11-7><a id=__codelineno-11-7 name=__codelineno-11-7></a>7. Click "Save Clip" to write changes
</span></code></pre></div></td></tr></table></div> <p><strong>Example Session:</strong></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-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></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>// Edit walk cycle animation:
</span><span id=__span-12-2><a id=__codelineno-12-2 name=__codelineno-12-2></a>1. Load "PlayerWalk.anim"
</span><span id=__span-12-3><a id=__codelineno-12-3 name=__codelineno-12-3></a>2. Preview plays at original 12 FPS
</span><span id=__span-12-4><a id=__codelineno-12-4 name=__codelineno-12-4></a>3. Drag frame 3 to position 1 (change starting pose)
</span><span id=__span-12-5><a id=__codelineno-12-5 name=__codelineno-12-5></a>4. Change FPS to 10 for slower walk
</span><span id=__span-12-6><a id=__codelineno-12-6 name=__codelineno-12-6></a>5. Click "Apply FPS" to preview
</span><span id=__span-12-7><a id=__codelineno-12-7 name=__codelineno-12-7></a>6. Click "Save Clip" to finalize
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Tweaking animation timing without re-export</li> <li>Creating variations by reordering frames</li> <li>Previewing character animation sets</li> <li>Testing different FPS values</li> <li>Quick prototyping from sprite sheets</li> <li>Fixing frame order mistakes</li> </ul> <p><strong>Tips:</strong></p> <ul> <li>Use the multi-file browser for entire animation sets</li> <li>Preview updates automatically while dragging</li> <li>FPS changes only affect the preview until saved</li> <li>Type frame numbers for precise positioning</li> <li>Press Enter to apply frame changes</li> </ul> <blockquote> <p><strong>Visual Demo</strong></p> <p><img alt="Sprite Animation Editor showing animation preview playing while frames are dragged to reorder" src=../../../images/editor-tools/sprite-animation-editor-reorder.gif></p> <p><em>Drag-and-drop frame reordering with real-time preview updates</em></p> <p><img alt="Sprite Animation Editor FPS adjustment showing animation speed changing live" src=../../../images/editor-tools/sprite-animation-editor-fps.gif></p> <p><em>Adjusting FPS slider and seeing immediate preview speed change</em></p> </blockquote> <hr> <h3 id=animation-creator>Animation Creator<a class=headerlink href=#animation-creator title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Animation Creator</code></p> <p><strong>Purpose:</strong> Bulk‑create AnimationClips from sprite naming patterns — one‑click generation from folders of sprites. Eliminates manual clip setup and ensures consistent naming, ordering, and FPS/loop settings.</p> <p><strong>Problems Solved:</strong></p> <ul> <li>Manual and error‑prone clip creation from many sprites</li> <li>Inconsistent frame ordering (lexicographic vs. numeric)</li> <li>Collisions/duplicates when generating many clips at once</li> <li>Repeating busywork when adding suffixes/prefixes across sets</li> </ul> <p><strong>Key Features:</strong></p> <ul> <li>Folder sources with regex sprite filtering (<code>spriteNameRegex</code>)</li> <li>Auto‑parse into clips using naming patterns (one click)</li> <li>Custom group regex with named groups <code>(?<base>)(?<index>)</code></li> <li>Case‑insensitive grouping and numeric sorting toggle</li> <li>Prefix clip names with a leaf folder or full folder path</li> <li>Auto‑parse name prefix/suffix and duplicate‑name resolution</li> <li>Dry‑run and preview (see groups and final asset paths)</li> <li>Per‑clip FPS and loop flag; bulk name append/remove</li> <li>"Populate First Slot with X Matched Sprites" helper</li> <li><strong>Live preview</strong>: Real-time animation playback in the editor before committing</li> <li><strong>Variable framerate</strong>: Constant FPS or curve-based frame timing per clip</li> </ul> <p><strong>Framerate Modes:</strong></p> <table> <thead> <tr> <th>Mode</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>Constant</code></td> <td>Fixed frames per second (default)</td> </tr> <tr> <td><code>Curve</code></td> <td>AnimationCurve-based timing for per-frame speed variation</td> </tr> </tbody> </table> <p><strong>Common Naming Patterns (auto‑detected):</strong></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-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></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>Player_Idle_0.png, Player_Idle_1.png, ... // base: Player_Idle, index: 0..N
</span><span id=__span-13-2><a id=__codelineno-13-2 name=__codelineno-13-2></a>slime-walk-01.png, slime-walk-02.png // base: slime-walk, index: 1..N
</span><span id=__span-13-3><a id=__codelineno-13-3 name=__codelineno-13-3></a>Mage/Attack (0).png, Mage/Attack (1).png // base: Mage_Attack, index: 0..N (folder prefix optional)
</span></code></pre></div></td></tr></table></div> <p><strong>Custom Group Regex Examples:</strong></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-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></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>// Named groups are optional but powerful when needed
</span><span id=__span-14-2><a id=__codelineno-14-2 name=__codelineno-14-2></a>^(?<base>.*?)(?:_|\s|-)?(?<index>\d+)\.[Pp][Nn][Gg]$ // base + trailing digits
</span><span id=__span-14-3><a id=__codelineno-14-3 name=__codelineno-14-3></a>^Enemy_(?<base>Walk)_(?<index>\d+)$ // narrow to specific clip type
</span></code></pre></div></td></tr></table></div> <p><strong>How To Use (one‑click flow):</strong></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-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></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>1) Open Animation Creator
</span><span id=__span-15-2><a id=__codelineno-15-2 name=__codelineno-15-2></a>2) Add one or more source folders
</span><span id=__span-15-3><a id=__codelineno-15-3 name=__codelineno-15-3></a>3) (Optional) Set sprite filter regex to narrow matches
</span><span id=__span-15-4><a id=__codelineno-15-4 name=__codelineno-15-4></a>4) Click “Auto‑Parse Matched Sprites into Animations”
</span><span id=__span-15-5><a id=__codelineno-15-5 name=__codelineno-15-5></a>5) Review generated Animation Data (set FPS/loop per clip)
</span><span id=__span-15-6><a id=__codelineno-15-6 name=__codelineno-15-6></a>6) Click “Create” (Action button) to write .anim assets
</span></code></pre></div></td></tr></table></div> <p><strong>Preview & Safety:</strong></p> <ul> <li>Use “Generate Auto‑Parse Preview” to see detected groups</li> <li>Use “Generate Dry‑Run Apply” to see final clip names/paths</li> <li>Toggle “Strict Numeric Ordering” to avoid <code>1,10,11,2,…</code> issues</li> <li>Enable “Resolve Duplicate Animation Names” to auto‑rename</li> </ul> <p><strong>Tips:</strong></p> <ul> <li>Keep sprite names consistent (e.g., <code>Name_Action_###</code>)</li> <li>Use the built‑in Regex Tester before applying</li> <li>Use folder name/path prefixing to avoid collisions across sets</li> <li>Batch rename tokens with the “Bulk Naming Operations” section</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>One‑click bulk clip creation from sprite folders</li> <li>Converting exported frame sequences into clips</li> <li>Large projects standardizing animation naming and FPS/loop</li> </ul> <blockquote> <p><strong>Visual Demo</strong></p> <p><img alt="Animation Creator auto-parse workflow showing sprites being grouped and clips generated" src=../../../images/editor-tools/animation-creator-auto-parse.gif></p> <p><em>One-click auto-parse: sprites grouped by naming pattern, clips generated instantly</em></p> </blockquote> <p><strong>Related Tools:</strong></p> <ul> <li>After creating animations, edit timing with <a href=#sprite-animation-editor-animation-viewer-window>Sprite Animation Editor</a></li> <li>Add events to created animations with <a href=#animation-event-editor>Animation Event Editor</a></li> <li>Organize animations between folders with <a href=#animation-copier>Animation Copier</a></li> <li>For sprite sheets (not sequences), use <a href=#sprite-sheet-animation-creator>Sprite Sheet Animation Creator</a></li> </ul> <hr> <h3 id=animation-copier>Animation Copier<a class=headerlink href=#animation-copier title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Animation Copier</code></p> <p><strong>Purpose:</strong> Analyze, duplicate, and synchronize AnimationClips between source and destination folders with previews, dry‑runs, and cleanup actions.</p> <p><strong>What It Analyzes:</strong></p> <ul> <li>New: exist in the source but not the destination</li> <li>Changed: exist in both but differ (hash mismatch)</li> <li>Unchanged: identical in both (duplicates)</li> <li>Destination Orphans: only in destination</li> </ul> <p><strong>Workflow:</strong></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-16-1> 1</a></span>
<span class=normal><a href=#__codelineno-16-2> 2</a></span>
<span class=normal><a href=#__codelineno-16-3> 3</a></span>
<span class=normal><a href=#__codelineno-16-4> 4</a></span>
<span class=normal><a href=#__codelineno-16-5> 5</a></span>
<span class=normal><a href=#__codelineno-16-6> 6</a></span>
<span class=normal><a href=#__codelineno-16-7> 7</a></span>
<span class=normal><a href=#__codelineno-16-8> 8</a></span>
<span class=normal><a href=#__codelineno-16-9> 9</a></span>
<span class=normal><a href=#__codelineno-16-10>10</a></span>
<span class=normal><a href=#__codelineno-16-11>11</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-16-1><a id=__codelineno-16-1 name=__codelineno-16-1></a>1) Open Animation Copier
</span><span id=__span-16-2><a id=__codelineno-16-2 name=__codelineno-16-2></a>2) Select Source Path (e.g., Assets/Sprites/Animations)
</span><span id=__span-16-3><a id=__codelineno-16-3 name=__codelineno-16-3></a>3) Select Destination Path (e.g., Assets/Animations)
</span><span id=__span-16-4><a id=__codelineno-16-4 name=__codelineno-16-4></a>4) Click “Analyze Source & Destination”
</span><span id=__span-16-5><a id=__codelineno-16-5 name=__codelineno-16-5></a>5) Review New/Changed/Unchanged/Orphans tabs (filter/sort)
</span><span id=__span-16-6><a id=__codelineno-16-6 name=__codelineno-16-6></a>6) Choose a copy mode:
</span><span id=__span-16-7><a id=__codelineno-16-7 name=__codelineno-16-7></a> - Copy New / Copy Changed / Copy All (optional force replace)
</span><span id=__span-16-8><a id=__codelineno-16-8 name=__codelineno-16-8></a>7) (Optional) Dry Run to preview without writing
</span><span id=__span-16-9><a id=__codelineno-16-9 name=__codelineno-16-9></a>8) Use Cleanup:
</span><span id=__span-16-10><a id=__codelineno-16-10 name=__codelineno-16-10></a> - Delete Unchanged Source Duplicates
</span><span id=__span-16-11><a id=__codelineno-16-11 name=__codelineno-16-11></a> - Delete Destination Orphans
</span></code></pre></div></td></tr></table></div> <p><strong>Safety & Options:</strong></p> <ul> <li>Dry Run (no changes) for all copy/cleanup operations</li> <li>“Include Unchanged in Copy All” to force overwrite duplicates</li> <li>Open Source/Destination folder buttons for quick navigation</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Creating animation variants and organizing libraries</li> <li>Syncing generated clips into your canonical destination</li> <li>Keeping animation folders tidy with cleanup actions</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Animation Copier window showing source/destination analysis" src=../../../images/editor-tools/animation-copier.png></p> <p><em>Animation Copier with new/changed/unchanged/orphan tabs and copy actions</em></p> </blockquote> <hr> <h3 id=sprite-sheet-animation-creator>Sprite Sheet Animation Creator<a class=headerlink href=#sprite-sheet-animation-creator title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Sprite Sheet Animation Creator</code></p> <p><strong>Purpose:</strong> Turn a sliced sprite sheet into one or more AnimationClips with live preview, drag‑to‑select sprite ranges, and per‑clip FPS/loop/cycle offset.</p> <p><strong>Key Features:</strong></p> <ul> <li>Load a multi‑sprite Texture2D (sliced in the Sprite Editor)</li> <li>Drag‑select sprite ranges to define clips visually</li> <li>Constant FPS or curve‑based frame rate per clip</li> <li>Live preview/playback controls and scrubbing</li> <li>Loop toggle and cycle offset per clip</li> <li>Safe asset creation with unique file names</li> </ul> <p><strong>Usage:</strong></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-17-1>1</a></span>
<span class=normal><a href=#__codelineno-17-2>2</a></span>
<span class=normal><a href=#__codelineno-17-3>3</a></span>
<span class=normal><a href=#__codelineno-17-4>4</a></span>
<span class=normal><a href=#__codelineno-17-5>5</a></span>
<span class=normal><a href=#__codelineno-17-6>6</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-17-1><a id=__codelineno-17-1 name=__codelineno-17-1></a>1) Open Sprite Sheet Animation Creator
</span><span id=__span-17-2><a id=__codelineno-17-2 name=__codelineno-17-2></a>2) Drag a sliced Texture2D (or use the object field)
</span><span id=__span-17-3><a id=__codelineno-17-3 name=__codelineno-17-3></a>3) Select frames (drag across thumbnails) to define a clip
</span><span id=__span-17-4><a id=__codelineno-17-4 name=__codelineno-17-4></a>4) Name the clip, set FPS/curve, loop, cycle offset
</span><span id=__span-17-5><a id=__codelineno-17-5 name=__codelineno-17-5></a>5) Repeat to add multiple definitions
</span><span id=__span-17-6><a id=__codelineno-17-6 name=__codelineno-17-6></a>6) Click “Generate Animations” and choose output folder
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Converting sprite sheets to animation clips with fine control</li> <li>Mixed timings using AnimationCurves for frame pacing</li> <li>Fast iteration via visual selection and preview</li> </ul> <blockquote> <p><strong>Visual Demo</strong></p> <p><img alt="Sprite Sheet Animation Creator showing drag-select across sprite thumbnails with live preview" src=../../../images/editor-tools/sprite-sheet-creator-select.gif></p> <p><em>Drag-select frame ranges on sprite sheet thumbnails with instant preview playback</em></p> </blockquote> <hr> <h3 id=sprite-sheet-extractor>Sprite Sheet Extractor<a class=headerlink href=#sprite-sheet-extractor title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Sprite Sheet Extractor</code></p> <p><strong>Purpose:</strong> Extract individual sprites from sprite sheet textures and save them as separate PNG files with batch processing, preview, and optional reference replacement.</p> <p><strong>Key Features:</strong></p> <ul> <li><strong>Multiple extraction modes:</strong> From existing metadata, grid-based, alpha detection, or padded grid</li> <li><strong>Auto-detection algorithms:</strong> Automatically detect optimal grid dimensions from transparency patterns</li> <li><strong>Pivot preservation:</strong> Maintain original pivot points or set custom pivots per sprite</li> <li><strong>Preview interface:</strong> Visual preview of all detected sprites before extraction</li> <li><strong>Batch processing:</strong> Process multiple sprite sheets at once</li> <li><strong>Reference replacement:</strong> Optionally update prefab/scene references to new sprites</li> <li><strong>Per-sheet configuration:</strong> Override global settings for individual sprite sheets</li> <li><strong>Config persistence:</strong> Save and load extraction settings per sprite sheet</li> </ul> <p><strong>Extraction Modes:</strong></p> <p><strong>FromMetadata:</strong></p> <ul> <li>Uses existing Unity sprite metadata (SpriteImportMode.Multiple)</li> <li>Preserves original names, rects, pivots, and borders</li> <li>Best for already-sliced sprite sheets</li> </ul> <p><strong>GridBased:</strong></p> <ul> <li>Divides texture into uniform grid cells</li> <li>Auto or manual grid dimensions</li> <li>Good for evenly-spaced sprite sheets</li> </ul> <p><strong>AlphaDetection:</strong></p> <ul> <li>Analyzes transparency to find sprite boundaries</li> <li>Works with irregular sprite layouts</li> <li>Configurable alpha threshold</li> </ul> <p><strong>PaddedGrid:</strong></p> <ul> <li>Grid-based with configurable padding/gutters</li> <li>Handles sprite sheets with spacing between cells</li> </ul> <p><strong>Pivot Modes:</strong></p> <ul> <li><strong>Center:</strong> Pivot at sprite center (0.5, 0.5)</li> <li><strong>BottomCenter:</strong> Pivot at bottom center (0.5, 0)</li> <li><strong>TopCenter:</strong> Pivot at top center (0.5, 1)</li> <li><strong>LeftCenter:</strong> Pivot at left center (0, 0.5)</li> <li><strong>RightCenter:</strong> Pivot at right center (1, 0.5)</li> <li><strong>BottomLeft:</strong> Pivot at bottom left (0, 0)</li> <li><strong>BottomRight:</strong> Pivot at bottom right (1, 0)</li> <li><strong>TopLeft:</strong> Pivot at top left (0, 1)</li> <li><strong>TopRight:</strong> Pivot at top right (1, 1)</li> <li><strong>Custom:</strong> User-specified pivot coordinates</li> </ul> <p><strong>Workflow:</strong></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-18-1> 1</a></span>
<span class=normal><a href=#__codelineno-18-2> 2</a></span>
<span class=normal><a href=#__codelineno-18-3> 3</a></span>
<span class=normal><a href=#__codelineno-18-4> 4</a></span>
<span class=normal><a href=#__codelineno-18-5> 5</a></span>
<span class=normal><a href=#__codelineno-18-6> 6</a></span>
<span class=normal><a href=#__codelineno-18-7> 7</a></span>
<span class=normal><a href=#__codelineno-18-8> 8</a></span>
<span class=normal><a href=#__codelineno-18-9> 9</a></span>
<span class=normal><a href=#__codelineno-18-10>10</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-18-1><a id=__codelineno-18-1 name=__codelineno-18-1></a>1. Open Sprite Sheet Extractor
</span><span id=__span-18-2><a id=__codelineno-18-2 name=__codelineno-18-2></a>2. Add input directories containing sprite sheets
</span><span id=__span-18-3><a id=__codelineno-18-3 name=__codelineno-18-3></a>3. (Optional) Set sprite name regex filter
</span><span id=__span-18-4><a id=__codelineno-18-4 name=__codelineno-18-4></a>4. Configure extraction mode and settings
</span><span id=__span-18-5><a id=__codelineno-18-5 name=__codelineno-18-5></a>5. Click "Discover Sprite Sheets" to scan
</span><span id=__span-18-6><a id=__codelineno-18-6 name=__codelineno-18-6></a>6. Review detected sheets and sprites in preview
</span><span id=__span-18-7><a id=__codelineno-18-7 name=__codelineno-18-7></a>7. Adjust per-sheet settings if needed
</span><span id=__span-18-8><a id=__codelineno-18-8 name=__codelineno-18-8></a>8. Set output directory
</span><span id=__span-18-9><a id=__codelineno-18-9 name=__codelineno-18-9></a>9. Click "Extract" to generate individual sprites
</span><span id=__span-18-10><a id=__codelineno-18-10 name=__codelineno-18-10></a>10. (Optional) Use reference replacement for prefab updates
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Converting packed sprite sheets to individual assets</li> <li>Preparing sprites for animation systems that expect separate files</li> <li>Creating backup copies of individual sprites</li> <li>Reorganizing sprite assets</li> <li>Migrating from third-party sprite sheet formats</li> </ul> <p><strong>Tips:</strong></p> <ul> <li>Use "Snap to Texture Divisor" for cleaner grid alignment</li> <li>Preview sprites before extraction to verify detection</li> <li>Save per-sheet configs for consistent re-extraction</li> <li>Enable reference replacement only with VCS backup</li> <li>Use alpha detection for irregularly-spaced sprite sheets</li> </ul> <hr> <h3 id=animation-event-editor>Animation Event Editor<a class=headerlink href=#animation-event-editor title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > AnimationEvent Editor</code></p> <p><strong>Purpose:</strong> Advanced visual editor for creating and managing animation events with sprite preview, method auto-discovery, and parameter editing.</p> <p><strong>Key Features:</strong></p> <ul> <li><strong>Sprite preview:</strong> See the sprite at each event time</li> <li><strong>Method auto-discovery:</strong> Automatically finds valid animation event methods</li> <li><strong>Explicit mode:</strong> Restrict to methods marked with <code>[AnimationEvent]</code> attribute</li> <li><strong>Parameter editing:</strong> Visual editors for int, float, string, object, and enum parameters</li> <li><strong>Frame-based editing:</strong> Work with frame numbers instead of time values</li> <li><strong>Search filtering:</strong> Filter types and methods by search terms</li> <li><strong>Real-time validation:</strong> Shows invalid texture rects and read/write issues</li> </ul> <p><strong>Workflow:</strong></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-19-1> 1</a></span>
<span class=normal><a href=#__codelineno-19-2> 2</a></span>
<span class=normal><a href=#__codelineno-19-3> 3</a></span>
<span class=normal><a href=#__codelineno-19-4> 4</a></span>
<span class=normal><a href=#__codelineno-19-5> 5</a></span>
<span class=normal><a href=#__codelineno-19-6> 6</a></span>
<span class=normal><a href=#__codelineno-19-7> 7</a></span>
<span class=normal><a href=#__codelineno-19-8> 8</a></span>
<span class=normal><a href=#__codelineno-19-9> 9</a></span>
<span class=normal><a href=#__codelineno-19-10>10</a></span>
<span class=normal><a href=#__codelineno-19-11>11</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-19-1><a id=__codelineno-19-1 name=__codelineno-19-1></a>1. Open Animation Event Editor
</span><span id=__span-19-2><a id=__codelineno-19-2 name=__codelineno-19-2></a>2. Drag Animator component into "Animator Object" field
</span><span id=__span-19-3><a id=__codelineno-19-3 name=__codelineno-19-3></a>3. Select animation from dropdown (or use Animation Search)
</span><span id=__span-19-4><a id=__codelineno-19-4 name=__codelineno-19-4></a>4. Set "FrameIndex" for new event
</span><span id=__span-19-5><a id=__codelineno-19-5 name=__codelineno-19-5></a>5. Click "Add Event" to create event at that frame
</span><span id=__span-19-6><a id=__codelineno-19-6 name=__codelineno-19-6></a>6. Configure event:
</span><span id=__span-19-7><a id=__codelineno-19-7 name=__codelineno-19-7></a> a. Select TypeName (MonoBehaviour with event methods)
</span><span id=__span-19-8><a id=__codelineno-19-8 name=__codelineno-19-8></a> b. Select MethodName from available methods
</span><span id=__span-19-9><a id=__codelineno-19-9 name=__codelineno-19-9></a> c. Set parameters (int, float, string, object, enum)
</span><span id=__span-19-10><a id=__codelineno-19-10 name=__codelineno-19-10></a>7. Reorder events if needed (Move Up/Down buttons)
</span><span id=__span-19-11><a id=__codelineno-19-11 name=__codelineno-19-11></a>8. Click "Save" to write changes to animation clip
</span></code></pre></div></td></tr></table></div> <p><strong>Modes:</strong></p> <p><strong>Explicit Mode (Default):</strong></p> <ul> <li>Only shows methods marked with <code>[AnimationEvent]</code> attribute</li> <li>Cleaner, curated list of event methods</li> <li>Recommended for large projects</li> </ul> <p><strong>Non-Explicit Mode:</strong></p> <ul> <li>Shows all public methods with valid signatures</li> <li>Use the "Search" field to filter by type/method name</li> <li>Good for discovery and prototyping</li> </ul> <p><strong>Control Frame Time:</strong></p> <ul> <li>Disabled: Work with frame indices (snaps to frames)</li> <li>Enabled: Edit precise time values (floating point)</li> </ul> <p><strong>Sprite Preview:</strong></p> <ul> <li>Automatically shows sprite at event time</li> <li>Requires texture Read/Write enabled</li> <li>"Fix" button to enable Read/Write if needed</li> <li>Warns if a sprite is packed too tightly</li> </ul> <p><strong>Event Management:</strong></p> <p><strong>Adding Events:</strong></p> <ol> <li>Set "FrameIndex" to desired frame</li> <li>Click "Add Event"</li> <li>Event created at frame time</li> </ol> <p><strong>Editing Events:</strong></p> <ul> <li>Change frame/time directly</li> <li>Select type and method from dropdowns</li> <li>Edit parameters based on method signature</li> <li>Override enum values if needed</li> </ul> <p><strong>Reordering:</strong></p> <ul> <li>"Move Up"/"Move Down" for events at the same time</li> <li>"Re-Order" button sorts all events by time</li> <li>Maintains proper event order for playback</li> </ul> <p><strong>Resetting:</strong></p> <ul> <li>Per-event "Reset" button (reverts to saved state)</li> <li>Global "Reset" button (discards all changes)</li> </ul> <p><strong>Parameter Types Supported:</strong></p> <ul> <li><code>int</code> - IntField editor</li> <li><code>float</code> - FloatField editor</li> <li><code>string</code> - TextField editor</li> <li><code>UnityEngine.Object</code> - ObjectField editor</li> <li><code>Enum</code> - Dropdown with an override option</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Complex animation event setup</li> <li>Character combat systems</li> <li>Footstep/sound effect events</li> <li>Particle effect triggers</li> <li>Animation state notifications</li> <li>Visual debugging of event timing</li> </ul> <p><strong>Tips:</strong></p> <ul> <li>Enable "Explicit Mode" to reduce clutter</li> <li>Use "Animation Search" for quick filtering</li> <li>Frame numbers are more intuitive than time values</li> <li>Sprite preview helps verify timing</li> <li>Multiple events can exist at the same frame</li> <li>Use "Re-Order" before saving for consistency</li> </ul> <p><strong>Common Method Signatures:</strong></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-20-1> 1</a></span>
<span class=normal><a href=#__codelineno-20-2> 2</a></span>
<span class=normal><a href=#__codelineno-20-3> 3</a></span>
<span class=normal><a href=#__codelineno-20-4> 4</a></span>
<span class=normal><a href=#__codelineno-20-5> 5</a></span>
<span class=normal><a href=#__codelineno-20-6> 6</a></span>
<span class=normal><a href=#__codelineno-20-7> 7</a></span>
<span class=normal><a href=#__codelineno-20-8> 8</a></span>
<span class=normal><a href=#__codelineno-20-9> 9</a></span>
<span class=normal><a href=#__codelineno-20-10>10</a></span>
<span class=normal><a href=#__codelineno-20-11>11</a></span>
<span class=normal><a href=#__codelineno-20-12>12</a></span>
<span class=normal><a href=#__codelineno-20-13>13</a></span>
<span class=normal><a href=#__codelineno-20-14>14</a></span>
<span class=normal><a href=#__codelineno-20-15>15</a></span>
<span class=normal><a href=#__codelineno-20-16>16</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-20-1><a id=__codelineno-20-1 name=__codelineno-20-1></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-20-2><a id=__codelineno-20-2 name=__codelineno-20-2></a>
</span><span id=__span-20-3><a id=__codelineno-20-3 name=__codelineno-20-3></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>CharacterAnimationEvents</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-20-4><a id=__codelineno-20-4 name=__codelineno-20-4></a><span class=p>{</span>
</span><span id=__span-20-5><a id=__codelineno-20-5 name=__codelineno-20-5></a><span class=w> </span><span class=na>[AnimationEvent]</span><span class=w> </span><span class=c1>// Shows in Explicit Mode</span>
</span><span id=__span-20-6><a id=__codelineno-20-6 name=__codelineno-20-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>PlayFootstep</span><span class=p>()</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
</span><span id=__span-20-7><a id=__codelineno-20-7 name=__codelineno-20-7></a>
</span><span id=__span-20-8><a id=__codelineno-20-8 name=__codelineno-20-8></a><span class=w> </span><span class=na>[AnimationEvent]</span>
</span><span id=__span-20-9><a id=__codelineno-20-9 name=__codelineno-20-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>SpawnEffect</span><span class=p>(</span><span class=kt>string</span><span class=w> </span><span class=n>effectName</span><span class=p>)</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
</span><span id=__span-20-10><a id=__codelineno-20-10 name=__codelineno-20-10></a>
</span><span id=__span-20-11><a id=__codelineno-20-11 name=__codelineno-20-11></a><span class=w> </span><span class=na>[AnimationEvent]</span>
</span><span id=__span-20-12><a id=__codelineno-20-12 name=__codelineno-20-12></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>ApplyDamage</span><span class=p>(</span><span class=kt>int</span><span class=w> </span><span class=n>damage</span><span class=p>)</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
</span><span id=__span-20-13><a id=__codelineno-20-13 name=__codelineno-20-13></a>
</span><span id=__span-20-14><a id=__codelineno-20-14 name=__codelineno-20-14></a><span class=w> </span><span class=na>[AnimationEvent]</span>
</span><span id=__span-20-15><a id=__codelineno-20-15 name=__codelineno-20-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>SetAnimationState</span><span class=p>(</span><span class=n>CharacterState</span><span class=w> </span><span class=n>state</span><span class=p>)</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span><span class=w> </span><span class=c1>// Enum parameter</span>
</span><span id=__span-20-16><a id=__codelineno-20-16 name=__codelineno-20-16></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <hr> <h2 id=sprite-atlas-tools>Sprite Atlas Tools<a class=headerlink href=#sprite-atlas-tools title="Permanent link">¶</a></h2> <h3 id=sprite-atlas-generator>Sprite Atlas Generator<a class=headerlink href=#sprite-atlas-generator title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Sprite Atlas Generator</code></p> <p><strong>Purpose:</strong> Comprehensive tool for creating and managing Unity Sprite Atlases with regex-based sprite selection, label filtering, and automated packing.</p> <p><strong>Key Features:</strong></p> <ul> <li><strong>Regex-based sprite selection:</strong> Use regular expressions to automatically find sprites</li> <li><strong>Label filtering:</strong> Select sprites based on Unity asset labels</li> <li><strong>Multiple source folders:</strong> Configure different folders with different selection criteria</li> <li><strong>Batch atlas generation:</strong> Create/update multiple atlases at once</li> <li><strong>Advanced packing settings:</strong> Control texture size, compression, padding, rotation</li> <li><strong>Source sprite utilities:</strong> Force uncompressed settings for source sprites</li> <li><strong>Scan and preview:</strong> See what sprites will be added/removed before applying changes</li> </ul> <p><strong>Configuration Asset:</strong> Create configurations via <code>Assets > Create > Wallstop Studios > Unity Helpers > Scriptable Sprite Atlas Config</code></p> <p><strong>ScriptableSpriteAtlas Configuration:</strong></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-21-1> 1</a></span>
<span class=normal><a href=#__codelineno-21-2> 2</a></span>
<span class=normal><a href=#__codelineno-21-3> 3</a></span>
<span class=normal><a href=#__codelineno-21-4> 4</a></span>
<span class=normal><a href=#__codelineno-21-5> 5</a></span>
<span class=normal><a href=#__codelineno-21-6> 6</a></span>
<span class=normal><a href=#__codelineno-21-7> 7</a></span>
<span class=normal><a href=#__codelineno-21-8> 8</a></span>
<span class=normal><a href=#__codelineno-21-9> 9</a></span>
<span class=normal><a href=#__codelineno-21-10>10</a></span>
<span class=normal><a href=#__codelineno-21-11>11</a></span>
<span class=normal><a href=#__codelineno-21-12>12</a></span>
<span class=normal><a href=#__codelineno-21-13>13</a></span>
<span class=normal><a href=#__codelineno-21-14>14</a></span>
<span class=normal><a href=#__codelineno-21-15>15</a></span>
<span class=normal><a href=#__codelineno-21-16>16</a></span>
<span class=normal><a href=#__codelineno-21-17>17</a></span>
<span class=normal><a href=#__codelineno-21-18>18</a></span>
<span class=normal><a href=#__codelineno-21-19>19</a></span>
<span class=normal><a href=#__codelineno-21-20>20</a></span>
<span class=normal><a href=#__codelineno-21-21>21</a></span>
<span class=normal><a href=#__codelineno-21-22>22</a></span>
<span class=normal><a href=#__codelineno-21-23>23</a></span>
<span class=normal><a href=#__codelineno-21-24>24</a></span>
<span class=normal><a href=#__codelineno-21-25>25</a></span>
<span class=normal><a href=#__codelineno-21-26>26</a></span>
<span class=normal><a href=#__codelineno-21-27>27</a></span>
<span class=normal><a href=#__codelineno-21-28>28</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-21-1><a id=__codelineno-21-1 name=__codelineno-21-1></a>Sprite Sources:
</span><span id=__span-21-2><a id=__codelineno-21-2 name=__codelineno-21-2></a>- spritesToPack: Manually added sprites (always included)
</span><span id=__span-21-3><a id=__codelineno-21-3 name=__codelineno-21-3></a>- sourceFolderEntries: Define folders with regex/label filters
</span><span id=__span-21-4><a id=__codelineno-21-4 name=__codelineno-21-4></a>
</span><span id=__span-21-5><a id=__codelineno-21-5 name=__codelineno-21-5></a>Source Folder Entry Options:
</span><span id=__span-21-6><a id=__codelineno-21-6 name=__codelineno-21-6></a>- folderPath: Folder to scan (relative to Assets/)
</span><span id=__span-21-7><a id=__codelineno-21-7 name=__codelineno-21-7></a>- selectionMode: Regex | Labels | Both
</span><span id=__span-21-8><a id=__codelineno-21-8 name=__codelineno-21-8></a>- regexes: List of regex patterns (all must match - AND logic)
</span><span id=__span-21-9><a id=__codelineno-21-9 name=__codelineno-21-9></a>- regexAndTagLogic: How to combine regex and labels (And/Or)
</span><span id=__span-21-10><a id=__codelineno-21-10 name=__codelineno-21-10></a>- labelSelectionMode: All | AnyOf
</span><span id=__span-21-11><a id=__codelineno-21-11 name=__codelineno-21-11></a>- labels: Asset labels to filter by
</span><span id=__span-21-12><a id=__codelineno-21-12 name=__codelineno-21-12></a>
</span><span id=__span-21-13><a id=__codelineno-21-13 name=__codelineno-21-13></a>Output Atlas Settings:
</span><span id=__span-21-14><a id=__codelineno-21-14 name=__codelineno-21-14></a>- outputSpriteAtlasDirectory: Where to save .spriteatlas
</span><span id=__span-21-15><a id=__codelineno-21-15 name=__codelineno-21-15></a>- outputSpriteAtlasName: Name of atlas file
</span><span id=__span-21-16><a id=__codelineno-21-16 name=__codelineno-21-16></a>
</span><span id=__span-21-17><a id=__codelineno-21-17 name=__codelineno-21-17></a>Packing Settings:
</span><span id=__span-21-18><a id=__codelineno-21-18 name=__codelineno-21-18></a>- maxTextureSize: 32-16384 (power of 2)
</span><span id=__span-21-19><a id=__codelineno-21-19 name=__codelineno-21-19></a>- enableRotation: Allow sprite rotation for better packing
</span><span id=__span-21-20><a id=__codelineno-21-20 name=__codelineno-21-20></a>- padding: Pixels between sprites (0-32)
</span><span id=__span-21-21><a id=__codelineno-21-21 name=__codelineno-21-21></a>- enableTightPacking: Optimize packing density
</span><span id=__span-21-22><a id=__codelineno-21-22 name=__codelineno-21-22></a>- enableAlphaDilation: Dilate alpha edges
</span><span id=__span-21-23><a id=__codelineno-21-23 name=__codelineno-21-23></a>- readWriteEnabled: Enable Read/Write on atlas texture
</span><span id=__span-21-24><a id=__codelineno-21-24 name=__codelineno-21-24></a>
</span><span id=__span-21-25><a id=__codelineno-21-25 name=__codelineno-21-25></a>Compression Settings:
</span><span id=__span-21-26><a id=__codelineno-21-26 name=__codelineno-21-26></a>- useCrunchCompression: Enable crunch compression
</span><span id=__span-21-27><a id=__codelineno-21-27 name=__codelineno-21-27></a>- crunchCompressionLevel: 0-100 quality
</span><span id=__span-21-28><a id=__codelineno-21-28 name=__codelineno-21-28></a>- compression: Compressed/CompressedHQ/Uncompressed
</span></code></pre></div></td></tr></table></div> <p><strong>Typical Workflow:</strong></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-22-1> 1</a></span>
<span class=normal><a href=#__codelineno-22-2> 2</a></span>
<span class=normal><a href=#__codelineno-22-3> 3</a></span>
<span class=normal><a href=#__codelineno-22-4> 4</a></span>
<span class=normal><a href=#__codelineno-22-5> 5</a></span>
<span class=normal><a href=#__codelineno-22-6> 6</a></span>
<span class=normal><a href=#__codelineno-22-7> 7</a></span>
<span class=normal><a href=#__codelineno-22-8> 8</a></span>
<span class=normal><a href=#__codelineno-22-9> 9</a></span>
<span class=normal><a href=#__codelineno-22-10>10</a></span>
<span class=normal><a href=#__codelineno-22-11>11</a></span>
<span class=normal><a href=#__codelineno-22-12>12</a></span>
<span class=normal><a href=#__codelineno-22-13>13</a></span>
<span class=normal><a href=#__codelineno-22-14>14</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-22-1><a id=__codelineno-22-1 name=__codelineno-22-1></a>1. Open Sprite Atlas Generator
</span><span id=__span-22-2><a id=__codelineno-22-2 name=__codelineno-22-2></a>2. Click "Create New Config in 'Assets/Data'"
</span><span id=__span-22-3><a id=__codelineno-22-3 name=__codelineno-22-3></a>3. Configure the new atlas:
</span><span id=__span-22-4><a id=__codelineno-22-4 name=__codelineno-22-4></a> a. Set output name and directory
</span><span id=__span-22-5><a id=__codelineno-22-5 name=__codelineno-22-5></a> b. Click "Add New Source Folder Entry"
</span><span id=__span-22-6><a id=__codelineno-22-6 name=__codelineno-22-6></a> c. Select folder containing sprites
</span><span id=__span-22-7><a id=__codelineno-22-7 name=__codelineno-22-7></a> d. Add regex patterns (e.g., "^character_.*\\.png$")
</span><span id=__span-22-8><a id=__codelineno-22-8 name=__codelineno-22-8></a> e. Or/and add labels for filtering
</span><span id=__span-22-9><a id=__codelineno-22-9 name=__codelineno-22-9></a> f. Configure packing settings (texture size, padding, etc.)
</span><span id=__span-22-10><a id=__codelineno-22-10 name=__codelineno-22-10></a>4. Click "Scan Folders for '[config name]'"
</span><span id=__span-22-11><a id=__codelineno-22-11 name=__codelineno-22-11></a>5. Review sprites to add/remove
</span><span id=__span-22-12><a id=__codelineno-22-12 name=__codelineno-22-12></a>6. Click "Add X Sprites" to populate the list
</span><span id=__span-22-13><a id=__codelineno-22-13 name=__codelineno-22-13></a>7. Click "Generate/Update '[atlas name].spriteatlas' ONLY"
</span><span id=__span-22-14><a id=__codelineno-22-14 name=__codelineno-22-14></a>8. Click "Pack All Generated Sprite Atlases" to pack textures
</span></code></pre></div></td></tr></table></div> <p><strong>Example Configurations:</strong></p> <p><strong>Character Sprites Atlas:</strong></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-23-1>1</a></span>
<span class=normal><a href=#__codelineno-23-2>2</a></span>
<span class=normal><a href=#__codelineno-23-3>3</a></span>
<span class=normal><a href=#__codelineno-23-4>4</a></span>
<span class=normal><a href=#__codelineno-23-5>5</a></span>
<span class=normal><a href=#__codelineno-23-6>6</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-23-1><a id=__codelineno-23-1 name=__codelineno-23-1></a>folderPath: Assets/Sprites/Characters
</span><span id=__span-23-2><a id=__codelineno-23-2 name=__codelineno-23-2></a>selectionMode: Regex
</span><span id=__span-23-3><a id=__codelineno-23-3 name=__codelineno-23-3></a>regexes: ["^player_.*\\.png$", ".*_idle_.*"]
</span><span id=__span-23-4><a id=__codelineno-23-4 name=__codelineno-23-4></a>maxTextureSize: 2048
</span><span id=__span-23-5><a id=__codelineno-23-5 name=__codelineno-23-5></a>padding: 4
</span><span id=__span-23-6><a id=__codelineno-23-6 name=__codelineno-23-6></a>compression: CompressedHQ
</span></code></pre></div></td></tr></table></div> <p><strong>UI Icons by Label:</strong></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-24-1>1</a></span>
<span class=normal><a href=#__codelineno-24-2>2</a></span>
<span class=normal><a href=#__codelineno-24-3>3</a></span>
<span class=normal><a href=#__codelineno-24-4>4</a></span>
<span class=normal><a href=#__codelineno-24-5>5</a></span>
<span class=normal><a href=#__codelineno-24-6>6</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-24-1><a id=__codelineno-24-1 name=__codelineno-24-1></a>folderPath: Assets/Sprites/UI
</span><span id=__span-24-2><a id=__codelineno-24-2 name=__codelineno-24-2></a>selectionMode: Labels
</span><span id=__span-24-3><a id=__codelineno-24-3 name=__codelineno-24-3></a>labelSelectionMode: AnyOf
</span><span id=__span-24-4><a id=__codelineno-24-4 name=__codelineno-24-4></a>labels: ["icon", "ui"]
</span><span id=__span-24-5><a id=__codelineno-24-5 name=__codelineno-24-5></a>maxTextureSize: 1024
</span><span id=__span-24-6><a id=__codelineno-24-6 name=__codelineno-24-6></a>padding: 2
</span></code></pre></div></td></tr></table></div> <p><strong>Combined Regex + Labels:</strong></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-25-1>1</a></span>
<span class=normal><a href=#__codelineno-25-2>2</a></span>
<span class=normal><a href=#__codelineno-25-3>3</a></span>
<span class=normal><a href=#__codelineno-25-4>4</a></span>
<span class=normal><a href=#__codelineno-25-5>5</a></span>
<span class=normal><a href=#__codelineno-25-6>6</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-25-1><a id=__codelineno-25-1 name=__codelineno-25-1></a>folderPath: Assets/Sprites/Effects
</span><span id=__span-25-2><a id=__codelineno-25-2 name=__codelineno-25-2></a>selectionMode: Regex | Labels
</span><span id=__span-25-3><a id=__codelineno-25-3 name=__codelineno-25-3></a>regexes: ["^vfx_.*"]
</span><span id=__span-25-4><a id=__codelineno-25-4 name=__codelineno-25-4></a>labels: ["particle"]
</span><span id=__span-25-5><a id=__codelineno-25-5 name=__codelineno-25-5></a>regexAndTagLogic: And
</span><span id=__span-25-6><a id=__codelineno-25-6 name=__codelineno-25-6></a>maxTextureSize: 2048
</span></code></pre></div></td></tr></table></div> <p><strong>Advanced Features:</strong></p> <p><strong>Scan and Preview:</strong></p> <ul> <li>Shows the exact sprite count that will be added/removed</li> <li>Prevents accidental overwrites</li> <li>Displays current vs. scanned sprite lists</li> </ul> <p><strong>Source Sprite Utilities:</strong></p> <ul> <li>"Force Uncompressed for X Source Sprites" button</li> <li>Sets source sprites to uncompressed (RGBA32/RGB24)</li> <li>Disables crunch compression on sources</li> <li>Ensures maximum quality before atlas packing</li> </ul> <p><strong>Batch Operations:</strong></p> <ul> <li>"Generate/Update All .spriteatlas Assets" - processes all configs</li> <li>"Pack All Generated Sprite Atlases" - packs all atlases in the project</li> <li>Progress bars for long operations</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Managing large sprite collections</li> <li>Automating sprite atlas creation</li> <li>Consistent atlas configuration across the team</li> <li>Dynamic sprite selection based on naming conventions</li> <li>Organizing sprites by labels/tags</li> <li>Build pipeline atlas generation</li> </ul> <p><strong>Tips:</strong></p> <ul> <li>Use regex for consistent naming patterns</li> <li>Combine multiple source folders for complex selections</li> <li>Test regex patterns with "Scan Folders" before generating</li> <li>Keep source sprites uncompressed for the best atlas quality</li> <li>Use labels for cross-folder sprite grouping</li> <li>Regular expressions use case-insensitive matching</li> </ul> <p><strong>Common Issues:</strong></p> <ul> <li><strong>No sprites found:</strong> Check regex patterns and folder paths</li> <li><strong>Sprites not packing:</strong> Run "Pack All Generated Sprite Atlases"</li> <li><strong>Quality issues:</strong> Use "Force Uncompressed" on source sprites</li> <li><strong>Regex errors:</strong> Validate patterns (will log specific errors)</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Sprite Atlas Generator window showing regex configuration" src=../../../images/editor-tools/sprite-atlas-generator.png></p> <p><em>Sprite Atlas Generator with regex-based sprite selection and packing settings</em></p> <p><img alt="Sprite Atlas Generator scan results showing sprites to add" src=../../../images/editor-tools/sprite-atlas-generator-scan.gif></p> <p><em>Scanning folders and previewing which sprites will be added to the atlas</em></p> </blockquote> <hr> <p><a id=validation--quality-tools></a> <a id=validation-quality-tools></a></p> <h2 id=validation-quality-tools>Validation & Quality Tools<a class=headerlink href=#validation-quality-tools title="Permanent link">¶</a></h2> <h3 id=prefab-checker>Prefab Checker<a class=headerlink href=#prefab-checker title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Prefab Checker</code></p> <p><strong>Purpose:</strong> Comprehensive prefab validation to detect configuration issues before runtime.</p> <p><strong>Validation Checks:</strong></p> <table> <thead> <tr> <th>Check</th> <th>Description</th> <th>Severity</th> </tr> </thead> <tbody> <tr> <td><strong>Missing Scripts</strong></td> <td>Detects broken MonoBehaviour references</td> <td>Critical</td> </tr> <tr> <td><strong>Nulls in Lists/Arrays</strong></td> <td>Finds null elements in serialized collections</td> <td>High</td> </tr> <tr> <td><strong>Missing Required Components</strong></td> <td>Validates [RequireComponent] dependencies</td> <td>Critical</td> </tr> <tr> <td><strong>Empty String Fields</strong></td> <td>Identifies unset string fields</td> <td>Medium</td> </tr> <tr> <td><strong>Null Object References</strong></td> <td>Finds unassigned UnityEngine.Object fields</td> <td>High</td> </tr> <tr> <td><strong>Only if [ValidateAssignment]</strong></td> <td>Restricts null checks to annotated fields</td> <td>Configurable</td> </tr> <tr> <td><strong>Disabled Root GameObject</strong></td> <td>Flags inactive prefab roots</td> <td>Medium</td> </tr> <tr> <td><strong>Disabled Components</strong></td> <td>Reports disabled Behaviour components</td> <td>Low</td> </tr> </tbody> </table> <p><strong>Typical Validation Workflow:</strong></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-26-1>1</a></span>
<span class=normal><a href=#__codelineno-26-2>2</a></span>
<span class=normal><a href=#__codelineno-26-3>3</a></span>
<span class=normal><a href=#__codelineno-26-4>4</a></span>
<span class=normal><a href=#__codelineno-26-5>5</a></span>
<span class=normal><a href=#__codelineno-26-6>6</a></span>
<span class=normal><a href=#__codelineno-26-7>7</a></span>
<span class=normal><a href=#__codelineno-26-8>8</a></span>
<span class=normal><a href=#__codelineno-26-9>9</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-26-1><a id=__codelineno-26-1 name=__codelineno-26-1></a>// Before committing prefab changes:
</span><span id=__span-26-2><a id=__codelineno-26-2 name=__codelineno-26-2></a>1. Open Prefab Checker
</span><span id=__span-26-3><a id=__codelineno-26-3 name=__codelineno-26-3></a>2. Enable relevant checks (especially Missing Scripts, Required Components)
</span><span id=__span-26-4><a id=__codelineno-26-4 name=__codelineno-26-4></a>3. Add "Assets/Prefabs" folder
</span><span id=__span-26-5><a id=__codelineno-26-5 name=__codelineno-26-5></a>4. Click "Run Checks"
</span><span id=__span-26-6><a id=__codelineno-26-6 name=__codelineno-26-6></a>5. Review console output (click to select problematic prefabs)
</span><span id=__span-26-7><a id=__codelineno-26-7 name=__codelineno-26-7></a>6. Fix reported issues
</span><span id=__span-26-8><a id=__codelineno-26-8 name=__codelineno-26-8></a>7. Re-run checks to verify
</span><span id=__span-26-9><a id=__codelineno-26-9 name=__codelineno-26-9></a>8. Commit changes
</span></code></pre></div></td></tr></table></div> <p><strong>CI/CD Integration:</strong></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-27-1>1</a></span>
<span class=normal><a href=#__codelineno-27-2>2</a></span>
<span class=normal><a href=#__codelineno-27-3>3</a></span>
<span class=normal><a href=#__codelineno-27-4>4</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-27-1><a id=__codelineno-27-1 name=__codelineno-27-1></a>// Can be scripted for automated builds
</span><span id=__span-27-2><a id=__codelineno-27-2 name=__codelineno-27-2></a>- Run validation on changed prefab folders
</span><span id=__span-27-3><a id=__codelineno-27-3 name=__codelineno-27-3></a>- Parse console output for errors
</span><span id=__span-27-4><a id=__codelineno-27-4 name=__codelineno-27-4></a>- Fail build if critical issues found
</span></code></pre></div></td></tr></table></div> <p><strong>Best Practices:</strong></p> <ul> <li>Use <code>[ValidateAssignment]</code> attribute on critical fields</li> <li>Run checks before committing prefab changes</li> <li>Enable "Only if [ValidateAssignment]" to reduce noise</li> <li>Fix "Missing Required Components" errors immediately</li> <li>Schedule regular validation runs</li> </ul> <p><strong>Performance:</strong> Uses cached reflection for fast repeated checks.</p> <p><strong>Best For:</strong></p> <ul> <li>Pre-build validation</li> <li>Code review assistance</li> <li>Team onboarding with prefab standards</li> <li>Migration validation after Unity upgrades</li> <li>Continuous integration health checks</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Prefab Checker window showing validation check options" src=../../../images/editor-tools/prefab-checker.png></p> <p><em>Prefab Checker with configurable validation checks and folder selection</em></p> <p><img alt="Prefab Checker results in console showing detected issues" src=../../../images/editor-tools/prefab-checker-results.png></p> <p><em>Console output showing detected prefab issues with clickable links</em></p> </blockquote> <hr> <h3 id=unity-method-analyzer>Unity Method Analyzer<a class=headerlink href=#unity-method-analyzer title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Unity Method Analyzer</code></p> <p><strong>Purpose:</strong> Detect inheritance issues and Unity lifecycle method errors across your entire C# codebase before they cause runtime bugs.</p> <p><strong>📖 Full Documentation:</strong> <a href=../unity-method-analyzer/ >Unity Method Analyzer Guide</a></p> <p><strong>Key Features:</strong></p> <ul> <li><strong>Static analysis</strong> without external dependencies (no Roslyn required)</li> <li><strong>Parallel scanning</strong> of thousands of files</li> <li><strong>Multiple issue categories</strong>: Unity Lifecycle, Unity Inheritance, General Inheritance</li> <li><strong>Five severity levels</strong>: Critical, High, Medium, Low, Info</li> <li><strong>Export options</strong>: JSON and Markdown for CI/CD integration</li> <li><strong>Flexible filtering</strong>: By severity, category, or free-text search</li> </ul> <p><strong>What It Detects:</strong></p> <table> <thead> <tr> <th>Issue Type</th> <th>Example</th> </tr> </thead> <tbody> <tr> <td>Missing <code>override</code> keyword</td> <td>Hiding base method instead of overriding</td> </tr> <tr> <td>Wrong Unity method signature</td> <td><code>OnCollisionEnter(Collider c)</code> instead of <code>OnCollisionEnter(Collision c)</code></td> </tr> <tr> <td>Shadowed lifecycle methods</td> <td>Both base and derived class have <code>private void Start()</code></td> </tr> <tr> <td>Static lifecycle methods</td> <td><code>static void Awake()</code> won't be called by Unity</td> </tr> </tbody> </table> <p><strong>Quick Start:</strong></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-28-1>1</a></span>
<span class=normal><a href=#__codelineno-28-2>2</a></span>
<span class=normal><a href=#__codelineno-28-3>3</a></span>
<span class=normal><a href=#__codelineno-28-4>4</a></span>
<span class=normal><a href=#__codelineno-28-5>5</a></span>
<span class=normal><a href=#__codelineno-28-6>6</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-28-1><a id=__codelineno-28-1 name=__codelineno-28-1></a>1. Open Unity Method Analyzer
</span><span id=__span-28-2><a id=__codelineno-28-2 name=__codelineno-28-2></a>2. Add source directories (e.g., Assets/Scripts)
</span><span id=__span-28-3><a id=__codelineno-28-3 name=__codelineno-28-3></a>3. Click "Analyze Code"
</span><span id=__span-28-4><a id=__codelineno-28-4 name=__codelineno-28-4></a>4. Review issues grouped by file, severity, or category
</span><span id=__span-28-5><a id=__codelineno-28-5 name=__codelineno-28-5></a>5. Double-click to navigate to problematic code
</span><span id=__span-28-6><a id=__codelineno-28-6 name=__codelineno-28-6></a>6. Export report for team review or CI/CD
</span></code></pre></div></td></tr></table></div> <blockquote> <p><strong>Visual Demo</strong></p> <p><img alt="Unity Method Analyzer window showing detected issues" src=../../../images/editor-tools/unity-method-analyzer/analyzer-overview.png></p> <p><em>The analyzer scanning a project and displaying categorized issues</em></p> </blockquote> <p><strong>Suppressing Warnings:</strong></p> <p>For test code or intentional patterns, use <code>[SuppressAnalyzer]</code>:</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-29-1>1</a></span>
<span class=normal><a href=#__codelineno-29-2>2</a></span>
<span class=normal><a href=#__codelineno-29-3>3</a></span>
<span class=normal><a href=#__codelineno-29-4>4</a></span>
<span class=normal><a href=#__codelineno-29-5>5</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-29-1><a id=__codelineno-29-1 name=__codelineno-29-1></a><span class=na>[SuppressAnalyzer("Test fixture for analyzer validation")]</span>
</span><span id=__span-29-2><a id=__codelineno-29-2 name=__codelineno-29-2></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>TestClassWithIntentionalIssues</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>BaseClass</span>
</span><span id=__span-29-3><a id=__codelineno-29-3 name=__codelineno-29-3></a><span class=p>{</span>
</span><span id=__span-29-4><a id=__codelineno-29-4 name=__codelineno-29-4></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>HiddenMethod</span><span class=p>()</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span><span class=w> </span><span class=c1>// Won't trigger warning</span>
</span><span id=__span-29-5><a id=__codelineno-29-5 name=__codelineno-29-5></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Pre-commit code validation</li> <li>Code review assistance</li> <li>CI/CD quality gates</li> <li>Team onboarding</li> <li>Post-refactoring verification</li> </ul> <hr> <h2 id=custom-component-editors>Custom Component Editors<a class=headerlink href=#custom-component-editors title="Permanent link">¶</a></h2> <p>These custom inspectors enhance Unity components with additional functionality and convenience features.</p> <h3 id=matchcollidertosprite-editor>MatchColliderToSprite Editor<a class=headerlink href=#matchcollidertosprite-editor title="Permanent link">¶</a></h3> <p><strong>Component:</strong> <code>MatchColliderToSprite</code></p> <p><strong>Purpose:</strong> Provides a button in the inspector to manually trigger collider-to-sprite matching.</p> <p><strong>Features:</strong></p> <ul> <li>"MatchColliderToSprite" button in inspector</li> <li>Manually invoke <code>OnValidate()</code> to update collider</li> <li>Useful when automatic updates don't trigger</li> </ul> <p><strong>When to Use:</strong></p> <ul> <li>After changing sprite at runtime</li> <li>When collider doesn't match sprite automatically</li> <li>Manual override of collider shape</li> </ul> <hr> <h3 id=polygoncollider2doptimizer-editor>PolygonCollider2DOptimizer Editor<a class=headerlink href=#polygoncollider2doptimizer-editor title="Permanent link">¶</a></h3> <p><strong>Component:</strong> <code>PolygonCollider2DOptimizer</code></p> <p><strong>Purpose:</strong> Custom inspector for optimizing PolygonCollider2D point counts with configurable tolerance.</p> <p><strong>Features:</strong></p> <ul> <li><strong>tolerance:</strong> Adjustable simplification tolerance</li> <li><strong>Optimize button:</strong> Manually trigger polygon simplification</li> <li>Reduces collider complexity while maintaining shape</li> </ul> <p><strong>How It Works:</strong></p> <ol> <li>Adjust tolerance slider (lower = more accurate, higher = simpler)</li> <li>Click "Optimize" to simplify polygon points</li> <li>Collider updates with a reduced point count</li> </ol> <p><strong>Best For:</strong></p> <ul> <li>Reducing physics performance overhead</li> <li>Simplifying complex sprite colliders</li> <li>Balancing accuracy vs. performance</li> <li>Editor-time optimization of imported sprites</li> </ul> <p><strong>Tolerance Guide:</strong></p> <ul> <li>0.0 - 0.1: High accuracy, minimal simplification</li> <li>0.1 - 0.5: Balanced (recommended)</li> <li>0.5 - 2.0: Aggressive simplification</li> <li>2.0+: Maximum simplification (may lose detail)</li> </ul> <hr> <h3 id=enhancedimage-editor>EnhancedImage Editor<a class=headerlink href=#enhancedimage-editor title="Permanent link">¶</a></h3> <p><strong>Component:</strong> <code>EnhancedImage</code> (extends Unity's Image)</p> <p><strong>Purpose:</strong> Extended inspector for EnhancedImage with HDR color support and shape mask configuration.</p> <p><strong>Additional Properties:</strong></p> <ul> <li><strong>HDR Color:</strong> High dynamic range color multiplication</li> <li><strong>Shape Mask:</strong> Texture2D for masking/shaping the image</li> <li><strong>Material Auto-Fix:</strong> Detects and fixes incorrect material assignment</li> </ul> <p><strong>Features:</strong></p> <p><strong>Material Detection:</strong></p> <ul> <li>Warns if using "Default UI Material"</li> <li>"Incorrect Material Detected - Try Fix?" button (yellow)</li> <li>Automatically finds and applies the correct BackgroundMask material</li> <li>Material path: <code>Shaders/Materials/BackgroundMask-Material.mat</code></li> </ul> <p><strong>Shape Mask:</strong></p> <ul> <li>Requires shader with <code>_ShapeMask</code> texture2D property</li> <li>Allows complex masking effects</li> <li>Integrates with a custom shader system</li> </ul> <p><strong>HDR Color:</strong></p> <ul> <li>Color picker with HDR support</li> <li>Intensity values > 1.0 for bloom/glow effects</li> <li>Works with post-processing</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>UI elements requiring HDR effects</li> <li>Masked UI images</li> <li>Custom-shaped UI elements</li> <li>Material-based UI effects</li> </ul> <p><strong>Workflow:</strong></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-30-1>1</a></span>
<span class=normal><a href=#__codelineno-30-2>2</a></span>
<span class=normal><a href=#__codelineno-30-3>3</a></span>
<span class=normal><a href=#__codelineno-30-4>4</a></span>
<span class=normal><a href=#__codelineno-30-5>5</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-30-1><a id=__codelineno-30-1 name=__codelineno-30-1></a>1. Add EnhancedImage component to UI GameObject
</span><span id=__span-30-2><a id=__codelineno-30-2 name=__codelineno-30-2></a>2. If yellow "Fix Material" button appears, click it
</span><span id=__span-30-3><a id=__codelineno-30-3 name=__codelineno-30-3></a>3. Configure HDR Color for glow/intensity
</span><span id=__span-30-4><a id=__codelineno-30-4 name=__codelineno-30-4></a>4. Assign Shape Mask texture if needed
</span><span id=__span-30-5><a id=__codelineno-30-5 name=__codelineno-30-5></a>5. Shader must expose _ShapeMask property
</span></code></pre></div></td></tr></table></div> <p><strong>Icon Customization:</strong></p> <ul> <li>Automatically uses Image icon in project/hierarchy</li> <li>Seamless integration with standard Unity UI</li> </ul> <hr> <p><a id=property-drawers--attributes></a> <a id=property-drawers-attributes></a></p> <h2 id=property-drawers-attributes>Property Drawers & Attributes<a class=headerlink href=#property-drawers-attributes title="Permanent link">¶</a></h2> <p>Custom property drawers enhance the inspector with conditional display, validation, and specialized input fields.</p> <p><a id=winlineeditor-property-drawer></a></p> <h3 id=winlineeditor-property-drawer>WInLineEditor Property Drawer<a class=headerlink href=#winlineeditor-property-drawer title="Permanent link">¶</a></h3> <p><strong>Attribute:</strong> <code>[WInLineEditor]</code></p> <p><strong>Purpose:</strong> Embed the inspector for object references (ScriptableObjects, Materials, Components, Textures, etc.) directly below the field so you can edit configuration without losing context.</p> <p><strong>Modes (<code>WInLineEditorMode</code>):</strong></p> <ul> <li><code>AlwaysExpanded</code> — always draws the inline inspector.</li> <li><code>FoldoutExpanded</code> — shows a foldout that starts expanded.</li> <li><code>FoldoutCollapsed</code> — shows a foldout that starts collapsed.</li> </ul> <p><strong>Options:</strong> tune the presentation with constructor parameters:</p> <ul> <li><code>inspectorHeight</code> (default 200, min 160) — vertical space reserved for the inspector body.</li> <li><code>drawObjectField</code> — hide or show the object picker next to the label.</li> <li><code>drawHeader</code> — draw a bold header with a ping button (ping is shown only while a Project window tab is visible).</li> <li><code>drawPreview</code> & <code>previewHeight</code> — render the preview area when the target editor exposes one.</li> <li><code>enableScrolling</code> — wrap the inspector body in a scroll view for long inspectors.</li> <li><code>minInspectorWidth</code> (default 520) — when the content area is narrower than this width, a horizontal scrollbar appears; set to <code>0</code> to disable the safeguard.</li> </ul> <blockquote> <p>WInLineEditor respects the <strong>Inline Editors</strong> defaults inside Unity Helpers Settings. Leave the <code>mode</code> argument unset to inherit the global foldout behaviour, or supply a <code>WInLineEditorMode</code> per field to override it. By default, Inline Editors start collapsed to mirror collapsible WGroups, so <code>[WInLineEditor]</code> without a mode expands only when you opt into a different setting.</p> </blockquote> <p><strong>Examples:</strong></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-31-1> 1</a></span>
<span class=normal><a href=#__codelineno-31-2> 2</a></span>
<span class=normal><a href=#__codelineno-31-3> 3</a></span>
<span class=normal><a href=#__codelineno-31-4> 4</a></span>
<span class=normal><a href=#__codelineno-31-5> 5</a></span>
<span class=normal><a href=#__codelineno-31-6> 6</a></span>
<span class=normal><a href=#__codelineno-31-7> 7</a></span>
<span class=normal><a href=#__codelineno-31-8> 8</a></span>
<span class=normal><a href=#__codelineno-31-9> 9</a></span>
<span class=normal><a href=#__codelineno-31-10>10</a></span>
<span class=normal><a href=#__codelineno-31-11>11</a></span>
<span class=normal><a href=#__codelineno-31-12>12</a></span>
<span class=normal><a href=#__codelineno-31-13>13</a></span>
<span class=normal><a href=#__codelineno-31-14>14</a></span>
<span class=normal><a href=#__codelineno-31-15>15</a></span>
<span class=normal><a href=#__codelineno-31-16>16</a></span>
<span class=normal><a href=#__codelineno-31-17>17</a></span>
<span class=normal><a href=#__codelineno-31-18>18</a></span>
<span class=normal><a href=#__codelineno-31-19>19</a></span>
<span class=normal><a href=#__codelineno-31-20>20</a></span>
<span class=normal><a href=#__codelineno-31-21>21</a></span>
<span class=normal><a href=#__codelineno-31-22>22</a></span>
<span class=normal><a href=#__codelineno-31-23>23</a></span>
<span class=normal><a href=#__codelineno-31-24>24</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-31-1><a id=__codelineno-31-1 name=__codelineno-31-1></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>AbilityConfig</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>ScriptableObject</span>
</span><span id=__span-31-2><a id=__codelineno-31-2 name=__codelineno-31-2></a><span class=p>{</span>
</span><span id=__span-31-3><a id=__codelineno-31-3 name=__codelineno-31-3></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-31-4><a id=__codelineno-31-4 name=__codelineno-31-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>cooldown</span><span class=p>;</span>
</span><span id=__span-31-5><a id=__codelineno-31-5 name=__codelineno-31-5></a><span class=p>}</span>
</span><span id=__span-31-6><a id=__codelineno-31-6 name=__codelineno-31-6></a>
</span><span id=__span-31-7><a id=__codelineno-31-7 name=__codelineno-31-7></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>AbilityDatabase</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>ScriptableObject</span>
</span><span id=__span-31-8><a id=__codelineno-31-8 name=__codelineno-31-8></a><span class=p>{</span>
</span><span id=__span-31-9><a id=__codelineno-31-9 name=__codelineno-31-9></a><span class=w> </span><span class=na>[WInLineEditor]</span><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>AbilityConfig</span><span class=w> </span><span class=n>defaultConfig</span><span class=p>;</span>
</span><span id=__span-31-10><a id=__codelineno-31-10 name=__codelineno-31-10></a>
</span><span id=__span-31-11><a id=__codelineno-31-11 name=__codelineno-31-11></a><span class=w> </span><span class=na>[WInLineEditor(</span>
</span><span id=__span-31-12><a id=__codelineno-31-12 name=__codelineno-31-12></a><span class=na> WInLineEditorMode.FoldoutCollapsed,</span>
</span><span id=__span-31-13><a id=__codelineno-31-13 name=__codelineno-31-13></a><span class=na> inspectorHeight: 180f,</span>
</span><span id=__span-31-14><a id=__codelineno-31-14 name=__codelineno-31-14></a><span class=na> drawPreview: true,</span>
</span><span id=__span-31-15><a id=__codelineno-31-15 name=__codelineno-31-15></a><span class=na> previewHeight: 64f)]</span>
</span><span id=__span-31-16><a id=__codelineno-31-16 name=__codelineno-31-16></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>Texture2D</span><span class=w> </span><span class=n>abilityIcon</span><span class=p>;</span>
</span><span id=__span-31-17><a id=__codelineno-31-17 name=__codelineno-31-17></a>
</span><span id=__span-31-18><a id=__codelineno-31-18 name=__codelineno-31-18></a><span class=w> </span><span class=na>[WInLineEditor(</span>
</span><span id=__span-31-19><a id=__codelineno-31-19 name=__codelineno-31-19></a><span class=na> WInLineEditorMode.AlwaysExpanded,</span>
</span><span id=__span-31-20><a id=__codelineno-31-20 name=__codelineno-31-20></a><span class=na> inspectorHeight: 220f,</span>
</span><span id=__span-31-21><a id=__codelineno-31-21 name=__codelineno-31-21></a><span class=na> drawObjectField: false,</span>
</span><span id=__span-31-22><a id=__codelineno-31-22 name=__codelineno-31-22></a><span class=na> enableScrolling: false)]</span>
</span><span id=__span-31-23><a id=__codelineno-31-23 name=__codelineno-31-23></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>AbilityConfig</span><span class=w> </span><span class=n>sharedTemplate</span><span class=p>;</span>
</span><span id=__span-31-24><a id=__codelineno-31-24 name=__codelineno-31-24></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Features:</strong></p> <ul> <li>Bespoke implementation (no Odin dependency) tailored to the most common inline editing workflows.</li> <li>Reuses Unity’s native editors, respecting custom inspectors, validation, and undo.</li> <li>Optional scroll view that keeps large inspectors usable without stealing space from the parent inspector.</li> <li>Preview support for assets that implement <code>HasPreviewGUI</code>.</li> <li>Header includes a quick “Ping” button so you can jump to the asset whenever the Project window is visible.</li> <li>Smooth expand/collapse animations with configurable speed.</li> </ul> <p><strong>Animation Settings:</strong></p> <p>Foldout animations are controlled via Unity Helpers Settings (<code>Edit > Project Settings > Unity Helpers</code>):</p> <ul> <li><code>InlineEditorFoldoutTweenEnabled</code> — Enable/disable smooth expand/collapse animations (default: <code>true</code>)</li> <li><code>InlineEditorFoldoutSpeed</code> — Animation speed from 2.0 to 12.0 (default: <code>2.0</code>)</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-32-1> 1</a></span>
<span class=normal><a href=#__codelineno-32-2> 2</a></span>
<span class=normal><a href=#__codelineno-32-3> 3</a></span>
<span class=normal><a href=#__codelineno-32-4> 4</a></span>
<span class=normal><a href=#__codelineno-32-5> 5</a></span>
<span class=normal><a href=#__codelineno-32-6> 6</a></span>
<span class=normal><a href=#__codelineno-32-7> 7</a></span>
<span class=normal><a href=#__codelineno-32-8> 8</a></span>
<span class=normal><a href=#__codelineno-32-9> 9</a></span>
<span class=normal><a href=#__codelineno-32-10>10</a></span>
<span class=normal><a href=#__codelineno-32-11>11</a></span>
<span class=normal><a href=#__codelineno-32-12>12</a></span>
<span class=normal><a href=#__codelineno-32-13>13</a></span>
<span class=normal><a href=#__codelineno-32-14>14</a></span>
<span class=normal><a href=#__codelineno-32-15>15</a></span>
<span class=normal><a href=#__codelineno-32-16>16</a></span>
<span class=normal><a href=#__codelineno-32-17>17</a></span>
<span class=normal><a href=#__codelineno-32-18>18</a></span>
<span class=normal><a href=#__codelineno-32-19>19</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-32-1><a id=__codelineno-32-1 name=__codelineno-32-1></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-32-2><a id=__codelineno-32-2 name=__codelineno-32-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-32-3><a id=__codelineno-32-3 name=__codelineno-32-3></a>
</span><span id=__span-32-4><a id=__codelineno-32-4 name=__codelineno-32-4></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>AbilityConfig</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>ScriptableObject</span>
</span><span id=__span-32-5><a id=__codelineno-32-5 name=__codelineno-32-5></a><span class=p>{</span>
</span><span id=__span-32-6><a id=__codelineno-32-6 name=__codelineno-32-6></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>abilityName</span><span class=p>;</span>
</span><span id=__span-32-7><a id=__codelineno-32-7 name=__codelineno-32-7></a><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><span id=__span-32-8><a id=__codelineno-32-8 name=__codelineno-32-8></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>cooldown</span><span class=p>;</span>
</span><span id=__span-32-9><a id=__codelineno-32-9 name=__codelineno-32-9></a><span class=p>}</span>
</span><span id=__span-32-10><a id=__codelineno-32-10 name=__codelineno-32-10></a>
</span><span id=__span-32-11><a id=__codelineno-32-11 name=__codelineno-32-11></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>WInLineEditorExample</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-32-12><a id=__codelineno-32-12 name=__codelineno-32-12></a><span class=p>{</span>
</span><span id=__span-32-13><a id=__codelineno-32-13 name=__codelineno-32-13></a><span class=w> </span><span class=c1>// Animation applies to foldout modes only</span>
</span><span id=__span-32-14><a id=__codelineno-32-14 name=__codelineno-32-14></a><span class=w> </span><span class=na>[WInLineEditor(WInLineEditorMode.FoldoutCollapsed)]</span><span class=w> </span><span class=c1>// Animated</span>
</span><span id=__span-32-15><a id=__codelineno-32-15 name=__codelineno-32-15></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>AbilityConfig</span><span class=w> </span><span class=n>animatedFoldout</span><span class=p>;</span>
</span><span id=__span-32-16><a id=__codelineno-32-16 name=__codelineno-32-16></a>
</span><span id=__span-32-17><a id=__codelineno-32-17 name=__codelineno-32-17></a><span class=w> </span><span class=na>[WInLineEditor(WInLineEditorMode.AlwaysExpanded)]</span><span class=w> </span><span class=c1>// No animation (always visible)</span>
</span><span id=__span-32-18><a id=__codelineno-32-18 name=__codelineno-32-18></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>AbilityConfig</span><span class=w> </span><span class=n>alwaysVisible</span><span class=p>;</span>
</span><span id=__span-32-19><a id=__codelineno-32-19 name=__codelineno-32-19></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p><strong>See also:</strong> <a href=../../inspector/inspector-settings/#inline-editor-settings>Inspector Settings Reference</a> for complete settings documentation.</p> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="WInLineEditor showing embedded ScriptableObject inspector and expansion" src=../../../images/editor-tools/winlineeditor-expanded.gif></p> <p><em>WInLineEditor with embedded inspector for a ScriptableObject reference with foldout and collapse transitions</em></p> </blockquote> <hr> <h3 id=wshowif-property-drawer>WShowIf Property Drawer<a class=headerlink href=#wshowif-property-drawer title="Permanent link">¶</a></h3> <p><strong>Attribute:</strong> <code>[WShowIf]</code></p> <p><strong>Purpose:</strong> Conditionally show/hide fields in inspector based on boolean fields or enum values.</p> <p><strong>Syntax:</strong></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-33-1>1</a></span>
<span class=normal><a href=#__codelineno-33-2>2</a></span>
<span class=normal><a href=#__codelineno-33-3>3</a></span>
<span class=normal><a href=#__codelineno-33-4>4</a></span>
<span class=normal><a href=#__codelineno-33-5>5</a></span>
<span class=normal><a href=#__codelineno-33-6>6</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-33-1><a id=__codelineno-33-1 name=__codelineno-33-1></a><span class=na>[WShowIf(nameof(fieldName))]</span>
</span><span id=__span-33-2><a id=__codelineno-33-2 name=__codelineno-33-2></a><span class=na>[WShowIf(nameof(fieldName), inverse = true)]</span>
</span><span id=__span-33-3><a id=__codelineno-33-3 name=__codelineno-33-3></a><span class=na>[WShowIf(nameof(fieldName), expectedValues: new object[]</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value1</span><span class=p>,</span><span class=w> </span><span class=n>value2</span><span class=w> </span><span class=p>})]</span>
</span><span id=__span-33-4><a id=__codelineno-33-4 name=__codelineno-33-4></a><span class=na>[WShowIf(nameof(numericField), WShowIfComparison.GreaterThan, 10)]</span>
</span><span id=__span-33-5><a id=__codelineno-33-5 name=__codelineno-33-5></a><span class=na>[WShowIf(nameof(stringField), WShowIfComparison.IsNotNullOrEmpty)]</span>
</span><span id=__span-33-6><a id=__codelineno-33-6 name=__codelineno-33-6></a><span class=na>[WShowIf(nameof(parentField) + "." + nameof(ChildType.someFlag))]</span>
</span></code></pre></div></td></tr></table></div> <blockquote> <p><code>WShowIfComparison.Unknown</code> exists only for backward compatibility and is marked obsolete; always choose an explicit comparison mode.</p> </blockquote> <p><strong>Examples:</strong></p> <p><strong>Boolean Condition:</strong></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-34-1>1</a></span>
<span class=normal><a href=#__codelineno-34-2>2</a></span>
<span class=normal><a href=#__codelineno-34-3>3</a></span>
<span class=normal><a href=#__codelineno-34-4>4</a></span>
<span class=normal><a href=#__codelineno-34-5>5</a></span>
<span class=normal><a href=#__codelineno-34-6>6</a></span>
<span class=normal><a href=#__codelineno-34-7>7</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-34-1><a id=__codelineno-34-1 name=__codelineno-34-1></a><span class=k>public</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>enableFeature</span><span class=p>;</span>
</span><span id=__span-34-2><a id=__codelineno-34-2 name=__codelineno-34-2></a>
</span><span id=__span-34-3><a id=__codelineno-34-3 name=__codelineno-34-3></a><span class=na>[WShowIf(nameof(enableFeature))]</span>
</span><span id=__span-34-4><a id=__codelineno-34-4 name=__codelineno-34-4></a><span class=k>public</span><span class=w> </span><span class=kt>float</span><span class=w> </span><span class=n>featureIntensity</span><span class=p>;</span>
</span><span id=__span-34-5><a id=__codelineno-34-5 name=__codelineno-34-5></a>
</span><span id=__span-34-6><a id=__codelineno-34-6 name=__codelineno-34-6></a><span class=na>[WShowIf(nameof(enableFeature), inverse = true)]</span>
</span><span id=__span-34-7><a id=__codelineno-34-7 name=__codelineno-34-7></a><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>disabledMessage</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Enum Condition:</strong></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-35-1>1</a></span>
<span class=normal><a href=#__codelineno-35-2>2</a></span>
<span class=normal><a href=#__codelineno-35-3>3</a></span>
<span class=normal><a href=#__codelineno-35-4>4</a></span>
<span class=normal><a href=#__codelineno-35-5>5</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-35-1><a id=__codelineno-35-1 name=__codelineno-35-1></a><span class=k>public</span><span class=w> </span><span class=k>enum</span><span class=w> </span><span class=n>Mode</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>Simple</span><span class=p>,</span><span class=w> </span><span class=n>Advanced</span><span class=p>,</span><span class=w> </span><span class=n>Expert</span><span class=w> </span><span class=p>}</span>
</span><span id=__span-35-2><a id=__codelineno-35-2 name=__codelineno-35-2></a><span class=k>public</span><span class=w> </span><span class=n>Mode</span><span class=w> </span><span class=n>currentMode</span><span class=p>;</span>
</span><span id=__span-35-3><a id=__codelineno-35-3 name=__codelineno-35-3></a>
</span><span id=__span-35-4><a id=__codelineno-35-4 name=__codelineno-35-4></a><span class=na>[WShowIf(nameof(currentMode), expectedValues = new object[]</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>Mode</span><span class=p>.</span><span class=n>Advanced</span><span class=p>,</span><span class=w> </span><span class=n>Mode</span><span class=p>.</span><span class=n>Expert</span><span class=w> </span><span class=p>})]</span>
</span><span id=__span-35-5><a id=__codelineno-35-5 name=__codelineno-35-5></a><span class=k>public</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>advancedSetting</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Multiple Values:</strong></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-36-1> 1</a></span>
<span class=normal><a href=#__codelineno-36-2> 2</a></span>
<span class=normal><a href=#__codelineno-36-3> 3</a></span>
<span class=normal><a href=#__codelineno-36-4> 4</a></span>
<span class=normal><a href=#__codelineno-36-5> 5</a></span>
<span class=normal><a href=#__codelineno-36-6> 6</a></span>
<span class=normal><a href=#__codelineno-36-7> 7</a></span>
<span class=normal><a href=#__codelineno-36-8> 8</a></span>
<span class=normal><a href=#__codelineno-36-9> 9</a></span>
<span class=normal><a href=#__codelineno-36-10>10</a></span>
<span class=normal><a href=#__codelineno-36-11>11</a></span>
<span class=normal><a href=#__codelineno-36-12>12</a></span>
<span class=normal><a href=#__codelineno-36-13>13</a></span>
<span class=normal><a href=#__codelineno-36-14>14</a></span>
<span class=normal><a href=#__codelineno-36-15>15</a></span>
<span class=normal><a href=#__codelineno-36-16>16</a></span>
<span class=normal><a href=#__codelineno-36-17>17</a></span>
<span class=normal><a href=#__codelineno-36-18>18</a></span>
<span class=normal><a href=#__codelineno-36-19>19</a></span>
<span class=normal><a href=#__codelineno-36-20>20</a></span>
<span class=normal><a href=#__codelineno-36-21>21</a></span>
<span class=normal><a href=#__codelineno-36-22>22</a></span>
<span class=normal><a href=#__codelineno-36-23>23</a></span>
<span class=normal><a href=#__codelineno-36-24>24</a></span>
<span class=normal><a href=#__codelineno-36-25>25</a></span>
<span class=normal><a href=#__codelineno-36-26>26</a></span>
<span class=normal><a href=#__codelineno-36-27>27</a></span>
<span class=normal><a href=#__codelineno-36-28>28</a></span>
<span class=normal><a href=#__codelineno-36-29>29</a></span>
<span class=normal><a href=#__codelineno-36-30>30</a></span>
<span class=normal><a href=#__codelineno-36-31>31</a></span>
<span class=normal><a href=#__codelineno-36-32>32</a></span>
<span class=normal><a href=#__codelineno-36-33>33</a></span>
<span class=normal><a href=#__codelineno-36-34>34</a></span>
<span class=normal><a href=#__codelineno-36-35>35</a></span>
<span class=normal><a href=#__codelineno-36-36>36</a></span>
<span class=normal><a href=#__codelineno-36-37>37</a></span>
<span class=normal><a href=#__codelineno-36-38>38</a></span>
<span class=normal><a href=#__codelineno-36-39>39</a></span>
<span class=normal><a href=#__codelineno-36-40>40</a></span>
<span class=normal><a href=#__codelineno-36-41>41</a></span>
<span class=normal><a href=#__codelineno-36-42>42</a></span>
<span class=normal><a href=#__codelineno-36-43>43</a></span>
<span class=normal><a href=#__codelineno-36-44>44</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-36-1><a id=__codelineno-36-1 name=__codelineno-36-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-36-2><a id=__codelineno-36-2 name=__codelineno-36-2></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-36-3><a id=__codelineno-36-3 name=__codelineno-36-3></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine.Serialization</span><span class=p>;</span>
</span><span id=__span-36-4><a id=__codelineno-36-4 name=__codelineno-36-4></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-36-5><a id=__codelineno-36-5 name=__codelineno-36-5></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Core.DataStructure.Adapters</span><span class=p>;</span>
</span><span id=__span-36-6><a id=__codelineno-36-6 name=__codelineno-36-6></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Editor.Sprites</span><span class=p>;</span>
</span><span id=__span-36-7><a id=__codelineno-36-7 name=__codelineno-36-7></a>
</span><span id=__span-36-8><a id=__codelineno-36-8 name=__codelineno-36-8></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>SelectionModeExample</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-36-9><a id=__codelineno-36-9 name=__codelineno-36-9></a><span class=p>{</span>
</span><span id=__span-36-10><a id=__codelineno-36-10 name=__codelineno-36-10></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=w> </span><span class=n>selectionMode</span><span class=p>;</span>
</span><span id=__span-36-11><a id=__codelineno-36-11 name=__codelineno-36-11></a>
</span><span id=__span-36-12><a id=__codelineno-36-12 name=__codelineno-36-12></a><span class=w> </span><span class=na>[WShowIf(</span>
</span><span id=__span-36-13><a id=__codelineno-36-13 name=__codelineno-36-13></a><span class=na> nameof(selectionMode),</span>
</span><span id=__span-36-14><a id=__codelineno-36-14 name=__codelineno-36-14></a><span class=na> expectedValues = new object[]</span>
</span><span id=__span-36-15><a id=__codelineno-36-15 name=__codelineno-36-15></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-36-16><a id=__codelineno-36-16 name=__codelineno-36-16></a><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Regex</span><span class=p>,</span>
</span><span id=__span-36-17><a id=__codelineno-36-17 name=__codelineno-36-17></a><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Regex</span><span class=w> </span><span class=o>|</span><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Labels</span><span class=p>,</span>
</span><span id=__span-36-18><a id=__codelineno-36-18 name=__codelineno-36-18></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-36-19><a id=__codelineno-36-19 name=__codelineno-36-19></a><span class=w> </span><span class=p>)]</span>
</span><span id=__span-36-20><a id=__codelineno-36-20 name=__codelineno-36-20></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=kt>string</span><span class=o>></span><span class=w> </span><span class=n>regexPatterns</span><span class=p>;</span>
</span><span id=__span-36-21><a id=__codelineno-36-21 name=__codelineno-36-21></a>
</span><span id=__span-36-22><a id=__codelineno-36-22 name=__codelineno-36-22></a><span class=w> </span><span class=na>[FormerlySerializedAs("regexPatterns")]</span>
</span><span id=__span-36-23><a id=__codelineno-36-23 name=__codelineno-36-23></a><span class=w> </span><span class=na>[WShowIf(</span>
</span><span id=__span-36-24><a id=__codelineno-36-24 name=__codelineno-36-24></a><span class=na> nameof(selectionMode),</span>
</span><span id=__span-36-25><a id=__codelineno-36-25 name=__codelineno-36-25></a><span class=na> expectedValues = new object[]</span>
</span><span id=__span-36-26><a id=__codelineno-36-26 name=__codelineno-36-26></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-36-27><a id=__codelineno-36-27 name=__codelineno-36-27></a><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Regex</span><span class=p>,</span>
</span><span id=__span-36-28><a id=__codelineno-36-28 name=__codelineno-36-28></a><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Regex</span><span class=w> </span><span class=o>|</span><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Labels</span><span class=p>,</span>
</span><span id=__span-36-29><a id=__codelineno-36-29 name=__codelineno-36-29></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-36-30><a id=__codelineno-36-30 name=__codelineno-36-30></a><span class=w> </span><span class=p>)]</span>
</span><span id=__span-36-31><a id=__codelineno-36-31 name=__codelineno-36-31></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>SerializableHashSet</span><span class=o><</span><span class=kt>string</span><span class=o>></span><span class=w> </span><span class=n>regexPatterns1</span><span class=p>;</span>
</span><span id=__span-36-32><a id=__codelineno-36-32 name=__codelineno-36-32></a>
</span><span id=__span-36-33><a id=__codelineno-36-33 name=__codelineno-36-33></a><span class=w> </span><span class=na>[WShowIf(</span>
</span><span id=__span-36-34><a id=__codelineno-36-34 name=__codelineno-36-34></a><span class=na> nameof(selectionMode),</span>
</span><span id=__span-36-35><a id=__codelineno-36-35 name=__codelineno-36-35></a><span class=na> expectedValues = new object[]</span>
</span><span id=__span-36-36><a id=__codelineno-36-36 name=__codelineno-36-36></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-36-37><a id=__codelineno-36-37 name=__codelineno-36-37></a><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Regex</span><span class=p>,</span>
</span><span id=__span-36-38><a id=__codelineno-36-38 name=__codelineno-36-38></a><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Regex</span><span class=w> </span><span class=o>|</span><span class=w> </span><span class=n>SpriteSelectionMode</span><span class=p>.</span><span class=n>Labels</span><span class=p>,</span>
</span><span id=__span-36-39><a id=__codelineno-36-39 name=__codelineno-36-39></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-36-40><a id=__codelineno-36-40 name=__codelineno-36-40></a><span class=w> </span><span class=p>)]</span>
</span><span id=__span-36-41><a id=__codelineno-36-41 name=__codelineno-36-41></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>SerializableDictionary</span><span class=o><</span><span class=kt>int</span><span class=p>,</span><span class=w> </span><span class=kt>string</span><span class=o>></span><span class=w> </span><span class=n>regexPatterns2</span><span class=p>;</span>
</span><span id=__span-36-42><a id=__codelineno-36-42 name=__codelineno-36-42></a>
</span><span id=__span-36-43><a id=__codelineno-36-43 name=__codelineno-36-43></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>someOtherField</span><span class=p>;</span>
</span><span id=__span-36-44><a id=__codelineno-36-44 name=__codelineno-36-44></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Features:</strong></p> <ul> <li>Hides field when condition false (0 height)</li> <li>Supports boolean, enum, numeric, any <code>IComparable</code>/<code>IComparable<T></code> type, null, and string/collection comparisons</li> <li>Allows referencing nested paths, properties, and parameterless methods</li> <li><code>inverse</code> parameter inverts any comparison result</li> <li><code>expectedValues</code> (or params arguments) for equality checks without manual arrays</li> <li>Falls back to reflection for non-SerializedProperty fields</li> <li>Cached reflection for performance</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Conditional inspector fields</li> <li>Reducing inspector clutter</li> <li>Mode-based configuration UI</li> <li>Complex nested settings</li> </ul> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="WShowIf showing field visibility changing based on toggle" src=../../../images/editor-tools/wshowif-boolean.gif></p> <p><em>Field appears/disappears based on enum toggle state</em></p> </blockquote> <hr> <h3 id=stringinlist-property-drawer>StringInList Property Drawer<a class=headerlink href=#stringinlist-property-drawer title="Permanent link">¶</a></h3> <p><strong>Attribute:</strong> <code>[StringInList]</code></p> <p><strong>Purpose:</strong> Display string or int fields as dropdown with predefined options.</p> <p><strong>Syntax:</strong></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-37-1> 1</a></span>
<span class=normal><a href=#__codelineno-37-2> 2</a></span>
<span class=normal><a href=#__codelineno-37-3> 3</a></span>
<span class=normal><a href=#__codelineno-37-4> 4</a></span>
<span class=normal><a href=#__codelineno-37-5> 5</a></span>
<span class=normal><a href=#__codelineno-37-6> 6</a></span>
<span class=normal><a href=#__codelineno-37-7> 7</a></span>
<span class=normal><a href=#__codelineno-37-8> 8</a></span>
<span class=normal><a href=#__codelineno-37-9> 9</a></span>
<span class=normal><a href=#__codelineno-37-10>10</a></span>
<span class=normal><a href=#__codelineno-37-11>11</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-37-1><a id=__codelineno-37-1 name=__codelineno-37-1></a><span class=c1>// Static array</span>
</span><span id=__span-37-2><a id=__codelineno-37-2 name=__codelineno-37-2></a><span class=na>[StringInList("Option1", "Option2", "Option3")]</span>
</span><span id=__span-37-3><a id=__codelineno-37-3 name=__codelineno-37-3></a><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>selectedOption</span><span class=p>;</span>
</span><span id=__span-37-4><a id=__codelineno-37-4 name=__codelineno-37-4></a>
</span><span id=__span-37-5><a id=__codelineno-37-5 name=__codelineno-37-5></a><span class=c1>// Method reference</span>
</span><span id=__span-37-6><a id=__codelineno-37-6 name=__codelineno-37-6></a><span class=na>[StringInList(typeof(MyClass), nameof(MyClass.GetOptions))]</span>
</span><span id=__span-37-7><a id=__codelineno-37-7 name=__codelineno-37-7></a><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>dynamicOption</span><span class=p>;</span>
</span><span id=__span-37-8><a id=__codelineno-37-8 name=__codelineno-37-8></a>
</span><span id=__span-37-9><a id=__codelineno-37-9 name=__codelineno-37-9></a><span class=c1>// With int field</span>
</span><span id=__span-37-10><a id=__codelineno-37-10 name=__codelineno-37-10></a><span class=na>[StringInList("Low", "Medium", "High")]</span>
</span><span id=__span-37-11><a id=__codelineno-37-11 name=__codelineno-37-11></a><span class=k>public</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>priorityIndex</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Dynamic Options Example:</strong></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-38-1>1</a></span>
<span class=normal><a href=#__codelineno-38-2>2</a></span>
<span class=normal><a href=#__codelineno-38-3>3</a></span>
<span class=normal><a href=#__codelineno-38-4>4</a></span>
<span class=normal><a href=#__codelineno-38-5>5</a></span>
<span class=normal><a href=#__codelineno-38-6>6</a></span>
<span class=normal><a href=#__codelineno-38-7>7</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-38-1><a id=__codelineno-38-1 name=__codelineno-38-1></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Core.Helper</span><span class=p>;</span>
</span><span id=__span-38-2><a id=__codelineno-38-2 name=__codelineno-38-2></a>
</span><span id=__span-38-3><a id=__codelineno-38-3 name=__codelineno-38-3></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>MySettings</span>
</span><span id=__span-38-4><a id=__codelineno-38-4 name=__codelineno-38-4></a><span class=p>{</span>
</span><span id=__span-38-5><a id=__codelineno-38-5 name=__codelineno-38-5></a><span class=w> </span><span class=na>[StringInList(typeof(Helpers), nameof(Helpers.GetAllSpriteLabelNames))]</span>
</span><span id=__span-38-6><a id=__codelineno-38-6 name=__codelineno-38-6></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=kt>string</span><span class=o>></span><span class=w> </span><span class=n>selectedLabels</span><span class=p>;</span>
</span><span id=__span-38-7><a id=__codelineno-38-7 name=__codelineno-38-7></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Features:</strong></p> <ul> <li>String fields: Dropdown with string values</li> <li>Int fields: Dropdown with indices</li> <li>Arrays/Lists: UI Toolkit list view with per-element dropdowns, add/remove, and drag-to-reorder</li> <li>Dynamic lists via static method reference</li> <li>Search/filter with lightweight autocomplete (Tab auto-completes and assigns, Enter just fills the search)</li> <li>Inline hint beneath the search box shows the current best match for quick Tab acceptance</li> <li>Pagination automatically appears when the option count exceeds the configured page size</li> <li>Page size configurable via <strong>Project Settings ▸ Wallstop Studios ▸ Unity Helpers ▸ StringInList Page Size</strong></li> <li>Auto-finds current value in list</li> <li>The same search + pagination experience is reused by <code>SerializableType</code>, so adjusting the page size updates both drawers</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Predefined option selection</li> <li>Tag/label selection</li> <li>Enum-like string fields</li> <li>Dynamic option lists</li> <li>User-friendly enumerations</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-39-1> 1</a></span>
<span class=normal><a href=#__codelineno-39-2> 2</a></span>
<span class=normal><a href=#__codelineno-39-3> 3</a></span>
<span class=normal><a href=#__codelineno-39-4> 4</a></span>
<span class=normal><a href=#__codelineno-39-5> 5</a></span>
<span class=normal><a href=#__codelineno-39-6> 6</a></span>
<span class=normal><a href=#__codelineno-39-7> 7</a></span>
<span class=normal><a href=#__codelineno-39-8> 8</a></span>
<span class=normal><a href=#__codelineno-39-9> 9</a></span>
<span class=normal><a href=#__codelineno-39-10>10</a></span>
<span class=normal><a href=#__codelineno-39-11>11</a></span>
<span class=normal><a href=#__codelineno-39-12>12</a></span>
<span class=normal><a href=#__codelineno-39-13>13</a></span>
<span class=normal><a href=#__codelineno-39-14>14</a></span>
<span class=normal><a href=#__codelineno-39-15>15</a></span>
<span class=normal><a href=#__codelineno-39-16>16</a></span>
<span class=normal><a href=#__codelineno-39-17>17</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-39-1><a id=__codelineno-39-1 name=__codelineno-39-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-39-2><a id=__codelineno-39-2 name=__codelineno-39-2></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-39-3><a id=__codelineno-39-3 name=__codelineno-39-3></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-39-4><a id=__codelineno-39-4 name=__codelineno-39-4></a>
</span><span id=__span-39-5><a id=__codelineno-39-5 name=__codelineno-39-5></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>StringInListExample</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-39-6><a id=__codelineno-39-6 name=__codelineno-39-6></a><span class=p>{</span>
</span><span id=__span-39-7><a id=__codelineno-39-7 name=__codelineno-39-7></a><span class=w> </span><span class=na>[StringInList(typeof(StringInListExample), nameof(GetValues))]</span>
</span><span id=__span-39-8><a id=__codelineno-39-8 name=__codelineno-39-8></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=k>value</span><span class=p>;</span>
</span><span id=__span-39-9><a id=__codelineno-39-9 name=__codelineno-39-9></a>
</span><span id=__span-39-10><a id=__codelineno-39-10 name=__codelineno-39-10></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=n>IEnumerable</span><span class=o><</span><span class=kt>string</span><span class=o>></span><span class=w> </span><span class=n>GetValues</span><span class=p>()</span>
</span><span id=__span-39-11><a id=__codelineno-39-11 name=__codelineno-39-11></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-39-12><a id=__codelineno-39-12 name=__codelineno-39-12></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>"A"</span><span class=p>;</span>
</span><span id=__span-39-13><a id=__codelineno-39-13 name=__codelineno-39-13></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>"B"</span><span class=p>;</span>
</span><span id=__span-39-14><a id=__codelineno-39-14 name=__codelineno-39-14></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>"C"</span><span class=p>;</span>
</span><span id=__span-39-15><a id=__codelineno-39-15 name=__codelineno-39-15></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>"D"</span><span class=p>;</span>
</span><span id=__span-39-16><a id=__codelineno-39-16 name=__codelineno-39-16></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-39-17><a id=__codelineno-39-17 name=__codelineno-39-17></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="StringInList dropdown with search and pagination" src=../../../images/editor-tools/stringinlist-dropdown.png></p> <p><em>StringInList dropdown showing search filtering and pagination</em></p> </blockquote> <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-40-1> 1</a></span>
<span class=normal><a href=#__codelineno-40-2> 2</a></span>
<span class=normal><a href=#__codelineno-40-3> 3</a></span>
<span class=normal><a href=#__codelineno-40-4> 4</a></span>
<span class=normal><a href=#__codelineno-40-5> 5</a></span>
<span class=normal><a href=#__codelineno-40-6> 6</a></span>
<span class=normal><a href=#__codelineno-40-7> 7</a></span>
<span class=normal><a href=#__codelineno-40-8> 8</a></span>
<span class=normal><a href=#__codelineno-40-9> 9</a></span>
<span class=normal><a href=#__codelineno-40-10>10</a></span>
<span class=normal><a href=#__codelineno-40-11>11</a></span>
<span class=normal><a href=#__codelineno-40-12>12</a></span>
<span class=normal><a href=#__codelineno-40-13>13</a></span>
<span class=normal><a href=#__codelineno-40-14>14</a></span>
<span class=normal><a href=#__codelineno-40-15>15</a></span>
<span class=normal><a href=#__codelineno-40-16>16</a></span>
<span class=normal><a href=#__codelineno-40-17>17</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-40-1><a id=__codelineno-40-1 name=__codelineno-40-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-40-2><a id=__codelineno-40-2 name=__codelineno-40-2></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-40-3><a id=__codelineno-40-3 name=__codelineno-40-3></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-40-4><a id=__codelineno-40-4 name=__codelineno-40-4></a>
</span><span id=__span-40-5><a id=__codelineno-40-5 name=__codelineno-40-5></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>StringInListExample</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-40-6><a id=__codelineno-40-6 name=__codelineno-40-6></a><span class=p>{</span>
</span><span id=__span-40-7><a id=__codelineno-40-7 name=__codelineno-40-7></a><span class=w> </span><span class=na>[StringInList(typeof(StringInListExample), nameof(GetValues))]</span>
</span><span id=__span-40-8><a id=__codelineno-40-8 name=__codelineno-40-8></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=k>value</span><span class=p>;</span>
</span><span id=__span-40-9><a id=__codelineno-40-9 name=__codelineno-40-9></a>
</span><span id=__span-40-10><a id=__codelineno-40-10 name=__codelineno-40-10></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=n>IEnumerable</span><span class=o><</span><span class=kt>string</span><span class=o>></span><span class=w> </span><span class=n>GetValues</span><span class=p>()</span>
</span><span id=__span-40-11><a id=__codelineno-40-11 name=__codelineno-40-11></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-40-12><a id=__codelineno-40-12 name=__codelineno-40-12></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>"A"</span><span class=p>;</span>
</span><span id=__span-40-13><a id=__codelineno-40-13 name=__codelineno-40-13></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>"B"</span><span class=p>;</span>
</span><span id=__span-40-14><a id=__codelineno-40-14 name=__codelineno-40-14></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>"C"</span><span class=p>;</span>
</span><span id=__span-40-15><a id=__codelineno-40-15 name=__codelineno-40-15></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>"D"</span><span class=p>;</span>
</span><span id=__span-40-16><a id=__codelineno-40-16 name=__codelineno-40-16></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-40-17><a id=__codelineno-40-17 name=__codelineno-40-17></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="StringInList with list field showing add/remove/reorder" src=../../../images/editor-tools/stringinlist-list.gif></p> <p><em>StringInList on a List field with per-element dropdowns and drag reordering</em></p> </blockquote> <hr> <h3 id=intdropdown-property-drawer>IntDropdown Property Drawer<a class=headerlink href=#intdropdown-property-drawer title="Permanent link">¶</a></h3> <p><strong>Attribute:</strong> <code>[IntDropdown]</code></p> <p><strong>Purpose:</strong> Display int fields as dropdown with specific integer options.</p> <p><strong>Syntax:</strong></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-41-1>1</a></span>
<span class=normal><a href=#__codelineno-41-2>2</a></span>
<span class=normal><a href=#__codelineno-41-3>3</a></span>
<span class=normal><a href=#__codelineno-41-4>4</a></span>
<span class=normal><a href=#__codelineno-41-5>5</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-41-1><a id=__codelineno-41-1 name=__codelineno-41-1></a><span class=na>[IntDropdown(32, 64, 128, 256, 512, 1024, 2048, 4096, 8192)]</span>
</span><span id=__span-41-2><a id=__codelineno-41-2 name=__codelineno-41-2></a><span class=k>public</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>textureSize</span><span class=p>;</span>
</span><span id=__span-41-3><a id=__codelineno-41-3 name=__codelineno-41-3></a>
</span><span id=__span-41-4><a id=__codelineno-41-4 name=__codelineno-41-4></a><span class=na>[IntDropdown(0, 2, 4, 8, 16, 32)]</span>
</span><span id=__span-41-5><a id=__codelineno-41-5 name=__codelineno-41-5></a><span class=k>public</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>padding</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Features:</strong></p> <ul> <li>Restricts int values to specific options</li> <li>Dropdown shows integer values as strings</li> <li>Prevents invalid values</li> <li>Visual clarity for constrained integers</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Power-of-two values (texture sizes)</li> <li>Discrete numeric options</li> <li>Preventing invalid integer input</li> <li>Configuration with specific valid values</li> </ul> <p><strong>Common Use Cases:</strong></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-42-1> 1</a></span>
<span class=normal><a href=#__codelineno-42-2> 2</a></span>
<span class=normal><a href=#__codelineno-42-3> 3</a></span>
<span class=normal><a href=#__codelineno-42-4> 4</a></span>
<span class=normal><a href=#__codelineno-42-5> 5</a></span>
<span class=normal><a href=#__codelineno-42-6> 6</a></span>
<span class=normal><a href=#__codelineno-42-7> 7</a></span>
<span class=normal><a href=#__codelineno-42-8> 8</a></span>
<span class=normal><a href=#__codelineno-42-9> 9</a></span>
<span class=normal><a href=#__codelineno-42-10>10</a></span>
<span class=normal><a href=#__codelineno-42-11>11</a></span>
<span class=normal><a href=#__codelineno-42-12>12</a></span>
<span class=normal><a href=#__codelineno-42-13>13</a></span>
<span class=normal><a href=#__codelineno-42-14>14</a></span>
<span class=normal><a href=#__codelineno-42-15>15</a></span>
<span class=normal><a href=#__codelineno-42-16>16</a></span>
<span class=normal><a href=#__codelineno-42-17>17</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-42-1><a id=__codelineno-42-1 name=__codelineno-42-1></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-42-2><a id=__codelineno-42-2 name=__codelineno-42-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-42-3><a id=__codelineno-42-3 name=__codelineno-42-3></a>
</span><span id=__span-42-4><a id=__codelineno-42-4 name=__codelineno-42-4></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>IntDropDownExample</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-42-5><a id=__codelineno-42-5 name=__codelineno-42-5></a><span class=p>{</span>
</span><span id=__span-42-6><a id=__codelineno-42-6 name=__codelineno-42-6></a><span class=w> </span><span class=c1>// Texture sizes (power of 2)</span>
</span><span id=__span-42-7><a id=__codelineno-42-7 name=__codelineno-42-7></a><span class=w> </span><span class=na>[IntDropDown(32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384)]</span>
</span><span id=__span-42-8><a id=__codelineno-42-8 name=__codelineno-42-8></a><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>maxTextureSize</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>2048</span><span class=p>;</span>
</span><span id=__span-42-9><a id=__codelineno-42-9 name=__codelineno-42-9></a>
</span><span id=__span-42-10><a id=__codelineno-42-10 name=__codelineno-42-10></a><span class=w> </span><span class=c1>// Padding options</span>
</span><span id=__span-42-11><a id=__codelineno-42-11 name=__codelineno-42-11></a><span class=w> </span><span class=na>[IntDropDown(0, 2, 4, 8, 16, 32)]</span>
</span><span id=__span-42-12><a id=__codelineno-42-12 name=__codelineno-42-12></a><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>spritePadding</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>4</span><span class=p>;</span>
</span><span id=__span-42-13><a id=__codelineno-42-13 name=__codelineno-42-13></a>
</span><span id=__span-42-14><a id=__codelineno-42-14 name=__codelineno-42-14></a><span class=w> </span><span class=c1>// Quality levels</span>
</span><span id=__span-42-15><a id=__codelineno-42-15 name=__codelineno-42-15></a><span class=w> </span><span class=na>[IntDropDown(0, 1, 2, 3, 4, 5)]</span>
</span><span id=__span-42-16><a id=__codelineno-42-16 name=__codelineno-42-16></a><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>qualityLevel</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>3</span><span class=p>;</span>
</span><span id=__span-42-17><a id=__codelineno-42-17 name=__codelineno-42-17></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="IntDropDown showing texture size options" src=../../../images/editor-tools/intdropdown-texturesize.gif></p> <p><em>IntDropDown for texture sizes showing power-of-two options</em></p> </blockquote> <hr> <h3 id=wvaluedropdown-property-drawer>WValueDropDown Property Drawer<a class=headerlink href=#wvaluedropdown-property-drawer title="Permanent link">¶</a></h3> <p><strong>Attribute:</strong> <code>[WValueDropDown]</code></p> <p><strong>Purpose:</strong> Generic dropdown for any type with fixed values or provider methods. More flexible than <code>StringInList</code> or <code>IntDropdown</code> — supports all primitive types, custom classes, and dynamic providers.</p> <p><strong>Syntax:</strong></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-43-1> 1</a></span>
<span class=normal><a href=#__codelineno-43-2> 2</a></span>
<span class=normal><a href=#__codelineno-43-3> 3</a></span>
<span class=normal><a href=#__codelineno-43-4> 4</a></span>
<span class=normal><a href=#__codelineno-43-5> 5</a></span>
<span class=normal><a href=#__codelineno-43-6> 6</a></span>
<span class=normal><a href=#__codelineno-43-7> 7</a></span>
<span class=normal><a href=#__codelineno-43-8> 8</a></span>
<span class=normal><a href=#__codelineno-43-9> 9</a></span>
<span class=normal><a href=#__codelineno-43-10>10</a></span>
<span class=normal><a href=#__codelineno-43-11>11</a></span>
<span class=normal><a href=#__codelineno-43-12>12</a></span>
<span class=normal><a href=#__codelineno-43-13>13</a></span>
<span class=normal><a href=#__codelineno-43-14>14</a></span>
<span class=normal><a href=#__codelineno-43-15>15</a></span>
<span class=normal><a href=#__codelineno-43-16>16</a></span>
<span class=normal><a href=#__codelineno-43-17>17</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-43-1><a id=__codelineno-43-1 name=__codelineno-43-1></a><span class=c1>// Fixed primitive values</span>
</span><span id=__span-43-2><a id=__codelineno-43-2 name=__codelineno-43-2></a><span class=na>[WValueDropDown(0, 25, 50, 100)]</span>
</span><span id=__span-43-3><a id=__codelineno-43-3 name=__codelineno-43-3></a><span class=k>public</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>staminaThreshold</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>50</span><span class=p>;</span>
</span><span id=__span-43-4><a id=__codelineno-43-4 name=__codelineno-43-4></a>
</span><span id=__span-43-5><a id=__codelineno-43-5 name=__codelineno-43-5></a><span class=na>[WValueDropDown(0.5f, 1.0f, 1.5f, 2.0f)]</span>
</span><span id=__span-43-6><a id=__codelineno-43-6 name=__codelineno-43-6></a><span class=k>public</span><span class=w> </span><span class=kt>float</span><span class=w> </span><span class=n>damageMultiplier</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>1.0f</span><span class=p>;</span>
</span><span id=__span-43-7><a id=__codelineno-43-7 name=__codelineno-43-7></a>
</span><span id=__span-43-8><a id=__codelineno-43-8 name=__codelineno-43-8></a><span class=na>[WValueDropDown("Easy", "Normal", "Hard", "Insane")]</span>
</span><span id=__span-43-9><a id=__codelineno-43-9 name=__codelineno-43-9></a><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>difficulty</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s>"Normal"</span><span class=p>;</span>
</span><span id=__span-43-10><a id=__codelineno-43-10 name=__codelineno-43-10></a>
</span><span id=__span-43-11><a id=__codelineno-43-11 name=__codelineno-43-11></a><span class=c1>// Static provider method</span>
</span><span id=__span-43-12><a id=__codelineno-43-12 name=__codelineno-43-12></a><span class=na>[WValueDropDown(typeof(PowerUpLibrary), nameof(PowerUpLibrary.GetAvailablePowerUps))]</span>
</span><span id=__span-43-13><a id=__codelineno-43-13 name=__codelineno-43-13></a><span class=k>public</span><span class=w> </span><span class=n>PowerUpDefinition</span><span class=w> </span><span class=n>selectedPowerUp</span><span class=p>;</span>
</span><span id=__span-43-14><a id=__codelineno-43-14 name=__codelineno-43-14></a>
</span><span id=__span-43-15><a id=__codelineno-43-15 name=__codelineno-43-15></a><span class=c1>// Instance provider method (context-aware)</span>
</span><span id=__span-43-16><a id=__codelineno-43-16 name=__codelineno-43-16></a><span class=na>[WValueDropDown(nameof(GetAvailableOptions), typeof(string))]</span>
</span><span id=__span-43-17><a id=__codelineno-43-17 name=__codelineno-43-17></a><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>selectedOption</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Features:</strong></p> <ul> <li>All primitive types: <code>bool</code>, <code>char</code>, <code>byte</code>, <code>sbyte</code>, <code>short</code>, <code>ushort</code>, <code>int</code>, <code>uint</code>, <code>long</code>, <code>ulong</code>, <code>float</code>, <code>double</code>, <code>string</code></li> <li>Custom types with <code>ToString()</code> for labels</li> <li>Static provider methods from any type</li> <li>Instance provider methods for context-aware options</li> <li>Type-safe value selection</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Type-safe options beyond strings/ints</li> <li>Custom class/struct selection</li> <li>Dynamic options from runtime data</li> <li>Designer-friendly preset selection</li> </ul> <p><strong>Custom Types Example:</strong></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-44-1> 1</a></span>
<span class=normal><a href=#__codelineno-44-2> 2</a></span>
<span class=normal><a href=#__codelineno-44-3> 3</a></span>
<span class=normal><a href=#__codelineno-44-4> 4</a></span>
<span class=normal><a href=#__codelineno-44-5> 5</a></span>
<span class=normal><a href=#__codelineno-44-6> 6</a></span>
<span class=normal><a href=#__codelineno-44-7> 7</a></span>
<span class=normal><a href=#__codelineno-44-8> 8</a></span>
<span class=normal><a href=#__codelineno-44-9> 9</a></span>
<span class=normal><a href=#__codelineno-44-10>10</a></span>
<span class=normal><a href=#__codelineno-44-11>11</a></span>
<span class=normal><a href=#__codelineno-44-12>12</a></span>
<span class=normal><a href=#__codelineno-44-13>13</a></span>
<span class=normal><a href=#__codelineno-44-14>14</a></span>
<span class=normal><a href=#__codelineno-44-15>15</a></span>
<span class=normal><a href=#__codelineno-44-16>16</a></span>
<span class=normal><a href=#__codelineno-44-17>17</a></span>
<span class=normal><a href=#__codelineno-44-18>18</a></span>
<span class=normal><a href=#__codelineno-44-19>19</a></span>
<span class=normal><a href=#__codelineno-44-20>20</a></span>
<span class=normal><a href=#__codelineno-44-21>21</a></span>
<span class=normal><a href=#__codelineno-44-22>22</a></span>
<span class=normal><a href=#__codelineno-44-23>23</a></span>
<span class=normal><a href=#__codelineno-44-24>24</a></span>
<span class=normal><a href=#__codelineno-44-25>25</a></span>
<span class=normal><a href=#__codelineno-44-26>26</a></span>
<span class=normal><a href=#__codelineno-44-27>27</a></span>
<span class=normal><a href=#__codelineno-44-28>28</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-44-1><a id=__codelineno-44-1 name=__codelineno-44-1></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-44-2><a id=__codelineno-44-2 name=__codelineno-44-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-44-3><a id=__codelineno-44-3 name=__codelineno-44-3></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-44-4><a id=__codelineno-44-4 name=__codelineno-44-4></a>
</span><span id=__span-44-5><a id=__codelineno-44-5 name=__codelineno-44-5></a><span class=na>[System.Serializable]</span>
</span><span id=__span-44-6><a id=__codelineno-44-6 name=__codelineno-44-6></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>Preset</span>
</span><span id=__span-44-7><a id=__codelineno-44-7 name=__codelineno-44-7></a><span class=p>{</span>
</span><span id=__span-44-8><a id=__codelineno-44-8 name=__codelineno-44-8></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>name</span><span class=p>;</span>
</span><span id=__span-44-9><a id=__codelineno-44-9 name=__codelineno-44-9></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=k>value</span><span class=p>;</span>
</span><span id=__span-44-10><a id=__codelineno-44-10 name=__codelineno-44-10></a>
</span><span id=__span-44-11><a id=__codelineno-44-11 name=__codelineno-44-11></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>override</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=nf>ToString</span><span class=p>()</span><span class=w> </span><span class=o>=></span><span class=w> </span><span class=n>name</span><span class=p>;</span><span class=w> </span><span class=c1>// Used for dropdown label</span>
</span><span id=__span-44-12><a id=__codelineno-44-12 name=__codelineno-44-12></a><span class=p>}</span>
</span><span id=__span-44-13><a id=__codelineno-44-13 name=__codelineno-44-13></a>
</span><span id=__span-44-14><a id=__codelineno-44-14 name=__codelineno-44-14></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>Config</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-44-15><a id=__codelineno-44-15 name=__codelineno-44-15></a><span class=p>{</span>
</span><span id=__span-44-16><a id=__codelineno-44-16 name=__codelineno-44-16></a><span class=w> </span><span class=na>[WValueDropDown(typeof(Config), nameof(GetPresets))]</span>
</span><span id=__span-44-17><a id=__codelineno-44-17 name=__codelineno-44-17></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=n>Preset</span><span class=w> </span><span class=n>selectedPreset</span><span class=p>;</span>
</span><span id=__span-44-18><a id=__codelineno-44-18 name=__codelineno-44-18></a>
</span><span id=__span-44-19><a id=__codelineno-44-19 name=__codelineno-44-19></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>IEnumerable</span><span class=o><</span><span class=n>Preset</span><span class=o>></span><span class=w> </span><span class=n>GetPresets</span><span class=p>()</span>
</span><span id=__span-44-20><a id=__codelineno-44-20 name=__codelineno-44-20></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-44-21><a id=__codelineno-44-21 name=__codelineno-44-21></a><span class=w> </span><span class=k>return</span><span class=w> </span><span class=k>new</span><span class=p>[]</span>
</span><span id=__span-44-22><a id=__codelineno-44-22 name=__codelineno-44-22></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-44-23><a id=__codelineno-44-23 name=__codelineno-44-23></a><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>Preset</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>name</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s>"Low"</span><span class=p>,</span><span class=w> </span><span class=k>value</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>0.5f</span><span class=w> </span><span class=p>},</span>
</span><span id=__span-44-24><a id=__codelineno-44-24 name=__codelineno-44-24></a><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>Preset</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>name</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s>"Medium"</span><span class=p>,</span><span class=w> </span><span class=k>value</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>1.0f</span><span class=w> </span><span class=p>},</span>
</span><span id=__span-44-25><a id=__codelineno-44-25 name=__codelineno-44-25></a><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>Preset</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>name</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s>"High"</span><span class=p>,</span><span class=w> </span><span class=k>value</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>2.0f</span><span class=w> </span><span class=p>},</span>
</span><span id=__span-44-26><a id=__codelineno-44-26 name=__codelineno-44-26></a><span class=w> </span><span class=p>};</span>
</span><span id=__span-44-27><a id=__codelineno-44-27 name=__codelineno-44-27></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-44-28><a id=__codelineno-44-28 name=__codelineno-44-28></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Instance Provider Example:</strong></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-45-1> 1</a></span>
<span class=normal><a href=#__codelineno-45-2> 2</a></span>
<span class=normal><a href=#__codelineno-45-3> 3</a></span>
<span class=normal><a href=#__codelineno-45-4> 4</a></span>
<span class=normal><a href=#__codelineno-45-5> 5</a></span>
<span class=normal><a href=#__codelineno-45-6> 6</a></span>
<span class=normal><a href=#__codelineno-45-7> 7</a></span>
<span class=normal><a href=#__codelineno-45-8> 8</a></span>
<span class=normal><a href=#__codelineno-45-9> 9</a></span>
<span class=normal><a href=#__codelineno-45-10>10</a></span>
<span class=normal><a href=#__codelineno-45-11>11</a></span>
<span class=normal><a href=#__codelineno-45-12>12</a></span>
<span class=normal><a href=#__codelineno-45-13>13</a></span>
<span class=normal><a href=#__codelineno-45-14>14</a></span>
<span class=normal><a href=#__codelineno-45-15>15</a></span>
<span class=normal><a href=#__codelineno-45-16>16</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-45-1><a id=__codelineno-45-1 name=__codelineno-45-1></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>DynamicOptions</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-45-2><a id=__codelineno-45-2 name=__codelineno-45-2></a><span class=p>{</span>
</span><span id=__span-45-3><a id=__codelineno-45-3 name=__codelineno-45-3></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>prefix</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s>"Option"</span><span class=p>;</span>
</span><span id=__span-45-4><a id=__codelineno-45-4 name=__codelineno-45-4></a><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>optionCount</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>5</span><span class=p>;</span>
</span><span id=__span-45-5><a id=__codelineno-45-5 name=__codelineno-45-5></a>
</span><span id=__span-45-6><a id=__codelineno-45-6 name=__codelineno-45-6></a><span class=w> </span><span class=na>[WValueDropDown(nameof(GetAvailableOptions), typeof(string))]</span>
</span><span id=__span-45-7><a id=__codelineno-45-7 name=__codelineno-45-7></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>selectedOption</span><span class=p>;</span>
</span><span id=__span-45-8><a id=__codelineno-45-8 name=__codelineno-45-8></a>
</span><span id=__span-45-9><a id=__codelineno-45-9 name=__codelineno-45-9></a><span class=w> </span><span class=k>private</span><span class=w> </span><span class=n>IEnumerable</span><span class=o><</span><span class=kt>string</span><span class=o>></span><span class=w> </span><span class=n>GetAvailableOptions</span><span class=p>()</span>
</span><span id=__span-45-10><a id=__codelineno-45-10 name=__codelineno-45-10></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-45-11><a id=__codelineno-45-11 name=__codelineno-45-11></a><span class=w> </span><span class=k>for</span><span class=w> </span><span class=p>(</span><span class=kt>int</span><span class=w> </span><span class=n>i</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>1</span><span class=p>;</span><span class=w> </span><span class=n>i</span><span class=w> </span><span class=o><=</span><span class=w> </span><span class=n>optionCount</span><span class=p>;</span><span class=w> </span><span class=n>i</span><span class=o>++</span><span class=p>)</span>
</span><span id=__span-45-12><a id=__codelineno-45-12 name=__codelineno-45-12></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-45-13><a id=__codelineno-45-13 name=__codelineno-45-13></a><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=k>return</span><span class=w> </span><span class=s>$"{prefix}_{i}"</span><span class=p>;</span>
</span><span id=__span-45-14><a id=__codelineno-45-14 name=__codelineno-45-14></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-45-15><a id=__codelineno-45-15 name=__codelineno-45-15></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-45-16><a id=__codelineno-45-16 name=__codelineno-45-16></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="WValueDropDown with predefined values" src=../../../images/inspector/selection/wvalue-dropdown-basic.gif></p> <p><em>WValueDropDown showing predefined integer, float, and string values</em></p> </blockquote> <p>For more detailed documentation, including all constructor forms, see <a href=../../inspector/inspector-selection-attributes/#wvaluedropdown>Inspector Selection Attributes</a>.</p> <hr> <h3 id=wreadonly-property-drawer>WReadOnly Property Drawer<a class=headerlink href=#wreadonly-property-drawer title="Permanent link">¶</a></h3> <p><strong>Attribute:</strong> <code>[WReadOnly]</code></p> <p><strong>Purpose:</strong> Display fields as read-only in the inspector (grayed out, non-editable).</p> <p><strong>Syntax:</strong></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-46-1>1</a></span>
<span class=normal><a href=#__codelineno-46-2>2</a></span>
<span class=normal><a href=#__codelineno-46-3>3</a></span>
<span class=normal><a href=#__codelineno-46-4>4</a></span>
<span class=normal><a href=#__codelineno-46-5>5</a></span>
<span class=normal><a href=#__codelineno-46-6>6</a></span>
<span class=normal><a href=#__codelineno-46-7>7</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-46-1><a id=__codelineno-46-1 name=__codelineno-46-1></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-46-2><a id=__codelineno-46-2 name=__codelineno-46-2></a>
</span><span id=__span-46-3><a id=__codelineno-46-3 name=__codelineno-46-3></a><span class=na>[WReadOnly]</span>
</span><span id=__span-46-4><a id=__codelineno-46-4 name=__codelineno-46-4></a><span class=k>public</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>calculatedValue</span><span class=p>;</span>
</span><span id=__span-46-5><a id=__codelineno-46-5 name=__codelineno-46-5></a>
</span><span id=__span-46-6><a id=__codelineno-46-6 name=__codelineno-46-6></a><span class=na>[WReadOnly]</span>
</span><span id=__span-46-7><a id=__codelineno-46-7 name=__codelineno-46-7></a><span class=k>public</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>currentState</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Features:</strong></p> <ul> <li>Disables GUI for field</li> <li>Shows value but prevents editing</li> <li>Maintains proper height and layout</li> <li>Works with all property types</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Displaying runtime state</li> <li>Showing calculated/derived values</li> <li>Debug information in inspector</li> <li>Values set by code only</li> </ul> <p><strong>Example:</strong></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-47-1> 1</a></span>
<span class=normal><a href=#__codelineno-47-2> 2</a></span>
<span class=normal><a href=#__codelineno-47-3> 3</a></span>
<span class=normal><a href=#__codelineno-47-4> 4</a></span>
<span class=normal><a href=#__codelineno-47-5> 5</a></span>
<span class=normal><a href=#__codelineno-47-6> 6</a></span>
<span class=normal><a href=#__codelineno-47-7> 7</a></span>
<span class=normal><a href=#__codelineno-47-8> 8</a></span>
<span class=normal><a href=#__codelineno-47-9> 9</a></span>
<span class=normal><a href=#__codelineno-47-10>10</a></span>
<span class=normal><a href=#__codelineno-47-11>11</a></span>
<span class=normal><a href=#__codelineno-47-12>12</a></span>
<span class=normal><a href=#__codelineno-47-13>13</a></span>
<span class=normal><a href=#__codelineno-47-14>14</a></span>
<span class=normal><a href=#__codelineno-47-15>15</a></span>
<span class=normal><a href=#__codelineno-47-16>16</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-47-1><a id=__codelineno-47-1 name=__codelineno-47-1></a><span class=k>using</span><span class=w> </span><span class=nn>UnityEngine</span><span class=p>;</span>
</span><span id=__span-47-2><a id=__codelineno-47-2 name=__codelineno-47-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-47-3><a id=__codelineno-47-3 name=__codelineno-47-3></a>
</span><span id=__span-47-4><a id=__codelineno-47-4 name=__codelineno-47-4></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>WReadOnlyExample</span><span class=w> </span><span class=p>:</span><span class=w> </span><span class=n>MonoBehaviour</span>
</span><span id=__span-47-5><a id=__codelineno-47-5 name=__codelineno-47-5></a><span class=p>{</span>
</span><span id=__span-47-6><a id=__codelineno-47-6 name=__codelineno-47-6></a><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>baseHealth</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>100</span><span class=p>;</span>
</span><span id=__span-47-7><a id=__codelineno-47-7 name=__codelineno-47-7></a><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>healthBonus</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>0</span><span class=p>;</span>
</span><span id=__span-47-8><a id=__codelineno-47-8 name=__codelineno-47-8></a>
</span><span id=__span-47-9><a id=__codelineno-47-9 name=__codelineno-47-9></a><span class=w> </span><span class=na>[WReadOnly]</span>
</span><span id=__span-47-10><a id=__codelineno-47-10 name=__codelineno-47-10></a><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>totalHealth</span><span class=p>;</span>
</span><span id=__span-47-11><a id=__codelineno-47-11 name=__codelineno-47-11></a>
</span><span id=__span-47-12><a id=__codelineno-47-12 name=__codelineno-47-12></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><span id=__span-47-13><a id=__codelineno-47-13 name=__codelineno-47-13></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-47-14><a id=__codelineno-47-14 name=__codelineno-47-14></a><span class=w> </span><span class=n>totalHealth</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>baseHealth</span><span class=w> </span><span class=o>+</span><span class=w> </span><span class=n>healthBonus</span><span class=p>;</span>
</span><span id=__span-47-15><a id=__codelineno-47-15 name=__codelineno-47-15></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-47-16><a id=__codelineno-47-16 name=__codelineno-47-16></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="WReadOnly showing grayed-out calculated value in inspector" src=../../../images/editor-tools/wreadonly-inspector.png></p> <p><em>WReadOnly field showing totalHealth as a non-editable calculated value</em></p> </blockquote> <p>For detailed documentation on validation attributes, see <a href=../../inspector/inspector-validation-attributes/ >Inspector Validation Attributes</a>.</p> <hr> <p><a id=automation--utilities></a> <a id=automation-utilities></a></p> <h2 id=automation-utilities>Automation & Utilities<a class=headerlink href=#automation-utilities title="Permanent link">¶</a></h2> <p><a id=scriptableobject-singleton-creator></a></p> <h3 id=scriptableobject-singleton-creator>ScriptableObject Singleton Creator<a class=headerlink href=#scriptableobject-singleton-creator title="Permanent link">¶</a></h3> <ul> <li><strong>Type:</strong> Automatic (runs on editor load)</li> <li><strong>Menu:</strong> N/A (automatic) - Uses <code>[InitializeOnLoad]</code></li> </ul> <p><strong>Purpose:</strong> Automatically creates and maintains singleton ScriptableObject assets.</p> <p>See the base API guide for details on <code>ScriptableObjectSingleton<T></code> usage, scenarios, and Odin compatibility: <a href=../../utilities/singletons/ >Singleton Utilities</a>.</p> <p><strong>How It Works:</strong></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-48-1>1</a></span>
<span class=normal><a href=#__codelineno-48-2>2</a></span>
<span class=normal><a href=#__codelineno-48-3>3</a></span>
<span class=normal><a href=#__codelineno-48-4>4</a></span>
<span class=normal><a href=#__codelineno-48-5>5</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-48-1><a id=__codelineno-48-1 name=__codelineno-48-1></a>1. Runs when Unity editor starts
</span><span id=__span-48-2><a id=__codelineno-48-2 name=__codelineno-48-2></a>2. Scans all ScriptableObjectSingleton<T> derived types
</span><span id=__span-48-3><a id=__codelineno-48-3 name=__codelineno-48-3></a>3. Creates missing assets in Assets/Resources/
</span><span id=__span-48-4><a id=__codelineno-48-4 name=__codelineno-48-4></a>4. Moves misplaced singletons to correct locations
</span><span id=__span-48-5><a id=__codelineno-48-5 name=__codelineno-48-5></a>5. Respects [ScriptableSingletonPath] attribute
</span></code></pre></div></td></tr></table></div> <p><strong>Usage Example:</strong></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-49-1> 1</a></span>
<span class=normal><a href=#__codelineno-49-2> 2</a></span>
<span class=normal><a href=#__codelineno-49-3> 3</a></span>
<span class=normal><a href=#__codelineno-49-4> 4</a></span>
<span class=normal><a href=#__codelineno-49-5> 5</a></span>
<span class=normal><a href=#__codelineno-49-6> 6</a></span>
<span class=normal><a href=#__codelineno-49-7> 7</a></span>
<span class=normal><a href=#__codelineno-49-8> 8</a></span>
<span class=normal><a href=#__codelineno-49-9> 9</a></span>
<span class=normal><a href=#__codelineno-49-10>10</a></span>
<span class=normal><a href=#__codelineno-49-11>11</a></span>
<span class=normal><a href=#__codelineno-49-12>12</a></span>
<span class=normal><a href=#__codelineno-49-13>13</a></span>
<span class=normal><a href=#__codelineno-49-14>14</a></span>
<span class=normal><a href=#__codelineno-49-15>15</a></span>
<span class=normal><a href=#__codelineno-49-16>16</a></span>
<span class=normal><a href=#__codelineno-49-17>17</a></span>
<span class=normal><a href=#__codelineno-49-18>18</a></span>
<span class=normal><a href=#__codelineno-49-19>19</a></span>
<span class=normal><a href=#__codelineno-49-20>20</a></span>
<span class=normal><a href=#__codelineno-49-21>21</a></span>
<span class=normal><a href=#__codelineno-49-22>22</a></span>
<span class=normal><a href=#__codelineno-49-23>23</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-49-1><a id=__codelineno-49-1 name=__codelineno-49-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-49-2><a id=__codelineno-49-2 name=__codelineno-49-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-49-3><a id=__codelineno-49-3 name=__codelineno-49-3></a>
</span><span id=__span-49-4><a id=__codelineno-49-4 name=__codelineno-49-4></a><span class=c1>// Define singleton:</span>
</span><span id=__span-49-5><a id=__codelineno-49-5 name=__codelineno-49-5></a><span class=k>public</span><span class=w> </span><span class=k>class</span><span class=w> </span><span class=nc>GameSettings</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>GameSettings</span><span class=o>></span>
</span><span id=__span-49-6><a id=__codelineno-49-6 name=__codelineno-49-6></a><span class=p>{</span>
</span><span id=__span-49-7><a id=__codelineno-49-7 name=__codelineno-49-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>masterVolume</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mf>1.0f</span><span class=p>;</span>
</span><span id=__span-49-8><a id=__codelineno-49-8 name=__codelineno-49-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>enableVSync</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-49-9><a id=__codelineno-49-9 name=__codelineno-49-9></a><span class=p>}</span>
</span><span id=__span-49-10><a id=__codelineno-49-10 name=__codelineno-49-10></a>
</span><span id=__span-49-11><a id=__codelineno-49-11 name=__codelineno-49-11></a><span class=c1>// Optional custom path:</span>
</span><span id=__span-49-12><a id=__codelineno-49-12 name=__codelineno-49-12></a><span class=na>[ScriptableSingletonPath("Settings/Audio")]</span>
</span><span id=__span-49-13><a id=__codelineno-49-13 name=__codelineno-49-13></a><span class=k>public</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-49-14><a id=__codelineno-49-14 name=__codelineno-49-14></a><span class=p>{</span>
</span><span id=__span-49-15><a id=__codelineno-49-15 name=__codelineno-49-15></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-49-16><a id=__codelineno-49-16 name=__codelineno-49-16></a><span class=p>}</span>
</span><span id=__span-49-17><a id=__codelineno-49-17 name=__codelineno-49-17></a>
</span><span id=__span-49-18><a id=__codelineno-49-18 name=__codelineno-49-18></a><span class=c1>// Assets created automatically:</span>
</span><span id=__span-49-19><a id=__codelineno-49-19 name=__codelineno-49-19></a><span class=c1>// - Assets/Resources/GameSettings.asset</span>
</span><span id=__span-49-20><a id=__codelineno-49-20 name=__codelineno-49-20></a><span class=c1>// - Assets/Resources/Settings/Audio/AudioSettings.asset</span>
</span><span id=__span-49-21><a id=__codelineno-49-21 name=__codelineno-49-21></a>
</span><span id=__span-49-22><a id=__codelineno-49-22 name=__codelineno-49-22></a><span class=c1>// Access at runtime:</span>
</span><span id=__span-49-23><a id=__codelineno-49-23 name=__codelineno-49-23></a><span class=kt>float</span><span class=w> </span><span class=n>volume</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>GameSettings</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><strong>Folder Structure:</strong></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-50-1>1</a></span>
<span class=normal><a href=#__codelineno-50-2>2</a></span>
<span class=normal><a href=#__codelineno-50-3>3</a></span>
<span class=normal><a href=#__codelineno-50-4>4</a></span>
<span class=normal><a href=#__codelineno-50-5>5</a></span>
<span class=normal><a href=#__codelineno-50-6>6</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-50-1><a id=__codelineno-50-1 name=__codelineno-50-1></a>Assets/
</span><span id=__span-50-2><a id=__codelineno-50-2 name=__codelineno-50-2></a> Resources/
</span><span id=__span-50-3><a id=__codelineno-50-3 name=__codelineno-50-3></a> GameSettings.asset (no path attribute)
</span><span id=__span-50-4><a id=__codelineno-50-4 name=__codelineno-50-4></a> Settings/
</span><span id=__span-50-5><a id=__codelineno-50-5 name=__codelineno-50-5></a> Audio/ ([ScriptableSingletonPath("Settings/Audio")])
</span><span id=__span-50-6><a id=__codelineno-50-6 name=__codelineno-50-6></a> AudioSettings.asset
</span></code></pre></div></td></tr></table></div> <p><strong>Best For:</strong></p> <ul> <li>Managing game settings as unique assets</li> <li>Centralizing configuration data</li> <li>Ensuring essential ScriptableObjects exist</li> <li>Team workflows to prevent missing asset errors</li> <li>Automatic project setup for new developers</li> </ul> <p><strong>Customization:</strong></p> <ul> <li>Set <code>IncludeTestAssemblies = true</code> to create test singletons</li> <li>Call <code>EnsureSingletonAssets()</code> manually to refresh</li> </ul> <hr> <h3 id=sprite-label-processor>Sprite Label Processor<a class=headerlink href=#sprite-label-processor title="Permanent link">¶</a></h3> <ul> <li><strong>Type:</strong> Automatic asset processor</li> <li><strong>Menu:</strong> N/A (automatic) - Uses <code>AssetPostprocessor</code></li> </ul> <p><strong>Purpose:</strong> Automatically maintains a cache of all sprite labels in the project for fast lookup in editor tools.</p> <p><strong>How It Works:</strong></p> <ol> <li>Monitors sprite asset imports/reimports (PNG, JPG, JPEG)</li> <li>Detects changes to asset labels on sprites</li> <li>Updates global sprite label cache automatically</li> <li>Provides a cached label list to tools like Sprite Atlas Generator</li> </ol> <p><strong>What Gets Cached:</strong></p> <ul> <li>All unique asset labels across sprite assets</li> <li>Sorted alphabetically for a consistent display</li> <li>Updated on import, not at runtime</li> </ul> <p><strong>Performance Benefits:</strong></p> <ul> <li>✅ No need to scan the entire project for labels</li> <li>✅ Fast dropdown population in editors</li> <li>✅ Automatic cache invalidation on changes</li> <li>✅ Only processes sprite texture types</li> </ul> <p><strong>Runtime Usage:</strong></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-51-1>1</a></span>
<span class=normal><a href=#__codelineno-51-2>2</a></span>
<span class=normal><a href=#__codelineno-51-3>3</a></span>
<span class=normal><a href=#__codelineno-51-4>4</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-51-1><a id=__codelineno-51-1 name=__codelineno-51-1></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Core.Helper</span><span class=p>;</span>
</span><span id=__span-51-2><a id=__codelineno-51-2 name=__codelineno-51-2></a>
</span><span id=__span-51-3><a id=__codelineno-51-3 name=__codelineno-51-3></a><span class=c1>// Access cached sprite labels</span>
</span><span id=__span-51-4><a id=__codelineno-51-4 name=__codelineno-51-4></a><span class=kt>string</span><span class=p>[]</span><span class=w> </span><span class=n>labels</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>SpriteLabelCache</span><span class=p>.</span><span class=n>GetAllLabels</span><span class=p>();</span>
</span></code></pre></div></td></tr></table></div> <hr> <p><a id=request-script-recompilation></a></p> <h3 id=request-script-compilation>Request Script Compilation<a class=headerlink href=#request-script-compilation title="Permanent link">¶</a></h3> <ul> <li><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Request Script Compilation</code></li> <li><strong>Shortcut:</strong> <code>Ctrl/Cmd + Alt + R</code> (configurable in Unity's Shortcut Manager)</li> </ul> <p><strong>Purpose:</strong> Manually trigger Unity script recompilation without needing to modify files or restart the editor.</p> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Request Script Recompilation menu item" src=../../../images/editor-tools/request-recompilation.png></p> <p><img alt="Request Script Recompilation shortcut" src=../../../images/editor-tools/request-recompilation-shortcut.png></p> </blockquote> <p><strong>Key Features:</strong></p> <ul> <li>One-click script recompilation</li> <li>Customizable keyboard shortcut (default: Ctrl/Cmd + Alt + R)</li> <li>Useful after external code generation or build processes</li> <li>Available in Unity's Shortcut Manager under "Wallstop Studios / Request Script Compilation"</li> </ul> <p><strong>When to Use:</strong></p> <ul> <li>After external code generation tools modify scripts</li> <li>When Unity doesn't auto-detect file changes</li> <li>To force recompilation without touching files</li> <li>In automated workflows that need explicit compilation steps</li> </ul> <p><strong>Common Workflow:</strong></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-52-1>1</a></span>
<span class=normal><a href=#__codelineno-52-2>2</a></span>
<span class=normal><a href=#__codelineno-52-3>3</a></span>
<span class=normal><a href=#__codelineno-52-4>4</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-52-1><a id=__codelineno-52-1 name=__codelineno-52-1></a>1. Run external code generator
</span><span id=__span-52-2><a id=__codelineno-52-2 name=__codelineno-52-2></a>2. Press Ctrl+Alt+R (or use menu item)
</span><span id=__span-52-3><a id=__codelineno-52-3 name=__codelineno-52-3></a>3. Wait for Unity to recompile scripts
</span><span id=__span-52-4><a id=__codelineno-52-4 name=__codelineno-52-4></a>4. Continue working with updated code
</span></code></pre></div></td></tr></table></div> <hr> <p><a id=project-settings-unity-helpers></a></p> <h3 id=project-settings-unity-helpers>Project Settings: Unity Helpers<a class=headerlink href=#project-settings-unity-helpers title="Permanent link">¶</a></h3> <p><strong>Menu:</strong> <code>Edit > Project Settings > Wallstop Studios > Unity Helpers</code></p> <p><strong>Purpose:</strong> Centralized configuration for Unity Helpers features, including buffer settings, pagination defaults, and inspector behavior.</p> <blockquote> <p><strong>Visual Reference</strong></p> <p><img alt="Project Settings panel for Unity Helpers" src=../../../images/editor-tools/project-settings-unity-helpers.png> <em>Centralized configuration panel in Unity's Project Settings</em></p> </blockquote> <p><strong>Key Settings:</strong></p> <h4 id=coroutine-wait-buffer-defaults>Coroutine Wait Buffer Defaults<a class=headerlink href=#coroutine-wait-buffer-defaults title="Permanent link">¶</a></h4> <p>Configure default behavior for <code>WaitForSeconds</code>, <code>WaitForFixedUpdate</code>, and other yield instructions:</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-53-1>1</a></span>
<span class=normal><a href=#__codelineno-53-2>2</a></span>
<span class=normal><a href=#__codelineno-53-3>3</a></span>
<span class=normal><a href=#__codelineno-53-4>4</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-53-1><a id=__codelineno-53-1 name=__codelineno-53-1></a><span class=c1>// Settings affect runtime buffer pool behavior:</span>
</span><span id=__span-53-2><a id=__codelineno-53-2 name=__codelineno-53-2></a><span class=o>-</span><span class=w> </span><span class=n>Quantization</span><span class=p>:</span><span class=w> </span><span class=n>How</span><span class=w> </span><span class=k>yield</span><span class=w> </span><span class=n>times</span><span class=w> </span><span class=n>are</span><span class=w> </span><span class=n>rounded</span><span class=w> </span><span class=p>(</span><span class=n>e</span><span class=p>.</span><span class=n>g</span><span class=p>.,</span><span class=w> </span><span class=mf>0.1f</span><span class=w> </span><span class=n>rounds</span><span class=w> </span><span class=n>to</span><span class=w> </span><span class=n>nearest</span><span class=w> </span><span class=mf>0.1</span><span class=p>)</span>
</span><span id=__span-53-3><a id=__codelineno-53-3 name=__codelineno-53-3></a><span class=o>-</span><span class=w> </span><span class=n>Entry</span><span class=w> </span><span class=n>Caps</span><span class=p>:</span><span class=w> </span><span class=n>Maximum</span><span class=w> </span><span class=n>number</span><span class=w> </span><span class=n>of</span><span class=w> </span><span class=n>cached</span><span class=w> </span><span class=n>wait</span><span class=w> </span><span class=n>instructions</span><span class=w> </span><span class=n>per</span><span class=w> </span><span class=n>type</span>
</span><span id=__span-53-4><a id=__codelineno-53-4 name=__codelineno-53-4></a><span class=o>-</span><span class=w> </span><span class=n>LRU</span><span class=w> </span><span class=n>Mode</span><span class=p>:</span><span class=w> </span><span class=n>Least</span><span class=o>-</span><span class=n>recently</span><span class=o>-</span><span class=n>used</span><span class=w> </span><span class=n>eviction</span><span class=w> </span><span class=k>when</span><span class=w> </span><span class=n>caps</span><span class=w> </span><span class=n>are</span><span class=w> </span><span class=n>exceeded</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Impact:</strong></p> <ul> <li>Reduces GC allocations from repeated coroutine yields</li> <li>Settings apply automatically on domain reload and player start</li> <li>Can be overridden at runtime if needed</li> </ul> <p><strong>Generated Asset:</strong> <code>Resources/WallstopStudios/UnityHelpers/UnityHelpersBufferSettings.asset</code></p> <h4 id=inspector-pagination-defaults>Inspector Pagination Defaults<a class=headerlink href=#inspector-pagination-defaults title="Permanent link">¶</a></h4> <ul> <li><code>StringInListPageSize</code>: Default page size for StringInList dropdowns (default: 50)</li> <li><code>WEnumToggleButtonsPageSize</code>: Default page size for enum toggle button grids (default: 20)</li> <li>Per-attribute overrides available on individual fields</li> </ul> <p><strong>When to Adjust:</strong></p> <ul> <li>Large option lists feel cramped (increase page size)</li> <li>Inspector feels sluggish with many options (decrease page size)</li> <li>Project-wide consistency for dropdown/toggle experiences</li> </ul> <hr> <p><strong>Runtime Usage:</strong></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-54-1>1</a></span>
<span class=normal><a href=#__codelineno-54-2>2</a></span>
<span class=normal><a href=#__codelineno-54-3>3</a></span>
<span class=normal><a href=#__codelineno-54-4>4</a></span>
<span class=normal><a href=#__codelineno-54-5>5</a></span>
<span class=normal><a href=#__codelineno-54-6>6</a></span>
<span class=normal><a href=#__codelineno-54-7>7</a></span>
<span class=normal><a href=#__codelineno-54-8>8</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-54-1><a id=__codelineno-54-1 name=__codelineno-54-1></a><span class=k>using</span><span class=w> </span><span class=nn>WallstopStudios.UnityHelpers.Core.Helper</span><span class=p>;</span>
</span><span id=__span-54-2><a id=__codelineno-54-2 name=__codelineno-54-2></a>
</span><span id=__span-54-3><a id=__codelineno-54-3 name=__codelineno-54-3></a><span class=c1>// Get all known sprite labels</span>
</span><span id=__span-54-4><a id=__codelineno-54-4 name=__codelineno-54-4></a><span class=kt>string</span><span class=p>[]</span><span class=w> </span><span class=n>allLabels</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>Helpers</span><span class=p>.</span><span class=n>GetAllSpriteLabelNames</span><span class=p>();</span>
</span><span id=__span-54-5><a id=__codelineno-54-5 name=__codelineno-54-5></a>
</span><span id=__span-54-6><a id=__codelineno-54-6 name=__codelineno-54-6></a><span class=c1>// Used internally by StringInList attribute</span>
</span><span id=__span-54-7><a id=__codelineno-54-7 name=__codelineno-54-7></a><span class=na>[StringInList(typeof(Helpers), nameof(Helpers.GetAllSpriteLabelNames))]</span>
</span><span id=__span-54-8><a id=__codelineno-54-8 name=__codelineno-54-8></a><span class=k>public</span><span class=w> </span><span class=n>List</span><span class=o><</span><span class=kt>string</span><span class=o>></span><span class=w> </span><span class=n>selectedLabels</span><span class=p>;</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Cache Updates:</strong></p> <ul> <li>On sprite import/reimport</li> <li>When labels added/removed from sprites</li> <li>After asset database refresh</li> <li>Automatically during asset post-processing</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Tools requiring sprite label selection</li> <li>DropDown menus for label filtering</li> <li>Maintaining label consistency across the project</li> <li>Fast label-based sprite queries</li> </ul> <p><strong>Technical Notes:</strong></p> <ul> <li>Skips execution in batch mode and CI environments</li> <li>Uses efficient HashSet for uniqueness checks</li> <li>Sorted results for a consistent UI display</li> <li>Thread-safe cache updates</li> </ul> <hr> <h3 id=attribute-metadata-cache-generator>Attribute Metadata Cache Generator<a class=headerlink href=#attribute-metadata-cache-generator title="Permanent link">¶</a></h3> <p><strong>Type:</strong> Automatic (runs on editor load and domain reload)</p> <p><strong>Purpose:</strong> Pre-generate attribute system metadata at edit time to eliminate runtime reflection overhead. The cache is automatically regenerated when scripts change. You can manually refresh it via the "Purge & Refresh Cache" button in the <code>AttributeMetadataCache</code> asset inspector.</p> <p><strong>What Gets Cached:</strong></p> <ul> <li>All "Attribute" fields across AttributesComponent types</li> <li>Relational metadata ([ParentComponent], [ChildComponent], [SiblingComponent])</li> <li>Assembly-qualified type names for runtime resolution</li> <li>Field types (single, array, List, HashSet)</li> <li>Interface detection for polymorphic queries</li> </ul> <p><strong>Performance Benefits:</strong></p> <ul> <li>✅ Eliminates reflection overhead during attribute initialization</li> <li>✅ Reduces first-frame lag when attribute components awake</li> <li>✅ Enables fast attribute name lookups for UI</li> <li>✅ Optimizes relational component queries</li> <li>✅ Supports IL2CPP ahead-of-time compilation</li> </ul> <p><strong>Runtime Usage:</strong></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-55-1> 1</a></span>
<span class=normal><a href=#__codelineno-55-2> 2</a></span>
<span class=normal><a href=#__codelineno-55-3> 3</a></span>
<span class=normal><a href=#__codelineno-55-4> 4</a></span>
<span class=normal><a href=#__codelineno-55-5> 5</a></span>
<span class=normal><a href=#__codelineno-55-6> 6</a></span>
<span class=normal><a href=#__codelineno-55-7> 7</a></span>
<span class=normal><a href=#__codelineno-55-8> 8</a></span>
<span class=normal><a href=#__codelineno-55-9> 9</a></span>
<span class=normal><a href=#__codelineno-55-10>10</a></span>
<span class=normal><a href=#__codelineno-55-11>11</a></span>
<span class=normal><a href=#__codelineno-55-12>12</a></span>
<span class=normal><a href=#__codelineno-55-13>13</a></span>
<span class=normal><a href=#__codelineno-55-14>14</a></span>
<span class=normal><a href=#__codelineno-55-15>15</a></span>
<span class=normal><a href=#__codelineno-55-16>16</a></span>
<span class=normal><a href=#__codelineno-55-17>17</a></span>
<span class=normal><a href=#__codelineno-55-18>18</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-55-1><a id=__codelineno-55-1 name=__codelineno-55-1></a><span class=c1>// Cache is loaded automatically:</span>
</span><span id=__span-55-2><a id=__codelineno-55-2 name=__codelineno-55-2></a><span class=n>AttributeMetadataCache</span><span class=w> </span><span class=n>cache</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>AttributeMetadataCache</span><span class=p>.</span><span class=n>Instance</span><span class=p>;</span>
</span><span id=__span-55-3><a id=__codelineno-55-3 name=__codelineno-55-3></a>
</span><span id=__span-55-4><a id=__codelineno-55-4 name=__codelineno-55-4></a><span class=c1>// Get all known attribute names:</span>
</span><span id=__span-55-5><a id=__codelineno-55-5 name=__codelineno-55-5></a><span class=kt>string</span><span class=p>[]</span><span class=w> </span><span class=n>allAttributes</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>cache</span><span class=p>.</span><span class=n>AllAttributeNames</span><span class=p>;</span>
</span><span id=__span-55-6><a id=__codelineno-55-6 name=__codelineno-55-6></a>
</span><span id=__span-55-7><a id=__codelineno-55-7 name=__codelineno-55-7></a><span class=c1>// Check type for attribute fields:</span>
</span><span id=__span-55-8><a id=__codelineno-55-8 name=__codelineno-55-8></a><span class=n>TypeFieldMetadata</span><span class=w> </span><span class=n>metadata</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>cache</span><span class=p>.</span><span class=n>GetMetadataForType</span><span class=p>(</span><span class=k>typeof</span><span class=p>(</span><span class=n>MyAttributesComponent</span><span class=p>));</span>
</span><span id=__span-55-9><a id=__codelineno-55-9 name=__codelineno-55-9></a><span class=k>if</span><span class=w> </span><span class=p>(</span><span class=n>metadata</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-55-10><a id=__codelineno-55-10 name=__codelineno-55-10></a><span class=p>{</span>
</span><span id=__span-55-11><a id=__codelineno-55-11 name=__codelineno-55-11></a><span class=w> </span><span class=k>foreach</span><span class=w> </span><span class=p>(</span><span class=kt>string</span><span class=w> </span><span class=n>fieldName</span><span class=w> </span><span class=k>in</span><span class=w> </span><span class=n>metadata</span><span class=p>.</span><span class=n>AttributeFieldNames</span><span class=p>)</span>
</span><span id=__span-55-12><a id=__codelineno-55-12 name=__codelineno-55-12></a><span class=w> </span><span class=p>{</span>
</span><span id=__span-55-13><a id=__codelineno-55-13 name=__codelineno-55-13></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>$"Found attribute field: {fieldName}"</span><span class=p>);</span>
</span><span id=__span-55-14><a id=__codelineno-55-14 name=__codelineno-55-14></a><span class=w> </span><span class=p>}</span>
</span><span id=__span-55-15><a id=__codelineno-55-15 name=__codelineno-55-15></a><span class=p>}</span>
</span><span id=__span-55-16><a id=__codelineno-55-16 name=__codelineno-55-16></a>
</span><span id=__span-55-17><a id=__codelineno-55-17 name=__codelineno-55-17></a><span class=c1>// Query relational component metadata:</span>
</span><span id=__span-55-18><a id=__codelineno-55-18 name=__codelineno-55-18></a><span class=n>RelationalTypeMetadata</span><span class=w> </span><span class=n>relational</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>cache</span><span class=p>.</span><span class=n>GetRelationalMetadataForType</span><span class=p>(</span><span class=k>typeof</span><span class=p>(</span><span class=n>MyComponent</span><span class=p>));</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Cache Regenerates:</strong></p> <ul> <li>On Unity editor startup (automatic)</li> <li>After script recompilation (automatic)</li> <li>Manual trigger via menu item</li> <li>After domain reload in the editor</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Large projects with many attribute-based components</li> <li>Games using extensive parent/child relationships</li> <li>Optimizing startup time for complex prefabs</li> <li>IL2CPP builds where reflection is expensive</li> <li>Tools that need to enumerate available attributes</li> </ul> <hr> <h3 id=editor-utilities>Editor Utilities<a class=headerlink href=#editor-utilities title="Permanent link">¶</a></h3> <ul> <li><strong>Type:</strong> Static utility class</li> <li><strong>Namespace:</strong> <code>WallstopStudios.UnityHelpers.Editor.Utils</code></li> </ul> <p><strong>Purpose:</strong> Helper methods for Unity Editor operations.</p> <p><strong>Available Methods:</strong></p> <h4 id=getcurrentpathofprojectwindow><code>GetCurrentPathOfProjectWindow()</code><a class=headerlink href=#getcurrentpathofprojectwindow title="Permanent link">¶</a></h4> <p>Gets the currently selected folder in Unity's Project window.</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-56-1> 1</a></span>
<span class=normal><a href=#__codelineno-56-2> 2</a></span>
<span class=normal><a href=#__codelineno-56-3> 3</a></span>
<span class=normal><a href=#__codelineno-56-4> 4</a></span>
<span class=normal><a href=#__codelineno-56-5> 5</a></span>
<span class=normal><a href=#__codelineno-56-6> 6</a></span>
<span class=normal><a href=#__codelineno-56-7> 7</a></span>
<span class=normal><a href=#__codelineno-56-8> 8</a></span>
<span class=normal><a href=#__codelineno-56-9> 9</a></span>
<span class=normal><a href=#__codelineno-56-10>10</a></span>
<span class=normal><a href=#__codelineno-56-11>11</a></span>
<span class=normal><a href=#__codelineno-56-12>12</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-56-1><a id=__codelineno-56-1 name=__codelineno-56-1></a><span class=c1>// In an editor window or wizard:</span>
</span><span id=__span-56-2><a id=__codelineno-56-2 name=__codelineno-56-2></a><span class=kt>string</span><span class=w> </span><span class=n>currentFolder</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=n>EditorUtilities</span><span class=p>.</span><span class=n>GetCurrentPathOfProjectWindow</span><span class=p>();</span>
</span><span id=__span-56-3><a id=__codelineno-56-3 name=__codelineno-56-3></a><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>currentFolder</span><span class=p>))</span>
</span><span id=__span-56-4><a id=__codelineno-56-4 name=__codelineno-56-4></a><span class=p>{</span>
</span><span id=__span-56-5><a id=__codelineno-56-5 name=__codelineno-56-5></a><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>newAssetPath</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s>$"{currentFolder}/NewGeneratedAsset.asset"</span><span class=p>;</span>
</span><span id=__span-56-6><a id=__codelineno-56-6 name=__codelineno-56-6></a><span class=w> </span><span class=n>AssetDatabase</span><span class=p>.</span><span class=n>CreateAsset</span><span class=p>(</span><span class=n>myAsset</span><span class=p>,</span><span class=w> </span><span class=n>newAssetPath</span><span class=p>);</span>
</span><span id=__span-56-7><a id=__codelineno-56-7 name=__codelineno-56-7></a><span class=p>}</span>
</span><span id=__span-56-8><a id=__codelineno-56-8 name=__codelineno-56-8></a><span class=k>else</span>
</span><span id=__span-56-9><a id=__codelineno-56-9 name=__codelineno-56-9></a><span class=p>{</span>
</span><span id=__span-56-10><a id=__codelineno-56-10 name=__codelineno-56-10></a><span class=w> </span><span class=c1>// Fallback to default location</span>
</span><span id=__span-56-11><a id=__codelineno-56-11 name=__codelineno-56-11></a><span class=w> </span><span class=n>AssetDatabase</span><span class=p>.</span><span class=n>CreateAsset</span><span class=p>(</span><span class=n>myAsset</span><span class=p>,</span><span class=w> </span><span class=s>"Assets/NewGeneratedAsset.asset"</span><span class=p>);</span>
</span><span id=__span-56-12><a id=__codelineno-56-12 name=__codelineno-56-12></a><span class=p>}</span>
</span></code></pre></div></td></tr></table></div> <p><strong>Returns:</strong> Asset-relative path (e.g., "Assets/Scripts/Editor") or empty string.</p> <p><strong>Use Cases:</strong></p> <ul> <li>Asset creation wizards defaulting to the selected folder</li> <li>Context menu extensions operating on the current location</li> <li>Batch processing tools respecting working directory</li> </ul> <p><strong>Technical Notes:</strong></p> <ul> <li>Uses reflection to access internal Unity API</li> <li>May break in future Unity versions</li> <li>Returns empty string on failure (no exceptions)</li> </ul> <p><strong>Best For:</strong></p> <ul> <li>Context-aware asset creation</li> <li>User-friendly editor tools</li> <li>Respecting the current working directory</li> </ul> <hr> <p><a id=failed-tests-exporter></a></p> <h3 id=failed-tests-exporter>Failed Tests Exporter<a class=headerlink href=#failed-tests-exporter title="Permanent link">¶</a></h3> <ul> <li><strong>Menu:</strong> <code>Tools > Wallstop Studios > Unity Helpers > Export Failed Tests</code> / <code>Clear Failed Tests</code></li> <li><strong>Settings:</strong> <code>Edit > Project Settings > Wallstop Studios > Unity Helpers</code></li> </ul> <p><strong>Purpose:</strong> Hooks into the Unity Test Runner API to automatically capture failed test results and export them to timestamped text files in a configurable directory (defaults to the project root). Disabled by default — enable in Project Settings.</p> <p><strong>Key Features:</strong></p> <ul> <li>Automatically records test name, failure message, and stack trace for each failed test</li> <li>Exports failures to <code>failed-tests-YYYY-MM-DD-HHmmss.txt</code> in the configured output directory (project root by default)</li> <li>Configurable output directory with folder picker — defaults to the project root</li> <li>Menu items to manually export or clear captured failures</li> <li>Useful for CI/CD pipelines and tracking intermittent test failures</li> </ul> <p>For full setup, usage, and API reference, see <a href=../failed-tests-exporter/ >Failed Tests Exporter</a>.</p> <hr> <h2 id=quick-reference>Quick Reference<a class=headerlink href=#quick-reference title="Permanent link">¶</a></h2> <h3 id=tools-by-category>Tools by Category<a class=headerlink href=#tools-by-category title="Permanent link">¶</a></h3> <p><strong>Image Processing:</strong></p> <ul> <li>Image Blur Tool - Gaussian blur effects</li> <li>Sprite Cropper - Remove transparent padding</li> <li>Texture Settings Applier - Batch import settings</li> <li>Sprite Settings Applier - Sprite-specific settings</li> <li>Sprite Pivot Adjuster - Pivot point adjustment</li> <li>Texture Resizer - Resize textures with bilinear/point algorithms</li> <li>Fit Texture Size - Auto-fit texture max size to source dimensions</li> </ul> <p><strong>Animation:</strong></p> <ul> <li>Sprite Animation Editor - Visual animation editing with preview</li> <li>Animation Event Editor - Visual animation event editing with sprite preview</li> <li>Animation Creator - Bulk-create clips from naming patterns</li> <li>Animation Copier - Duplicate and manage clips</li> <li>Sprite Sheet Animation Creator - Convert atlases to clips</li> </ul> <p><strong>Sprite Atlases:</strong></p> <ul> <li>Sprite Atlas Generator - Regex/label-based atlas creation and packing</li> </ul> <p><strong>Quality & Validation:</strong></p> <ul> <li>Prefab Checker - Comprehensive prefab validation</li> </ul> <p><strong>Custom Editors:</strong></p> <ul> <li>MatchColliderToSprite Editor - Manual collider matching</li> <li>PolygonCollider2DOptimizer Editor - Collider simplification</li> <li>EnhancedImage Editor - HDR color and shape mask support</li> </ul> <p><strong>Property Drawers:</strong></p> <ul> <li>WShowIf - Conditional field visibility</li> <li>StringInList - DropDown selection for strings</li> <li>IntDropDown - DropDown selection for integers</li> <li>WReadOnly - Read-only inspector fields</li> </ul> <p><strong>Automation:</strong></p> <ul> <li>ScriptableObject Singleton Creator - Auto-create singletons</li> <li>Attribute Metadata Cache Generator - Performance optimization</li> <li>Sprite Label Processor - Automatic sprite label caching</li> <li>Failed Tests Exporter - Capture and export test failures</li> </ul> <p><strong>Utilities:</strong></p> <ul> <li>Editor Utilities - Helper methods for editor scripting</li> </ul> <hr> <h3 id=all-menu-items>All Menu Items<a class=headerlink href=#all-menu-items title="Permanent link">¶</a></h3> <p><strong>Tools > Wallstop Studios > Unity Helpers:</strong></p> <ul> <li>Animation Copier</li> <li>Animation Creator</li> <li>AnimationEvent Editor</li> <li>Fit Texture Size</li> <li>Image Blur</li> <li>Prefab Checker</li> <li>Sprite Animation Editor</li> <li>Sprite Atlas Generator</li> <li>Sprite Cropper</li> <li>Sprite Pivot Adjuster</li> <li>Sprite Settings Applier</li> <li>Sprite Sheet Animation Creator</li> <li>Sprite Sheet Extractor</li> <li>Texture Resizer</li> <li>Texture Settings Applier</li> <li>Export Failed Tests</li> <li>Clear Failed Tests</li> </ul> <p><strong>Assets > Create > Wallstop Studios > Unity Helpers:</strong></p> <ul> <li>Scriptable Sprite Atlas Config</li> </ul> <hr> <h3 id=common-workflows>Common Workflows<a class=headerlink href=#common-workflows title="Permanent link">¶</a></h3> <h4 id=setting-up-new-sprites>Setting Up New Sprites<a class=headerlink href=#setting-up-new-sprites title="Permanent link">¶</a></h4> <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-57-1>1</a></span>
<span class=normal><a href=#__codelineno-57-2>2</a></span>
<span class=normal><a href=#__codelineno-57-3>3</a></span>
<span class=normal><a href=#__codelineno-57-4>4</a></span>
<span class=normal><a href=#__codelineno-57-5>5</a></span>
<span class=normal><a href=#__codelineno-57-6>6</a></span>
<span class=normal><a href=#__codelineno-57-7>7</a></span>
<span class=normal><a href=#__codelineno-57-8>8</a></span>
<span class=normal><a href=#__codelineno-57-9>9</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-57-1><a id=__codelineno-57-1 name=__codelineno-57-1></a>1. Import sprites to Assets/Sprites/
</span><span id=__span-57-2><a id=__codelineno-57-2 name=__codelineno-57-2></a>2. Use Sprite Cropper to remove padding
</span><span id=__span-57-3><a id=__codelineno-57-3 name=__codelineno-57-3></a>3. Use Texture Settings Applier:
</span><span id=__span-57-4><a id=__codelineno-57-4 name=__codelineno-57-4></a> - Filter Mode: Bilinear
</span><span id=__span-57-5><a id=__codelineno-57-5 name=__codelineno-57-5></a> - Wrap Mode: Clamp
</span><span id=__span-57-6><a id=__codelineno-57-6 name=__codelineno-57-6></a> - Compression: CompressedHQ
</span><span id=__span-57-7><a id=__codelineno-57-7 name=__codelineno-57-7></a>4. Use Sprite Settings Applier:
</span><span id=__span-57-8><a id=__codelineno-57-8 name=__codelineno-57-8></a> - Set consistent PPU (e.g., 32 or 64)
</span><span id=__span-57-9><a id=__codelineno-57-9 name=__codelineno-57-9></a>5. Use Sprite Pivot Adjuster for consistent alignment
</span></code></pre></div></td></tr></table></div> <h4 id=creating-and-editing-animations>Creating and Editing Animations<a class=headerlink href=#creating-and-editing-animations title="Permanent link">¶</a></h4> <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-58-1> 1</a></span>
<span class=normal><a href=#__codelineno-58-2> 2</a></span>
<span class=normal><a href=#__codelineno-58-3> 3</a></span>
<span class=normal><a href=#__codelineno-58-4> 4</a></span>
<span class=normal><a href=#__codelineno-58-5> 5</a></span>
<span class=normal><a href=#__codelineno-58-6> 6</a></span>
<span class=normal><a href=#__codelineno-58-7> 7</a></span>
<span class=normal><a href=#__codelineno-58-8> 8</a></span>
<span class=normal><a href=#__codelineno-58-9> 9</a></span>
<span class=normal><a href=#__codelineno-58-10>10</a></span>
<span class=normal><a href=#__codelineno-58-11>11</a></span>
<span class=normal><a href=#__codelineno-58-12>12</a></span>
<span class=normal><a href=#__codelineno-58-13>13</a></span>
<span class=normal><a href=#__codelineno-58-14>14</a></span>
<span class=normal><a href=#__codelineno-58-15>15</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-58-1><a id=__codelineno-58-1 name=__codelineno-58-1></a>1. Prepare sprite frames in folder
</span><span id=__span-58-2><a id=__codelineno-58-2 name=__codelineno-58-2></a>2. Open Sprite Animation Editor
</span><span id=__span-58-3><a id=__codelineno-58-3 name=__codelineno-58-3></a>3. Click "Browse Clips (Multi)..." if clips exist, or
</span><span id=__span-58-4><a id=__codelineno-58-4 name=__codelineno-58-4></a>4. Use Animation Creator to generate from sprites
</span><span id=__span-58-5><a id=__codelineno-58-5 name=__codelineno-58-5></a>5. Edit in Sprite Animation Editor:
</span><span id=__span-58-6><a id=__codelineno-58-6 name=__codelineno-58-6></a> - Adjust frame order via drag-drop
</span><span id=__span-58-7><a id=__codelineno-58-7 name=__codelineno-58-7></a> - Set appropriate FPS
</span><span id=__span-58-8><a id=__codelineno-58-8 name=__codelineno-58-8></a>6. Save clips
</span><span id=__span-58-9><a id=__codelineno-58-9 name=__codelineno-58-9></a>7. (Optional) Add animation events:
</span><span id=__span-58-10><a id=__codelineno-58-10 name=__codelineno-58-10></a> a. Open AnimationEvent Editor
</span><span id=__span-58-11><a id=__codelineno-58-11 name=__codelineno-58-11></a> b. Drag Animator to "Animator Object" field
</span><span id=__span-58-12><a id=__codelineno-58-12 name=__codelineno-58-12></a> c. Select animation clip
</span><span id=__span-58-13><a id=__codelineno-58-13 name=__codelineno-58-13></a> d. Add events at specific frames
</span><span id=__span-58-14><a id=__codelineno-58-14 name=__codelineno-58-14></a> e. Configure event methods and parameters
</span><span id=__span-58-15><a id=__codelineno-58-15 name=__codelineno-58-15></a> f. Save changes
</span></code></pre></div></td></tr></table></div> <h4 id=creating-sprite-atlases>Creating Sprite Atlases<a class=headerlink href=#creating-sprite-atlases title="Permanent link">¶</a></h4> <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-59-1> 1</a></span>
<span class=normal><a href=#__codelineno-59-2> 2</a></span>
<span class=normal><a href=#__codelineno-59-3> 3</a></span>
<span class=normal><a href=#__codelineno-59-4> 4</a></span>
<span class=normal><a href=#__codelineno-59-5> 5</a></span>
<span class=normal><a href=#__codelineno-59-6> 6</a></span>
<span class=normal><a href=#__codelineno-59-7> 7</a></span>
<span class=normal><a href=#__codelineno-59-8> 8</a></span>
<span class=normal><a href=#__codelineno-59-9> 9</a></span>
<span class=normal><a href=#__codelineno-59-10>10</a></span>
<span class=normal><a href=#__codelineno-59-11>11</a></span>
<span class=normal><a href=#__codelineno-59-12>12</a></span>
<span class=normal><a href=#__codelineno-59-13>13</a></span>
<span class=normal><a href=#__codelineno-59-14>14</a></span>
<span class=normal><a href=#__codelineno-59-15>15</a></span>
<span class=normal><a href=#__codelineno-59-16>16</a></span>
<span class=normal><a href=#__codelineno-59-17>17</a></span>
<span class=normal><a href=#__codelineno-59-18>18</a></span>
<span class=normal><a href=#__codelineno-59-19>19</a></span>
<span class=normal><a href=#__codelineno-59-20>20</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-59-1><a id=__codelineno-59-1 name=__codelineno-59-1></a>1. Create atlas config:
</span><span id=__span-59-2><a id=__codelineno-59-2 name=__codelineno-59-2></a> a. Open Sprite Atlas Generator
</span><span id=__span-59-3><a id=__codelineno-59-3 name=__codelineno-59-3></a> b. Click "Create New Config in 'Assets/Data'"
</span><span id=__span-59-4><a id=__codelineno-59-4 name=__codelineno-59-4></a> c. Name your atlas configuration
</span><span id=__span-59-5><a id=__codelineno-59-5 name=__codelineno-59-5></a>2. Configure source folders:
</span><span id=__span-59-6><a id=__codelineno-59-6 name=__codelineno-59-6></a> a. Click "Add New Source Folder Entry"
</span><span id=__span-59-7><a id=__codelineno-59-7 name=__codelineno-59-7></a> b. Select folder containing sprites
</span><span id=__span-59-8><a id=__codelineno-59-8 name=__codelineno-59-8></a> c. Add regex patterns (e.g., "^character_.*")
</span><span id=__span-59-9><a id=__codelineno-59-9 name=__codelineno-59-9></a> d. Or add labels for filtering
</span><span id=__span-59-10><a id=__codelineno-59-10 name=__codelineno-59-10></a>3. Set packing options:
</span><span id=__span-59-11><a id=__codelineno-59-11 name=__codelineno-59-11></a> - Max texture size (2048 recommended)
</span><span id=__span-59-12><a id=__codelineno-59-12 name=__codelineno-59-12></a> - Padding (4px default)
</span><span id=__span-59-13><a id=__codelineno-59-13 name=__codelineno-59-13></a> - Compression settings
</span><span id=__span-59-14><a id=__codelineno-59-14 name=__codelineno-59-14></a>4. Preview changes:
</span><span id=__span-59-15><a id=__codelineno-59-15 name=__codelineno-59-15></a> a. Click "Scan Folders"
</span><span id=__span-59-16><a id=__codelineno-59-16 name=__codelineno-59-16></a> b. Review sprites to add/remove
</span><span id=__span-59-17><a id=__codelineno-59-17 name=__codelineno-59-17></a>5. Generate atlas:
</span><span id=__span-59-18><a id=__codelineno-59-18 name=__codelineno-59-18></a> a. Click "Add X Sprites" if satisfied
</span><span id=__span-59-19><a id=__codelineno-59-19 name=__codelineno-59-19></a> b. Click "Generate/Update .spriteatlas ONLY"
</span><span id=__span-59-20><a id=__codelineno-59-20 name=__codelineno-59-20></a> c. Click "Pack All Generated Sprite Atlases"
</span></code></pre></div></td></tr></table></div> <h4 id=pre-commit-validation>Pre-Commit Validation<a class=headerlink href=#pre-commit-validation title="Permanent link">¶</a></h4> <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-60-1> 1</a></span>
<span class=normal><a href=#__codelineno-60-2> 2</a></span>
<span class=normal><a href=#__codelineno-60-3> 3</a></span>
<span class=normal><a href=#__codelineno-60-4> 4</a></span>
<span class=normal><a href=#__codelineno-60-5> 5</a></span>
<span class=normal><a href=#__codelineno-60-6> 6</a></span>
<span class=normal><a href=#__codelineno-60-7> 7</a></span>
<span class=normal><a href=#__codelineno-60-8> 8</a></span>
<span class=normal><a href=#__codelineno-60-9> 9</a></span>
<span class=normal><a href=#__codelineno-60-10>10</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-60-1><a id=__codelineno-60-1 name=__codelineno-60-1></a>1. Open Prefab Checker
</span><span id=__span-60-2><a id=__codelineno-60-2 name=__codelineno-60-2></a>2. Enable all critical checks:
</span><span id=__span-60-3><a id=__codelineno-60-3 name=__codelineno-60-3></a> - Missing Scripts ✓
</span><span id=__span-60-4><a id=__codelineno-60-4 name=__codelineno-60-4></a> - Missing Required Components ✓
</span><span id=__span-60-5><a id=__codelineno-60-5 name=__codelineno-60-5></a> - Null Object References ✓
</span><span id=__span-60-6><a id=__codelineno-60-6 name=__codelineno-60-6></a>3. Add changed prefab folders
</span><span id=__span-60-7><a id=__codelineno-60-7 name=__codelineno-60-7></a>4. Click "Run Checks"
</span><span id=__span-60-8><a id=__codelineno-60-8 name=__codelineno-60-8></a>5. Fix all reported issues
</span><span id=__span-60-9><a id=__codelineno-60-9 name=__codelineno-60-9></a>6. Re-run to verify
</span><span id=__span-60-10><a id=__codelineno-60-10 name=__codelineno-60-10></a>7. Commit changes
</span></code></pre></div></td></tr></table></div> <h4 id=optimizing-textures-for-build>Optimizing Textures for Build<a class=headerlink href=#optimizing-textures-for-build title="Permanent link">¶</a></h4> <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-61-1>1</a></span>
<span class=normal><a href=#__codelineno-61-2>2</a></span>
<span class=normal><a href=#__codelineno-61-3>3</a></span>
<span class=normal><a href=#__codelineno-61-4>4</a></span>
<span class=normal><a href=#__codelineno-61-5>5</a></span>
<span class=normal><a href=#__codelineno-61-6>6</a></span>
<span class=normal><a href=#__codelineno-61-7>7</a></span></pre></div></td><td class=code><div><pre><span></span><code><span id=__span-61-1><a id=__codelineno-61-1 name=__codelineno-61-1></a>1. Use Sprite Cropper on all sprites (reduces memory)
</span><span id=__span-61-2><a id=__codelineno-61-2 name=__codelineno-61-2></a>2. Use Texture Settings Applier with:
</span><span id=__span-61-3><a id=__codelineno-61-3 name=__codelineno-61-3></a> - Appropriate compression for platform
</span><span id=__span-61-4><a id=__codelineno-61-4 name=__codelineno-61-4></a> - Crunch compression enabled
</span><span id=__span-61-5><a id=__codelineno-61-5 name=__codelineno-61-5></a> - Proper max texture sizes
</span><span id=__span-61-6><a id=__codelineno-61-6 name=__codelineno-61-6></a>3. Review build report for texture memory usage
</span><span id=__span-61-7><a id=__codelineno-61-7 name=__codelineno-61-7></a>4. Iterate on settings as needed
</span></code></pre></div></td></tr></table></div> <hr> <h3 id=keyboard-shortcuts-tips>Keyboard Shortcuts & Tips<a class=headerlink href=#keyboard-shortcuts-tips title="Permanent link">¶</a></h3> <p><strong>Sprite Animation Editor:</strong></p> <ul> <li><code>Enter</code> in frame order field: Apply frame reordering</li> <li>Drag frames: Reorder via visual feedback</li> <li>Drag clips: Reorder layer priority</li> </ul> <p><strong>Prefab Checker:</strong></p> <ul> <li>Click console errors: Selects problematic prefabs</li> <li>Toggle checks: Right-aligned checkboxes</li> </ul> <p><strong>General:</strong></p> <ul> <li>All tools remember last used directories</li> <li>Most tools support drag-and-drop folders</li> <li>Batch operations show progress in the console</li> </ul> <hr> <h3 id=performance-considerations>Performance Considerations<a class=headerlink href=#performance-considerations title="Permanent link">¶</a></h3> <p><strong>Sprite Cropper:</strong></p> <ul> <li>Uses parallel processing for pixel scanning</li> <li>Can process hundreds of sprites quickly</li> <li>Memory usage scales with sprite size</li> </ul> <p><strong>Texture Settings Applier:</strong></p> <ul> <li>Triggers Unity reimport for affected textures</li> <li>May take time on large texture sets</li> <li>Refresh only happens once after all changes</li> </ul> <p><strong>Prefab Checker:</strong></p> <ul> <li>Caches reflection metadata for speed</li> <li>Fast on repeated runs</li> <li>Scales linearly with prefab count</li> </ul> <p><strong>Attribute Metadata Cache:</strong></p> <ul> <li>Eliminates ~95% of runtime reflection overhead</li> <li>Startup time improvement: 50-200ms on large projects</li> <li>Critical for IL2CPP builds</li> </ul> <hr> <h3 id=troubleshooting>Troubleshooting<a class=headerlink href=#troubleshooting title="Permanent link">¶</a></h3> <p><strong>Tool window won't open:</strong></p> <ul> <li>Check the console for errors</li> <li>Verify that the package is in the correct location</li> <li>Try reimporting package</li> </ul> <p><strong>Settings not applying:</strong></p> <ul> <li>Ensure textures aren't in use</li> <li>Check the console for import errors</li> <li>Verify file permissions</li> </ul> <p><strong>Cache not regenerating:</strong></p> <ul> <li>Manually trigger via menu</li> <li>Check for script compilation errors</li> <li>Verify ScriptableObject singleton exists</li> </ul> <p><strong>Prefab Checker missing issues:</strong></p> <ul> <li>Ensure all relevant checks are enabled</li> <li>Verify folders are correct</li> <li>Check filter settings</li> </ul> <hr> <h3 id=best-practices>Best Practices<a class=headerlink href=#best-practices title="Permanent link">¶</a></h3> <p><strong>Organization:</strong></p> <ul> <li>Keep sprites in an organized folder structure</li> <li>Use consistent naming conventions</li> <li>Separate by type (UI, Characters, Environment)</li> </ul> <p><strong>Performance:</strong></p> <ul> <li>Run Sprite Cropper before creating atlases</li> <li>Use appropriate texture compression</li> <li>Enable crunch compression for mobile</li> </ul> <p><strong>Quality:</strong></p> <ul> <li>Run Prefab Checker before commits</li> <li>Use [ValidateAssignment] on critical fields</li> <li>Maintain consistent texture settings per category</li> <li>Use the manual recompilation menu/shortcut when iterating on packages to avoid reopening the project</li> </ul> <p><strong>Workflow:</strong></p> <ul> <li>Batch similar operations together</li> <li>Use multi-file selection where available</li> <li>Leverage automation tools (SingletonCreator, CacheGenerator)</li> </ul> <p><strong>Compilation helpers:</strong></p> <ul> <li>Menu path: <code>Tools > Wallstop Studios > Unity Helpers > Request Script Compilation</code></li> <li>Shortcut: <code>Ctrl/Cmd + Alt + R</code> (configurable via Unity’s Shortcut Manager under <em>Wallstop / Request Script Compilation</em>)</li> <li>Behavior: Forces an <code>AssetDatabase.Refresh</code> (synchronous import) before calling <code>CompilationPipeline.RequestScriptCompilation()</code> and logs whenever Unity is already compiling so scripts created outside the editor are imported immediately.</li> </ul> <hr> <h3 id=additional-resources>Additional Resources<a class=headerlink href=#additional-resources title="Permanent link">¶</a></h3> <p><strong>Attributes System:</strong></p> <ul> <li>See <code>[ValidateAssignment]</code> for prefab validation</li> <li>See <code>[ScriptableSingletonPath]</code> for custom singleton paths</li> <li>See <code>[ParentComponent]</code>, <code>[ChildComponent]</code>, <code>[SiblingComponent]</code> for relational queries</li> </ul> <p><strong>Related Components:</strong></p> <ul> <li><code>ScriptableObjectSingleton<T></code> - Base class for settings</li> <li><code>AttributesComponent</code> - Base class for the attribute system</li> <li><code>LayeredImage</code> - UI Toolkit multi-layer sprite rendering</li> </ul> <hr> <h2 id=version-information>Version Information<a class=headerlink href=#version-information title="Permanent link">¶</a></h2> <p>Document Version: 2.0 Package: com.wallstop-studios.unity-helpers Last Updated: 2025-10-08</p> <p><strong>What's New in v2.0:</strong></p> <ul> <li>Added comprehensive Sprite Atlas Generator documentation</li> <li>Added Animation Event Editor documentation</li> <li>Added Texture Resizer and Fit Texture Size tools</li> <li>Added Custom Component Editors section</li> <li>Added Property Drawers & Attributes section</li> <li>Added Sprite Label Processor documentation</li> <li>Expanded all existing tool documentation</li> <li>Added new workflow examples</li> <li>Complete menu item reference</li> <li>Enhanced quick reference section</li> </ul> <hr> <h2 id=summary>Summary<a class=headerlink href=#summary title="Permanent link">¶</a></h2> <p>This package provides <strong>20+ editor tools</strong> across multiple categories:</p> <p><strong>14 Editor Windows/Wizards:</strong></p> <ul> <li>Image Blur Tool, Sprite Cropper, Texture Settings Applier, Sprite Settings Applier</li> <li>Sprite Pivot Adjuster, Texture Resizer, Fit Texture Size</li> <li>Sprite Animation Editor, Animation Event Editor, Animation Creator, Animation Copier</li> <li>Sprite Sheet Animation Creator, Sprite Atlas Generator, Prefab Checker</li> </ul> <p><strong>3 Custom Component Editors:</strong></p> <ul> <li>MatchColliderToSprite, PolygonCollider2DOptimizer, EnhancedImage</li> </ul> <p><strong>4 Property Drawers:</strong></p> <ul> <li>WShowIf, StringInList, IntDropDown, WReadOnly</li> </ul> <p><strong>3 Automated Systems:</strong></p> <ul> <li>ScriptableObject Singleton Creator</li> <li>Attribute Metadata Cache Generator</li> <li>Sprite Label Processor</li> </ul> <p><strong>1 Utility Library:</strong></p> <ul> <li>Editor Utilities</li> </ul> <p>All tools are designed to work together seamlessly and follow consistent design patterns for ease of use.</p> <hr> <p>For questions, issues, or feature requests, please contact the Wallstop Studios team.</p> <ul> <li>Integration note: The cache powers editor dropdowns and reflection shortcuts for the Effects system’s <code>AttributeModification.attribute</code> field. See <a href=../../effects/effects-system/ >Effects System</a> for how attributes, effects, and tags fit together.</li> </ul> <h3 id=multifile-selector-ui-toolkit>MultiFile Selector (UI Toolkit)<a class=headerlink href=#multifile-selector-ui-toolkit title="Permanent link">¶</a></h3> <ul> <li>The <code>MultiFileSelectorElement</code> is primarily intended for Editor tooling. It can also be used in player builds, where it enumerates files under the application’s data root. In the Editor it integrates with <code>EditorPrefs</code> and Reveal-in-Finder; at runtime it falls back to <code>PlayerPrefs</code> and omits Editor-only affordances.</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="March 1, 2026 19:59:30 UTC"><span class=timeago datetime=2026-03-01T19:59:30+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="March 1, 2026 19:59:30 UTC">2026-03-01</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=../../logging/unity-main-thread-dispatcher/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Main Thread Dispatcher"> <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> Main Thread Dispatcher </div> </div> </a> <a href=../unity-method-analyzer/ class="md-footer__link md-footer__link--next" aria-label="Next: Unity Method Analyzer"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Unity Method Analyzer </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>