com.wallstop-studios.dxmessaging 2.1.5 → 2.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (161) hide show
  1. package/.artifacts/SourceGenerators.Tests/obj/Debug/net9.0/WallstopStudios.DxMessaging.SourceGenerators.Tests.AssemblyInfo.cs +1 -1
  2. package/.cspell.json +4 -1
  3. package/.github/workflows/actionlint.yml +11 -1
  4. package/.github/workflows/csharpier-autofix.yml +34 -3
  5. package/.github/workflows/dotnet-tests.yml +13 -0
  6. package/.github/workflows/format-on-demand.yml +38 -44
  7. package/.github/workflows/json-format-check.yml +24 -0
  8. package/.github/workflows/lint-doc-links.yml +13 -0
  9. package/.github/workflows/markdown-json.yml +21 -4
  10. package/.github/workflows/markdown-link-text-check.yml +10 -0
  11. package/.github/workflows/markdown-link-validity.yml +10 -0
  12. package/.github/workflows/markdownlint.yml +7 -5
  13. package/.github/workflows/prettier-autofix.yml +67 -11
  14. package/.github/workflows/release-drafter.yml +2 -2
  15. package/.github/workflows/sync-wiki.yml +3 -3
  16. package/.github/workflows/yaml-format-lint.yml +26 -0
  17. package/.llm/context.md +113 -3
  18. package/.llm/skills/documentation/changelog-management.md +38 -0
  19. package/.llm/skills/documentation/documentation-style-guide.md +18 -0
  20. package/.llm/skills/documentation/documentation-update-workflow.md +2 -0
  21. package/.llm/skills/documentation/documentation-updates.md +2 -0
  22. package/.llm/skills/documentation/markdown-compatibility.md +476 -0
  23. package/.llm/skills/documentation/mermaid-theming.md +326 -0
  24. package/.llm/skills/documentation/mkdocs-navigation.md +290 -0
  25. package/.llm/skills/github-actions/git-renormalize-patterns.md +231 -0
  26. package/.llm/skills/github-actions/workflow-consistency.md +346 -0
  27. package/.llm/skills/index.md +53 -27
  28. package/.llm/skills/scripting/javascript-code-quality.md +417 -0
  29. package/.llm/skills/scripting/regex-documentation.md +461 -0
  30. package/.llm/skills/scripting/shell-best-practices.md +55 -4
  31. package/.llm/skills/scripting/validation-patterns.md +418 -0
  32. package/.llm/skills/specification.md +4 -1
  33. package/.llm/skills/testing/test-code-quality.md +243 -0
  34. package/.llm/skills/testing/test-production-code.md +348 -0
  35. package/CHANGELOG.md +11 -0
  36. package/README.md +0 -11
  37. package/Tests/Runtime/Benchmarks/WallstopStudios.DxMessaging.Tests.Runtime.Benchmarks.asmdef +1 -6
  38. package/Tests/Runtime/Integrations/Reflex/WallstopStudios.DxMessaging.Tests.Runtime.Reflex.asmdef +1 -1
  39. package/Tests/Runtime/Integrations/VContainer/WallstopStudios.DxMessaging.Tests.Runtime.VContainer.asmdef +1 -1
  40. package/Tests/Runtime/Integrations/Zenject/WallstopStudios.DxMessaging.Tests.Runtime.Zenject.asmdef +1 -1
  41. package/coverage/clover.xml +216 -3
  42. package/coverage/clover.xml.meta +7 -7
  43. package/coverage/coverage-final.json +2 -1
  44. package/coverage/coverage-final.json.meta +7 -7
  45. package/coverage/lcov-report/base.css.meta +1 -1
  46. package/coverage/lcov-report/block-navigation.js.meta +1 -1
  47. package/coverage/lcov-report/favicon.png.meta +1 -1
  48. package/coverage/lcov-report/index.html +25 -10
  49. package/coverage/lcov-report/index.html.meta +7 -7
  50. package/coverage/lcov-report/prettify.css.meta +1 -1
  51. package/coverage/lcov-report/prettify.js.meta +1 -1
  52. package/coverage/lcov-report/sort-arrow-sprite.png.meta +1 -1
  53. package/coverage/lcov-report/sorter.js.meta +1 -1
  54. package/coverage/lcov-report/transform-docs-to-wiki.js.html +1 -1
  55. package/coverage/lcov-report/transform-docs-to-wiki.js.html.meta +7 -7
  56. package/coverage/lcov-report/vendor.meta +1 -1
  57. package/coverage/lcov-report.meta +8 -8
  58. package/coverage/lcov.info +365 -0
  59. package/coverage/lcov.info.meta +7 -7
  60. package/docs/architecture/design-and-architecture.md +0 -1
  61. package/docs/concepts/index.md +37 -0
  62. package/docs/concepts/index.md.meta +7 -0
  63. package/docs/concepts/interceptors-and-ordering.md +0 -2
  64. package/docs/concepts/mental-model.md +390 -0
  65. package/docs/concepts/mental-model.md.meta +7 -0
  66. package/docs/concepts/message-types.md +0 -1
  67. package/docs/getting-started/getting-started.md +1 -0
  68. package/docs/getting-started/index.md +6 -5
  69. package/docs/getting-started/overview.md +1 -0
  70. package/docs/getting-started/quick-start.md +2 -1
  71. package/docs/getting-started/visual-guide.md +4 -10
  72. package/docs/hooks.py +10 -1
  73. package/docs/images/DxMessaging-banner.svg +1 -1
  74. package/docs/index.md +7 -7
  75. package/docs/javascripts/mermaid-config.js +44 -4
  76. package/docs/reference/helpers.md +130 -154
  77. package/docs/reference/quick-reference.md +5 -1
  78. package/docs/reference/reference.md +124 -130
  79. package/mkdocs.yml +2 -0
  80. package/package.json +1 -1
  81. package/scripts/__tests__/generate-skills-index.test.js +397 -0
  82. package/scripts/__tests__/generate-skills-index.test.js.meta +7 -0
  83. package/scripts/__tests__/mermaid-config.test.js +467 -0
  84. package/scripts/__tests__/mermaid-config.test.js.meta +7 -0
  85. package/scripts/__tests__/validate-skills-optional-fields.test.js +1474 -0
  86. package/scripts/__tests__/validate-skills-optional-fields.test.js.meta +7 -0
  87. package/scripts/__tests__/validate-skills-required-fields.test.js +188 -0
  88. package/scripts/__tests__/validate-skills-required-fields.test.js.meta +7 -0
  89. package/scripts/__tests__/validate-skills-tags.test.js +353 -0
  90. package/scripts/__tests__/validate-skills-tags.test.js.meta +7 -0
  91. package/scripts/__tests__/validate-workflows.test.js +188 -0
  92. package/scripts/__tests__/validate-workflows.test.js.meta +7 -0
  93. package/scripts/generate-skills-index.js +88 -3
  94. package/scripts/validate-skills.js +230 -30
  95. package/scripts/validate-workflows.js +272 -0
  96. package/scripts/validate-workflows.js.meta +7 -0
  97. package/site/404.html +1 -1
  98. package/site/advanced/emit-shorthands/index.html +2 -2
  99. package/site/advanced/message-bus-providers/index.html +2 -2
  100. package/site/advanced/registration-builders/index.html +2 -2
  101. package/site/advanced/runtime-configuration/index.html +2 -2
  102. package/site/advanced/string-messages/index.html +2 -2
  103. package/site/advanced.meta +1 -1
  104. package/site/architecture/comparisons/index.html +2 -2
  105. package/site/architecture/design-and-architecture/index.html +2 -2
  106. package/site/architecture/performance/index.html +1 -1
  107. package/site/architecture.meta +1 -1
  108. package/site/concepts/index.html +1 -0
  109. package/site/concepts/index.html.meta +7 -0
  110. package/site/concepts/interceptors-and-ordering/index.html +4 -4
  111. package/site/concepts/listening-patterns/index.html +2 -2
  112. package/site/concepts/mental-model/index.html +146 -0
  113. package/site/concepts/mental-model/index.html.meta +7 -0
  114. package/site/concepts/mental-model.meta +8 -0
  115. package/site/concepts/message-types/index.html +2 -2
  116. package/site/concepts/targeting-and-context/index.html +2 -2
  117. package/site/concepts.meta +1 -1
  118. package/site/examples/end-to-end/index.html +2 -2
  119. package/site/examples/end-to-end-scene-transitions/index.html +2 -2
  120. package/site/examples.meta +1 -1
  121. package/site/getting-started/getting-started/index.html +3 -3
  122. package/site/getting-started/index.html +4 -4
  123. package/site/getting-started/install/index.html +3 -3
  124. package/site/getting-started/overview/index.html +2 -2
  125. package/site/getting-started/quick-start/index.html +2 -2
  126. package/site/getting-started/visual-guide/index.html +11 -11
  127. package/site/getting-started.meta +1 -1
  128. package/site/guides/advanced/index.html +2 -2
  129. package/site/guides/diagnostics/index.html +2 -2
  130. package/site/guides/migration-guide/index.html +2 -2
  131. package/site/guides/patterns/index.html +2 -2
  132. package/site/guides/testing/index.html +2 -2
  133. package/site/guides/unity-integration/index.html +2 -2
  134. package/site/guides.meta +1 -1
  135. package/site/hooks.py.meta +1 -1
  136. package/site/images/DxMessaging-banner.svg +119 -0
  137. package/site/images/DxMessaging-banner.svg.meta +7 -0
  138. package/site/images.meta +8 -0
  139. package/site/index.html +2 -2
  140. package/site/integrations/index.html +2 -2
  141. package/site/integrations/reflex/index.html +2 -2
  142. package/site/integrations/vcontainer/index.html +2 -2
  143. package/site/integrations/zenject/index.html +2 -2
  144. package/site/integrations.meta +1 -1
  145. package/site/javascripts/csharp-highlight.js.meta +7 -7
  146. package/site/javascripts/mermaid-config.js +4 -1
  147. package/site/javascripts/mermaid-config.js.meta +1 -1
  148. package/site/javascripts.meta +1 -1
  149. package/site/reference/compatibility/index.html +1 -1
  150. package/site/reference/faq/index.html +1 -1
  151. package/site/reference/glossary/index.html +2 -2
  152. package/site/reference/helpers/index.html +15 -15
  153. package/site/reference/quick-reference/index.html +3 -3
  154. package/site/reference/reference/index.html +37 -37
  155. package/site/reference/troubleshooting/index.html +1 -1
  156. package/site/reference.meta +1 -1
  157. package/site/search/search_index.json +1 -1
  158. package/site/sitemap.xml +46 -38
  159. package/site/sitemap.xml.gz +0 -0
  160. package/site/stylesheets/extra.css.meta +1 -1
  161. package/site/stylesheets.meta +1 -1
