namespace_con.html 147 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: Con Namespace Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#nested-classes">Classes</a> &#124;
  73. <a href="#typedef-members">Typedefs</a> &#124;
  74. <a href="#enum-members">Enumerations</a> &#124;
  75. <a href="#func-members">Functions</a> </div>
  76. <div class="headertitle"><div class="title">Con Namespace Reference</div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  81. Classes</h2></td></tr>
  82. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_con_1_1_con_prinf_threaded_event.html">ConPrinfThreadedEvent</a></td></tr>
  83. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table><table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
  86. Typedefs</h2></td></tr>
  87. <tr class="memitem:a9f19521452a2a20b0e75df991b4bd8c7" id="r_a9f19521452a2a20b0e75df991b4bd8c7"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="class_hash_map.html">HashMap</a>&lt; StringTableEntry, StringTableEntry &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a9f19521452a2a20b0e75df991b4bd8c7">typePathExpandoMap</a></td></tr>
  88. <tr class="separator:a9f19521452a2a20b0e75df991b4bd8c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. </table><table class="memberdecls">
  90. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
  91. Enumerations</h2></td></tr>
  92. <tr class="memitem:a198b8c2c77ea9f9815a181ddeda1c320" id="r_a198b8c2c77ea9f9815a181ddeda1c320"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a198b8c2c77ea9f9815a181ddeda1c320">Constants</a> { <a class="el" href="namespace_con.html#a198b8c2c77ea9f9815a181ddeda1c320afb839de9272a0ef76db2f9e8b8195638">DSOVersion</a> = 44
  93. , <a class="el" href="namespace_con.html#a198b8c2c77ea9f9815a181ddeda1c320a4479fc6451d3142aaaa94f6de153b2ad">MaxLineLength</a> = 512
  94. , <a class="el" href="namespace_con.html#a198b8c2c77ea9f9815a181ddeda1c320a871a196095500379a8442e2b9558fdad">MaxDataTypes</a> = 256
  95. }</td></tr>
  96. <tr class="memdesc:a198b8c2c77ea9f9815a181ddeda1c320"><td class="mdescLeft">&#160;</td><td class="mdescRight">Various configuration constants. <a href="namespace_con.html#a198b8c2c77ea9f9815a181ddeda1c320">More...</a><br /></td></tr>
  97. <tr class="separator:a198b8c2c77ea9f9815a181ddeda1c320"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  100. Functions</h2></td></tr>
  101. <tr class="memitem:acfece81969a99e56dc5b05a6f3800842" id="r_acfece81969a99e56dc5b05a6f3800842"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#acfece81969a99e56dc5b05a6f3800842">isMainThread</a> ()</td></tr>
  102. <tr class="memdesc:acfece81969a99e56dc5b05a6f3800842"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true when called from the main thread, false otherwise. <br /></td></tr>
  103. <tr class="separator:acfece81969a99e56dc5b05a6f3800842"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr><td colspan="2"><div class="groupHeader">Console Function Implementation Helpers</div></td></tr>
  105. <tr><td colspan="2"><div class="groupText"><p>The functions <a class="el" href="namespace_con.html#af64f95625041d8ad300dfab3875dfb99">Con::getIntArg</a>, <a class="el" href="namespace_con.html#a9e00c3d7b7e2c86d2b606ec5933ae4f7">Con::getFloatArg</a> and Con::getArgBuffer(size) are used to allocate on the console stack string variables that will be passed into the next console </p>
  106. </div></td></tr>
  107. <tr class="memitem:ab0583ba59217e586cf79446c95bbed3a" id="r_ab0583ba59217e586cf79446c95bbed3a"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ab0583ba59217e586cf79446c95bbed3a">getReturnBuffer</a> (U32 bufferSize)</td></tr>
  108. <tr class="separator:ab0583ba59217e586cf79446c95bbed3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a0fd8dc9c46dea3bb9afd749a6323b601" id="r_a0fd8dc9c46dea3bb9afd749a6323b601"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a0fd8dc9c46dea3bb9afd749a6323b601">getReturnBuffer</a> (const char *stringToCopy)</td></tr>
  110. <tr class="separator:a0fd8dc9c46dea3bb9afd749a6323b601"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a561915e6ebb649c6bac00b80f8b42cc3" id="r_a561915e6ebb649c6bac00b80f8b42cc3"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a561915e6ebb649c6bac00b80f8b42cc3">getArgBuffer</a> (U32 bufferSize)</td></tr>
  112. <tr class="separator:a561915e6ebb649c6bac00b80f8b42cc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a9e00c3d7b7e2c86d2b606ec5933ae4f7" id="r_a9e00c3d7b7e2c86d2b606ec5933ae4f7"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a9e00c3d7b7e2c86d2b606ec5933ae4f7">getFloatArg</a> (F64 arg)</td></tr>
  114. <tr class="separator:a9e00c3d7b7e2c86d2b606ec5933ae4f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:af64f95625041d8ad300dfab3875dfb99" id="r_af64f95625041d8ad300dfab3875dfb99"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#af64f95625041d8ad300dfab3875dfb99">getIntArg</a> (S32 arg)</td></tr>
  116. <tr class="separator:af64f95625041d8ad300dfab3875dfb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a6d7df441a2b4b2369dabe83dff178427" id="r_a6d7df441a2b4b2369dabe83dff178427"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a6d7df441a2b4b2369dabe83dff178427">getBoolArg</a> (bool arg)</td></tr>
  118. <tr class="separator:a6d7df441a2b4b2369dabe83dff178427"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr><td colspan="2"><div class="groupHeader">Control Functions</div></td></tr>
  120. <tr><td colspan="2"><div class="groupText"><p>The console must be initialized and shutdown appropriately during the lifetime of the app. These functions are used to manage this behavior.</p>
  121. <dl class="section note"><dt>Note</dt><dd><a class="el" href="namespace_torque.html">Torque</a> deals with this aspect of console management, so you don't need to call these functions in normal usage of the engine. </dd></dl>
  122. </div></td></tr>
  123. <tr class="memitem:a02fd73d861ef2e4aabb38c0c9ff82947" id="r_a02fd73d861ef2e4aabb38c0c9ff82947"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a02fd73d861ef2e4aabb38c0c9ff82947">init</a> ()</td></tr>
  124. <tr class="separator:a02fd73d861ef2e4aabb38c0c9ff82947"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a7861ee1569802186a619778efc85af13" id="r_a7861ee1569802186a619778efc85af13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a7861ee1569802186a619778efc85af13">shutdown</a> ()</td></tr>
  126. <tr class="separator:a7861ee1569802186a619778efc85af13"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:aa1f512ab0fcc05612f8e3d6a4664ce9a" id="r_aa1f512ab0fcc05612f8e3d6a4664ce9a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#aa1f512ab0fcc05612f8e3d6a4664ce9a">isActive</a> ()</td></tr>
  128. <tr class="memdesc:aa1f512ab0fcc05612f8e3d6a4664ce9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is the console active at this time? <br /></td></tr>
  129. <tr class="separator:aa1f512ab0fcc05612f8e3d6a4664ce9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr><td colspan="2"><div class="groupHeader">Logging</div></td></tr>
  131. <tr class="memitem:a7a567eee4c11f2b36849d4895f2824a4" id="r_a7a567eee4c11f2b36849d4895f2824a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a7a567eee4c11f2b36849d4895f2824a4">getLockLog</a> (<a class="el" href="struct_console_log_entry.html">ConsoleLogEntry</a> *&amp;log, U32 &amp;size)</td></tr>
  132. <tr class="separator:a7a567eee4c11f2b36849d4895f2824a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a0fbda1952e95e63be5f2b96c5a140abc" id="r_a0fbda1952e95e63be5f2b96c5a140abc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a0fbda1952e95e63be5f2b96c5a140abc">unlockLog</a> ()</td></tr>
  134. <tr class="separator:a0fbda1952e95e63be5f2b96c5a140abc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ac56041c92b409836c4d809e4880d0ff4" id="r_ac56041c92b409836c4d809e4880d0ff4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ac56041c92b409836c4d809e4880d0ff4">setLogMode</a> (S32 newMode)</td></tr>
  136. <tr class="separator:ac56041c92b409836c4d809e4880d0ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr><td colspan="2"><div class="groupHeader">Miscellaneous</div></td></tr>
  138. <tr class="memitem:a3ccce5ef4dd2bc53a33e07a4cc1fa313" id="r_a3ccce5ef4dd2bc53a33e07a4cc1fa313"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a3ccce5ef4dd2bc53a33e07a4cc1fa313">tabComplete</a> (char *inputBuffer, U32 cursorPos, U32 maxResultLength, bool forwardTab)</td></tr>
  139. <tr class="separator:a3ccce5ef4dd2bc53a33e07a4cc1fa313"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aba4d99980cbe6d1fae6b61a4a85f5c38" id="r_aba4d99980cbe6d1fae6b61a4a85f5c38"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#aba4d99980cbe6d1fae6b61a4a85f5c38">stripColorChars</a> (char *line)</td></tr>
  141. <tr class="separator:aba4d99980cbe6d1fae6b61a4a85f5c38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a13f3ea370bb12b0f9b2284cb2c406954" id="r_a13f3ea370bb12b0f9b2284cb2c406954"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a13f3ea370bb12b0f9b2284cb2c406954">isFunction</a> (const char *fn)</td></tr>
  143. <tr class="separator:a13f3ea370bb12b0f9b2284cb2c406954"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:aee2a5d3865c4b41083e4a1ecb4965e8e" id="r_aee2a5d3865c4b41083e4a1ecb4965e8e"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#aee2a5d3865c4b41083e4a1ecb4965e8e">getModNameFromPath</a> (const char *path)</td></tr>
  145. <tr class="separator:aee2a5d3865c4b41083e4a1ecb4965e8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a90e867fb7cb7be0c5be5b2a48121e3f8" id="r_a90e867fb7cb7be0c5be5b2a48121e3f8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a90e867fb7cb7be0c5be5b2a48121e3f8">addPathExpando</a> (const char *pExpandoName, const char *pPath)</td></tr>
  147. <tr class="separator:a90e867fb7cb7be0c5be5b2a48121e3f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:aca6ed7058ea6c73ec40148b4bc865997" id="r_aca6ed7058ea6c73ec40148b4bc865997"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#aca6ed7058ea6c73ec40148b4bc865997">getPathExpando</a> (const char *pExpandoName)</td></tr>
  149. <tr class="separator:aca6ed7058ea6c73ec40148b4bc865997"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a0c93fb7c60d2ca1491dd66f6834370f9" id="r_a0c93fb7c60d2ca1491dd66f6834370f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a0c93fb7c60d2ca1491dd66f6834370f9">removePathExpando</a> (const char *pExpandoName)</td></tr>
  151. <tr class="separator:a0c93fb7c60d2ca1491dd66f6834370f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ad0368dff61918f2b46e74cdab98afb21" id="r_ad0368dff61918f2b46e74cdab98afb21"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ad0368dff61918f2b46e74cdab98afb21">isPathExpando</a> (const char *pExpandoName)</td></tr>
  153. <tr class="separator:ad0368dff61918f2b46e74cdab98afb21"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a65a279da1ce0f579a7989cf3cd0cd6dc" id="r_a65a279da1ce0f579a7989cf3cd0cd6dc"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a65a279da1ce0f579a7989cf3cd0cd6dc">getPathExpandoCount</a> (void)</td></tr>
  155. <tr class="separator:a65a279da1ce0f579a7989cf3cd0cd6dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a24351fba6ef62142af5a686705c07920" id="r_a24351fba6ef62142af5a686705c07920"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a24351fba6ef62142af5a686705c07920">getPathExpandoKey</a> (U32 expandoIndex)</td></tr>
  157. <tr class="separator:a24351fba6ef62142af5a686705c07920"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:ad75e4f935a859c876ccfdfae61b9d7f3" id="r_ad75e4f935a859c876ccfdfae61b9d7f3"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ad75e4f935a859c876ccfdfae61b9d7f3">getPathExpandoValue</a> (U32 expandoIndex)</td></tr>
  159. <tr class="separator:ad75e4f935a859c876ccfdfae61b9d7f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:ade40cc27b73661f1d997107a00baae6b" id="r_ade40cc27b73661f1d997107a00baae6b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ade40cc27b73661f1d997107a00baae6b">expandPath</a> (char *pDstPath, U32 size, const char *pSrcPath, const char *pWorkingDirectoryHint, const bool <a class="el" href="namespace_con.html#a839910d8445542be1b6a4259b6fe453a">ensureTrailingSlash</a>)</td></tr>
  161. <tr class="separator:ade40cc27b73661f1d997107a00baae6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a65b1843a43b1db17ea4a3f78a20990b3" id="r_a65b1843a43b1db17ea4a3f78a20990b3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a65b1843a43b1db17ea4a3f78a20990b3">isBasePath</a> (const char *SrcPath, const char *pBasePath)</td></tr>
  163. <tr class="separator:a65b1843a43b1db17ea4a3f78a20990b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a0cfdebebf927e430c9c5e76f0e575c67" id="r_a0cfdebebf927e430c9c5e76f0e575c67"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a0cfdebebf927e430c9c5e76f0e575c67">collapsePath</a> (char *pDstPath, U32 size, const char *pSrcPath, const char *pWorkingDirectoryHint)</td></tr>
  165. <tr class="separator:a0cfdebebf927e430c9c5e76f0e575c67"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a839910d8445542be1b6a4259b6fe453a" id="r_a839910d8445542be1b6a4259b6fe453a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a839910d8445542be1b6a4259b6fe453a">ensureTrailingSlash</a> (char *pDstPath, const char *pSrcPath)</td></tr>
  167. <tr class="separator:a839910d8445542be1b6a4259b6fe453a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a198f138e423c00cd0db8083115afe0a3" id="r_a198f138e423c00cd0db8083115afe0a3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a198f138e423c00cd0db8083115afe0a3">stripRepeatSlashes</a> (char *pDstPath, const char *pSrcPath, S32 dstSize)</td></tr>
  169. <tr class="separator:a198f138e423c00cd0db8083115afe0a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr><td colspan="2"><div class="groupHeader">Console Output</div></td></tr>
  171. <tr><td colspan="2"><div class="groupText"><p>These functions process the formatted string and pass it to all the ConsumerCallbacks that are currently registered. The console log file and the console window callbacks are installed by default.</p>
  172. <dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_con.html#a648038e7c75ddf17ab4ca01ffa347d27">addConsumer()</a> </dd>
  173. <dd>
  174. <a class="el" href="namespace_con.html#a16dfb00f8413c5bffac8e8700f8ef796">removeConsumer()</a> </dd></dl>
  175. </div></td></tr>
  176. <tr class="memitem:ae5f15506155750b79c8ceb1d9e86d34c" id="r_ae5f15506155750b79c8ceb1d9e86d34c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ae5f15506155750b79c8ceb1d9e86d34c">cls</a> (void)</td></tr>
  177. <tr class="memdesc:ae5f15506155750b79c8ceb1d9e86d34c"><td class="mdescLeft">&#160;</td><td class="mdescRight">clear the console log <br /></td></tr>
  178. <tr class="separator:ae5f15506155750b79c8ceb1d9e86d34c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a0aff7311d684a0e0ef33125616a73385" id="r_a0aff7311d684a0e0ef33125616a73385"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a0aff7311d684a0e0ef33125616a73385">printf</a> (const char *fmt,...)</td></tr>
  180. <tr class="separator:a0aff7311d684a0e0ef33125616a73385"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a8559290355d1bfb41d57211f47a25805" id="r_a8559290355d1bfb41d57211f47a25805"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a8559290355d1bfb41d57211f47a25805">warnf</a> (<a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7">ConsoleLogEntry::Type</a> type, const char *fmt,...)</td></tr>
  182. <tr class="separator:a8559290355d1bfb41d57211f47a25805"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:a392f9ee44bd2f1e06b87da3e621fdaed" id="r_a392f9ee44bd2f1e06b87da3e621fdaed"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a392f9ee44bd2f1e06b87da3e621fdaed">errorf</a> (<a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7">ConsoleLogEntry::Type</a> type, const char *fmt,...)</td></tr>
  184. <tr class="separator:a392f9ee44bd2f1e06b87da3e621fdaed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:a2fa5ed97682afe78d32da12d0827d12d" id="r_a2fa5ed97682afe78d32da12d0827d12d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a2fa5ed97682afe78d32da12d0827d12d">warnf</a> (const char *fmt,...)</td></tr>
  186. <tr class="separator:a2fa5ed97682afe78d32da12d0827d12d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a81242a979f28bc6aa76d4a6bdc3fa707" id="r_a81242a979f28bc6aa76d4a6bdc3fa707"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a81242a979f28bc6aa76d4a6bdc3fa707">errorf</a> (const char *fmt,...)</td></tr>
  188. <tr class="separator:a81242a979f28bc6aa76d4a6bdc3fa707"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a46f11da4f5c73c8ee975083968e25202" id="r_a46f11da4f5c73c8ee975083968e25202"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a46f11da4f5c73c8ee975083968e25202">printSeparator</a> (void)</td></tr>
  190. <tr class="memdesc:a46f11da4f5c73c8ee975083968e25202"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints a separator to the console. <br /></td></tr>
  191. <tr class="separator:a46f11da4f5c73c8ee975083968e25202"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a1423233a5f47c3247dc46d38318b054f" id="r_a1423233a5f47c3247dc46d38318b054f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a1423233a5f47c3247dc46d38318b054f">printBlankLine</a> (void)</td></tr>
  193. <tr class="memdesc:a1423233a5f47c3247dc46d38318b054f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints a separator to the console. <br /></td></tr>
  194. <tr class="separator:a1423233a5f47c3247dc46d38318b054f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr><td colspan="2"><div class="groupHeader">Global Variable Accessors</div></td></tr>
  196. <tr><td colspan="2"><div class="groupText"><p>Assign a string value to a global console variable </p><dl class="params"><dt>Parameters</dt><dd>
  197. <table class="params">
  198. <tr><td class="paramname">name</td><td>Global console variable name to set </td></tr>
  199. <tr><td class="paramname">value</td><td>String value to assign to this variable. </td></tr>
  200. </table>
  201. </dd>
  202. </dl>
  203. </div></td></tr>
  204. <tr class="memitem:ae6903e12c93d43fc84224e183c11c728" id="r_ae6903e12c93d43fc84224e183c11c728"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ae6903e12c93d43fc84224e183c11c728">setVariable</a> (const char *name, const char *value)</td></tr>
  205. <tr class="separator:ae6903e12c93d43fc84224e183c11c728"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <tr class="memitem:a810eda28f4146b51daad8500fb6792be" id="r_a810eda28f4146b51daad8500fb6792be"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a810eda28f4146b51daad8500fb6792be">setBoolVariable</a> (const char *name, bool var)</td></tr>
  207. <tr class="memdesc:a810eda28f4146b51daad8500fb6792be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="namespace_con.html#ae6903e12c93d43fc84224e183c11c728">setVariable()</a>, but for bools. <br /></td></tr>
  208. <tr class="separator:a810eda28f4146b51daad8500fb6792be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. <tr class="memitem:a1457a2f1a5d8750ea592fef2a1139099" id="r_a1457a2f1a5d8750ea592fef2a1139099"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a1457a2f1a5d8750ea592fef2a1139099">setIntVariable</a> (const char *name, S32 var)</td></tr>
  210. <tr class="memdesc:a1457a2f1a5d8750ea592fef2a1139099"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="namespace_con.html#ae6903e12c93d43fc84224e183c11c728">setVariable()</a>, but for ints. <br /></td></tr>
  211. <tr class="separator:a1457a2f1a5d8750ea592fef2a1139099"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <tr class="memitem:ad79b1be9ec6572eb1dcc8bfa6987e84c" id="r_ad79b1be9ec6572eb1dcc8bfa6987e84c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ad79b1be9ec6572eb1dcc8bfa6987e84c">setFloatVariable</a> (const char *name, F32 var)</td></tr>
  213. <tr class="memdesc:ad79b1be9ec6572eb1dcc8bfa6987e84c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="namespace_con.html#ae6903e12c93d43fc84224e183c11c728">setVariable()</a>, but for floats. <br /></td></tr>
  214. <tr class="separator:ad79b1be9ec6572eb1dcc8bfa6987e84c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  215. <tr class="memitem:a7a7b8a66c903bd9f22e8ddc5837f9c88" id="r_a7a7b8a66c903bd9f22e8ddc5837f9c88"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a7a7b8a66c903bd9f22e8ddc5837f9c88">getVariable</a> (const char *name)</td></tr>
  216. <tr class="separator:a7a7b8a66c903bd9f22e8ddc5837f9c88"><td class="memSeparator" colspan="2">&#160;</td></tr>
  217. <tr class="memitem:a8608bcc5cd3aa1bd16dbd6e07d3d87f7" id="r_a8608bcc5cd3aa1bd16dbd6e07d3d87f7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a8608bcc5cd3aa1bd16dbd6e07d3d87f7">getBoolVariable</a> (const char *varName, bool def)</td></tr>
  218. <tr class="separator:a8608bcc5cd3aa1bd16dbd6e07d3d87f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  219. <tr class="memitem:af30ef7079120ea73d6fa29021be67de2" id="r_af30ef7079120ea73d6fa29021be67de2"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#af30ef7079120ea73d6fa29021be67de2">getIntVariable</a> (const char *varName, S32 def)</td></tr>
  220. <tr class="separator:af30ef7079120ea73d6fa29021be67de2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  221. <tr class="memitem:ad4378d3748cbaa7ee606f7e045e48bd5" id="r_ad4378d3748cbaa7ee606f7e045e48bd5"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ad4378d3748cbaa7ee606f7e045e48bd5">getFloatVariable</a> (const char *varName, F32 def)</td></tr>
  222. <tr class="separator:ad4378d3748cbaa7ee606f7e045e48bd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  223. <tr><td colspan="2"><div class="groupHeader">Variable Management</div></td></tr>
  224. <tr class="memitem:a322c2b9c1caa63109f25e1aea9f8861c" id="r_a322c2b9c1caa63109f25e1aea9f8861c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a322c2b9c1caa63109f25e1aea9f8861c">setLocalVariable</a> (const char *name, const char *value)</td></tr>
  225. <tr class="separator:a322c2b9c1caa63109f25e1aea9f8861c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  226. <tr class="memitem:aa7566bbb49751967d5fe942f221d182c" id="r_aa7566bbb49751967d5fe942f221d182c"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#aa7566bbb49751967d5fe942f221d182c">getLocalVariable</a> (const char *name)</td></tr>
  227. <tr class="separator:aa7566bbb49751967d5fe942f221d182c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  228. <tr class="memitem:a72b63f75173e2818ec56be71ea96104c" id="r_a72b63f75173e2818ec56be71ea96104c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a72b63f75173e2818ec56be71ea96104c">addVariable</a> (const char *name, S32 t, void *dp)</td></tr>
  229. <tr class="separator:a72b63f75173e2818ec56be71ea96104c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  230. <tr class="memitem:a7ee14fb28117a740e2af63ac87c0580b" id="r_a7ee14fb28117a740e2af63ac87c0580b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a7ee14fb28117a740e2af63ac87c0580b">removeVariable</a> (const char *name)</td></tr>
  231. <tr class="separator:a7ee14fb28117a740e2af63ac87c0580b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  232. <tr><td colspan="2"><div class="groupHeader">Console Consumers</div></td></tr>
  233. <tr><td colspan="2"><div class="groupText"><p>The console distributes its output through <a class="el" href="namespace_torque.html">Torque</a> by using consumers. Every time a new line is printed to the console, all the ConsumerCallbacks registered using addConsumer are called, in order.</p>
  234. <dl class="section note"><dt>Note</dt><dd>The <a class="el" href="class_gui_console.html">GuiConsole</a> control, which provides the on-screen in-game console, uses a different technique to render the console. It calls <a class="el" href="namespace_con.html#a7a567eee4c11f2b36849d4895f2824a4">getLockLog()</a> to lock the <a class="el" href="class_vector.html">Vector</a> of on-screen console entries, then it renders them as needed. While the <a class="el" href="class_vector.html">Vector</a> is locked, the console will not change the <a class="el" href="class_vector.html">Vector</a>. When the <a class="el" href="class_gui_console.html">GuiConsole</a> control is done with the console entries, it calls <a class="el" href="namespace_con.html#a0fbda1952e95e63be5f2b96c5a140abc">unlockLog()</a> to tell the console that it is again safe to modify the <a class="el" href="class_vector.html">Vector</a>.</dd></dl>
  235. <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_telnet_console.html">TelnetConsole</a> </dd>
  236. <dd>
  237. <a class="el" href="class_telnet_debugger.html">TelnetDebugger</a> </dd>
  238. <dd>
  239. WinConsole </dd>
  240. <dd>
  241. MacCarbConsole </dd>
  242. <dd>
  243. iPhoneConsole </dd>
  244. <dd>
  245. StdConsole </dd>
  246. <dd>
  247. <a class="el" href="class_console_logger.html">ConsoleLogger</a> </dd></dl>
  248. </div></td></tr>
  249. <tr class="memitem:a648038e7c75ddf17ab4ca01ffa347d27" id="r_a648038e7c75ddf17ab4ca01ffa347d27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a648038e7c75ddf17ab4ca01ffa347d27">addConsumer</a> (<a class="el" href="group__console__callbacks.html#ga73457ddc96b5e0366926bfd1f6c762ce">ConsumerCallback</a> consumer)</td></tr>
  250. <tr class="separator:a648038e7c75ddf17ab4ca01ffa347d27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  251. <tr class="memitem:a16dfb00f8413c5bffac8e8700f8ef796" id="r_a16dfb00f8413c5bffac8e8700f8ef796"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a16dfb00f8413c5bffac8e8700f8ef796">removeConsumer</a> (<a class="el" href="group__console__callbacks.html#ga73457ddc96b5e0366926bfd1f6c762ce">ConsumerCallback</a> consumer)</td></tr>
  252. <tr class="separator:a16dfb00f8413c5bffac8e8700f8ef796"><td class="memSeparator" colspan="2">&#160;</td></tr>
  253. <tr><td colspan="2"><div class="groupHeader">Namespace Function Registration</div></td></tr>
  254. <tr class="memitem:afeb915f0af44d6f2a6bf5aab00898eef" id="r_afeb915f0af44d6f2a6bf5aab00898eef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#afeb915f0af44d6f2a6bf5aab00898eef">addCommand</a> (const char *nsName, const char *name, <a class="el" href="group__console__callbacks.html#ga3b1618755db8dcc0264d9adbd7944801">StringCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  255. <tr class="separator:afeb915f0af44d6f2a6bf5aab00898eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  256. <tr class="memitem:aac84e5f08163aa8046cc6d7483bf619a" id="r_aac84e5f08163aa8046cc6d7483bf619a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#aac84e5f08163aa8046cc6d7483bf619a">addCommand</a> (const char *nameSpace, const char *name, <a class="el" href="group__console__callbacks.html#gae7bde538b4003b19dca7a9279b5f79b6">VoidCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  257. <tr class="separator:aac84e5f08163aa8046cc6d7483bf619a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  258. <tr class="memitem:a8540dd6e3e93909e45dec01ee821e8cb" id="r_a8540dd6e3e93909e45dec01ee821e8cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a8540dd6e3e93909e45dec01ee821e8cb">addCommand</a> (const char *nameSpace, const char *name, <a class="el" href="group__console__callbacks.html#ga82b43b62df148a3ef01de7f8e8035d58">IntCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  259. <tr class="separator:a8540dd6e3e93909e45dec01ee821e8cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  260. <tr class="memitem:af56a446c7ec8b5d74c63f8f9881cb062" id="r_af56a446c7ec8b5d74c63f8f9881cb062"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#af56a446c7ec8b5d74c63f8f9881cb062">addCommand</a> (const char *nameSpace, const char *name, <a class="el" href="group__console__callbacks.html#gacea87d3b8941b7ffcea991099d630d3a">FloatCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  261. <tr class="separator:af56a446c7ec8b5d74c63f8f9881cb062"><td class="memSeparator" colspan="2">&#160;</td></tr>
  262. <tr class="memitem:a85b1aa25b35f3fca854b14f328b492e9" id="r_a85b1aa25b35f3fca854b14f328b492e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a85b1aa25b35f3fca854b14f328b492e9">addCommand</a> (const char *nameSpace, const char *name, <a class="el" href="group__console__callbacks.html#ga3daa15ec563ddf01edfcf67f9515cf89">BoolCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  263. <tr class="separator:a85b1aa25b35f3fca854b14f328b492e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  264. <tr><td colspan="2"><div class="groupHeader">Special Purpose Registration</div></td></tr>
  265. <tr><td colspan="2"><div class="groupText"><p>These are special-purpose functions that exist to allow commands to be grouped, so that when we generate console docs, they can be more meaningfully presented.</p>
  266. <p><a class="el" href="console_autodoc.html">Click here for more information about console docs and grouping.</a> </p>
  267. </div></td></tr>
  268. <tr class="memitem:a067658a5bf63fb6531cc3042ace16b3e" id="r_a067658a5bf63fb6531cc3042ace16b3e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a067658a5bf63fb6531cc3042ace16b3e">markCommandGroup</a> (const char *nsName, const char *name, const char *usage)</td></tr>
  269. <tr class="separator:a067658a5bf63fb6531cc3042ace16b3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  270. <tr class="memitem:aa69afcece9fc960512f77667f76c1f9a" id="r_aa69afcece9fc960512f77667f76c1f9a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#aa69afcece9fc960512f77667f76c1f9a">beginCommandGroup</a> (const char *nsName, const char *name, const char *usage)</td></tr>
  271. <tr class="separator:aa69afcece9fc960512f77667f76c1f9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  272. <tr class="memitem:a5c1fa7e18f9ef2a129564e741edbe5c1" id="r_a5c1fa7e18f9ef2a129564e741edbe5c1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a5c1fa7e18f9ef2a129564e741edbe5c1">endCommandGroup</a> (const char *nsName, const char *name)</td></tr>
  273. <tr class="separator:a5c1fa7e18f9ef2a129564e741edbe5c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  274. <tr class="memitem:a0041d41e4a4f919e6540d811d6550d6d" id="r_a0041d41e4a4f919e6540d811d6550d6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a0041d41e4a4f919e6540d811d6550d6d">addOverload</a> (const char *nsName, const char *name, const char *altUsage)</td></tr>
  275. <tr class="separator:a0041d41e4a4f919e6540d811d6550d6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  276. <tr><td colspan="2"><div class="groupHeader">Global Function Registration</div></td></tr>
  277. <tr class="memitem:adaa9f527b251884d3f31ed37b141db74" id="r_adaa9f527b251884d3f31ed37b141db74"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#adaa9f527b251884d3f31ed37b141db74">addCommand</a> (const char *name, <a class="el" href="group__console__callbacks.html#ga3b1618755db8dcc0264d9adbd7944801">StringCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  278. <tr class="separator:adaa9f527b251884d3f31ed37b141db74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  279. <tr class="memitem:a2dece2ce768b744138d1182ed7a1e9ab" id="r_a2dece2ce768b744138d1182ed7a1e9ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a2dece2ce768b744138d1182ed7a1e9ab">addCommand</a> (const char *name, <a class="el" href="group__console__callbacks.html#gae7bde538b4003b19dca7a9279b5f79b6">VoidCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  280. <tr class="separator:a2dece2ce768b744138d1182ed7a1e9ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  281. <tr class="memitem:ab3a3d2021690b554ff5c2d2eb757f5df" id="r_ab3a3d2021690b554ff5c2d2eb757f5df"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ab3a3d2021690b554ff5c2d2eb757f5df">addCommand</a> (const char *name, <a class="el" href="group__console__callbacks.html#ga82b43b62df148a3ef01de7f8e8035d58">IntCallback</a> cb, const char *usage, S32 minArgs, S32 maxArg)</td></tr>
  282. <tr class="separator:ab3a3d2021690b554ff5c2d2eb757f5df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  283. <tr class="memitem:af142b271baa302bafe36c9a1574c4b71" id="r_af142b271baa302bafe36c9a1574c4b71"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#af142b271baa302bafe36c9a1574c4b71">addCommand</a> (const char *name, <a class="el" href="group__console__callbacks.html#gacea87d3b8941b7ffcea991099d630d3a">FloatCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  284. <tr class="separator:af142b271baa302bafe36c9a1574c4b71"><td class="memSeparator" colspan="2">&#160;</td></tr>
  285. <tr class="memitem:a7d5079dbd4f29f45e244e7aaf0611c46" id="r_a7d5079dbd4f29f45e244e7aaf0611c46"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a7d5079dbd4f29f45e244e7aaf0611c46">addCommand</a> (const char *name, <a class="el" href="group__console__callbacks.html#ga3daa15ec563ddf01edfcf67f9515cf89">BoolCallback</a> cb, const char *usage, S32 minArgs, S32 maxArgs)</td></tr>
  286. <tr class="separator:a7d5079dbd4f29f45e244e7aaf0611c46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  287. <tr><td colspan="2"><div class="groupHeader">Console Execution</div></td></tr>
  288. <tr><td colspan="2"><div class="groupText"><p>These are functions relating to the execution of script code. </p>
  289. </div></td></tr>
  290. <tr class="memitem:a56d04d81661139edd6894e5d20aa76d8" id="r_a56d04d81661139edd6894e5d20aa76d8"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a56d04d81661139edd6894e5d20aa76d8">evaluate</a> (const char *string, bool echo, const char *fileName)</td></tr>
  291. <tr class="separator:a56d04d81661139edd6894e5d20aa76d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  292. <tr class="memitem:ac139ad582656800381462591409276f6" id="r_ac139ad582656800381462591409276f6"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#ac139ad582656800381462591409276f6">evaluatef</a> (const char *string,...)</td></tr>
  293. <tr class="separator:ac139ad582656800381462591409276f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  294. <tr class="memitem:a27b33db8c092259f68383935d89ab802" id="r_a27b33db8c092259f68383935d89ab802"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a27b33db8c092259f68383935d89ab802">execute</a> (S32 argc, const char *argv[])</td></tr>
  295. <tr class="separator:a27b33db8c092259f68383935d89ab802"><td class="memSeparator" colspan="2">&#160;</td></tr>
  296. <tr class="memitem:a0870067030f9dd3b180fb6a913bac43d" id="r_a0870067030f9dd3b180fb6a913bac43d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a0870067030f9dd3b180fb6a913bac43d">execute</a> (<a class="el" href="class_sim_object.html">SimObject</a> *object, S32 argc, const char *argv[], bool thisCallOnly)</td></tr>
  297. <tr class="separator:a0870067030f9dd3b180fb6a913bac43d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  298. <tr class="memitem:a443c03c63fe60016f5bbfb99e1ccbee5" id="r_a443c03c63fe60016f5bbfb99e1ccbee5"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a443c03c63fe60016f5bbfb99e1ccbee5">executef</a> (<a class="el" href="class_sim_object.html">SimObject</a> *object, S32 argc,...)</td></tr>
  299. <tr class="separator:a443c03c63fe60016f5bbfb99e1ccbee5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  300. <tr class="memitem:a2c0aa758af4981c10a362ddb90914f44" id="r_a2c0aa758af4981c10a362ddb90914f44"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a2c0aa758af4981c10a362ddb90914f44">executef</a> (S32 argc,...)</td></tr>
  301. <tr class="separator:a2c0aa758af4981c10a362ddb90914f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  302. <tr><td colspan="2"><div class="groupHeader">Namespaces</div></td></tr>
  303. <tr class="memitem:a8e8f4ab27f2d023e198c56d79d6f58df" id="r_a8e8f4ab27f2d023e198c56d79d6f58df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_namespace.html">Namespace</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a8e8f4ab27f2d023e198c56d79d6f58df">lookupNamespace</a> (const char *ns)</td></tr>
  304. <tr class="separator:a8e8f4ab27f2d023e198c56d79d6f58df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  305. <tr class="memitem:a62144b415ec2d859119ad5fd8ebb9d5c" id="r_a62144b415ec2d859119ad5fd8ebb9d5c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a62144b415ec2d859119ad5fd8ebb9d5c">linkNamespaces</a> (const char *parent, const char *child)</td></tr>
  306. <tr class="separator:a62144b415ec2d859119ad5fd8ebb9d5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  307. <tr class="memitem:a4d7b63382a84d1d9910407e1fd0ca449" id="r_a4d7b63382a84d1d9910407e1fd0ca449"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a4d7b63382a84d1d9910407e1fd0ca449">unlinkNamespaces</a> (const char *parent, const char *child)</td></tr>
  308. <tr class="separator:a4d7b63382a84d1d9910407e1fd0ca449"><td class="memSeparator" colspan="2">&#160;</td></tr>
  309. <tr class="memitem:a0960f95cb63f7d78a67fe99dba4c29e4" id="r_a0960f95cb63f7d78a67fe99dba4c29e4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a0960f95cb63f7d78a67fe99dba4c29e4">classLinkNamespaces</a> (<a class="el" href="class_namespace.html">Namespace</a> *parent, <a class="el" href="class_namespace.html">Namespace</a> *child)</td></tr>
  310. <tr class="separator:a0960f95cb63f7d78a67fe99dba4c29e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  311. <tr><td colspan="2"><div class="groupHeader">Dynamic Type System</div></td></tr>
  312. <tr class="memitem:a2512f6d7054fcd0066be6ca39a4bc475" id="r_a2512f6d7054fcd0066be6ca39a4bc475"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a2512f6d7054fcd0066be6ca39a4bc475">setData</a> (S32 type, void *dptr, S32 index, S32 argc, const char **argv, <a class="el" href="struct_enum_table.html">EnumTable</a> *tbl, <a class="el" href="class_bit_set32.html">BitSet32</a> flag)</td></tr>
  313. <tr class="separator:a2512f6d7054fcd0066be6ca39a4bc475"><td class="memSeparator" colspan="2">&#160;</td></tr>
  314. <tr class="memitem:aa4eb7e2dc05afc3db75676be3834c756" id="r_aa4eb7e2dc05afc3db75676be3834c756"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#aa4eb7e2dc05afc3db75676be3834c756">getData</a> (S32 type, void *dptr, S32 index, <a class="el" href="struct_enum_table.html">EnumTable</a> *tbl, <a class="el" href="class_bit_set32.html">BitSet32</a> flag)</td></tr>
  315. <tr class="separator:aa4eb7e2dc05afc3db75676be3834c756"><td class="memSeparator" colspan="2">&#160;</td></tr>
  316. </table><table class="memberdecls">
  317. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
  318. Variables</h2></td></tr>
  319. <tr><td colspan="2"><div class="groupHeader"></div></td></tr>
  320. <tr class="memitem:a7589f755bdcac5afcff4a6bf7fa542a2" id="r_a7589f755bdcac5afcff4a6bf7fa542a2"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a7589f755bdcac5afcff4a6bf7fa542a2">gCurrentFile</a></td></tr>
  321. <tr class="separator:a7589f755bdcac5afcff4a6bf7fa542a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  322. <tr class="memitem:a83de8ac9ca13363b9f70ab5a09098e82" id="r_a83de8ac9ca13363b9f70ab5a09098e82"><td class="memItemLeft" align="right" valign="top">StringTableEntry&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_con.html#a83de8ac9ca13363b9f70ab5a09098e82">gCurrentRoot</a></td></tr>
  323. <tr class="separator:a83de8ac9ca13363b9f70ab5a09098e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  324. </table>
  325. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  326. <div class="textblock"><p>This namespace contains the core of the console functionality.</p>
  327. <h1><a class="anchor" id="con_intro"></a>
  328. Introduction</h1>
  329. <p>The console is a key part of <a class="el" href="namespace_torque.html">Torque</a>'s architecture. It allows direct run-time control of many aspects of the engine. </p>
  330. </div><h2 class="groupheader">Typedef Documentation</h2>
  331. <a id="a9f19521452a2a20b0e75df991b4bd8c7" name="a9f19521452a2a20b0e75df991b4bd8c7"></a>
  332. <h2 class="memtitle"><span class="permalink"><a href="#a9f19521452a2a20b0e75df991b4bd8c7">&#9670;&#160;</a></span>typePathExpandoMap</h2>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname">typedef <a class="el" href="class_hash_map.html">HashMap</a>&lt;StringTableEntry, StringTableEntry&gt; <a class="el" href="namespace_con.html#a9f19521452a2a20b0e75df991b4bd8c7">typePathExpandoMap</a></td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. </div>
  342. </div>
  343. <h2 class="groupheader">Enumeration Type Documentation</h2>
  344. <a id="a198b8c2c77ea9f9815a181ddeda1c320" name="a198b8c2c77ea9f9815a181ddeda1c320"></a>
  345. <h2 class="memtitle"><span class="permalink"><a href="#a198b8c2c77ea9f9815a181ddeda1c320">&#9670;&#160;</a></span>Constants</h2>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">enum <a class="el" href="namespace_con.html#a198b8c2c77ea9f9815a181ddeda1c320">Constants</a></td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Various configuration constants. </p>
  355. <table class="fieldtable">
  356. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a198b8c2c77ea9f9815a181ddeda1c320afb839de9272a0ef76db2f9e8b8195638" name="a198b8c2c77ea9f9815a181ddeda1c320afb839de9272a0ef76db2f9e8b8195638"></a>DSOVersion&#160;</td><td class="fielddoc"><p>This is the version number associated with DSO files. </p><pre class="fragment"> If you make any changes to the way the scripting language works
  357. (such as DSO format changes, adding/removing op-codes) that would
  358. break compatibility, then you should increment this.
  359. If you make a really major change, increment it to the next multiple
  360. of ten.
  361. 12/29/04 - BJG - 33-&gt;34 Removed some opcodes, part of namespace upgrade.
  362. 12/30/04 - BJG - 34-&gt;35 Reordered some things, further general shuffling.
  363. 11/03/05 - BJG - 35-&gt;36 Integrated new debugger code.
  364. </pre> </td></tr>
  365. <tr><td class="fieldname"><a id="a198b8c2c77ea9f9815a181ddeda1c320a4479fc6451d3142aaaa94f6de153b2ad" name="a198b8c2c77ea9f9815a181ddeda1c320a4479fc6451d3142aaaa94f6de153b2ad"></a>MaxLineLength&#160;</td><td class="fielddoc"><p>Maximum length of a line of console input. </p>
  366. </td></tr>
  367. <tr><td class="fieldname"><a id="a198b8c2c77ea9f9815a181ddeda1c320a871a196095500379a8442e2b9558fdad" name="a198b8c2c77ea9f9815a181ddeda1c320a871a196095500379a8442e2b9558fdad"></a>MaxDataTypes&#160;</td><td class="fielddoc"><p>Maximum number of registered data types. </p>
  368. </td></tr>
  369. </table>
  370. </div>
  371. </div>
  372. <h2 class="groupheader">Function Documentation</h2>
  373. <a id="a7d5079dbd4f29f45e244e7aaf0611c46" name="a7d5079dbd4f29f45e244e7aaf0611c46"></a>
  374. <h2 class="memtitle"><span class="permalink"><a href="#a7d5079dbd4f29f45e244e7aaf0611c46">&#9670;&#160;</a></span>addCommand() <span class="overload">[1/10]</span></h2>
  375. <div class="memitem">
  376. <div class="memproto">
  377. <table class="memname">
  378. <tr>
  379. <td class="memname">void addCommand </td>
  380. <td>(</td>
  381. <td class="paramtype">const char *&#160;</td>
  382. <td class="paramname"><em>name</em>, </td>
  383. </tr>
  384. <tr>
  385. <td class="paramkey"></td>
  386. <td></td>
  387. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga3daa15ec563ddf01edfcf67f9515cf89">BoolCallback</a>&#160;</td>
  388. <td class="paramname"><em>cb</em>, </td>
  389. </tr>
  390. <tr>
  391. <td class="paramkey"></td>
  392. <td></td>
  393. <td class="paramtype">const char *&#160;</td>
  394. <td class="paramname"><em>usage</em>, </td>
  395. </tr>
  396. <tr>
  397. <td class="paramkey"></td>
  398. <td></td>
  399. <td class="paramtype">S32&#160;</td>
  400. <td class="paramname"><em>minArgs</em>, </td>
  401. </tr>
  402. <tr>
  403. <td class="paramkey"></td>
  404. <td></td>
  405. <td class="paramtype">S32&#160;</td>
  406. <td class="paramname"><em>maxArgs</em>&#160;</td>
  407. </tr>
  408. <tr>
  409. <td></td>
  410. <td>)</td>
  411. <td></td><td></td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p></p>
  416. <p>Register a C++ function with the console making it a global function callable from the scripting engine.</p>
  417. <dl class="params"><dt>Parameters</dt><dd>
  418. <table class="params">
  419. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  420. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  421. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  422. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  423. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  424. </table>
  425. </dd>
  426. </dl>
  427. </div>
  428. </div>
  429. <a id="af142b271baa302bafe36c9a1574c4b71" name="af142b271baa302bafe36c9a1574c4b71"></a>
  430. <h2 class="memtitle"><span class="permalink"><a href="#af142b271baa302bafe36c9a1574c4b71">&#9670;&#160;</a></span>addCommand() <span class="overload">[2/10]</span></h2>
  431. <div class="memitem">
  432. <div class="memproto">
  433. <table class="memname">
  434. <tr>
  435. <td class="memname">void addCommand </td>
  436. <td>(</td>
  437. <td class="paramtype">const char *&#160;</td>
  438. <td class="paramname"><em>name</em>, </td>
  439. </tr>
  440. <tr>
  441. <td class="paramkey"></td>
  442. <td></td>
  443. <td class="paramtype"><a class="el" href="group__console__callbacks.html#gacea87d3b8941b7ffcea991099d630d3a">FloatCallback</a>&#160;</td>
  444. <td class="paramname"><em>cb</em>, </td>
  445. </tr>
  446. <tr>
  447. <td class="paramkey"></td>
  448. <td></td>
  449. <td class="paramtype">const char *&#160;</td>
  450. <td class="paramname"><em>usage</em>, </td>
  451. </tr>
  452. <tr>
  453. <td class="paramkey"></td>
  454. <td></td>
  455. <td class="paramtype">S32&#160;</td>
  456. <td class="paramname"><em>minArgs</em>, </td>
  457. </tr>
  458. <tr>
  459. <td class="paramkey"></td>
  460. <td></td>
  461. <td class="paramtype">S32&#160;</td>
  462. <td class="paramname"><em>maxArgs</em>&#160;</td>
  463. </tr>
  464. <tr>
  465. <td></td>
  466. <td>)</td>
  467. <td></td><td></td>
  468. </tr>
  469. </table>
  470. </div><div class="memdoc">
  471. <p></p>
  472. <p>Register a C++ function with the console making it a global function callable from the scripting engine.</p>
  473. <dl class="params"><dt>Parameters</dt><dd>
  474. <table class="params">
  475. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  476. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  477. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  478. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  479. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  480. </table>
  481. </dd>
  482. </dl>
  483. </div>
  484. </div>
  485. <a id="ab3a3d2021690b554ff5c2d2eb757f5df" name="ab3a3d2021690b554ff5c2d2eb757f5df"></a>
  486. <h2 class="memtitle"><span class="permalink"><a href="#ab3a3d2021690b554ff5c2d2eb757f5df">&#9670;&#160;</a></span>addCommand() <span class="overload">[3/10]</span></h2>
  487. <div class="memitem">
  488. <div class="memproto">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname">void addCommand </td>
  492. <td>(</td>
  493. <td class="paramtype">const char *&#160;</td>
  494. <td class="paramname"><em>name</em>, </td>
  495. </tr>
  496. <tr>
  497. <td class="paramkey"></td>
  498. <td></td>
  499. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga82b43b62df148a3ef01de7f8e8035d58">IntCallback</a>&#160;</td>
  500. <td class="paramname"><em>cb</em>, </td>
  501. </tr>
  502. <tr>
  503. <td class="paramkey"></td>
  504. <td></td>
  505. <td class="paramtype">const char *&#160;</td>
  506. <td class="paramname"><em>usage</em>, </td>
  507. </tr>
  508. <tr>
  509. <td class="paramkey"></td>
  510. <td></td>
  511. <td class="paramtype">S32&#160;</td>
  512. <td class="paramname"><em>minArgs</em>, </td>
  513. </tr>
  514. <tr>
  515. <td class="paramkey"></td>
  516. <td></td>
  517. <td class="paramtype">S32&#160;</td>
  518. <td class="paramname"><em>maxArg</em>&#160;</td>
  519. </tr>
  520. <tr>
  521. <td></td>
  522. <td>)</td>
  523. <td></td><td></td>
  524. </tr>
  525. </table>
  526. </div><div class="memdoc">
  527. <p></p>
  528. <p>Register a C++ function with the console making it a global function callable from the scripting engine.</p>
  529. <dl class="params"><dt>Parameters</dt><dd>
  530. <table class="params">
  531. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  532. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  533. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  534. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  535. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  536. </table>
  537. </dd>
  538. </dl>
  539. </div>
  540. </div>
  541. <a id="adaa9f527b251884d3f31ed37b141db74" name="adaa9f527b251884d3f31ed37b141db74"></a>
  542. <h2 class="memtitle"><span class="permalink"><a href="#adaa9f527b251884d3f31ed37b141db74">&#9670;&#160;</a></span>addCommand() <span class="overload">[4/10]</span></h2>
  543. <div class="memitem">
  544. <div class="memproto">
  545. <table class="memname">
  546. <tr>
  547. <td class="memname">void addCommand </td>
  548. <td>(</td>
  549. <td class="paramtype">const char *&#160;</td>
  550. <td class="paramname"><em>name</em>, </td>
  551. </tr>
  552. <tr>
  553. <td class="paramkey"></td>
  554. <td></td>
  555. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga3b1618755db8dcc0264d9adbd7944801">StringCallback</a>&#160;</td>
  556. <td class="paramname"><em>cb</em>, </td>
  557. </tr>
  558. <tr>
  559. <td class="paramkey"></td>
  560. <td></td>
  561. <td class="paramtype">const char *&#160;</td>
  562. <td class="paramname"><em>usage</em>, </td>
  563. </tr>
  564. <tr>
  565. <td class="paramkey"></td>
  566. <td></td>
  567. <td class="paramtype">S32&#160;</td>
  568. <td class="paramname"><em>minArgs</em>, </td>
  569. </tr>
  570. <tr>
  571. <td class="paramkey"></td>
  572. <td></td>
  573. <td class="paramtype">S32&#160;</td>
  574. <td class="paramname"><em>maxArgs</em>&#160;</td>
  575. </tr>
  576. <tr>
  577. <td></td>
  578. <td>)</td>
  579. <td></td><td></td>
  580. </tr>
  581. </table>
  582. </div><div class="memdoc">
  583. <p>Register a C++ function with the console making it a global function callable from the scripting engine.</p>
  584. <dl class="params"><dt>Parameters</dt><dd>
  585. <table class="params">
  586. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  587. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  588. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  589. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  590. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  591. </table>
  592. </dd>
  593. </dl>
  594. </div>
  595. </div>
  596. <a id="a2dece2ce768b744138d1182ed7a1e9ab" name="a2dece2ce768b744138d1182ed7a1e9ab"></a>
  597. <h2 class="memtitle"><span class="permalink"><a href="#a2dece2ce768b744138d1182ed7a1e9ab">&#9670;&#160;</a></span>addCommand() <span class="overload">[5/10]</span></h2>
  598. <div class="memitem">
  599. <div class="memproto">
  600. <table class="memname">
  601. <tr>
  602. <td class="memname">void addCommand </td>
  603. <td>(</td>
  604. <td class="paramtype">const char *&#160;</td>
  605. <td class="paramname"><em>name</em>, </td>
  606. </tr>
  607. <tr>
  608. <td class="paramkey"></td>
  609. <td></td>
  610. <td class="paramtype"><a class="el" href="group__console__callbacks.html#gae7bde538b4003b19dca7a9279b5f79b6">VoidCallback</a>&#160;</td>
  611. <td class="paramname"><em>cb</em>, </td>
  612. </tr>
  613. <tr>
  614. <td class="paramkey"></td>
  615. <td></td>
  616. <td class="paramtype">const char *&#160;</td>
  617. <td class="paramname"><em>usage</em>, </td>
  618. </tr>
  619. <tr>
  620. <td class="paramkey"></td>
  621. <td></td>
  622. <td class="paramtype">S32&#160;</td>
  623. <td class="paramname"><em>minArgs</em>, </td>
  624. </tr>
  625. <tr>
  626. <td class="paramkey"></td>
  627. <td></td>
  628. <td class="paramtype">S32&#160;</td>
  629. <td class="paramname"><em>maxArgs</em>&#160;</td>
  630. </tr>
  631. <tr>
  632. <td></td>
  633. <td>)</td>
  634. <td></td><td></td>
  635. </tr>
  636. </table>
  637. </div><div class="memdoc">
  638. <p></p>
  639. <p>Register a C++ function with the console making it a global function callable from the scripting engine.</p>
  640. <dl class="params"><dt>Parameters</dt><dd>
  641. <table class="params">
  642. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  643. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  644. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  645. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  646. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  647. </table>
  648. </dd>
  649. </dl>
  650. </div>
  651. </div>
  652. <a id="a85b1aa25b35f3fca854b14f328b492e9" name="a85b1aa25b35f3fca854b14f328b492e9"></a>
  653. <h2 class="memtitle"><span class="permalink"><a href="#a85b1aa25b35f3fca854b14f328b492e9">&#9670;&#160;</a></span>addCommand() <span class="overload">[6/10]</span></h2>
  654. <div class="memitem">
  655. <div class="memproto">
  656. <table class="memname">
  657. <tr>
  658. <td class="memname">void addCommand </td>
  659. <td>(</td>
  660. <td class="paramtype">const char *&#160;</td>
  661. <td class="paramname"><em>nameSpace</em>, </td>
  662. </tr>
  663. <tr>
  664. <td class="paramkey"></td>
  665. <td></td>
  666. <td class="paramtype">const char *&#160;</td>
  667. <td class="paramname"><em>name</em>, </td>
  668. </tr>
  669. <tr>
  670. <td class="paramkey"></td>
  671. <td></td>
  672. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga3daa15ec563ddf01edfcf67f9515cf89">BoolCallback</a>&#160;</td>
  673. <td class="paramname"><em>cb</em>, </td>
  674. </tr>
  675. <tr>
  676. <td class="paramkey"></td>
  677. <td></td>
  678. <td class="paramtype">const char *&#160;</td>
  679. <td class="paramname"><em>usage</em>, </td>
  680. </tr>
  681. <tr>
  682. <td class="paramkey"></td>
  683. <td></td>
  684. <td class="paramtype">S32&#160;</td>
  685. <td class="paramname"><em>minArgs</em>, </td>
  686. </tr>
  687. <tr>
  688. <td class="paramkey"></td>
  689. <td></td>
  690. <td class="paramtype">S32&#160;</td>
  691. <td class="paramname"><em>maxArgs</em>&#160;</td>
  692. </tr>
  693. <tr>
  694. <td></td>
  695. <td>)</td>
  696. <td></td><td></td>
  697. </tr>
  698. </table>
  699. </div><div class="memdoc">
  700. <p></p>
  701. <p>Register a C++ function with the console making it callable as a method of the given namespace from the scripting engine.</p>
  702. <dl class="params"><dt>Parameters</dt><dd>
  703. <table class="params">
  704. <tr><td class="paramname">nameSpace</td><td>Name of the namespace to associate the new function with; this is usually the name of a class. </td></tr>
  705. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  706. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  707. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  708. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  709. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  710. </table>
  711. </dd>
  712. </dl>
  713. </div>
  714. </div>
  715. <a id="af56a446c7ec8b5d74c63f8f9881cb062" name="af56a446c7ec8b5d74c63f8f9881cb062"></a>
  716. <h2 class="memtitle"><span class="permalink"><a href="#af56a446c7ec8b5d74c63f8f9881cb062">&#9670;&#160;</a></span>addCommand() <span class="overload">[7/10]</span></h2>
  717. <div class="memitem">
  718. <div class="memproto">
  719. <table class="memname">
  720. <tr>
  721. <td class="memname">void addCommand </td>
  722. <td>(</td>
  723. <td class="paramtype">const char *&#160;</td>
  724. <td class="paramname"><em>nameSpace</em>, </td>
  725. </tr>
  726. <tr>
  727. <td class="paramkey"></td>
  728. <td></td>
  729. <td class="paramtype">const char *&#160;</td>
  730. <td class="paramname"><em>name</em>, </td>
  731. </tr>
  732. <tr>
  733. <td class="paramkey"></td>
  734. <td></td>
  735. <td class="paramtype"><a class="el" href="group__console__callbacks.html#gacea87d3b8941b7ffcea991099d630d3a">FloatCallback</a>&#160;</td>
  736. <td class="paramname"><em>cb</em>, </td>
  737. </tr>
  738. <tr>
  739. <td class="paramkey"></td>
  740. <td></td>
  741. <td class="paramtype">const char *&#160;</td>
  742. <td class="paramname"><em>usage</em>, </td>
  743. </tr>
  744. <tr>
  745. <td class="paramkey"></td>
  746. <td></td>
  747. <td class="paramtype">S32&#160;</td>
  748. <td class="paramname"><em>minArgs</em>, </td>
  749. </tr>
  750. <tr>
  751. <td class="paramkey"></td>
  752. <td></td>
  753. <td class="paramtype">S32&#160;</td>
  754. <td class="paramname"><em>maxArgs</em>&#160;</td>
  755. </tr>
  756. <tr>
  757. <td></td>
  758. <td>)</td>
  759. <td></td><td></td>
  760. </tr>
  761. </table>
  762. </div><div class="memdoc">
  763. <p></p>
  764. <p>Register a C++ function with the console making it callable as a method of the given namespace from the scripting engine.</p>
  765. <dl class="params"><dt>Parameters</dt><dd>
  766. <table class="params">
  767. <tr><td class="paramname">nameSpace</td><td>Name of the namespace to associate the new function with; this is usually the name of a class. </td></tr>
  768. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  769. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  770. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  771. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  772. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  773. </table>
  774. </dd>
  775. </dl>
  776. </div>
  777. </div>
  778. <a id="a8540dd6e3e93909e45dec01ee821e8cb" name="a8540dd6e3e93909e45dec01ee821e8cb"></a>
  779. <h2 class="memtitle"><span class="permalink"><a href="#a8540dd6e3e93909e45dec01ee821e8cb">&#9670;&#160;</a></span>addCommand() <span class="overload">[8/10]</span></h2>
  780. <div class="memitem">
  781. <div class="memproto">
  782. <table class="memname">
  783. <tr>
  784. <td class="memname">void addCommand </td>
  785. <td>(</td>
  786. <td class="paramtype">const char *&#160;</td>
  787. <td class="paramname"><em>nameSpace</em>, </td>
  788. </tr>
  789. <tr>
  790. <td class="paramkey"></td>
  791. <td></td>
  792. <td class="paramtype">const char *&#160;</td>
  793. <td class="paramname"><em>name</em>, </td>
  794. </tr>
  795. <tr>
  796. <td class="paramkey"></td>
  797. <td></td>
  798. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga82b43b62df148a3ef01de7f8e8035d58">IntCallback</a>&#160;</td>
  799. <td class="paramname"><em>cb</em>, </td>
  800. </tr>
  801. <tr>
  802. <td class="paramkey"></td>
  803. <td></td>
  804. <td class="paramtype">const char *&#160;</td>
  805. <td class="paramname"><em>usage</em>, </td>
  806. </tr>
  807. <tr>
  808. <td class="paramkey"></td>
  809. <td></td>
  810. <td class="paramtype">S32&#160;</td>
  811. <td class="paramname"><em>minArgs</em>, </td>
  812. </tr>
  813. <tr>
  814. <td class="paramkey"></td>
  815. <td></td>
  816. <td class="paramtype">S32&#160;</td>
  817. <td class="paramname"><em>maxArgs</em>&#160;</td>
  818. </tr>
  819. <tr>
  820. <td></td>
  821. <td>)</td>
  822. <td></td><td></td>
  823. </tr>
  824. </table>
  825. </div><div class="memdoc">
  826. <p></p>
  827. <p>Register a C++ function with the console making it callable as a method of the given namespace from the scripting engine.</p>
  828. <dl class="params"><dt>Parameters</dt><dd>
  829. <table class="params">
  830. <tr><td class="paramname">nameSpace</td><td>Name of the namespace to associate the new function with; this is usually the name of a class. </td></tr>
  831. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  832. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  833. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  834. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  835. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  836. </table>
  837. </dd>
  838. </dl>
  839. </div>
  840. </div>
  841. <a id="aac84e5f08163aa8046cc6d7483bf619a" name="aac84e5f08163aa8046cc6d7483bf619a"></a>
  842. <h2 class="memtitle"><span class="permalink"><a href="#aac84e5f08163aa8046cc6d7483bf619a">&#9670;&#160;</a></span>addCommand() <span class="overload">[9/10]</span></h2>
  843. <div class="memitem">
  844. <div class="memproto">
  845. <table class="memname">
  846. <tr>
  847. <td class="memname">void addCommand </td>
  848. <td>(</td>
  849. <td class="paramtype">const char *&#160;</td>
  850. <td class="paramname"><em>nameSpace</em>, </td>
  851. </tr>
  852. <tr>
  853. <td class="paramkey"></td>
  854. <td></td>
  855. <td class="paramtype">const char *&#160;</td>
  856. <td class="paramname"><em>name</em>, </td>
  857. </tr>
  858. <tr>
  859. <td class="paramkey"></td>
  860. <td></td>
  861. <td class="paramtype"><a class="el" href="group__console__callbacks.html#gae7bde538b4003b19dca7a9279b5f79b6">VoidCallback</a>&#160;</td>
  862. <td class="paramname"><em>cb</em>, </td>
  863. </tr>
  864. <tr>
  865. <td class="paramkey"></td>
  866. <td></td>
  867. <td class="paramtype">const char *&#160;</td>
  868. <td class="paramname"><em>usage</em>, </td>
  869. </tr>
  870. <tr>
  871. <td class="paramkey"></td>
  872. <td></td>
  873. <td class="paramtype">S32&#160;</td>
  874. <td class="paramname"><em>minArgs</em>, </td>
  875. </tr>
  876. <tr>
  877. <td class="paramkey"></td>
  878. <td></td>
  879. <td class="paramtype">S32&#160;</td>
  880. <td class="paramname"><em>maxArgs</em>&#160;</td>
  881. </tr>
  882. <tr>
  883. <td></td>
  884. <td>)</td>
  885. <td></td><td></td>
  886. </tr>
  887. </table>
  888. </div><div class="memdoc">
  889. <p></p>
  890. <p>Register a C++ function with the console making it callable as a method of the given namespace from the scripting engine.</p>
  891. <dl class="params"><dt>Parameters</dt><dd>
  892. <table class="params">
  893. <tr><td class="paramname">nameSpace</td><td>Name of the namespace to associate the new function with; this is usually the name of a class. </td></tr>
  894. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  895. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  896. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  897. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  898. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  899. </table>
  900. </dd>
  901. </dl>
  902. </div>
  903. </div>
  904. <a id="afeb915f0af44d6f2a6bf5aab00898eef" name="afeb915f0af44d6f2a6bf5aab00898eef"></a>
  905. <h2 class="memtitle"><span class="permalink"><a href="#afeb915f0af44d6f2a6bf5aab00898eef">&#9670;&#160;</a></span>addCommand() <span class="overload">[10/10]</span></h2>
  906. <div class="memitem">
  907. <div class="memproto">
  908. <table class="memname">
  909. <tr>
  910. <td class="memname">void addCommand </td>
  911. <td>(</td>
  912. <td class="paramtype">const char *&#160;</td>
  913. <td class="paramname"><em>nameSpace</em>, </td>
  914. </tr>
  915. <tr>
  916. <td class="paramkey"></td>
  917. <td></td>
  918. <td class="paramtype">const char *&#160;</td>
  919. <td class="paramname"><em>name</em>, </td>
  920. </tr>
  921. <tr>
  922. <td class="paramkey"></td>
  923. <td></td>
  924. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga3b1618755db8dcc0264d9adbd7944801">StringCallback</a>&#160;</td>
  925. <td class="paramname"><em>cb</em>, </td>
  926. </tr>
  927. <tr>
  928. <td class="paramkey"></td>
  929. <td></td>
  930. <td class="paramtype">const char *&#160;</td>
  931. <td class="paramname"><em>usage</em>, </td>
  932. </tr>
  933. <tr>
  934. <td class="paramkey"></td>
  935. <td></td>
  936. <td class="paramtype">S32&#160;</td>
  937. <td class="paramname"><em>minArgs</em>, </td>
  938. </tr>
  939. <tr>
  940. <td class="paramkey"></td>
  941. <td></td>
  942. <td class="paramtype">S32&#160;</td>
  943. <td class="paramname"><em>maxArgs</em>&#160;</td>
  944. </tr>
  945. <tr>
  946. <td></td>
  947. <td>)</td>
  948. <td></td><td></td>
  949. </tr>
  950. </table>
  951. </div><div class="memdoc">
  952. <p>Register a C++ function with the console making it callable as a method of the given namespace from the scripting engine.</p>
  953. <dl class="params"><dt>Parameters</dt><dd>
  954. <table class="params">
  955. <tr><td class="paramname">nameSpace</td><td>Name of the namespace to associate the new function with; this is usually the name of a class. </td></tr>
  956. <tr><td class="paramname">name</td><td>Name of the new function. </td></tr>
  957. <tr><td class="paramname">cb</td><td>Pointer to the function implementing the scripting call; a console callback function returning a specific type value. </td></tr>
  958. <tr><td class="paramname">usage</td><td>Documentation for this function. <a class="el" href="console_autodoc.html">Console Auto-Documentation</a> </td></tr>
  959. <tr><td class="paramname">minArgs</td><td>Minimum number of arguments this function accepts </td></tr>
  960. <tr><td class="paramname">maxArgs</td><td>Maximum number of arguments this function accepts </td></tr>
  961. </table>
  962. </dd>
  963. </dl>
  964. </div>
  965. </div>
  966. <a id="a648038e7c75ddf17ab4ca01ffa347d27" name="a648038e7c75ddf17ab4ca01ffa347d27"></a>
  967. <h2 class="memtitle"><span class="permalink"><a href="#a648038e7c75ddf17ab4ca01ffa347d27">&#9670;&#160;</a></span>addConsumer()</h2>
  968. <div class="memitem">
  969. <div class="memproto">
  970. <table class="memname">
  971. <tr>
  972. <td class="memname">void addConsumer </td>
  973. <td>(</td>
  974. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga73457ddc96b5e0366926bfd1f6c762ce">ConsumerCallback</a>&#160;</td>
  975. <td class="paramname"><em>consumer</em></td><td>)</td>
  976. <td></td>
  977. </tr>
  978. </table>
  979. </div><div class="memdoc">
  980. </div>
  981. </div>
  982. <a id="a0041d41e4a4f919e6540d811d6550d6d" name="a0041d41e4a4f919e6540d811d6550d6d"></a>
  983. <h2 class="memtitle"><span class="permalink"><a href="#a0041d41e4a4f919e6540d811d6550d6d">&#9670;&#160;</a></span>addOverload()</h2>
  984. <div class="memitem">
  985. <div class="memproto">
  986. <table class="memname">
  987. <tr>
  988. <td class="memname">void addOverload </td>
  989. <td>(</td>
  990. <td class="paramtype">const char *&#160;</td>
  991. <td class="paramname"><em>nsName</em>, </td>
  992. </tr>
  993. <tr>
  994. <td class="paramkey"></td>
  995. <td></td>
  996. <td class="paramtype">const char *&#160;</td>
  997. <td class="paramname"><em>name</em>, </td>
  998. </tr>
  999. <tr>
  1000. <td class="paramkey"></td>
  1001. <td></td>
  1002. <td class="paramtype">const char *&#160;</td>
  1003. <td class="paramname"><em>altUsage</em>&#160;</td>
  1004. </tr>
  1005. <tr>
  1006. <td></td>
  1007. <td>)</td>
  1008. <td></td><td></td>
  1009. </tr>
  1010. </table>
  1011. </div><div class="memdoc">
  1012. <dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd></dd></dl>
  1013. </div>
  1014. </div>
  1015. <a id="a90e867fb7cb7be0c5be5b2a48121e3f8" name="a90e867fb7cb7be0c5be5b2a48121e3f8"></a>
  1016. <h2 class="memtitle"><span class="permalink"><a href="#a90e867fb7cb7be0c5be5b2a48121e3f8">&#9670;&#160;</a></span>addPathExpando()</h2>
  1017. <div class="memitem">
  1018. <div class="memproto">
  1019. <table class="memname">
  1020. <tr>
  1021. <td class="memname">void addPathExpando </td>
  1022. <td>(</td>
  1023. <td class="paramtype">const char *&#160;</td>
  1024. <td class="paramname"><em>pExpandoName</em>, </td>
  1025. </tr>
  1026. <tr>
  1027. <td class="paramkey"></td>
  1028. <td></td>
  1029. <td class="paramtype">const char *&#160;</td>
  1030. <td class="paramname"><em>pPath</em>&#160;</td>
  1031. </tr>
  1032. <tr>
  1033. <td></td>
  1034. <td>)</td>
  1035. <td></td><td></td>
  1036. </tr>
  1037. </table>
  1038. </div><div class="memdoc">
  1039. </div>
  1040. </div>
  1041. <a id="a72b63f75173e2818ec56be71ea96104c" name="a72b63f75173e2818ec56be71ea96104c"></a>
  1042. <h2 class="memtitle"><span class="permalink"><a href="#a72b63f75173e2818ec56be71ea96104c">&#9670;&#160;</a></span>addVariable()</h2>
  1043. <div class="memitem">
  1044. <div class="memproto">
  1045. <table class="memname">
  1046. <tr>
  1047. <td class="memname">bool addVariable </td>
  1048. <td>(</td>
  1049. <td class="paramtype">const char *&#160;</td>
  1050. <td class="paramname"><em>name</em>, </td>
  1051. </tr>
  1052. <tr>
  1053. <td class="paramkey"></td>
  1054. <td></td>
  1055. <td class="paramtype">S32&#160;</td>
  1056. <td class="paramname"><em>type</em>, </td>
  1057. </tr>
  1058. <tr>
  1059. <td class="paramkey"></td>
  1060. <td></td>
  1061. <td class="paramtype">void *&#160;</td>
  1062. <td class="paramname"><em>pointer</em>&#160;</td>
  1063. </tr>
  1064. <tr>
  1065. <td></td>
  1066. <td>)</td>
  1067. <td></td><td></td>
  1068. </tr>
  1069. </table>
  1070. </div><div class="memdoc">
  1071. <p>Add a console variable that references the value of a variable in C++ code.</p>
  1072. <p>If a value is assigned to the console variable the C++ variable is updated, and vice-versa.</p>
  1073. <dl class="params"><dt>Parameters</dt><dd>
  1074. <table class="params">
  1075. <tr><td class="paramname">name</td><td>Global console variable name to create </td></tr>
  1076. <tr><td class="paramname">type</td><td>The type of the C++ variable; see the ConsoleDynamicTypes enum for a complete list. </td></tr>
  1077. <tr><td class="paramname">pointer</td><td>Pointer to the variable. </td></tr>
  1078. </table>
  1079. </dd>
  1080. </dl>
  1081. <dl class="section see"><dt>See also</dt><dd>ConsoleDynamicTypes </dd></dl>
  1082. </div>
  1083. </div>
  1084. <a id="aa69afcece9fc960512f77667f76c1f9a" name="aa69afcece9fc960512f77667f76c1f9a"></a>
  1085. <h2 class="memtitle"><span class="permalink"><a href="#aa69afcece9fc960512f77667f76c1f9a">&#9670;&#160;</a></span>beginCommandGroup()</h2>
  1086. <div class="memitem">
  1087. <div class="memproto">
  1088. <table class="memname">
  1089. <tr>
  1090. <td class="memname">void beginCommandGroup </td>
  1091. <td>(</td>
  1092. <td class="paramtype">const char *&#160;</td>
  1093. <td class="paramname"><em>nsName</em>, </td>
  1094. </tr>
  1095. <tr>
  1096. <td class="paramkey"></td>
  1097. <td></td>
  1098. <td class="paramtype">const char *&#160;</td>
  1099. <td class="paramname"><em>name</em>, </td>
  1100. </tr>
  1101. <tr>
  1102. <td class="paramkey"></td>
  1103. <td></td>
  1104. <td class="paramtype">const char *&#160;</td>
  1105. <td class="paramname"><em>usage</em>&#160;</td>
  1106. </tr>
  1107. <tr>
  1108. <td></td>
  1109. <td>)</td>
  1110. <td></td><td></td>
  1111. </tr>
  1112. </table>
  1113. </div><div class="memdoc">
  1114. </div>
  1115. </div>
  1116. <a id="a0960f95cb63f7d78a67fe99dba4c29e4" name="a0960f95cb63f7d78a67fe99dba4c29e4"></a>
  1117. <h2 class="memtitle"><span class="permalink"><a href="#a0960f95cb63f7d78a67fe99dba4c29e4">&#9670;&#160;</a></span>classLinkNamespaces()</h2>
  1118. <div class="memitem">
  1119. <div class="memproto">
  1120. <table class="memname">
  1121. <tr>
  1122. <td class="memname">bool classLinkNamespaces </td>
  1123. <td>(</td>
  1124. <td class="paramtype"><a class="el" href="class_namespace.html">Namespace</a> *&#160;</td>
  1125. <td class="paramname"><em>parent</em>, </td>
  1126. </tr>
  1127. <tr>
  1128. <td class="paramkey"></td>
  1129. <td></td>
  1130. <td class="paramtype"><a class="el" href="class_namespace.html">Namespace</a> *&#160;</td>
  1131. <td class="paramname"><em>child</em>&#160;</td>
  1132. </tr>
  1133. <tr>
  1134. <td></td>
  1135. <td>)</td>
  1136. <td></td><td></td>
  1137. </tr>
  1138. </table>
  1139. </div><div class="memdoc">
  1140. <dl class="section note"><dt>Note</dt><dd>This should only be called from consoleObject.h </dd></dl>
  1141. </div>
  1142. </div>
  1143. <a id="ae5f15506155750b79c8ceb1d9e86d34c" name="ae5f15506155750b79c8ceb1d9e86d34c"></a>
  1144. <h2 class="memtitle"><span class="permalink"><a href="#ae5f15506155750b79c8ceb1d9e86d34c">&#9670;&#160;</a></span>cls()</h2>
  1145. <div class="memitem">
  1146. <div class="memproto">
  1147. <table class="memname">
  1148. <tr>
  1149. <td class="memname">void cls </td>
  1150. <td>(</td>
  1151. <td class="paramtype">void&#160;</td>
  1152. <td class="paramname"></td><td>)</td>
  1153. <td></td>
  1154. </tr>
  1155. </table>
  1156. </div><div class="memdoc">
  1157. <p>clear the console log </p>
  1158. </div>
  1159. </div>
  1160. <a id="a0cfdebebf927e430c9c5e76f0e575c67" name="a0cfdebebf927e430c9c5e76f0e575c67"></a>
  1161. <h2 class="memtitle"><span class="permalink"><a href="#a0cfdebebf927e430c9c5e76f0e575c67">&#9670;&#160;</a></span>collapsePath()</h2>
  1162. <div class="memitem">
  1163. <div class="memproto">
  1164. <table class="memname">
  1165. <tr>
  1166. <td class="memname">void collapsePath </td>
  1167. <td>(</td>
  1168. <td class="paramtype">char *&#160;</td>
  1169. <td class="paramname"><em>pDstPath</em>, </td>
  1170. </tr>
  1171. <tr>
  1172. <td class="paramkey"></td>
  1173. <td></td>
  1174. <td class="paramtype">U32&#160;</td>
  1175. <td class="paramname"><em>size</em>, </td>
  1176. </tr>
  1177. <tr>
  1178. <td class="paramkey"></td>
  1179. <td></td>
  1180. <td class="paramtype">const char *&#160;</td>
  1181. <td class="paramname"><em>pSrcPath</em>, </td>
  1182. </tr>
  1183. <tr>
  1184. <td class="paramkey"></td>
  1185. <td></td>
  1186. <td class="paramtype">const char *&#160;</td>
  1187. <td class="paramname"><em>pWorkingDirectoryHint</em>&#160;</td>
  1188. </tr>
  1189. <tr>
  1190. <td></td>
  1191. <td>)</td>
  1192. <td></td><td></td>
  1193. </tr>
  1194. </table>
  1195. </div><div class="memdoc">
  1196. </div>
  1197. </div>
  1198. <a id="a5c1fa7e18f9ef2a129564e741edbe5c1" name="a5c1fa7e18f9ef2a129564e741edbe5c1"></a>
  1199. <h2 class="memtitle"><span class="permalink"><a href="#a5c1fa7e18f9ef2a129564e741edbe5c1">&#9670;&#160;</a></span>endCommandGroup()</h2>
  1200. <div class="memitem">
  1201. <div class="memproto">
  1202. <table class="memname">
  1203. <tr>
  1204. <td class="memname">void endCommandGroup </td>
  1205. <td>(</td>
  1206. <td class="paramtype">const char *&#160;</td>
  1207. <td class="paramname"><em>nsName</em>, </td>
  1208. </tr>
  1209. <tr>
  1210. <td class="paramkey"></td>
  1211. <td></td>
  1212. <td class="paramtype">const char *&#160;</td>
  1213. <td class="paramname"><em>name</em>&#160;</td>
  1214. </tr>
  1215. <tr>
  1216. <td></td>
  1217. <td>)</td>
  1218. <td></td><td></td>
  1219. </tr>
  1220. </table>
  1221. </div><div class="memdoc">
  1222. </div>
  1223. </div>
  1224. <a id="a839910d8445542be1b6a4259b6fe453a" name="a839910d8445542be1b6a4259b6fe453a"></a>
  1225. <h2 class="memtitle"><span class="permalink"><a href="#a839910d8445542be1b6a4259b6fe453a">&#9670;&#160;</a></span>ensureTrailingSlash()</h2>
  1226. <div class="memitem">
  1227. <div class="memproto">
  1228. <table class="memname">
  1229. <tr>
  1230. <td class="memname">void ensureTrailingSlash </td>
  1231. <td>(</td>
  1232. <td class="paramtype">char *&#160;</td>
  1233. <td class="paramname"><em>pDstPath</em>, </td>
  1234. </tr>
  1235. <tr>
  1236. <td class="paramkey"></td>
  1237. <td></td>
  1238. <td class="paramtype">const char *&#160;</td>
  1239. <td class="paramname"><em>pSrcPath</em>&#160;</td>
  1240. </tr>
  1241. <tr>
  1242. <td></td>
  1243. <td>)</td>
  1244. <td></td><td></td>
  1245. </tr>
  1246. </table>
  1247. </div><div class="memdoc">
  1248. </div>
  1249. </div>
  1250. <a id="a392f9ee44bd2f1e06b87da3e621fdaed" name="a392f9ee44bd2f1e06b87da3e621fdaed"></a>
  1251. <h2 class="memtitle"><span class="permalink"><a href="#a392f9ee44bd2f1e06b87da3e621fdaed">&#9670;&#160;</a></span>errorf() <span class="overload">[1/2]</span></h2>
  1252. <div class="memitem">
  1253. <div class="memproto">
  1254. <table class="memname">
  1255. <tr>
  1256. <td class="memname">void errorf </td>
  1257. <td>(</td>
  1258. <td class="paramtype"><a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7">ConsoleLogEntry::Type</a>&#160;</td>
  1259. <td class="paramname"><em>type</em>, </td>
  1260. </tr>
  1261. <tr>
  1262. <td class="paramkey"></td>
  1263. <td></td>
  1264. <td class="paramtype">const char *&#160;</td>
  1265. <td class="paramname"><em>_format</em>, </td>
  1266. </tr>
  1267. <tr>
  1268. <td class="paramkey"></td>
  1269. <td></td>
  1270. <td class="paramtype">&#160;</td>
  1271. <td class="paramname"><em>...</em>&#160;</td>
  1272. </tr>
  1273. <tr>
  1274. <td></td>
  1275. <td>)</td>
  1276. <td></td><td></td>
  1277. </tr>
  1278. </table>
  1279. </div><div class="memdoc">
  1280. <dl class="section note"><dt>Note</dt><dd>The console window colors warning text as RED. </dd></dl>
  1281. <dl class="params"><dt>Parameters</dt><dd>
  1282. <table class="params">
  1283. <tr><td class="paramname">type</td><td>Allows you to associate the warning message with an internal module. </td></tr>
  1284. <tr><td class="paramname">_format</td><td>A stdlib printf style formatted out put string </td></tr>
  1285. <tr><td class="paramname">...</td><td>Variables to be written </td></tr>
  1286. </table>
  1287. </dd>
  1288. </dl>
  1289. <dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_con.html#a392f9ee44bd2f1e06b87da3e621fdaed">Con::errorf()</a> </dd></dl>
  1290. </div>
  1291. </div>
  1292. <a id="a81242a979f28bc6aa76d4a6bdc3fa707" name="a81242a979f28bc6aa76d4a6bdc3fa707"></a>
  1293. <h2 class="memtitle"><span class="permalink"><a href="#a81242a979f28bc6aa76d4a6bdc3fa707">&#9670;&#160;</a></span>errorf() <span class="overload">[2/2]</span></h2>
  1294. <div class="memitem">
  1295. <div class="memproto">
  1296. <table class="memname">
  1297. <tr>
  1298. <td class="memname">void errorf </td>
  1299. <td>(</td>
  1300. <td class="paramtype">const char *&#160;</td>
  1301. <td class="paramname"><em>_format</em>, </td>
  1302. </tr>
  1303. <tr>
  1304. <td class="paramkey"></td>
  1305. <td></td>
  1306. <td class="paramtype">&#160;</td>
  1307. <td class="paramname"><em>...</em>&#160;</td>
  1308. </tr>
  1309. <tr>
  1310. <td></td>
  1311. <td>)</td>
  1312. <td></td><td></td>
  1313. </tr>
  1314. </table>
  1315. </div><div class="memdoc">
  1316. <dl class="section note"><dt>Note</dt><dd>The console window colors warning text as RED. </dd></dl>
  1317. <dl class="params"><dt>Parameters</dt><dd>
  1318. <table class="params">
  1319. <tr><td class="paramname">_format</td><td>A stdlib printf style formatted out put string </td></tr>
  1320. <tr><td class="paramname">...</td><td>Variables to be written </td></tr>
  1321. </table>
  1322. </dd>
  1323. </dl>
  1324. </div>
  1325. </div>
  1326. <a id="a56d04d81661139edd6894e5d20aa76d8" name="a56d04d81661139edd6894e5d20aa76d8"></a>
  1327. <h2 class="memtitle"><span class="permalink"><a href="#a56d04d81661139edd6894e5d20aa76d8">&#9670;&#160;</a></span>evaluate()</h2>
  1328. <div class="memitem">
  1329. <div class="memproto">
  1330. <table class="memname">
  1331. <tr>
  1332. <td class="memname">const char * evaluate </td>
  1333. <td>(</td>
  1334. <td class="paramtype">const char *&#160;</td>
  1335. <td class="paramname"><em>string</em>, </td>
  1336. </tr>
  1337. <tr>
  1338. <td class="paramkey"></td>
  1339. <td></td>
  1340. <td class="paramtype">bool&#160;</td>
  1341. <td class="paramname"><em>echo</em> = <code>false</code>, </td>
  1342. </tr>
  1343. <tr>
  1344. <td class="paramkey"></td>
  1345. <td></td>
  1346. <td class="paramtype">const char *&#160;</td>
  1347. <td class="paramname"><em>fileName</em> = <code>NULL</code>&#160;</td>
  1348. </tr>
  1349. <tr>
  1350. <td></td>
  1351. <td>)</td>
  1352. <td></td><td></td>
  1353. </tr>
  1354. </table>
  1355. </div><div class="memdoc">
  1356. <p>Evaluate an arbitrary chunk of code.</p>
  1357. <dl class="params"><dt>Parameters</dt><dd>
  1358. <table class="params">
  1359. <tr><td class="paramname">string</td><td>Buffer containing code to execute. </td></tr>
  1360. <tr><td class="paramname">echo</td><td>Should we echo the string to the console? </td></tr>
  1361. <tr><td class="paramname">fileName</td><td>Indicate what file this code is coming from; used in error reporting and such. </td></tr>
  1362. </table>
  1363. </dd>
  1364. </dl>
  1365. </div>
  1366. </div>
  1367. <a id="ac139ad582656800381462591409276f6" name="ac139ad582656800381462591409276f6"></a>
  1368. <h2 class="memtitle"><span class="permalink"><a href="#ac139ad582656800381462591409276f6">&#9670;&#160;</a></span>evaluatef()</h2>
  1369. <div class="memitem">
  1370. <div class="memproto">
  1371. <table class="memname">
  1372. <tr>
  1373. <td class="memname">const char * evaluatef </td>
  1374. <td>(</td>
  1375. <td class="paramtype">const char *&#160;</td>
  1376. <td class="paramname"><em>string</em>, </td>
  1377. </tr>
  1378. <tr>
  1379. <td class="paramkey"></td>
  1380. <td></td>
  1381. <td class="paramtype">&#160;</td>
  1382. <td class="paramname"><em>...</em>&#160;</td>
  1383. </tr>
  1384. <tr>
  1385. <td></td>
  1386. <td>)</td>
  1387. <td></td><td></td>
  1388. </tr>
  1389. </table>
  1390. </div><div class="memdoc">
  1391. <p>Evaluate an arbitrary line of script.</p>
  1392. <p>This wraps dVsprintf(), so you can substitute parameters into the code being executed. </p>
  1393. </div>
  1394. </div>
  1395. <a id="a27b33db8c092259f68383935d89ab802" name="a27b33db8c092259f68383935d89ab802"></a>
  1396. <h2 class="memtitle"><span class="permalink"><a href="#a27b33db8c092259f68383935d89ab802">&#9670;&#160;</a></span>execute() <span class="overload">[1/2]</span></h2>
  1397. <div class="memitem">
  1398. <div class="memproto">
  1399. <table class="memname">
  1400. <tr>
  1401. <td class="memname">const char * execute </td>
  1402. <td>(</td>
  1403. <td class="paramtype">S32&#160;</td>
  1404. <td class="paramname"><em>argc</em>, </td>
  1405. </tr>
  1406. <tr>
  1407. <td class="paramkey"></td>
  1408. <td></td>
  1409. <td class="paramtype">const char *&#160;</td>
  1410. <td class="paramname"><em>argv</em>[]&#160;</td>
  1411. </tr>
  1412. <tr>
  1413. <td></td>
  1414. <td>)</td>
  1415. <td></td><td></td>
  1416. </tr>
  1417. </table>
  1418. </div><div class="memdoc">
  1419. <p>Call a script function from C/C++ code.</p>
  1420. <dl class="params"><dt>Parameters</dt><dd>
  1421. <table class="params">
  1422. <tr><td class="paramname">argc</td><td>Number of elements in the argv parameter </td></tr>
  1423. <tr><td class="paramname">argv</td><td>A character string array containing the name of the function to call followed by the arguments to that function. <div class="fragment"><div class="line"><span class="comment">// Call a Torque script function called mAbs, having one parameter.</span></div>
  1424. <div class="line"><span class="keywordtype">char</span>* argv[] = {<span class="stringliteral">&quot;abs&quot;</span>, <span class="stringliteral">&quot;-9&quot;</span>};</div>
  1425. <div class="line"><span class="keywordtype">char</span>* result = <a class="code hl_function" href="namespace_con.html#a27b33db8c092259f68383935d89ab802">execute</a>(2, argv);</div>
  1426. <div class="ttc" id="anamespace_con_html_a27b33db8c092259f68383935d89ab802"><div class="ttname"><a href="namespace_con.html#a27b33db8c092259f68383935d89ab802">Con::execute</a></div><div class="ttdeci">const char * execute(S32 argc, const char *argv[])</div><div class="ttdef"><b>Definition</b> console.cc:971</div></div>
  1427. </div><!-- fragment --> </td></tr>
  1428. </table>
  1429. </dd>
  1430. </dl>
  1431. </div>
  1432. </div>
  1433. <a id="a0870067030f9dd3b180fb6a913bac43d" name="a0870067030f9dd3b180fb6a913bac43d"></a>
  1434. <h2 class="memtitle"><span class="permalink"><a href="#a0870067030f9dd3b180fb6a913bac43d">&#9670;&#160;</a></span>execute() <span class="overload">[2/2]</span></h2>
  1435. <div class="memitem">
  1436. <div class="memproto">
  1437. <table class="memname">
  1438. <tr>
  1439. <td class="memname">const char * execute </td>
  1440. <td>(</td>
  1441. <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td>
  1442. <td class="paramname"><em>object</em>, </td>
  1443. </tr>
  1444. <tr>
  1445. <td class="paramkey"></td>
  1446. <td></td>
  1447. <td class="paramtype">S32&#160;</td>
  1448. <td class="paramname"><em>argc</em>, </td>
  1449. </tr>
  1450. <tr>
  1451. <td class="paramkey"></td>
  1452. <td></td>
  1453. <td class="paramtype">const char *&#160;</td>
  1454. <td class="paramname"><em>argv</em>[], </td>
  1455. </tr>
  1456. <tr>
  1457. <td class="paramkey"></td>
  1458. <td></td>
  1459. <td class="paramtype">bool&#160;</td>
  1460. <td class="paramname"><em>thisCallOnly</em> = <code>false</code>&#160;</td>
  1461. </tr>
  1462. <tr>
  1463. <td></td>
  1464. <td>)</td>
  1465. <td></td><td></td>
  1466. </tr>
  1467. </table>
  1468. </div><div class="memdoc">
  1469. <p>Call a <a class="el" href="namespace_torque.html">Torque</a> Script member function of a <a class="el" href="class_sim_object.html">SimObject</a> from C/C++ code. </p><dl class="params"><dt>Parameters</dt><dd>
  1470. <table class="params">
  1471. <tr><td class="paramname">object</td><td>Object on which to execute the method call. </td></tr>
  1472. <tr><td class="paramname">argc</td><td>Number of elements in the argv parameter (must be &gt;2, see argv) </td></tr>
  1473. <tr><td class="paramname">argv</td><td>A character string array containing the name of the member function to call followed by an empty parameter (gets filled with object ID) followed by arguments to that function. <div class="fragment"><div class="line"><span class="comment">// Call the method setMode() on an object, passing it one parameter.</span></div>
  1474. <div class="line"> </div>
  1475. <div class="line"><span class="keywordtype">char</span>* argv[] = {<span class="stringliteral">&quot;setMode&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, <span class="stringliteral">&quot;2&quot;</span>};</div>
  1476. <div class="line"><span class="keywordtype">char</span>* result = <a class="code hl_function" href="namespace_con.html#a27b33db8c092259f68383935d89ab802">execute</a>(mysimobject, 3, argv);</div>
  1477. </div><!-- fragment --> </td></tr>
  1478. </table>
  1479. </dd>
  1480. </dl>
  1481. </div>
  1482. </div>
  1483. <a id="a2c0aa758af4981c10a362ddb90914f44" name="a2c0aa758af4981c10a362ddb90914f44"></a>
  1484. <h2 class="memtitle"><span class="permalink"><a href="#a2c0aa758af4981c10a362ddb90914f44">&#9670;&#160;</a></span>executef() <span class="overload">[1/2]</span></h2>
  1485. <div class="memitem">
  1486. <div class="memproto">
  1487. <table class="memname">
  1488. <tr>
  1489. <td class="memname">const char * executef </td>
  1490. <td>(</td>
  1491. <td class="paramtype">S32&#160;</td>
  1492. <td class="paramname"><em>argc</em>, </td>
  1493. </tr>
  1494. <tr>
  1495. <td class="paramkey"></td>
  1496. <td></td>
  1497. <td class="paramtype">&#160;</td>
  1498. <td class="paramname"><em>...</em>&#160;</td>
  1499. </tr>
  1500. <tr>
  1501. <td></td>
  1502. <td>)</td>
  1503. <td></td><td></td>
  1504. </tr>
  1505. </table>
  1506. </div><div class="memdoc">
  1507. <dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_con.html#a27b33db8c092259f68383935d89ab802">execute(S32 argc, const char* argv[])</a> </dd></dl>
  1508. </div>
  1509. </div>
  1510. <a id="a443c03c63fe60016f5bbfb99e1ccbee5" name="a443c03c63fe60016f5bbfb99e1ccbee5"></a>
  1511. <h2 class="memtitle"><span class="permalink"><a href="#a443c03c63fe60016f5bbfb99e1ccbee5">&#9670;&#160;</a></span>executef() <span class="overload">[2/2]</span></h2>
  1512. <div class="memitem">
  1513. <div class="memproto">
  1514. <table class="memname">
  1515. <tr>
  1516. <td class="memname">const char * executef </td>
  1517. <td>(</td>
  1518. <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td>
  1519. <td class="paramname">, </td>
  1520. </tr>
  1521. <tr>
  1522. <td class="paramkey"></td>
  1523. <td></td>
  1524. <td class="paramtype">S32&#160;</td>
  1525. <td class="paramname"><em>argc</em>, </td>
  1526. </tr>
  1527. <tr>
  1528. <td class="paramkey"></td>
  1529. <td></td>
  1530. <td class="paramtype">&#160;</td>
  1531. <td class="paramname"><em>...</em>&#160;</td>
  1532. </tr>
  1533. <tr>
  1534. <td></td>
  1535. <td>)</td>
  1536. <td></td><td></td>
  1537. </tr>
  1538. </table>
  1539. </div><div class="memdoc">
  1540. <dl class="section see"><dt>See also</dt><dd>execute(SimObject *, S32 argc, const char *argv[]) </dd></dl>
  1541. </div>
  1542. </div>
  1543. <a id="ade40cc27b73661f1d997107a00baae6b" name="ade40cc27b73661f1d997107a00baae6b"></a>
  1544. <h2 class="memtitle"><span class="permalink"><a href="#ade40cc27b73661f1d997107a00baae6b">&#9670;&#160;</a></span>expandPath()</h2>
  1545. <div class="memitem">
  1546. <div class="memproto">
  1547. <table class="memname">
  1548. <tr>
  1549. <td class="memname">bool expandPath </td>
  1550. <td>(</td>
  1551. <td class="paramtype">char *&#160;</td>
  1552. <td class="paramname"><em>pDstPath</em>, </td>
  1553. </tr>
  1554. <tr>
  1555. <td class="paramkey"></td>
  1556. <td></td>
  1557. <td class="paramtype">U32&#160;</td>
  1558. <td class="paramname"><em>size</em>, </td>
  1559. </tr>
  1560. <tr>
  1561. <td class="paramkey"></td>
  1562. <td></td>
  1563. <td class="paramtype">const char *&#160;</td>
  1564. <td class="paramname"><em>pSrcPath</em>, </td>
  1565. </tr>
  1566. <tr>
  1567. <td class="paramkey"></td>
  1568. <td></td>
  1569. <td class="paramtype">const char *&#160;</td>
  1570. <td class="paramname"><em>pWorkingDirectoryHint</em> = <code>NULL</code>, </td>
  1571. </tr>
  1572. <tr>
  1573. <td class="paramkey"></td>
  1574. <td></td>
  1575. <td class="paramtype">const bool&#160;</td>
  1576. <td class="paramname"><em>ensureTrailingSlash</em> = <code>false</code>&#160;</td>
  1577. </tr>
  1578. <tr>
  1579. <td></td>
  1580. <td>)</td>
  1581. <td></td><td></td>
  1582. </tr>
  1583. </table>
  1584. </div><div class="memdoc">
  1585. <p>Convert from a relative path to an absolute path.</p>
  1586. <p>This is used in (among other places) the exec() script function, which takes a parameter indicating a script file and executes it. Script paths can be one of:</p><ul>
  1587. <li><b>Absolute:</b> <em>fps/foo/bar.cs</em> Paths of this sort are passed through.</li>
  1588. <li><b>Mod-relative:</b> <em>~/foo/bar.cs</em> Paths of this sort have their replaced with the name of the current mod.</li>
  1589. <li><b>File-relative:</b> <em>./baz/blip.cs</em> Paths of this sort are calculated relative to the path of the current scripting file.</li>
  1590. <li><b>Expando:</b> <em>^Project/image/happy.png</em> Paths of this sort are relative to the path defined by the expando, in this case the "Project" expando.</li>
  1591. </ul>
  1592. <dl class="params"><dt>Parameters</dt><dd>
  1593. <table class="params">
  1594. <tr><td class="paramname">pDstPath</td><td>Pointer to string buffer to fill with absolute path. </td></tr>
  1595. <tr><td class="paramname">size</td><td>Size of buffer pointed to by pDstPath. </td></tr>
  1596. <tr><td class="paramname">pSrcPath</td><td>Original, possibly relative path. </td></tr>
  1597. </table>
  1598. </dd>
  1599. </dl>
  1600. </div>
  1601. </div>
  1602. <a id="a561915e6ebb649c6bac00b80f8b42cc3" name="a561915e6ebb649c6bac00b80f8b42cc3"></a>
  1603. <h2 class="memtitle"><span class="permalink"><a href="#a561915e6ebb649c6bac00b80f8b42cc3">&#9670;&#160;</a></span>getArgBuffer()</h2>
  1604. <div class="memitem">
  1605. <div class="memproto">
  1606. <table class="memname">
  1607. <tr>
  1608. <td class="memname">char * getArgBuffer </td>
  1609. <td>(</td>
  1610. <td class="paramtype">U32&#160;</td>
  1611. <td class="paramname"><em>bufferSize</em></td><td>)</td>
  1612. <td></td>
  1613. </tr>
  1614. </table>
  1615. </div><div class="memdoc">
  1616. </div>
  1617. </div>
  1618. <a id="a6d7df441a2b4b2369dabe83dff178427" name="a6d7df441a2b4b2369dabe83dff178427"></a>
  1619. <h2 class="memtitle"><span class="permalink"><a href="#a6d7df441a2b4b2369dabe83dff178427">&#9670;&#160;</a></span>getBoolArg()</h2>
  1620. <div class="memitem">
  1621. <div class="memproto">
  1622. <table class="memname">
  1623. <tr>
  1624. <td class="memname">char * getBoolArg </td>
  1625. <td>(</td>
  1626. <td class="paramtype">bool&#160;</td>
  1627. <td class="paramname"><em>arg</em></td><td>)</td>
  1628. <td></td>
  1629. </tr>
  1630. </table>
  1631. </div><div class="memdoc">
  1632. </div>
  1633. </div>
  1634. <a id="a8608bcc5cd3aa1bd16dbd6e07d3d87f7" name="a8608bcc5cd3aa1bd16dbd6e07d3d87f7"></a>
  1635. <h2 class="memtitle"><span class="permalink"><a href="#a8608bcc5cd3aa1bd16dbd6e07d3d87f7">&#9670;&#160;</a></span>getBoolVariable()</h2>
  1636. <div class="memitem">
  1637. <div class="memproto">
  1638. <table class="memname">
  1639. <tr>
  1640. <td class="memname">bool getBoolVariable </td>
  1641. <td>(</td>
  1642. <td class="paramtype">const char *&#160;</td>
  1643. <td class="paramname"><em>name</em>, </td>
  1644. </tr>
  1645. <tr>
  1646. <td class="paramkey"></td>
  1647. <td></td>
  1648. <td class="paramtype">bool&#160;</td>
  1649. <td class="paramname"><em>def</em> = <code>false</code>&#160;</td>
  1650. </tr>
  1651. <tr>
  1652. <td></td>
  1653. <td>)</td>
  1654. <td></td><td></td>
  1655. </tr>
  1656. </table>
  1657. </div><div class="memdoc">
  1658. <p>Same as <a class="el" href="namespace_con.html#a7a7b8a66c903bd9f22e8ddc5837f9c88">getVariable()</a>, but for bools.</p>
  1659. <dl class="params"><dt>Parameters</dt><dd>
  1660. <table class="params">
  1661. <tr><td class="paramname">name</td><td>Name of the variable. </td></tr>
  1662. <tr><td class="paramname">def</td><td>Default value to supply if no matching variable is found. </td></tr>
  1663. </table>
  1664. </dd>
  1665. </dl>
  1666. </div>
  1667. </div>
  1668. <a id="aa4eb7e2dc05afc3db75676be3834c756" name="aa4eb7e2dc05afc3db75676be3834c756"></a>
  1669. <h2 class="memtitle"><span class="permalink"><a href="#aa4eb7e2dc05afc3db75676be3834c756">&#9670;&#160;</a></span>getData()</h2>
  1670. <div class="memitem">
  1671. <div class="memproto">
  1672. <table class="memname">
  1673. <tr>
  1674. <td class="memname">const char * getData </td>
  1675. <td>(</td>
  1676. <td class="paramtype">S32&#160;</td>
  1677. <td class="paramname"><em>type</em>, </td>
  1678. </tr>
  1679. <tr>
  1680. <td class="paramkey"></td>
  1681. <td></td>
  1682. <td class="paramtype">void *&#160;</td>
  1683. <td class="paramname"><em>dptr</em>, </td>
  1684. </tr>
  1685. <tr>
  1686. <td class="paramkey"></td>
  1687. <td></td>
  1688. <td class="paramtype">S32&#160;</td>
  1689. <td class="paramname"><em>index</em>, </td>
  1690. </tr>
  1691. <tr>
  1692. <td class="paramkey"></td>
  1693. <td></td>
  1694. <td class="paramtype"><a class="el" href="struct_enum_table.html">EnumTable</a> *&#160;</td>
  1695. <td class="paramname"><em>tbl</em>, </td>
  1696. </tr>
  1697. <tr>
  1698. <td class="paramkey"></td>
  1699. <td></td>
  1700. <td class="paramtype"><a class="el" href="class_bit_set32.html">BitSet32</a>&#160;</td>
  1701. <td class="paramname"><em>flag</em>&#160;</td>
  1702. </tr>
  1703. <tr>
  1704. <td></td>
  1705. <td>)</td>
  1706. <td></td><td></td>
  1707. </tr>
  1708. </table>
  1709. </div><div class="memdoc">
  1710. </div>
  1711. </div>
  1712. <a id="a9e00c3d7b7e2c86d2b606ec5933ae4f7" name="a9e00c3d7b7e2c86d2b606ec5933ae4f7"></a>
  1713. <h2 class="memtitle"><span class="permalink"><a href="#a9e00c3d7b7e2c86d2b606ec5933ae4f7">&#9670;&#160;</a></span>getFloatArg()</h2>
  1714. <div class="memitem">
  1715. <div class="memproto">
  1716. <table class="memname">
  1717. <tr>
  1718. <td class="memname">char * getFloatArg </td>
  1719. <td>(</td>
  1720. <td class="paramtype">F64&#160;</td>
  1721. <td class="paramname"><em>arg</em></td><td>)</td>
  1722. <td></td>
  1723. </tr>
  1724. </table>
  1725. </div><div class="memdoc">
  1726. </div>
  1727. </div>
  1728. <a id="ad4378d3748cbaa7ee606f7e045e48bd5" name="ad4378d3748cbaa7ee606f7e045e48bd5"></a>
  1729. <h2 class="memtitle"><span class="permalink"><a href="#ad4378d3748cbaa7ee606f7e045e48bd5">&#9670;&#160;</a></span>getFloatVariable()</h2>
  1730. <div class="memitem">
  1731. <div class="memproto">
  1732. <table class="memname">
  1733. <tr>
  1734. <td class="memname">F32 getFloatVariable </td>
  1735. <td>(</td>
  1736. <td class="paramtype">const char *&#160;</td>
  1737. <td class="paramname"><em>name</em>, </td>
  1738. </tr>
  1739. <tr>
  1740. <td class="paramkey"></td>
  1741. <td></td>
  1742. <td class="paramtype">F32&#160;</td>
  1743. <td class="paramname"><em>def</em> = <code>.0f</code>&#160;</td>
  1744. </tr>
  1745. <tr>
  1746. <td></td>
  1747. <td>)</td>
  1748. <td></td><td></td>
  1749. </tr>
  1750. </table>
  1751. </div><div class="memdoc">
  1752. <p>Same as <a class="el" href="namespace_con.html#a7a7b8a66c903bd9f22e8ddc5837f9c88">getVariable()</a>, but for floats.</p>
  1753. <dl class="params"><dt>Parameters</dt><dd>
  1754. <table class="params">
  1755. <tr><td class="paramname">name</td><td>Name of the variable. </td></tr>
  1756. <tr><td class="paramname">def</td><td>Default value to supply if no matching variable is found. </td></tr>
  1757. </table>
  1758. </dd>
  1759. </dl>
  1760. </div>
  1761. </div>
  1762. <a id="af64f95625041d8ad300dfab3875dfb99" name="af64f95625041d8ad300dfab3875dfb99"></a>
  1763. <h2 class="memtitle"><span class="permalink"><a href="#af64f95625041d8ad300dfab3875dfb99">&#9670;&#160;</a></span>getIntArg()</h2>
  1764. <div class="memitem">
  1765. <div class="memproto">
  1766. <table class="memname">
  1767. <tr>
  1768. <td class="memname">char * getIntArg </td>
  1769. <td>(</td>
  1770. <td class="paramtype">S32&#160;</td>
  1771. <td class="paramname"><em>arg</em></td><td>)</td>
  1772. <td></td>
  1773. </tr>
  1774. </table>
  1775. </div><div class="memdoc">
  1776. </div>
  1777. </div>
  1778. <a id="af30ef7079120ea73d6fa29021be67de2" name="af30ef7079120ea73d6fa29021be67de2"></a>
  1779. <h2 class="memtitle"><span class="permalink"><a href="#af30ef7079120ea73d6fa29021be67de2">&#9670;&#160;</a></span>getIntVariable()</h2>
  1780. <div class="memitem">
  1781. <div class="memproto">
  1782. <table class="memname">
  1783. <tr>
  1784. <td class="memname">S32 getIntVariable </td>
  1785. <td>(</td>
  1786. <td class="paramtype">const char *&#160;</td>
  1787. <td class="paramname"><em>name</em>, </td>
  1788. </tr>
  1789. <tr>
  1790. <td class="paramkey"></td>
  1791. <td></td>
  1792. <td class="paramtype">S32&#160;</td>
  1793. <td class="paramname"><em>def</em> = <code>0</code>&#160;</td>
  1794. </tr>
  1795. <tr>
  1796. <td></td>
  1797. <td>)</td>
  1798. <td></td><td></td>
  1799. </tr>
  1800. </table>
  1801. </div><div class="memdoc">
  1802. <p>Same as <a class="el" href="namespace_con.html#a7a7b8a66c903bd9f22e8ddc5837f9c88">getVariable()</a>, but for ints.</p>
  1803. <dl class="params"><dt>Parameters</dt><dd>
  1804. <table class="params">
  1805. <tr><td class="paramname">name</td><td>Name of the variable. </td></tr>
  1806. <tr><td class="paramname">def</td><td>Default value to supply if no matching variable is found. </td></tr>
  1807. </table>
  1808. </dd>
  1809. </dl>
  1810. </div>
  1811. </div>
  1812. <a id="aa7566bbb49751967d5fe942f221d182c" name="aa7566bbb49751967d5fe942f221d182c"></a>
  1813. <h2 class="memtitle"><span class="permalink"><a href="#aa7566bbb49751967d5fe942f221d182c">&#9670;&#160;</a></span>getLocalVariable()</h2>
  1814. <div class="memitem">
  1815. <div class="memproto">
  1816. <table class="memname">
  1817. <tr>
  1818. <td class="memname">const char * getLocalVariable </td>
  1819. <td>(</td>
  1820. <td class="paramtype">const char *&#160;</td>
  1821. <td class="paramname"><em>name</em></td><td>)</td>
  1822. <td></td>
  1823. </tr>
  1824. </table>
  1825. </div><div class="memdoc">
  1826. <p>Retrieve the string value to a locally scoped console variable</p>
  1827. <dl class="section note"><dt>Note</dt><dd>The context of the variable is determined by gEvalState; that is, by the currently executing code.</dd></dl>
  1828. <dl class="params"><dt>Parameters</dt><dd>
  1829. <table class="params">
  1830. <tr><td class="paramname">name</td><td>Local console variable name to get </td></tr>
  1831. </table>
  1832. </dd>
  1833. </dl>
  1834. </div>
  1835. </div>
  1836. <a id="a7a567eee4c11f2b36849d4895f2824a4" name="a7a567eee4c11f2b36849d4895f2824a4"></a>
  1837. <h2 class="memtitle"><span class="permalink"><a href="#a7a567eee4c11f2b36849d4895f2824a4">&#9670;&#160;</a></span>getLockLog()</h2>
  1838. <div class="memitem">
  1839. <div class="memproto">
  1840. <table class="memname">
  1841. <tr>
  1842. <td class="memname">void getLockLog </td>
  1843. <td>(</td>
  1844. <td class="paramtype"><a class="el" href="struct_console_log_entry.html">ConsoleLogEntry</a> *&amp;&#160;</td>
  1845. <td class="paramname"><em>log</em>, </td>
  1846. </tr>
  1847. <tr>
  1848. <td class="paramkey"></td>
  1849. <td></td>
  1850. <td class="paramtype">U32 &amp;&#160;</td>
  1851. <td class="paramname"><em>size</em>&#160;</td>
  1852. </tr>
  1853. <tr>
  1854. <td></td>
  1855. <td>)</td>
  1856. <td></td><td></td>
  1857. </tr>
  1858. </table>
  1859. </div><div class="memdoc">
  1860. </div>
  1861. </div>
  1862. <a id="aee2a5d3865c4b41083e4a1ecb4965e8e" name="aee2a5d3865c4b41083e4a1ecb4965e8e"></a>
  1863. <h2 class="memtitle"><span class="permalink"><a href="#aee2a5d3865c4b41083e4a1ecb4965e8e">&#9670;&#160;</a></span>getModNameFromPath()</h2>
  1864. <div class="memitem">
  1865. <div class="memproto">
  1866. <table class="memname">
  1867. <tr>
  1868. <td class="memname">StringTableEntry getModNameFromPath </td>
  1869. <td>(</td>
  1870. <td class="paramtype">const char *&#160;</td>
  1871. <td class="paramname"><em>path</em></td><td>)</td>
  1872. <td></td>
  1873. </tr>
  1874. </table>
  1875. </div><div class="memdoc">
  1876. </div>
  1877. </div>
  1878. <a id="aca6ed7058ea6c73ec40148b4bc865997" name="aca6ed7058ea6c73ec40148b4bc865997"></a>
  1879. <h2 class="memtitle"><span class="permalink"><a href="#aca6ed7058ea6c73ec40148b4bc865997">&#9670;&#160;</a></span>getPathExpando()</h2>
  1880. <div class="memitem">
  1881. <div class="memproto">
  1882. <table class="memname">
  1883. <tr>
  1884. <td class="memname">StringTableEntry getPathExpando </td>
  1885. <td>(</td>
  1886. <td class="paramtype">const char *&#160;</td>
  1887. <td class="paramname"><em>pExpandoName</em></td><td>)</td>
  1888. <td></td>
  1889. </tr>
  1890. </table>
  1891. </div><div class="memdoc">
  1892. </div>
  1893. </div>
  1894. <a id="a65a279da1ce0f579a7989cf3cd0cd6dc" name="a65a279da1ce0f579a7989cf3cd0cd6dc"></a>
  1895. <h2 class="memtitle"><span class="permalink"><a href="#a65a279da1ce0f579a7989cf3cd0cd6dc">&#9670;&#160;</a></span>getPathExpandoCount()</h2>
  1896. <div class="memitem">
  1897. <div class="memproto">
  1898. <table class="memname">
  1899. <tr>
  1900. <td class="memname">U32 getPathExpandoCount </td>
  1901. <td>(</td>
  1902. <td class="paramtype">void&#160;</td>
  1903. <td class="paramname"></td><td>)</td>
  1904. <td></td>
  1905. </tr>
  1906. </table>
  1907. </div><div class="memdoc">
  1908. </div>
  1909. </div>
  1910. <a id="a24351fba6ef62142af5a686705c07920" name="a24351fba6ef62142af5a686705c07920"></a>
  1911. <h2 class="memtitle"><span class="permalink"><a href="#a24351fba6ef62142af5a686705c07920">&#9670;&#160;</a></span>getPathExpandoKey()</h2>
  1912. <div class="memitem">
  1913. <div class="memproto">
  1914. <table class="memname">
  1915. <tr>
  1916. <td class="memname">StringTableEntry getPathExpandoKey </td>
  1917. <td>(</td>
  1918. <td class="paramtype">U32&#160;</td>
  1919. <td class="paramname"><em>expandoIndex</em></td><td>)</td>
  1920. <td></td>
  1921. </tr>
  1922. </table>
  1923. </div><div class="memdoc">
  1924. </div>
  1925. </div>
  1926. <a id="ad75e4f935a859c876ccfdfae61b9d7f3" name="ad75e4f935a859c876ccfdfae61b9d7f3"></a>
  1927. <h2 class="memtitle"><span class="permalink"><a href="#ad75e4f935a859c876ccfdfae61b9d7f3">&#9670;&#160;</a></span>getPathExpandoValue()</h2>
  1928. <div class="memitem">
  1929. <div class="memproto">
  1930. <table class="memname">
  1931. <tr>
  1932. <td class="memname">StringTableEntry getPathExpandoValue </td>
  1933. <td>(</td>
  1934. <td class="paramtype">U32&#160;</td>
  1935. <td class="paramname"><em>expandoIndex</em></td><td>)</td>
  1936. <td></td>
  1937. </tr>
  1938. </table>
  1939. </div><div class="memdoc">
  1940. </div>
  1941. </div>
  1942. <a id="a0fd8dc9c46dea3bb9afd749a6323b601" name="a0fd8dc9c46dea3bb9afd749a6323b601"></a>
  1943. <h2 class="memtitle"><span class="permalink"><a href="#a0fd8dc9c46dea3bb9afd749a6323b601">&#9670;&#160;</a></span>getReturnBuffer() <span class="overload">[1/2]</span></h2>
  1944. <div class="memitem">
  1945. <div class="memproto">
  1946. <table class="memname">
  1947. <tr>
  1948. <td class="memname">char * getReturnBuffer </td>
  1949. <td>(</td>
  1950. <td class="paramtype">const char *&#160;</td>
  1951. <td class="paramname"><em>stringToCopy</em></td><td>)</td>
  1952. <td></td>
  1953. </tr>
  1954. </table>
  1955. </div><div class="memdoc">
  1956. </div>
  1957. </div>
  1958. <a id="ab0583ba59217e586cf79446c95bbed3a" name="ab0583ba59217e586cf79446c95bbed3a"></a>
  1959. <h2 class="memtitle"><span class="permalink"><a href="#ab0583ba59217e586cf79446c95bbed3a">&#9670;&#160;</a></span>getReturnBuffer() <span class="overload">[2/2]</span></h2>
  1960. <div class="memitem">
  1961. <div class="memproto">
  1962. <table class="memname">
  1963. <tr>
  1964. <td class="memname">char * getReturnBuffer </td>
  1965. <td>(</td>
  1966. <td class="paramtype">U32&#160;</td>
  1967. <td class="paramname"><em>bufferSize</em></td><td>)</td>
  1968. <td></td>
  1969. </tr>
  1970. </table>
  1971. </div><div class="memdoc">
  1972. <p>getReturnBuffer lets you allocate stack space to return data in. </p>
  1973. </div>
  1974. </div>
  1975. <a id="a7a7b8a66c903bd9f22e8ddc5837f9c88" name="a7a7b8a66c903bd9f22e8ddc5837f9c88"></a>
  1976. <h2 class="memtitle"><span class="permalink"><a href="#a7a7b8a66c903bd9f22e8ddc5837f9c88">&#9670;&#160;</a></span>getVariable()</h2>
  1977. <div class="memitem">
  1978. <div class="memproto">
  1979. <table class="memname">
  1980. <tr>
  1981. <td class="memname">const char * getVariable </td>
  1982. <td>(</td>
  1983. <td class="paramtype">const char *&#160;</td>
  1984. <td class="paramname"><em>name</em></td><td>)</td>
  1985. <td></td>
  1986. </tr>
  1987. </table>
  1988. </div><div class="memdoc">
  1989. <p>Retrieve the string value of a global console variable </p><dl class="params"><dt>Parameters</dt><dd>
  1990. <table class="params">
  1991. <tr><td class="paramname">name</td><td>Global Console variable name to query </td></tr>
  1992. </table>
  1993. </dd>
  1994. </dl>
  1995. <dl class="section return"><dt>Returns</dt><dd>The string value of the variable or "" if the variable does not exist. </dd></dl>
  1996. </div>
  1997. </div>
  1998. <a id="a02fd73d861ef2e4aabb38c0c9ff82947" name="a02fd73d861ef2e4aabb38c0c9ff82947"></a>
  1999. <h2 class="memtitle"><span class="permalink"><a href="#a02fd73d861ef2e4aabb38c0c9ff82947">&#9670;&#160;</a></span>init()</h2>
  2000. <div class="memitem">
  2001. <div class="memproto">
  2002. <table class="memname">
  2003. <tr>
  2004. <td class="memname">void init </td>
  2005. <td>(</td>
  2006. <td class="paramname"></td><td>)</td>
  2007. <td></td>
  2008. </tr>
  2009. </table>
  2010. </div><div class="memdoc">
  2011. <p>Initializes the console.</p>
  2012. <p>This performs the following steps:</p><ul>
  2013. <li>Calls <a class="el" href="class_namespace.html#a02fd73d861ef2e4aabb38c0c9ff82947">Namespace::init()</a> to initialize the scripting namespace hierarchy.</li>
  2014. <li>Calls <a class="el" href="class_console_constructor.html#a4fc01d736fe50cf5b977f755b675f11d">ConsoleConstructor::setup()</a> to initialize globally defined console methods and functions.</li>
  2015. <li>Registers some basic global script variables.</li>
  2016. <li>Calls <a class="el" href="class_abstract_class_rep.html#a309878900c060216e1457bea60fb1ba5">AbstractClassRep::init()</a> to initialize <a class="el" href="namespace_torque.html">Torque</a>'s class database.</li>
  2017. <li>Registers some basic global script functions that couldn't usefully be defined anywhere else. </li>
  2018. </ul>
  2019. </div>
  2020. </div>
  2021. <a id="aa1f512ab0fcc05612f8e3d6a4664ce9a" name="aa1f512ab0fcc05612f8e3d6a4664ce9a"></a>
  2022. <h2 class="memtitle"><span class="permalink"><a href="#aa1f512ab0fcc05612f8e3d6a4664ce9a">&#9670;&#160;</a></span>isActive()</h2>
  2023. <div class="memitem">
  2024. <div class="memproto">
  2025. <table class="memname">
  2026. <tr>
  2027. <td class="memname">bool isActive </td>
  2028. <td>(</td>
  2029. <td class="paramname"></td><td>)</td>
  2030. <td></td>
  2031. </tr>
  2032. </table>
  2033. </div><div class="memdoc">
  2034. <p>Is the console active at this time? </p>
  2035. </div>
  2036. </div>
  2037. <a id="a65b1843a43b1db17ea4a3f78a20990b3" name="a65b1843a43b1db17ea4a3f78a20990b3"></a>
  2038. <h2 class="memtitle"><span class="permalink"><a href="#a65b1843a43b1db17ea4a3f78a20990b3">&#9670;&#160;</a></span>isBasePath()</h2>
  2039. <div class="memitem">
  2040. <div class="memproto">
  2041. <table class="memname">
  2042. <tr>
  2043. <td class="memname">bool isBasePath </td>
  2044. <td>(</td>
  2045. <td class="paramtype">const char *&#160;</td>
  2046. <td class="paramname"><em>SrcPath</em>, </td>
  2047. </tr>
  2048. <tr>
  2049. <td class="paramkey"></td>
  2050. <td></td>
  2051. <td class="paramtype">const char *&#160;</td>
  2052. <td class="paramname"><em>pBasePath</em>&#160;</td>
  2053. </tr>
  2054. <tr>
  2055. <td></td>
  2056. <td>)</td>
  2057. <td></td><td></td>
  2058. </tr>
  2059. </table>
  2060. </div><div class="memdoc">
  2061. </div>
  2062. </div>
  2063. <a id="a13f3ea370bb12b0f9b2284cb2c406954" name="a13f3ea370bb12b0f9b2284cb2c406954"></a>
  2064. <h2 class="memtitle"><span class="permalink"><a href="#a13f3ea370bb12b0f9b2284cb2c406954">&#9670;&#160;</a></span>isFunction()</h2>
  2065. <div class="memitem">
  2066. <div class="memproto">
  2067. <table class="memname">
  2068. <tr>
  2069. <td class="memname">bool isFunction </td>
  2070. <td>(</td>
  2071. <td class="paramtype">const char *&#160;</td>
  2072. <td class="paramname"><em>fn</em></td><td>)</td>
  2073. <td></td>
  2074. </tr>
  2075. </table>
  2076. </div><div class="memdoc">
  2077. <p>Returns true if fn is a global scripting function.</p>
  2078. <p>This looks in the global namespace. It also checks to see if fn is in the StringTable; if not, it returns false. </p>
  2079. </div>
  2080. </div>
  2081. <a id="acfece81969a99e56dc5b05a6f3800842" name="acfece81969a99e56dc5b05a6f3800842"></a>
  2082. <h2 class="memtitle"><span class="permalink"><a href="#acfece81969a99e56dc5b05a6f3800842">&#9670;&#160;</a></span>isMainThread()</h2>
  2083. <div class="memitem">
  2084. <div class="memproto">
  2085. <table class="memname">
  2086. <tr>
  2087. <td class="memname">bool isMainThread </td>
  2088. <td>(</td>
  2089. <td class="paramname"></td><td>)</td>
  2090. <td></td>
  2091. </tr>
  2092. </table>
  2093. </div><div class="memdoc">
  2094. <p>Returns true when called from the main thread, false otherwise. </p>
  2095. </div>
  2096. </div>
  2097. <a id="ad0368dff61918f2b46e74cdab98afb21" name="ad0368dff61918f2b46e74cdab98afb21"></a>
  2098. <h2 class="memtitle"><span class="permalink"><a href="#ad0368dff61918f2b46e74cdab98afb21">&#9670;&#160;</a></span>isPathExpando()</h2>
  2099. <div class="memitem">
  2100. <div class="memproto">
  2101. <table class="memname">
  2102. <tr>
  2103. <td class="memname">bool isPathExpando </td>
  2104. <td>(</td>
  2105. <td class="paramtype">const char *&#160;</td>
  2106. <td class="paramname"><em>pExpandoName</em></td><td>)</td>
  2107. <td></td>
  2108. </tr>
  2109. </table>
  2110. </div><div class="memdoc">
  2111. </div>
  2112. </div>
  2113. <a id="a62144b415ec2d859119ad5fd8ebb9d5c" name="a62144b415ec2d859119ad5fd8ebb9d5c"></a>
  2114. <h2 class="memtitle"><span class="permalink"><a href="#a62144b415ec2d859119ad5fd8ebb9d5c">&#9670;&#160;</a></span>linkNamespaces()</h2>
  2115. <div class="memitem">
  2116. <div class="memproto">
  2117. <table class="memname">
  2118. <tr>
  2119. <td class="memname">bool linkNamespaces </td>
  2120. <td>(</td>
  2121. <td class="paramtype">const char *&#160;</td>
  2122. <td class="paramname"><em>parent</em>, </td>
  2123. </tr>
  2124. <tr>
  2125. <td class="paramkey"></td>
  2126. <td></td>
  2127. <td class="paramtype">const char *&#160;</td>
  2128. <td class="paramname"><em>child</em>&#160;</td>
  2129. </tr>
  2130. <tr>
  2131. <td></td>
  2132. <td>)</td>
  2133. <td></td><td></td>
  2134. </tr>
  2135. </table>
  2136. </div><div class="memdoc">
  2137. </div>
  2138. </div>
  2139. <a id="a8e8f4ab27f2d023e198c56d79d6f58df" name="a8e8f4ab27f2d023e198c56d79d6f58df"></a>
  2140. <h2 class="memtitle"><span class="permalink"><a href="#a8e8f4ab27f2d023e198c56d79d6f58df">&#9670;&#160;</a></span>lookupNamespace()</h2>
  2141. <div class="memitem">
  2142. <div class="memproto">
  2143. <table class="memname">
  2144. <tr>
  2145. <td class="memname"><a class="el" href="class_namespace.html">Namespace</a> * lookupNamespace </td>
  2146. <td>(</td>
  2147. <td class="paramtype">const char *&#160;</td>
  2148. <td class="paramname"><em>ns</em></td><td>)</td>
  2149. <td></td>
  2150. </tr>
  2151. </table>
  2152. </div><div class="memdoc">
  2153. </div>
  2154. </div>
  2155. <a id="a067658a5bf63fb6531cc3042ace16b3e" name="a067658a5bf63fb6531cc3042ace16b3e"></a>
  2156. <h2 class="memtitle"><span class="permalink"><a href="#a067658a5bf63fb6531cc3042ace16b3e">&#9670;&#160;</a></span>markCommandGroup()</h2>
  2157. <div class="memitem">
  2158. <div class="memproto">
  2159. <table class="memname">
  2160. <tr>
  2161. <td class="memname">void markCommandGroup </td>
  2162. <td>(</td>
  2163. <td class="paramtype">const char *&#160;</td>
  2164. <td class="paramname"><em>nsName</em>, </td>
  2165. </tr>
  2166. <tr>
  2167. <td class="paramkey"></td>
  2168. <td></td>
  2169. <td class="paramtype">const char *&#160;</td>
  2170. <td class="paramname"><em>name</em>, </td>
  2171. </tr>
  2172. <tr>
  2173. <td class="paramkey"></td>
  2174. <td></td>
  2175. <td class="paramtype">const char *&#160;</td>
  2176. <td class="paramname"><em>usage</em>&#160;</td>
  2177. </tr>
  2178. <tr>
  2179. <td></td>
  2180. <td>)</td>
  2181. <td></td><td></td>
  2182. </tr>
  2183. </table>
  2184. </div><div class="memdoc">
  2185. </div>
  2186. </div>
  2187. <a id="a1423233a5f47c3247dc46d38318b054f" name="a1423233a5f47c3247dc46d38318b054f"></a>
  2188. <h2 class="memtitle"><span class="permalink"><a href="#a1423233a5f47c3247dc46d38318b054f">&#9670;&#160;</a></span>printBlankLine()</h2>
  2189. <div class="memitem">
  2190. <div class="memproto">
  2191. <table class="mlabels">
  2192. <tr>
  2193. <td class="mlabels-left">
  2194. <table class="memname">
  2195. <tr>
  2196. <td class="memname">void printBlankLine </td>
  2197. <td>(</td>
  2198. <td class="paramtype">void&#160;</td>
  2199. <td class="paramname"></td><td>)</td>
  2200. <td></td>
  2201. </tr>
  2202. </table>
  2203. </td>
  2204. <td class="mlabels-right">
  2205. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2206. </tr>
  2207. </table>
  2208. </div><div class="memdoc">
  2209. <p>Prints a separator to the console. </p>
  2210. </div>
  2211. </div>
  2212. <a id="a0aff7311d684a0e0ef33125616a73385" name="a0aff7311d684a0e0ef33125616a73385"></a>
  2213. <h2 class="memtitle"><span class="permalink"><a href="#a0aff7311d684a0e0ef33125616a73385">&#9670;&#160;</a></span>printf()</h2>
  2214. <div class="memitem">
  2215. <div class="memproto">
  2216. <table class="memname">
  2217. <tr>
  2218. <td class="memname">void printf </td>
  2219. <td>(</td>
  2220. <td class="paramtype">const char *&#160;</td>
  2221. <td class="paramname"><em>_format</em>, </td>
  2222. </tr>
  2223. <tr>
  2224. <td class="paramkey"></td>
  2225. <td></td>
  2226. <td class="paramtype">&#160;</td>
  2227. <td class="paramname"><em>...</em>&#160;</td>
  2228. </tr>
  2229. <tr>
  2230. <td></td>
  2231. <td>)</td>
  2232. <td></td><td></td>
  2233. </tr>
  2234. </table>
  2235. </div><div class="memdoc">
  2236. <dl class="params"><dt>Parameters</dt><dd>
  2237. <table class="params">
  2238. <tr><td class="paramname">_format</td><td>A stdlib printf style formatted out put string </td></tr>
  2239. <tr><td class="paramname">...</td><td>Variables to be written </td></tr>
  2240. </table>
  2241. </dd>
  2242. </dl>
  2243. </div>
  2244. </div>
  2245. <a id="a46f11da4f5c73c8ee975083968e25202" name="a46f11da4f5c73c8ee975083968e25202"></a>
  2246. <h2 class="memtitle"><span class="permalink"><a href="#a46f11da4f5c73c8ee975083968e25202">&#9670;&#160;</a></span>printSeparator()</h2>
  2247. <div class="memitem">
  2248. <div class="memproto">
  2249. <table class="mlabels">
  2250. <tr>
  2251. <td class="mlabels-left">
  2252. <table class="memname">
  2253. <tr>
  2254. <td class="memname">void printSeparator </td>
  2255. <td>(</td>
  2256. <td class="paramtype">void&#160;</td>
  2257. <td class="paramname"></td><td>)</td>
  2258. <td></td>
  2259. </tr>
  2260. </table>
  2261. </td>
  2262. <td class="mlabels-right">
  2263. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  2264. </tr>
  2265. </table>
  2266. </div><div class="memdoc">
  2267. <p>Prints a separator to the console. </p>
  2268. </div>
  2269. </div>
  2270. <a id="a16dfb00f8413c5bffac8e8700f8ef796" name="a16dfb00f8413c5bffac8e8700f8ef796"></a>
  2271. <h2 class="memtitle"><span class="permalink"><a href="#a16dfb00f8413c5bffac8e8700f8ef796">&#9670;&#160;</a></span>removeConsumer()</h2>
  2272. <div class="memitem">
  2273. <div class="memproto">
  2274. <table class="memname">
  2275. <tr>
  2276. <td class="memname">void removeConsumer </td>
  2277. <td>(</td>
  2278. <td class="paramtype"><a class="el" href="group__console__callbacks.html#ga73457ddc96b5e0366926bfd1f6c762ce">ConsumerCallback</a>&#160;</td>
  2279. <td class="paramname"><em>consumer</em></td><td>)</td>
  2280. <td></td>
  2281. </tr>
  2282. </table>
  2283. </div><div class="memdoc">
  2284. </div>
  2285. </div>
  2286. <a id="a0c93fb7c60d2ca1491dd66f6834370f9" name="a0c93fb7c60d2ca1491dd66f6834370f9"></a>
  2287. <h2 class="memtitle"><span class="permalink"><a href="#a0c93fb7c60d2ca1491dd66f6834370f9">&#9670;&#160;</a></span>removePathExpando()</h2>
  2288. <div class="memitem">
  2289. <div class="memproto">
  2290. <table class="memname">
  2291. <tr>
  2292. <td class="memname">void removePathExpando </td>
  2293. <td>(</td>
  2294. <td class="paramtype">const char *&#160;</td>
  2295. <td class="paramname"><em>pExpandoName</em></td><td>)</td>
  2296. <td></td>
  2297. </tr>
  2298. </table>
  2299. </div><div class="memdoc">
  2300. </div>
  2301. </div>
  2302. <a id="a7ee14fb28117a740e2af63ac87c0580b" name="a7ee14fb28117a740e2af63ac87c0580b"></a>
  2303. <h2 class="memtitle"><span class="permalink"><a href="#a7ee14fb28117a740e2af63ac87c0580b">&#9670;&#160;</a></span>removeVariable()</h2>
  2304. <div class="memitem">
  2305. <div class="memproto">
  2306. <table class="memname">
  2307. <tr>
  2308. <td class="memname">bool removeVariable </td>
  2309. <td>(</td>
  2310. <td class="paramtype">const char *&#160;</td>
  2311. <td class="paramname"><em>name</em></td><td>)</td>
  2312. <td></td>
  2313. </tr>
  2314. </table>
  2315. </div><div class="memdoc">
  2316. <p>Remove a console variable.</p>
  2317. <dl class="params"><dt>Parameters</dt><dd>
  2318. <table class="params">
  2319. <tr><td class="paramname">name</td><td>Global console variable name to remove </td></tr>
  2320. </table>
  2321. </dd>
  2322. </dl>
  2323. <dl class="section return"><dt>Returns</dt><dd>true if variable existed before removal. </dd></dl>
  2324. </div>
  2325. </div>
  2326. <a id="a810eda28f4146b51daad8500fb6792be" name="a810eda28f4146b51daad8500fb6792be"></a>
  2327. <h2 class="memtitle"><span class="permalink"><a href="#a810eda28f4146b51daad8500fb6792be">&#9670;&#160;</a></span>setBoolVariable()</h2>
  2328. <div class="memitem">
  2329. <div class="memproto">
  2330. <table class="memname">
  2331. <tr>
  2332. <td class="memname">void setBoolVariable </td>
  2333. <td>(</td>
  2334. <td class="paramtype">const char *&#160;</td>
  2335. <td class="paramname"><em>varName</em>, </td>
  2336. </tr>
  2337. <tr>
  2338. <td class="paramkey"></td>
  2339. <td></td>
  2340. <td class="paramtype">bool&#160;</td>
  2341. <td class="paramname"><em>value</em>&#160;</td>
  2342. </tr>
  2343. <tr>
  2344. <td></td>
  2345. <td>)</td>
  2346. <td></td><td></td>
  2347. </tr>
  2348. </table>
  2349. </div><div class="memdoc">
  2350. <p>Same as <a class="el" href="namespace_con.html#ae6903e12c93d43fc84224e183c11c728">setVariable()</a>, but for bools. </p>
  2351. </div>
  2352. </div>
  2353. <a id="a2512f6d7054fcd0066be6ca39a4bc475" name="a2512f6d7054fcd0066be6ca39a4bc475"></a>
  2354. <h2 class="memtitle"><span class="permalink"><a href="#a2512f6d7054fcd0066be6ca39a4bc475">&#9670;&#160;</a></span>setData()</h2>
  2355. <div class="memitem">
  2356. <div class="memproto">
  2357. <table class="memname">
  2358. <tr>
  2359. <td class="memname">void setData </td>
  2360. <td>(</td>
  2361. <td class="paramtype">S32&#160;</td>
  2362. <td class="paramname"><em>type</em>, </td>
  2363. </tr>
  2364. <tr>
  2365. <td class="paramkey"></td>
  2366. <td></td>
  2367. <td class="paramtype">void *&#160;</td>
  2368. <td class="paramname"><em>dptr</em>, </td>
  2369. </tr>
  2370. <tr>
  2371. <td class="paramkey"></td>
  2372. <td></td>
  2373. <td class="paramtype">S32&#160;</td>
  2374. <td class="paramname"><em>index</em>, </td>
  2375. </tr>
  2376. <tr>
  2377. <td class="paramkey"></td>
  2378. <td></td>
  2379. <td class="paramtype">S32&#160;</td>
  2380. <td class="paramname"><em>argc</em>, </td>
  2381. </tr>
  2382. <tr>
  2383. <td class="paramkey"></td>
  2384. <td></td>
  2385. <td class="paramtype">const char **&#160;</td>
  2386. <td class="paramname"><em>argv</em>, </td>
  2387. </tr>
  2388. <tr>
  2389. <td class="paramkey"></td>
  2390. <td></td>
  2391. <td class="paramtype"><a class="el" href="struct_enum_table.html">EnumTable</a> *&#160;</td>
  2392. <td class="paramname"><em>tbl</em>, </td>
  2393. </tr>
  2394. <tr>
  2395. <td class="paramkey"></td>
  2396. <td></td>
  2397. <td class="paramtype"><a class="el" href="class_bit_set32.html">BitSet32</a>&#160;</td>
  2398. <td class="paramname"><em>flag</em>&#160;</td>
  2399. </tr>
  2400. <tr>
  2401. <td></td>
  2402. <td>)</td>
  2403. <td></td><td></td>
  2404. </tr>
  2405. </table>
  2406. </div><div class="memdoc">
  2407. </div>
  2408. </div>
  2409. <a id="ad79b1be9ec6572eb1dcc8bfa6987e84c" name="ad79b1be9ec6572eb1dcc8bfa6987e84c"></a>
  2410. <h2 class="memtitle"><span class="permalink"><a href="#ad79b1be9ec6572eb1dcc8bfa6987e84c">&#9670;&#160;</a></span>setFloatVariable()</h2>
  2411. <div class="memitem">
  2412. <div class="memproto">
  2413. <table class="memname">
  2414. <tr>
  2415. <td class="memname">void setFloatVariable </td>
  2416. <td>(</td>
  2417. <td class="paramtype">const char *&#160;</td>
  2418. <td class="paramname"><em>varName</em>, </td>
  2419. </tr>
  2420. <tr>
  2421. <td class="paramkey"></td>
  2422. <td></td>
  2423. <td class="paramtype">F32&#160;</td>
  2424. <td class="paramname"><em>value</em>&#160;</td>
  2425. </tr>
  2426. <tr>
  2427. <td></td>
  2428. <td>)</td>
  2429. <td></td><td></td>
  2430. </tr>
  2431. </table>
  2432. </div><div class="memdoc">
  2433. <p>Same as <a class="el" href="namespace_con.html#ae6903e12c93d43fc84224e183c11c728">setVariable()</a>, but for floats. </p>
  2434. </div>
  2435. </div>
  2436. <a id="a1457a2f1a5d8750ea592fef2a1139099" name="a1457a2f1a5d8750ea592fef2a1139099"></a>
  2437. <h2 class="memtitle"><span class="permalink"><a href="#a1457a2f1a5d8750ea592fef2a1139099">&#9670;&#160;</a></span>setIntVariable()</h2>
  2438. <div class="memitem">
  2439. <div class="memproto">
  2440. <table class="memname">
  2441. <tr>
  2442. <td class="memname">void setIntVariable </td>
  2443. <td>(</td>
  2444. <td class="paramtype">const char *&#160;</td>
  2445. <td class="paramname"><em>varName</em>, </td>
  2446. </tr>
  2447. <tr>
  2448. <td class="paramkey"></td>
  2449. <td></td>
  2450. <td class="paramtype">S32&#160;</td>
  2451. <td class="paramname"><em>value</em>&#160;</td>
  2452. </tr>
  2453. <tr>
  2454. <td></td>
  2455. <td>)</td>
  2456. <td></td><td></td>
  2457. </tr>
  2458. </table>
  2459. </div><div class="memdoc">
  2460. <p>Same as <a class="el" href="namespace_con.html#ae6903e12c93d43fc84224e183c11c728">setVariable()</a>, but for ints. </p>
  2461. </div>
  2462. </div>
  2463. <a id="a322c2b9c1caa63109f25e1aea9f8861c" name="a322c2b9c1caa63109f25e1aea9f8861c"></a>
  2464. <h2 class="memtitle"><span class="permalink"><a href="#a322c2b9c1caa63109f25e1aea9f8861c">&#9670;&#160;</a></span>setLocalVariable()</h2>
  2465. <div class="memitem">
  2466. <div class="memproto">
  2467. <table class="memname">
  2468. <tr>
  2469. <td class="memname">void setLocalVariable </td>
  2470. <td>(</td>
  2471. <td class="paramtype">const char *&#160;</td>
  2472. <td class="paramname"><em>name</em>, </td>
  2473. </tr>
  2474. <tr>
  2475. <td class="paramkey"></td>
  2476. <td></td>
  2477. <td class="paramtype">const char *&#160;</td>
  2478. <td class="paramname"><em>value</em>&#160;</td>
  2479. </tr>
  2480. <tr>
  2481. <td></td>
  2482. <td>)</td>
  2483. <td></td><td></td>
  2484. </tr>
  2485. </table>
  2486. </div><div class="memdoc">
  2487. <p>Assign a string value to a locally scoped console variable</p>
  2488. <dl class="section note"><dt>Note</dt><dd>The context of the variable is determined by gEvalState; that is, by the currently executing code.</dd></dl>
  2489. <dl class="params"><dt>Parameters</dt><dd>
  2490. <table class="params">
  2491. <tr><td class="paramname">name</td><td>Local console variable name to set </td></tr>
  2492. <tr><td class="paramname">value</td><td>String value to assign to name </td></tr>
  2493. </table>
  2494. </dd>
  2495. </dl>
  2496. </div>
  2497. </div>
  2498. <a id="ac56041c92b409836c4d809e4880d0ff4" name="ac56041c92b409836c4d809e4880d0ff4"></a>
  2499. <h2 class="memtitle"><span class="permalink"><a href="#ac56041c92b409836c4d809e4880d0ff4">&#9670;&#160;</a></span>setLogMode()</h2>
  2500. <div class="memitem">
  2501. <div class="memproto">
  2502. <table class="memname">
  2503. <tr>
  2504. <td class="memname">void setLogMode </td>
  2505. <td>(</td>
  2506. <td class="paramtype">S32&#160;</td>
  2507. <td class="paramname"><em>newMode</em></td><td>)</td>
  2508. <td></td>
  2509. </tr>
  2510. </table>
  2511. </div><div class="memdoc">
  2512. </div>
  2513. </div>
  2514. <a id="ae6903e12c93d43fc84224e183c11c728" name="ae6903e12c93d43fc84224e183c11c728"></a>
  2515. <h2 class="memtitle"><span class="permalink"><a href="#ae6903e12c93d43fc84224e183c11c728">&#9670;&#160;</a></span>setVariable()</h2>
  2516. <div class="memitem">
  2517. <div class="memproto">
  2518. <table class="memname">
  2519. <tr>
  2520. <td class="memname">void setVariable </td>
  2521. <td>(</td>
  2522. <td class="paramtype">const char *&#160;</td>
  2523. <td class="paramname"><em>name</em>, </td>
  2524. </tr>
  2525. <tr>
  2526. <td class="paramkey"></td>
  2527. <td></td>
  2528. <td class="paramtype">const char *&#160;</td>
  2529. <td class="paramname"><em>value</em>&#160;</td>
  2530. </tr>
  2531. <tr>
  2532. <td></td>
  2533. <td>)</td>
  2534. <td></td><td></td>
  2535. </tr>
  2536. </table>
  2537. </div><div class="memdoc">
  2538. </div>
  2539. </div>
  2540. <a id="a7861ee1569802186a619778efc85af13" name="a7861ee1569802186a619778efc85af13"></a>
  2541. <h2 class="memtitle"><span class="permalink"><a href="#a7861ee1569802186a619778efc85af13">&#9670;&#160;</a></span>shutdown()</h2>
  2542. <div class="memitem">
  2543. <div class="memproto">
  2544. <table class="memname">
  2545. <tr>
  2546. <td class="memname">void shutdown </td>
  2547. <td>(</td>
  2548. <td class="paramname"></td><td>)</td>
  2549. <td></td>
  2550. </tr>
  2551. </table>
  2552. </div><div class="memdoc">
  2553. <p>Shuts down the console.</p>
  2554. <p>This performs the following steps:</p><ul>
  2555. <li>Closes the console log file.</li>
  2556. <li>Calls <a class="el" href="class_namespace.html#a7861ee1569802186a619778efc85af13">Namespace::shutdown()</a> to shut down the scripting namespace hierarchy. </li>
  2557. </ul>
  2558. </div>
  2559. </div>
  2560. <a id="aba4d99980cbe6d1fae6b61a4a85f5c38" name="aba4d99980cbe6d1fae6b61a4a85f5c38"></a>
  2561. <h2 class="memtitle"><span class="permalink"><a href="#aba4d99980cbe6d1fae6b61a4a85f5c38">&#9670;&#160;</a></span>stripColorChars()</h2>
  2562. <div class="memitem">
  2563. <div class="memproto">
  2564. <table class="memname">
  2565. <tr>
  2566. <td class="memname">void stripColorChars </td>
  2567. <td>(</td>
  2568. <td class="paramtype">char *&#160;</td>
  2569. <td class="paramname"><em>line</em></td><td>)</td>
  2570. <td></td>
  2571. </tr>
  2572. </table>
  2573. </div><div class="memdoc">
  2574. <p>Remove color marking information from a string.</p>
  2575. <dl class="section note"><dt>Note</dt><dd>It does this in-place, so be careful! It may potentially blast data if you're not careful. When in doubt, make a copy of the string first. </dd></dl>
  2576. </div>
  2577. </div>
  2578. <a id="a198f138e423c00cd0db8083115afe0a3" name="a198f138e423c00cd0db8083115afe0a3"></a>
  2579. <h2 class="memtitle"><span class="permalink"><a href="#a198f138e423c00cd0db8083115afe0a3">&#9670;&#160;</a></span>stripRepeatSlashes()</h2>
  2580. <div class="memitem">
  2581. <div class="memproto">
  2582. <table class="memname">
  2583. <tr>
  2584. <td class="memname">bool stripRepeatSlashes </td>
  2585. <td>(</td>
  2586. <td class="paramtype">char *&#160;</td>
  2587. <td class="paramname"><em>pDstPath</em>, </td>
  2588. </tr>
  2589. <tr>
  2590. <td class="paramkey"></td>
  2591. <td></td>
  2592. <td class="paramtype">const char *&#160;</td>
  2593. <td class="paramname"><em>pSrcPath</em>, </td>
  2594. </tr>
  2595. <tr>
  2596. <td class="paramkey"></td>
  2597. <td></td>
  2598. <td class="paramtype">S32&#160;</td>
  2599. <td class="paramname"><em>dstSize</em>&#160;</td>
  2600. </tr>
  2601. <tr>
  2602. <td></td>
  2603. <td>)</td>
  2604. <td></td><td></td>
  2605. </tr>
  2606. </table>
  2607. </div><div class="memdoc">
  2608. </div>
  2609. </div>
  2610. <a id="a3ccce5ef4dd2bc53a33e07a4cc1fa313" name="a3ccce5ef4dd2bc53a33e07a4cc1fa313"></a>
  2611. <h2 class="memtitle"><span class="permalink"><a href="#a3ccce5ef4dd2bc53a33e07a4cc1fa313">&#9670;&#160;</a></span>tabComplete()</h2>
  2612. <div class="memitem">
  2613. <div class="memproto">
  2614. <table class="memname">
  2615. <tr>
  2616. <td class="memname">U32 tabComplete </td>
  2617. <td>(</td>
  2618. <td class="paramtype">char *&#160;</td>
  2619. <td class="paramname"><em>inputBuffer</em>, </td>
  2620. </tr>
  2621. <tr>
  2622. <td class="paramkey"></td>
  2623. <td></td>
  2624. <td class="paramtype">U32&#160;</td>
  2625. <td class="paramname"><em>cursorPos</em>, </td>
  2626. </tr>
  2627. <tr>
  2628. <td class="paramkey"></td>
  2629. <td></td>
  2630. <td class="paramtype">U32&#160;</td>
  2631. <td class="paramname"><em>maxResultLength</em>, </td>
  2632. </tr>
  2633. <tr>
  2634. <td class="paramkey"></td>
  2635. <td></td>
  2636. <td class="paramtype">bool&#160;</td>
  2637. <td class="paramname"><em>forwardTab</em>&#160;</td>
  2638. </tr>
  2639. <tr>
  2640. <td></td>
  2641. <td>)</td>
  2642. <td></td><td></td>
  2643. </tr>
  2644. </table>
  2645. </div><div class="memdoc">
  2646. <p>This is the basis for tab completion in the console.</p>
  2647. <dl class="section note"><dt>Note</dt><dd>This is an internally used function. You probably don't care much about how this works.</dd></dl>
  2648. <p>This function does some basic parsing to try to ascertain the namespace in which we are attempting to do tab completion, then bumps control off to the appropriate tabComplete function, either in <a class="el" href="class_sim_object.html">SimObject</a> or <a class="el" href="class_namespace.html">Namespace</a>.</p>
  2649. <dl class="params"><dt>Parameters</dt><dd>
  2650. <table class="params">
  2651. <tr><td class="paramname">inputBuffer</td><td>Pointer to buffer containing starting data, or last result. </td></tr>
  2652. <tr><td class="paramname">cursorPos</td><td>Location of cursor in this buffer. This is used to indicate what part of the string should be kept and what part should be advanced to the next match if any. </td></tr>
  2653. <tr><td class="paramname">maxResultLength</td><td>Maximum amount of result data to put into inputBuffer. This is capped by MaxCompletionBufferSize. </td></tr>
  2654. <tr><td class="paramname">forwardTab</td><td>Should we go forward to next match or backwards to previous match? True indicates forward. </td></tr>
  2655. </table>
  2656. </dd>
  2657. </dl>
  2658. </div>
  2659. </div>
  2660. <a id="a4d7b63382a84d1d9910407e1fd0ca449" name="a4d7b63382a84d1d9910407e1fd0ca449"></a>
  2661. <h2 class="memtitle"><span class="permalink"><a href="#a4d7b63382a84d1d9910407e1fd0ca449">&#9670;&#160;</a></span>unlinkNamespaces()</h2>
  2662. <div class="memitem">
  2663. <div class="memproto">
  2664. <table class="memname">
  2665. <tr>
  2666. <td class="memname">bool unlinkNamespaces </td>
  2667. <td>(</td>
  2668. <td class="paramtype">const char *&#160;</td>
  2669. <td class="paramname"><em>parent</em>, </td>
  2670. </tr>
  2671. <tr>
  2672. <td class="paramkey"></td>
  2673. <td></td>
  2674. <td class="paramtype">const char *&#160;</td>
  2675. <td class="paramname"><em>child</em>&#160;</td>
  2676. </tr>
  2677. <tr>
  2678. <td></td>
  2679. <td>)</td>
  2680. <td></td><td></td>
  2681. </tr>
  2682. </table>
  2683. </div><div class="memdoc">
  2684. </div>
  2685. </div>
  2686. <a id="a0fbda1952e95e63be5f2b96c5a140abc" name="a0fbda1952e95e63be5f2b96c5a140abc"></a>
  2687. <h2 class="memtitle"><span class="permalink"><a href="#a0fbda1952e95e63be5f2b96c5a140abc">&#9670;&#160;</a></span>unlockLog()</h2>
  2688. <div class="memitem">
  2689. <div class="memproto">
  2690. <table class="memname">
  2691. <tr>
  2692. <td class="memname">void unlockLog </td>
  2693. <td>(</td>
  2694. <td class="paramname"></td><td>)</td>
  2695. <td></td>
  2696. </tr>
  2697. </table>
  2698. </div><div class="memdoc">
  2699. </div>
  2700. </div>
  2701. <a id="a8559290355d1bfb41d57211f47a25805" name="a8559290355d1bfb41d57211f47a25805"></a>
  2702. <h2 class="memtitle"><span class="permalink"><a href="#a8559290355d1bfb41d57211f47a25805">&#9670;&#160;</a></span>warnf() <span class="overload">[1/2]</span></h2>
  2703. <div class="memitem">
  2704. <div class="memproto">
  2705. <table class="memname">
  2706. <tr>
  2707. <td class="memname">void warnf </td>
  2708. <td>(</td>
  2709. <td class="paramtype"><a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7">ConsoleLogEntry::Type</a>&#160;</td>
  2710. <td class="paramname"><em>type</em>, </td>
  2711. </tr>
  2712. <tr>
  2713. <td class="paramkey"></td>
  2714. <td></td>
  2715. <td class="paramtype">const char *&#160;</td>
  2716. <td class="paramname"><em>_format</em>, </td>
  2717. </tr>
  2718. <tr>
  2719. <td class="paramkey"></td>
  2720. <td></td>
  2721. <td class="paramtype">&#160;</td>
  2722. <td class="paramname"><em>...</em>&#160;</td>
  2723. </tr>
  2724. <tr>
  2725. <td></td>
  2726. <td>)</td>
  2727. <td></td><td></td>
  2728. </tr>
  2729. </table>
  2730. </div><div class="memdoc">
  2731. <dl class="section note"><dt>Note</dt><dd>The console window colors warning text as LIGHT GRAY. </dd></dl>
  2732. <dl class="params"><dt>Parameters</dt><dd>
  2733. <table class="params">
  2734. <tr><td class="paramname">type</td><td>Allows you to associate the warning message with an internal module. </td></tr>
  2735. <tr><td class="paramname">_format</td><td>A stdlib printf style formatted out put string </td></tr>
  2736. <tr><td class="paramname">...</td><td>Variables to be written </td></tr>
  2737. </table>
  2738. </dd>
  2739. </dl>
  2740. <dl class="section see"><dt>See also</dt><dd><a class="el" href="namespace_con.html#a8559290355d1bfb41d57211f47a25805">Con::warnf()</a> </dd></dl>
  2741. </div>
  2742. </div>
  2743. <a id="a2fa5ed97682afe78d32da12d0827d12d" name="a2fa5ed97682afe78d32da12d0827d12d"></a>
  2744. <h2 class="memtitle"><span class="permalink"><a href="#a2fa5ed97682afe78d32da12d0827d12d">&#9670;&#160;</a></span>warnf() <span class="overload">[2/2]</span></h2>
  2745. <div class="memitem">
  2746. <div class="memproto">
  2747. <table class="memname">
  2748. <tr>
  2749. <td class="memname">void warnf </td>
  2750. <td>(</td>
  2751. <td class="paramtype">const char *&#160;</td>
  2752. <td class="paramname"><em>_format</em>, </td>
  2753. </tr>
  2754. <tr>
  2755. <td class="paramkey"></td>
  2756. <td></td>
  2757. <td class="paramtype">&#160;</td>
  2758. <td class="paramname"><em>...</em>&#160;</td>
  2759. </tr>
  2760. <tr>
  2761. <td></td>
  2762. <td>)</td>
  2763. <td></td><td></td>
  2764. </tr>
  2765. </table>
  2766. </div><div class="memdoc">
  2767. <dl class="section note"><dt>Note</dt><dd>The console window colors warning text as LIGHT GRAY. </dd></dl>
  2768. <dl class="params"><dt>Parameters</dt><dd>
  2769. <table class="params">
  2770. <tr><td class="paramname">_format</td><td>A stdlib printf style formatted out put string </td></tr>
  2771. <tr><td class="paramname">...</td><td>Variables to be written </td></tr>
  2772. </table>
  2773. </dd>
  2774. </dl>
  2775. </div>
  2776. </div>
  2777. <h2 class="groupheader">Variable Documentation</h2>
  2778. <a id="a7589f755bdcac5afcff4a6bf7fa542a2" name="a7589f755bdcac5afcff4a6bf7fa542a2"></a>
  2779. <h2 class="memtitle"><span class="permalink"><a href="#a7589f755bdcac5afcff4a6bf7fa542a2">&#9670;&#160;</a></span>gCurrentFile</h2>
  2780. <div class="memitem">
  2781. <div class="memproto">
  2782. <table class="memname">
  2783. <tr>
  2784. <td class="memname">StringTableEntry gCurrentFile</td>
  2785. </tr>
  2786. </table>
  2787. </div><div class="memdoc">
  2788. <p>Current script file name and root, these are registered as console variables. </p>
  2789. </div>
  2790. </div>
  2791. <a id="a83de8ac9ca13363b9f70ab5a09098e82" name="a83de8ac9ca13363b9f70ab5a09098e82"></a>
  2792. <h2 class="memtitle"><span class="permalink"><a href="#a83de8ac9ca13363b9f70ab5a09098e82">&#9670;&#160;</a></span>gCurrentRoot</h2>
  2793. <div class="memitem">
  2794. <div class="memproto">
  2795. <table class="memname">
  2796. <tr>
  2797. <td class="memname">StringTableEntry gCurrentRoot</td>
  2798. </tr>
  2799. </table>
  2800. </div><div class="memdoc">
  2801. </div>
  2802. </div>
  2803. </div><!-- contents -->
  2804. <!-- start footer part -->
  2805. <hr class="footer"/><address class="footer"><small>
  2806. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  2807. </small></address>
  2808. </body>
  2809. </html>