custom-adapters.html 50 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883
  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="astar-pathfinding.html">
  7. <link rel="next" href="../integrations/index.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>Custom Adapters - 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="#pathfinding-custom-adapters" 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. Custom Adapters
  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--nested">
  220. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
  221. <div class="md-nav__link md-nav__container">
  222. <a href="../advanced-features/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="false">
  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="../advanced-features/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="../advanced-features/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="../advanced-features/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="../advanced-features/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">
  266. <a href="../advanced-features/injecting-tiles.html" class="md-nav__link">
  267. <span class="md-ellipsis">
  268. Injecting Special Tiles
  269. </span>
  270. </a>
  271. </li>
  272. <li class="md-nav__item">
  273. <a href="../advanced-features/connection-rules.html" class="md-nav__link">
  274. <span class="md-ellipsis">
  275. Tile Connection Rules
  276. </span>
  277. </a>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../advanced-features/attached-dungeons.html" class="md-nav__link">
  281. <span class="md-ellipsis">
  282. Generating Attached Dungeons
  283. </span>
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../advanced-features/additional-collisions.html" class="md-nav__link">
  288. <span class="md-ellipsis">
  289. Avoid Collisions With the Scene
  290. </span>
  291. </a>
  292. </li>
  293. <li class="md-nav__item">
  294. <a href="../advanced-features/runtime-events.html" class="md-nav__link">
  295. <span class="md-ellipsis">
  296. Runtime Events & Code Execution
  297. </span>
  298. </a>
  299. </li>
  300. <li class="md-nav__item">
  301. <a href="../advanced-features/post-processing.html" class="md-nav__link">
  302. <span class="md-ellipsis">
  303. Custom Post-Processing
  304. </span>
  305. </a>
  306. </li>
  307. <li class="md-nav__item">
  308. <a href="../advanced-features/character-component.html" class="md-nav__link">
  309. <span class="md-ellipsis">
  310. DunGen Character Component
  311. </span>
  312. </a>
  313. </li>
  314. </ul>
  315. </nav>
  316. </li>
  317. <li class="md-nav__item md-nav__item--nested">
  318. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
  319. <div class="md-nav__link md-nav__container">
  320. <a href="../optimization/index.html" class="md-nav__link ">
  321. <span class="md-ellipsis">
  322. Optimization
  323. </span>
  324. </a>
  325. <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
  326. <span class="md-nav__icon md-icon"></span>
  327. </label>
  328. </div>
  329. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  330. <label class="md-nav__title" for="__nav_6">
  331. <span class="md-nav__icon md-icon"></span>
  332. Optimization
  333. </label>
  334. <ul class="md-nav__list" data-md-scrollfix>
  335. <li class="md-nav__item">
  336. <a href="../optimization/culling.html" class="md-nav__link">
  337. <span class="md-ellipsis">
  338. Built-in Culling
  339. </span>
  340. </a>
  341. </li>
  342. <li class="md-nav__item">
  343. <a href="../optimization/tile-pooling.html" class="md-nav__link">
  344. <span class="md-ellipsis">
  345. Tile Pooling
  346. </span>
  347. </a>
  348. </li>
  349. </ul>
  350. </nav>
  351. </li>
  352. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  353. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" checked>
  354. <div class="md-nav__link md-nav__container">
  355. <a href="index.html" class="md-nav__link ">
  356. <span class="md-ellipsis">
  357. Pathfinding
  358. </span>
  359. </a>
  360. <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
  361. <span class="md-nav__icon md-icon"></span>
  362. </label>
  363. </div>
  364. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="true">
  365. <label class="md-nav__title" for="__nav_7">
  366. <span class="md-nav__icon md-icon"></span>
  367. Pathfinding
  368. </label>
  369. <ul class="md-nav__list" data-md-scrollfix>
  370. <li class="md-nav__item">
  371. <a href="unity-navmesh.html" class="md-nav__link">
  372. <span class="md-ellipsis">
  373. Unity NavMesh Components
  374. </span>
  375. </a>
  376. </li>
  377. <li class="md-nav__item">
  378. <a href="astar-pathfinding.html" class="md-nav__link">
  379. <span class="md-ellipsis">
  380. A* Pathfinding Project Pro
  381. </span>
  382. </a>
  383. </li>
  384. <li class="md-nav__item md-nav__item--active">
  385. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  386. <label class="md-nav__link md-nav__link--active" for="__toc">
  387. <span class="md-ellipsis">
  388. Custom Adapters
  389. </span>
  390. <span class="md-nav__icon md-icon"></span>
  391. </label>
  392. <a href="custom-adapters.html" class="md-nav__link md-nav__link--active">
  393. <span class="md-ellipsis">
  394. Custom Adapters
  395. </span>
  396. </a>
  397. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  398. <label class="md-nav__title" for="__toc">
  399. <span class="md-nav__icon md-icon"></span>
  400. Table of contents
  401. </label>
  402. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  403. <li class="md-nav__item">
  404. <a href="#whats-an-adapter" class="md-nav__link">
  405. <span class="md-ellipsis">
  406. What's an Adapter?
  407. </span>
  408. </a>
  409. </li>
  410. <li class="md-nav__item">
  411. <a href="#the-navmeshadapter-class" class="md-nav__link">
  412. <span class="md-ellipsis">
  413. The NavMeshAdapter Class
  414. </span>
  415. </a>
  416. </li>
  417. <li class="md-nav__item">
  418. <a href="#the-generate-method" class="md-nav__link">
  419. <span class="md-ellipsis">
  420. The Generate Method
  421. </span>
  422. </a>
  423. </li>
  424. <li class="md-nav__item">
  425. <a href="#implementation-steps" class="md-nav__link">
  426. <span class="md-ellipsis">
  427. Implementation Steps
  428. </span>
  429. </a>
  430. </li>
  431. <li class="md-nav__item">
  432. <a href="#considerations" class="md-nav__link">
  433. <span class="md-ellipsis">
  434. Considerations
  435. </span>
  436. </a>
  437. </li>
  438. </ul>
  439. </nav>
  440. </li>
  441. </ul>
  442. </nav>
  443. </li>
  444. <li class="md-nav__item md-nav__item--nested">
  445. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
  446. <div class="md-nav__link md-nav__container">
  447. <a href="../integrations/index.html" class="md-nav__link ">
  448. <span class="md-ellipsis">
  449. Integrations
  450. </span>
  451. </a>
  452. <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0">
  453. <span class="md-nav__icon md-icon"></span>
  454. </label>
  455. </div>
  456. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  457. <label class="md-nav__title" for="__nav_8">
  458. <span class="md-nav__icon md-icon"></span>
  459. Integrations
  460. </label>
  461. <ul class="md-nav__list" data-md-scrollfix>
  462. <li class="md-nav__item">
  463. <a href="../integrations/sectr.html" class="md-nav__link">
  464. <span class="md-ellipsis">
  465. SECTR Portal Culling
  466. </span>
  467. </a>
  468. </li>
  469. <li class="md-nav__item">
  470. <a href="../integrations/playmaker.html" class="md-nav__link">
  471. <span class="md-ellipsis">
  472. PlayMaker Actions
  473. </span>
  474. </a>
  475. </li>
  476. </ul>
  477. </nav>
  478. </li>
  479. <li class="md-nav__item md-nav__item--nested">
  480. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
  481. <div class="md-nav__link md-nav__container">
  482. <a href="../troubleshooting/index.html" class="md-nav__link ">
  483. <span class="md-ellipsis">
  484. Troubleshooting
  485. </span>
  486. </a>
  487. <label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="0">
  488. <span class="md-nav__icon md-icon"></span>
  489. </label>
  490. </div>
  491. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
  492. <label class="md-nav__title" for="__nav_9">
  493. <span class="md-nav__icon md-icon"></span>
  494. Troubleshooting
  495. </label>
  496. <ul class="md-nav__list" data-md-scrollfix>
  497. <li class="md-nav__item">
  498. <a href="../troubleshooting/limitations.html" class="md-nav__link">
  499. <span class="md-ellipsis">
  500. Limitations & Considerations
  501. </span>
  502. </a>
  503. </li>
  504. <li class="md-nav__item">
  505. <a href="../troubleshooting/analysis.html" class="md-nav__link">
  506. <span class="md-ellipsis">
  507. Analysis
  508. </span>
  509. </a>
  510. </li>
  511. </ul>
  512. </nav>
  513. </li>
  514. <li class="md-nav__item md-nav__item--nested">
  515. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
  516. <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
  517. <span class="md-ellipsis">
  518. Reference
  519. </span>
  520. <span class="md-nav__icon md-icon"></span>
  521. </label>
  522. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
  523. <label class="md-nav__title" for="__nav_10">
  524. <span class="md-nav__icon md-icon"></span>
  525. Reference
  526. </label>
  527. <ul class="md-nav__list" data-md-scrollfix>
  528. <li class="md-nav__item">
  529. <a href="../reference/faq.html" class="md-nav__link">
  530. <span class="md-ellipsis">
  531. FAQ
  532. </span>
  533. </a>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../reference/cookbook.html" class="md-nav__link">
  537. <span class="md-ellipsis">
  538. Cookbook
  539. </span>
  540. </a>
  541. </li>
  542. </ul>
  543. </nav>
  544. </li>
  545. </ul>
  546. </nav>
  547. </div>
  548. </div>
  549. </div>
  550. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  551. <div class="md-sidebar__scrollwrap">
  552. <div class="md-sidebar__inner">
  553. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  554. <label class="md-nav__title" for="__toc">
  555. <span class="md-nav__icon md-icon"></span>
  556. Table of contents
  557. </label>
  558. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  559. <li class="md-nav__item">
  560. <a href="#whats-an-adapter" class="md-nav__link">
  561. <span class="md-ellipsis">
  562. What's an Adapter?
  563. </span>
  564. </a>
  565. </li>
  566. <li class="md-nav__item">
  567. <a href="#the-navmeshadapter-class" class="md-nav__link">
  568. <span class="md-ellipsis">
  569. The NavMeshAdapter Class
  570. </span>
  571. </a>
  572. </li>
  573. <li class="md-nav__item">
  574. <a href="#the-generate-method" class="md-nav__link">
  575. <span class="md-ellipsis">
  576. The Generate Method
  577. </span>
  578. </a>
  579. </li>
  580. <li class="md-nav__item">
  581. <a href="#implementation-steps" class="md-nav__link">
  582. <span class="md-ellipsis">
  583. Implementation Steps
  584. </span>
  585. </a>
  586. </li>
  587. <li class="md-nav__item">
  588. <a href="#considerations" class="md-nav__link">
  589. <span class="md-ellipsis">
  590. Considerations
  591. </span>
  592. </a>
  593. </li>
  594. </ul>
  595. </nav>
  596. </div>
  597. </div>
  598. </div>
  599. <div class="md-content" data-md-component="content">
  600. <article class="md-content__inner md-typeset">
  601. <h1 id="pathfinding-custom-adapters">Pathfinding: Custom Adapters</h1>
  602. <p>While DunGen provides built-in integration adapters for popular pathfinding solutions like Unity NavMesh Components and A* Pathfinding Project Pro, you might be using a different system. DunGen offers a flexible way to integrate <em>any</em> third-party system (including custom pathfinding solutions) by creating your own <strong>Custom Adapter</strong>.</p>
  603. <hr />
  604. <h2 id="whats-an-adapter">What's an Adapter?</h2>
  605. <p>DunGen Adapters are C# script components that hook into the dungeon generation lifecycle, specifically during the <strong>post-processing phase</strong>. This phase occurs <em>after</em> the main dungeon layout (Tiles and connections) has been generated and placed in the scene.</p>
  606. <p>By creating a script that inherits from DunGen's <code>NavMeshAdapter</code> class, you can execute your custom logic at the right time, allowing you to trigger actions in your chosen pathfinding system, such as:</p>
  607. <ul>
  608. <li>Scanning or baking navigation data based on the generated geometry.</li>
  609. <li>Placing specific pathfinding-related objects or markers.</li>
  610. <li>Updating pathfinding graphs based on door states or other dynamic elements.</li>
  611. </ul>
  612. <hr />
  613. <h2 id="the-navmeshadapter-class">The <code>NavMeshAdapter</code> Class</h2>
  614. <p>To create a custom adapter, your script must inherit from <code>DunGen.Adapters.NavMeshAdapter</code>.</p>
  615. <div class="language-csharp 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="k">using</span><span class="w"> </span><span class="nn">UnityEngine</span><span class="p">;</span>
  616. </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="k">using</span><span class="w"> </span><span class="nn">DunGen</span><span class="p">;</span>
  617. </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="k">using</span><span class="w"> </span><span class="nn">DunGen.Adapters</span><span class="p">;</span>
  618. </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>
  619. </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="k">public</span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">MyCustomPathfindingAdapter</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="n">NavMeshAdapter</span>
  620. </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="p">{</span>
  621. </span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="c1">// Your custom settings can go here (exposed in the Inspector)</span>
  622. </span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="c1">// [SerializeField] private float scanResolution = 0.5f;</span>
  623. </span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>
  624. </span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="w"> </span><span class="c1">// You MUST override the abstract Generate method</span>
  625. </span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="k">override</span><span class="w"> </span><span class="k">void</span><span class="w"> </span><span class="nf">Generate</span><span class="p">(</span><span class="n">Dungeon</span><span class="w"> </span><span class="n">dungeon</span><span class="p">)</span>
  626. </span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w"> </span><span class="p">{</span>
  627. </span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w"> </span><span class="n">Debug</span><span class="p">.</span><span class="n">Log</span><span class="p">(</span><span class="s">&quot;My Custom Pathfinding Adapter is running!&quot;</span><span class="p">);</span>
  628. </span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a>
  629. </span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="w"> </span><span class="c1">// --- Add your custom pathfinding logic here ---</span>
  630. </span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="w"> </span><span class="c1">// Example: Trigger your pathfinding system&#39;s API</span>
  631. </span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="w"> </span><span class="c1">// MyPathfindingSystem.Instance.ScanNewArea(dungeon.AllTiles);</span>
  632. </span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="w"> </span><span class="p">}</span>
  633. </span><span id="__span-0-19"><a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="p">}</span>
  634. </span></code></pre></div>
  635. <p>Key points about <code>NavMeshAdapter</code>:</p>
  636. <ul>
  637. <li>It inherits from <code>MonoBehaviour</code>, so it's a standard Unity component.</li>
  638. <li>It includes a virtual <code>Priority</code> property (defaulting to 0) which you can override if you need to control the execution order relative to other DunGen adapters (lower priority runs first).</li>
  639. <li>It defines the abstract <code>Generate</code> method, which you <strong>must</strong> implement.</li>
  640. </ul>
  641. <hr />
  642. <h2 id="the-generate-method">The <code>Generate</code> Method</h2>
  643. <p>This is the core of your custom adapter. DunGen automatically calls this method during its post-processing phase.</p>
  644. <ul>
  645. <li><strong>Parameter:</strong> It receives a <code>Dungeon</code> object as input.</li>
  646. <li><strong><code>Dungeon</code> Object:</strong> This object contains comprehensive information about the just-generated dungeon layout, including:<ul>
  647. <li><code>dungeon.AllTiles</code>: A collection of all <code>Tile</code> instances placed in the scene.</li>
  648. <li><code>dungeon.MainPathTiles</code>: Tiles belonging to the main path.</li>
  649. <li><code>dungeon.BranchPathTiles</code>: Tiles belonging to branch paths.</li>
  650. <li><code>dungeon.Connections</code>: A collection of <code>DoorwayConnection</code> objects detailing which doorways were connected.</li>
  651. <li><code>dungeon.Root</code>: The root GameObject containing the generated dungeon.</li>
  652. <li>... and other useful properties about the layout.</li>
  653. </ul>
  654. </li>
  655. <li><strong>Timing:</strong> This method executes <em>after</em> all tiles, props (via <code>Global Props</code>), doors (via <code>Doorway</code> Connectors), and Lock &amp; Key elements have been placed.</li>
  656. </ul>
  657. <hr />
  658. <h2 id="implementation-steps">Implementation Steps</h2>
  659. <ol>
  660. <li><strong>Create Script:</strong> Create a new C# script in your Unity project (e.g., <code>MyCustomPathfindingAdapter.cs</code>).</li>
  661. <li><strong>Inherit &amp; Implement:</strong> Make the class inherit from <code>DunGen.Adapters.NavMeshAdapter</code> and implement the required <code>public override void Generate(Dungeon dungeon)</code> method. Include the necessary <code>using</code> statements.</li>
  662. <li><strong>Add Logic:</strong> Inside the <code>Generate</code> method, write the code needed to interact with your specific pathfinding system's API. Use the provided <code>dungeon</code> object to get information about the layout (e.g., bounds of tiles, doorway connection points).</li>
  663. <li><strong>Attach Component:</strong> Add your custom adapter script as a component to the <strong>same GameObject</strong> in your scene that has the <strong><code>Runtime Dungeon</code></strong> component. DunGen automatically detects and runs all <code>BaseAdapter</code> components attached to this GameObject.</li>
  664. <li><strong>(Optional) Set Priority:</strong> If the execution order matters relative to other adapters (like built-in ones or other custom ones), override the <code>Priority</code> property in your script.</li>
  665. </ol>
  666. <hr />
  667. <h2 id="considerations">Considerations</h2>
  668. <ul>
  669. <li><strong>Performance:</strong> Be mindful that complex pathfinding calculations performed synchronously within the <code>Generate</code> method can cause a noticeable hitch or delay when the dungeon generation completes. Consider if your pathfinding system offers asynchronous updating options that you can trigger from the adapter.</li>
  670. <li><strong>Dependencies:</strong> Ensure any necessary manager objects or setup for your pathfinding system are already present and initialized in the scene <em>before</em> DunGen generation starts.</li>
  671. <li><strong>Error Handling:</strong> Implement robust error checking (e.g., checking for nulls, using try-catch blocks) within your <code>Generate</code> method to prevent issues in your pathfinding logic from breaking the entire generation process.</li>
  672. </ul>
  673. <p>By creating a custom adapter, you can seamlessly integrate virtually any pathfinding system with DunGen's powerful procedural generation capabilities.</p>
  674. </article>
  675. </div>
  676. <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>
  677. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  678. </div>
  679. <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  680. <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>
  681. Back to top
  682. </button>
  683. </main>
  684. <footer class="md-footer">
  685. <nav class="md-footer__inner md-grid" aria-label="Footer" >
  686. <a href="astar-pathfinding.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: A* Pathfinding Project Pro">
  687. <div class="md-footer__button md-icon">
  688. <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>
  689. </div>
  690. <div class="md-footer__title">
  691. <span class="md-footer__direction">
  692. Previous
  693. </span>
  694. <div class="md-ellipsis">
  695. A* Pathfinding Project Pro
  696. </div>
  697. </div>
  698. </a>
  699. <a href="../integrations/index.html" class="md-footer__link md-footer__link--next" aria-label="Next: Overview">
  700. <div class="md-footer__title">
  701. <span class="md-footer__direction">
  702. Next
  703. </span>
  704. <div class="md-ellipsis">
  705. Overview
  706. </div>
  707. </div>
  708. <div class="md-footer__button md-icon">
  709. <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>
  710. </div>
  711. </a>
  712. </nav>
  713. <div class="md-footer-meta md-typeset">
  714. <div class="md-footer-meta__inner md-grid">
  715. <div class="md-copyright">
  716. <div class="md-copyright__highlight">
  717. Copyright &copy; Aegon Games Ltd.
  718. </div>
  719. Made with
  720. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  721. Material for MkDocs
  722. </a>
  723. </div>
  724. </div>
  725. </div>
  726. </footer>
  727. </div>
  728. <div class="md-dialog" data-md-component="dialog">
  729. <div class="md-dialog__inner md-typeset"></div>
  730. </div>
  731. <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>
  732. <script src="../assets/javascripts/bundle.c8b220af.min.js"></script>
  733. </body>
  734. </html>