package/site/reference/helpers/index.html CHANGED
@@ -1,4 +1,4 @@
1
- <!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="High-performance type-safe messaging library for Unity"><meta name=author content="Wallstop Studios"><link href=https://wallstop.github.io/DxMessaging/reference/helpers/ rel=canonical><link href=../quick-reference/ rel=prev><link href=../faq/ rel=next><link rel=icon href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.1"><title>Helpers - DxMessaging Documentation</title><link rel=stylesheet href=../../assets/stylesheets/main.484c7ddc.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../css/timeago.css><link rel=stylesheet href=../../stylesheets/extra.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=default data-md-color-primary=indigo data-md-color-accent=indigo> <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=#helpers-and-source-generation 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="DxMessaging Documentation" class="md-header__button md-logo" aria-label="DxMessaging Documentation" 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> DxMessaging Documentation </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Helpers </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></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/DxMessaging 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/DxMessaging </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=../../getting-started/ class=md-tabs__link> Getting Started </a> </li> <li class=md-tabs__item> <a href=../../concepts/message-types/ class=md-tabs__link> Concepts </a> </li> <li class=md-tabs__item> <a href=../../guides/patterns/ class=md-tabs__link> Guides </a> </li> <li class=md-tabs__item> <a href=../../architecture/design-and-architecture/ class=md-tabs__link> Architecture </a> </li> <li class=md-tabs__item> <a href=../../advanced/emit-shorthands/ class=md-tabs__link> Advanced </a> </li> <li class=md-tabs__item> <a href=../../integrations/ class=md-tabs__link> Integrations </a> </li> <li class=md-tabs__item> <a href=../../examples/end-to-end/ class=md-tabs__link> Examples </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../reference/ class=md-tabs__link> Reference </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" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../.. title="DxMessaging Documentation" class="md-nav__button md-logo" aria-label="DxMessaging Documentation" 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> DxMessaging Documentation </label> <div class=md-nav__source> <a href=https://github.com/wallstop/DxMessaging 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/DxMessaging </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=../../getting-started/ 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=../../getting-started/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../getting-started/install/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../../getting-started/quick-start/ class=md-nav__link> <span class=md-ellipsis> Quick Start </span> </a> </li> <li class=md-nav__item> <a href=../../getting-started/getting-started/ class=md-nav__link> <span class=md-ellipsis> Getting Started Guide </span> </a> </li> <li class=md-nav__item> <a href=../../getting-started/visual-guide/ class=md-nav__link> <span class=md-ellipsis> Visual Guide </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_3> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex=0> <span class=md-ellipsis> Concepts </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=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Concepts </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../concepts/message-types/ class=md-nav__link> <span class=md-ellipsis> Message Types </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/listening-patterns/ class=md-nav__link> <span class=md-ellipsis> Listening Patterns </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/targeting-and-context/ class=md-nav__link> <span class=md-ellipsis> Targeting & Context </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/interceptors-and-ordering/ class=md-nav__link> <span class=md-ellipsis> Interceptors & Ordering </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_4> <label class=md-nav__link for=__nav_4 id=__nav_4_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_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <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/patterns/ class=md-nav__link> <span class=md-ellipsis> Patterns </span> </a> </li> <li class=md-nav__item> <a href=../../guides/unity-integration/ class=md-nav__link> <span class=md-ellipsis> Unity Integration </span> </a> </li> <li class=md-nav__item> <a href=../../guides/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../../guides/diagnostics/ class=md-nav__link> <span class=md-ellipsis> Diagnostics </span> </a> </li> <li class=md-nav__item> <a href=../../guides/advanced/ class=md-nav__link> <span class=md-ellipsis> Advanced Topics </span> </a> </li> <li class=md-nav__item> <a href=../../guides/migration-guide/ class=md-nav__link> <span class=md-ellipsis> Migration Guide </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> Architecture </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> Architecture </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../architecture/design-and-architecture/ class=md-nav__link> <span class=md-ellipsis> Design & Architecture </span> </a> </li> <li class=md-nav__item> <a href=../../architecture/comparisons/ class=md-nav__link> <span class=md-ellipsis> Comparisons </span> </a> </li> <li class=md-nav__item> <a href=../../architecture/performance/ class=md-nav__link> <span class=md-ellipsis> Performance </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> Advanced </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> Advanced </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../advanced/emit-shorthands/ class=md-nav__link> <span class=md-ellipsis> Emit Shorthands </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/message-bus-providers/ class=md-nav__link> <span class=md-ellipsis> Message Bus Providers </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/registration-builders/ class=md-nav__link> <span class=md-ellipsis> Registration Builders </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/runtime-configuration/ class=md-nav__link> <span class=md-ellipsis> Runtime Configuration </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/string-messages/ class=md-nav__link> <span class=md-ellipsis> String Messages </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> <div class="md-nav__link md-nav__container"> <a href=../../integrations/ class="md-nav__link "> <span class=md-ellipsis> Integrations </span> </a> <label class="md-nav__link " for=__nav_7 id=__nav_7_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <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> Integrations </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../integrations/vcontainer/ class=md-nav__link> <span class=md-ellipsis> VContainer </span> </a> </li> <li class=md-nav__item> <a href=../../integrations/zenject/ class=md-nav__link> <span class=md-ellipsis> Zenject </span> </a> </li> <li class=md-nav__item> <a href=../../integrations/reflex/ class=md-nav__link> <span class=md-ellipsis> Reflex </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_8> <label class=md-nav__link for=__nav_8 id=__nav_8_label tabindex=0> <span class=md-ellipsis> Examples </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Examples </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../examples/end-to-end/ class=md-nav__link> <span class=md-ellipsis> End-to-End </span> </a> </li> <li class=md-nav__item> <a href=../../examples/end-to-end-scene-transitions/ class=md-nav__link> <span class=md-ellipsis> Scene Transitions </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_9 checked> <label class=md-nav__link for=__nav_9 id=__nav_9_label tabindex> <span class=md-ellipsis> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_9_label aria-expanded=true> <label class=md-nav__title for=__nav_9> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../reference/ class=md-nav__link> <span class=md-ellipsis> API Reference (Practical) </span> </a> </li> <li class=md-nav__item> <a href=../quick-reference/ class=md-nav__link> <span class=md-ellipsis> Quick Reference </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Helpers </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Helpers </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=#what-are-source-generators class=md-nav__link> <span class=md-ellipsis> What Are Source Generators </span> </a> <nav class=md-nav aria-label="What Are Source Generators"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#in-plain-english class=md-nav__link> <span class=md-ellipsis> In plain English </span> </a> <nav class=md-nav aria-label="In plain English"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#learn-more-about-source-generators class=md-nav__link> <span class=md-ellipsis> Learn more about source generators </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxmessaging-attributes-your-code-wizards class=md-nav__link> <span class=md-ellipsis> DxMessaging Attributes (Your Code Wizards) </span> </a> <nav class=md-nav aria-label="DxMessaging Attributes (Your Code Wizards)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#1-message-type-attributes-pick-your-message-category class=md-nav__link> <span class=md-ellipsis> 1. Message Type Attributes (Pick Your Message Category) </span> </a> <nav class=md-nav aria-label="1. Message Type Attributes (Pick Your Message Category)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxuntargetedmessage---global-messages class=md-nav__link> <span class=md-ellipsis> [DxUntargetedMessage] - Global Messages </span> </a> <nav class=md-nav aria-label="[DxUntargetedMessage] - Global Messages"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxtargetedmessage---messages-to-specific-targets class=md-nav__link> <span class=md-ellipsis> [DxTargetedMessage] - Messages to Specific Targets </span> </a> <nav class=md-nav aria-label="[DxTargetedMessage] - Messages to Specific Targets"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates_1 class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxbroadcastmessage---messages-from-a-source class=md-nav__link> <span class=md-ellipsis> [DxBroadcastMessage] - Messages from a Source </span> </a> <nav class=md-nav aria-label="[DxBroadcastMessage] - Messages from a Source"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates_2 class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#2-dxautoconstructor---automatic-constructors class=md-nav__link> <span class=md-ellipsis> 2. [DxAutoConstructor] - Automatic Constructors </span> </a> <nav class=md-nav aria-label="2. [DxAutoConstructor] - Automatic Constructors"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-you-get-auto-generated class=md-nav__link> <span class=md-ellipsis> What you get (auto-generated) </span> </a> <nav class=md-nav aria-label="What you get (auto-generated)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#rules class=md-nav__link> <span class=md-ellipsis> Rules </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#3-dxoptionalparameter---optional-constructor-parameters class=md-nav__link> <span class=md-ellipsis> 3. [DxOptionalParameter] - Optional Constructor Parameters </span> </a> <nav class=md-nav aria-label="3. [DxOptionalParameter] - Optional Constructor Parameters"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#how-it-works-with-dxautoconstructor class=md-nav__link> <span class=md-ellipsis> How It Works with DxAutoConstructor </span> </a> </li> <li class=md-nav__item> <a href=#generated-constructor class=md-nav__link> <span class=md-ellipsis> Generated constructor </span> </a> </li> <li class=md-nav__item> <a href=#calling-the-constructor class=md-nav__link> <span class=md-ellipsis> Calling the Constructor </span> </a> </li> <li class=md-nav__item> <a href=#supported-default-value-types class=md-nav__link> <span class=md-ellipsis> Supported Default Value Types </span> </a> <nav class=md-nav aria-label="Supported Default Value Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#examples-by-type class=md-nav__link> <span class=md-ellipsis> Examples by type </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#using-type-defaults class=md-nav__link> <span class=md-ellipsis> Using Type Defaults </span> </a> </li> <li class=md-nav__item> <a href=#advanced-custom-expressions-for-any-type class=md-nav__link> <span class=md-ellipsis> Advanced: Custom Expressions for Any Type </span> </a> </li> <li class=md-nav__item> <a href=#code-examples class=md-nav__link> <span class=md-ellipsis> Code Examples </span> </a> </li> <li class=md-nav__item> <a href=#example-1-basic-optional-parameter-with-default-value class=md-nav__link> <span class=md-ellipsis> Example 1: Basic Optional Parameter with Default Value </span> </a> </li> <li class=md-nav__item> <a href=#example-2-multiple-optional-parameters class=md-nav__link> <span class=md-ellipsis> Example 2: Multiple Optional Parameters </span> </a> </li> <li class=md-nav__item> <a href=#example-3-mix-of-required-and-optional-fields class=md-nav__link> <span class=md-ellipsis> Example 3: Mix of Required and Optional Fields </span> </a> </li> <li class=md-nav__item> <a href=#example-4-game-settings-message class=md-nav__link> <span class=md-ellipsis> Example 4: Game Settings Message </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> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#why-use-attributes-instead-of-manual-implementation class=md-nav__link> <span class=md-ellipsis> Why Use Attributes Instead of Manual Implementation </span> </a> <nav class=md-nav aria-label="Why Use Attributes Instead of Manual Implementation"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#-attribute-definition-clean-automatic class=md-nav__link> <span class=md-ellipsis> ✅ Attribute Definition (Clean, Automatic) </span> </a> </li> <li class=md-nav__item> <a href=#what-the-generator-emits-for-reference class=md-nav__link> <span class=md-ellipsis> What the generator emits (for reference) </span> </a> <nav class=md-nav aria-label="What the generator emits (for reference)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#benefits class=md-nav__link> <span class=md-ellipsis> Benefits </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#complete-example-attribute-definition-vs-generated-output class=md-nav__link> <span class=md-ellipsis> Complete Example: Attribute Definition vs Generated Output </span> </a> <nav class=md-nav aria-label="Complete Example: Attribute Definition vs Generated Output"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#attribute-definition-8-lines class=md-nav__link> <span class=md-ellipsis> Attribute Definition (8 lines) </span> </a> </li> <li class=md-nav__item> <a href=#generated-output-20-lines-you-never-write class=md-nav__link> <span class=md-ellipsis> Generated Output (20 lines you never write) </span> </a> </li> <li class=md-nav__item> <a href=#result class=md-nav__link> <span class=md-ellipsis> Result </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#advanced-manual-implementation-when-attributes-arent-enough class=md-nav__link> <span class=md-ellipsis> Advanced: Manual Implementation (When Attributes Aren't Enough) </span> </a> <nav class=md-nav aria-label="Advanced: Manual Implementation (When Attributes Aren't Enough)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#generic-message-interfaces-zero-boxing-for-structs class=md-nav__link> <span class=md-ellipsis> Generic Message Interfaces (Zero-Boxing for Structs) </span> </a> </li> <li class=md-nav__item> <a href=#do-i-have-to-use-attributes class=md-nav__link> <span class=md-ellipsis> "Do I HAVE to use attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#what-if-i-want-custom-constructor-logic class=md-nav__link> <span class=md-ellipsis> "What if I want custom constructor logic?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-mix-attribute-based-and-manual-messages class=md-nav__link> <span class=md-ellipsis> "Can I mix attribute-based and manual messages?" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#extension-methods-emit-helpers class=md-nav__link> <span class=md-ellipsis> Extension Methods (Emit Helpers) </span> </a> <nav class=md-nav aria-label="Extension Methods (Emit Helpers)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#automatic-overload-selection class=md-nav__link> <span class=md-ellipsis> Automatic overload selection </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#local-bus-islands-isolated-testing class=md-nav__link> <span class=md-ellipsis> Local Bus Islands (Isolated Testing) </span> </a> <nav class=md-nav aria-label="Local Bus Islands (Isolated Testing)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-cases class=md-nav__link> <span class=md-ellipsis> Use cases </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#attributes-quick-reference class=md-nav__link> <span class=md-ellipsis> Attributes Quick Reference </span> </a> <nav class=md-nav aria-label="Attributes Quick Reference"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#message-type-attributes class=md-nav__link> <span class=md-ellipsis> Message Type Attributes </span> </a> </li> <li class=md-nav__item> <a href=#constructor-generation-attributes class=md-nav__link> <span class=md-ellipsis> Constructor Generation Attributes </span> </a> <nav class=md-nav aria-label="Constructor Generation Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxautoconstructor class=md-nav__link> <span class=md-ellipsis> [DxAutoConstructor] </span> </a> </li> <li class=md-nav__item> <a href=#dxoptionalparameter class=md-nav__link> <span class=md-ellipsis> [DxOptionalParameter] </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#supported-types class=md-nav__link> <span class=md-ellipsis> Supported Types </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#common-patterns-with-attributes class=md-nav__link> <span class=md-ellipsis> Common Patterns with Attributes </span> </a> <nav class=md-nav aria-label="Common Patterns with Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#pattern-1-simple-message-no-data class=md-nav__link> <span class=md-ellipsis> Pattern 1: Simple Message (No Data) </span> </a> </li> <li class=md-nav__item> <a href=#pattern-2-message-with-data class=md-nav__link> <span class=md-ellipsis> Pattern 2: Message with Data </span> </a> </li> <li class=md-nav__item> <a href=#pattern-3-message-with-optional-fields class=md-nav__link> <span class=md-ellipsis> Pattern 3: Message with Optional Fields </span> </a> </li> <li class=md-nav__item> <a href=#pattern-4-complex-message class=md-nav__link> <span class=md-ellipsis> Pattern 4: Complex Message </span> </a> </li> <li class=md-nav__item> <a href=#pattern-5-nested-types class=md-nav__link> <span class=md-ellipsis> Pattern 5: Nested Types </span> </a> <nav class=md-nav aria-label="Pattern 5: Nested Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#benefits_1 class=md-nav__link> <span class=md-ellipsis> Benefits </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#pattern-6-internal-types-assembly-private-messages class=md-nav__link> <span class=md-ellipsis> Pattern 6: Internal Types (Assembly-Private Messages) </span> </a> <nav class=md-nav aria-label="Pattern 6: Internal Types (Assembly-Private Messages)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-cases_1 class=md-nav__link> <span class=md-ellipsis> Use cases </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#faq-source-generators--attributes class=md-nav__link> <span class=md-ellipsis> FAQ: Source Generators &amp; Attributes </span> </a> <nav class=md-nav aria-label="FAQ: Source Generators & Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#do-i-have-to-use-attributes_1 class=md-nav__link> <span class=md-ellipsis> "Do I HAVE to use attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#why-partial-when-using-attributes class=md-nav__link> <span class=md-ellipsis> "Why partial when using attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-see-the-generated-code class=md-nav__link> <span class=md-ellipsis> "Can I see the generated code?" </span> </a> </li> <li class=md-nav__item> <a href=#what-if-i-want-custom-constructor-logic_1 class=md-nav__link> <span class=md-ellipsis> "What if I want custom constructor logic?" </span> </a> </li> <li class=md-nav__item> <a href=#do-attributes-affect-runtime-performance class=md-nav__link> <span class=md-ellipsis> "Do attributes affect runtime performance?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-mix-attributes-and-manual-implementation class=md-nav__link> <span class=md-ellipsis> "Can I mix attributes and manual implementation?" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#troubleshooting-source-generators class=md-nav__link> <span class=md-ellipsis> Troubleshooting Source Generators </span> </a> </li> <li class=md-nav__item> <a href=#related-documentation class=md-nav__link> <span class=md-ellipsis> Related Documentation </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=#source-generators--code-wizards-that-write-boilerplate-for-you class=md-nav__link> <span class=md-ellipsis> Source generators = Code wizards that write boilerplate for you </span> </a> <nav class=md-nav aria-label="Source generators = Code wizards that write boilerplate for you"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-attributes-for class=md-nav__link> <span class=md-ellipsis> Use attributes for </span> </a> <nav class=md-nav aria-label="Use attributes for"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-manual-implementation-for class=md-nav__link> <span class=md-ellipsis> Use manual implementation for </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../faq/ class=md-nav__link> <span class=md-ellipsis> FAQ </span> </a> </li> <li class=md-nav__item> <a href=../glossary/ class=md-nav__link> <span class=md-ellipsis> Glossary </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=../compatibility/ class=md-nav__link> <span class=md-ellipsis> Compatibility </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <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=#what-are-source-generators class=md-nav__link> <span class=md-ellipsis> What Are Source Generators </span> </a> <nav class=md-nav aria-label="What Are Source Generators"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#in-plain-english class=md-nav__link> <span class=md-ellipsis> In plain English </span> </a> <nav class=md-nav aria-label="In plain English"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#learn-more-about-source-generators class=md-nav__link> <span class=md-ellipsis> Learn more about source generators </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxmessaging-attributes-your-code-wizards class=md-nav__link> <span class=md-ellipsis> DxMessaging Attributes (Your Code Wizards) </span> </a> <nav class=md-nav aria-label="DxMessaging Attributes (Your Code Wizards)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#1-message-type-attributes-pick-your-message-category class=md-nav__link> <span class=md-ellipsis> 1. Message Type Attributes (Pick Your Message Category) </span> </a> <nav class=md-nav aria-label="1. Message Type Attributes (Pick Your Message Category)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxuntargetedmessage---global-messages class=md-nav__link> <span class=md-ellipsis> [DxUntargetedMessage] - Global Messages </span> </a> <nav class=md-nav aria-label="[DxUntargetedMessage] - Global Messages"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxtargetedmessage---messages-to-specific-targets class=md-nav__link> <span class=md-ellipsis> [DxTargetedMessage] - Messages to Specific Targets </span> </a> <nav class=md-nav aria-label="[DxTargetedMessage] - Messages to Specific Targets"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates_1 class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxbroadcastmessage---messages-from-a-source class=md-nav__link> <span class=md-ellipsis> [DxBroadcastMessage] - Messages from a Source </span> </a> <nav class=md-nav aria-label="[DxBroadcastMessage] - Messages from a Source"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates_2 class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#2-dxautoconstructor---automatic-constructors class=md-nav__link> <span class=md-ellipsis> 2. [DxAutoConstructor] - Automatic Constructors </span> </a> <nav class=md-nav aria-label="2. [DxAutoConstructor] - Automatic Constructors"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-you-get-auto-generated class=md-nav__link> <span class=md-ellipsis> What you get (auto-generated) </span> </a> <nav class=md-nav aria-label="What you get (auto-generated)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#rules class=md-nav__link> <span class=md-ellipsis> Rules </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#3-dxoptionalparameter---optional-constructor-parameters class=md-nav__link> <span class=md-ellipsis> 3. [DxOptionalParameter] - Optional Constructor Parameters </span> </a> <nav class=md-nav aria-label="3. [DxOptionalParameter] - Optional Constructor Parameters"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#how-it-works-with-dxautoconstructor class=md-nav__link> <span class=md-ellipsis> How It Works with DxAutoConstructor </span> </a> </li> <li class=md-nav__item> <a href=#generated-constructor class=md-nav__link> <span class=md-ellipsis> Generated constructor </span> </a> </li> <li class=md-nav__item> <a href=#calling-the-constructor class=md-nav__link> <span class=md-ellipsis> Calling the Constructor </span> </a> </li> <li class=md-nav__item> <a href=#supported-default-value-types class=md-nav__link> <span class=md-ellipsis> Supported Default Value Types </span> </a> <nav class=md-nav aria-label="Supported Default Value Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#examples-by-type class=md-nav__link> <span class=md-ellipsis> Examples by type </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#using-type-defaults class=md-nav__link> <span class=md-ellipsis> Using Type Defaults </span> </a> </li> <li class=md-nav__item> <a href=#advanced-custom-expressions-for-any-type class=md-nav__link> <span class=md-ellipsis> Advanced: Custom Expressions for Any Type </span> </a> </li> <li class=md-nav__item> <a href=#code-examples class=md-nav__link> <span class=md-ellipsis> Code Examples </span> </a> </li> <li class=md-nav__item> <a href=#example-1-basic-optional-parameter-with-default-value class=md-nav__link> <span class=md-ellipsis> Example 1: Basic Optional Parameter with Default Value </span> </a> </li> <li class=md-nav__item> <a href=#example-2-multiple-optional-parameters class=md-nav__link> <span class=md-ellipsis> Example 2: Multiple Optional Parameters </span> </a> </li> <li class=md-nav__item> <a href=#example-3-mix-of-required-and-optional-fields class=md-nav__link> <span class=md-ellipsis> Example 3: Mix of Required and Optional Fields </span> </a> </li> <li class=md-nav__item> <a href=#example-4-game-settings-message class=md-nav__link> <span class=md-ellipsis> Example 4: Game Settings Message </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> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#why-use-attributes-instead-of-manual-implementation class=md-nav__link> <span class=md-ellipsis> Why Use Attributes Instead of Manual Implementation </span> </a> <nav class=md-nav aria-label="Why Use Attributes Instead of Manual Implementation"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#-attribute-definition-clean-automatic class=md-nav__link> <span class=md-ellipsis> ✅ Attribute Definition (Clean, Automatic) </span> </a> </li> <li class=md-nav__item> <a href=#what-the-generator-emits-for-reference class=md-nav__link> <span class=md-ellipsis> What the generator emits (for reference) </span> </a> <nav class=md-nav aria-label="What the generator emits (for reference)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#benefits class=md-nav__link> <span class=md-ellipsis> Benefits </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#complete-example-attribute-definition-vs-generated-output class=md-nav__link> <span class=md-ellipsis> Complete Example: Attribute Definition vs Generated Output </span> </a> <nav class=md-nav aria-label="Complete Example: Attribute Definition vs Generated Output"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#attribute-definition-8-lines class=md-nav__link> <span class=md-ellipsis> Attribute Definition (8 lines) </span> </a> </li> <li class=md-nav__item> <a href=#generated-output-20-lines-you-never-write class=md-nav__link> <span class=md-ellipsis> Generated Output (20 lines you never write) </span> </a> </li> <li class=md-nav__item> <a href=#result class=md-nav__link> <span class=md-ellipsis> Result </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#advanced-manual-implementation-when-attributes-arent-enough class=md-nav__link> <span class=md-ellipsis> Advanced: Manual Implementation (When Attributes Aren't Enough) </span> </a> <nav class=md-nav aria-label="Advanced: Manual Implementation (When Attributes Aren't Enough)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#generic-message-interfaces-zero-boxing-for-structs class=md-nav__link> <span class=md-ellipsis> Generic Message Interfaces (Zero-Boxing for Structs) </span> </a> </li> <li class=md-nav__item> <a href=#do-i-have-to-use-attributes class=md-nav__link> <span class=md-ellipsis> "Do I HAVE to use attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#what-if-i-want-custom-constructor-logic class=md-nav__link> <span class=md-ellipsis> "What if I want custom constructor logic?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-mix-attribute-based-and-manual-messages class=md-nav__link> <span class=md-ellipsis> "Can I mix attribute-based and manual messages?" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#extension-methods-emit-helpers class=md-nav__link> <span class=md-ellipsis> Extension Methods (Emit Helpers) </span> </a> <nav class=md-nav aria-label="Extension Methods (Emit Helpers)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#automatic-overload-selection class=md-nav__link> <span class=md-ellipsis> Automatic overload selection </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#local-bus-islands-isolated-testing class=md-nav__link> <span class=md-ellipsis> Local Bus Islands (Isolated Testing) </span> </a> <nav class=md-nav aria-label="Local Bus Islands (Isolated Testing)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-cases class=md-nav__link> <span class=md-ellipsis> Use cases </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#attributes-quick-reference class=md-nav__link> <span class=md-ellipsis> Attributes Quick Reference </span> </a> <nav class=md-nav aria-label="Attributes Quick Reference"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#message-type-attributes class=md-nav__link> <span class=md-ellipsis> Message Type Attributes </span> </a> </li> <li class=md-nav__item> <a href=#constructor-generation-attributes class=md-nav__link> <span class=md-ellipsis> Constructor Generation Attributes </span> </a> <nav class=md-nav aria-label="Constructor Generation Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxautoconstructor class=md-nav__link> <span class=md-ellipsis> [DxAutoConstructor] </span> </a> </li> <li class=md-nav__item> <a href=#dxoptionalparameter class=md-nav__link> <span class=md-ellipsis> [DxOptionalParameter] </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#supported-types class=md-nav__link> <span class=md-ellipsis> Supported Types </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#common-patterns-with-attributes class=md-nav__link> <span class=md-ellipsis> Common Patterns with Attributes </span> </a> <nav class=md-nav aria-label="Common Patterns with Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#pattern-1-simple-message-no-data class=md-nav__link> <span class=md-ellipsis> Pattern 1: Simple Message (No Data) </span> </a> </li> <li class=md-nav__item> <a href=#pattern-2-message-with-data class=md-nav__link> <span class=md-ellipsis> Pattern 2: Message with Data </span> </a> </li> <li class=md-nav__item> <a href=#pattern-3-message-with-optional-fields class=md-nav__link> <span class=md-ellipsis> Pattern 3: Message with Optional Fields </span> </a> </li> <li class=md-nav__item> <a href=#pattern-4-complex-message class=md-nav__link> <span class=md-ellipsis> Pattern 4: Complex Message </span> </a> </li> <li class=md-nav__item> <a href=#pattern-5-nested-types class=md-nav__link> <span class=md-ellipsis> Pattern 5: Nested Types </span> </a> <nav class=md-nav aria-label="Pattern 5: Nested Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#benefits_1 class=md-nav__link> <span class=md-ellipsis> Benefits </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#pattern-6-internal-types-assembly-private-messages class=md-nav__link> <span class=md-ellipsis> Pattern 6: Internal Types (Assembly-Private Messages) </span> </a> <nav class=md-nav aria-label="Pattern 6: Internal Types (Assembly-Private Messages)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-cases_1 class=md-nav__link> <span class=md-ellipsis> Use cases </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#faq-source-generators--attributes class=md-nav__link> <span class=md-ellipsis> FAQ: Source Generators &amp; Attributes </span> </a> <nav class=md-nav aria-label="FAQ: Source Generators & Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#do-i-have-to-use-attributes_1 class=md-nav__link> <span class=md-ellipsis> "Do I HAVE to use attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#why-partial-when-using-attributes class=md-nav__link> <span class=md-ellipsis> "Why partial when using attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-see-the-generated-code class=md-nav__link> <span class=md-ellipsis> "Can I see the generated code?" </span> </a> </li> <li class=md-nav__item> <a href=#what-if-i-want-custom-constructor-logic_1 class=md-nav__link> <span class=md-ellipsis> "What if I want custom constructor logic?" </span> </a> </li> <li class=md-nav__item> <a href=#do-attributes-affect-runtime-performance class=md-nav__link> <span class=md-ellipsis> "Do attributes affect runtime performance?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-mix-attributes-and-manual-implementation class=md-nav__link> <span class=md-ellipsis> "Can I mix attributes and manual implementation?" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#troubleshooting-source-generators class=md-nav__link> <span class=md-ellipsis> Troubleshooting Source Generators </span> </a> </li> <li class=md-nav__item> <a href=#related-documentation class=md-nav__link> <span class=md-ellipsis> Related Documentation </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=#source-generators--code-wizards-that-write-boilerplate-for-you class=md-nav__link> <span class=md-ellipsis> Source generators = Code wizards that write boilerplate for you </span> </a> <nav class=md-nav aria-label="Source generators = Code wizards that write boilerplate for you"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-attributes-for class=md-nav__link> <span class=md-ellipsis> Use attributes for </span> </a> <nav class=md-nav aria-label="Use attributes for"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-manual-implementation-for class=md-nav__link> <span class=md-ellipsis> Use manual implementation for </span> </a> </li> </ul> </nav> </li> </ul> </nav> </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=../reference/ class=md-path__link> <span class=md-ellipsis> Reference </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <a href=https://github.com/wallstop/DxMessaging/edit/master/docs/reference/helpers.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="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> </a> <a href=https://github.com/wallstop/DxMessaging/raw/master/docs/reference/helpers.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="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg> </a> <h1 id=helpers-and-source-generation>Helpers and Source Generation<a class=headerlink href=#helpers-and-source-generation title="Anchor link to this section">&para;</a></h1> <h2 id=what-are-source-generators>What Are Source Generators<a class=headerlink href=#what-are-source-generators title="Anchor link to this section">&para;</a></h2> <p><strong>Source generators</strong> are a C# feature (introduced in C# 9.0) that <strong>automatically write code for you at compile time</strong>. Think of them as smart code wizards that look at your code, see what you need, and generate the boilerplate automatically.</p> <h3 id=in-plain-english>In plain English<a class=headerlink href=#in-plain-english title="Anchor link to this section">&para;</a></h3> <ul> <li>You write: <code>[DxAutoConstructor]</code> on a struct</li> <li>Source generator sees: "Oh, they want a constructor!"</li> <li>Source generator creates: A constructor with all the fields as parameters</li> <li>You get: Less typing, fewer bugs, more consistent code</li> </ul> <h4 id=learn-more-about-source-generators>Learn more about source generators<a class=headerlink href=#learn-more-about-source-generators title="Anchor link to this section">&para;</a></h4> <ul> <li><a href=https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview>Microsoft Docs: Source Generators</a></li> <li><a href=https://devblogs.microsoft.com/dotnet/introducing-c-source-generators/ >Introduction to C# Source Generators</a></li> </ul> <h2 id=dxmessaging-attributes-your-code-wizards>DxMessaging Attributes (Your Code Wizards)<a class=headerlink href=#dxmessaging-attributes-your-code-wizards title="Anchor link to this section">&para;</a></h2> <p>DxMessaging provides <strong>3 main attributes</strong> that use source generators to eliminate boilerplate:</p> <h3 id=1-message-type-attributes-pick-your-message-category>1. Message Type Attributes (Pick Your Message Category)<a class=headerlink href=#1-message-type-attributes-pick-your-message-category title="Anchor link to this section">&para;</a></h3> <p>These tell the source generator what KIND of message you're making:</p> <h4 id=dxuntargetedmessage---global-messages><code>[DxUntargetedMessage]</code> - Global Messages<a class=headerlink href=#dxuntargetedmessage---global-messages title="Anchor link to this section">&para;</a></h4> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=na>[DxUntargetedMessage]</span><span class=w> </span><span class=c1>// ← Tells generator: &quot;This is a global message&quot;</span>
1
+ <!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="High-performance type-safe messaging library for Unity"><meta name=author content="Wallstop Studios"><link href=https://wallstop.github.io/DxMessaging/reference/helpers/ rel=canonical><link href=../quick-reference/ rel=prev><link href=../faq/ rel=next><link rel=icon href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.7.1"><title>Helpers - DxMessaging Documentation</title><link rel=stylesheet href=../../assets/stylesheets/main.484c7ddc.min.css><link rel=stylesheet href=../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../css/timeago.css><link rel=stylesheet href=../../stylesheets/extra.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=default data-md-color-primary=indigo data-md-color-accent=indigo> <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=#helpers-and-source-generation 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="DxMessaging Documentation" class="md-header__button md-logo" aria-label="DxMessaging Documentation" 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> DxMessaging Documentation </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Helpers </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></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/DxMessaging 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/DxMessaging </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=../../getting-started/ class=md-tabs__link> Getting Started </a> </li> <li class=md-tabs__item> <a href=../../concepts/ class=md-tabs__link> Concepts </a> </li> <li class=md-tabs__item> <a href=../../guides/patterns/ class=md-tabs__link> Guides </a> </li> <li class=md-tabs__item> <a href=../../architecture/design-and-architecture/ class=md-tabs__link> Architecture </a> </li> <li class=md-tabs__item> <a href=../../advanced/emit-shorthands/ class=md-tabs__link> Advanced </a> </li> <li class=md-tabs__item> <a href=../../integrations/ class=md-tabs__link> Integrations </a> </li> <li class=md-tabs__item> <a href=../../examples/end-to-end/ class=md-tabs__link> Examples </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../reference/ class=md-tabs__link> Reference </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" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../.. title="DxMessaging Documentation" class="md-nav__button md-logo" aria-label="DxMessaging Documentation" 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> DxMessaging Documentation </label> <div class=md-nav__source> <a href=https://github.com/wallstop/DxMessaging 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/DxMessaging </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=../../getting-started/ 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=../../getting-started/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../getting-started/install/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../../getting-started/quick-start/ class=md-nav__link> <span class=md-ellipsis> Quick Start </span> </a> </li> <li class=md-nav__item> <a href=../../getting-started/getting-started/ class=md-nav__link> <span class=md-ellipsis> Getting Started Guide </span> </a> </li> <li class=md-nav__item> <a href=../../getting-started/visual-guide/ class=md-nav__link> <span class=md-ellipsis> Visual Guide </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_3> <div class="md-nav__link md-nav__container"> <a href=../../concepts/ class="md-nav__link "> <span class=md-ellipsis> Concepts </span> </a> <label class="md-nav__link " for=__nav_3 id=__nav_3_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> Concepts </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../concepts/mental-model/ class=md-nav__link> <span class=md-ellipsis> Mental Model </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/message-types/ class=md-nav__link> <span class=md-ellipsis> Message Types </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/listening-patterns/ class=md-nav__link> <span class=md-ellipsis> Listening Patterns </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/targeting-and-context/ class=md-nav__link> <span class=md-ellipsis> Targeting & Context </span> </a> </li> <li class=md-nav__item> <a href=../../concepts/interceptors-and-ordering/ class=md-nav__link> <span class=md-ellipsis> Interceptors & Ordering </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_4> <label class=md-nav__link for=__nav_4 id=__nav_4_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_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <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/patterns/ class=md-nav__link> <span class=md-ellipsis> Patterns </span> </a> </li> <li class=md-nav__item> <a href=../../guides/unity-integration/ class=md-nav__link> <span class=md-ellipsis> Unity Integration </span> </a> </li> <li class=md-nav__item> <a href=../../guides/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../../guides/diagnostics/ class=md-nav__link> <span class=md-ellipsis> Diagnostics </span> </a> </li> <li class=md-nav__item> <a href=../../guides/advanced/ class=md-nav__link> <span class=md-ellipsis> Advanced Topics </span> </a> </li> <li class=md-nav__item> <a href=../../guides/migration-guide/ class=md-nav__link> <span class=md-ellipsis> Migration Guide </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> Architecture </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> Architecture </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../architecture/design-and-architecture/ class=md-nav__link> <span class=md-ellipsis> Design & Architecture </span> </a> </li> <li class=md-nav__item> <a href=../../architecture/comparisons/ class=md-nav__link> <span class=md-ellipsis> Comparisons </span> </a> </li> <li class=md-nav__item> <a href=../../architecture/performance/ class=md-nav__link> <span class=md-ellipsis> Performance </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> Advanced </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> Advanced </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../advanced/emit-shorthands/ class=md-nav__link> <span class=md-ellipsis> Emit Shorthands </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/message-bus-providers/ class=md-nav__link> <span class=md-ellipsis> Message Bus Providers </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/registration-builders/ class=md-nav__link> <span class=md-ellipsis> Registration Builders </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/runtime-configuration/ class=md-nav__link> <span class=md-ellipsis> Runtime Configuration </span> </a> </li> <li class=md-nav__item> <a href=../../advanced/string-messages/ class=md-nav__link> <span class=md-ellipsis> String Messages </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> <div class="md-nav__link md-nav__container"> <a href=../../integrations/ class="md-nav__link "> <span class=md-ellipsis> Integrations </span> </a> <label class="md-nav__link " for=__nav_7 id=__nav_7_label tabindex=0> <span class="md-nav__icon md-icon"></span> </label> </div> <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> Integrations </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../integrations/vcontainer/ class=md-nav__link> <span class=md-ellipsis> VContainer </span> </a> </li> <li class=md-nav__item> <a href=../../integrations/zenject/ class=md-nav__link> <span class=md-ellipsis> Zenject </span> </a> </li> <li class=md-nav__item> <a href=../../integrations/reflex/ class=md-nav__link> <span class=md-ellipsis> Reflex </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_8> <label class=md-nav__link for=__nav_8 id=__nav_8_label tabindex=0> <span class=md-ellipsis> Examples </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Examples </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../examples/end-to-end/ class=md-nav__link> <span class=md-ellipsis> End-to-End </span> </a> </li> <li class=md-nav__item> <a href=../../examples/end-to-end-scene-transitions/ class=md-nav__link> <span class=md-ellipsis> Scene Transitions </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_9 checked> <label class=md-nav__link for=__nav_9 id=__nav_9_label tabindex> <span class=md-ellipsis> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_9_label aria-expanded=true> <label class=md-nav__title for=__nav_9> <span class="md-nav__icon md-icon"></span> Reference </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../reference/ class=md-nav__link> <span class=md-ellipsis> API Reference (Practical) </span> </a> </li> <li class=md-nav__item> <a href=../quick-reference/ class=md-nav__link> <span class=md-ellipsis> Quick Reference </span> </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Helpers </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Helpers </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=#what-are-source-generators class=md-nav__link> <span class=md-ellipsis> What Are Source Generators </span> </a> <nav class=md-nav aria-label="What Are Source Generators"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#in-plain-english class=md-nav__link> <span class=md-ellipsis> In plain English </span> </a> <nav class=md-nav aria-label="In plain English"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#learn-more-about-source-generators class=md-nav__link> <span class=md-ellipsis> Learn more about source generators </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxmessaging-attributes-your-code-wizards class=md-nav__link> <span class=md-ellipsis> DxMessaging Attributes (Your Code Wizards) </span> </a> <nav class=md-nav aria-label="DxMessaging Attributes (Your Code Wizards)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#1-message-type-attributes-pick-your-message-category class=md-nav__link> <span class=md-ellipsis> 1. Message Type Attributes (Pick Your Message Category) </span> </a> <nav class=md-nav aria-label="1. Message Type Attributes (Pick Your Message Category)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxuntargetedmessage---global-messages class=md-nav__link> <span class=md-ellipsis> [DxUntargetedMessage] - Global Messages </span> </a> <nav class=md-nav aria-label="[DxUntargetedMessage] - Global Messages"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxtargetedmessage---messages-to-specific-targets class=md-nav__link> <span class=md-ellipsis> [DxTargetedMessage] - Messages to Specific Targets </span> </a> <nav class=md-nav aria-label="[DxTargetedMessage] - Messages to Specific Targets"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates_1 class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxbroadcastmessage---messages-from-a-source class=md-nav__link> <span class=md-ellipsis> [DxBroadcastMessage] - Messages from a Source </span> </a> <nav class=md-nav aria-label="[DxBroadcastMessage] - Messages from a Source"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates_2 class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#2-dxautoconstructor---automatic-constructors class=md-nav__link> <span class=md-ellipsis> 2. [DxAutoConstructor] - Automatic Constructors </span> </a> <nav class=md-nav aria-label="2. [DxAutoConstructor] - Automatic Constructors"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-you-get-auto-generated class=md-nav__link> <span class=md-ellipsis> What you get (auto-generated) </span> </a> <nav class=md-nav aria-label="What you get (auto-generated)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#rules class=md-nav__link> <span class=md-ellipsis> Rules </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#3-dxoptionalparameter---optional-constructor-parameters class=md-nav__link> <span class=md-ellipsis> 3. [DxOptionalParameter] - Optional Constructor Parameters </span> </a> <nav class=md-nav aria-label="3. [DxOptionalParameter] - Optional Constructor Parameters"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#how-it-works-with-dxautoconstructor class=md-nav__link> <span class=md-ellipsis> How It Works with DxAutoConstructor </span> </a> </li> <li class=md-nav__item> <a href=#generated-constructor class=md-nav__link> <span class=md-ellipsis> Generated constructor </span> </a> </li> <li class=md-nav__item> <a href=#calling-the-constructor class=md-nav__link> <span class=md-ellipsis> Calling the Constructor </span> </a> </li> <li class=md-nav__item> <a href=#supported-default-value-types class=md-nav__link> <span class=md-ellipsis> Supported Default Value Types </span> </a> <nav class=md-nav aria-label="Supported Default Value Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#examples-by-type class=md-nav__link> <span class=md-ellipsis> Examples by type </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#using-type-defaults class=md-nav__link> <span class=md-ellipsis> Using Type Defaults </span> </a> </li> <li class=md-nav__item> <a href=#advanced-custom-expressions-for-any-type class=md-nav__link> <span class=md-ellipsis> Advanced: Custom Expressions for Any Type </span> </a> </li> <li class=md-nav__item> <a href=#code-examples class=md-nav__link> <span class=md-ellipsis> Code Examples </span> </a> </li> <li class=md-nav__item> <a href=#example-1-basic-optional-parameter-with-default-value class=md-nav__link> <span class=md-ellipsis> Example 1: Basic Optional Parameter with Default Value </span> </a> </li> <li class=md-nav__item> <a href=#example-2-multiple-optional-parameters class=md-nav__link> <span class=md-ellipsis> Example 2: Multiple Optional Parameters </span> </a> </li> <li class=md-nav__item> <a href=#example-3-mix-of-required-and-optional-fields class=md-nav__link> <span class=md-ellipsis> Example 3: Mix of Required and Optional Fields </span> </a> </li> <li class=md-nav__item> <a href=#example-4-game-settings-message class=md-nav__link> <span class=md-ellipsis> Example 4: Game Settings Message </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> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#why-use-attributes-instead-of-manual-implementation class=md-nav__link> <span class=md-ellipsis> Why Use Attributes Instead of Manual Implementation </span> </a> <nav class=md-nav aria-label="Why Use Attributes Instead of Manual Implementation"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#-attribute-definition-clean-automatic class=md-nav__link> <span class=md-ellipsis> ✅ Attribute Definition (Clean, Automatic) </span> </a> </li> <li class=md-nav__item> <a href=#what-the-generator-emits-for-reference class=md-nav__link> <span class=md-ellipsis> What the generator emits (for reference) </span> </a> <nav class=md-nav aria-label="What the generator emits (for reference)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#benefits class=md-nav__link> <span class=md-ellipsis> Benefits </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#complete-example-attribute-definition-vs-generated-output class=md-nav__link> <span class=md-ellipsis> Complete Example: Attribute Definition vs Generated Output </span> </a> <nav class=md-nav aria-label="Complete Example: Attribute Definition vs Generated Output"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#attribute-definition-8-lines class=md-nav__link> <span class=md-ellipsis> Attribute Definition (8 lines) </span> </a> </li> <li class=md-nav__item> <a href=#generated-output-20-lines-you-never-write class=md-nav__link> <span class=md-ellipsis> Generated Output (20 lines you never write) </span> </a> </li> <li class=md-nav__item> <a href=#result class=md-nav__link> <span class=md-ellipsis> Result </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#advanced-manual-implementation-when-attributes-arent-enough class=md-nav__link> <span class=md-ellipsis> Advanced: Manual Implementation (When Attributes Aren't Enough) </span> </a> <nav class=md-nav aria-label="Advanced: Manual Implementation (When Attributes Aren't Enough)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#generic-message-interfaces-zero-boxing-for-structs class=md-nav__link> <span class=md-ellipsis> Generic Message Interfaces (Zero-Boxing for Structs) </span> </a> </li> <li class=md-nav__item> <a href=#do-i-have-to-use-attributes class=md-nav__link> <span class=md-ellipsis> "Do I HAVE to use attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#what-if-i-want-custom-constructor-logic class=md-nav__link> <span class=md-ellipsis> "What if I want custom constructor logic?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-mix-attribute-based-and-manual-messages class=md-nav__link> <span class=md-ellipsis> "Can I mix attribute-based and manual messages?" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#extension-methods-emit-helpers class=md-nav__link> <span class=md-ellipsis> Extension Methods (Emit Helpers) </span> </a> <nav class=md-nav aria-label="Extension Methods (Emit Helpers)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#automatic-overload-selection class=md-nav__link> <span class=md-ellipsis> Automatic overload selection </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#local-bus-islands-isolated-testing class=md-nav__link> <span class=md-ellipsis> Local Bus Islands (Isolated Testing) </span> </a> <nav class=md-nav aria-label="Local Bus Islands (Isolated Testing)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-cases class=md-nav__link> <span class=md-ellipsis> Use cases </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#attributes-quick-reference class=md-nav__link> <span class=md-ellipsis> Attributes Quick Reference </span> </a> <nav class=md-nav aria-label="Attributes Quick Reference"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#message-type-attributes class=md-nav__link> <span class=md-ellipsis> Message Type Attributes </span> </a> <nav class=md-nav aria-label="Message Type Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#untargeted class=md-nav__link> <span class=md-ellipsis> Untargeted </span> </a> </li> <li class=md-nav__item> <a href=#targeted class=md-nav__link> <span class=md-ellipsis> Targeted </span> </a> </li> <li class=md-nav__item> <a href=#broadcast class=md-nav__link> <span class=md-ellipsis> Broadcast </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#constructor-generation-attributes class=md-nav__link> <span class=md-ellipsis> Constructor Generation Attributes </span> </a> <nav class=md-nav aria-label="Constructor Generation Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxautoconstructor class=md-nav__link> <span class=md-ellipsis> [DxAutoConstructor] </span> </a> </li> <li class=md-nav__item> <a href=#dxoptionalparameter class=md-nav__link> <span class=md-ellipsis> [DxOptionalParameter] </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#supported-types class=md-nav__link> <span class=md-ellipsis> Supported Types </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#common-patterns-with-attributes class=md-nav__link> <span class=md-ellipsis> Common Patterns with Attributes </span> </a> <nav class=md-nav aria-label="Common Patterns with Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#pattern-1-simple-message-no-data class=md-nav__link> <span class=md-ellipsis> Pattern 1: Simple Message (No Data) </span> </a> </li> <li class=md-nav__item> <a href=#pattern-2-message-with-data class=md-nav__link> <span class=md-ellipsis> Pattern 2: Message with Data </span> </a> </li> <li class=md-nav__item> <a href=#pattern-3-message-with-optional-fields class=md-nav__link> <span class=md-ellipsis> Pattern 3: Message with Optional Fields </span> </a> </li> <li class=md-nav__item> <a href=#pattern-4-complex-message class=md-nav__link> <span class=md-ellipsis> Pattern 4: Complex Message </span> </a> </li> <li class=md-nav__item> <a href=#pattern-5-nested-types class=md-nav__link> <span class=md-ellipsis> Pattern 5: Nested Types </span> </a> <nav class=md-nav aria-label="Pattern 5: Nested Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#benefits_1 class=md-nav__link> <span class=md-ellipsis> Benefits </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#pattern-6-internal-types-assembly-private-messages class=md-nav__link> <span class=md-ellipsis> Pattern 6: Internal Types (Assembly-Private Messages) </span> </a> <nav class=md-nav aria-label="Pattern 6: Internal Types (Assembly-Private Messages)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-cases_1 class=md-nav__link> <span class=md-ellipsis> Use cases </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#faq-source-generators--attributes class=md-nav__link> <span class=md-ellipsis> FAQ: Source Generators &amp; Attributes </span> </a> <nav class=md-nav aria-label="FAQ: Source Generators & Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#do-i-have-to-use-attributes_1 class=md-nav__link> <span class=md-ellipsis> "Do I HAVE to use attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#why-partial-when-using-attributes class=md-nav__link> <span class=md-ellipsis> "Why partial when using attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-see-the-generated-code class=md-nav__link> <span class=md-ellipsis> "Can I see the generated code?" </span> </a> </li> <li class=md-nav__item> <a href=#what-if-i-want-custom-constructor-logic_1 class=md-nav__link> <span class=md-ellipsis> "What if I want custom constructor logic?" </span> </a> </li> <li class=md-nav__item> <a href=#do-attributes-affect-runtime-performance class=md-nav__link> <span class=md-ellipsis> "Do attributes affect runtime performance?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-mix-attributes-and-manual-implementation class=md-nav__link> <span class=md-ellipsis> "Can I mix attributes and manual implementation?" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#troubleshooting-source-generators class=md-nav__link> <span class=md-ellipsis> Troubleshooting Source Generators </span> </a> <nav class=md-nav aria-label="Troubleshooting Source Generators"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#checklist class=md-nav__link> <span class=md-ellipsis> Checklist </span> </a> <nav class=md-nav aria-label=Checklist> <ul class=md-nav__list> <li class=md-nav__item> <a href=#fix class=md-nav__link> <span class=md-ellipsis> Fix </span> </a> <nav class=md-nav aria-label=Fix> <ul class=md-nav__list> <li class=md-nav__item> <a href=#solution class=md-nav__link> <span class=md-ellipsis> Solution </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#related-documentation class=md-nav__link> <span class=md-ellipsis> Related Documentation </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=#source-generators--code-wizards-that-write-boilerplate-for-you class=md-nav__link> <span class=md-ellipsis> Source generators = Code wizards that write boilerplate for you </span> </a> <nav class=md-nav aria-label="Source generators = Code wizards that write boilerplate for you"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-attributes-for class=md-nav__link> <span class=md-ellipsis> Use attributes for </span> </a> <nav class=md-nav aria-label="Use attributes for"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-manual-implementation-for class=md-nav__link> <span class=md-ellipsis> Use manual implementation for </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../faq/ class=md-nav__link> <span class=md-ellipsis> FAQ </span> </a> </li> <li class=md-nav__item> <a href=../glossary/ class=md-nav__link> <span class=md-ellipsis> Glossary </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=../compatibility/ class=md-nav__link> <span class=md-ellipsis> Compatibility </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <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=#what-are-source-generators class=md-nav__link> <span class=md-ellipsis> What Are Source Generators </span> </a> <nav class=md-nav aria-label="What Are Source Generators"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#in-plain-english class=md-nav__link> <span class=md-ellipsis> In plain English </span> </a> <nav class=md-nav aria-label="In plain English"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#learn-more-about-source-generators class=md-nav__link> <span class=md-ellipsis> Learn more about source generators </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxmessaging-attributes-your-code-wizards class=md-nav__link> <span class=md-ellipsis> DxMessaging Attributes (Your Code Wizards) </span> </a> <nav class=md-nav aria-label="DxMessaging Attributes (Your Code Wizards)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#1-message-type-attributes-pick-your-message-category class=md-nav__link> <span class=md-ellipsis> 1. Message Type Attributes (Pick Your Message Category) </span> </a> <nav class=md-nav aria-label="1. Message Type Attributes (Pick Your Message Category)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxuntargetedmessage---global-messages class=md-nav__link> <span class=md-ellipsis> [DxUntargetedMessage] - Global Messages </span> </a> <nav class=md-nav aria-label="[DxUntargetedMessage] - Global Messages"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxtargetedmessage---messages-to-specific-targets class=md-nav__link> <span class=md-ellipsis> [DxTargetedMessage] - Messages to Specific Targets </span> </a> <nav class=md-nav aria-label="[DxTargetedMessage] - Messages to Specific Targets"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates_1 class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#dxbroadcastmessage---messages-from-a-source class=md-nav__link> <span class=md-ellipsis> [DxBroadcastMessage] - Messages from a Source </span> </a> <nav class=md-nav aria-label="[DxBroadcastMessage] - Messages from a Source"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-it-generates_2 class=md-nav__link> <span class=md-ellipsis> What it generates </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#2-dxautoconstructor---automatic-constructors class=md-nav__link> <span class=md-ellipsis> 2. [DxAutoConstructor] - Automatic Constructors </span> </a> <nav class=md-nav aria-label="2. [DxAutoConstructor] - Automatic Constructors"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#what-you-get-auto-generated class=md-nav__link> <span class=md-ellipsis> What you get (auto-generated) </span> </a> <nav class=md-nav aria-label="What you get (auto-generated)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#rules class=md-nav__link> <span class=md-ellipsis> Rules </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#3-dxoptionalparameter---optional-constructor-parameters class=md-nav__link> <span class=md-ellipsis> 3. [DxOptionalParameter] - Optional Constructor Parameters </span> </a> <nav class=md-nav aria-label="3. [DxOptionalParameter] - Optional Constructor Parameters"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#how-it-works-with-dxautoconstructor class=md-nav__link> <span class=md-ellipsis> How It Works with DxAutoConstructor </span> </a> </li> <li class=md-nav__item> <a href=#generated-constructor class=md-nav__link> <span class=md-ellipsis> Generated constructor </span> </a> </li> <li class=md-nav__item> <a href=#calling-the-constructor class=md-nav__link> <span class=md-ellipsis> Calling the Constructor </span> </a> </li> <li class=md-nav__item> <a href=#supported-default-value-types class=md-nav__link> <span class=md-ellipsis> Supported Default Value Types </span> </a> <nav class=md-nav aria-label="Supported Default Value Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#examples-by-type class=md-nav__link> <span class=md-ellipsis> Examples by type </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#using-type-defaults class=md-nav__link> <span class=md-ellipsis> Using Type Defaults </span> </a> </li> <li class=md-nav__item> <a href=#advanced-custom-expressions-for-any-type class=md-nav__link> <span class=md-ellipsis> Advanced: Custom Expressions for Any Type </span> </a> </li> <li class=md-nav__item> <a href=#code-examples class=md-nav__link> <span class=md-ellipsis> Code Examples </span> </a> </li> <li class=md-nav__item> <a href=#example-1-basic-optional-parameter-with-default-value class=md-nav__link> <span class=md-ellipsis> Example 1: Basic Optional Parameter with Default Value </span> </a> </li> <li class=md-nav__item> <a href=#example-2-multiple-optional-parameters class=md-nav__link> <span class=md-ellipsis> Example 2: Multiple Optional Parameters </span> </a> </li> <li class=md-nav__item> <a href=#example-3-mix-of-required-and-optional-fields class=md-nav__link> <span class=md-ellipsis> Example 3: Mix of Required and Optional Fields </span> </a> </li> <li class=md-nav__item> <a href=#example-4-game-settings-message class=md-nav__link> <span class=md-ellipsis> Example 4: Game Settings Message </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> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#why-use-attributes-instead-of-manual-implementation class=md-nav__link> <span class=md-ellipsis> Why Use Attributes Instead of Manual Implementation </span> </a> <nav class=md-nav aria-label="Why Use Attributes Instead of Manual Implementation"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#-attribute-definition-clean-automatic class=md-nav__link> <span class=md-ellipsis> ✅ Attribute Definition (Clean, Automatic) </span> </a> </li> <li class=md-nav__item> <a href=#what-the-generator-emits-for-reference class=md-nav__link> <span class=md-ellipsis> What the generator emits (for reference) </span> </a> <nav class=md-nav aria-label="What the generator emits (for reference)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#benefits class=md-nav__link> <span class=md-ellipsis> Benefits </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#complete-example-attribute-definition-vs-generated-output class=md-nav__link> <span class=md-ellipsis> Complete Example: Attribute Definition vs Generated Output </span> </a> <nav class=md-nav aria-label="Complete Example: Attribute Definition vs Generated Output"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#attribute-definition-8-lines class=md-nav__link> <span class=md-ellipsis> Attribute Definition (8 lines) </span> </a> </li> <li class=md-nav__item> <a href=#generated-output-20-lines-you-never-write class=md-nav__link> <span class=md-ellipsis> Generated Output (20 lines you never write) </span> </a> </li> <li class=md-nav__item> <a href=#result class=md-nav__link> <span class=md-ellipsis> Result </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#advanced-manual-implementation-when-attributes-arent-enough class=md-nav__link> <span class=md-ellipsis> Advanced: Manual Implementation (When Attributes Aren't Enough) </span> </a> <nav class=md-nav aria-label="Advanced: Manual Implementation (When Attributes Aren't Enough)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#generic-message-interfaces-zero-boxing-for-structs class=md-nav__link> <span class=md-ellipsis> Generic Message Interfaces (Zero-Boxing for Structs) </span> </a> </li> <li class=md-nav__item> <a href=#do-i-have-to-use-attributes class=md-nav__link> <span class=md-ellipsis> "Do I HAVE to use attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#what-if-i-want-custom-constructor-logic class=md-nav__link> <span class=md-ellipsis> "What if I want custom constructor logic?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-mix-attribute-based-and-manual-messages class=md-nav__link> <span class=md-ellipsis> "Can I mix attribute-based and manual messages?" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#extension-methods-emit-helpers class=md-nav__link> <span class=md-ellipsis> Extension Methods (Emit Helpers) </span> </a> <nav class=md-nav aria-label="Extension Methods (Emit Helpers)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#automatic-overload-selection class=md-nav__link> <span class=md-ellipsis> Automatic overload selection </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#local-bus-islands-isolated-testing class=md-nav__link> <span class=md-ellipsis> Local Bus Islands (Isolated Testing) </span> </a> <nav class=md-nav aria-label="Local Bus Islands (Isolated Testing)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-cases class=md-nav__link> <span class=md-ellipsis> Use cases </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#attributes-quick-reference class=md-nav__link> <span class=md-ellipsis> Attributes Quick Reference </span> </a> <nav class=md-nav aria-label="Attributes Quick Reference"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#message-type-attributes class=md-nav__link> <span class=md-ellipsis> Message Type Attributes </span> </a> <nav class=md-nav aria-label="Message Type Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#untargeted class=md-nav__link> <span class=md-ellipsis> Untargeted </span> </a> </li> <li class=md-nav__item> <a href=#targeted class=md-nav__link> <span class=md-ellipsis> Targeted </span> </a> </li> <li class=md-nav__item> <a href=#broadcast class=md-nav__link> <span class=md-ellipsis> Broadcast </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#constructor-generation-attributes class=md-nav__link> <span class=md-ellipsis> Constructor Generation Attributes </span> </a> <nav class=md-nav aria-label="Constructor Generation Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#dxautoconstructor class=md-nav__link> <span class=md-ellipsis> [DxAutoConstructor] </span> </a> </li> <li class=md-nav__item> <a href=#dxoptionalparameter class=md-nav__link> <span class=md-ellipsis> [DxOptionalParameter] </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#supported-types class=md-nav__link> <span class=md-ellipsis> Supported Types </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#common-patterns-with-attributes class=md-nav__link> <span class=md-ellipsis> Common Patterns with Attributes </span> </a> <nav class=md-nav aria-label="Common Patterns with Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#pattern-1-simple-message-no-data class=md-nav__link> <span class=md-ellipsis> Pattern 1: Simple Message (No Data) </span> </a> </li> <li class=md-nav__item> <a href=#pattern-2-message-with-data class=md-nav__link> <span class=md-ellipsis> Pattern 2: Message with Data </span> </a> </li> <li class=md-nav__item> <a href=#pattern-3-message-with-optional-fields class=md-nav__link> <span class=md-ellipsis> Pattern 3: Message with Optional Fields </span> </a> </li> <li class=md-nav__item> <a href=#pattern-4-complex-message class=md-nav__link> <span class=md-ellipsis> Pattern 4: Complex Message </span> </a> </li> <li class=md-nav__item> <a href=#pattern-5-nested-types class=md-nav__link> <span class=md-ellipsis> Pattern 5: Nested Types </span> </a> <nav class=md-nav aria-label="Pattern 5: Nested Types"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#benefits_1 class=md-nav__link> <span class=md-ellipsis> Benefits </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#pattern-6-internal-types-assembly-private-messages class=md-nav__link> <span class=md-ellipsis> Pattern 6: Internal Types (Assembly-Private Messages) </span> </a> <nav class=md-nav aria-label="Pattern 6: Internal Types (Assembly-Private Messages)"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-cases_1 class=md-nav__link> <span class=md-ellipsis> Use cases </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#faq-source-generators--attributes class=md-nav__link> <span class=md-ellipsis> FAQ: Source Generators &amp; Attributes </span> </a> <nav class=md-nav aria-label="FAQ: Source Generators & Attributes"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#do-i-have-to-use-attributes_1 class=md-nav__link> <span class=md-ellipsis> "Do I HAVE to use attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#why-partial-when-using-attributes class=md-nav__link> <span class=md-ellipsis> "Why partial when using attributes?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-see-the-generated-code class=md-nav__link> <span class=md-ellipsis> "Can I see the generated code?" </span> </a> </li> <li class=md-nav__item> <a href=#what-if-i-want-custom-constructor-logic_1 class=md-nav__link> <span class=md-ellipsis> "What if I want custom constructor logic?" </span> </a> </li> <li class=md-nav__item> <a href=#do-attributes-affect-runtime-performance class=md-nav__link> <span class=md-ellipsis> "Do attributes affect runtime performance?" </span> </a> </li> <li class=md-nav__item> <a href=#can-i-mix-attributes-and-manual-implementation class=md-nav__link> <span class=md-ellipsis> "Can I mix attributes and manual implementation?" </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#troubleshooting-source-generators class=md-nav__link> <span class=md-ellipsis> Troubleshooting Source Generators </span> </a> <nav class=md-nav aria-label="Troubleshooting Source Generators"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#checklist class=md-nav__link> <span class=md-ellipsis> Checklist </span> </a> <nav class=md-nav aria-label=Checklist> <ul class=md-nav__list> <li class=md-nav__item> <a href=#fix class=md-nav__link> <span class=md-ellipsis> Fix </span> </a> <nav class=md-nav aria-label=Fix> <ul class=md-nav__list> <li class=md-nav__item> <a href=#solution class=md-nav__link> <span class=md-ellipsis> Solution </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#related-documentation class=md-nav__link> <span class=md-ellipsis> Related Documentation </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=#source-generators--code-wizards-that-write-boilerplate-for-you class=md-nav__link> <span class=md-ellipsis> Source generators = Code wizards that write boilerplate for you </span> </a> <nav class=md-nav aria-label="Source generators = Code wizards that write boilerplate for you"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-attributes-for class=md-nav__link> <span class=md-ellipsis> Use attributes for </span> </a> <nav class=md-nav aria-label="Use attributes for"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#use-manual-implementation-for class=md-nav__link> <span class=md-ellipsis> Use manual implementation for </span> </a> </li> </ul> </nav> </li> </ul> </nav> </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=../reference/ class=md-path__link> <span class=md-ellipsis> Reference </span> </a> </li> </ol> </nav> <article class="md-content__inner md-typeset"> <a href=https://github.com/wallstop/DxMessaging/edit/master/docs/reference/helpers.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="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> </a> <a href=https://github.com/wallstop/DxMessaging/raw/master/docs/reference/helpers.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="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg> </a> <h1 id=helpers-and-source-generation>Helpers and Source Generation<a class=headerlink href=#helpers-and-source-generation title="Anchor link to this section">&para;</a></h1> <h2 id=what-are-source-generators>What Are Source Generators<a class=headerlink href=#what-are-source-generators title="Anchor link to this section">&para;</a></h2> <p><strong>Source generators</strong> are a C# feature (introduced in C# 9.0) that <strong>automatically write code for you at compile time</strong>. Think of them as smart code wizards that look at your code, see what you need, and generate the boilerplate automatically.</p> <h3 id=in-plain-english>In plain English<a class=headerlink href=#in-plain-english title="Anchor link to this section">&para;</a></h3> <ul> <li>You write: <code>[DxAutoConstructor]</code> on a struct</li> <li>Source generator sees: "Oh, they want a constructor!"</li> <li>Source generator creates: A constructor with all the fields as parameters</li> <li>You get: Less typing, fewer bugs, more consistent code</li> </ul> <h4 id=learn-more-about-source-generators>Learn more about source generators<a class=headerlink href=#learn-more-about-source-generators title="Anchor link to this section">&para;</a></h4> <ul> <li><a href=https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview>Microsoft Docs: Source Generators</a></li> <li><a href=https://devblogs.microsoft.com/dotnet/introducing-c-source-generators/ >Introduction to C# Source Generators</a></li> </ul> <h2 id=dxmessaging-attributes-your-code-wizards>DxMessaging Attributes (Your Code Wizards)<a class=headerlink href=#dxmessaging-attributes-your-code-wizards title="Anchor link to this section">&para;</a></h2> <p>DxMessaging provides <strong>3 main attributes</strong> that use source generators to eliminate boilerplate:</p> <h3 id=1-message-type-attributes-pick-your-message-category>1. Message Type Attributes (Pick Your Message Category)<a class=headerlink href=#1-message-type-attributes-pick-your-message-category title="Anchor link to this section">&para;</a></h3> <p>These tell the source generator what KIND of message you're making:</p> <h4 id=dxuntargetedmessage---global-messages><code>[DxUntargetedMessage]</code> - Global Messages<a class=headerlink href=#dxuntargetedmessage---global-messages title="Anchor link to this section">&para;</a></h4> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-0-1><a id=__codelineno-0-1 name=__codelineno-0-1 href=#__codelineno-0-1></a><span class=na>[DxUntargetedMessage]</span><span class=w> </span><span class=c1>// ← Tells generator: &quot;This is a global message&quot;</span>
2
2
  </span><span id=__span-0-2><a id=__codelineno-0-2 name=__codelineno-0-2 href=#__codelineno-0-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>GamePaused</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
