injecting-tiles.html 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="lock-key-system.html">
  7. <link rel="next" href="connection-rules.html">
  8. <link rel="icon" href="../assets/images/favicon.ico">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
  10. <title>Injecting Special Tiles - DunGen</title>
  11. <link rel="stylesheet" href="../assets/stylesheets/main.4af4bdda.min.css">
  12. <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
  13. <script src="https://unpkg.com/iframe-worker/shim"></script>
  14. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  15. <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">
  16. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  17. <link rel="stylesheet" href="../stylesheets/extra.css">
  18. <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>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="cyan">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#advanced-features-injecting-special-tiles" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <header class="md-header md-header--shadow" data-md-component="header">
  32. <nav class="md-header__inner md-grid" aria-label="Header">
  33. <a href="../index.html" title="DunGen" class="md-header__button md-logo" aria-label="DunGen" data-md-component="logo">
  34. <svg width="100%" height="100%" viewBox="0 0 258 272" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
  35. <path d="M79,20.998C103.163,20.998 126.827,20.993 150.49,21.002C156.512,21.004 156.994,21.502 157,27.603C157.008,36.435 157.275,45.279 156.89,54.094C156.689,58.68 158.685,61.484 161.849,64.242C170.723,71.978 179.515,79.812 188.188,87.772C190.849,90.214 193.071,93.217 195.28,95.995C199.425,101.209 199.993,100.532 203.73,100.441C209.056,100.311 214.403,100.217 219.713,100.549C222.988,100.754 224.083,99.873 224.059,96.517C223.93,78.354 223.952,60.189 224.044,42.025C224.059,38.949 223.341,37.434 219.868,37.603C214.383,37.872 208.877,37.791 203.381,37.715C199.579,37.663 197.517,38.715 197.907,43.168C198.327,47.964 197.807,52.836 198.065,57.655C198.263,61.366 196.432,62.919 193.348,61.885C188.656,60.311 184.193,58.029 179.724,55.858C179.188,55.598 179.033,54.157 179.028,53.262C178.979,44.43 179.007,35.598 178.995,26.766C178.99,22.857 180.241,20.823 184.822,20.897C200.816,21.158 216.816,20.988 232.814,21.004C239.132,21.01 240.996,22.894 240.998,29.241C241.006,56.07 241.005,82.9 240.998,109.729C240.997,114.795 238.959,117.469 233.922,117.935C228.649,118.423 223.32,118.407 218.015,118.42C208.355,118.444 198.68,117.994 189.04,118.408C184.225,118.615 181.96,116.755 180.231,112.653C175.241,100.811 167.104,91.401 156.54,84.26C153.778,82.394 150.001,81.189 146.67,81.142C126.51,80.86 106.344,81.107 86.182,80.92C81.723,80.878 80.502,82.453 80.517,86.753C80.64,122.394 80.606,158.037 80.499,193.679C80.487,197.764 81.821,199.148 86.047,199.093C103.375,198.866 120.707,198.998 138.038,198.998C159.059,198.998 178.198,184.319 182.849,163.942C184.15,158.243 183.93,152.135 183.91,146.215C183.896,141.846 185.254,139.882 189.885,139.936C204.381,140.105 218.88,139.974 233.378,140.01C238.862,140.024 240.989,142.215 240.993,147.822C241.011,180.317 241.012,212.813 240.992,245.308C240.988,250.939 238.967,252.977 233.218,252.985C205.722,253.022 178.226,253.017 150.73,252.989C145.524,252.983 144.074,251.47 144.001,246.325C143.982,244.992 144.14,243.641 143.973,242.329C143.34,237.341 146.132,235.979 150.411,235.99C160.395,236.016 171.06,236.112 181.183,236.112C181.349,229.59 181.592,223.106 181.957,216.723C182.112,214.015 183.166,213.054 185.926,212.937C199.005,212.385 199.002,212.308 199.002,225.465C199.002,236.846 199.003,236.883 210.211,236.618C214.669,236.512 219.122,236.203 223.998,235.966L223.998,215.809C223.998,197.812 223.911,179.813 224.071,161.817C224.103,158.195 223.211,156.729 219.348,156.922C213.399,157.218 207.424,157 201.518,157C200.995,162.216 201.49,167.296 200.093,171.982C197.761,179.807 196.375,184.335 192.2,189.003C186.463,195.42 180.539,202.401 173.212,206.467C165.218,210.904 155.809,213.982 146.533,214.772C140.003,215.328 133.915,215.112 127.586,214.988C124.239,214.923 122.845,216.06 122.934,219.622C123.145,228.116 123.005,236.618 123.001,245.117C122.998,251.059 121.128,252.977 115.061,252.989C97.897,253.025 80.733,253.002 63.568,253.002C51.404,253.002 39.239,253.028 27.074,252.99C21.11,252.972 19.972,251.911 19.969,246.171C19.952,212.512 20.027,178.852 19.931,145.193C19.92,141.244 21.512,139.936 25.206,139.967C36.037,140.056 46.872,139.868 57.7,140.066C61.659,140.139 62.704,138.654 62.9,134.816C63.079,131.328 63.031,127.859 62.985,124.329C62.92,119.388 61.017,118.259 56.858,118.302C47.864,118.397 38.869,118.381 29.875,118.42C29.044,118.424 28.21,118.569 27.382,118.535C20.483,118.255 19.854,117.626 19.858,110.743C19.874,83.582 19.901,56.422 19.946,29.261C19.957,22.709 21.747,21.005 28.509,21.001C45.173,20.992 61.836,20.998 79,20.998M40.806,37.592C39.579,39.018 37.305,40.427 37.283,41.871C37.009,60.012 37.047,78.158 37.045,96.302C37.045,98.812 38.187,100.243 40.973,100.24C46.626,100.235 52.281,100.327 57.93,100.537C61.815,100.681 63.165,99.043 63.06,95.156C62.832,86.672 62.99,78.177 63.001,69.687C63.01,63.101 65.168,60.989 71.882,60.989C92.36,60.99 112.837,60.999 133.315,60.997C139.718,60.996 139.987,60.711 139.998,54.125C140.004,50.629 139.757,47.111 140.059,43.642C140.457,39.073 138.568,37.373 134.101,37.395C103.319,37.551 72.535,37.595 40.806,37.592M62.997,200.455C62.997,187.472 63.078,174.487 62.886,161.507C62.863,159.996 61.38,157.25 60.476,157.208C52.923,156.859 45.347,157.01 37.87,157.01C37.87,182.364 37.917,206.983 37.817,231.602C37.803,235.205 39.289,236.074 42.623,236.055C62.599,235.939 82.576,236.005 102.552,235.977C103.642,235.975 104.732,235.678 105.997,235.493C105.997,229.703 105.875,224.216 106.048,218.738C106.137,215.898 105.136,214.958 102.315,214.998C93.661,215.12 85.004,215.009 76.348,215.006C62.998,215 62.998,215.006 62.997,200.455Z" style="fill:currentColor;fill-rule:nonzero;"/>
  36. <g transform="matrix(1,0,0,1,91.4761,179.778)">
  37. <text x="0px" y="0px" style="font-family:'Arial-BoldMT', 'Arial', sans-serif;font-weight:700;font-size:110px;fill:currentColor;">D</text>
  38. </g>
  39. </svg>
  40. </a>
  41. <label class="md-header__button md-icon" for="__drawer">
  42. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  43. </label>
  44. <div class="md-header__title" data-md-component="header-title">
  45. <div class="md-header__ellipsis">
  46. <div class="md-header__topic">
  47. <span class="md-ellipsis">
  48. DunGen
  49. </span>
  50. </div>
  51. <div class="md-header__topic" data-md-component="header-topic">
  52. <span class="md-ellipsis">
  53. Injecting Special Tiles
  54. </span>
  55. </div>
  56. </div>
  57. </div>
  58. </nav>
  59. </header>
  60. <div class="md-container" data-md-component="container">
  61. <main class="md-main" data-md-component="main">
  62. <div class="md-main__inner md-grid">
  63. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  64. <div class="md-sidebar__scrollwrap">
  65. <div class="md-sidebar__inner">
  66. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  67. <label class="md-nav__title" for="__drawer">
  68. <a href="../index.html" title="DunGen" class="md-nav__button md-logo" aria-label="DunGen" data-md-component="logo">
  69. <svg width="100%" height="100%" viewBox="0 0 258 272" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
  70. <path d="M79,20.998C103.163,20.998 126.827,20.993 150.49,21.002C156.512,21.004 156.994,21.502 157,27.603C157.008,36.435 157.275,45.279 156.89,54.094C156.689,58.68 158.685,61.484 161.849,64.242C170.723,71.978 179.515,79.812 188.188,87.772C190.849,90.214 193.071,93.217 195.28,95.995C199.425,101.209 199.993,100.532 203.73,100.441C209.056,100.311 214.403,100.217 219.713,100.549C222.988,100.754 224.083,99.873 224.059,96.517C223.93,78.354 223.952,60.189 224.044,42.025C224.059,38.949 223.341,37.434 219.868,37.603C214.383,37.872 208.877,37.791 203.381,37.715C199.579,37.663 197.517,38.715 197.907,43.168C198.327,47.964 197.807,52.836 198.065,57.655C198.263,61.366 196.432,62.919 193.348,61.885C188.656,60.311 184.193,58.029 179.724,55.858C179.188,55.598 179.033,54.157 179.028,53.262C178.979,44.43 179.007,35.598 178.995,26.766C178.99,22.857 180.241,20.823 184.822,20.897C200.816,21.158 216.816,20.988 232.814,21.004C239.132,21.01 240.996,22.894 240.998,29.241C241.006,56.07 241.005,82.9 240.998,109.729C240.997,114.795 238.959,117.469 233.922,117.935C228.649,118.423 223.32,118.407 218.015,118.42C208.355,118.444 198.68,117.994 189.04,118.408C184.225,118.615 181.96,116.755 180.231,112.653C175.241,100.811 167.104,91.401 156.54,84.26C153.778,82.394 150.001,81.189 146.67,81.142C126.51,80.86 106.344,81.107 86.182,80.92C81.723,80.878 80.502,82.453 80.517,86.753C80.64,122.394 80.606,158.037 80.499,193.679C80.487,197.764 81.821,199.148 86.047,199.093C103.375,198.866 120.707,198.998 138.038,198.998C159.059,198.998 178.198,184.319 182.849,163.942C184.15,158.243 183.93,152.135 183.91,146.215C183.896,141.846 185.254,139.882 189.885,139.936C204.381,140.105 218.88,139.974 233.378,140.01C238.862,140.024 240.989,142.215 240.993,147.822C241.011,180.317 241.012,212.813 240.992,245.308C240.988,250.939 238.967,252.977 233.218,252.985C205.722,253.022 178.226,253.017 150.73,252.989C145.524,252.983 144.074,251.47 144.001,246.325C143.982,244.992 144.14,243.641 143.973,242.329C143.34,237.341 146.132,235.979 150.411,235.99C160.395,236.016 171.06,236.112 181.183,236.112C181.349,229.59 181.592,223.106 181.957,216.723C182.112,214.015 183.166,213.054 185.926,212.937C199.005,212.385 199.002,212.308 199.002,225.465C199.002,236.846 199.003,236.883 210.211,236.618C214.669,236.512 219.122,236.203 223.998,235.966L223.998,215.809C223.998,197.812 223.911,179.813 224.071,161.817C224.103,158.195 223.211,156.729 219.348,156.922C213.399,157.218 207.424,157 201.518,157C200.995,162.216 201.49,167.296 200.093,171.982C197.761,179.807 196.375,184.335 192.2,189.003C186.463,195.42 180.539,202.401 173.212,206.467C165.218,210.904 155.809,213.982 146.533,214.772C140.003,215.328 133.915,215.112 127.586,214.988C124.239,214.923 122.845,216.06 122.934,219.622C123.145,228.116 123.005,236.618 123.001,245.117C122.998,251.059 121.128,252.977 115.061,252.989C97.897,253.025 80.733,253.002 63.568,253.002C51.404,253.002 39.239,253.028 27.074,252.99C21.11,252.972 19.972,251.911 19.969,246.171C19.952,212.512 20.027,178.852 19.931,145.193C19.92,141.244 21.512,139.936 25.206,139.967C36.037,140.056 46.872,139.868 57.7,140.066C61.659,140.139 62.704,138.654 62.9,134.816C63.079,131.328 63.031,127.859 62.985,124.329C62.92,119.388 61.017,118.259 56.858,118.302C47.864,118.397 38.869,118.381 29.875,118.42C29.044,118.424 28.21,118.569 27.382,118.535C20.483,118.255 19.854,117.626 19.858,110.743C19.874,83.582 19.901,56.422 19.946,29.261C19.957,22.709 21.747,21.005 28.509,21.001C45.173,20.992 61.836,20.998 79,20.998M40.806,37.592C39.579,39.018 37.305,40.427 37.283,41.871C37.009,60.012 37.047,78.158 37.045,96.302C37.045,98.812 38.187,100.243 40.973,100.24C46.626,100.235 52.281,100.327 57.93,100.537C61.815,100.681 63.165,99.043 63.06,95.156C62.832,86.672 62.99,78.177 63.001,69.687C63.01,63.101 65.168,60.989 71.882,60.989C92.36,60.99 112.837,60.999 133.315,60.997C139.718,60.996 139.987,60.711 139.998,54.125C140.004,50.629 139.757,47.111 140.059,43.642C140.457,39.073 138.568,37.373 134.101,37.395C103.319,37.551 72.535,37.595 40.806,37.592M62.997,200.455C62.997,187.472 63.078,174.487 62.886,161.507C62.863,159.996 61.38,157.25 60.476,157.208C52.923,156.859 45.347,157.01 37.87,157.01C37.87,182.364 37.917,206.983 37.817,231.602C37.803,235.205 39.289,236.074 42.623,236.055C62.599,235.939 82.576,236.005 102.552,235.977C103.642,235.975 104.732,235.678 105.997,235.493C105.997,229.703 105.875,224.216 106.048,218.738C106.137,215.898 105.136,214.958 102.315,214.998C93.661,215.12 85.004,215.009 76.348,215.006C62.998,215 62.998,215.006 62.997,200.455Z" style="fill:currentColor;fill-rule:nonzero;"/>
  71. <g transform="matrix(1,0,0,1,91.4761,179.778)">
  72. <text x="0px" y="0px" style="font-family:'Arial-BoldMT', 'Arial', sans-serif;font-weight:700;font-size:110px;fill:currentColor;">D</text>
  73. </g>
  74. </svg>
  75. </a>
  76. DunGen
  77. </label>
  78. <ul class="md-nav__list" data-md-scrollfix>
  79. <li class="md-nav__item">
  80. <a href="../index.html" class="md-nav__link">
  81. <span class="md-ellipsis">
  82. Introduction
  83. </span>
  84. </a>
  85. </li>
  86. <li class="md-nav__item">
  87. <a href="../changelog.html" class="md-nav__link">
  88. <span class="md-ellipsis">
  89. Changelog
  90. </span>
  91. </a>
  92. </li>
  93. <li class="md-nav__item md-nav__item--nested">
  94. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
  95. <div class="md-nav__link md-nav__container">
  96. <a href="../getting-started/index.html" class="md-nav__link ">
  97. <span class="md-ellipsis">
  98. Getting Started
  99. </span>
  100. </a>
  101. <label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
  102. <span class="md-nav__icon md-icon"></span>
  103. </label>
  104. </div>
  105. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  106. <label class="md-nav__title" for="__nav_3">
  107. <span class="md-nav__icon md-icon"></span>
  108. Getting Started
  109. </label>
  110. <ul class="md-nav__list" data-md-scrollfix>
  111. <li class="md-nav__item">
  112. <a href="../getting-started/1-creating-tiles.html" class="md-nav__link">
  113. <span class="md-ellipsis">
  114. 1. Creating Tiles
  115. </span>
  116. </a>
  117. </li>
  118. <li class="md-nav__item">
  119. <a href="../getting-started/2-doorways.html" class="md-nav__link">
  120. <span class="md-ellipsis">
  121. 2. Doorways
  122. </span>
  123. </a>
  124. </li>
  125. <li class="md-nav__item">
  126. <a href="../getting-started/3-dungeon-flow.html" class="md-nav__link">
  127. <span class="md-ellipsis">
  128. 3. Dungeon Flow Basics
  129. </span>
  130. </a>
  131. </li>
  132. <li class="md-nav__item">
  133. <a href="../getting-started/4-scene-setup.html" class="md-nav__link">
  134. <span class="md-ellipsis">
  135. 4. Scene Setup & First Generation
  136. </span>
  137. </a>
  138. </li>
  139. </ul>
  140. </nav>
  141. </li>
  142. <li class="md-nav__item md-nav__item--nested">
  143. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
  144. <div class="md-nav__link md-nav__container">
  145. <a href="../core-concepts/index.html" class="md-nav__link ">
  146. <span class="md-ellipsis">
  147. Core Concepts
  148. </span>
  149. </a>
  150. <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
  151. <span class="md-nav__icon md-icon"></span>
  152. </label>
  153. </div>
  154. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  155. <label class="md-nav__title" for="__nav_4">
  156. <span class="md-nav__icon md-icon"></span>
  157. Core Concepts
  158. </label>
  159. <ul class="md-nav__list" data-md-scrollfix>
  160. <li class="md-nav__item">
  161. <a href="../core-concepts/tiles.html" class="md-nav__link">
  162. <span class="md-ellipsis">
  163. Tiles & Tile Component
  164. </span>
  165. </a>
  166. </li>
  167. <li class="md-nav__item">
  168. <a href="../core-concepts/weighting.html" class="md-nav__link">
  169. <span class="md-ellipsis">
  170. Weighting
  171. </span>
  172. </a>
  173. </li>
  174. <li class="md-nav__item">
  175. <a href="../core-concepts/tile-sets.html" class="md-nav__link">
  176. <span class="md-ellipsis">
  177. Tile Sets
  178. </span>
  179. </a>
  180. </li>
  181. <li class="md-nav__item">
  182. <a href="../core-concepts/archetypes.html" class="md-nav__link">
  183. <span class="md-ellipsis">
  184. Archetypes
  185. </span>
  186. </a>
  187. </li>
  188. <li class="md-nav__item">
  189. <a href="../core-concepts/doorways.html" class="md-nav__link">
  190. <span class="md-ellipsis">
  191. Doorways
  192. </span>
  193. </a>
  194. </li>
  195. <li class="md-nav__item">
  196. <a href="../core-concepts/dungeon-flow.html" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Dungeon Flow Asset
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../core-concepts/flow-editor.html" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Flow Editor
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../core-concepts/dungeon-generator.html" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. Dungeon Generator
  213. </span>
  214. </a>
  215. </li>
  216. </ul>
  217. </nav>
  218. </li>
  219. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  220. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
  221. <div class="md-nav__link md-nav__container">
  222. <a href="index.html" class="md-nav__link ">
  223. <span class="md-ellipsis">
  224. Advanced Features
  225. </span>
  226. </a>
  227. <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
  228. <span class="md-nav__icon md-icon"></span>
  229. </label>
  230. </div>
  231. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
  232. <label class="md-nav__title" for="__nav_5">
  233. <span class="md-nav__icon md-icon"></span>
  234. Advanced Features
  235. </label>
  236. <ul class="md-nav__list" data-md-scrollfix>
  237. <li class="md-nav__item">
  238. <a href="props-variety.html" class="md-nav__link">
  239. <span class="md-ellipsis">
  240. Props for Variety
  241. </span>
  242. </a>
  243. </li>
  244. <li class="md-nav__item">
  245. <a href="doors.html" class="md-nav__link">
  246. <span class="md-ellipsis">
  247. Doors
  248. </span>
  249. </a>
  250. </li>
  251. <li class="md-nav__item">
  252. <a href="multiple-floors.html" class="md-nav__link">
  253. <span class="md-ellipsis">
  254. Multiple Floors
  255. </span>
  256. </a>
  257. </li>
  258. <li class="md-nav__item">
  259. <a href="lock-key-system.html" class="md-nav__link">
  260. <span class="md-ellipsis">
  261. Lock & Key System
  262. </span>
  263. </a>
  264. </li>
  265. <li class="md-nav__item md-nav__item--active">
  266. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  267. <label class="md-nav__link md-nav__link--active" for="__toc">
  268. <span class="md-ellipsis">
  269. Injecting Special Tiles
  270. </span>
  271. <span class="md-nav__icon md-icon"></span>
  272. </label>
  273. <a href="injecting-tiles.html" class="md-nav__link md-nav__link--active">
  274. <span class="md-ellipsis">
  275. Injecting Special Tiles
  276. </span>
  277. </a>
  278. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  279. <label class="md-nav__title" for="__toc">
  280. <span class="md-nav__icon md-icon"></span>
  281. Table of contents
  282. </label>
  283. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  284. <li class="md-nav__item">
  285. <a href="#method-1-tile-injection-via-inspector" class="md-nav__link">
  286. <span class="md-ellipsis">
  287. Method 1: Tile Injection via Inspector
  288. </span>
  289. </a>
  290. </li>
  291. <li class="md-nav__item">
  292. <a href="#method-2-tile-injection-through-code" class="md-nav__link">
  293. <span class="md-ellipsis">
  294. Method 2: Tile Injection Through Code
  295. </span>
  296. </a>
  297. <nav class="md-nav" aria-label="Method 2: Tile Injection Through Code">
  298. <ul class="md-nav__list">
  299. <li class="md-nav__item">
  300. <a href="#the-injectedtile-class" class="md-nav__link">
  301. <span class="md-ellipsis">
  302. The InjectedTile Class:
  303. </span>
  304. </a>
  305. </li>
  306. <li class="md-nav__item">
  307. <a href="#attaching-the-delegate" class="md-nav__link">
  308. <span class="md-ellipsis">
  309. Attaching the Delegate:
  310. </span>
  311. </a>
  312. </li>
  313. </ul>
  314. </nav>
  315. </li>
  316. <li class="md-nav__item">
  317. <a href="#when-to-use-which-method" class="md-nav__link">
  318. <span class="md-ellipsis">
  319. When to Use Which Method
  320. </span>
  321. </a>
  322. </li>
  323. </ul>
  324. </nav>
  325. </li>
  326. <li class="md-nav__item">
  327. <a href="connection-rules.html" class="md-nav__link">
  328. <span class="md-ellipsis">
  329. Tile Connection Rules
  330. </span>
  331. </a>
  332. </li>
  333. <li class="md-nav__item">
  334. <a href="attached-dungeons.html" class="md-nav__link">
  335. <span class="md-ellipsis">
  336. Generating Attached Dungeons
  337. </span>
  338. </a>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="additional-collisions.html" class="md-nav__link">
  342. <span class="md-ellipsis">
  343. Avoid Collisions With the Scene
  344. </span>
  345. </a>
  346. </li>
  347. <li class="md-nav__item">
  348. <a href="runtime-events.html" class="md-nav__link">
  349. <span class="md-ellipsis">
  350. Runtime Events & Code Execution
  351. </span>
  352. </a>
  353. </li>
  354. <li class="md-nav__item">
  355. <a href="post-processing.html" class="md-nav__link">
  356. <span class="md-ellipsis">
  357. Custom Post-Processing
  358. </span>
  359. </a>
  360. </li>
  361. <li class="md-nav__item">
  362. <a href="character-component.html" class="md-nav__link">
  363. <span class="md-ellipsis">
  364. DunGen Character Component
  365. </span>
  366. </a>
  367. </li>
  368. </ul>
  369. </nav>
  370. </li>
  371. <li class="md-nav__item md-nav__item--nested">
  372. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
  373. <div class="md-nav__link md-nav__container">
  374. <a href="../optimization/index.html" class="md-nav__link ">
  375. <span class="md-ellipsis">
  376. Optimization
  377. </span>
  378. </a>
  379. <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
  380. <span class="md-nav__icon md-icon"></span>
  381. </label>
  382. </div>
  383. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  384. <label class="md-nav__title" for="__nav_6">
  385. <span class="md-nav__icon md-icon"></span>
  386. Optimization
  387. </label>
  388. <ul class="md-nav__list" data-md-scrollfix>
  389. <li class="md-nav__item">
  390. <a href="../optimization/culling.html" class="md-nav__link">
  391. <span class="md-ellipsis">
  392. Built-in Culling
  393. </span>
  394. </a>
  395. </li>
  396. <li class="md-nav__item">
  397. <a href="../optimization/tile-pooling.html" class="md-nav__link">
  398. <span class="md-ellipsis">
  399. Tile Pooling
  400. </span>
  401. </a>
  402. </li>
  403. </ul>
  404. </nav>
  405. </li>
  406. <li class="md-nav__item md-nav__item--nested">
  407. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
  408. <div class="md-nav__link md-nav__container">
  409. <a href="../pathfinding/index.html" class="md-nav__link ">
  410. <span class="md-ellipsis">
  411. Pathfinding
  412. </span>
  413. </a>
  414. <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
  415. <span class="md-nav__icon md-icon"></span>
  416. </label>
  417. </div>
  418. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  419. <label class="md-nav__title" for="__nav_7">
  420. <span class="md-nav__icon md-icon"></span>
  421. Pathfinding
  422. </label>
  423. <ul class="md-nav__list" data-md-scrollfix>
  424. <li class="md-nav__item">
  425. <a href="../pathfinding/unity-navmesh.html" class="md-nav__link">
  426. <span class="md-ellipsis">
  427. Unity NavMesh Components
  428. </span>
  429. </a>
  430. </li>
  431. <li class="md-nav__item">
  432. <a href="../pathfinding/astar-pathfinding.html" class="md-nav__link">
  433. <span class="md-ellipsis">
  434. A* Pathfinding Project Pro
  435. </span>
  436. </a>
  437. </li>
  438. <li class="md-nav__item">
  439. <a href="../pathfinding/custom-adapters.html" class="md-nav__link">
  440. <span class="md-ellipsis">
  441. Custom Adapters
  442. </span>
  443. </a>
  444. </li>
  445. </ul>
  446. </nav>
  447. </li>
  448. <li class="md-nav__item md-nav__item--nested">
  449. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
  450. <div class="md-nav__link md-nav__container">
  451. <a href="../integrations/index.html" class="md-nav__link ">
  452. <span class="md-ellipsis">
  453. Integrations
  454. </span>
  455. </a>
  456. <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0">
  457. <span class="md-nav__icon md-icon"></span>
  458. </label>
  459. </div>
  460. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  461. <label class="md-nav__title" for="__nav_8">
  462. <span class="md-nav__icon md-icon"></span>
  463. Integrations
  464. </label>
  465. <ul class="md-nav__list" data-md-scrollfix>
  466. <li class="md-nav__item">
  467. <a href="../integrations/sectr.html" class="md-nav__link">
  468. <span class="md-ellipsis">
  469. SECTR Portal Culling
  470. </span>
  471. </a>
  472. </li>
  473. <li class="md-nav__item">
  474. <a href="../integrations/playmaker.html" class="md-nav__link">
  475. <span class="md-ellipsis">
  476. PlayMaker Actions
  477. </span>
  478. </a>
  479. </li>
  480. </ul>
  481. </nav>
  482. </li>
  483. <li class="md-nav__item md-nav__item--nested">
  484. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
  485. <div class="md-nav__link md-nav__container">
  486. <a href="../troubleshooting/index.html" class="md-nav__link ">
  487. <span class="md-ellipsis">
  488. Troubleshooting
  489. </span>
  490. </a>
  491. <label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="0">
  492. <span class="md-nav__icon md-icon"></span>
  493. </label>
  494. </div>
  495. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
  496. <label class="md-nav__title" for="__nav_9">
  497. <span class="md-nav__icon md-icon"></span>
  498. Troubleshooting
  499. </label>
  500. <ul class="md-nav__list" data-md-scrollfix>
  501. <li class="md-nav__item">
  502. <a href="../troubleshooting/limitations.html" class="md-nav__link">
  503. <span class="md-ellipsis">
  504. Limitations & Considerations
  505. </span>
  506. </a>
  507. </li>
  508. <li class="md-nav__item">
  509. <a href="../troubleshooting/analysis.html" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. Analysis
  512. </span>
  513. </a>
  514. </li>
  515. </ul>
  516. </nav>
  517. </li>
  518. <li class="md-nav__item md-nav__item--nested">
  519. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
  520. <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
  521. <span class="md-ellipsis">
  522. Reference
  523. </span>
  524. <span class="md-nav__icon md-icon"></span>
  525. </label>
  526. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
  527. <label class="md-nav__title" for="__nav_10">
  528. <span class="md-nav__icon md-icon"></span>
  529. Reference
  530. </label>
  531. <ul class="md-nav__list" data-md-scrollfix>
  532. <li class="md-nav__item">
  533. <a href="../reference/faq.html" class="md-nav__link">
  534. <span class="md-ellipsis">
  535. FAQ
  536. </span>
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../reference/cookbook.html" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Cookbook
  543. </span>
  544. </a>
  545. </li>
  546. </ul>
  547. </nav>
  548. </li>
  549. </ul>
  550. </nav>
  551. </div>
  552. </div>
  553. </div>
  554. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  555. <div class="md-sidebar__scrollwrap">
  556. <div class="md-sidebar__inner">
  557. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  558. <label class="md-nav__title" for="__toc">
  559. <span class="md-nav__icon md-icon"></span>
  560. Table of contents
  561. </label>
  562. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  563. <li class="md-nav__item">
  564. <a href="#method-1-tile-injection-via-inspector" class="md-nav__link">
  565. <span class="md-ellipsis">
  566. Method 1: Tile Injection via Inspector
  567. </span>
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="#method-2-tile-injection-through-code" class="md-nav__link">
  572. <span class="md-ellipsis">
  573. Method 2: Tile Injection Through Code
  574. </span>
  575. </a>
  576. <nav class="md-nav" aria-label="Method 2: Tile Injection Through Code">
  577. <ul class="md-nav__list">
  578. <li class="md-nav__item">
  579. <a href="#the-injectedtile-class" class="md-nav__link">
  580. <span class="md-ellipsis">
  581. The InjectedTile Class:
  582. </span>
  583. </a>
  584. </li>
  585. <li class="md-nav__item">
  586. <a href="#attaching-the-delegate" class="md-nav__link">
  587. <span class="md-ellipsis">
  588. Attaching the Delegate:
  589. </span>
  590. </a>
  591. </li>
  592. </ul>
  593. </nav>
  594. </li>
  595. <li class="md-nav__item">
  596. <a href="#when-to-use-which-method" class="md-nav__link">
  597. <span class="md-ellipsis">
  598. When to Use Which Method
  599. </span>
  600. </a>
  601. </li>
  602. </ul>
  603. </nav>
  604. </div>
  605. </div>
  606. </div>
  607. <div class="md-content" data-md-component="content">
  608. <article class="md-content__inner md-typeset">
  609. <h1 id="advanced-features-injecting-special-tiles">Advanced Features: Injecting Special Tiles</h1>
  610. <p>Sometimes, the standard random selection of tiles based on <a href="../core-concepts/tile-sets.html">Tile Sets</a> and <a href="../core-concepts/archetypes.html">Archetypes</a> isn't enough. You might need to guarantee that a specific type of tile (like a boss room, a unique quest location, or a special challenge room) appears in the dungeon, perhaps only once, or within a specific area.</p>
  611. <p>This is where <strong>Tile Injection</strong> comes in. It allows you to "inject" tiles from a specified Tile Set into the dungeon generation process, overriding the normal selection based on a set of rules you define.</p>
  612. <p>There are two main ways to implement Tile Injection:</p>
  613. <ol>
  614. <li><strong>Using the Inspector (Simple Rules):</strong> Configure injection rules directly on your <a href="../core-concepts/dungeon-flow.html">Dungeon Flow</a> asset for common scenarios.</li>
  615. <li><strong>Using Code (Complex Rules):</strong> Write custom logic to add injection rules dynamically for maximum flexibility.</li>
  616. </ol>
  617. <hr />
  618. <h2 id="method-1-tile-injection-via-inspector">Method 1: Tile Injection via Inspector</h2>
  619. <p>For straightforward injection rules based on location within the dungeon, you can configure them directly in the <strong>Special Tile Injection</strong> section of your <code>Dungeon Flow</code> asset inspector.</p>
  620. <ol>
  621. <li>Select your <code>Dungeon Flow</code> asset in the Project view.</li>
  622. <li>Find the <strong>Special Tile Injection</strong> foldout in the Inspector.</li>
  623. <li>Click <strong>"Add New Rule"</strong> to create an injection entry.</li>
  624. </ol>
  625. <p>Each rule defines conditions under which a tile from a specified Tile Set should be injected:</p>
  626. <ul>
  627. <li><strong>Tile Set (e.g., "Special Tiles"):</strong> Drag the Tile Set asset containing the tile(s) you want to inject here. When this rule triggers, DunGen will randomly select <strong>one</strong> tile from this Tile Set to place.</li>
  628. <li><strong>Is Required?</strong><ul>
  629. <li><strong>Checked:</strong> This tile <em>must</em> be successfully placed according to the rules. If DunGen fails to generate a valid dungeon layout that includes this required injection (e.g., due to restrictive placement rules or collisions), it will <strong>retry the entire dungeon generation</strong> until it succeeds.</li>
  630. <li><strong>Unchecked:</strong> DunGen will <em>attempt</em> to place this tile according to the rules, but if it fails (e.g., no suitable location found within the depth range), generation will continue without it.</li>
  631. </ul>
  632. <div class="admonition warning">
  633. <p class="admonition-title">Performance Impact</p>
  634. <p>Using <code>Is Required?</code> can increase generation time, especially if the placement rules (<code>Path Depth</code>, <code>Branch Depth</code>) are very narrow or if collisions are likely. Use it only when placement is absolutely essential.</p>
  635. </div>
  636. </li>
  637. <li><strong>Can appear on Main Path?</strong> If checked, this rule allows the tile to be injected somewhere along the main path (Start to Goal).</li>
  638. <li><strong>Can appear on Branch Path?</strong> If checked, this rule allows the tile to be injected somewhere along an optional branch path.</li>
  639. <li><strong>Locked:</strong> If checked, the entrance to this tile will be locked.</li>
  640. <li><strong>Lock Type:</strong> Which lock from the <code>KeyManager</code> to use.</li>
  641. <li><strong>Path Depth:</strong> Defines the normalized range along the <strong>main path</strong> where this injection is allowed.<ul>
  642. <li><code>0</code> represents the Start tile location.</li>
  643. <li><code>1</code> represents the Goal tile location.</li>
  644. <li>A range of <code>0.4</code> to <code>0.6</code> means the tile can only be injected near the middle of the main path.</li>
  645. </ul>
  646. </li>
  647. <li><strong>Branch Depth:</strong> (Only used if <code>Can appear on Branch Path</code> is checked) Defines the normalized range along a <strong>branch path</strong> where this injection is allowed.<ul>
  648. <li><code>0</code> represents the first tile of the branch (connected to the main path).</li>
  649. <li><code>1</code> represents the final tile (dead end) of the branch.</li>
  650. <li>A range of <code>0.9</code> to <code>1.0</code> means the tile can only be injected near the end of a branch.</li>
  651. </ul>
  652. </li>
  653. </ul>
  654. <p>You can add multiple rules to inject different types of special tiles under various conditions.</p>
  655. <hr />
  656. <h2 id="method-2-tile-injection-through-code">Method 2: Tile Injection Through Code</h2>
  657. <p>For more advanced scenarios where injection rules depend on dynamic game state, complex logic, or need more fine-grained control, you can inject tiles via code.</p>
  658. <p>This involves creating a method that matches the <code>TileInjectionDelegate</code> signature and adding it to the <code>TileInjectionMethods</code> list on the <code>DungeonGenerator</code> instance.</p>
  659. <p><strong>The Delegate Signature:</strong></p>
  660. <div class="language-C# highlight"><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="c1">// Your method needs to match this pattern</span>
  661. </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="k">void</span><span class="w"> </span><span class="nf">MyInjectionLogic</span><span class="p">(</span><span class="n">DunGen</span><span class="p">.</span><span class="n">RandomStream</span><span class="w"> </span><span class="n">randomStream</span><span class="p">,</span><span class="w"> </span><span class="k">ref</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="n">InjectedTile</span><span class="o">&gt;</span><span class="w"> </span><span class="n">tilesToInject</span><span class="p">);</span>
  662. </span></code></pre></div>
  663. <ul>
  664. <li><code>randomStream</code>: The <code>DunGen.RandomStream</code> instance used for the current dungeon generation. Use this if your injection logic needs randomness consistent with the dungeon seed.</li>
  665. <li><code>tilesToInject</code>: A list of <code>InjectedTile</code> objects. Your method must add new <code>InjectedTile</code> instances to this list. DunGen will then process this list during generation.</li>
  666. </ul>
  667. <hr />
  668. <h3 id="the-injectedtile-class">The InjectedTile Class:</h3>
  669. <p>You create instances of <code>InjectedTile</code> to represent the tiles you want to inject. The <code>InjectedTile</code> class has the following properties:</p>
  670. <ul>
  671. <li><strong>TileSet (<code>TileSet</code>):</strong> The TileSet to inject.</li>
  672. <li><strong>NormalizedPathDepth (<code>float</code>):</strong> Normalized (0-1) depth along the main path that this tile should be spawned (0 = Start, 1 = Goal).</li>
  673. <li><strong>NormalizedBranchDepth (<code>float</code>):</strong> (Only valid if spawned on a branch) Normalized (0-1) depth along the branch that this tile should be spawned (0 = Branch Entrance, 1 = Branch Cap)</li>
  674. <li><strong>IsOnMainPath (<code>bool</code>):</strong> Should this tile be spawned on the main path? If false, it will be spawned on a branch.</li>
  675. <li><strong>IsRequired (<code>bool</code>):</strong> If true, DunGen will regenerate the dungeon if it fails to spawn this injected tile.</li>
  676. <li><strong>IsLocked (<code>bool</code>):</strong> Should the entrance to this tile be locked using the <a href="lock-key-system.html">Lock &amp; Key System</a>?</li>
  677. <li><strong>LockID (<code>int</code>):</strong> (Only used if <code>IsLocked</code> is true) The ID of the lock to use. This is the index of the lock found in the <code>KeyManager</code>.</li>
  678. </ul>
  679. <details class="example">
  680. <summary>Example Implementation</summary>
  681. <p>In this example, we will inject a random tile from the <code>TileSet</code> assigned to <code>MySpecialTileSet</code> onto the end of the first branch encountered after the halfway point of the main path.</p>
  682. <div class="language-C# highlight"><span class="filename">CustomTileInjector.cs</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="k">using</span><span class="w"> </span><span class="nn">UnityEngine</span><span class="p">;</span>
  683. </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="k">using</span><span class="w"> </span><span class="nn">DunGen</span><span class="p">;</span>
  684. </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="k">using</span><span class="w"> </span><span class="nn">System.Collections.Generic</span><span class="p">;</span>
  685. </span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>
  686. </span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="k">public</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">CustomTileInjector</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">MonoBehaviour</span>
  687. </span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="p">{</span>
  688. </span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="c1">// Assign your Runtime Dungeon Generator here</span>
  689. </span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="n">RuntimeDungeon</span><span class="w"> </span><span class="n">RuntimeDungeon</span><span class="p">;</span>
  690. </span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>
  691. </span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="c1">// Assign the TileSet containing your special tile(s)</span>
  692. </span><span id="__span-1-11"><a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="n">TileSet</span><span class="w"> </span><span class="n">MySpecialTileSet</span><span class="p">;</span>
  693. </span><span id="__span-1-12"><a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>
  694. </span><span id="__span-1-13"><a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>
  695. </span><span id="__span-1-14"><a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w"> </span><span class="k">private</span><span class="w"> </span><span class="k">void</span><span class="w"> </span><span class="nf">Start</span><span class="p">()</span>
  696. </span><span id="__span-1-15"><a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w"> </span><span class="p">{</span>
  697. </span><span id="__span-1-16"><a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">RuntimeDungeon</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="k">null</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">RuntimeDungeon</span><span class="p">.</span><span class="n">Generator</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="k">null</span><span class="p">)</span>
  698. </span><span id="__span-1-17"><a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="w"> </span><span class="n">RuntimeDungeon</span><span class="p">.</span><span class="n">Generator</span><span class="p">.</span><span class="n">TileInjectionMethods</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">InjectMySpecialTile</span><span class="p">;</span>
  699. </span><span id="__span-1-18"><a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a><span class="w"> </span><span class="k">else</span>
  700. </span><span id="__span-1-19"><a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a><span class="w"> </span><span class="n">Debug</span><span class="p">.</span><span class="n">LogError</span><span class="p">(</span><span class="s">&quot;RuntimeDungeon or its Generator is not assigned&quot;</span><span class="p">);</span>
  701. </span><span id="__span-1-20"><a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a><span class="w"> </span><span class="p">}</span>
  702. </span><span id="__span-1-21"><a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a>
  703. </span><span id="__span-1-22"><a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a><span class="w"> </span><span class="c1">// This method matches the TileInjectionDelegate</span>
  704. </span><span id="__span-1-23"><a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a><span class="w"> </span><span class="k">private</span><span class="w"> </span><span class="k">void</span><span class="w"> </span><span class="nf">InjectMySpecialTile</span><span class="p">(</span><span class="n">RandomStream</span><span class="w"> </span><span class="n">randomStream</span><span class="p">,</span><span class="w"> </span><span class="k">ref</span><span class="w"> </span><span class="n">List</span><span class="o">&lt;</span><span class="n">InjectedTile</span><span class="o">&gt;</span><span class="w"> </span><span class="n">tilesToInject</span><span class="p">)</span>
  705. </span><span id="__span-1-24"><a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a><span class="w"> </span><span class="p">{</span>
  706. </span><span id="__span-1-25"><a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a><span class="w"> </span><span class="c1">// Define the injection parameters</span>
  707. </span><span id="__span-1-26"><a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">tryOnMainPath</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">false</span><span class="p">;</span><span class="w"> </span><span class="c1">// Let&#39;s target a branch path in this example</span>
  708. </span><span id="__span-1-27"><a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a><span class="w"> </span><span class="kt">float</span><span class="w"> </span><span class="n">targetPathDepth</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">0.5f</span><span class="p">;</span><span class="w"> </span><span class="c1">// We want this to spawn at the halfway point of the main path</span>
  709. </span><span id="__span-1-28"><a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a><span class="w"> </span><span class="kt">float</span><span class="w"> </span><span class="n">targetBranchDepth</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">1.0f</span><span class="p">;</span><span class="w"> </span><span class="c1">// Target the very end of the branch</span>
  710. </span><span id="__span-1-29"><a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a><span class="w"> </span><span class="kt">bool</span><span class="w"> </span><span class="n">mustBePlaced</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">false</span><span class="p">;</span><span class="w"> </span><span class="c1">// It&#39;s okay if this tile isn&#39;t placed</span>
  711. </span><span id="__span-1-30"><a id="__codelineno-1-30" name="__codelineno-1-30" href="#__codelineno-1-30"></a>
  712. </span><span id="__span-1-31"><a id="__codelineno-1-31" name="__codelineno-1-31" href="#__codelineno-1-31"></a><span class="w"> </span><span class="kt">var</span><span class="w"> </span><span class="n">tileToInject</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">InjectedTile</span><span class="p">(</span><span class="n">MySpecialTileSet</span><span class="p">,</span><span class="w"> </span><span class="n">tryOnMainPath</span><span class="p">,</span><span class="w"> </span><span class="n">targetPathDepth</span><span class="p">,</span><span class="w"> </span><span class="n">targetBranchDepth</span><span class="p">,</span><span class="w"> </span><span class="n">mustBePlaced</span><span class="p">);</span>
  713. </span><span id="__span-1-32"><a id="__codelineno-1-32" name="__codelineno-1-32" href="#__codelineno-1-32"></a>
  714. </span><span id="__span-1-33"><a id="__codelineno-1-33" name="__codelineno-1-33" href="#__codelineno-1-33"></a><span class="w"> </span><span class="c1">// Add it to the list DunGen will process</span>
  715. </span><span id="__span-1-34"><a id="__codelineno-1-34" name="__codelineno-1-34" href="#__codelineno-1-34"></a><span class="w"> </span><span class="n">tilesToInject</span><span class="p">.</span><span class="n">Add</span><span class="p">(</span><span class="n">tileToInject</span><span class="p">);</span>
  716. </span><span id="__span-1-35"><a id="__codelineno-1-35" name="__codelineno-1-35" href="#__codelineno-1-35"></a><span class="w"> </span><span class="p">}</span>
  717. </span><span id="__span-1-36"><a id="__codelineno-1-36" name="__codelineno-1-36" href="#__codelineno-1-36"></a>
  718. </span><span id="__span-1-37"><a id="__codelineno-1-37" name="__codelineno-1-37" href="#__codelineno-1-37"></a><span class="w"> </span><span class="c1">// Unsubscribe when the object is destroyed</span>
  719. </span><span id="__span-1-38"><a id="__codelineno-1-38" name="__codelineno-1-38" href="#__codelineno-1-38"></a><span class="w"> </span><span class="k">private</span><span class="w"> </span><span class="k">void</span><span class="w"> </span><span class="nf">OnDestroy</span><span class="p">()</span>
  720. </span><span id="__span-1-39"><a id="__codelineno-1-39" name="__codelineno-1-39" href="#__codelineno-1-39"></a><span class="w"> </span><span class="p">{</span>
  721. </span><span id="__span-1-40"><a id="__codelineno-1-40" name="__codelineno-1-40" href="#__codelineno-1-40"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">RuntimeDungeon</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="k">null</span><span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span><span class="n">RuntimeDungeon</span><span class="p">.</span><span class="n">Generator</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="k">null</span><span class="p">)</span>
  722. </span><span id="__span-1-41"><a id="__codelineno-1-41" name="__codelineno-1-41" href="#__codelineno-1-41"></a><span class="w"> </span><span class="n">RuntimeDungeon</span><span class="p">.</span><span class="n">Generator</span><span class="p">.</span><span class="n">TileInjectionMethods</span><span class="w"> </span><span class="o">-=</span><span class="w"> </span><span class="n">InjectMySpecialTile</span><span class="p">;</span>
  723. </span><span id="__span-1-42"><a id="__codelineno-1-42" name="__codelineno-1-42" href="#__codelineno-1-42"></a><span class="w"> </span><span class="p">}</span>
  724. </span><span id="__span-1-43"><a id="__codelineno-1-43" name="__codelineno-1-43" href="#__codelineno-1-43"></a><span class="p">}</span>
  725. </span></code></pre></div>
  726. </details>
  727. <h3 id="attaching-the-delegate">Attaching the Delegate:</h3>
  728. <p>You typically add your custom injection method to the <code>TileInjectionMethods</code> list before generation begins, often in a <code>Start()</code> or <code>Awake()</code> method after getting a reference to the <code>DungeonGenerator</code>. Remember to unsubscribe (-=) in <code>OnDestroy()</code> or <code>OnDisable()</code> to prevent issues if the generator object persists longer than your injector script.</p>
  729. <hr />
  730. <h2 id="when-to-use-which-method">When to Use Which Method</h2>
  731. <ul>
  732. <li>
  733. <p><strong>Inspector:</strong> Best for simple, static rules based purely on placement depth (main/branch path ranges) and whether the tile is required. Easy to set up and manage without code.</p>
  734. </li>
  735. <li>
  736. <p><strong>Code:</strong> Necessary when injection logic is complex, depends on external factors (game state, player progress), requires dynamic calculation of placement, or needs to inject multiple different tiles based on intricate conditions. Offers ultimate flexibility but requires scripting knowledge.</p>
  737. </li>
  738. </ul>
  739. <p>Tile Injection is a powerful tool for adding specific, authored moments or structures within your otherwise randomized dungeons.</p>
  740. </article>
  741. </div>
  742. <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>
  743. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  744. </div>
  745. <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  746. <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>
  747. Back to top
  748. </button>
  749. </main>
  750. <footer class="md-footer">
  751. <nav class="md-footer__inner md-grid" aria-label="Footer" >
  752. <a href="lock-key-system.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Lock &amp; Key System">
  753. <div class="md-footer__button md-icon">
  754. <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>
  755. </div>
  756. <div class="md-footer__title">
  757. <span class="md-footer__direction">
  758. Previous
  759. </span>
  760. <div class="md-ellipsis">
  761. Lock & Key System
  762. </div>
  763. </div>
  764. </a>
  765. <a href="connection-rules.html" class="md-footer__link md-footer__link--next" aria-label="Next: Tile Connection Rules">
  766. <div class="md-footer__title">
  767. <span class="md-footer__direction">
  768. Next
  769. </span>
  770. <div class="md-ellipsis">
  771. Tile Connection Rules
  772. </div>
  773. </div>
  774. <div class="md-footer__button md-icon">
  775. <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>
  776. </div>
  777. </a>
  778. </nav>
  779. <div class="md-footer-meta md-typeset">
  780. <div class="md-footer-meta__inner md-grid">
  781. <div class="md-copyright">
  782. <div class="md-copyright__highlight">
  783. Copyright &copy; Aegon Games Ltd.
  784. </div>
  785. Made with
  786. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  787. Material for MkDocs
  788. </a>
  789. </div>
  790. </div>
  791. </div>
  792. </footer>
  793. </div>
  794. <div class="md-dialog" data-md-component="dialog">
  795. <div class="md-dialog__inner md-typeset"></div>
  796. </div>
  797. <script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "announce.dismiss", "header.autohide", "navigation.footer", "navigation.indexes", "navigation.top", "navigation.tracking"], "search": "../assets/javascripts/workers/search.f8cc74c7.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>
  798. <script src="../assets/javascripts/bundle.c8b220af.min.js"></script>
  799. </body>
  800. </html>