| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Torque2D Reference: SimObject Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">Torque2D Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Classes</a> |
- <a href="#pub-types">Public Types</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="#pro-static-methods">Static Protected Member Functions</a> |
- <a href="#pro-attribs">Protected Attributes</a> |
- <a href="#friends">Friends</a> |
- <a href="class_sim_object-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">SimObject Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <simObject.h></code></p>
- <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
- <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for SimObject:</div>
- <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
- </div>
- <div id="dynsection-0-content" class="dyncontent" style="display:none;">
- <div class="center">
- <img src="class_sim_object.png" usemap="#SimObject_map" alt=""/>
- <map id="SimObject_map" name="SimObject_map">
- <area href="class_console_object.html" alt="ConsoleObject" shape="rect" coords="0,0,145,24"/>
- <area href="class_taml_callbacks.html" alt="TamlCallbacks" shape="rect" coords="155,0,300,24"/>
- <area href="class_action_map.html" alt="ActionMap" shape="rect" coords="232,112,377,136"/>
- <area href="class_android_stream_source.html" alt="AndroidStreamSource" shape="rect" coords="232,168,377,192"/>
- <area href="class_array.html" title="A data structure holding indexed sequences of key/value pairs for script use." alt="Array" shape="rect" coords="232,224,377,248"/>
- <area href="class_asset_base.html" alt="AssetBase" shape="rect" coords="232,280,377,304"/>
- <area href="class_asset_manager.html" alt="AssetManager" shape="rect" coords="232,336,377,360"/>
- <area href="class_asset_query.html" alt="AssetQuery" shape="rect" coords="232,392,377,416"/>
- <area href="class_asset_tags_manifest.html" alt="AssetTagsManifest" shape="rect" coords="232,448,377,472"/>
- <area href="class_behavior_instance.html" alt="BehaviorInstance" shape="rect" coords="232,504,377,528"/>
- <area href="class_behavior_template.html" alt="BehaviorTemplate" shape="rect" coords="232,560,377,584"/>
- <area href="class_console_logger.html" alt="ConsoleLogger" shape="rect" coords="232,616,377,640"/>
- <area href="class_declared_assets.html" alt="DeclaredAssets" shape="rect" coords="232,672,377,696"/>
- <area href="class_dynamic_texture.html" alt="DynamicTexture" shape="rect" coords="232,728,377,752"/>
- <area href="class_editor_toy_tool.html" alt="EditorToyTool" shape="rect" coords="232,784,377,808"/>
- <area href="class_event_manager.html" alt="EventManager" shape="rect" coords="232,840,377,864"/>
- <area href="class_file_dialog.html" alt="FileDialog" shape="rect" coords="232,896,377,920"/>
- <area href="class_file_object.html" alt="FileObject" shape="rect" coords="232,952,377,976"/>
- <area href="class_gui_border_profile.html" alt="GuiBorderProfile" shape="rect" coords="232,1008,377,1032"/>
- <area href="class_gui_control_profile.html" alt="GuiControlProfile" shape="rect" coords="232,1064,377,1088"/>
- <area href="class_gui_cursor.html" alt="GuiCursor" shape="rect" coords="232,1120,377,1144"/>
- <area href="class_input_device.html" alt="InputDevice" shape="rect" coords="232,1176,377,1200"/>
- <area href="class_lang_table.html" title="Language file table." alt="LangTable" shape="rect" coords="232,1232,377,1256"/>
- <area href="class_message.html" title="Base class for messages." alt="Message" shape="rect" coords="232,1288,377,1312"/>
- <area href="class_message_vector.html" alt="MessageVector" shape="rect" coords="232,1344,377,1368"/>
- <area href="class_module_manager.html" alt="ModuleManager" shape="rect" coords="232,1400,377,1424"/>
- <area href="class_module_merge_definition.html" alt="ModuleMergeDefinition" shape="rect" coords="232,1456,377,1480"/>
- <area href="class_net_object.html" alt="NetObject" shape="rect" coords="232,1512,377,1536"/>
- <area href="class_p_n_g_image.html" alt="PNGImage" shape="rect" coords="232,1568,377,1592"/>
- <area href="class_particle_asset_emitter.html" alt="ParticleAssetEmitter" shape="rect" coords="232,1624,377,1648"/>
- <area href="class_picking_scene_controller.html" alt="PickingSceneController" shape="rect" coords="232,1680,377,1704"/>
- <area href="class_popup_menu.html" alt="PopupMenu" shape="rect" coords="232,1736,377,1760"/>
- <area href="class_referenced_assets.html" alt="ReferencedAssets" shape="rect" coords="232,1792,377,1816"/>
- <area href="class_remote_debugger_base.html" alt="RemoteDebuggerBase" shape="rect" coords="232,1848,377,1872"/>
- <area href="class_render_proxy.html" alt="RenderProxy" shape="rect" coords="232,1904,377,1928"/>
- <area href="class_scene_object_set.html" alt="SceneObjectSet" shape="rect" coords="232,1960,377,1984"/>
- <area href="class_script_msg_listener.html" title="Script accessible version of Dispatcher::IMessageListener." alt="ScriptMsgListener" shape="rect" coords="232,2016,377,2040"/>
- <area href="class_sim_component.html" alt="SimComponent" shape="rect" coords="232,2072,377,2096"/>
- <area href="class_sim_data_block.html" alt="SimDataBlock" shape="rect" coords="232,2128,377,2152"/>
- <area href="class_sim_set.html" alt="SimSet" shape="rect" coords="232,2184,377,2208"/>
- <area href="class_sim_x_m_l_document.html" alt="SimXMLDocument" shape="rect" coords="232,2240,377,2264"/>
- <area href="class_stream_object.html" title="Script wrapper for the Stream class." alt="StreamObject" shape="rect" coords="232,2296,377,2320"/>
- <area href="class_t_c_p_object.html" alt="TCPObject" shape="rect" coords="232,2352,377,2376"/>
- <area href="class_taml.html" alt="Taml" shape="rect" coords="232,2408,377,2432"/>
- <area href="class_undo_action.html" alt="UndoAction" shape="rect" coords="232,2464,377,2488"/>
- <area href="class_undo_manager.html" alt="UndoManager" shape="rect" coords="232,2520,377,2544"/>
- <area href="class_world_query.html" alt="WorldQuery" shape="rect" coords="232,2576,377,2600"/>
- <area href="class_zip_object.html" title="Script wrapper for Zip::ZipArchive." alt="ZipObject" shape="rect" coords="232,2632,377,2656"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
- Classes</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_sim_object_1_1_notify.html">Notify</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
- Public Types</h2></td></tr>
- <tr class="memitem:aa764d6ab46a34397a2a625235de83577" id="r_aa764d6ab46a34397a2a625235de83577"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aa764d6ab46a34397a2a625235de83577">WriteFlags</a> { <a class="el" href="class_sim_object.html#aa764d6ab46a34397a2a625235de83577a03224eeb724e582e75ae323a49e31156">SelectedOnly</a> = BIT(0)
- }</td></tr>
- <tr class="separator:aa764d6ab46a34397a2a625235de83577"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a8defc59286e7d323201bbeb1a07c2554" id="r_a8defc59286e7d323201bbeb1a07c2554"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8defc59286e7d323201bbeb1a07c2554">getClassNamespace</a> () const</td></tr>
- <tr class="separator:a8defc59286e7d323201bbeb1a07c2554"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab4678bf80f0b627902ea12e02ccd9db0" id="r_ab4678bf80f0b627902ea12e02ccd9db0"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ab4678bf80f0b627902ea12e02ccd9db0">getSuperClassNamespace</a> () const</td></tr>
- <tr class="separator:ab4678bf80f0b627902ea12e02ccd9db0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8e60d73cee05c995ed9bec7ee248cad3" id="r_a8e60d73cee05c995ed9bec7ee248cad3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8e60d73cee05c995ed9bec7ee248cad3">setClassNamespace</a> (const char *classNamespace)</td></tr>
- <tr class="separator:a8e60d73cee05c995ed9bec7ee248cad3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abeb83ab949786a5de00558e024c2efd5" id="r_abeb83ab949786a5de00558e024c2efd5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#abeb83ab949786a5de00558e024c2efd5">setSuperClassNamespace</a> (const char *superClassNamespace)</td></tr>
- <tr class="separator:abeb83ab949786a5de00558e024c2efd5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0f1470540933ff4bd9227e116f8ec135" id="r_a0f1470540933ff4bd9227e116f8ec135"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a0f1470540933ff4bd9227e116f8ec135">pushScriptCallbackGuard</a> (void)</td></tr>
- <tr class="separator:a0f1470540933ff4bd9227e116f8ec135"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab54472a52381c54f13657d6ea3cd4a1b" id="r_ab54472a52381c54f13657d6ea3cd4a1b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ab54472a52381c54f13657d6ea3cd4a1b">popScriptCallbackGuard</a> (void)</td></tr>
- <tr class="separator:ab54472a52381c54f13657d6ea3cd4a1b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a818bf0b599f807adffb0562ba8b19f28" id="r_a818bf0b599f807adffb0562ba8b19f28"><td class="memItemLeft" align="right" valign="top">S32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a818bf0b599f807adffb0562ba8b19f28">getScriptCallbackGuard</a> (void)</td></tr>
- <tr class="separator:a818bf0b599f807adffb0562ba8b19f28"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea6dde4400c9c8a5bd378a89a055cf92" id="r_aea6dde4400c9c8a5bd378a89a055cf92"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_sim_object.html">SimObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aea6dde4400c9c8a5bd378a89a055cf92">findObject</a> (const char *name)</td></tr>
- <tr class="separator:aea6dde4400c9c8a5bd378a89a055cf92"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7122ae5ad0933f2041746e4c80757269" id="r_a7122ae5ad0933f2041746e4c80757269"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_namespace.html">Namespace</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a7122ae5ad0933f2041746e4c80757269">getNamespace</a> ()</td></tr>
- <tr class="memdesc:a7122ae5ad0933f2041746e4c80757269"><td class="mdescLeft"> </td><td class="mdescRight">Return the object's namespace. <br /></td></tr>
- <tr class="separator:a7122ae5ad0933f2041746e4c80757269"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acd454ef0ad63af6686f09aad336f290f" id="r_acd454ef0ad63af6686f09aad336f290f"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#acd454ef0ad63af6686f09aad336f290f">tabComplete</a> (const char *prevText, S32 baseLen, bool)</td></tr>
- <tr class="separator:acd454ef0ad63af6686f09aad336f290f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c" id="r_accd2600060dbaee3a3b41aed4034c63c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
- <tr class="separator:accd2600060dbaee3a3b41aed4034c63c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a" id="r_a1810f5aba25efd242c24232c2c2bbd1a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
- <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aacb30b9c403e8687e109b7738af141d8" id="r_aacb30b9c403e8687e109b7738af141d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sim_object.html">SimObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aacb30b9c403e8687e109b7738af141d8">clone</a> (const bool copyDynamicFields)</td></tr>
- <tr class="separator:aacb30b9c403e8687e109b7738af141d8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a62aa4e3f1aea3c0841234882d0105c1b" id="r_a62aa4e3f1aea3c0841234882d0105c1b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a62aa4e3f1aea3c0841234882d0105c1b">copyTo</a> (<a class="el" href="class_sim_object.html">SimObject</a> *object)</td></tr>
- <tr class="separator:a62aa4e3f1aea3c0841234882d0105c1b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a526b0ae2c04966128bcbb3c12f5a283d" id="r_a526b0ae2c04966128bcbb3c12f5a283d"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:a526b0ae2c04966128bcbb3c12f5a283d"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a526b0ae2c04966128bcbb3c12f5a283d">isType</a> (void)</td></tr>
- <tr class="separator:a526b0ae2c04966128bcbb3c12f5a283d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a76fd3b455488c03e0c8683b836ee96a2" id="r_a76fd3b455488c03e0c8683b836ee96a2"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a76fd3b455488c03e0c8683b836ee96a2">handlesConsoleMethod</a> (const char *fname, S32 *routingId)</td></tr>
- <tr class="separator:a76fd3b455488c03e0c8683b836ee96a2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5347739a7bbaab1de0130ac29073dcfd" id="r_a5347739a7bbaab1de0130ac29073dcfd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a5347739a7bbaab1de0130ac29073dcfd">DECLARE_CONOBJECT</a> (<a class="el" href="class_sim_object.html">SimObject</a>)</td></tr>
- <tr class="separator:a5347739a7bbaab1de0130ac29073dcfd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_console_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_console_object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_console_object.html">ConsoleObject</a></td></tr>
- <tr class="memitem:a1126670f9cef40e89f356669cd373252 inherit pub_methods_class_console_object" id="r_a1126670f9cef40e89f356669cd373252"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_abstract_class_rep_1_1_field.html">AbstractClassRep::Field</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a1126670f9cef40e89f356669cd373252">findField</a> (StringTableEntry fieldName) const</td></tr>
- <tr class="memdesc:a1126670f9cef40e89f356669cd373252 inherit pub_methods_class_console_object"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to a field by name. <br /></td></tr>
- <tr class="separator:a1126670f9cef40e89f356669cd373252 inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa8453ccfe6d778d5612ae246b05c488b inherit pub_methods_class_console_object" id="r_aa8453ccfe6d778d5612ae246b05c488b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#aa8453ccfe6d778d5612ae246b05c488b">getClassRep</a> () const</td></tr>
- <tr class="memdesc:aa8453ccfe6d778d5612ae246b05c488b inherit pub_methods_class_console_object"><td class="mdescLeft"> </td><td class="mdescRight">Gets the ClassRep. <br /></td></tr>
- <tr class="separator:aa8453ccfe6d778d5612ae246b05c488b inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac980ffce7987a95385fe04d6fd934a6a inherit pub_methods_class_console_object" id="r_ac980ffce7987a95385fe04d6fd934a6a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ac980ffce7987a95385fe04d6fd934a6a">setField</a> (const char *fieldName, const char *value)</td></tr>
- <tr class="memdesc:ac980ffce7987a95385fe04d6fd934a6a inherit pub_methods_class_console_object"><td class="mdescLeft"> </td><td class="mdescRight">Set the value of a field. <br /></td></tr>
- <tr class="separator:ac980ffce7987a95385fe04d6fd934a6a inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a648a403aff97cfb8f198fad055feea64 inherit pub_methods_class_console_object" id="r_a648a403aff97cfb8f198fad055feea64"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a648a403aff97cfb8f198fad055feea64">~ConsoleObject</a> ()</td></tr>
- <tr class="separator:a648a403aff97cfb8f198fad055feea64 inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2f9f31b3f4acbf8bdfefa15f78c49729 inherit pub_methods_class_console_object" id="r_a2f9f31b3f4acbf8bdfefa15f78c49729"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_abstract_class_rep.html#a470d9814acbdf9bd6a2b054c6ff7f3a6">AbstractClassRep::FieldList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a2f9f31b3f4acbf8bdfefa15f78c49729">getFieldList</a> () const</td></tr>
- <tr class="memdesc:a2f9f31b3f4acbf8bdfefa15f78c49729 inherit pub_methods_class_console_object"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of all the fields. This information cannot be modified. <br /></td></tr>
- <tr class="separator:a2f9f31b3f4acbf8bdfefa15f78c49729 inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab33e449170ae2f52341c47138da4996c inherit pub_methods_class_console_object" id="r_ab33e449170ae2f52341c47138da4996c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_abstract_class_rep.html#a470d9814acbdf9bd6a2b054c6ff7f3a6">AbstractClassRep::FieldList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ab33e449170ae2f52341c47138da4996c">getModifiableFieldList</a> ()</td></tr>
- <tr class="separator:ab33e449170ae2f52341c47138da4996c inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a546fd9261e6104b86b947e417bef1228 inherit pub_methods_class_console_object" id="r_a546fd9261e6104b86b947e417bef1228"><td class="memItemLeft" align="right" valign="top">bool & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a546fd9261e6104b86b947e417bef1228">getDynamicGroupExpand</a> ()</td></tr>
- <tr class="separator:a546fd9261e6104b86b947e417bef1228 inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae7913c7a8d1966a725b93f657456b66a inherit pub_methods_class_console_object" id="r_ae7913c7a8d1966a725b93f657456b66a"><td class="memItemLeft" align="right" valign="top">S32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ae7913c7a8d1966a725b93f657456b66a">getClassId</a> (U32 netClassGroup) const</td></tr>
- <tr class="separator:ae7913c7a8d1966a725b93f657456b66a inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a45b489f436c9d32a63f9c3d62f66c892 inherit pub_methods_class_console_object" id="r_a45b489f436c9d32a63f9c3d62f66c892"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a45b489f436c9d32a63f9c3d62f66c892">getClassName</a> () const</td></tr>
- <tr class="separator:a45b489f436c9d32a63f9c3d62f66c892 inherit pub_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a67420d3593db1aae6efb2c3abb23c690" id="r_a67420d3593db1aae6efb2c3abb23c690"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a67420d3593db1aae6efb2c3abb23c690">initPersistFields</a> ()</td></tr>
- <tr class="separator:a67420d3593db1aae6efb2c3abb23c690"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_static_methods_class_console_object"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_console_object')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_console_object.html">ConsoleObject</a></td></tr>
- <tr class="memitem:a336cc354c2d28bd8a502405466282db9 inherit pub_static_methods_class_console_object" id="r_a336cc354c2d28bd8a502405466282db9"><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a336cc354c2d28bd8a502405466282db9">lookupClassName</a> (const U32 in_classTag)</td></tr>
- <tr class="memdesc:a336cc354c2d28bd8a502405466282db9 inherit pub_static_methods_class_console_object"><td class="mdescLeft"> </td><td class="mdescRight">Get the classname from a class tag. <br /></td></tr>
- <tr class="separator:a336cc354c2d28bd8a502405466282db9 inherit pub_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a67420d3593db1aae6efb2c3abb23c690 inherit pub_static_methods_class_console_object" id="r_a67420d3593db1aae6efb2c3abb23c690"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a67420d3593db1aae6efb2c3abb23c690">initPersistFields</a> ()</td></tr>
- <tr class="separator:a67420d3593db1aae6efb2c3abb23c690 inherit pub_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a95c239afc15d197ae11798bc11e5c28b inherit pub_static_methods_class_console_object" id="r_a95c239afc15d197ae11798bc11e5c28b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a95c239afc15d197ae11798bc11e5c28b">consoleInit</a> ()</td></tr>
- <tr class="separator:a95c239afc15d197ae11798bc11e5c28b inherit pub_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af6128f2158606edc40e1cb210ba92bd0 inherit pub_static_methods_class_console_object" id="r_af6128f2158606edc40e1cb210ba92bd0"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#af6128f2158606edc40e1cb210ba92bd0">getStaticClassRep</a> ()</td></tr>
- <tr class="memdesc:af6128f2158606edc40e1cb210ba92bd0 inherit pub_static_methods_class_console_object"><td class="mdescLeft"> </td><td class="mdescRight">Get the abstract class information for this class. <br /></td></tr>
- <tr class="separator:af6128f2158606edc40e1cb210ba92bd0 inherit pub_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac93219672441a5e91bcfc02abeed29cb inherit pub_static_methods_class_console_object" id="r_ac93219672441a5e91bcfc02abeed29cb"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_abstract_class_rep.html">AbstractClassRep</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ac93219672441a5e91bcfc02abeed29cb">getParentStaticClassRep</a> ()</td></tr>
- <tr class="memdesc:ac93219672441a5e91bcfc02abeed29cb inherit pub_static_methods_class_console_object"><td class="mdescLeft"> </td><td class="mdescRight">Get the abstract class information for this class's superclass. <br /></td></tr>
- <tr class="separator:ac93219672441a5e91bcfc02abeed29cb inherit pub_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa8b4ee59c729a0704b4a2f7b52246f98 inherit pub_static_methods_class_console_object" id="r_aa8b4ee59c729a0704b4a2f7b52246f98"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_console_object.html">ConsoleObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#aa8b4ee59c729a0704b4a2f7b52246f98">create</a> (const char *in_pClassName)</td></tr>
- <tr class="separator:aa8b4ee59c729a0704b4a2f7b52246f98 inherit pub_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abeb358d6fc89fc282b4e401de2895965 inherit pub_static_methods_class_console_object" id="r_abeb358d6fc89fc282b4e401de2895965"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_console_object.html">ConsoleObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#abeb358d6fc89fc282b4e401de2895965">create</a> (const U32 groupId, const U32 typeId, const U32 in_classId)</td></tr>
- <tr class="separator:abeb358d6fc89fc282b4e401de2895965 inherit pub_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:a3b0caf75cb0eccb9fb63406b813c431d" id="r_a3b0caf75cb0eccb9fb63406b813c431d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a3b0caf75cb0eccb9fb63406b813c431d">onTamlPreWrite</a> (void)</td></tr>
- <tr class="memdesc:a3b0caf75cb0eccb9fb63406b813c431d"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_taml.html">Taml</a> callbacks. <br /></td></tr>
- <tr class="separator:a3b0caf75cb0eccb9fb63406b813c431d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1baf86d5d5d9f1c2190e7bb72aacb068" id="r_a1baf86d5d5d9f1c2190e7bb72aacb068"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a1baf86d5d5d9f1c2190e7bb72aacb068">onTamlPostWrite</a> (void)</td></tr>
- <tr class="memdesc:a1baf86d5d5d9f1c2190e7bb72aacb068"><td class="mdescLeft"> </td><td class="mdescRight">Called after <a class="el" href="class_taml.html">Taml</a> has finished writing the object. <br /></td></tr>
- <tr class="separator:a1baf86d5d5d9f1c2190e7bb72aacb068"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af3830391b29fe4e30779260612049995" id="r_af3830391b29fe4e30779260612049995"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#af3830391b29fe4e30779260612049995">onTamlPreRead</a> (void)</td></tr>
- <tr class="memdesc:af3830391b29fe4e30779260612049995"><td class="mdescLeft"> </td><td class="mdescRight">Called prior to <a class="el" href="class_taml.html">Taml</a> reading the object. <br /></td></tr>
- <tr class="separator:af3830391b29fe4e30779260612049995"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8d896544fb75ff4b98cac3099bf5f55f" id="r_a8d896544fb75ff4b98cac3099bf5f55f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8d896544fb75ff4b98cac3099bf5f55f">onTamlPostRead</a> (const <a class="el" href="class_taml_custom_nodes.html">TamlCustomNodes</a> &customNodes)</td></tr>
- <tr class="separator:a8d896544fb75ff4b98cac3099bf5f55f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad03b42162545e4be24b218369f4fbcf5" id="r_ad03b42162545e4be24b218369f4fbcf5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ad03b42162545e4be24b218369f4fbcf5">onTamlAddParent</a> (<a class="el" href="class_sim_object.html">SimObject</a> *pParentObject)</td></tr>
- <tr class="memdesc:ad03b42162545e4be24b218369f4fbcf5"><td class="mdescLeft"> </td><td class="mdescRight">Called after <a class="el" href="class_taml.html">Taml</a> has finished reading the object and has added the object to any parent. <br /></td></tr>
- <tr class="separator:ad03b42162545e4be24b218369f4fbcf5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a037d9b99b69dbd817a78b7a7758d1a69" id="r_a037d9b99b69dbd817a78b7a7758d1a69"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a037d9b99b69dbd817a78b7a7758d1a69">onTamlCustomWrite</a> (<a class="el" href="class_taml_custom_nodes.html">TamlCustomNodes</a> &customNodes)</td></tr>
- <tr class="memdesc:a037d9b99b69dbd817a78b7a7758d1a69"><td class="mdescLeft"> </td><td class="mdescRight">Called during the writing of the object to allow custom properties to be written. <br /></td></tr>
- <tr class="separator:a037d9b99b69dbd817a78b7a7758d1a69"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3d9c05e2d4a4ba16cc11dc7949015a3e" id="r_a3d9c05e2d4a4ba16cc11dc7949015a3e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a3d9c05e2d4a4ba16cc11dc7949015a3e">onTamlCustomRead</a> (const <a class="el" href="class_taml_custom_nodes.html">TamlCustomNodes</a> &customNodes)</td></tr>
- <tr class="memdesc:a3d9c05e2d4a4ba16cc11dc7949015a3e"><td class="mdescLeft"> </td><td class="mdescRight">Called during the reading of the object to allow custom properties to be read. <br /></td></tr>
- <tr class="separator:a3d9c05e2d4a4ba16cc11dc7949015a3e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9d1bbaa7a9b2443eeb39c4a127d9f9e8" id="r_a9d1bbaa7a9b2443eeb39c4a127d9f9e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a9d1bbaa7a9b2443eeb39c4a127d9f9e8">linkNamespaces</a> ()</td></tr>
- <tr class="separator:a9d1bbaa7a9b2443eeb39c4a127d9f9e8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a97551603378a0bbc3d3d98326a56631e" id="r_a97551603378a0bbc3d3d98326a56631e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a97551603378a0bbc3d3d98326a56631e">unlinkNamespaces</a> ()</td></tr>
- <tr class="separator:a97551603378a0bbc3d3d98326a56631e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_methods_class_console_object"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_console_object')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_console_object.html">ConsoleObject</a></td></tr>
- <tr class="memitem:a8b5a944ed3b7fa672a250a5d389c8f15 inherit pro_methods_class_console_object" id="r_a8b5a944ed3b7fa672a250a5d389c8f15"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a8b5a944ed3b7fa672a250a5d389c8f15">ConsoleObject</a> ()</td></tr>
- <tr class="separator:a8b5a944ed3b7fa672a250a5d389c8f15 inherit pro_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a601f42ddcee97ab4eee59e6dbc9df75b inherit pro_methods_class_console_object" id="r_a601f42ddcee97ab4eee59e6dbc9df75b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a601f42ddcee97ab4eee59e6dbc9df75b">ConsoleObject</a> (const <a class="el" href="class_console_object.html">ConsoleObject</a> &)</td></tr>
- <tr class="separator:a601f42ddcee97ab4eee59e6dbc9df75b inherit pro_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-methods" name="pro-static-methods"></a>
- Static Protected Member Functions</h2></td></tr>
- <tr class="memitem:a238c87f71783e3654af75d5ca4a84ae8" id="r_a238c87f71783e3654af75d5ca4a84ae8"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a238c87f71783e3654af75d5ca4a84ae8">setClass</a> (void *obj, const char *data)</td></tr>
- <tr class="separator:a238c87f71783e3654af75d5ca4a84ae8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a43001ba1a3e2861eb120a04cf0796588" id="r_a43001ba1a3e2861eb120a04cf0796588"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a43001ba1a3e2861eb120a04cf0796588">setSuperClass</a> (void *obj, const char *data)</td></tr>
- <tr class="separator:a43001ba1a3e2861eb120a04cf0796588"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a050c10f238d99841ebaf065d96054342" id="r_a050c10f238d99841ebaf065d96054342"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a050c10f238d99841ebaf065d96054342">writeObjectName</a> (void *obj, StringTableEntry pFieldName)</td></tr>
- <tr class="separator:a050c10f238d99841ebaf065d96054342"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa7652122ac6a5cf7337b0e7a7b3825e5" id="r_aa7652122ac6a5cf7337b0e7a7b3825e5"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aa7652122ac6a5cf7337b0e7a7b3825e5">writeCanSaveDynamicFields</a> (void *obj, StringTableEntry pFieldName)</td></tr>
- <tr class="separator:aa7652122ac6a5cf7337b0e7a7b3825e5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a57d090bc62bb37dd4a36dab7d5538ad4" id="r_a57d090bc62bb37dd4a36dab7d5538ad4"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a57d090bc62bb37dd4a36dab7d5538ad4">writeInternalName</a> (void *obj, StringTableEntry pFieldName)</td></tr>
- <tr class="separator:a57d090bc62bb37dd4a36dab7d5538ad4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1f5140e6ccbc12845db7038be8c8c2e1" id="r_a1f5140e6ccbc12845db7038be8c8c2e1"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a1f5140e6ccbc12845db7038be8c8c2e1">setParentGroup</a> (void *obj, const char *data)</td></tr>
- <tr class="separator:a1f5140e6ccbc12845db7038be8c8c2e1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad11229fc0e726de20183e61c4e963904" id="r_ad11229fc0e726de20183e61c4e963904"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ad11229fc0e726de20183e61c4e963904">writeParentGroup</a> (void *obj, StringTableEntry pFieldName)</td></tr>
- <tr class="separator:ad11229fc0e726de20183e61c4e963904"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1a0d756e0d41114cfb264c5a0a38399b" id="r_a1a0d756e0d41114cfb264c5a0a38399b"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a1a0d756e0d41114cfb264c5a0a38399b">writeSuperclass</a> (void *obj, StringTableEntry pFieldName)</td></tr>
- <tr class="separator:a1a0d756e0d41114cfb264c5a0a38399b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3753e8d47c78c8b6c39f5a1df2586d45" id="r_a3753e8d47c78c8b6c39f5a1df2586d45"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a3753e8d47c78c8b6c39f5a1df2586d45">writeClass</a> (void *obj, StringTableEntry pFieldName)</td></tr>
- <tr class="separator:a3753e8d47c78c8b6c39f5a1df2586d45"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a359e31abae34476f5e76b43114058166" id="r_a359e31abae34476f5e76b43114058166"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a359e31abae34476f5e76b43114058166">setProtectedName</a> (void *obj, const char *data)</td></tr>
- <tr class="separator:a359e31abae34476f5e76b43114058166"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pro_static_methods_class_console_object"><td colspan="2" onclick="javascript:toggleInherit('pro_static_methods_class_console_object')"><img src="closed.png" alt="-"/> Static Protected Member Functions inherited from <a class="el" href="class_console_object.html">ConsoleObject</a></td></tr>
- <tr class="memitem:a38f3095c01e8b2055e4c2e58d9a133e8 inherit pro_static_methods_class_console_object" id="r_a38f3095c01e8b2055e4c2e58d9a133e8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a38f3095c01e8b2055e4c2e58d9a133e8">addGroup</a> (const char *in_pGroupname, const char *in_pGroupDocs=NULL)</td></tr>
- <tr class="separator:a38f3095c01e8b2055e4c2e58d9a133e8 inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1918263ead95ed1906c7027651938e0c inherit pro_static_methods_class_console_object" id="r_a1918263ead95ed1906c7027651938e0c"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a1918263ead95ed1906c7027651938e0c">endGroup</a> (const char *in_pGroupname)</td></tr>
- <tr class="separator:a1918263ead95ed1906c7027651938e0c inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1e61452413a8cd497dfc1a2b62f072cd inherit pro_static_methods_class_console_object" id="r_a1e61452413a8cd497dfc1a2b62f072cd"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a1e61452413a8cd497dfc1a2b62f072cd">addField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, <a class="el" href="struct_enum_table.html">EnumTable</a> *in_table=NULL, const char *in_pFieldDocs=NULL)</td></tr>
- <tr class="separator:a1e61452413a8cd497dfc1a2b62f072cd inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad4ad51d247b2e09ea51783a8fdbb4b95 inherit pro_static_methods_class_console_object" id="r_ad4ad51d247b2e09ea51783a8fdbb4b95"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ad4ad51d247b2e09ea51783a8fdbb4b95">addField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a> in_writeDataFn, const U32 in_elementCount=1, <a class="el" href="struct_enum_table.html">EnumTable</a> *in_table=NULL, const char *in_pFieldDocs=NULL)</td></tr>
- <tr class="separator:ad4ad51d247b2e09ea51783a8fdbb4b95 inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7fe0d513b2bea8f6a1710c35189f550c inherit pro_static_methods_class_console_object" id="r_a7fe0d513b2bea8f6a1710c35189f550c"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a7fe0d513b2bea8f6a1710c35189f550c">addField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char *in_pFieldDocs)</td></tr>
- <tr class="separator:a7fe0d513b2bea8f6a1710c35189f550c inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a83176674ac909724b9ba2dce44a71e9a inherit pro_static_methods_class_console_object" id="r_a83176674ac909724b9ba2dce44a71e9a"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a83176674ac909724b9ba2dce44a71e9a">addField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a> in_writeDataFn, const char *in_pFieldDocs)</td></tr>
- <tr class="separator:a83176674ac909724b9ba2dce44a71e9a inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3356a3140575cbc1e4466883937daf0b inherit pro_static_methods_class_console_object" id="r_a3356a3140575cbc1e4466883937daf0b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a3356a3140575cbc1e4466883937daf0b">addFieldV</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_console_type_validator.html">ConsoleTypeValidator</a> *v, const char *in_pFieldDocs=NULL)</td></tr>
- <tr class="separator:a3356a3140575cbc1e4466883937daf0b inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae5af434e7146816044ce3be70f61ebb8 inherit pro_static_methods_class_console_object" id="r_ae5af434e7146816044ce3be70f61ebb8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#ae5af434e7146816044ce3be70f61ebb8">addProtectedField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a> in_setDataFn, <a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a> in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, <a class="el" href="struct_enum_table.html">EnumTable</a> *in_table=NULL, const char *in_pFieldDocs=NULL)</td></tr>
- <tr class="separator:ae5af434e7146816044ce3be70f61ebb8 inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5161f628159e510b744cef47fd6598a3 inherit pro_static_methods_class_console_object" id="r_a5161f628159e510b744cef47fd6598a3"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a5161f628159e510b744cef47fd6598a3">addProtectedField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a> in_setDataFn, <a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a> in_getDataFn=&defaultProtectedGetFn, <a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a> in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, <a class="el" href="struct_enum_table.html">EnumTable</a> *in_table=NULL, const char *in_pFieldDocs=NULL)</td></tr>
- <tr class="separator:a5161f628159e510b744cef47fd6598a3 inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2df2d873096113f009661c676c4d0c81 inherit pro_static_methods_class_console_object" id="r_a2df2d873096113f009661c676c4d0c81"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a2df2d873096113f009661c676c4d0c81">addProtectedField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a> in_setDataFn, <a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a> in_getDataFn=&defaultProtectedGetFn, const char *in_pFieldDocs=NULL)</td></tr>
- <tr class="separator:a2df2d873096113f009661c676c4d0c81 inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aed96a36e73e2eee15cf6a3ae1412d9bd inherit pro_static_methods_class_console_object" id="r_aed96a36e73e2eee15cf6a3ae1412d9bd"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#aed96a36e73e2eee15cf6a3ae1412d9bd">addProtectedField</a> (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, <a class="el" href="class_abstract_class_rep.html#a23fe751b9b844d180a5e8ee921968aa5">AbstractClassRep::SetDataNotify</a> in_setDataFn, <a class="el" href="class_abstract_class_rep.html#a11f286fc60ce139f916571059ec35e22">AbstractClassRep::GetDataNotify</a> in_getDataFn=&defaultProtectedGetFn, <a class="el" href="class_abstract_class_rep.html#ab897bbd2116b331da38ac71717dbb3b3">AbstractClassRep::WriteDataNotify</a> in_writeDataFn=&defaultProtectedWriteFn, const char *in_pFieldDocs=NULL)</td></tr>
- <tr class="separator:aed96a36e73e2eee15cf6a3ae1412d9bd inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aed3d0d1abd7ba4a17e792ca80f3478a7 inherit pro_static_methods_class_console_object" id="r_aed3d0d1abd7ba4a17e792ca80f3478a7"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#aed3d0d1abd7ba4a17e792ca80f3478a7">addDepricatedField</a> (const char *fieldName)</td></tr>
- <tr class="separator:aed3d0d1abd7ba4a17e792ca80f3478a7 inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a47772574721164fe83b2fd5e3c6fc8 inherit pro_static_methods_class_console_object" id="r_a7a47772574721164fe83b2fd5e3c6fc8"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_console_object.html#a7a47772574721164fe83b2fd5e3c6fc8">removeField</a> (const char *in_pFieldname)</td></tr>
- <tr class="separator:a7a47772574721164fe83b2fd5e3c6fc8 inherit pro_static_methods_class_console_object"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
- Protected Attributes</h2></td></tr>
- <tr class="memitem:a084af54739c09b7f36838bd505d3f683" id="r_a084af54739c09b7f36838bd505d3f683"><td class="memItemLeft" align="right" valign="top">SimObjectId </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a084af54739c09b7f36838bd505d3f683">mId</a></td></tr>
- <tr class="memdesc:a084af54739c09b7f36838bd505d3f683"><td class="mdescLeft"> </td><td class="mdescRight">Id number for this object. <br /></td></tr>
- <tr class="separator:a084af54739c09b7f36838bd505d3f683"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1bc0c634cbd6eae42ba8e678123b3e12" id="r_a1bc0c634cbd6eae42ba8e678123b3e12"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a1bc0c634cbd6eae42ba8e678123b3e12">mIdString</a></td></tr>
- <tr class="separator:a1bc0c634cbd6eae42ba8e678123b3e12"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afa8dcd83f1b3cc756738fd08d91b699b" id="r_afa8dcd83f1b3cc756738fd08d91b699b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_namespace.html">Namespace</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#afa8dcd83f1b3cc756738fd08d91b699b">mNameSpace</a></td></tr>
- <tr class="separator:afa8dcd83f1b3cc756738fd08d91b699b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7e0203ca282d77263fdee9a9c8d0631f" id="r_a7e0203ca282d77263fdee9a9c8d0631f"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a7e0203ca282d77263fdee9a9c8d0631f">mTypeMask</a></td></tr>
- <tr class="separator:a7e0203ca282d77263fdee9a9c8d0631f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afb0ea09846fa6e5ceac432439a252709" id="r_afb0ea09846fa6e5ceac432439a252709"><td class="memItemLeft" align="right" valign="top">S32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#afb0ea09846fa6e5ceac432439a252709">mScriptCallbackGuard</a></td></tr>
- <tr class="memdesc:afb0ea09846fa6e5ceac432439a252709"><td class="mdescLeft"> </td><td class="mdescRight">Whether the object is executing a script callback. <br /></td></tr>
- <tr class="separator:afb0ea09846fa6e5ceac432439a252709"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9d58648eb55132316b07f0bfdf1f5f79" id="r_a9d58648eb55132316b07f0bfdf1f5f79"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a9d58648eb55132316b07f0bfdf1f5f79">mCanSaveFieldDictionary</a></td></tr>
- <tr class="memdesc:a9d58648eb55132316b07f0bfdf1f5f79"><td class="mdescLeft"> </td><td class="mdescRight">true if dynamic fields (added at runtime) should be saved, defaults to true <br /></td></tr>
- <tr class="separator:a9d58648eb55132316b07f0bfdf1f5f79"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae25d89dbd7309a4fe60e221d19e3beb4" id="r_ae25d89dbd7309a4fe60e221d19e3beb4"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ae25d89dbd7309a4fe60e221d19e3beb4">mInternalName</a></td></tr>
- <tr class="memdesc:ae25d89dbd7309a4fe60e221d19e3beb4"><td class="mdescLeft"> </td><td class="mdescRight">Stores object Internal Name. <br /></td></tr>
- <tr class="separator:ae25d89dbd7309a4fe60e221d19e3beb4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afcdd8b2e39eb6cab2310ec01fc23dfc8" id="r_afcdd8b2e39eb6cab2310ec01fc23dfc8"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#afcdd8b2e39eb6cab2310ec01fc23dfc8">mClassName</a></td></tr>
- <tr class="memdesc:afcdd8b2e39eb6cab2310ec01fc23dfc8"><td class="mdescLeft"> </td><td class="mdescRight">Stores the class name to link script class namespaces. <br /></td></tr>
- <tr class="separator:afcdd8b2e39eb6cab2310ec01fc23dfc8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2866b6130ce096fe6563e71995d35f0f" id="r_a2866b6130ce096fe6563e71995d35f0f"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a2866b6130ce096fe6563e71995d35f0f">mSuperClassName</a></td></tr>
- <tr class="memdesc:a2866b6130ce096fe6563e71995d35f0f"><td class="mdescLeft"> </td><td class="mdescRight">Stores super class name to link script class namespaces. <br /></td></tr>
- <tr class="separator:a2866b6130ce096fe6563e71995d35f0f"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:a197bc9fab2f8558c52fb7a57ef526dca" id="r_a197bc9fab2f8558c52fb7a57ef526dca"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a197bc9fab2f8558c52fb7a57ef526dca">SimManager</a></td></tr>
- <tr class="separator:a197bc9fab2f8558c52fb7a57ef526dca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a68bd73954c8c1df1c3919a72ed1ee68e" id="r_a68bd73954c8c1df1c3919a72ed1ee68e"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a68bd73954c8c1df1c3919a72ed1ee68e">SimGroup</a></td></tr>
- <tr class="separator:a68bd73954c8c1df1c3919a72ed1ee68e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a23a2aca26949fc86b646bdf61c4e203d" id="r_a23a2aca26949fc86b646bdf61c4e203d"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a23a2aca26949fc86b646bdf61c4e203d">SimNameDictionary</a></td></tr>
- <tr class="separator:a23a2aca26949fc86b646bdf61c4e203d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8a37b2a278f0f8beff3adf5dc4b970d4" id="r_a8a37b2a278f0f8beff3adf5dc4b970d4"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8a37b2a278f0f8beff3adf5dc4b970d4">SimManagerNameDictionary</a></td></tr>
- <tr class="separator:a8a37b2a278f0f8beff3adf5dc4b970d4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4303dad0bd3c617f3c5087090aa2e07c" id="r_a4303dad0bd3c617f3c5087090aa2e07c"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a4303dad0bd3c617f3c5087090aa2e07c">SimIdDictionary</a></td></tr>
- <tr class="separator:a4303dad0bd3c617f3c5087090aa2e07c"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader">Notification</h2></td></tr>
- <tr class="memitem:a8f583d26e810008b4532327b7bbae397" id="r_a8f583d26e810008b4532327b7bbae397"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="struct_sim_object_1_1_notify.html">SimObject::Notify</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8f583d26e810008b4532327b7bbae397">mNotifyFreeList</a> = NULL</td></tr>
- <tr class="separator:a8f583d26e810008b4532327b7bbae397"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a27f9b7da7ac37f39ba7e364a74cc943f" id="r_a27f9b7da7ac37f39ba7e364a74cc943f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="struct_sim_object_1_1_notify.html">SimObject::Notify</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a27f9b7da7ac37f39ba7e364a74cc943f">allocNotify</a> ()</td></tr>
- <tr class="memdesc:a27f9b7da7ac37f39ba7e364a74cc943f"><td class="mdescLeft"> </td><td class="mdescRight">Get a free <a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> structure. <br /></td></tr>
- <tr class="separator:a27f9b7da7ac37f39ba7e364a74cc943f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa77d566406c826b12013b264b4d72450" id="r_aa77d566406c826b12013b264b4d72450"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aa77d566406c826b12013b264b4d72450">freeNotify</a> (<a class="el" href="struct_sim_object_1_1_notify.html">SimObject::Notify</a> *)</td></tr>
- <tr class="memdesc:aa77d566406c826b12013b264b4d72450"><td class="mdescLeft"> </td><td class="mdescRight">Mark a <a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> structure as free. <br /></td></tr>
- <tr class="separator:aa77d566406c826b12013b264b4d72450"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac894e7acfdf29d01464a20d670e1208a" id="r_ac894e7acfdf29d01464a20d670e1208a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ac894e7acfdf29d01464a20d670e1208a">removeNotify</a> (void *ptr, <a class="el" href="struct_sim_object_1_1_notify.html#a1d1cfd8ffb84e947f82999c682b666a7">Notify::Type</a>)</td></tr>
- <tr class="memdesc:ac894e7acfdf29d01464a20d670e1208a"><td class="mdescLeft"> </td><td class="mdescRight">Remove a notification from the list. <br /></td></tr>
- <tr class="separator:ac894e7acfdf29d01464a20d670e1208a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2838b603fe80fa772e6be008b649decf" id="r_a2838b603fe80fa772e6be008b649decf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a2838b603fe80fa772e6be008b649decf">deleteNotify</a> (<a class="el" href="class_sim_object.html">SimObject</a> *obj)</td></tr>
- <tr class="memdesc:a2838b603fe80fa772e6be008b649decf"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> an object when we are deleted. <br /></td></tr>
- <tr class="separator:a2838b603fe80fa772e6be008b649decf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae9d02581f339ef7ede02efaf54bed50e" id="r_ae9d02581f339ef7ede02efaf54bed50e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ae9d02581f339ef7ede02efaf54bed50e">clearNotify</a> (<a class="el" href="class_sim_object.html">SimObject</a> *obj)</td></tr>
- <tr class="memdesc:ae9d02581f339ef7ede02efaf54bed50e"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> an object when we are cleared. <br /></td></tr>
- <tr class="separator:ae9d02581f339ef7ede02efaf54bed50e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac1e31054548229bd5ea4779d9cbc2be2" id="r_ac1e31054548229bd5ea4779d9cbc2be2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ac1e31054548229bd5ea4779d9cbc2be2">clearAllNotifications</a> ()</td></tr>
- <tr class="memdesc:ac1e31054548229bd5ea4779d9cbc2be2"><td class="mdescLeft"> </td><td class="mdescRight">Remove all notifications for this object. <br /></td></tr>
- <tr class="separator:ac1e31054548229bd5ea4779d9cbc2be2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab0bd2d18dedeb363463ad2cad045f6a3" id="r_ab0bd2d18dedeb363463ad2cad045f6a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ab0bd2d18dedeb363463ad2cad045f6a3">processDeleteNotifies</a> ()</td></tr>
- <tr class="memdesc:ab0bd2d18dedeb363463ad2cad045f6a3"><td class="mdescLeft"> </td><td class="mdescRight">Send out deletion notifications. <br /></td></tr>
- <tr class="separator:ab0bd2d18dedeb363463ad2cad045f6a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5de000764497f99eac15f2fe1ff8d709" id="r_a5de000764497f99eac15f2fe1ff8d709"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a5de000764497f99eac15f2fe1ff8d709">registerReference</a> (<a class="el" href="class_sim_object.html">SimObject</a> **obj)</td></tr>
- <tr class="separator:a5de000764497f99eac15f2fe1ff8d709"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9ab2d546d0ed6b4abc8dcf9e373d8bcb" id="r_a9ab2d546d0ed6b4abc8dcf9e373d8bcb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a9ab2d546d0ed6b4abc8dcf9e373d8bcb">unregisterReference</a> (<a class="el" href="class_sim_object.html">SimObject</a> **obj)</td></tr>
- <tr class="separator:a9ab2d546d0ed6b4abc8dcf9e373d8bcb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a72e24351a839620574085b37ccd8e688" id="r_a72e24351a839620574085b37ccd8e688"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a72e24351a839620574085b37ccd8e688">addListener</a> (std::string objID)</td></tr>
- <tr class="separator:a72e24351a839620574085b37ccd8e688"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5f8f817f59dc708ccbec810392842a5b" id="r_a5f8f817f59dc708ccbec810392842a5b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a5f8f817f59dc708ccbec810392842a5b">removeListener</a> (std::string objID)</td></tr>
- <tr class="separator:a5f8f817f59dc708ccbec810392842a5b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a87be48ec4599c3d02a118cee89e47f55" id="r_a87be48ec4599c3d02a118cee89e47f55"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a87be48ec4599c3d02a118cee89e47f55">removeAllListeners</a> ()</td></tr>
- <tr class="separator:a87be48ec4599c3d02a118cee89e47f55"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a62d16d76ec4b30520d9cce1f2e7fda6a" id="r_a62d16d76ec4b30520d9cce1f2e7fda6a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a62d16d76ec4b30520d9cce1f2e7fda6a">postEvent</a> (std::string eventName, std::string data)</td></tr>
- <tr class="separator:a62d16d76ec4b30520d9cce1f2e7fda6a"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader">Accessors</h2></td></tr>
- <tr class="memitem:a5d6df47d150d38ec4999f9bd9ac68fa5" id="r_a5d6df47d150d38ec4999f9bd9ac68fa5"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a5d6df47d150d38ec4999f9bd9ac68fa5">disableNameChanging</a> = false</td></tr>
- <tr class="separator:a5d6df47d150d38ec4999f9bd9ac68fa5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a61da44826bbcdcbed3775d0b59dcbea7" id="r_a61da44826bbcdcbed3775d0b59dcbea7"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a61da44826bbcdcbed3775d0b59dcbea7">getDataField</a> (StringTableEntry slotName, const char *array)</td></tr>
- <tr class="separator:a61da44826bbcdcbed3775d0b59dcbea7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a13add87ef90b3882bd7eaff39004eb35" id="r_a13add87ef90b3882bd7eaff39004eb35"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a13add87ef90b3882bd7eaff39004eb35">setDataField</a> (StringTableEntry slotName, const char *array, const char *value)</td></tr>
- <tr class="separator:a13add87ef90b3882bd7eaff39004eb35"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1fffab6c801d5afd3a6116bfaa05011e" id="r_a1fffab6c801d5afd3a6116bfaa05011e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a1fffab6c801d5afd3a6116bfaa05011e">getPrefixedDataField</a> (StringTableEntry fieldName, const char *array)</td></tr>
- <tr class="separator:a1fffab6c801d5afd3a6116bfaa05011e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8b55bbf2e919e4c167264aee7fb1c1b7" id="r_a8b55bbf2e919e4c167264aee7fb1c1b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8b55bbf2e919e4c167264aee7fb1c1b7">setPrefixedDataField</a> (StringTableEntry fieldName, const char *array, const char *value)</td></tr>
- <tr class="separator:a8b55bbf2e919e4c167264aee7fb1c1b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a60a0b20565b21ca6534788ecf030b0db" id="r_a60a0b20565b21ca6534788ecf030b0db"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a60a0b20565b21ca6534788ecf030b0db">getPrefixedDynamicDataField</a> (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)</td></tr>
- <tr class="separator:a60a0b20565b21ca6534788ecf030b0db"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6befae44e0c81ad846242e8d8eddb149" id="r_a6befae44e0c81ad846242e8d8eddb149"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a6befae44e0c81ad846242e8d8eddb149">setPrefixedDynamicDataField</a> (StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType=-1)</td></tr>
- <tr class="separator:a6befae44e0c81ad846242e8d8eddb149"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aad68561955e2af5a7ec3e3bed8fd4c62" id="r_aad68561955e2af5a7ec3e3bed8fd4c62"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aad68561955e2af5a7ec3e3bed8fd4c62">getDataFieldPrefix</a> (StringTableEntry fieldName)</td></tr>
- <tr class="separator:aad68561955e2af5a7ec3e3bed8fd4c62"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a825bbfc5684ff3b4f43a17932cea0582" id="r_a825bbfc5684ff3b4f43a17932cea0582"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a825bbfc5684ff3b4f43a17932cea0582">getDataFieldType</a> (StringTableEntry slotName, const char *array)</td></tr>
- <tr class="separator:a825bbfc5684ff3b4f43a17932cea0582"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8bb1d1ae4846e2edea63ae6db267c847" id="r_a8bb1d1ae4846e2edea63ae6db267c847"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sim_field_dictionary.html">SimFieldDictionary</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8bb1d1ae4846e2edea63ae6db267c847">getFieldDictionary</a> ()</td></tr>
- <tr class="separator:a8bb1d1ae4846e2edea63ae6db267c847"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5a09726e6e6f20422bf0d5d9f1cd9422" id="r_a5a09726e6e6f20422bf0d5d9f1cd9422"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a5a09726e6e6f20422bf0d5d9f1cd9422">clearDynamicFields</a> (void)</td></tr>
- <tr class="memdesc:a5a09726e6e6f20422bf0d5d9f1cd9422"><td class="mdescLeft"> </td><td class="mdescRight">Clear all dynamic fields. <br /></td></tr>
- <tr class="separator:a5a09726e6e6f20422bf0d5d9f1cd9422"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aafe55ac523c402717ec8625b67fa1561" id="r_aafe55ac523c402717ec8625b67fa1561"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aafe55ac523c402717ec8625b67fa1561">setCanSaveDynamicFields</a> (bool bCanSave)</td></tr>
- <tr class="memdesc:aafe55ac523c402717ec8625b67fa1561"><td class="mdescLeft"> </td><td class="mdescRight">Set whether fields created at runtime should be saved. Default is true. <br /></td></tr>
- <tr class="separator:aafe55ac523c402717ec8625b67fa1561"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5e521770780a12f40f6fbf75b668c4ad" id="r_a5e521770780a12f40f6fbf75b668c4ad"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a5e521770780a12f40f6fbf75b668c4ad">getCanSaveDynamicFields</a> (void) const</td></tr>
- <tr class="memdesc:a5e521770780a12f40f6fbf75b668c4ad"><td class="mdescLeft"> </td><td class="mdescRight">Get whether fields created at runtime should be saved. Default is true. <br /></td></tr>
- <tr class="separator:a5e521770780a12f40f6fbf75b668c4ad"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad551e97d8f825c04f4cced55f8db3a64" id="r_ad551e97d8f825c04f4cced55f8db3a64"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ad551e97d8f825c04f4cced55f8db3a64">setInternalName</a> (const char *newname)</td></tr>
- <tr class="separator:ad551e97d8f825c04f4cced55f8db3a64"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa9e468963daa41c06c14cc2d6282b456" id="r_aa9e468963daa41c06c14cc2d6282b456"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aa9e468963daa41c06c14cc2d6282b456">getInternalName</a> ()</td></tr>
- <tr class="memdesc:aa9e468963daa41c06c14cc2d6282b456"><td class="mdescLeft"> </td><td class="mdescRight">Get the internal of of this control. <br /></td></tr>
- <tr class="separator:aa9e468963daa41c06c14cc2d6282b456"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a86f7c64cb6f7eba36f8a6e391e29492f" id="r_a86f7c64cb6f7eba36f8a6e391e29492f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a86f7c64cb6f7eba36f8a6e391e29492f">save</a> (const char *pcFilePath, bool bOnlySelected=false)</td></tr>
- <tr class="memdesc:a86f7c64cb6f7eba36f8a6e391e29492f"><td class="mdescLeft"> </td><td class="mdescRight">Save object as a TorqueScript <a class="el" href="class_file.html">File</a>. <br /></td></tr>
- <tr class="separator:a86f7c64cb6f7eba36f8a6e391e29492f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8a1d5ac5403526378c7abb0916c55c3c" id="r_a8a1d5ac5403526378c7abb0916c55c3c"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8a1d5ac5403526378c7abb0916c55c3c">isMethod</a> (const char *methodName)</td></tr>
- <tr class="memdesc:a8a1d5ac5403526378c7abb0916c55c3c"><td class="mdescLeft"> </td><td class="mdescRight">Check if a method exists in the objects current namespace. <br /></td></tr>
- <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa4a7bd634ae9f58bccb125fe45d86fc9" id="r_aa4a7bd634ae9f58bccb125fe45d86fc9"><td class="memItemLeft" align="right" valign="top">SimObjectId </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aa4a7bd634ae9f58bccb125fe45d86fc9">getId</a> (void) const</td></tr>
- <tr class="separator:aa4a7bd634ae9f58bccb125fe45d86fc9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a571c5d0b4440f6f1d5e4ab220949897e" id="r_a571c5d0b4440f6f1d5e4ab220949897e"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a571c5d0b4440f6f1d5e4ab220949897e">getIdString</a> (void) const</td></tr>
- <tr class="separator:a571c5d0b4440f6f1d5e4ab220949897e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a604dfe76701f827f0d0787f1ec29b690" id="r_a604dfe76701f827f0d0787f1ec29b690"><td class="memItemLeft" align="right" valign="top">U32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a604dfe76701f827f0d0787f1ec29b690">getType</a> () const</td></tr>
- <tr class="separator:a604dfe76701f827f0d0787f1ec29b690"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afef631e435982063322597320f4c817f" id="r_afef631e435982063322597320f4c817f"><td class="memItemLeft" align="right" valign="top">const StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#afef631e435982063322597320f4c817f">getName</a> (void) const</td></tr>
- <tr class="separator:afef631e435982063322597320f4c817f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa19ca64ec6199448db9552e13387a246" id="r_aa19ca64ec6199448db9552e13387a246"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aa19ca64ec6199448db9552e13387a246">setId</a> (SimObjectId id)</td></tr>
- <tr class="separator:aa19ca64ec6199448db9552e13387a246"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a43a200e331c5a48c30890b7ab32557eb" id="r_a43a200e331c5a48c30890b7ab32557eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a43a200e331c5a48c30890b7ab32557eb">assignName</a> (const char *name)</td></tr>
- <tr class="separator:a43a200e331c5a48c30890b7ab32557eb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8cd893920348a8bb5566e86b188bba37" id="r_a8cd893920348a8bb5566e86b188bba37"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sim_group.html">SimGroup</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8cd893920348a8bb5566e86b188bba37">getGroup</a> () const</td></tr>
- <tr class="separator:a8cd893920348a8bb5566e86b188bba37"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4ba53dcc84f4c3192248367068eeb22a" id="r_a4ba53dcc84f4c3192248367068eeb22a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a4ba53dcc84f4c3192248367068eeb22a">isChildOfGroup</a> (<a class="el" href="class_sim_group.html">SimGroup</a> *pGroup)</td></tr>
- <tr class="separator:a4ba53dcc84f4c3192248367068eeb22a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0b639b01b66038bf995b7943b9c4cca2" id="r_a0b639b01b66038bf995b7943b9c4cca2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a0b639b01b66038bf995b7943b9c4cca2">isProperlyAdded</a> () const</td></tr>
- <tr class="separator:a0b639b01b66038bf995b7943b9c4cca2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac8efc5df207a89f8c9044015074c19d8" id="r_ac8efc5df207a89f8c9044015074c19d8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ac8efc5df207a89f8c9044015074c19d8">isDeleted</a> () const</td></tr>
- <tr class="separator:ac8efc5df207a89f8c9044015074c19d8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a69e923e012cb8988e900f51ff135fd7f" id="r_a69e923e012cb8988e900f51ff135fd7f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a69e923e012cb8988e900f51ff135fd7f">isRemoved</a> () const</td></tr>
- <tr class="separator:a69e923e012cb8988e900f51ff135fd7f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a43966e19963e4bcb7f7f9b5327ec732b" id="r_a43966e19963e4bcb7f7f9b5327ec732b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a43966e19963e4bcb7f7f9b5327ec732b">isLocked</a> () const</td></tr>
- <tr class="separator:a43966e19963e4bcb7f7f9b5327ec732b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0d0eb38693dcaae147b7a890fae82934" id="r_a0d0eb38693dcaae147b7a890fae82934"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a0d0eb38693dcaae147b7a890fae82934">setLocked</a> (bool b)</td></tr>
- <tr class="separator:a0d0eb38693dcaae147b7a890fae82934"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a451227147204d105046094b758ce3438" id="r_a451227147204d105046094b758ce3438"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a451227147204d105046094b758ce3438">isHidden</a> () const</td></tr>
- <tr class="separator:a451227147204d105046094b758ce3438"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85f8b66f6d9e9acf89ae056554f82776" id="r_a85f8b66f6d9e9acf89ae056554f82776"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a85f8b66f6d9e9acf89ae056554f82776">setHidden</a> (bool b)</td></tr>
- <tr class="separator:a85f8b66f6d9e9acf89ae056554f82776"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac8fc39880dcb3be2d5658b57e9fed264" id="r_ac8fc39880dcb3be2d5658b57e9fed264"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ac8fc39880dcb3be2d5658b57e9fed264">setProgenitorFile</a> (const char *pFile)</td></tr>
- <tr class="separator:ac8fc39880dcb3be2d5658b57e9fed264"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab9ddb5b67db343e1b7a8014bfc326bf8" id="r_ab9ddb5b67db343e1b7a8014bfc326bf8"><td class="memItemLeft" align="right" valign="top">StringTableEntry </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ab9ddb5b67db343e1b7a8014bfc326bf8">getProgenitorFile</a> (void) const</td></tr>
- <tr class="separator:ab9ddb5b67db343e1b7a8014bfc326bf8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6cb2bfe07966c75d9360afe422749d36" id="r_a6cb2bfe07966c75d9360afe422749d36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a6cb2bfe07966c75d9360afe422749d36">setPeriodicTimerID</a> (const S32 timerID)</td></tr>
- <tr class="separator:a6cb2bfe07966c75d9360afe422749d36"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1bca5aee058d82e2c22db072bbfdef96" id="r_a1bca5aee058d82e2c22db072bbfdef96"><td class="memItemLeft" align="right" valign="top">S32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a1bca5aee058d82e2c22db072bbfdef96">getPeriodicTimerID</a> (void) const</td></tr>
- <tr class="separator:a1bca5aee058d82e2c22db072bbfdef96"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a45f7816c50cb3b1b9dc31bdc271db3dc" id="r_a45f7816c50cb3b1b9dc31bdc271db3dc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a45f7816c50cb3b1b9dc31bdc271db3dc">isPeriodicTimerActive</a> (void) const</td></tr>
- <tr class="separator:a45f7816c50cb3b1b9dc31bdc271db3dc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a56a065a2c20a230931de0ed98019d8fb" id="r_a56a065a2c20a230931de0ed98019d8fb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a56a065a2c20a230931de0ed98019d8fb">isSelected</a> () const</td></tr>
- <tr class="separator:a56a065a2c20a230931de0ed98019d8fb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a78577963741dd7d80dae749dccc02fc2" id="r_a78577963741dd7d80dae749dccc02fc2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a78577963741dd7d80dae749dccc02fc2">isExpanded</a> () const</td></tr>
- <tr class="separator:a78577963741dd7d80dae749dccc02fc2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a40c19418aede1f21ea7aeadc87342dee" id="r_a40c19418aede1f21ea7aeadc87342dee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a40c19418aede1f21ea7aeadc87342dee">setSelected</a> (bool sel)</td></tr>
- <tr class="separator:a40c19418aede1f21ea7aeadc87342dee"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af83d1fe99918d6650c71c6302a5839ae" id="r_af83d1fe99918d6650c71c6302a5839ae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#af83d1fe99918d6650c71c6302a5839ae">setExpanded</a> (bool exp)</td></tr>
- <tr class="separator:af83d1fe99918d6650c71c6302a5839ae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab80c81429637a9f3a44aa55e7533cd2c" id="r_ab80c81429637a9f3a44aa55e7533cd2c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ab80c81429637a9f3a44aa55e7533cd2c">setModDynamicFields</a> (bool dyn)</td></tr>
- <tr class="separator:ab80c81429637a9f3a44aa55e7533cd2c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a00201e9d1946024a8060f586e03f5a74" id="r_a00201e9d1946024a8060f586e03f5a74"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a00201e9d1946024a8060f586e03f5a74">setModStaticFields</a> (bool sta)</td></tr>
- <tr class="separator:a00201e9d1946024a8060f586e03f5a74"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader">Initialization</h2></td></tr>
- <tr class="memitem:a2f0d5f226a833bafd913a942723c6918" id="r_a2f0d5f226a833bafd913a942723c6918"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a2f0d5f226a833bafd913a942723c6918">SimObject</a> ()</td></tr>
- <tr class="separator:a2f0d5f226a833bafd913a942723c6918"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a681b2768672c09f14125319ac2308ee6" id="r_a681b2768672c09f14125319ac2308ee6"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a681b2768672c09f14125319ac2308ee6">~SimObject</a> ()</td></tr>
- <tr class="separator:a681b2768672c09f14125319ac2308ee6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea22401f7205e885be6dd887a61a0797" id="r_aea22401f7205e885be6dd887a61a0797"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aea22401f7205e885be6dd887a61a0797">processArguments</a> (S32 argc, const char **argv)</td></tr>
- <tr class="memdesc:aea22401f7205e885be6dd887a61a0797"><td class="mdescLeft"> </td><td class="mdescRight">Process constructor options. (ie, new <a class="el" href="class_sim_object.html">SimObject(1,2,3)</a>) <br /></td></tr>
- <tr class="separator:aea22401f7205e885be6dd887a61a0797"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader">Events</h2></td></tr>
- <tr class="memitem:aa8fb2a4e72e5c4975d3cd912c5de131a" id="r_aa8fb2a4e72e5c4975d3cd912c5de131a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a">onAdd</a> ()</td></tr>
- <tr class="memdesc:aa8fb2a4e72e5c4975d3cd912c5de131a"><td class="mdescLeft"> </td><td class="mdescRight">Called when the object is added to the sim. <br /></td></tr>
- <tr class="separator:aa8fb2a4e72e5c4975d3cd912c5de131a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a28fb2b0653c2c31284ebef9237dc9c5c" id="r_a28fb2b0653c2c31284ebef9237dc9c5c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a28fb2b0653c2c31284ebef9237dc9c5c">onRemove</a> ()</td></tr>
- <tr class="memdesc:a28fb2b0653c2c31284ebef9237dc9c5c"><td class="mdescLeft"> </td><td class="mdescRight">Called when the object is removed from the sim. <br /></td></tr>
- <tr class="separator:a28fb2b0653c2c31284ebef9237dc9c5c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e0c7d4c3cea7aee9d23a4b596a92fba" id="r_a0e0c7d4c3cea7aee9d23a4b596a92fba"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a0e0c7d4c3cea7aee9d23a4b596a92fba">onGroupAdd</a> ()</td></tr>
- <tr class="memdesc:a0e0c7d4c3cea7aee9d23a4b596a92fba"><td class="mdescLeft"> </td><td class="mdescRight">Called when the object is added to a <a class="el" href="class_sim_group.html">SimGroup</a>. <br /></td></tr>
- <tr class="separator:a0e0c7d4c3cea7aee9d23a4b596a92fba"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad8e217b4d87fd05d0cc53eed4482926f" id="r_ad8e217b4d87fd05d0cc53eed4482926f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ad8e217b4d87fd05d0cc53eed4482926f">onGroupRemove</a> ()</td></tr>
- <tr class="memdesc:ad8e217b4d87fd05d0cc53eed4482926f"><td class="mdescLeft"> </td><td class="mdescRight">Called when the object is removed from a <a class="el" href="class_sim_group.html">SimGroup</a>. <br /></td></tr>
- <tr class="separator:ad8e217b4d87fd05d0cc53eed4482926f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab83e4b1fa22db99d20741b86321a400d" id="r_ab83e4b1fa22db99d20741b86321a400d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ab83e4b1fa22db99d20741b86321a400d">onNameChange</a> (const char *name)</td></tr>
- <tr class="memdesc:ab83e4b1fa22db99d20741b86321a400d"><td class="mdescLeft"> </td><td class="mdescRight">Called when the object's name is changed. <br /></td></tr>
- <tr class="separator:ab83e4b1fa22db99d20741b86321a400d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a774b03009201ddc3fd55367f5578384f" id="r_a774b03009201ddc3fd55367f5578384f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a774b03009201ddc3fd55367f5578384f">onStaticModified</a> (const char *slotName, const char *newValue=NULL)</td></tr>
- <tr class="separator:a774b03009201ddc3fd55367f5578384f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acb00b32e56849913eae3abc6f872b572" id="r_acb00b32e56849913eae3abc6f872b572"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#acb00b32e56849913eae3abc6f872b572">inspectPreApply</a> ()</td></tr>
- <tr class="separator:acb00b32e56849913eae3abc6f872b572"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aefba6ba5e9b537b3d11e5416add644e1" id="r_aefba6ba5e9b537b3d11e5416add644e1"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aefba6ba5e9b537b3d11e5416add644e1">inspectPostApply</a> ()</td></tr>
- <tr class="separator:aefba6ba5e9b537b3d11e5416add644e1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8db26dd3c0ca2b1ac05e7c3516325e61" id="r_a8db26dd3c0ca2b1ac05e7c3516325e61"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8db26dd3c0ca2b1ac05e7c3516325e61">onDeleteNotify</a> (<a class="el" href="class_sim_object.html">SimObject</a> *object)</td></tr>
- <tr class="separator:a8db26dd3c0ca2b1ac05e7c3516325e61"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a35ed1968ac7850e14737aa7ccb4356a6" id="r_a35ed1968ac7850e14737aa7ccb4356a6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a35ed1968ac7850e14737aa7ccb4356a6">onEditorEnable</a> ()</td></tr>
- <tr class="memdesc:a35ed1968ac7850e14737aa7ccb4356a6"><td class="mdescLeft"> </td><td class="mdescRight">Called when the editor is activated. <br /></td></tr>
- <tr class="separator:a35ed1968ac7850e14737aa7ccb4356a6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1444b2e49c37757bf57740bcd43a5a19" id="r_a1444b2e49c37757bf57740bcd43a5a19"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a1444b2e49c37757bf57740bcd43a5a19">onEditorDisable</a> ()</td></tr>
- <tr class="memdesc:a1444b2e49c37757bf57740bcd43a5a19"><td class="mdescLeft"> </td><td class="mdescRight">Called when the editor is deactivated. <br /></td></tr>
- <tr class="separator:a1444b2e49c37757bf57740bcd43a5a19"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader">Registration</h2></td></tr>
- <tr><td class="ititle" colspan="2"><p>SimObjects must be registered with the object system. </p>
- </td></tr>
- <tr class="memitem:a2400b9daf420c4b7f40e2fefccf819a7" id="r_a2400b9daf420c4b7f40e2fefccf819a7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a2400b9daf420c4b7f40e2fefccf819a7">registerObject</a> ()</td></tr>
- <tr class="separator:a2400b9daf420c4b7f40e2fefccf819a7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a03e5444a670c9fc42bda3a569cdcfc8b" id="r_a03e5444a670c9fc42bda3a569cdcfc8b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a03e5444a670c9fc42bda3a569cdcfc8b">registerObject</a> (U32 id)</td></tr>
- <tr class="separator:a03e5444a670c9fc42bda3a569cdcfc8b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a40957e593443f2fae6e5d84c58689e23" id="r_a40957e593443f2fae6e5d84c58689e23"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a40957e593443f2fae6e5d84c58689e23">registerObject</a> (const char *name)</td></tr>
- <tr class="separator:a40957e593443f2fae6e5d84c58689e23"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad87febcd9c1b24a68db0656b4ac4bb5e" id="r_ad87febcd9c1b24a68db0656b4ac4bb5e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ad87febcd9c1b24a68db0656b4ac4bb5e">registerObject</a> (const char *name, U32 id)</td></tr>
- <tr class="separator:ad87febcd9c1b24a68db0656b4ac4bb5e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5d4a04eec15214f98292fa4d2bcb6c58" id="r_a5d4a04eec15214f98292fa4d2bcb6c58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a5d4a04eec15214f98292fa4d2bcb6c58">unregisterObject</a> ()</td></tr>
- <tr class="separator:a5d4a04eec15214f98292fa4d2bcb6c58"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a035562e6d1b195a025da907836d24d1c" id="r_a035562e6d1b195a025da907836d24d1c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a035562e6d1b195a025da907836d24d1c">deleteObject</a> ()</td></tr>
- <tr class="separator:a035562e6d1b195a025da907836d24d1c"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader">Sets</h2></td></tr>
- <tr><td class="ititle" colspan="2"><p>The object must be properly registered before you can add/remove it to/from a set.</p>
- <p>All these functions accept either a name or ID to identify the set you wish to operate on. Then they call addObject or removeObject on the set, which sets up appropriate notifications.</p>
- <p>An object may be in multiple sets at a time. </p>
- </td></tr>
- <tr class="memitem:a3a6c0e9f5513c15dbc861831b392872a" id="r_a3a6c0e9f5513c15dbc861831b392872a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a3a6c0e9f5513c15dbc861831b392872a">addToSet</a> (SimObjectId)</td></tr>
- <tr class="separator:a3a6c0e9f5513c15dbc861831b392872a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae32c75b008160f8599389fa1416270f4" id="r_ae32c75b008160f8599389fa1416270f4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ae32c75b008160f8599389fa1416270f4">addToSet</a> (const char *)</td></tr>
- <tr class="separator:ae32c75b008160f8599389fa1416270f4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8fb724887b442070d3f78e5ffdf529fc" id="r_a8fb724887b442070d3f78e5ffdf529fc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8fb724887b442070d3f78e5ffdf529fc">removeFromSet</a> (SimObjectId)</td></tr>
- <tr class="separator:a8fb724887b442070d3f78e5ffdf529fc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae15bec249a7c1003e0ebb253ba7ca4df" id="r_ae15bec249a7c1003e0ebb253ba7ca4df"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ae15bec249a7c1003e0ebb253ba7ca4df">removeFromSet</a> (const char *)</td></tr>
- <tr class="separator:ae15bec249a7c1003e0ebb253ba7ca4df"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader">Serialization</h2></td></tr>
- <tr class="memitem:a8b9f425bde559d3f1b3146fd3c1ceba2" id="r_a8b9f425bde559d3f1b3146fd3c1ceba2"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a8b9f425bde559d3f1b3146fd3c1ceba2">writeField</a> (StringTableEntry fieldname, const char *value)</td></tr>
- <tr class="separator:a8b9f425bde559d3f1b3146fd3c1ceba2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:add2aa52391620bbfb9f8c29eb1f921cd" id="r_add2aa52391620bbfb9f8c29eb1f921cd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#add2aa52391620bbfb9f8c29eb1f921cd">write</a> (<a class="el" href="class_stream.html">Stream</a> &stream, U32 tabStop, U32 flags=0)</td></tr>
- <tr class="separator:add2aa52391620bbfb9f8c29eb1f921cd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a200de464a60a45ee5904de160e677b5f" id="r_a200de464a60a45ee5904de160e677b5f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a200de464a60a45ee5904de160e677b5f">writeFields</a> (<a class="el" href="class_stream.html">Stream</a> &stream, U32 tabStop)</td></tr>
- <tr class="separator:a200de464a60a45ee5904de160e677b5f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aebb68b5bbb2a5feb7bbf710834c6888b" id="r_aebb68b5bbb2a5feb7bbf710834c6888b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#aebb68b5bbb2a5feb7bbf710834c6888b">writeObject</a> (<a class="el" href="class_stream.html">Stream</a> *stream)</td></tr>
- <tr class="separator:aebb68b5bbb2a5feb7bbf710834c6888b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a783fe3358bc6a3bf993ec1bfef693529" id="r_a783fe3358bc6a3bf993ec1bfef693529"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a783fe3358bc6a3bf993ec1bfef693529">readObject</a> (<a class="el" href="class_stream.html">Stream</a> *stream)</td></tr>
- <tr class="separator:a783fe3358bc6a3bf993ec1bfef693529"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afc937cb7e1cd1b0768101aec936bbe45" id="r_afc937cb7e1cd1b0768101aec936bbe45"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#afc937cb7e1cd1b0768101aec936bbe45">buildFilterList</a> ()</td></tr>
- <tr class="separator:afc937cb7e1cd1b0768101aec936bbe45"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac9c1a44b539dfe7ca6782c5dd561e9ac" id="r_ac9c1a44b539dfe7ca6782c5dd561e9ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#ac9c1a44b539dfe7ca6782c5dd561e9ac">addFieldFilter</a> (const char *fieldName)</td></tr>
- <tr class="separator:ac9c1a44b539dfe7ca6782c5dd561e9ac"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a800867188378386931156e3329846b71" id="r_a800867188378386931156e3329846b71"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a800867188378386931156e3329846b71">removeFieldFilter</a> (const char *fieldName)</td></tr>
- <tr class="separator:a800867188378386931156e3329846b71"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a97791ba163a65547d7a5d47bed803d7d" id="r_a97791ba163a65547d7a5d47bed803d7d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a97791ba163a65547d7a5d47bed803d7d">clearFieldFilters</a> ()</td></tr>
- <tr class="separator:a97791ba163a65547d7a5d47bed803d7d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af05be979fb46390caf87d391486d38b1" id="r_af05be979fb46390caf87d391486d38b1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#af05be979fb46390caf87d391486d38b1">isFiltered</a> (const char *fieldName)</td></tr>
- <tr class="separator:af05be979fb46390caf87d391486d38b1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afe42c2298dcfb82059cd5d8590a76479" id="r_afe42c2298dcfb82059cd5d8590a76479"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#afe42c2298dcfb82059cd5d8590a76479">assignFieldsFrom</a> (<a class="el" href="class_sim_object.html">SimObject</a> *obj)</td></tr>
- <tr class="separator:afe42c2298dcfb82059cd5d8590a76479"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2ed3c32bdfeb17efd31de7faf0f5b37c" id="r_a2ed3c32bdfeb17efd31de7faf0f5b37c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object.html#a2ed3c32bdfeb17efd31de7faf0f5b37c">assignDynamicFieldsFrom</a> (<a class="el" href="class_sim_object.html">SimObject</a> *obj)</td></tr>
- <tr class="separator:a2ed3c32bdfeb17efd31de7faf0f5b37c"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Base class for objects involved in the simulation.</p>
- <h1><a class="anchor" id="simobject_intro"></a>
- Introduction</h1>
- <p><a class="el" href="class_sim_object.html">SimObject</a> is a base class for most of the classes you'll encounter working in <a class="el" href="namespace_torque.html">Torque</a>. It provides fundamental services allowing "smart" object referencing, creation, destruction, organization, and location. Along with <a class="el" href="class_sim_event.html">SimEvent</a>, it gives you a flexible event-scheduling system, as well as laying the foundation for the in-game editors, GUI system, and other vital subsystems.</p>
- <h1><a class="anchor" id="simobject_subclassing"></a>
- Subclassing</h1>
- <p>You will spend a lot of your time in <a class="el" href="namespace_torque.html">Torque</a> subclassing, or working with subclasses of, <a class="el" href="class_sim_object.html">SimObject</a>. <a class="el" href="class_sim_object.html">SimObject</a> is designed to be easy to subclass.</p>
- <p>You should not need to override anything in a subclass except:</p><ul>
- <li>The constructor/destructor.</li>
- <li><a class="el" href="class_sim_object.html#aea22401f7205e885be6dd887a61a0797" title="Process constructor options. (ie, new SimObject(1,2,3))">processArguments()</a></li>
- <li><a class="el" href="class_sim_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a" title="Called when the object is added to the sim.">onAdd()</a>/onRemove()</li>
- <li><a class="el" href="class_sim_object.html#a0e0c7d4c3cea7aee9d23a4b596a92fba" title="Called when the object is added to a SimGroup.">onGroupAdd()</a>/onGroupRemove()</li>
- <li><a class="el" href="class_sim_object.html#ab83e4b1fa22db99d20741b86321a400d" title="Called when the object's name is changed.">onNameChange()</a></li>
- <li><a class="el" href="class_sim_object.html#a774b03009201ddc3fd55367f5578384f">onStaticModified()</a></li>
- <li><a class="el" href="class_sim_object.html#a8db26dd3c0ca2b1ac05e7c3516325e61">onDeleteNotify()</a></li>
- <li><a class="el" href="class_sim_object.html#a35ed1968ac7850e14737aa7ccb4356a6" title="Called when the editor is activated.">onEditorEnable()</a>/onEditorDisable()</li>
- <li><a class="el" href="class_sim_object.html#acb00b32e56849913eae3abc6f872b572">inspectPreApply()</a>/inspectPostApply()</li>
- <li>things from <a class="el" href="class_console_object.html">ConsoleObject</a> (see <a class="el" href="class_console_object.html">ConsoleObject</a> docs for specifics)</li>
- </ul>
- <p>Of course, if you know what you're doing, go nuts! But in most cases, you shouldn't need to touch things not on that list.</p>
- <p>When you subclass, you should define a typedef in the class, called Parent, that references the class you're inheriting from.</p>
- <div class="fragment"><div class="line"><span class="keyword">class </span>mySubClass : <span class="keyword">public</span> <a class="code hl_class" href="class_sim_object.html">SimObject</a> {</div>
- <div class="line"> <span class="keyword">typedef</span> <a class="code hl_class" href="class_sim_object.html">SimObject</a> <a class="code hl_class" href="class_console_object.html">Parent</a>;</div>
- <div class="line"> ...</div>
- <div class="ttc" id="aclass_console_object_html"><div class="ttname"><a href="class_console_object.html">ConsoleObject</a></div><div class="ttdef"><b>Definition</b> consoleObject.h:481</div></div>
- <div class="ttc" id="aclass_sim_object_html"><div class="ttname"><a href="class_sim_object.html">SimObject</a></div><div class="ttdef"><b>Definition</b> simObject.h:234</div></div>
- </div><!-- fragment --><p>Then, when you override a method, put in:</p>
- <div class="fragment"><div class="line"><span class="keywordtype">bool</span> mySubClass::onAdd()</div>
- <div class="line">{</div>
- <div class="line"> <span class="keywordflow">if</span>(!Parent::onAdd())</div>
- <div class="line"> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
- <div class="line"> </div>
- <div class="line"> <span class="comment">// ... do other things ...</span></div>
- <div class="line">}</div>
- </div><!-- fragment --><p>Of course, you want to replace onAdd with the appropriate method call.</p>
- <h1><a class="anchor" id="simobject_lifecycle"></a>
- A SimObject's Life Cycle</h1>
- <p>SimObjects do not live apart. One of the primary benefits of using a <a class="el" href="class_sim_object.html">SimObject</a> is that you can uniquely identify it and easily find it (using its ID). <a class="el" href="namespace_torque.html">Torque</a> does this by keeping a global hierarchy of SimGroups - a tree - containing every registered <a class="el" href="class_sim_object.html">SimObject</a>. You can then query for a given object using <a class="el" href="namespace_sim.html#a3e94a217b10a43c58030035d7efa5ea4">Sim::findObject()</a> (or <a class="el" href="class_sim_set.html#aea6dde4400c9c8a5bd378a89a055cf92">SimSet::findObject()</a> if you want to search only a specific set).</p>
- <div class="fragment"><div class="line"><span class="comment">// Three examples of registering an object.</span></div>
- <div class="line"> </div>
- <div class="line"><span class="comment">// Method 1:</span></div>
- <div class="line">AIClient *aiPlayer = <span class="keyword">new</span> AIClient();</div>
- <div class="line">aiPlayer->registerObject();</div>
- <div class="line"> </div>
- <div class="line"><span class="comment">// Method 2:</span></div>
- <div class="line"><a class="code hl_class" href="class_action_map.html">ActionMap</a>* globalMap = <span class="keyword">new</span> <a class="code hl_class" href="class_action_map.html">ActionMap</a>;</div>
- <div class="line">globalMap-><a class="code hl_function" href="class_sim_object.html#a2400b9daf420c4b7f40e2fefccf819a7">registerObject</a>(<span class="stringliteral">"GlobalActionMap"</span>);</div>
- <div class="line"> </div>
- <div class="line"><span class="comment">// Method 3:</span></div>
- <div class="line"><span class="keywordtype">bool</span> reg = mObj->registerObject(<span class="keywordtype">id</span>);</div>
- <div class="ttc" id="aclass_action_map_html"><div class="ttname"><a href="class_action_map.html">ActionMap</a></div><div class="ttdef"><b>Definition</b> actionMap.h:50</div></div>
- <div class="ttc" id="aclass_sim_object_html_a2400b9daf420c4b7f40e2fefccf819a7"><div class="ttname"><a href="class_sim_object.html#a2400b9daf420c4b7f40e2fefccf819a7">SimObject::registerObject</a></div><div class="ttdeci">bool registerObject()</div><div class="ttdef"><b>Definition</b> simObject.cc:93</div></div>
- </div><!-- fragment --><p>Registering a <a class="el" href="class_sim_object.html">SimObject</a> performs these tasks:</p><ul>
- <li>Marks the object as not cleared and not removed.</li>
- <li>Assigns the object a unique SimObjectID if it does not have one already.</li>
- <li>Adds the object to the global name and ID dictionaries so it can be found again.</li>
- <li>Calls the object's <a class="el" href="class_sim_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a" title="Called when the object is added to the sim.">onAdd()</a> method. <b>Note:</b> <a class="el" href="class_sim_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a" title="Called when the object is added to the sim.">SimObject::onAdd()</a> performs some important initialization steps. See <a class="el" href="class_sim_object.html#simobject_subclassing">here</a> for details" on how to properly subclass SimObject.
- - If onAdd() fails (returns false), it calls unregisterObject().
- - Checks to make sure that the SimObject was properly initialized (and asserts
- if not).
- Calling registerObject() and passing an ID or a name will cause the object to be
- assigned that name and/or ID before it is registered.
- Congratulations, you have now registered your object! What now?
- Well, hopefully, the SimObject will have a long, useful life. But eventually,
- it must die.
- There are a two ways a SimObject can die.
- - First, the game can be shut down. This causes the root SimGroup
- to be unregistered and deleted. When a SimGroup is unregistered,
- it unregisters all of its member SimObjects; this results in everything
- that has been registered with Sim being unregistered, as everything
- registered with Sim is in the root group.
- - Second, you can manually kill it off, either by calling unregisterObject()
- or by calling deleteObject().
- When you unregister a SimObject, the following tasks are performed:
- - The object is flagged as removed.
- - Notifications are cleaned up.
- - If the object is in a group, then it removes itself from the group.
- - Delete notifications are sent out.
- - Finally, the object removes itself from the Sim globals, and tells
- Sim to get rid of any pending events for it.
- If you call deleteObject(), all of the above tasks are performed, in addition
- to some sanity checking to make sure the object was previously added properly,
- and isn't in the process of being deleted. After the object is unregistered, it
- de-allocates itself.
- @section simobject_editor Torque Editors
- SimObjects are one of the building blocks for the in-game editors. They
- provide a basic interface for the editor to be able to list the fields
- of the object, update them safely and reliably, and inform the object
- things have changed.
- This interface is implemented in the following areas:
- - onNameChange() is called when the object is renamed.
- - onStaticModified() is called whenever a static field is modified.
- - inspectPreApply() is called before the object's fields are updated,
- when changes are being applied.
- - inspectPostApply() is called after the object's fields are updated.
- - onEditorEnable() is called whenever an editor is enabled (for instance,
- when you hit F11 to bring up the world editor).
- - onEditorDisable() is called whenever the editor is disabled (for instance,
- when you hit F11 again to close the world editor).
- (Note: you can check the variable gEditingMission to see if the mission editor
- is running; if so, you may want to render special indicators. For instance, the
- fxFoliageReplicator renders inner and outer radii when the mission editor is
- running.)
- @section simobject_console The Console
- SimObject extends ConsoleObject by allowing you to
- to set arbitrary dynamic fields on the object, as well as
- statically defined fields. This is done through two methods,
- setDataField and getDataField, which deal with the complexities of
- allowing access to two different types of object fields.
- Static fields take priority over dynamic fields. This is to be
- expected, as the role of dynamic fields is to allow data to be
- stored in addition to the predefined fields.
- The fields in a SimObject are like properties (or fields) in a class.
- Some fields may be arrays, which is what the array parameter is for; if it's non-null,
- then it is parsed with dAtoI and used as an index into the array. If you access something
- as an array which isn't, then you get an empty string.
- <b>You don't need to read any further than this.</b> Right now,
- set/getDataField are called a total of 6 times through the entire
- Torque codebase. Therefore, you probably don't need to be familiar
- with the details of accessing them. You may want to look at Con::setData
- instead. Most of the time you will probably be accessing fields directly,
- or using the scripting language, which in either case means you don't
- need to do anything special.
- The functions to get/set these fields are very straightforward:
- @code
- setDataField(StringTable->insert("locked", false), NULL, b ? "true" : "false" ); curObject->setDataField(curField, curFieldArray, STR.getStringValue()); setDataField(slotName, array, value); </li>
- </ul>
- <p><em>For advanced users:</em> There are two flags which control the behavior of these functions. The first is ModStaticFields, which controls whether or not the DataField functions look through the static fields (defined with addField; see <a class="el" href="class_console_object.html">ConsoleObject</a> for details) of the class. The second is ModDynamicFields, which controls dynamically defined fields. They are set automatically by the console constructor code. </p>
- </div><h2 class="groupheader">Member Enumeration Documentation</h2>
- <a id="aa764d6ab46a34397a2a625235de83577" name="aa764d6ab46a34397a2a625235de83577"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa764d6ab46a34397a2a625235de83577">◆ </a></span>WriteFlags</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="class_sim_object.html#aa764d6ab46a34397a2a625235de83577">WriteFlags</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa764d6ab46a34397a2a625235de83577a03224eeb724e582e75ae323a49e31156" name="aa764d6ab46a34397a2a625235de83577a03224eeb724e582e75ae323a49e31156"></a>SelectedOnly </td><td class="fielddoc"><p>Passed to <a class="el" href="class_sim_object.html#add2aa52391620bbfb9f8c29eb1f921cd">SimObject::write</a> to indicate that only objects </p>
- </td></tr>
- </table>
- </div>
- </div>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a2f0d5f226a833bafd913a942723c6918" name="a2f0d5f226a833bafd913a942723c6918"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2f0d5f226a833bafd913a942723c6918">◆ </a></span>SimObject()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_object.html">SimObject</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a681b2768672c09f14125319ac2308ee6" name="a681b2768672c09f14125319ac2308ee6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a681b2768672c09f14125319ac2308ee6">◆ </a></span>~SimObject()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">~<a class="el" href="class_sim_object.html">SimObject</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="ac9c1a44b539dfe7ca6782c5dd561e9ac" name="ac9c1a44b539dfe7ca6782c5dd561e9ac"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac9c1a44b539dfe7ca6782c5dd561e9ac">◆ </a></span>addFieldFilter()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void addFieldFilter </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>fieldName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a72e24351a839620574085b37ccd8e688" name="a72e24351a839620574085b37ccd8e688"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a72e24351a839620574085b37ccd8e688">◆ </a></span>addListener()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void addListener </td>
- <td>(</td>
- <td class="paramtype">std::string </td>
- <td class="paramname"><em>objID</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ae32c75b008160f8599389fa1416270f4" name="ae32c75b008160f8599389fa1416270f4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae32c75b008160f8599389fa1416270f4">◆ </a></span>addToSet() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool addToSet </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>ObjectName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a3a6c0e9f5513c15dbc861831b392872a" name="a3a6c0e9f5513c15dbc861831b392872a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3a6c0e9f5513c15dbc861831b392872a">◆ </a></span>addToSet() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool addToSet </td>
- <td>(</td>
- <td class="paramtype">SimObjectId </td>
- <td class="paramname"><em>spid</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a27f9b7da7ac37f39ba7e364a74cc943f" name="a27f9b7da7ac37f39ba7e364a74cc943f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a27f9b7da7ac37f39ba7e364a74cc943f">◆ </a></span>allocNotify()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="struct_sim_object_1_1_notify.html">SimObject::Notify</a> * allocNotify </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get a free <a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> structure. </p>
- </div>
- </div>
- <a id="a2ed3c32bdfeb17efd31de7faf0f5b37c" name="a2ed3c32bdfeb17efd31de7faf0f5b37c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2ed3c32bdfeb17efd31de7faf0f5b37c">◆ </a></span>assignDynamicFieldsFrom()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void assignDynamicFieldsFrom </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> * </td>
- <td class="paramname"><em>obj</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Copy dynamic fields from another object onto this one.</p>
- <p>Everything from obj will overwrite what's in this object.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">obj</td><td>Object to copy from. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="afe42c2298dcfb82059cd5d8590a76479" name="afe42c2298dcfb82059cd5d8590a76479"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afe42c2298dcfb82059cd5d8590a76479">◆ </a></span>assignFieldsFrom()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void assignFieldsFrom </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> * </td>
- <td class="paramname"><em>obj</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Copy fields from another object onto this one.</p>
- <p>Objects must be of same type. Everything from obj will overwrite what's in this object; extra fields in this object will remain. This includes dynamic fields.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">obj</td><td>Object to copy from. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a43a200e331c5a48c30890b7ab32557eb" name="a43a200e331c5a48c30890b7ab32557eb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a43a200e331c5a48c30890b7ab32557eb">◆ </a></span>assignName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void assignName </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="afc937cb7e1cd1b0768101aec936bbe45" name="afc937cb7e1cd1b0768101aec936bbe45"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afc937cb7e1cd1b0768101aec936bbe45">◆ </a></span>buildFilterList()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void buildFilterList </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac1e31054548229bd5ea4779d9cbc2be2" name="ac1e31054548229bd5ea4779d9cbc2be2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac1e31054548229bd5ea4779d9cbc2be2">◆ </a></span>clearAllNotifications()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void clearAllNotifications </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove all notifications for this object. </p>
- </div>
- </div>
- <a id="a5a09726e6e6f20422bf0d5d9f1cd9422" name="a5a09726e6e6f20422bf0d5d9f1cd9422"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5a09726e6e6f20422bf0d5d9f1cd9422">◆ </a></span>clearDynamicFields()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void clearDynamicFields </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clear all dynamic fields. </p>
- </div>
- </div>
- <a id="a97791ba163a65547d7a5d47bed803d7d" name="a97791ba163a65547d7a5d47bed803d7d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a97791ba163a65547d7a5d47bed803d7d">◆ </a></span>clearFieldFilters()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void clearFieldFilters </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ae9d02581f339ef7ede02efaf54bed50e" name="ae9d02581f339ef7ede02efaf54bed50e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae9d02581f339ef7ede02efaf54bed50e">◆ </a></span>clearNotify()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void clearNotify </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> * </td>
- <td class="paramname"><em>obj</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p><a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> an object when we are cleared. </p>
- </div>
- </div>
- <a id="aacb30b9c403e8687e109b7738af141d8" name="aacb30b9c403e8687e109b7738af141d8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aacb30b9c403e8687e109b7738af141d8">◆ </a></span>clone()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_object.html">SimObject</a> * clone </td>
- <td>(</td>
- <td class="paramtype">const bool </td>
- <td class="paramname"><em>copyDynamicFields</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a62aa4e3f1aea3c0841234882d0105c1b" name="a62aa4e3f1aea3c0841234882d0105c1b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a62aa4e3f1aea3c0841234882d0105c1b">◆ </a></span>copyTo()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void copyTo </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> * </td>
- <td class="paramname"><em>object</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reimplemented in <a class="el" href="class_shape_vector.html#add6ef633c96e2e1663b017c4541ddb1e">ShapeVector</a>, <a class="el" href="class_animation_asset.html#a62aa4e3f1aea3c0841234882d0105c1b">AnimationAsset</a>, <a class="el" href="class_font_asset.html#a62aa4e3f1aea3c0841234882d0105c1b">FontAsset</a>, <a class="el" href="class_image_asset.html#a62aa4e3f1aea3c0841234882d0105c1b">ImageAsset</a>, <a class="el" href="class_particle_asset.html#a62aa4e3f1aea3c0841234882d0105c1b">ParticleAsset</a>, <a class="el" href="class_particle_asset_emitter.html#a62aa4e3f1aea3c0841234882d0105c1b">ParticleAssetEmitter</a>, <a class="el" href="class_ambient_force_controller.html#a62aa4e3f1aea3c0841234882d0105c1b">AmbientForceController</a>, <a class="el" href="class_buoyancy_controller.html#a62aa4e3f1aea3c0841234882d0105c1b">BuoyancyController</a>, <a class="el" href="class_grouped_scene_controller.html#a62aa4e3f1aea3c0841234882d0105c1b">GroupedSceneController</a>, <a class="el" href="class_picking_scene_controller.html#a62aa4e3f1aea3c0841234882d0105c1b">PickingSceneController</a>, <a class="el" href="class_point_force_controller.html#a62aa4e3f1aea3c0841234882d0105c1b">PointForceController</a>, <a class="el" href="class_render_proxy.html#a62aa4e3f1aea3c0841234882d0105c1b">RenderProxy</a>, <a class="el" href="class_sprite_base.html#a62aa4e3f1aea3c0841234882d0105c1b">SpriteBase</a>, <a class="el" href="class_wave_composite.html#a62aa4e3f1aea3c0841234882d0105c1b">WaveComposite</a>, <a class="el" href="class_gui_sprite_ctrl.html#a62aa4e3f1aea3c0841234882d0105c1b">GuiSpriteCtrl</a>, <a class="el" href="class_composite_sprite.html#a62aa4e3f1aea3c0841234882d0105c1b">CompositeSprite</a>, <a class="el" href="class_particle_player.html#a62aa4e3f1aea3c0841234882d0105c1b">ParticlePlayer</a>, <a class="el" href="class_scene_object.html#a62aa4e3f1aea3c0841234882d0105c1b">SceneObject</a>, <a class="el" href="class_scroller.html#a62aa4e3f1aea3c0841234882d0105c1b">Scroller</a>, <a class="el" href="class_sprite.html#a62aa4e3f1aea3c0841234882d0105c1b">Sprite</a>, <a class="el" href="class_text_sprite.html#a62aa4e3f1aea3c0841234882d0105c1b">TextSprite</a>, <a class="el" href="class_trigger.html#a62aa4e3f1aea3c0841234882d0105c1b">Trigger</a>, <a class="el" href="class_asset_base.html#a62aa4e3f1aea3c0841234882d0105c1b">AssetBase</a>, <a class="el" href="class_audio_asset.html#a62aa4e3f1aea3c0841234882d0105c1b">AudioAsset</a>, and <a class="el" href="class_behavior_component.html#a62aa4e3f1aea3c0841234882d0105c1b">BehaviorComponent</a>.</p>
- </div>
- </div>
- <a id="a5347739a7bbaab1de0130ac29073dcfd" name="a5347739a7bbaab1de0130ac29073dcfd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5347739a7bbaab1de0130ac29073dcfd">◆ </a></span>DECLARE_CONOBJECT()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">DECLARE_CONOBJECT </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a2838b603fe80fa772e6be008b649decf" name="a2838b603fe80fa772e6be008b649decf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2838b603fe80fa772e6be008b649decf">◆ </a></span>deleteNotify()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void deleteNotify </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> * </td>
- <td class="paramname"><em>obj</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p><a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> an object when we are deleted. </p>
- </div>
- </div>
- <a id="a035562e6d1b195a025da907836d24d1c" name="a035562e6d1b195a025da907836d24d1c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a035562e6d1b195a025da907836d24d1c">◆ </a></span>deleteObject()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void deleteObject </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Unregister, mark as deleted, and free the object. </p>
- </div>
- </div>
- <a id="accd2600060dbaee3a3b41aed4034c63c" name="accd2600060dbaee3a3b41aed4034c63c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#accd2600060dbaee3a3b41aed4034c63c">◆ </a></span>dump()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void dump </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a1810f5aba25efd242c24232c2c2bbd1a" name="a1810f5aba25efd242c24232c2c2bbd1a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1810f5aba25efd242c24232c2c2bbd1a">◆ </a></span>dumpClassHierarchy()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void dumpClassHierarchy </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aea6dde4400c9c8a5bd378a89a055cf92" name="aea6dde4400c9c8a5bd378a89a055cf92"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aea6dde4400c9c8a5bd378a89a055cf92">◆ </a></span>findObject()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_object.html">SimObject</a> * findObject </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Find a named sub-object of this object.</p>
- <p>This is subclassed in the <a class="el" href="class_sim_group.html">SimGroup</a> and <a class="el" href="class_sim_set.html">SimSet</a> classes.</p>
- <p>For a single object, it just returns NULL, as normal objects cannot have children. </p>
- <p>Reimplemented in <a class="el" href="class_scene_object_set.html#aea6dde4400c9c8a5bd378a89a055cf92">SceneObjectSet</a>, <a class="el" href="class_sim_set.html#aea6dde4400c9c8a5bd378a89a055cf92">SimSet</a>, and <a class="el" href="class_sim_group.html#aea6dde4400c9c8a5bd378a89a055cf92">SimGroup</a>.</p>
- </div>
- </div>
- <a id="aa77d566406c826b12013b264b4d72450" name="aa77d566406c826b12013b264b4d72450"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa77d566406c826b12013b264b4d72450">◆ </a></span>freeNotify()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void freeNotify </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_sim_object_1_1_notify.html">SimObject::Notify</a> * </td>
- <td class="paramname"><em>note</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Mark a <a class="el" href="struct_sim_object_1_1_notify.html">Notify</a> structure as free. </p>
- </div>
- </div>
- <a id="a5e521770780a12f40f6fbf75b668c4ad" name="a5e521770780a12f40f6fbf75b668c4ad"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5e521770780a12f40f6fbf75b668c4ad">◆ </a></span>getCanSaveDynamicFields()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool getCanSaveDynamicFields </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get whether fields created at runtime should be saved. Default is true. </p>
- </div>
- </div>
- <a id="a8defc59286e7d323201bbeb1a07c2554" name="a8defc59286e7d323201bbeb1a07c2554"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8defc59286e7d323201bbeb1a07c2554">◆ </a></span>getClassNamespace()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry getClassNamespace </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a61da44826bbcdcbed3775d0b59dcbea7" name="a61da44826bbcdcbed3775d0b59dcbea7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a61da44826bbcdcbed3775d0b59dcbea7">◆ </a></span>getDataField()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const char * getDataField </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>slotName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>array</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aad68561955e2af5a7ec3e3bed8fd4c62" name="aad68561955e2af5a7ec3e3bed8fd4c62"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aad68561955e2af5a7ec3e3bed8fd4c62">◆ </a></span>getDataFieldPrefix()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry getDataFieldPrefix </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>fieldName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a825bbfc5684ff3b4f43a17932cea0582" name="a825bbfc5684ff3b4f43a17932cea0582"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a825bbfc5684ff3b4f43a17932cea0582">◆ </a></span>getDataFieldType()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">U32 getDataFieldType </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>slotName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>array</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the type of a field on the object.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">slotName</td><td>Field to access. </td></tr>
- <tr><td class="paramname">array</td><td>String containing index into array (if field is an array); if NULL, it is ignored. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a8bb1d1ae4846e2edea63ae6db267c847" name="a8bb1d1ae4846e2edea63ae6db267c847"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8bb1d1ae4846e2edea63ae6db267c847">◆ </a></span>getFieldDictionary()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_field_dictionary.html">SimFieldDictionary</a> * getFieldDictionary </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get reference to the dictionary containing dynamic fields.</p>
- <p>See <a class="el" href="class_sim_object.html#simobject_console">here</a> for a detailed discussion of what this function does.</p>
- <p>This dictionary can be iterated over using a <a class="el" href="class_sim_field_dictionary_iterator.html">SimFieldDictionaryIterator</a>. </p>
- </div>
- </div>
- <a id="a8cd893920348a8bb5566e86b188bba37" name="a8cd893920348a8bb5566e86b188bba37"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8cd893920348a8bb5566e86b188bba37">◆ </a></span>getGroup()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_sim_group.html">SimGroup</a> * getGroup </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa4a7bd634ae9f58bccb125fe45d86fc9" name="aa4a7bd634ae9f58bccb125fe45d86fc9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa4a7bd634ae9f58bccb125fe45d86fc9">◆ </a></span>getId()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">SimObjectId getId </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a571c5d0b4440f6f1d5e4ab220949897e" name="a571c5d0b4440f6f1d5e4ab220949897e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a571c5d0b4440f6f1d5e4ab220949897e">◆ </a></span>getIdString()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry getIdString </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa9e468963daa41c06c14cc2d6282b456" name="aa9e468963daa41c06c14cc2d6282b456"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa9e468963daa41c06c14cc2d6282b456">◆ </a></span>getInternalName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry getInternalName </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the internal of of this control. </p>
- </div>
- </div>
- <a id="afef631e435982063322597320f4c817f" name="afef631e435982063322597320f4c817f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afef631e435982063322597320f4c817f">◆ </a></span>getName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const StringTableEntry getName </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a7122ae5ad0933f2041746e4c80757269" name="a7122ae5ad0933f2041746e4c80757269"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7122ae5ad0933f2041746e4c80757269">◆ </a></span>getNamespace()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_namespace.html">Namespace</a> * getNamespace </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the object's namespace. </p>
- </div>
- </div>
- <a id="a1bca5aee058d82e2c22db072bbfdef96" name="a1bca5aee058d82e2c22db072bbfdef96"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1bca5aee058d82e2c22db072bbfdef96">◆ </a></span>getPeriodicTimerID()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">S32 getPeriodicTimerID </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a1fffab6c801d5afd3a6116bfaa05011e" name="a1fffab6c801d5afd3a6116bfaa05011e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1fffab6c801d5afd3a6116bfaa05011e">◆ </a></span>getPrefixedDataField()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const char * getPrefixedDataField </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>fieldName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>array</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a60a0b20565b21ca6534788ecf030b0db" name="a60a0b20565b21ca6534788ecf030b0db"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a60a0b20565b21ca6534788ecf030b0db">◆ </a></span>getPrefixedDynamicDataField()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const char * getPrefixedDynamicDataField </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>fieldName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>array</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const S32 </td>
- <td class="paramname"><em>fieldType</em> = <code>-1</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ab9ddb5b67db343e1b7a8014bfc326bf8" name="ab9ddb5b67db343e1b7a8014bfc326bf8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab9ddb5b67db343e1b7a8014bfc326bf8">◆ </a></span>getProgenitorFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry getProgenitorFile </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a818bf0b599f807adffb0562ba8b19f28" name="a818bf0b599f807adffb0562ba8b19f28"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a818bf0b599f807adffb0562ba8b19f28">◆ </a></span>getScriptCallbackGuard()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">S32 getScriptCallbackGuard </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ab4678bf80f0b627902ea12e02ccd9db0" name="ab4678bf80f0b627902ea12e02ccd9db0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab4678bf80f0b627902ea12e02ccd9db0">◆ </a></span>getSuperClassNamespace()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry getSuperClassNamespace </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a604dfe76701f827f0d0787f1ec29b690" name="a604dfe76701f827f0d0787f1ec29b690"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a604dfe76701f827f0d0787f1ec29b690">◆ </a></span>getType()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 getType </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a76fd3b455488c03e0c8683b836ee96a2" name="a76fd3b455488c03e0c8683b836ee96a2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a76fd3b455488c03e0c8683b836ee96a2">◆ </a></span>handlesConsoleMethod()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool handlesConsoleMethod </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>fname</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">S32 * </td>
- <td class="paramname"><em>routingId</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reimplemented in <a class="el" href="class_behavior_component.html#a992962b4d3263ded2a0c5ca3c39b0a73">BehaviorComponent</a>, and <a class="el" href="class_dynamic_console_method_component.html#a992962b4d3263ded2a0c5ca3c39b0a73">DynamicConsoleMethodComponent</a>.</p>
- </div>
- </div>
- <a id="a67420d3593db1aae6efb2c3abb23c690" name="a67420d3593db1aae6efb2c3abb23c690"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a67420d3593db1aae6efb2c3abb23c690">◆ </a></span>initPersistFields()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void initPersistFields </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aefba6ba5e9b537b3d11e5416add644e1" name="aefba6ba5e9b537b3d11e5416add644e1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aefba6ba5e9b537b3d11e5416add644e1">◆ </a></span>inspectPostApply()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void inspectPostApply </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called after any property of the object is changed in the world editor.</p>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sim_object.html#acb00b32e56849913eae3abc6f872b572">inspectPreApply</a> </dd></dl>
- <p>Reimplemented in <a class="el" href="class_gui_scene_object_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiSceneObjectCtrl</a>, <a class="el" href="class_gui_chain_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiChainCtrl</a>, <a class="el" href="class_gui_frame_set_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiFrameSetCtrl</a>, <a class="el" href="class_gui_grid_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiGridCtrl</a>, <a class="el" href="class_gui_scroll_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiScrollCtrl</a>, <a class="el" href="class_gui_inspector.html#aefba6ba5e9b537b3d11e5416add644e1">GuiInspector</a>, <a class="el" href="class_gui_menu_bar_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiMenuBarCtrl</a>, <a class="el" href="class_gui_menu_item_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiMenuItemCtrl</a>, <a class="el" href="class_gui_control.html#aefba6ba5e9b537b3d11e5416add644e1">GuiControl</a>, <a class="el" href="class_gui_message_vector_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiMessageVectorCtrl</a>, and <a class="el" href="class_gui_text_edit_ctrl.html#aefba6ba5e9b537b3d11e5416add644e1">GuiTextEditCtrl</a>.</p>
- </div>
- </div>
- <a id="acb00b32e56849913eae3abc6f872b572" name="acb00b32e56849913eae3abc6f872b572"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acb00b32e56849913eae3abc6f872b572">◆ </a></span>inspectPreApply()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void inspectPreApply </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Specifically, this is called by setDataField when a static field is modified, see <a class="el" href="class_sim_object.html#simobject_console">the console details</a>. Called before any property of the object is changed in the world editor.</p>
- <p>The calling order here is:</p><ul>
- <li><a class="el" href="class_sim_object.html#acb00b32e56849913eae3abc6f872b572">inspectPreApply()</a></li>
- <li>...</li>
- <li>calls to <a class="el" href="class_sim_object.html#a13add87ef90b3882bd7eaff39004eb35">setDataField()</a></li>
- <li>...</li>
- <li><a class="el" href="class_sim_object.html#aefba6ba5e9b537b3d11e5416add644e1">inspectPostApply()</a> </li>
- </ul>
- <p>Reimplemented in <a class="el" href="class_gui_chain_ctrl.html#acb00b32e56849913eae3abc6f872b572">GuiChainCtrl</a>, and <a class="el" href="class_gui_control.html#acb00b32e56849913eae3abc6f872b572">GuiControl</a>.</p>
- </div>
- </div>
- <a id="a4ba53dcc84f4c3192248367068eeb22a" name="a4ba53dcc84f4c3192248367068eeb22a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4ba53dcc84f4c3192248367068eeb22a">◆ </a></span>isChildOfGroup()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool isChildOfGroup </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_group.html">SimGroup</a> * </td>
- <td class="paramname"><em>pGroup</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac8efc5df207a89f8c9044015074c19d8" name="ac8efc5df207a89f8c9044015074c19d8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac8efc5df207a89f8c9044015074c19d8">◆ </a></span>isDeleted()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isDeleted </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a78577963741dd7d80dae749dccc02fc2" name="a78577963741dd7d80dae749dccc02fc2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a78577963741dd7d80dae749dccc02fc2">◆ </a></span>isExpanded()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isExpanded </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="af05be979fb46390caf87d391486d38b1" name="af05be979fb46390caf87d391486d38b1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af05be979fb46390caf87d391486d38b1">◆ </a></span>isFiltered()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool isFiltered </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>fieldName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a451227147204d105046094b758ce3438" name="a451227147204d105046094b758ce3438"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a451227147204d105046094b758ce3438">◆ </a></span>isHidden()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isHidden </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a43966e19963e4bcb7f7f9b5327ec732b" name="a43966e19963e4bcb7f7f9b5327ec732b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a43966e19963e4bcb7f7f9b5327ec732b">◆ </a></span>isLocked()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isLocked </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8a1d5ac5403526378c7abb0916c55c3c" name="a8a1d5ac5403526378c7abb0916c55c3c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8a1d5ac5403526378c7abb0916c55c3c">◆ </a></span>isMethod()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isMethod </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>methodName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Check if a method exists in the objects current namespace. </p>
- </div>
- </div>
- <a id="a45f7816c50cb3b1b9dc31bdc271db3dc" name="a45f7816c50cb3b1b9dc31bdc271db3dc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a45f7816c50cb3b1b9dc31bdc271db3dc">◆ </a></span>isPeriodicTimerActive()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isPeriodicTimerActive </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a0b639b01b66038bf995b7943b9c4cca2" name="a0b639b01b66038bf995b7943b9c4cca2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0b639b01b66038bf995b7943b9c4cca2">◆ </a></span>isProperlyAdded()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isProperlyAdded </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a69e923e012cb8988e900f51ff135fd7f" name="a69e923e012cb8988e900f51ff135fd7f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a69e923e012cb8988e900f51ff135fd7f">◆ </a></span>isRemoved()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isRemoved </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a56a065a2c20a230931de0ed98019d8fb" name="a56a065a2c20a230931de0ed98019d8fb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a56a065a2c20a230931de0ed98019d8fb">◆ </a></span>isSelected()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isSelected </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a526b0ae2c04966128bcbb3c12f5a283d" name="a526b0ae2c04966128bcbb3c12f5a283d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a526b0ae2c04966128bcbb3c12f5a283d">◆ </a></span>isType()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isType </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a9d1bbaa7a9b2443eeb39c4a127d9f9e8" name="a9d1bbaa7a9b2443eeb39c4a127d9f9e8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9d1bbaa7a9b2443eeb39c4a127d9f9e8">◆ </a></span>linkNamespaces()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void linkNamespaces </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa8fb2a4e72e5c4975d3cd912c5de131a" name="aa8fb2a4e72e5c4975d3cd912c5de131a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa8fb2a4e72e5c4975d3cd912c5de131a">◆ </a></span>onAdd()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool onAdd </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when the object is added to the sim. </p>
- <p>Reimplemented in <a class="el" href="class_animation_asset.html#aa8fb2a4e72e5c4975d3cd912c5de131a">AnimationAsset</a>, <a class="el" href="class_font_asset.html#aa8fb2a4e72e5c4975d3cd912c5de131a">FontAsset</a>, <a class="el" href="class_image_asset.html#aa8fb2a4e72e5c4975d3cd912c5de131a">ImageAsset</a>, <a class="el" href="class_editor_toy_scene_window.html#aa8fb2a4e72e5c4975d3cd912c5de131a">EditorToySceneWindow</a>, <a class="el" href="class_editor_toy_tool.html#aa8fb2a4e72e5c4975d3cd912c5de131a">EditorToyTool</a>, <a class="el" href="class_scene_window.html#aa8fb2a4e72e5c4975d3cd912c5de131a">SceneWindow</a>, <a class="el" href="class_scene.html#aa8fb2a4e72e5c4975d3cd912c5de131a">Scene</a>, <a class="el" href="class_composite_sprite.html#aa8fb2a4e72e5c4975d3cd912c5de131a">CompositeSprite</a>, <a class="el" href="class_light_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a">LightObject</a>, <a class="el" href="class_scene_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a">SceneObject</a>, <a class="el" href="class_scroller.html#aa8fb2a4e72e5c4975d3cd912c5de131a">Scroller</a>, <a class="el" href="class_shape_vector.html#aa8fb2a4e72e5c4975d3cd912c5de131a">ShapeVector</a>, <a class="el" href="class_text_sprite.html#aa8fb2a4e72e5c4975d3cd912c5de131a">TextSprite</a>, <a class="el" href="class_trigger.html#aa8fb2a4e72e5c4975d3cd912c5de131a">Trigger</a>, <a class="el" href="class_asset_manager.html#aa8fb2a4e72e5c4975d3cd912c5de131a">AssetManager</a>, <a class="el" href="class_name_tags.html#aa8fb2a4e72e5c4975d3cd912c5de131a">NameTags</a>, <a class="el" href="class_undo_script_action.html#a2616b18f797c687205b1ab7d47fda07d">UndoScriptAction</a>, <a class="el" href="class_behavior_component.html#aa8fb2a4e72e5c4975d3cd912c5de131a">BehaviorComponent</a>, <a class="el" href="class_behavior_instance.html#aa8fb2a4e72e5c4975d3cd912c5de131a">BehaviorInstance</a>, <a class="el" href="class_behavior_template.html#aa8fb2a4e72e5c4975d3cd912c5de131a">BehaviorTemplate</a>, <a class="el" href="class_sim_component.html#aa8fb2a4e72e5c4975d3cd912c5de131a">SimComponent</a>, <a class="el" href="class_array.html#aa8fb2a4e72e5c4975d3cd912c5de131a">Array</a>, <a class="el" href="class_game_connection.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GameConnection</a>, <a class="el" href="class_gui_frame_set_ctrl.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiFrameSetCtrl</a>, <a class="el" href="class_gui_frame_set_ctrl.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiFrameSetCtrl</a>, <a class="el" href="class_gui_panel_ctrl.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiPanelCtrl</a>, <a class="el" href="class_gui_tab_book_ctrl.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiTabBookCtrl</a>, <a class="el" href="class_gui_edit_ctrl.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiEditCtrl</a>, <a class="el" href="class_gui_inspector_field.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiInspectorField</a>, <a class="el" href="class_gui_inspector_group.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiInspectorGroup</a>, <a class="el" href="class_gui_inspector_dynamic_field.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiInspectorDynamicField</a>, <a class="el" href="class_gui_control.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiControl</a>, <a class="el" href="class_gui_message_vector_ctrl.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiMessageVectorCtrl</a>, <a class="el" href="class_gui_text_edit_ctrl.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiTextEditCtrl</a>, <a class="el" href="class_gui_border_profile.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiBorderProfile</a>, <a class="el" href="class_gui_control_profile.html#aa8fb2a4e72e5c4975d3cd912c5de131a">GuiControlProfile</a>, <a class="el" href="class_message_vector.html#aa8fb2a4e72e5c4975d3cd912c5de131a">MessageVector</a>, <a class="el" href="class_action_map.html#aa8fb2a4e72e5c4975d3cd912c5de131a">ActionMap</a>, <a class="el" href="class_file_stream_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a">FileStreamObject</a>, <a class="el" href="class_stream_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a">StreamObject</a>, <a class="el" href="class_module_manager.html#aa8fb2a4e72e5c4975d3cd912c5de131a">ModuleManager</a>, <a class="el" href="class_net_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a">NetObject</a>, <a class="el" href="class_t_c_p_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a">TCPObject</a>, <a class="el" href="class_sim_x_m_l_document.html#aa8fb2a4e72e5c4975d3cd912c5de131a">SimXMLDocument</a>, <a class="el" href="class_taml.html#aa8fb2a4e72e5c4975d3cd912c5de131a">Taml</a>, <a class="el" href="class_popup_menu.html#aa8fb2a4e72e5c4975d3cd912c5de131a">PopupMenu</a>, <a class="el" href="class_u_input_manager.html#aa8fb2a4e72e5c4975d3cd912c5de131a">UInputManager</a>, <a class="el" href="class_sim_data_block.html#aa8fb2a4e72e5c4975d3cd912c5de131a">SimDataBlock</a>, and <a class="el" href="class_gui_cursor.html#a5d7b311e7d81f6b29e262f3f8a659a07">GuiCursor</a>.</p>
- </div>
- </div>
- <a id="a8db26dd3c0ca2b1ac05e7c3516325e61" name="a8db26dd3c0ca2b1ac05e7c3516325e61"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8db26dd3c0ca2b1ac05e7c3516325e61">◆ </a></span>onDeleteNotify()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void onDeleteNotify </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> * </td>
- <td class="paramname"><em>object</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when a <a class="el" href="class_sim_object.html">SimObject</a> is deleted.</p>
- <p>When you are on the notification list for another object and it is deleted, this method is called. </p>
- <p>Reimplemented in <a class="el" href="class_particle_asset.html#a8db26dd3c0ca2b1ac05e7c3516325e61">ParticleAsset</a>, <a class="el" href="class_scene.html#a8db26dd3c0ca2b1ac05e7c3516325e61">Scene</a>, <a class="el" href="class_path.html#a8db26dd3c0ca2b1ac05e7c3516325e61">Path</a>, <a class="el" href="class_scene_object_set.html#a8db26dd3c0ca2b1ac05e7c3516325e61">SceneObjectSet</a>, <a class="el" href="class_behavior_component.html#a8db26dd3c0ca2b1ac05e7c3516325e61">BehaviorComponent</a>, <a class="el" href="class_module_manager.html#a8db26dd3c0ca2b1ac05e7c3516325e61">ModuleManager</a>, <a class="el" href="class_u_input_manager.html#a8db26dd3c0ca2b1ac05e7c3516325e61">UInputManager</a>, and <a class="el" href="class_sim_set.html#a8db26dd3c0ca2b1ac05e7c3516325e61">SimSet</a>.</p>
- </div>
- </div>
- <a id="a1444b2e49c37757bf57740bcd43a5a19" name="a1444b2e49c37757bf57740bcd43a5a19"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1444b2e49c37757bf57740bcd43a5a19">◆ </a></span>onEditorDisable()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onEditorDisable </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when the editor is deactivated. </p>
- </div>
- </div>
- <a id="a35ed1968ac7850e14737aa7ccb4356a6" name="a35ed1968ac7850e14737aa7ccb4356a6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a35ed1968ac7850e14737aa7ccb4356a6">◆ </a></span>onEditorEnable()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onEditorEnable </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when the editor is activated. </p>
- </div>
- </div>
- <a id="a0e0c7d4c3cea7aee9d23a4b596a92fba" name="a0e0c7d4c3cea7aee9d23a4b596a92fba"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0e0c7d4c3cea7aee9d23a4b596a92fba">◆ </a></span>onGroupAdd()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void onGroupAdd </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when the object is added to a <a class="el" href="class_sim_group.html">SimGroup</a>. </p>
- </div>
- </div>
- <a id="ad8e217b4d87fd05d0cc53eed4482926f" name="ad8e217b4d87fd05d0cc53eed4482926f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad8e217b4d87fd05d0cc53eed4482926f">◆ </a></span>onGroupRemove()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void onGroupRemove </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when the object is removed from a <a class="el" href="class_sim_group.html">SimGroup</a>. </p>
- <p>Reimplemented in <a class="el" href="class_gui_control.html#ad8e217b4d87fd05d0cc53eed4482926f">GuiControl</a>.</p>
- </div>
- </div>
- <a id="ab83e4b1fa22db99d20741b86321a400d" name="ab83e4b1fa22db99d20741b86321a400d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab83e4b1fa22db99d20741b86321a400d">◆ </a></span>onNameChange()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void onNameChange </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when the object's name is changed. </p>
- </div>
- </div>
- <a id="a28fb2b0653c2c31284ebef9237dc9c5c" name="a28fb2b0653c2c31284ebef9237dc9c5c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a28fb2b0653c2c31284ebef9237dc9c5c">◆ </a></span>onRemove()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void onRemove </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when the object is removed from the sim. </p>
- <p>Reimplemented in <a class="el" href="class_animation_asset.html#a28fb2b0653c2c31284ebef9237dc9c5c">AnimationAsset</a>, <a class="el" href="class_font_asset.html#a28fb2b0653c2c31284ebef9237dc9c5c">FontAsset</a>, <a class="el" href="class_image_asset.html#a28fb2b0653c2c31284ebef9237dc9c5c">ImageAsset</a>, <a class="el" href="class_editor_toy_scene_window.html#a28fb2b0653c2c31284ebef9237dc9c5c">EditorToySceneWindow</a>, <a class="el" href="class_editor_toy_tool.html#a28fb2b0653c2c31284ebef9237dc9c5c">EditorToyTool</a>, <a class="el" href="class_scene_window.html#a28fb2b0653c2c31284ebef9237dc9c5c">SceneWindow</a>, <a class="el" href="class_scene.html#a28fb2b0653c2c31284ebef9237dc9c5c">Scene</a>, <a class="el" href="class_composite_sprite.html#a28fb2b0653c2c31284ebef9237dc9c5c">CompositeSprite</a>, <a class="el" href="class_light_object.html#a28fb2b0653c2c31284ebef9237dc9c5c">LightObject</a>, <a class="el" href="class_scene_object.html#a28fb2b0653c2c31284ebef9237dc9c5c">SceneObject</a>, <a class="el" href="class_scene_object_set.html#a28fb2b0653c2c31284ebef9237dc9c5c">SceneObjectSet</a>, <a class="el" href="class_scroller.html#a28fb2b0653c2c31284ebef9237dc9c5c">Scroller</a>, <a class="el" href="class_shape_vector.html#a28fb2b0653c2c31284ebef9237dc9c5c">ShapeVector</a>, <a class="el" href="class_text_sprite.html#a28fb2b0653c2c31284ebef9237dc9c5c">TextSprite</a>, <a class="el" href="class_asset_manager.html#a28fb2b0653c2c31284ebef9237dc9c5c">AssetManager</a>, <a class="el" href="class_undo_script_action.html#a2dbcdaacaa525e64afa2e6aa7f2c207d">UndoScriptAction</a>, <a class="el" href="class_behavior_component.html#a28fb2b0653c2c31284ebef9237dc9c5c">BehaviorComponent</a>, <a class="el" href="class_behavior_instance.html#a28fb2b0653c2c31284ebef9237dc9c5c">BehaviorInstance</a>, <a class="el" href="class_behavior_template.html#a28fb2b0653c2c31284ebef9237dc9c5c">BehaviorTemplate</a>, <a class="el" href="class_sim_component.html#a28fb2b0653c2c31284ebef9237dc9c5c">SimComponent</a>, <a class="el" href="class_array.html#a28fb2b0653c2c31284ebef9237dc9c5c">Array</a>, <a class="el" href="class_game_connection.html#a28fb2b0653c2c31284ebef9237dc9c5c">GameConnection</a>, <a class="el" href="class_gui_tab_book_ctrl.html#a28fb2b0653c2c31284ebef9237dc9c5c">GuiTabBookCtrl</a>, <a class="el" href="class_gui_edit_ctrl.html#a28fb2b0653c2c31284ebef9237dc9c5c">GuiEditCtrl</a>, <a class="el" href="class_gui_control.html#a28fb2b0653c2c31284ebef9237dc9c5c">GuiControl</a>, <a class="el" href="class_gui_message_vector_ctrl.html#a28fb2b0653c2c31284ebef9237dc9c5c">GuiMessageVectorCtrl</a>, <a class="el" href="class_gui_cursor.html#a28fb2b0653c2c31284ebef9237dc9c5c">GuiCursor</a>, <a class="el" href="class_gui_border_profile.html#a28fb2b0653c2c31284ebef9237dc9c5c">GuiBorderProfile</a>, <a class="el" href="class_message_vector.html#a28fb2b0653c2c31284ebef9237dc9c5c">MessageVector</a>, <a class="el" href="class_module_manager.html#a28fb2b0653c2c31284ebef9237dc9c5c">ModuleManager</a>, <a class="el" href="class_net_connection.html#a28fb2b0653c2c31284ebef9237dc9c5c">NetConnection</a>, <a class="el" href="class_net_object.html#a28fb2b0653c2c31284ebef9237dc9c5c">NetObject</a>, <a class="el" href="class_sim_x_m_l_document.html#a28fb2b0653c2c31284ebef9237dc9c5c">SimXMLDocument</a>, <a class="el" href="class_taml.html#a28fb2b0653c2c31284ebef9237dc9c5c">Taml</a>, <a class="el" href="class_popup_menu.html#a28fb2b0653c2c31284ebef9237dc9c5c">PopupMenu</a>, <a class="el" href="class_u_input_manager.html#a28fb2b0653c2c31284ebef9237dc9c5c">UInputManager</a>, <a class="el" href="class_sim_data_block.html#a28fb2b0653c2c31284ebef9237dc9c5c">SimDataBlock</a>, <a class="el" href="class_sim_set.html#a28fb2b0653c2c31284ebef9237dc9c5c">SimSet</a>, and <a class="el" href="class_sim_group.html#a28fb2b0653c2c31284ebef9237dc9c5c">SimGroup</a>.</p>
- </div>
- </div>
- <a id="a774b03009201ddc3fd55367f5578384f" name="a774b03009201ddc3fd55367f5578384f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a774b03009201ddc3fd55367f5578384f">◆ </a></span>onStaticModified()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void onStaticModified </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>slotName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>newValue</em> = <code>NULL</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called when a static field is modified. </p>
- <p>Reimplemented in <a class="el" href="class_sim_data_block.html#a774b03009201ddc3fd55367f5578384f">SimDataBlock</a>.</p>
- </div>
- </div>
- <a id="ad03b42162545e4be24b218369f4fbcf5" name="ad03b42162545e4be24b218369f4fbcf5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad03b42162545e4be24b218369f4fbcf5">◆ </a></span>onTamlAddParent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onTamlAddParent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> * </td>
- <td class="paramname"><em>pParentObject</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called after <a class="el" href="class_taml.html">Taml</a> has finished reading the object and has added the object to any parent. </p>
- <p>Implements <a class="el" href="class_taml_callbacks.html">TamlCallbacks</a>.</p>
- <p>Reimplemented in <a class="el" href="class_particle_player.html#a85f3913566a705d7b642d41ce288073f">ParticlePlayer</a>.</p>
- </div>
- </div>
- <a id="a3d9c05e2d4a4ba16cc11dc7949015a3e" name="a3d9c05e2d4a4ba16cc11dc7949015a3e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3d9c05e2d4a4ba16cc11dc7949015a3e">◆ </a></span>onTamlCustomRead()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onTamlCustomRead </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_taml_custom_nodes.html">TamlCustomNodes</a> & </td>
- <td class="paramname"><em>customNodes</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called during the reading of the object to allow custom properties to be read. </p>
- <p>Implements <a class="el" href="class_taml_callbacks.html">TamlCallbacks</a>.</p>
- <p>Reimplemented in <a class="el" href="class_font_asset.html#af46594ff3cf78be8bee74463cd2eab14">FontAsset</a>, <a class="el" href="class_image_asset.html#af46594ff3cf78be8bee74463cd2eab14">ImageAsset</a>, <a class="el" href="class_particle_asset.html#af46594ff3cf78be8bee74463cd2eab14">ParticleAsset</a>, <a class="el" href="class_particle_asset_emitter.html#af46594ff3cf78be8bee74463cd2eab14">ParticleAssetEmitter</a>, <a class="el" href="class_scene.html#af46594ff3cf78be8bee74463cd2eab14">Scene</a>, <a class="el" href="class_composite_sprite.html#af46594ff3cf78be8bee74463cd2eab14">CompositeSprite</a>, <a class="el" href="class_scene_object.html#af46594ff3cf78be8bee74463cd2eab14">SceneObject</a>, <a class="el" href="class_asset_query.html#af46594ff3cf78be8bee74463cd2eab14">AssetQuery</a>, <a class="el" href="class_asset_tags_manifest.html#af46594ff3cf78be8bee74463cd2eab14">AssetTagsManifest</a>, <a class="el" href="class_behavior_component.html#af46594ff3cf78be8bee74463cd2eab14">BehaviorComponent</a>, and <a class="el" href="class_gui_frame_set_ctrl.html#af46594ff3cf78be8bee74463cd2eab14">GuiFrameSetCtrl</a>.</p>
- </div>
- </div>
- <a id="a037d9b99b69dbd817a78b7a7758d1a69" name="a037d9b99b69dbd817a78b7a7758d1a69"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a037d9b99b69dbd817a78b7a7758d1a69">◆ </a></span>onTamlCustomWrite()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onTamlCustomWrite </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_taml_custom_nodes.html">TamlCustomNodes</a> & </td>
- <td class="paramname"><em>customNodes</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called during the writing of the object to allow custom properties to be written. </p>
- <p>Implements <a class="el" href="class_taml_callbacks.html">TamlCallbacks</a>.</p>
- <p>Reimplemented in <a class="el" href="class_font_asset.html#acd7861614dbad46880a829cc09d2600d">FontAsset</a>, <a class="el" href="class_image_asset.html#acd7861614dbad46880a829cc09d2600d">ImageAsset</a>, <a class="el" href="class_particle_asset.html#acd7861614dbad46880a829cc09d2600d">ParticleAsset</a>, <a class="el" href="class_particle_asset_emitter.html#acd7861614dbad46880a829cc09d2600d">ParticleAssetEmitter</a>, <a class="el" href="class_scene.html#acd7861614dbad46880a829cc09d2600d">Scene</a>, <a class="el" href="class_composite_sprite.html#acd7861614dbad46880a829cc09d2600d">CompositeSprite</a>, <a class="el" href="class_scene_object.html#acd7861614dbad46880a829cc09d2600d">SceneObject</a>, <a class="el" href="class_asset_query.html#acd7861614dbad46880a829cc09d2600d">AssetQuery</a>, <a class="el" href="class_asset_tags_manifest.html#acd7861614dbad46880a829cc09d2600d">AssetTagsManifest</a>, <a class="el" href="class_behavior_component.html#acd7861614dbad46880a829cc09d2600d">BehaviorComponent</a>, and <a class="el" href="class_gui_frame_set_ctrl.html#acd7861614dbad46880a829cc09d2600d">GuiFrameSetCtrl</a>.</p>
- </div>
- </div>
- <a id="a8d896544fb75ff4b98cac3099bf5f55f" name="a8d896544fb75ff4b98cac3099bf5f55f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8d896544fb75ff4b98cac3099bf5f55f">◆ </a></span>onTamlPostRead()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onTamlPostRead </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_taml_custom_nodes.html">TamlCustomNodes</a> & </td>
- <td class="paramname"><em>customNodes</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called after <a class="el" href="class_taml.html">Taml</a> has finished reading the object. The custom properties is additionally passed here for object who want to process it at the end of reading. </p>
- <p>Implements <a class="el" href="class_taml_callbacks.html">TamlCallbacks</a>.</p>
- <p>Reimplemented in <a class="el" href="class_scene.html#a417756b06f9406003aad2268a14d57af">Scene</a>.</p>
- </div>
- </div>
- <a id="a1baf86d5d5d9f1c2190e7bb72aacb068" name="a1baf86d5d5d9f1c2190e7bb72aacb068"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1baf86d5d5d9f1c2190e7bb72aacb068">◆ </a></span>onTamlPostWrite()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onTamlPostWrite </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called after <a class="el" href="class_taml.html">Taml</a> has finished writing the object. </p>
- <p>Implements <a class="el" href="class_taml_callbacks.html">TamlCallbacks</a>.</p>
- <p>Reimplemented in <a class="el" href="class_font_asset.html#abf220cc51918a1dd4ba65fcc26e5efb0">FontAsset</a>, <a class="el" href="class_image_asset.html#abf220cc51918a1dd4ba65fcc26e5efb0">ImageAsset</a>, and <a class="el" href="class_audio_asset.html#abf220cc51918a1dd4ba65fcc26e5efb0">AudioAsset</a>.</p>
- </div>
- </div>
- <a id="af3830391b29fe4e30779260612049995" name="af3830391b29fe4e30779260612049995"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af3830391b29fe4e30779260612049995">◆ </a></span>onTamlPreRead()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onTamlPreRead </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called prior to <a class="el" href="class_taml.html">Taml</a> reading the object. </p>
- <p>Implements <a class="el" href="class_taml_callbacks.html">TamlCallbacks</a>.</p>
- <p>Reimplemented in <a class="el" href="class_scene.html#acc91f516dddcf7ab3b3c6c5cf75f1a94">Scene</a>.</p>
- </div>
- </div>
- <a id="a3b0caf75cb0eccb9fb63406b813c431d" name="a3b0caf75cb0eccb9fb63406b813c431d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3b0caf75cb0eccb9fb63406b813c431d">◆ </a></span>onTamlPreWrite()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void onTamlPreWrite </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p><a class="el" href="class_taml.html">Taml</a> callbacks. </p>
- <p>Implements <a class="el" href="class_taml_callbacks.html">TamlCallbacks</a>.</p>
- <p>Reimplemented in <a class="el" href="class_font_asset.html#a7b374c0eb1e42ea199835df8d4ca9eb3">FontAsset</a>, <a class="el" href="class_image_asset.html#a7b374c0eb1e42ea199835df8d4ca9eb3">ImageAsset</a>, and <a class="el" href="class_audio_asset.html#a7b374c0eb1e42ea199835df8d4ca9eb3">AudioAsset</a>.</p>
- </div>
- </div>
- <a id="ab54472a52381c54f13657d6ea3cd4a1b" name="ab54472a52381c54f13657d6ea3cd4a1b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab54472a52381c54f13657d6ea3cd4a1b">◆ </a></span>popScriptCallbackGuard()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void popScriptCallbackGuard </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a62d16d76ec4b30520d9cce1f2e7fda6a" name="a62d16d76ec4b30520d9cce1f2e7fda6a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a62d16d76ec4b30520d9cce1f2e7fda6a">◆ </a></span>postEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void postEvent </td>
- <td>(</td>
- <td class="paramtype">std::string </td>
- <td class="paramname"><em>eventName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::string </td>
- <td class="paramname"><em>data</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aea22401f7205e885be6dd887a61a0797" name="aea22401f7205e885be6dd887a61a0797"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aea22401f7205e885be6dd887a61a0797">◆ </a></span>processArguments()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool processArguments </td>
- <td>(</td>
- <td class="paramtype">S32 </td>
- <td class="paramname"><em>argc</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char ** </td>
- <td class="paramname"><em>argv</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Process constructor options. (ie, new <a class="el" href="class_sim_object.html">SimObject(1,2,3)</a>) </p>
- <p>Reimplemented in <a class="el" href="class_sim_component.html#aea22401f7205e885be6dd887a61a0797">SimComponent</a>, <a class="el" href="class_console_logger.html#aea22401f7205e885be6dd887a61a0797">ConsoleLogger</a>, <a class="el" href="class_t_c_p_object.html#aea22401f7205e885be6dd887a61a0797">TCPObject</a>, <a class="el" href="class_sim_x_m_l_document.html#aea22401f7205e885be6dd887a61a0797">SimXMLDocument</a>, and <a class="el" href="class_sim_group.html#aea22401f7205e885be6dd887a61a0797">SimGroup</a>.</p>
- </div>
- </div>
- <a id="ab0bd2d18dedeb363463ad2cad045f6a3" name="ab0bd2d18dedeb363463ad2cad045f6a3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab0bd2d18dedeb363463ad2cad045f6a3">◆ </a></span>processDeleteNotifies()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void processDeleteNotifies </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Send out deletion notifications. </p>
- </div>
- </div>
- <a id="a0f1470540933ff4bd9227e116f8ec135" name="a0f1470540933ff4bd9227e116f8ec135"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0f1470540933ff4bd9227e116f8ec135">◆ </a></span>pushScriptCallbackGuard()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void pushScriptCallbackGuard </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a783fe3358bc6a3bf993ec1bfef693529" name="a783fe3358bc6a3bf993ec1bfef693529"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a783fe3358bc6a3bf993ec1bfef693529">◆ </a></span>readObject()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool readObject </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> * </td>
- <td class="paramname"><em>stream</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reimplemented in <a class="el" href="class_sim_set.html#a783fe3358bc6a3bf993ec1bfef693529">SimSet</a>.</p>
- </div>
- </div>
- <a id="a2400b9daf420c4b7f40e2fefccf819a7" name="a2400b9daf420c4b7f40e2fefccf819a7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2400b9daf420c4b7f40e2fefccf819a7">◆ </a></span>registerObject() <span class="overload">[1/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool registerObject </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Register an object with the object system.</p>
- <p>This must be called if you want to keep the object around. In the rare case that you will delete the object immediately, or don't want to be able to use <a class="el" href="namespace_sim.html#a3e94a217b10a43c58030035d7efa5ea4">Sim::findObject</a> to locate it, then you don't need to register it.</p>
- <p>registerObject adds the object to the global ID and name dictionaries, after first assigning it a new ID number. It calls <a class="el" href="class_sim_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a" title="Called when the object is added to the sim.">onAdd()</a>. If onAdd fails, it unregisters the object and returns false.</p>
- <p>If a subclass's onAdd doesn't eventually call <a class="el" href="class_sim_object.html#aa8fb2a4e72e5c4975d3cd912c5de131a" title="Called when the object is added to the sim.">SimObject::onAdd()</a>, it will cause an assertion. </p>
- </div>
- </div>
- <a id="a40957e593443f2fae6e5d84c58689e23" name="a40957e593443f2fae6e5d84c58689e23"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a40957e593443f2fae6e5d84c58689e23">◆ </a></span>registerObject() <span class="overload">[2/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool registerObject </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Register the object, assigning the name.</p>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sim_object.html#a2400b9daf420c4b7f40e2fefccf819a7">registerObject()</a> </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">name</td><td>Name to assign to the object. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="ad87febcd9c1b24a68db0656b4ac4bb5e" name="ad87febcd9c1b24a68db0656b4ac4bb5e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad87febcd9c1b24a68db0656b4ac4bb5e">◆ </a></span>registerObject() <span class="overload">[3/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool registerObject </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>id</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Register the object, assigning a name and ID.</p>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sim_object.html#a2400b9daf420c4b7f40e2fefccf819a7">registerObject()</a> </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">name</td><td>Name to assign to the object. </td></tr>
- <tr><td class="paramname">id</td><td>ID to assign to the object. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a03e5444a670c9fc42bda3a569cdcfc8b" name="a03e5444a670c9fc42bda3a569cdcfc8b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a03e5444a670c9fc42bda3a569cdcfc8b">◆ </a></span>registerObject() <span class="overload">[4/4]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool registerObject </td>
- <td>(</td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>id</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Register the object, forcing the id.</p>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sim_object.html#a2400b9daf420c4b7f40e2fefccf819a7">registerObject()</a> </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">id</td><td>ID to assign to the object. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a5de000764497f99eac15f2fe1ff8d709" name="a5de000764497f99eac15f2fe1ff8d709"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5de000764497f99eac15f2fe1ff8d709">◆ </a></span>registerReference()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void registerReference </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> ** </td>
- <td class="paramname"><em>obj</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Register a reference to this object.</p>
- <p>You pass a pointer to your reference to this object.</p>
- <p>When the object is deleted, it will null your pointer, ensuring you don't access old memory.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">obj</td><td>Pointer to your reference to the object. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a87be48ec4599c3d02a118cee89e47f55" name="a87be48ec4599c3d02a118cee89e47f55"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a87be48ec4599c3d02a118cee89e47f55">◆ </a></span>removeAllListeners()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void removeAllListeners </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a800867188378386931156e3329846b71" name="a800867188378386931156e3329846b71"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a800867188378386931156e3329846b71">◆ </a></span>removeFieldFilter()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void removeFieldFilter </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>fieldName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ae15bec249a7c1003e0ebb253ba7ca4df" name="ae15bec249a7c1003e0ebb253ba7ca4df"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae15bec249a7c1003e0ebb253ba7ca4df">◆ </a></span>removeFromSet() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool removeFromSet </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>objectName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8fb724887b442070d3f78e5ffdf529fc" name="a8fb724887b442070d3f78e5ffdf529fc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8fb724887b442070d3f78e5ffdf529fc">◆ </a></span>removeFromSet() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool removeFromSet </td>
- <td>(</td>
- <td class="paramtype">SimObjectId </td>
- <td class="paramname"><em>sid</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a5f8f817f59dc708ccbec810392842a5b" name="a5f8f817f59dc708ccbec810392842a5b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5f8f817f59dc708ccbec810392842a5b">◆ </a></span>removeListener()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void removeListener </td>
- <td>(</td>
- <td class="paramtype">std::string </td>
- <td class="paramname"><em>objID</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac894e7acfdf29d01464a20d670e1208a" name="ac894e7acfdf29d01464a20d670e1208a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac894e7acfdf29d01464a20d670e1208a">◆ </a></span>removeNotify()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="struct_sim_object_1_1_notify.html">SimObject::Notify</a> * removeNotify </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>ptr</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="struct_sim_object_1_1_notify.html#a1d1cfd8ffb84e947f82999c682b666a7">Notify::Type</a> </td>
- <td class="paramname"><em>type</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove a notification from the list. </p>
- </div>
- </div>
- <a id="a86f7c64cb6f7eba36f8a6e391e29492f" name="a86f7c64cb6f7eba36f8a6e391e29492f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a86f7c64cb6f7eba36f8a6e391e29492f">◆ </a></span>save()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool save </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>pcFilePath</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>bOnlySelected</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Save object as a TorqueScript <a class="el" href="class_file.html">File</a>. </p>
- </div>
- </div>
- <a id="aafe55ac523c402717ec8625b67fa1561" name="aafe55ac523c402717ec8625b67fa1561"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aafe55ac523c402717ec8625b67fa1561">◆ </a></span>setCanSaveDynamicFields()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setCanSaveDynamicFields </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>bCanSave</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set whether fields created at runtime should be saved. Default is true. </p>
- </div>
- </div>
- <a id="a238c87f71783e3654af75d5ca4a84ae8" name="a238c87f71783e3654af75d5ca4a84ae8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a238c87f71783e3654af75d5ca4a84ae8">◆ </a></span>setClass()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool setClass </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8e60d73cee05c995ed9bec7ee248cad3" name="a8e60d73cee05c995ed9bec7ee248cad3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8e60d73cee05c995ed9bec7ee248cad3">◆ </a></span>setClassNamespace()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setClassNamespace </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>classNamespace</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a13add87ef90b3882bd7eaff39004eb35" name="a13add87ef90b3882bd7eaff39004eb35"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a13add87ef90b3882bd7eaff39004eb35">◆ </a></span>setDataField()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setDataField </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>slotName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>array</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set the value of a field on the object.</p>
- <p>See <a class="el" href="class_sim_object.html#simobject_console">here</a> for a detailed discussion of what this function does.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">slotName</td><td>Field to access. </td></tr>
- <tr><td class="paramname">array</td><td>String containing index into array; if NULL, it is ignored. </td></tr>
- <tr><td class="paramname">value</td><td>Value to store. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Reimplemented in <a class="el" href="class_gui_control.html#a13add87ef90b3882bd7eaff39004eb35">GuiControl</a>.</p>
- </div>
- </div>
- <a id="af83d1fe99918d6650c71c6302a5839ae" name="af83d1fe99918d6650c71c6302a5839ae"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af83d1fe99918d6650c71c6302a5839ae">◆ </a></span>setExpanded()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setExpanded </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>exp</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a85f8b66f6d9e9acf89ae056554f82776" name="a85f8b66f6d9e9acf89ae056554f82776"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a85f8b66f6d9e9acf89ae056554f82776">◆ </a></span>setHidden()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setHidden </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>b</em> = <code>true</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa19ca64ec6199448db9552e13387a246" name="aa19ca64ec6199448db9552e13387a246"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa19ca64ec6199448db9552e13387a246">◆ </a></span>setId()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setId </td>
- <td>(</td>
- <td class="paramtype">SimObjectId </td>
- <td class="paramname"><em>id</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ad551e97d8f825c04f4cced55f8db3a64" name="ad551e97d8f825c04f4cced55f8db3a64"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad551e97d8f825c04f4cced55f8db3a64">◆ </a></span>setInternalName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setInternalName </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>newname</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>These functions support internal naming that is not namespace bound for locating child controls in a generic way.</p>
- <p>Set the internal name of this control (Not linked to a namespace) </p>
- </div>
- </div>
- <a id="a0d0eb38693dcaae147b7a890fae82934" name="a0d0eb38693dcaae147b7a890fae82934"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0d0eb38693dcaae147b7a890fae82934">◆ </a></span>setLocked()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setLocked </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>b</em> = <code>true</code></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ab80c81429637a9f3a44aa55e7533cd2c" name="ab80c81429637a9f3a44aa55e7533cd2c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab80c81429637a9f3a44aa55e7533cd2c">◆ </a></span>setModDynamicFields()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setModDynamicFields </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>dyn</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a00201e9d1946024a8060f586e03f5a74" name="a00201e9d1946024a8060f586e03f5a74"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a00201e9d1946024a8060f586e03f5a74">◆ </a></span>setModStaticFields()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setModStaticFields </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>sta</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a1f5140e6ccbc12845db7038be8c8c2e1" name="a1f5140e6ccbc12845db7038be8c8c2e1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1f5140e6ccbc12845db7038be8c8c2e1">◆ </a></span>setParentGroup()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool setParentGroup </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a6cb2bfe07966c75d9360afe422749d36" name="a6cb2bfe07966c75d9360afe422749d36"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6cb2bfe07966c75d9360afe422749d36">◆ </a></span>setPeriodicTimerID()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setPeriodicTimerID </td>
- <td>(</td>
- <td class="paramtype">const S32 </td>
- <td class="paramname"><em>timerID</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8b55bbf2e919e4c167264aee7fb1c1b7" name="a8b55bbf2e919e4c167264aee7fb1c1b7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8b55bbf2e919e4c167264aee7fb1c1b7">◆ </a></span>setPrefixedDataField()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setPrefixedDataField </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>fieldName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>array</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a6befae44e0c81ad846242e8d8eddb149" name="a6befae44e0c81ad846242e8d8eddb149"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6befae44e0c81ad846242e8d8eddb149">◆ </a></span>setPrefixedDynamicDataField()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setPrefixedDynamicDataField </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>fieldName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>array</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>value</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const S32 </td>
- <td class="paramname"><em>fieldType</em> = <code>-1</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac8fc39880dcb3be2d5658b57e9fed264" name="ac8fc39880dcb3be2d5658b57e9fed264"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac8fc39880dcb3be2d5658b57e9fed264">◆ </a></span>setProgenitorFile()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setProgenitorFile </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>pFile</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a359e31abae34476f5e76b43114058166" name="a359e31abae34476f5e76b43114058166"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a359e31abae34476f5e76b43114058166">◆ </a></span>setProtectedName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool setProtectedName </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a40c19418aede1f21ea7aeadc87342dee" name="a40c19418aede1f21ea7aeadc87342dee"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a40c19418aede1f21ea7aeadc87342dee">◆ </a></span>setSelected()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setSelected </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>sel</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a43001ba1a3e2861eb120a04cf0796588" name="a43001ba1a3e2861eb120a04cf0796588"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a43001ba1a3e2861eb120a04cf0796588">◆ </a></span>setSuperClass()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool setSuperClass </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="abeb83ab949786a5de00558e024c2efd5" name="abeb83ab949786a5de00558e024c2efd5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abeb83ab949786a5de00558e024c2efd5">◆ </a></span>setSuperClassNamespace()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setSuperClassNamespace </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>superClassNamespace</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="acd454ef0ad63af6686f09aad336f290f" name="acd454ef0ad63af6686f09aad336f290f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acd454ef0ad63af6686f09aad336f290f">◆ </a></span>tabComplete()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const char * tabComplete </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>prevText</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">S32 </td>
- <td class="paramname"><em>baseLen</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>fForward</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get next matching item in namespace.</p>
- <p>This wraps a call to <a class="el" href="class_namespace.html#a25f0d038677f834a5dcd5f2561a7b5b2">Namespace::tabComplete</a>; it gets the next thing in the namespace, given a starting value and a base length of the string. See <a class="el" href="class_namespace.html#a25f0d038677f834a5dcd5f2561a7b5b2">Namespace::tabComplete</a> for details. </p>
- </div>
- </div>
- <a id="a97551603378a0bbc3d3d98326a56631e" name="a97551603378a0bbc3d3d98326a56631e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a97551603378a0bbc3d3d98326a56631e">◆ </a></span>unlinkNamespaces()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void unlinkNamespaces </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a5d4a04eec15214f98292fa4d2bcb6c58" name="a5d4a04eec15214f98292fa4d2bcb6c58"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5d4a04eec15214f98292fa4d2bcb6c58">◆ </a></span>unregisterObject()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void unregisterObject </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Unregister the object from <a class="el" href="namespace_sim.html">Sim</a>.</p>
- <p>This performs several operations:</p><ul>
- <li>Sets the removed flag.</li>
- <li>Call <a class="el" href="class_sim_object.html#a28fb2b0653c2c31284ebef9237dc9c5c" title="Called when the object is removed from the sim.">onRemove()</a></li>
- <li>Clear out notifications.</li>
- <li>Remove the object from...<ul>
- <li>its group, if any. (via getGroup)</li>
- <li><a class="el" href="namespace_sim.html#a3d11b952cee9221b40855c54f96c425c">Sim::gNameDictionary</a></li>
- <li>Sim::gIDDictionary</li>
- </ul>
- </li>
- <li>Finally, cancel any pending events for this object (as it can't receive them now). </li>
- </ul>
- </div>
- </div>
- <a id="a9ab2d546d0ed6b4abc8dcf9e373d8bcb" name="a9ab2d546d0ed6b4abc8dcf9e373d8bcb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9ab2d546d0ed6b4abc8dcf9e373d8bcb">◆ </a></span>unregisterReference()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void unregisterReference </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> ** </td>
- <td class="paramname"><em>obj</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Unregister a reference to this object.</p>
- <p>Remove a reference from the list, so that it won't get nulled inappropriately.</p>
- <p>Call this when you're done with your reference to the object, especially if you're going to free the memory. Otherwise, you may erroneously get something overwritten.</p>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_sim_object.html#a5de000764497f99eac15f2fe1ff8d709">registerReference</a> </dd></dl>
- </div>
- </div>
- <a id="add2aa52391620bbfb9f8c29eb1f921cd" name="add2aa52391620bbfb9f8c29eb1f921cd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#add2aa52391620bbfb9f8c29eb1f921cd">◆ </a></span>write()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void write </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> & </td>
- <td class="paramname"><em>stream</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>tabStop</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>flags</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Output the TorqueScript to recreate this object.</p>
- <p>This calls writeFields internally. </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">stream</td><td><a class="el" href="class_stream.html" title="Base stream class for streaming data across a specific media.">Stream</a> to output to. </td></tr>
- <tr><td class="paramname">tabStop</td><td>Indentation level for this object. </td></tr>
- <tr><td class="paramname">flags</td><td>If SelectedOnly is passed here, then only objects marked as selected (using setSelected) will output themselves. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Reimplemented in <a class="el" href="class_gui_control.html#a68a384f752ce523f5285881a144ec121">GuiControl</a>, <a class="el" href="class_name_tags.html#add2aa52391620bbfb9f8c29eb1f921cd">NameTags</a>, <a class="el" href="class_behavior_component.html#add2aa52391620bbfb9f8c29eb1f921cd">BehaviorComponent</a>, <a class="el" href="class_sim_component.html#add2aa52391620bbfb9f8c29eb1f921cd">SimComponent</a>, and <a class="el" href="class_sim_set.html#add2aa52391620bbfb9f8c29eb1f921cd">SimSet</a>.</p>
- </div>
- </div>
- <a id="aa7652122ac6a5cf7337b0e7a7b3825e5" name="aa7652122ac6a5cf7337b0e7a7b3825e5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa7652122ac6a5cf7337b0e7a7b3825e5">◆ </a></span>writeCanSaveDynamicFields()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool writeCanSaveDynamicFields </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>pFieldName</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a3753e8d47c78c8b6c39f5a1df2586d45" name="a3753e8d47c78c8b6c39f5a1df2586d45"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3753e8d47c78c8b6c39f5a1df2586d45">◆ </a></span>writeClass()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool writeClass </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>pFieldName</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8b9f425bde559d3f1b3146fd3c1ceba2" name="a8b9f425bde559d3f1b3146fd3c1ceba2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8b9f425bde559d3f1b3146fd3c1ceba2">◆ </a></span>writeField()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool writeField </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>fieldname</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>value</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Determine whether or not a field should be written.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fieldname</td><td>The name of the field being written. </td></tr>
- <tr><td class="paramname">value</td><td>The value of the field. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Reimplemented in <a class="el" href="class_scene_object.html#a8b9f425bde559d3f1b3146fd3c1ceba2">SceneObject</a>, and <a class="el" href="class_sim_component.html#a8b9f425bde559d3f1b3146fd3c1ceba2">SimComponent</a>.</p>
- </div>
- </div>
- <a id="a200de464a60a45ee5904de160e677b5f" name="a200de464a60a45ee5904de160e677b5f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a200de464a60a45ee5904de160e677b5f">◆ </a></span>writeFields()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void writeFields </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> & </td>
- <td class="paramname"><em>stream</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>tabStop</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Write the fields of this object in TorqueScript.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">stream</td><td><a class="el" href="class_stream.html" title="Base stream class for streaming data across a specific media.">Stream</a> for output. </td></tr>
- <tr><td class="paramname">tabStop</td><td>Indentation level for the fields. </td></tr>
- </table>
- </dd>
- </dl>
- <p>Reimplemented in <a class="el" href="class_name_tags.html#a200de464a60a45ee5904de160e677b5f">NameTags</a>, and <a class="el" href="class_gui_frame_set_ctrl.html#a200de464a60a45ee5904de160e677b5f">GuiFrameSetCtrl</a>.</p>
- </div>
- </div>
- <a id="a57d090bc62bb37dd4a36dab7d5538ad4" name="a57d090bc62bb37dd4a36dab7d5538ad4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a57d090bc62bb37dd4a36dab7d5538ad4">◆ </a></span>writeInternalName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool writeInternalName </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>pFieldName</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aebb68b5bbb2a5feb7bbf710834c6888b" name="aebb68b5bbb2a5feb7bbf710834c6888b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aebb68b5bbb2a5feb7bbf710834c6888b">◆ </a></span>writeObject()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool writeObject </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> * </td>
- <td class="paramname"><em>stream</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reimplemented in <a class="el" href="class_sim_set.html#aebb68b5bbb2a5feb7bbf710834c6888b">SimSet</a>.</p>
- </div>
- </div>
- <a id="a050c10f238d99841ebaf065d96054342" name="a050c10f238d99841ebaf065d96054342"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a050c10f238d99841ebaf065d96054342">◆ </a></span>writeObjectName()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool writeObjectName </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>pFieldName</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ad11229fc0e726de20183e61c4e963904" name="ad11229fc0e726de20183e61c4e963904"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad11229fc0e726de20183e61c4e963904">◆ </a></span>writeParentGroup()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool writeParentGroup </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>pFieldName</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a1a0d756e0d41114cfb264c5a0a38399b" name="a1a0d756e0d41114cfb264c5a0a38399b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1a0d756e0d41114cfb264c5a0a38399b">◆ </a></span>writeSuperclass()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool writeSuperclass </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>obj</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>pFieldName</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Symbol Documentation</h2>
- <a id="a68bd73954c8c1df1c3919a72ed1ee68e" name="a68bd73954c8c1df1c3919a72ed1ee68e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a68bd73954c8c1df1c3919a72ed1ee68e">◆ </a></span>SimGroup</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class <a class="el" href="class_sim_group.html">SimGroup</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4303dad0bd3c617f3c5087090aa2e07c" name="a4303dad0bd3c617f3c5087090aa2e07c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4303dad0bd3c617f3c5087090aa2e07c">◆ </a></span>SimIdDictionary</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class <a class="el" href="class_sim_id_dictionary.html">SimIdDictionary</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a197bc9fab2f8558c52fb7a57ef526dca" name="a197bc9fab2f8558c52fb7a57ef526dca"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a197bc9fab2f8558c52fb7a57ef526dca">◆ </a></span>SimManager</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class SimManager</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8a37b2a278f0f8beff3adf5dc4b970d4" name="a8a37b2a278f0f8beff3adf5dc4b970d4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8a37b2a278f0f8beff3adf5dc4b970d4">◆ </a></span>SimManagerNameDictionary</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class <a class="el" href="class_sim_manager_name_dictionary.html">SimManagerNameDictionary</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a23a2aca26949fc86b646bdf61c4e203d" name="a23a2aca26949fc86b646bdf61c4e203d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a23a2aca26949fc86b646bdf61c4e203d">◆ </a></span>SimNameDictionary</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class <a class="el" href="class_sim_name_dictionary.html">SimNameDictionary</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="a5d6df47d150d38ec4999f9bd9ac68fa5" name="a5d6df47d150d38ec4999f9bd9ac68fa5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5d6df47d150d38ec4999f9bd9ac68fa5">◆ </a></span>disableNameChanging</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool disableNameChanging = false</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the value of a field on the object.</p>
- <p>See <a class="el" href="class_sim_object.html#simobject_console">here</a> for a detailed discussion of what this function does.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">slotName</td><td>Field to access. </td></tr>
- <tr><td class="paramname">array</td><td>String containing index into array (if field is an array); if NULL, it is ignored. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a9d58648eb55132316b07f0bfdf1f5f79" name="a9d58648eb55132316b07f0bfdf1f5f79"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9d58648eb55132316b07f0bfdf1f5f79">◆ </a></span>mCanSaveFieldDictionary</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool mCanSaveFieldDictionary</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>true if dynamic fields (added at runtime) should be saved, defaults to true </p>
- </div>
- </div>
- <a id="afcdd8b2e39eb6cab2310ec01fc23dfc8" name="afcdd8b2e39eb6cab2310ec01fc23dfc8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afcdd8b2e39eb6cab2310ec01fc23dfc8">◆ </a></span>mClassName</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry mClassName</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Stores the class name to link script class namespaces. </p>
- </div>
- </div>
- <a id="a084af54739c09b7f36838bd505d3f683" name="a084af54739c09b7f36838bd505d3f683"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a084af54739c09b7f36838bd505d3f683">◆ </a></span>mId</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">SimObjectId mId</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Id number for this object. </p>
- </div>
- </div>
- <a id="a1bc0c634cbd6eae42ba8e678123b3e12" name="a1bc0c634cbd6eae42ba8e678123b3e12"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1bc0c634cbd6eae42ba8e678123b3e12">◆ </a></span>mIdString</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry mIdString</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ae25d89dbd7309a4fe60e221d19e3beb4" name="ae25d89dbd7309a4fe60e221d19e3beb4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae25d89dbd7309a4fe60e221d19e3beb4">◆ </a></span>mInternalName</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry mInternalName</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Stores object Internal Name. </p>
- </div>
- </div>
- <a id="afa8dcd83f1b3cc756738fd08d91b699b" name="afa8dcd83f1b3cc756738fd08d91b699b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afa8dcd83f1b3cc756738fd08d91b699b">◆ </a></span>mNameSpace</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_namespace.html">Namespace</a>* mNameSpace</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a8f583d26e810008b4532327b7bbae397" name="a8f583d26e810008b4532327b7bbae397"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a8f583d26e810008b4532327b7bbae397">◆ </a></span>mNotifyFreeList</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="struct_sim_object_1_1_notify.html">SimObject::Notify</a> * mNotifyFreeList = NULL</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="afb0ea09846fa6e5ceac432439a252709" name="afb0ea09846fa6e5ceac432439a252709"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afb0ea09846fa6e5ceac432439a252709">◆ </a></span>mScriptCallbackGuard</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">S32 mScriptCallbackGuard</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Whether the object is executing a script callback. </p>
- </div>
- </div>
- <a id="a2866b6130ce096fe6563e71995d35f0f" name="a2866b6130ce096fe6563e71995d35f0f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2866b6130ce096fe6563e71995d35f0f">◆ </a></span>mSuperClassName</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">StringTableEntry mSuperClassName</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Stores super class name to link script class namespaces. </p>
- </div>
- </div>
- <a id="a7e0203ca282d77263fdee9a9c8d0631f" name="a7e0203ca282d77263fdee9a9c8d0631f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7e0203ca282d77263fdee9a9c8d0631f">◆ </a></span>mTypeMask</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">U32 mTypeMask</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>sim/<b>simObject.h</b></li>
- <li>sim/<b>simObject.cc</b></li>
- <li>sim/<b>simSerialize.cpp</b></li>
- <li>sim/<b>simSet.cc</b></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|