3
3
  </span></code></pre></div> <h5 id=what-it-generates>What it generates<a class=headerlink href=#what-it-generates title="Anchor link to this section">&para;</a></h5> <ul> <li>Implements <code>IUntargetedMessage&lt;GamePaused&gt;</code></li> <li>Adds required plumbing for the message system</li> <li>Makes it work with <code>.Emit()</code> extension methods</li> </ul> <h4 id=dxtargetedmessage---messages-to-specific-targets><code>[DxTargetedMessage]</code> - Messages to Specific Targets<a class=headerlink href=#dxtargetedmessage---messages-to-specific-targets title="Anchor link to this section">&para;</a></h4> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-1-1><a id=__codelineno-1-1 name=__codelineno-1-1 href=#__codelineno-1-1></a><span class=na>[DxTargetedMessage]</span><span class=w> </span><span class=c1>// ← Tells generator: &quot;This goes to one specific target&quot;</span>
4
4
  </span><span id=__span-1-2><a id=__codelineno-1-2 name=__codelineno-1-2 href=#__codelineno-1-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>Heal</span><span class=w> </span><span class=p>{</span>
@@ -48,7 +48,7 @@
48
48
  </span><span id=__span-7-7><a id=__codelineno-7-7 name=__codelineno-7-7 href=#__codelineno-7-7></a><span class=c1>// Use named arguments to skip some optionals</span>
49
49
  </span><span id=__span-7-8><a id=__codelineno-7-8 name=__codelineno-7-8 href=#__codelineno-7-8></a><span class=kt>var</span><span class=w> </span><span class=n>settings3</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>SettingsChanged</span><span class=p>(</span><span class=mf>0.8f</span><span class=p>,</span><span class=w> </span><span class=mi>2</span><span class=p>,</span><span class=w> </span><span class=n>fullscreen</span><span class=p>:</span><span class=w> </span><span class=k>true</span><span class=p>);</span><span class=w> </span><span class=c1>// brightness=100</span>
50
50
  </span><span id=__span-7-9><a id=__codelineno-7-9 name=__codelineno-7-9 href=#__codelineno-7-9></a><span class=kt>var</span><span class=w> </span><span class=n>settings4</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>SettingsChanged</span><span class=p>(</span><span class=mf>0.8f</span><span class=p>,</span><span class=w> </span><span class=mi>2</span><span class=p>,</span><span class=w> </span><span class=n>brightness</span><span class=p>:</span><span class=w> </span><span class=mi>50</span><span class=p>);</span><span class=w> </span><span class=c1>// fullscreen=false</span>
51
- </span></code></pre></div> <h4 id=supported-default-value-types>Supported Default Value Types<a class=headerlink href=#supported-default-value-types title="Anchor link to this section">&para;</a></h4> <p>The attribute provides constructor overloads for all common primitive types:</p> <div class="admonition info"> <p class=admonition-title>Built-in Type Support</p> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=__tabbed_1_1 name=__tabbed_1 type=radio><input id=__tabbed_1_2 name=__tabbed_1 type=radio><div class=tabbed-labels><label for=__tabbed_1_1>Numeric</label><label for=__tabbed_1_2>Other</label></div> <div class=tabbed-content> <div class=tabbed-block> <table> <thead> <tr> <th>Category</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>Signed Integers</strong></td> <td><code>sbyte</code>, <code>short</code>, <code>int</code>, <code>long</code></td> </tr> <tr> <td><strong>Unsigned Integers</strong></td> <td><code>byte</code>, <code>ushort</code>, <code>uint</code>, <code>ulong</code></td> </tr> <tr> <td><strong>Floating Point</strong></td> <td><code>float</code>, <code>double</code></td> </tr> </tbody> </table> </div> <div class=tabbed-block> <table> <thead> <tr> <th>Category</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>Boolean</strong></td> <td><code>bool</code></td> </tr> <tr> <td><strong>Character</strong></td> <td><code>char</code></td> </tr> <tr> <td><strong>String</strong></td> <td><code>string</code></td> </tr> </tbody> </table> </div> </div> </div> <p>For enums, Unity types, and other complex types, use the <code>Expression</code> property.</p> </div> <h5 id=examples-by-type>Examples by type<a class=headerlink href=#examples-by-type title="Anchor link to this section">&para;</a></h5> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-8-1><a id=__codelineno-8-1 name=__codelineno-8-1 href=#__codelineno-8-1></a><span class=na>[DxAutoConstructor]</span>
51
+ </span></code></pre></div> <h4 id=supported-default-value-types>Supported Default Value Types<a class=headerlink href=#supported-default-value-types title="Anchor link to this section">&para;</a></h4> <p>The attribute provides constructor overloads for all common primitive types:</p> <blockquote> <p>ℹ️ <strong>Info: Built-in Type Support</strong></p> <p><strong>Numeric:</strong></p> <table> <thead> <tr> <th>Category</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>Signed Integers</strong></td> <td><code>sbyte</code>, <code>short</code>, <code>int</code>, <code>long</code></td> </tr> <tr> <td><strong>Unsigned Integers</strong></td> <td><code>byte</code>, <code>ushort</code>, <code>uint</code>, <code>ulong</code></td> </tr> <tr> <td><strong>Floating Point</strong></td> <td><code>float</code>, <code>double</code></td> </tr> </tbody> </table> <p><strong>Other:</strong></p> <table> <thead> <tr> <th>Category</th> <th>Types</th> </tr> </thead> <tbody> <tr> <td><strong>Boolean</strong></td> <td><code>bool</code></td> </tr> <tr> <td><strong>Character</strong></td> <td><code>char</code></td> </tr> <tr> <td><strong>String</strong></td> <td><code>string</code></td> </tr> </tbody> </table> <p>For enums, Unity types, and other complex types, use the <code>Expression</code> property.</p> </blockquote> <h5 id=examples-by-type>Examples by type<a class=headerlink href=#examples-by-type title="Anchor link to this section">&para;</a></h5> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-8-1><a id=__codelineno-8-1 name=__codelineno-8-1 href=#__codelineno-8-1></a><span class=na>[DxAutoConstructor]</span>
52
52
  </span><span id=__span-8-2><a id=__codelineno-8-2 name=__codelineno-8-2 href=#__codelineno-8-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>TypeExamples</span>
53
53
  </span><span id=__span-8-3><a id=__codelineno-8-3 name=__codelineno-8-3 href=#__codelineno-8-3></a><span class=p>{</span>
54
54
  </span><span id=__span-8-4><a id=__codelineno-8-4 name=__codelineno-8-4 href=#__codelineno-8-4></a><span class=w> </span><span class=c1>// Boolean</span>
@@ -137,7 +137,7 @@
137
137
  </span><span id=__span-10-24><a id=__codelineno-10-24 name=__codelineno-10-24 href=#__codelineno-10-24></a><span class=w> </span><span class=na>[DxOptionalParameter(Expression = &quot;GameConstants.DefaultHealth&quot;)]</span>
138
138
  </span><span id=__span-10-25><a id=__codelineno-10-25 name=__codelineno-10-25 href=#__codelineno-10-25></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>health</span><span class=p>;</span>
139
139
  </span><span id=__span-10-26><a id=__codelineno-10-26 name=__codelineno-10-26 href=#__codelineno-10-26></a><span class=p>}</span>
140
- </span></code></pre></div> <div class="admonition tip"> <p class=admonition-title>Expression rules</p> <ul> <li>The expression is inserted <strong>verbatim</strong> into the generated code</li> <li>Must be a valid C# constant expression</li> <li>Type safety is enforced by the C# compiler at build time</li> <li>Perfect for enums, nullable types, static constants, or complex defaults</li> </ul> </div> <h4 id=code-examples>Code Examples<a class=headerlink href=#code-examples title="Anchor link to this section">&para;</a></h4> <h4 id=example-1-basic-optional-parameter-with-default-value>Example 1: Basic Optional Parameter with Default Value<a class=headerlink href=#example-1-basic-optional-parameter-with-default-value title="Anchor link to this section">&para;</a></h4> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-11-1><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=na>[DxTargetedMessage]</span>
140
+ </span></code></pre></div> <blockquote> <p>💡 <strong>Tip: Expression rules</strong></p> <ul> <li>The expression is inserted <strong>verbatim</strong> into the generated code</li> <li>Must be a valid C# constant expression</li> <li>Type safety is enforced by the C# compiler at build time</li> <li>Perfect for enums, nullable types, static constants, or complex defaults</li> </ul> </blockquote> <h4 id=code-examples>Code Examples<a class=headerlink href=#code-examples title="Anchor link to this section">&para;</a></h4> <h4 id=example-1-basic-optional-parameter-with-default-value>Example 1: Basic Optional Parameter with Default Value<a class=headerlink href=#example-1-basic-optional-parameter-with-default-value title="Anchor link to this section">&para;</a></h4> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-11-1><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=na>[DxTargetedMessage]</span>
141
141
  </span><span id=__span-11-2><a id=__codelineno-11-2 name=__codelineno-11-2 href=#__codelineno-11-2></a><span class=na>[DxAutoConstructor]</span>
142
142
  </span><span id=__span-11-3><a id=__codelineno-11-3 name=__codelineno-11-3 href=#__codelineno-11-3></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>Heal</span>
143
143
  </span><span id=__span-11-4><a id=__codelineno-11-4 name=__codelineno-11-4 href=#__codelineno-11-4></a><span class=p>{</span>
@@ -219,7 +219,7 @@
219
219
  </span><span id=__span-14-23><a id=__codelineno-14-23 name=__codelineno-14-23 href=#__codelineno-14-23></a>
220
220
  </span><span id=__span-14-24><a id=__codelineno-14-24 name=__codelineno-14-24 href=#__codelineno-14-24></a><span class=c1>// Change multiple settings</span>
221
221
  </span><span id=__span-14-25><a id=__codelineno-14-25 name=__codelineno-14-25 href=#__codelineno-14-25></a><span class=k>new</span><span class=w> </span><span class=nf>AudioSettingsChanged</span><span class=p>(</span><span class=mf>0.7f</span><span class=p>,</span><span class=w> </span><span class=mf>0.6f</span><span class=p>,</span><span class=w> </span><span class=mf>0.9f</span><span class=p>,</span><span class=w> </span><span class=k>false</span><span class=p>).</span><span class=n>Emit</span><span class=p>();</span>
222
- </span></code></pre></div> <h4 id=best-practices>Best Practices<a class=headerlink href=#best-practices title="Anchor link to this section">&para;</a></h4> <div class="admonition success"> <p class=admonition-title>Recommendations</p> <ol> <li><strong>Order matters</strong> — Place required fields before optional fields in your struct</li> <li><strong>Use meaningful defaults</strong> — Choose defaults that represent the most common use case</li> <li><strong>Prefer explicit values</strong> — Use <code>[DxOptionalParameter(0)]</code> instead of <code>[DxOptionalParameter]</code> when clarity helps</li> <li><strong>Use Expression for complex types</strong> — Don't fight the type system; use <code>Expression</code> for enums and Unity types</li> <li><strong>Document unusual defaults</strong> — If a default isn't obvious, add a comment explaining why</li> </ol> </div> <h2 id=why-use-attributes-instead-of-manual-implementation>Why Use Attributes Instead of Manual Implementation<a class=headerlink href=#why-use-attributes-instead-of-manual-implementation title="Anchor link to this section">&para;</a></h2> <h3 id=-attribute-definition-clean-automatic>✅ Attribute Definition (Clean, Automatic)<a class=headerlink href=#-attribute-definition-clean-automatic title="Anchor link to this section">&para;</a></h3> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-15-1><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a><span class=na>[DxTargetedMessage]</span>
222
+ </span></code></pre></div> <h4 id=best-practices>Best Practices<a class=headerlink href=#best-practices title="Anchor link to this section">&para;</a></h4> <blockquote> <p>✅ <strong>Success: Recommendations</strong></p> <ol> <li><strong>Order matters</strong> — Place required fields before optional fields in your struct</li> <li><strong>Use meaningful defaults</strong> — Choose defaults that represent the most common use case</li> <li><strong>Prefer explicit values</strong> — Use <code>[DxOptionalParameter(0)]</code> instead of <code>[DxOptionalParameter]</code> when clarity helps</li> <li><strong>Use Expression for complex types</strong> — Don't fight the type system; use <code>Expression</code> for enums and Unity types</li> <li><strong>Document unusual defaults</strong> — If a default isn't obvious, add a comment explaining why</li> </ol> </blockquote> <h2 id=why-use-attributes-instead-of-manual-implementation>Why Use Attributes Instead of Manual Implementation<a class=headerlink href=#why-use-attributes-instead-of-manual-implementation title="Anchor link to this section">&para;</a></h2> <h3 id=-attribute-definition-clean-automatic>✅ Attribute Definition (Clean, Automatic)<a class=headerlink href=#-attribute-definition-clean-automatic title="Anchor link to this section">&para;</a></h3> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-15-1><a id=__codelineno-15-1 name=__codelineno-15-1 href=#__codelineno-15-1></a><span class=na>[DxTargetedMessage]</span>
223
223
  </span><span id=__span-15-2><a id=__codelineno-15-2 name=__codelineno-15-2 href=#__codelineno-15-2></a><span class=na>[DxAutoConstructor]</span>
224
224
  </span><span id=__span-15-3><a id=__codelineno-15-3 name=__codelineno-15-3 href=#__codelineno-15-3></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>Heal</span>
225
225
  </span><span id=__span-15-4><a id=__codelineno-15-4 name=__codelineno-15-4 href=#__codelineno-15-4></a><span class=p>{</span>
@@ -329,35 +329,35 @@
329
329
  </span><span id=__span-24-12><a id=__codelineno-24-12 name=__codelineno-24-12 href=#__codelineno-24-12></a><span class=c1>// Emit to isolated bus (won&#39;t affect global bus!)</span>
330
330
  </span><span id=__span-24-13><a id=__codelineno-24-13 name=__codelineno-24-13 href=#__codelineno-24-13></a><span class=kt>var</span><span class=w> </span><span class=n>msg</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=k>new</span><span class=w> </span><span class=n>MyMessage</span><span class=p>();</span>
331
331
  </span><span id=__span-24-14><a id=__codelineno-24-14 name=__codelineno-24-14 href=#__codelineno-24-14></a><span class=n>msg</span><span class=p>.</span><span class=n>Emit</span><span class=p>(</span><span class=n>testBus</span><span class=p>);</span>
332
- </span></code></pre></div> <h3 id=use-cases>Use cases<a class=headerlink href=#use-cases title="Anchor link to this section">&para;</a></h3> <ul> <li>Unit tests (no global side effects!)</li> <li>Subsystem isolation (UI has own bus)</li> <li>Sandboxing (mod systems, untrusted code)</li> </ul> <h2 id=attributes-quick-reference>Attributes Quick Reference<a class=headerlink href=#attributes-quick-reference title="Anchor link to this section">&para;</a></h2> <h3 id=message-type-attributes>Message Type Attributes<a class=headerlink href=#message-type-attributes title="Anchor link to this section">&para;</a></h3> <div class="tabbed-set tabbed-alternate" data-tabs=2:3><input checked=checked id=__tabbed_2_1 name=__tabbed_2 type=radio><input id=__tabbed_2_2 name=__tabbed_2 type=radio><input id=__tabbed_2_3 name=__tabbed_2 type=radio><div class=tabbed-labels><label for=__tabbed_2_1>Untargeted</label><label for=__tabbed_2_2>Targeted</label><label for=__tabbed_2_3>Broadcast</label></div> <div class=tabbed-content> <div class=tabbed-block> <p>Mark as a global message (no target):</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-25-1><a id=__codelineno-25-1 name=__codelineno-25-1 href=#__codelineno-25-1></a><span class=na>[DxUntargetedMessage]</span>
332
+ </span></code></pre></div> <h3 id=use-cases>Use cases<a class=headerlink href=#use-cases title="Anchor link to this section">&para;</a></h3> <ul> <li>Unit tests (no global side effects!)</li> <li>Subsystem isolation (UI has own bus)</li> <li>Sandboxing (mod systems, untrusted code)</li> </ul> <h2 id=attributes-quick-reference>Attributes Quick Reference<a class=headerlink href=#attributes-quick-reference title="Anchor link to this section">&para;</a></h2> <h3 id=message-type-attributes>Message Type Attributes<a class=headerlink href=#message-type-attributes title="Anchor link to this section">&para;</a></h3> <h4 id=untargeted>Untargeted<a class=headerlink href=#untargeted title="Anchor link to this section">&para;</a></h4> <p>Mark as a global message (no target):</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-25-1><a id=__codelineno-25-1 name=__codelineno-25-1 href=#__codelineno-25-1></a><span class=na>[DxUntargetedMessage]</span>
333
333
  </span><span id=__span-25-2><a id=__codelineno-25-2 name=__codelineno-25-2 href=#__codelineno-25-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>GamePaused</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
334
- </span></code></pre></div> </div> <div class=tabbed-block> <p>Mark as a message sent to a specific target:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-26-1><a id=__codelineno-26-1 name=__codelineno-26-1 href=#__codelineno-26-1></a><span class=na>[DxTargetedMessage]</span>
334
+ </span></code></pre></div> <h4 id=targeted>Targeted<a class=headerlink href=#targeted title="Anchor link to this section">&para;</a></h4> <p>Mark as a message sent to a specific target:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-26-1><a id=__codelineno-26-1 name=__codelineno-26-1 href=#__codelineno-26-1></a><span class=na>[DxTargetedMessage]</span>
335
335
  </span><span id=__span-26-2><a id=__codelineno-26-2 name=__codelineno-26-2 href=#__codelineno-26-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>Heal</span>
336
336
  </span><span id=__span-26-3><a id=__codelineno-26-3 name=__codelineno-26-3 href=#__codelineno-26-3></a><span class=p>{</span>
337
337
  </span><span id=__span-26-4><a id=__codelineno-26-4 name=__codelineno-26-4 href=#__codelineno-26-4></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>amount</span><span class=p>;</span>
338
338
  </span><span id=__span-26-5><a id=__codelineno-26-5 name=__codelineno-26-5 href=#__codelineno-26-5></a><span class=p>}</span>
339
- </span></code></pre></div> </div> <div class=tabbed-block> <p>Mark as a message broadcast from a source:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-27-1><a id=__codelineno-27-1 name=__codelineno-27-1 href=#__codelineno-27-1></a><span class=na>[DxBroadcastMessage]</span>
339
+ </span></code></pre></div> <h4 id=broadcast>Broadcast<a class=headerlink href=#broadcast title="Anchor link to this section">&para;</a></h4> <p>Mark as a message broadcast from a source:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-27-1><a id=__codelineno-27-1 name=__codelineno-27-1 href=#__codelineno-27-1></a><span class=na>[DxBroadcastMessage]</span>
340
340
  </span><span id=__span-27-2><a id=__codelineno-27-2 name=__codelineno-27-2 href=#__codelineno-27-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>TookDamage</span>
341
341
  </span><span id=__span-27-3><a id=__codelineno-27-3 name=__codelineno-27-3 href=#__codelineno-27-3></a><span class=p>{</span>
342
342
  </span><span id=__span-27-4><a id=__codelineno-27-4 name=__codelineno-27-4 href=#__codelineno-27-4></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>amount</span><span class=p>;</span>
343
343
  </span><span id=__span-27-5><a id=__codelineno-27-5 name=__codelineno-27-5 href=#__codelineno-27-5></a><span class=p>}</span>
344
- </span></code></pre></div> </div> </div> </div> <h3 id=constructor-generation-attributes>Constructor Generation Attributes<a class=headerlink href=#constructor-generation-attributes title="Anchor link to this section">&para;</a></h3> <h4 id=dxautoconstructor><code>[DxAutoConstructor]</code><a class=headerlink href=#dxautoconstructor title="Anchor link to this section">&para;</a></h4> <p>Automatically generates a constructor with all public fields as parameters:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-28-1><a id=__codelineno-28-1 name=__codelineno-28-1 href=#__codelineno-28-1></a><span class=na>[DxAutoConstructor]</span>
344
+ </span></code></pre></div> <h3 id=constructor-generation-attributes>Constructor Generation Attributes<a class=headerlink href=#constructor-generation-attributes title="Anchor link to this section">&para;</a></h3> <h4 id=dxautoconstructor><code>[DxAutoConstructor]</code><a class=headerlink href=#dxautoconstructor title="Anchor link to this section">&para;</a></h4> <p>Automatically generates a constructor with all public fields as parameters:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-28-1><a id=__codelineno-28-1 name=__codelineno-28-1 href=#__codelineno-28-1></a><span class=na>[DxAutoConstructor]</span>
345
345
  </span><span id=__span-28-2><a id=__codelineno-28-2 name=__codelineno-28-2 href=#__codelineno-28-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>Damage</span>
346
346
  </span><span id=__span-28-3><a id=__codelineno-28-3 name=__codelineno-28-3 href=#__codelineno-28-3></a><span class=p>{</span>
347
347
  </span><span id=__span-28-4><a id=__codelineno-28-4 name=__codelineno-28-4 href=#__codelineno-28-4></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>amount</span><span class=p>;</span>
348
348
  </span><span id=__span-28-5><a id=__codelineno-28-5 name=__codelineno-28-5 href=#__codelineno-28-5></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>string</span><span class=w> </span><span class=n>type</span><span class=p>;</span>
349
349
  </span><span id=__span-28-6><a id=__codelineno-28-6 name=__codelineno-28-6 href=#__codelineno-28-6></a><span class=p>}</span>
350
350
  </span><span id=__span-28-7><a id=__codelineno-28-7 name=__codelineno-28-7 href=#__codelineno-28-7></a><span class=c1>// Generates: Damage(int amount, string type)</span>
351
- </span></code></pre></div> <h4 id=dxoptionalparameter><code>[DxOptionalParameter]</code><a class=headerlink href=#dxoptionalparameter title="Anchor link to this section">&para;</a></h4> <p>Makes a constructor parameter optional. Three usage patterns:</p> <details class=example> <summary>Default Value (type default)</summary> <p>Uses the type's default value (<code>0</code>, <code>false</code>, <code>null</code>, etc.):</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-29-1><a id=__codelineno-29-1 name=__codelineno-29-1 href=#__codelineno-29-1></a><span class=na>[DxOptionalParameter]</span>
351
+ </span></code></pre></div> <h4 id=dxoptionalparameter><code>[DxOptionalParameter]</code><a class=headerlink href=#dxoptionalparameter title="Anchor link to this section">&para;</a></h4> <p>Makes a constructor parameter optional. Three usage patterns:</p> <blockquote> <p>📋 <strong>Example: Default Value (type default)</strong></p> <p>Uses the type's default value (<code>0</code>, <code>false</code>, <code>null</code>, etc.):</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-29-1><a id=__codelineno-29-1 name=__codelineno-29-1 href=#__codelineno-29-1></a><span class=na>[DxOptionalParameter]</span>
352
352
  </span><span id=__span-29-2><a id=__codelineno-29-2 name=__codelineno-29-2 href=#__codelineno-29-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>bool</span><span class=w> </span><span class=n>flag</span><span class=p>;</span>
353
353
  </span><span id=__span-29-3><a id=__codelineno-29-3 name=__codelineno-29-3 href=#__codelineno-29-3></a><span class=c1>// Generates: bool flag = default</span>
354
- </span></code></pre></div> </details> <details class=example> <summary>Custom Value (primitive)</summary> <p>Provides a specific default value:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-30-1><a id=__codelineno-30-1 name=__codelineno-30-1 href=#__codelineno-30-1></a><span class=na>[DxOptionalParameter(42)]</span>
354
+ </span></code></pre></div> <p>📋 <strong>Example: Custom Value (primitive)</strong></p> <p>Provides a specific default value:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-30-1><a id=__codelineno-30-1 name=__codelineno-30-1 href=#__codelineno-30-1></a><span class=na>[DxOptionalParameter(42)]</span>
355
355
  </span><span id=__span-30-2><a id=__codelineno-30-2 name=__codelineno-30-2 href=#__codelineno-30-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=n>count</span><span class=p>;</span>
356
356
  </span><span id=__span-30-3><a id=__codelineno-30-3 name=__codelineno-30-3 href=#__codelineno-30-3></a><span class=c1>// Generates: int count = 42</span>
357
- </span></code></pre></div> </details> <details class=example> <summary>Expression (complex types)</summary> <p>Uses a verbatim expression for enums, Unity types, etc.:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-31-1><a id=__codelineno-31-1 name=__codelineno-31-1 href=#__codelineno-31-1></a><span class=na>[DxOptionalParameter(Expression = &quot;DamageType.Physical&quot;)]</span>
357
+ </span></code></pre></div> <p>📋 <strong>Example: Expression (complex types)</strong></p> <p>Uses a verbatim expression for enums, Unity types, etc.:</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-31-1><a id=__codelineno-31-1 name=__codelineno-31-1 href=#__codelineno-31-1></a><span class=na>[DxOptionalParameter(Expression = &quot;DamageType.Physical&quot;)]</span>
358
358
  </span><span id=__span-31-2><a id=__codelineno-31-2 name=__codelineno-31-2 href=#__codelineno-31-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=n>DamageType</span><span class=w> </span><span class=n>damageType</span><span class=p>;</span>
359
359
  </span><span id=__span-31-3><a id=__codelineno-31-3 name=__codelineno-31-3 href=#__codelineno-31-3></a><span class=c1>// Generates: DamageType damageType = DamageType.Physical</span>
360
- </span></code></pre></div> </details> <h3 id=supported-types>Supported Types<a class=headerlink href=#supported-types title="Anchor link to this section">&para;</a></h3> <p>These attributes work with:</p> <ul> <li><strong>Top-level types</strong> — public structs and classes</li> <li><strong>Nested types</strong> — types inside other classes</li> <li><strong>Internal types</strong> — assembly-private messages</li> </ul> <h2 id=common-patterns-with-attributes>Common Patterns with Attributes<a class=headerlink href=#common-patterns-with-attributes title="Anchor link to this section">&para;</a></h2> <h3 id=pattern-1-simple-message-no-data>Pattern 1: Simple Message (No Data)<a class=headerlink href=#pattern-1-simple-message-no-data title="Anchor link to this section">&para;</a></h3> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-32-1><a id=__codelineno-32-1 name=__codelineno-32-1 href=#__codelineno-32-1></a><span class=na>[DxUntargetedMessage]</span>
360
+ </span></code></pre></div> </blockquote> <h3 id=supported-types>Supported Types<a class=headerlink href=#supported-types title="Anchor link to this section">&para;</a></h3> <p>These attributes work with:</p> <ul> <li><strong>Top-level types</strong> — public structs and classes</li> <li><strong>Nested types</strong> — types inside other classes</li> <li><strong>Internal types</strong> — assembly-private messages</li> </ul> <h2 id=common-patterns-with-attributes>Common Patterns with Attributes<a class=headerlink href=#common-patterns-with-attributes title="Anchor link to this section">&para;</a></h2> <h3 id=pattern-1-simple-message-no-data>Pattern 1: Simple Message (No Data)<a class=headerlink href=#pattern-1-simple-message-no-data title="Anchor link to this section">&para;</a></h3> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-32-1><a id=__codelineno-32-1 name=__codelineno-32-1 href=#__codelineno-32-1></a><span class=na>[DxUntargetedMessage]</span>
361
361
  </span><span id=__span-32-2><a id=__codelineno-32-2 name=__codelineno-32-2 href=#__codelineno-32-2></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>GamePaused</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
362
362
  </span><span id=__span-32-3><a id=__codelineno-32-3 name=__codelineno-32-3 href=#__codelineno-32-3></a><span class=c1>// No constructor needed - empty message</span>
363
363
  </span></code></pre></div> <h3 id=pattern-2-message-with-data>Pattern 2: Message with Data<a class=headerlink href=#pattern-2-message-with-data title="Anchor link to this section">&para;</a></h3> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-33-1><a id=__codelineno-33-1 name=__codelineno-33-1 href=#__codelineno-33-1></a><span class=na>[DxTargetedMessage]</span>
@@ -456,14 +456,14 @@
456
456
  </span><span id=__span-41-6><a id=__codelineno-41-6 name=__codelineno-41-6 href=#__codelineno-41-6></a><span class=p>}</span>
457
457
  </span><span id=__span-41-7><a id=__codelineno-41-7 name=__codelineno-41-7 href=#__codelineno-41-7></a>
458
458
  </span><span id=__span-41-8><a id=__codelineno-41-8 name=__codelineno-41-8 href=#__codelineno-41-8></a><span class=c1>// Existing manual messages keep working alongside attribute-driven ones.</span>
459
- </span></code></pre></div> <h2 id=troubleshooting-source-generators>Troubleshooting Source Generators<a class=headerlink href=#troubleshooting-source-generators title="Anchor link to this section">&para;</a></h2> <details class=warning> <summary>Attributes not working / code not generated</summary> <p><strong>Checklist:</strong></p> <ol> <li>✅ Is type marked <code>partial</code>?</li> <li>✅ Did you rebuild the project?</li> <li>✅ Is Unity 2021.3+ (Roslyn source generator support)?</li> <li>✅ Check <code>obj/</code> folder for <code>.g.cs</code> files</li> </ol> <p><strong>Fix:</strong></p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-42-1><a id=__codelineno-42-1 name=__codelineno-42-1 href=#__codelineno-42-1></a><span class=c1>// ❌ Missing partial, will not compile</span>
459
+ </span></code></pre></div> <h2 id=troubleshooting-source-generators>Troubleshooting Source Generators<a class=headerlink href=#troubleshooting-source-generators title="Anchor link to this section">&para;</a></h2> <blockquote> <p>⚠️ <strong>Warning: Attributes not working / code not generated</strong></p> <h3 id=checklist>Checklist<a class=headerlink href=#checklist title="Anchor link to this section">&para;</a></h3> <ol> <li>✅ Is type marked <code>partial</code>?</li> <li>✅ Did you rebuild the project?</li> <li>✅ Is Unity 2021.3+ (Roslyn source generator support)?</li> <li>✅ Check <code>obj/</code> folder for <code>.g.cs</code> files</li> </ol> <h4 id=fix>Fix<a class=headerlink href=#fix title="Anchor link to this section">&para;</a></h4> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-42-1><a id=__codelineno-42-1 name=__codelineno-42-1 href=#__codelineno-42-1></a><span class=c1>// ❌ Missing partial, will not compile</span>
460
460
  </span><span id=__span-42-2><a id=__codelineno-42-2 name=__codelineno-42-2 href=#__codelineno-42-2></a><span class=na>[DxAutoConstructor]</span>
461
461
  </span><span id=__span-42-3><a id=__codelineno-42-3 name=__codelineno-42-3 href=#__codelineno-42-3></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>MyMsg</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
462
462
  </span><span id=__span-42-4><a id=__codelineno-42-4 name=__codelineno-42-4 href=#__codelineno-42-4></a>
463
463
  </span><span id=__span-42-5><a id=__codelineno-42-5 name=__codelineno-42-5 href=#__codelineno-42-5></a><span class=c1>// ✅ Correct</span>
464
464
  </span><span id=__span-42-6><a id=__codelineno-42-6 name=__codelineno-42-6 href=#__codelineno-42-6></a><span class=na>[DxAutoConstructor]</span>
465
465
  </span><span id=__span-42-7><a id=__codelineno-42-7 name=__codelineno-42-7 href=#__codelineno-42-7></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>MyMsg</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
466
- </span></code></pre></div> </details> <details class=warning> <summary>Constructor not generated</summary> <p><strong>Cause:</strong> No public fields to generate from</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-43-1><a id=__codelineno-43-1 name=__codelineno-43-1 href=#__codelineno-43-1></a><span class=c1>// ❌ No public fields</span>
466
+ </span></code></pre></div> <p>⚠️ <strong>Warning: Constructor not generated</strong></p> <p><strong>Cause:</strong> No public fields to generate from</p> <div class="language-csharp highlight"><span class=filename>C#</span><pre><span></span><code><span id=__span-43-1><a id=__codelineno-43-1 name=__codelineno-43-1 href=#__codelineno-43-1></a><span class=c1>// ❌ No public fields</span>
467
467
  </span><span id=__span-43-2><a id=__codelineno-43-2 name=__codelineno-43-2 href=#__codelineno-43-2></a><span class=na>[DxAutoConstructor]</span>
468
468
  </span><span id=__span-43-3><a id=__codelineno-43-3 name=__codelineno-43-3 href=#__codelineno-43-3></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>Empty</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=p>}</span>
469
469
  </span><span id=__span-43-4><a id=__codelineno-43-4 name=__codelineno-43-4 href=#__codelineno-43-4></a>
@@ -472,4 +472,4 @@
472
472
  </span><span id=__span-43-7><a id=__codelineno-43-7 name=__codelineno-43-7 href=#__codelineno-43-7></a><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=k>partial</span><span class=w> </span><span class=k>struct</span><span class=w> </span><span class=nc>WithData</span><span class=w> </span><span class=p>{</span>
473
473
  </span><span id=__span-43-8><a id=__codelineno-43-8 name=__codelineno-43-8 href=#__codelineno-43-8></a><span class=w> </span><span class=k>public</span><span class=w> </span><span class=k>readonly</span><span class=w> </span><span class=kt>int</span><span class=w> </span><span class=k>value</span><span class=p>;</span>
474
474
  </span><span id=__span-43-9><a id=__codelineno-43-9 name=__codelineno-43-9 href=#__codelineno-43-9></a><span class=p>}</span>
475
- </span></code></pre></div> </details> <details class=warning> <summary>Unity can't find generated code</summary> <p><strong>Solution:</strong></p> <ol> <li>Close Unity</li> <li>Delete <code>Library/</code> folder</li> <li>Reopen Unity</li> <li>Let it reimport everything</li> </ol> </details> <h2 id=related-documentation>Related Documentation<a class=headerlink href=#related-documentation title="Anchor link to this section">&para;</a></h2> <ul> <li><strong><a href=../reference/ >API Reference</a></strong> — Complete API documentation</li> <li><strong><a href=../../concepts/message-types/ >Message Types</a></strong> — When to use Untargeted/Targeted/Broadcast</li> <li><strong><a href=../quick-reference/ >Quick Reference</a></strong> — Cheat sheet</li> <li><strong><a href=../../architecture/design-and-architecture/ >Design &amp; Architecture</a></strong> — How source generation works internally</li> </ul> <h2 id=summary>Summary<a class=headerlink href=#summary title="Anchor link to this section">&para;</a></h2> <h3 id=source-generators--code-wizards-that-write-boilerplate-for-you>Source generators = Code wizards that write boilerplate for you<a class=headerlink href=#source-generators--code-wizards-that-write-boilerplate-for-you title="Anchor link to this section">&para;</a></h3> <h4 id=use-attributes-for>Use attributes for<a class=headerlink href=#use-attributes-for title="Anchor link to this section">&para;</a></h4> <ul> <li>✅ Clean, maintainable code</li> <li>✅ Automatic constructor generation</li> <li>✅ Zero boilerplate</li> <li>✅ Refactor safety</li> </ul> <h5 id=use-manual-implementation-for>Use manual implementation for<a class=headerlink href=#use-manual-implementation-for title="Anchor link to this section">&para;</a></h5> <ul> <li>✅ Custom constructor logic</li> <li>✅ Explicit control</li> <li>✅ Understanding exactly what happens</li> </ul> <p><strong>Recommendation:</strong> Start with attributes (they cover most cases), switch to manual only when needed.</p> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 26, 2026 18:15:02 UTC"><span class=timeago datetime=2026-01-26T18:15:02+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 26, 2026 18:15:02 UTC">2026-01-26</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Created> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 26, 2026 18:15:02 UTC"><span class=timeago datetime=2026-01-26T18:15:02+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 26, 2026 18:15:02 UTC">2026-01-26</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=../quick-reference/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Quick Reference"> <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> Quick Reference </div> </div> </a> <a href=../faq/ class="md-footer__link md-footer__link--next" aria-label="Next: FAQ"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> FAQ </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 &copy; 2017-2026 Wallstop Studios </div> </div> <div class=md-social> <a href=https://github.com/wallstop target=_blank rel=noopener title="Wallstop Studios 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": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.instant.prefetch", "navigation.instant.progress", "navigation.path", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "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@11/dist/mermaid.min.js></script> <script src=../../javascripts/mermaid-config.js></script> <script src=../../javascripts/csharp-highlight.js></script> </body> </html>
475
+ </span></code></pre></div> <p>⚠️ <strong>Warning: Unity can't find generated code</strong></p> <h5 id=solution>Solution<a class=headerlink href=#solution title="Anchor link to this section">&para;</a></h5> <ol> <li>Close Unity</li> <li>Delete <code>Library/</code> folder</li> <li>Reopen Unity</li> <li>Let it reimport everything</li> </ol> </blockquote> <h2 id=related-documentation>Related Documentation<a class=headerlink href=#related-documentation title="Anchor link to this section">&para;</a></h2> <ul> <li><strong><a href=../reference/ >API Reference</a></strong> — Complete API documentation</li> <li><strong><a href=../../concepts/message-types/ >Message Types</a></strong> — When to use Untargeted/Targeted/Broadcast</li> <li><strong><a href=../quick-reference/ >Quick Reference</a></strong> — Cheat sheet</li> <li><strong><a href=../../architecture/design-and-architecture/ >Design &amp; Architecture</a></strong> — How source generation works internally</li> </ul> <h2 id=summary>Summary<a class=headerlink href=#summary title="Anchor link to this section">&para;</a></h2> <h3 id=source-generators--code-wizards-that-write-boilerplate-for-you>Source generators = Code wizards that write boilerplate for you<a class=headerlink href=#source-generators--code-wizards-that-write-boilerplate-for-you title="Anchor link to this section">&para;</a></h3> <h4 id=use-attributes-for>Use attributes for<a class=headerlink href=#use-attributes-for title="Anchor link to this section">&para;</a></h4> <ul> <li>✅ Clean, maintainable code</li> <li>✅ Automatic constructor generation</li> <li>✅ Zero boilerplate</li> <li>✅ Refactor safety</li> </ul> <h5 id=use-manual-implementation-for>Use manual implementation for<a class=headerlink href=#use-manual-implementation-for title="Anchor link to this section">&para;</a></h5> <ul> <li>✅ Custom constructor logic</li> <li>✅ Explicit control</li> <li>✅ Understanding exactly what happens</li> </ul> <p><strong>Recommendation:</strong> Start with attributes (they cover most cases), switch to manual only when needed.</p> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="January 29, 2026 05:02:02 UTC"><span class=timeago datetime=2026-01-29T05:02:02+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 29, 2026 05:02:02 UTC">2026-01-29</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="January 27, 2026 04:59:07 UTC"><span class=timeago datetime=2026-01-27T04:59:07+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="January 27, 2026 04:59:07 UTC">2026-01-27</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=../quick-reference/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Quick Reference"> <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> Quick Reference </div> </div> </a> <a href=../faq/ class="md-footer__link md-footer__link--next" aria-label="Next: FAQ"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> FAQ </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 &copy; 2017-2026 Wallstop Studios </div> </div> <div class=md-social> <a href=https://github.com/wallstop target=_blank rel=noopener title="Wallstop Studios 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": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.instant", "navigation.instant.prefetch", "navigation.instant.progress", "navigation.path", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "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@11/dist/mermaid.min.js></script> <script src=../../javascripts/mermaid-config.js></script> <script src=../../javascripts/csharp-highlight.js></script> </body> </html>