| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215 |
- <!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: GameInterface 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="#pub-methods">Public Member Functions</a> |
- <a href="class_game_interface-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">GameInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <gameInterface.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 GameInterface:</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_game_interface.png" usemap="#GameInterface_map" alt=""/>
- <map id="GameInterface_map" name="GameInterface_map">
- <area href="class_default_game.html" alt="DefaultGame" shape="rect" coords="0,56,94,80"/>
- </map>
- </div></div>
- <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:a5dae33400e4a41a68de5dda622957cbc" id="r_a5dae33400e4a41a68de5dda622957cbc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a5dae33400e4a41a68de5dda622957cbc">GameInterface</a> ()</td></tr>
- <tr class="separator:a5dae33400e4a41a68de5dda622957cbc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a888acc31806054076bbb82d3a7520e61" id="r_a888acc31806054076bbb82d3a7520e61"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a888acc31806054076bbb82d3a7520e61">gameDeactivate</a> (const bool noRender)=0</td></tr>
- <tr class="separator:a888acc31806054076bbb82d3a7520e61"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acc6f7ab9f3aa79223e4cde77bc324fc7" id="r_acc6f7ab9f3aa79223e4cde77bc324fc7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#acc6f7ab9f3aa79223e4cde77bc324fc7">gameReactivate</a> (void)=0</td></tr>
- <tr class="separator:acc6f7ab9f3aa79223e4cde77bc324fc7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Game Loop</div></td></tr>
- <tr class="memitem:a5ba630471faace5d375ec97929abf91f" id="r_a5ba630471faace5d375ec97929abf91f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a5ba630471faace5d375ec97929abf91f">mainInitialize</a> (int argc, const char **argv)=0</td></tr>
- <tr class="separator:a5ba630471faace5d375ec97929abf91f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac0318fde7694326dbaa6efc7603b7e9b" id="r_ac0318fde7694326dbaa6efc7603b7e9b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#ac0318fde7694326dbaa6efc7603b7e9b">mainLoop</a> (void)=0</td></tr>
- <tr class="separator:ac0318fde7694326dbaa6efc7603b7e9b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab4f05281a713f0a778b9d9507105cb05" id="r_ab4f05281a713f0a778b9d9507105cb05"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#ab4f05281a713f0a778b9d9507105cb05">mainShutdown</a> (void)=0</td></tr>
- <tr class="separator:ab4f05281a713f0a778b9d9507105cb05"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Platform Interface</div></td></tr>
- <tr><td colspan="2"><div class="groupText"><p>The platform calls these functions to control execution of the game. </p>
- </div></td></tr>
- <tr class="memitem:a51630e0a6734c0e65762da2aacf54b65" id="r_a51630e0a6734c0e65762da2aacf54b65"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a51630e0a6734c0e65762da2aacf54b65">textureKill</a> (void)=0</td></tr>
- <tr class="separator:a51630e0a6734c0e65762da2aacf54b65"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a98d778dfe06e13d5718cbfe11d608f6b" id="r_a98d778dfe06e13d5718cbfe11d608f6b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a98d778dfe06e13d5718cbfe11d608f6b">textureResurrect</a> (void)=0</td></tr>
- <tr class="separator:a98d778dfe06e13d5718cbfe11d608f6b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aee356ade317d4fa3bb03249b2924413c" id="r_aee356ade317d4fa3bb03249b2924413c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#aee356ade317d4fa3bb03249b2924413c">refreshWindow</a> (void)=0</td></tr>
- <tr class="separator:aee356ade317d4fa3bb03249b2924413c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a52dbaef796e5d5e049995eb631989a8a" id="r_a52dbaef796e5d5e049995eb631989a8a"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a52dbaef796e5d5e049995eb631989a8a">postEvent</a> (<a class="el" href="struct_event.html">Event</a> &event)</td></tr>
- <tr class="memdesc:a52dbaef796e5d5e049995eb631989a8a"><td class="mdescLeft"> </td><td class="mdescRight">Place an event in Game's event queue. <br /></td></tr>
- <tr class="separator:a52dbaef796e5d5e049995eb631989a8a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad5473b44af17c41807bd98b6d1da298b" id="r_ad5473b44af17c41807bd98b6d1da298b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#ad5473b44af17c41807bd98b6d1da298b">processEvents</a> ()</td></tr>
- <tr class="memdesc:ad5473b44af17c41807bd98b6d1da298b"><td class="mdescLeft"> </td><td class="mdescRight">Process all the events in Game's event queue. Only the main thread should call this. <br /></td></tr>
- <tr class="separator:ad5473b44af17c41807bd98b6d1da298b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Event Handlers</div></td></tr>
- <tr><td colspan="2"><div class="groupText"><p>default event behavior with journaling support default handler forwards events to appropriate routines </p>
- </div></td></tr>
- <tr class="memitem:a29d06d47932bed594e92a0e935d69857" id="r_a29d06d47932bed594e92a0e935d69857"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a29d06d47932bed594e92a0e935d69857">processEvent</a> (<a class="el" href="struct_event.html">Event</a> *event)</td></tr>
- <tr class="separator:a29d06d47932bed594e92a0e935d69857"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a779d3dcf22b84ca46d3d2f4807c5592e" id="r_a779d3dcf22b84ca46d3d2f4807c5592e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a779d3dcf22b84ca46d3d2f4807c5592e">processQuitEvent</a> ()=0</td></tr>
- <tr class="separator:a779d3dcf22b84ca46d3d2f4807c5592e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab304a3d6579c3a1b0b99fb2562fcf8e6" id="r_ab304a3d6579c3a1b0b99fb2562fcf8e6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#ab304a3d6579c3a1b0b99fb2562fcf8e6">processTimeEvent</a> (<a class="el" href="struct_time_event.html">TimeEvent</a> *event)=0</td></tr>
- <tr class="separator:ab304a3d6579c3a1b0b99fb2562fcf8e6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a31ae403f71ef74f07321bc0b098d1b7d" id="r_a31ae403f71ef74f07321bc0b098d1b7d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a31ae403f71ef74f07321bc0b098d1b7d">processInputEvent</a> (<a class="el" href="struct_input_event.html">InputEvent</a> *event)=0</td></tr>
- <tr class="separator:a31ae403f71ef74f07321bc0b098d1b7d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abe67b471a3dd5470fd038a4b2724dfe9" id="r_abe67b471a3dd5470fd038a4b2724dfe9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#abe67b471a3dd5470fd038a4b2724dfe9">processMouseMoveEvent</a> (<a class="el" href="struct_mouse_move_event.html">MouseMoveEvent</a> *event)=0</td></tr>
- <tr class="separator:abe67b471a3dd5470fd038a4b2724dfe9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af86ab9e168dd5460a425b4c3532a130e" id="r_af86ab9e168dd5460a425b4c3532a130e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#af86ab9e168dd5460a425b4c3532a130e">processScreenTouchEvent</a> (<a class="el" href="struct_screen_touch_event.html">ScreenTouchEvent</a> *event)=0</td></tr>
- <tr class="separator:af86ab9e168dd5460a425b4c3532a130e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae8d0046a3d63a0e615889a38b8b33ed9" id="r_ae8d0046a3d63a0e615889a38b8b33ed9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#ae8d0046a3d63a0e615889a38b8b33ed9">processConsoleEvent</a> (<a class="el" href="struct_console_event.html">ConsoleEvent</a> *event)=0</td></tr>
- <tr class="separator:ae8d0046a3d63a0e615889a38b8b33ed9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a703725f526d2ada035851e26c5810acc" id="r_a703725f526d2ada035851e26c5810acc"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a703725f526d2ada035851e26c5810acc">processPacketReceiveEvent</a> (<a class="el" href="struct_packet_receive_event.html">PacketReceiveEvent</a> *event)=0</td></tr>
- <tr class="separator:a703725f526d2ada035851e26c5810acc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af7de28c08ef1117cafcd137ae94779d6" id="r_af7de28c08ef1117cafcd137ae94779d6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#af7de28c08ef1117cafcd137ae94779d6">processConnectedAcceptEvent</a> (<a class="el" href="struct_connected_accept_event.html">ConnectedAcceptEvent</a> *event)=0</td></tr>
- <tr class="separator:af7de28c08ef1117cafcd137ae94779d6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3eb8ea5a6909736a03a702ad96ba4c00" id="r_a3eb8ea5a6909736a03a702ad96ba4c00"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a3eb8ea5a6909736a03a702ad96ba4c00">processConnectedReceiveEvent</a> (<a class="el" href="struct_connected_receive_event.html">ConnectedReceiveEvent</a> *event)=0</td></tr>
- <tr class="separator:a3eb8ea5a6909736a03a702ad96ba4c00"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac536e64122d815c97cda3ab9023f70ba" id="r_ac536e64122d815c97cda3ab9023f70ba"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#ac536e64122d815c97cda3ab9023f70ba">processConnectedNotifyEvent</a> (<a class="el" href="struct_connected_notify_event.html">ConnectedNotifyEvent</a> *event)=0</td></tr>
- <tr class="separator:ac536e64122d815c97cda3ab9023f70ba"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Running</div></td></tr>
- <tr class="memitem:affa464a1d259b8fdb964058925b1b69b" id="r_affa464a1d259b8fdb964058925b1b69b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#affa464a1d259b8fdb964058925b1b69b">setRunning</a> (const bool running)</td></tr>
- <tr class="separator:affa464a1d259b8fdb964058925b1b69b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7d914bd4eddb3cf57ad8d024c376c2c4" id="r_a7d914bd4eddb3cf57ad8d024c376c2c4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a7d914bd4eddb3cf57ad8d024c376c2c4">isRunning</a> (void) const</td></tr>
- <tr class="separator:a7d914bd4eddb3cf57ad8d024c376c2c4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3ed3c2d0b972bab60891d82efacbc9e2" id="r_a3ed3c2d0b972bab60891d82efacbc9e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a3ed3c2d0b972bab60891d82efacbc9e2">setRestart</a> (const bool restart)</td></tr>
- <tr class="separator:a3ed3c2d0b972bab60891d82efacbc9e2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aafeed11da1cedbbec921b45aa970dfa6" id="r_aafeed11da1cedbbec921b45aa970dfa6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#aafeed11da1cedbbec921b45aa970dfa6">requiresRestart</a> (void) const</td></tr>
- <tr class="separator:aafeed11da1cedbbec921b45aa970dfa6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr><td colspan="2"><div class="groupHeader">Journaling</div></td></tr>
- <tr><td colspan="2"><div class="groupText"><p>Journaling is used in order to make a "demo" of the actual game. It logs all processes that happen throughout code execution (NOT script). This is very handy for debugging. Say an end user finds a crash in the program. The user can start up the engine with journal recording enabled, reproduce the crash, then send in the journal file to the development team. The development team can then play back the journal file and see exactly what happened to cause the crash. This will result in the ability to run the program through the debugger to easily track what went wrong and easily create a stack trace.</p>
- <p>Actually enabling journaling may be different in different distributions if the developers decided to change how it works. However, by default, run the program with the "-jSave filename" command argument. The filename does not need an extension, and only requires write access. If the file does not exist, it will be created. In order to play back a journal, use the "-jPlay filename" command argument, and just watch the magic happen. Examples: </p><div class="fragment"><div class="line">torqueDemo_DEBUG.exe -jSave crash</div>
- <div class="line">torqueDemo_DEBUG.exe -jPlay crash</div>
- </div><!-- fragment --> </div></td></tr>
- <tr class="memitem:aabfbd9eb3ce8835855b37b59c6759cfa" id="r_aabfbd9eb3ce8835855b37b59c6759cfa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#aabfbd9eb3ce8835855b37b59c6759cfa">journalProcess</a> ()</td></tr>
- <tr class="separator:aabfbd9eb3ce8835855b37b59c6759cfa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a11816f2d65c8d9a3a735733ff4dca4b5" id="r_a11816f2d65c8d9a3a735733ff4dca4b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a11816f2d65c8d9a3a735733ff4dca4b5">loadJournal</a> (const char *fileName)</td></tr>
- <tr class="memdesc:a11816f2d65c8d9a3a735733ff4dca4b5"><td class="mdescLeft"> </td><td class="mdescRight">Start loading journal data from the specified file. <br /></td></tr>
- <tr class="separator:a11816f2d65c8d9a3a735733ff4dca4b5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad4c2914d27277e6f13dbd5296fefdc0f" id="r_ad4c2914d27277e6f13dbd5296fefdc0f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#ad4c2914d27277e6f13dbd5296fefdc0f">saveJournal</a> (const char *fileName)</td></tr>
- <tr class="memdesc:ad4c2914d27277e6f13dbd5296fefdc0f"><td class="mdescLeft"> </td><td class="mdescRight">Start saving journal data to the specified file (must be able to write it). <br /></td></tr>
- <tr class="separator:ad4c2914d27277e6f13dbd5296fefdc0f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abf0a6493502f62311a6eae4047355311" id="r_abf0a6493502f62311a6eae4047355311"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#abf0a6493502f62311a6eae4047355311">playJournal</a> (const char *fileName, bool journalBreak=false)</td></tr>
- <tr class="separator:abf0a6493502f62311a6eae4047355311"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6434ff125839fe34b9423fb434759266" id="r_a6434ff125839fe34b9423fb434759266"><td class="memItemLeft" align="right" valign="top">JournalMode </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a6434ff125839fe34b9423fb434759266">getJournalMode</a> ()</td></tr>
- <tr class="separator:a6434ff125839fe34b9423fb434759266"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acbe62eff84ed9304b3cd6dae96531010" id="r_acbe62eff84ed9304b3cd6dae96531010"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#acbe62eff84ed9304b3cd6dae96531010">isJournalReading</a> (void) const</td></tr>
- <tr class="memdesc:acbe62eff84ed9304b3cd6dae96531010"><td class="mdescLeft"> </td><td class="mdescRight">Are we reading back from the journal? <br /></td></tr>
- <tr class="separator:acbe62eff84ed9304b3cd6dae96531010"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a46629c4b566b2692bea90abf5d4cbb1a" id="r_a46629c4b566b2692bea90abf5d4cbb1a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a46629c4b566b2692bea90abf5d4cbb1a">isJournalWriting</a> (void) const</td></tr>
- <tr class="memdesc:a46629c4b566b2692bea90abf5d4cbb1a"><td class="mdescLeft"> </td><td class="mdescRight">Are we writing to the journal? <br /></td></tr>
- <tr class="separator:a46629c4b566b2692bea90abf5d4cbb1a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1765ef15a840036cff90d59ddff68ea6" id="r_a1765ef15a840036cff90d59ddff68ea6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a1765ef15a840036cff90d59ddff68ea6">journalRead</a> (U32 *val)</td></tr>
- <tr class="memdesc:a1765ef15a840036cff90d59ddff68ea6"><td class="mdescLeft"> </td><td class="mdescRight">Read a U32 from the journal. <br /></td></tr>
- <tr class="separator:a1765ef15a840036cff90d59ddff68ea6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a35634a03800817eba8ba77d8fc13a2c0" id="r_a35634a03800817eba8ba77d8fc13a2c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a35634a03800817eba8ba77d8fc13a2c0">journalWrite</a> (U32 val)</td></tr>
- <tr class="memdesc:a35634a03800817eba8ba77d8fc13a2c0"><td class="mdescLeft"> </td><td class="mdescRight">Write a U32 to the journal. <br /></td></tr>
- <tr class="separator:a35634a03800817eba8ba77d8fc13a2c0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9bc11913418c04e26f8a67c3a106c7dc" id="r_a9bc11913418c04e26f8a67c3a106c7dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a9bc11913418c04e26f8a67c3a106c7dc">journalRead</a> (U32 size, void *buffer)</td></tr>
- <tr class="memdesc:a9bc11913418c04e26f8a67c3a106c7dc"><td class="mdescLeft"> </td><td class="mdescRight">Read a block of data from the journal. <br /></td></tr>
- <tr class="separator:a9bc11913418c04e26f8a67c3a106c7dc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a254e56d2e1ddab486a54e6d460d1ffc4" id="r_a254e56d2e1ddab486a54e6d460d1ffc4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a254e56d2e1ddab486a54e6d460d1ffc4">journalWrite</a> (U32 size, const void *buffer)</td></tr>
- <tr class="memdesc:a254e56d2e1ddab486a54e6d460d1ffc4"><td class="mdescLeft"> </td><td class="mdescRight">Write a block of data to the journal. <br /></td></tr>
- <tr class="separator:a254e56d2e1ddab486a54e6d460d1ffc4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a13b3161700c069b06ed26037f3134b3c" id="r_a13b3161700c069b06ed26037f3134b3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file_stream.html">FileStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_game_interface.html#a13b3161700c069b06ed26037f3134b3c">getJournalStream</a> (void)</td></tr>
- <tr class="separator:a13b3161700c069b06ed26037f3134b3c"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a5dae33400e4a41a68de5dda622957cbc" name="a5dae33400e4a41a68de5dda622957cbc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5dae33400e4a41a68de5dda622957cbc">◆ </a></span>GameInterface()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_game_interface.html">GameInterface</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a888acc31806054076bbb82d3a7520e61" name="a888acc31806054076bbb82d3a7520e61"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a888acc31806054076bbb82d3a7520e61">◆ </a></span>gameDeactivate()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void gameDeactivate </td>
- <td>(</td>
- <td class="paramtype">const bool </td>
- <td class="paramname"><em>noRender</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a2295949ad18a6ce0041a9ad8496aeecb">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="acc6f7ab9f3aa79223e4cde77bc324fc7" name="acc6f7ab9f3aa79223e4cde77bc324fc7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acc6f7ab9f3aa79223e4cde77bc324fc7">◆ </a></span>gameReactivate()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void gameReactivate </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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a4e42a20714695adb2dab152a0be25ccc">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="a6434ff125839fe34b9423fb434759266" name="a6434ff125839fe34b9423fb434759266"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6434ff125839fe34b9423fb434759266">◆ </a></span>getJournalMode()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">JournalMode getJournalMode </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">
- </div>
- </div>
- <a id="a13b3161700c069b06ed26037f3134b3c" name="a13b3161700c069b06ed26037f3134b3c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a13b3161700c069b06ed26037f3134b3c">◆ </a></span>getJournalStream()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_file_stream.html">FileStream</a> * getJournalStream </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="acbe62eff84ed9304b3cd6dae96531010" name="acbe62eff84ed9304b3cd6dae96531010"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acbe62eff84ed9304b3cd6dae96531010">◆ </a></span>isJournalReading()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isJournalReading </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>Are we reading back from the journal? </p>
- </div>
- </div>
- <a id="a46629c4b566b2692bea90abf5d4cbb1a" name="a46629c4b566b2692bea90abf5d4cbb1a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a46629c4b566b2692bea90abf5d4cbb1a">◆ </a></span>isJournalWriting()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isJournalWriting </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>Are we writing to the journal? </p>
- </div>
- </div>
- <a id="a7d914bd4eddb3cf57ad8d024c376c2c4" name="a7d914bd4eddb3cf57ad8d024c376c2c4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7d914bd4eddb3cf57ad8d024c376c2c4">◆ </a></span>isRunning()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isRunning </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="aabfbd9eb3ce8835855b37b59c6759cfa" name="aabfbd9eb3ce8835855b37b59c6759cfa"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aabfbd9eb3ce8835855b37b59c6759cfa">◆ </a></span>journalProcess()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void journalProcess </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>If we're doing a journal playback, this function is responsible for reading events from the journal file and dispatching them. </p>
- </div>
- </div>
- <a id="a1765ef15a840036cff90d59ddff68ea6" name="a1765ef15a840036cff90d59ddff68ea6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1765ef15a840036cff90d59ddff68ea6">◆ </a></span>journalRead() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void journalRead </td>
- <td>(</td>
- <td class="paramtype">U32 * </td>
- <td class="paramname"><em>val</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Read a U32 from the journal. </p>
- </div>
- </div>
- <a id="a9bc11913418c04e26f8a67c3a106c7dc" name="a9bc11913418c04e26f8a67c3a106c7dc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9bc11913418c04e26f8a67c3a106c7dc">◆ </a></span>journalRead() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void journalRead </td>
- <td>(</td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>size</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>buffer</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Read a block of data from the journal. </p>
- </div>
- </div>
- <a id="a254e56d2e1ddab486a54e6d460d1ffc4" name="a254e56d2e1ddab486a54e6d460d1ffc4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a254e56d2e1ddab486a54e6d460d1ffc4">◆ </a></span>journalWrite() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void journalWrite </td>
- <td>(</td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>size</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>buffer</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Write a block of data to the journal. </p>
- </div>
- </div>
- <a id="a35634a03800817eba8ba77d8fc13a2c0" name="a35634a03800817eba8ba77d8fc13a2c0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a35634a03800817eba8ba77d8fc13a2c0">◆ </a></span>journalWrite() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void journalWrite </td>
- <td>(</td>
- <td class="paramtype">U32 </td>
- <td class="paramname"><em>val</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Write a U32 to the journal. </p>
- </div>
- </div>
- <a id="a11816f2d65c8d9a3a735733ff4dca4b5" name="a11816f2d65c8d9a3a735733ff4dca4b5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a11816f2d65c8d9a3a735733ff4dca4b5">◆ </a></span>loadJournal()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void loadJournal </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>fileName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Start loading journal data from the specified file. </p>
- </div>
- </div>
- <a id="a5ba630471faace5d375ec97929abf91f" name="a5ba630471faace5d375ec97929abf91f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5ba630471faace5d375ec97929abf91f">◆ </a></span>mainInitialize()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual bool mainInitialize </td>
- <td>(</td>
- <td class="paramtype">int </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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#abbdcbad8eede448753966b6ff3005211">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="ac0318fde7694326dbaa6efc7603b7e9b" name="ac0318fde7694326dbaa6efc7603b7e9b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac0318fde7694326dbaa6efc7603b7e9b">◆ </a></span>mainLoop()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void mainLoop </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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a52387bf053883d1a8feeee2dd2cdd4f3">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="ab4f05281a713f0a778b9d9507105cb05" name="ab4f05281a713f0a778b9d9507105cb05"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab4f05281a713f0a778b9d9507105cb05">◆ </a></span>mainShutdown()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void mainShutdown </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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a44c2cfeb1f1b3695b46571e291916bcf">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="abf0a6493502f62311a6eae4047355311" name="abf0a6493502f62311a6eae4047355311"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abf0a6493502f62311a6eae4047355311">◆ </a></span>playJournal()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void playJournal </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>fileName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>journalBreak</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Play back the specified journal.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fileName</td><td>Journal file to play back. </td></tr>
- <tr><td class="paramname">journalBreak</td><td>Should we break execution after we're done? </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a52dbaef796e5d5e049995eb631989a8a" name="a52dbaef796e5d5e049995eb631989a8a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a52dbaef796e5d5e049995eb631989a8a">◆ </a></span>postEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void postEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_event.html">Event</a> & </td>
- <td class="paramname"><em>event</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>Place an event in Game's event queue. </p>
- </div>
- </div>
- <a id="af7de28c08ef1117cafcd137ae94779d6" name="af7de28c08ef1117cafcd137ae94779d6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af7de28c08ef1117cafcd137ae94779d6">◆ </a></span>processConnectedAcceptEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processConnectedAcceptEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_connected_accept_event.html">ConnectedAcceptEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a731e9ef0950a79c4dd1717241b6062e2">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="ac536e64122d815c97cda3ab9023f70ba" name="ac536e64122d815c97cda3ab9023f70ba"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac536e64122d815c97cda3ab9023f70ba">◆ </a></span>processConnectedNotifyEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processConnectedNotifyEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_connected_notify_event.html">ConnectedNotifyEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a9b2ef82face55702cf133c74383184f9">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="a3eb8ea5a6909736a03a702ad96ba4c00" name="a3eb8ea5a6909736a03a702ad96ba4c00"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3eb8ea5a6909736a03a702ad96ba4c00">◆ </a></span>processConnectedReceiveEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processConnectedReceiveEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_connected_receive_event.html">ConnectedReceiveEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a8d4000d87620ae1bfa8ee82ff1316228">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="ae8d0046a3d63a0e615889a38b8b33ed9" name="ae8d0046a3d63a0e615889a38b8b33ed9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae8d0046a3d63a0e615889a38b8b33ed9">◆ </a></span>processConsoleEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processConsoleEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_console_event.html">ConsoleEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a8fdc5a96f79a4c43335f9320ed7c6f3b">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="a29d06d47932bed594e92a0e935d69857" name="a29d06d47932bed594e92a0e935d69857"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a29d06d47932bed594e92a0e935d69857">◆ </a></span>processEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void processEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_event.html">Event</a> * </td>
- <td class="paramname"><em>event</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">
- </div>
- </div>
- <a id="ad5473b44af17c41807bd98b6d1da298b" name="ad5473b44af17c41807bd98b6d1da298b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad5473b44af17c41807bd98b6d1da298b">◆ </a></span>processEvents()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void processEvents </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>Process all the events in Game's event queue. Only the main thread should call this. </p>
- </div>
- </div>
- <a id="a31ae403f71ef74f07321bc0b098d1b7d" name="a31ae403f71ef74f07321bc0b098d1b7d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a31ae403f71ef74f07321bc0b098d1b7d">◆ </a></span>processInputEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processInputEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_input_event.html">InputEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a8f354293f685e59d7d891ba0a380cc1f">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="abe67b471a3dd5470fd038a4b2724dfe9" name="abe67b471a3dd5470fd038a4b2724dfe9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abe67b471a3dd5470fd038a4b2724dfe9">◆ </a></span>processMouseMoveEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processMouseMoveEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_mouse_move_event.html">MouseMoveEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a45c40b274a542c50c5a8a4cca6cfd89e">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="a703725f526d2ada035851e26c5810acc" name="a703725f526d2ada035851e26c5810acc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a703725f526d2ada035851e26c5810acc">◆ </a></span>processPacketReceiveEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processPacketReceiveEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_packet_receive_event.html">PacketReceiveEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a084d4a832fe9e55e55202369d75fa572">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="a779d3dcf22b84ca46d3d2f4807c5592e" name="a779d3dcf22b84ca46d3d2f4807c5592e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a779d3dcf22b84ca46d3d2f4807c5592e">◆ </a></span>processQuitEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processQuitEvent </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#aa21d8cfe3556cf8e268b05f30758a698">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="af86ab9e168dd5460a425b4c3532a130e" name="af86ab9e168dd5460a425b4c3532a130e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#af86ab9e168dd5460a425b4c3532a130e">◆ </a></span>processScreenTouchEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processScreenTouchEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_screen_touch_event.html">ScreenTouchEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#a79e916ffdbb7f88c652c402634b19959">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="ab304a3d6579c3a1b0b99fb2562fcf8e6" name="ab304a3d6579c3a1b0b99fb2562fcf8e6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab304a3d6579c3a1b0b99fb2562fcf8e6">◆ </a></span>processTimeEvent()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void processTimeEvent </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="struct_time_event.html">TimeEvent</a> * </td>
- <td class="paramname"><em>event</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#ab65459bc506046192a646e2a531bd587">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="aee356ade317d4fa3bb03249b2924413c" name="aee356ade317d4fa3bb03249b2924413c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aee356ade317d4fa3bb03249b2924413c">◆ </a></span>refreshWindow()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void refreshWindow </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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#adca01547aa741fd54d8224d8d3d68c7c">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="aafeed11da1cedbbec921b45aa970dfa6" name="aafeed11da1cedbbec921b45aa970dfa6"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aafeed11da1cedbbec921b45aa970dfa6">◆ </a></span>requiresRestart()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool requiresRestart </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="ad4c2914d27277e6f13dbd5296fefdc0f" name="ad4c2914d27277e6f13dbd5296fefdc0f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad4c2914d27277e6f13dbd5296fefdc0f">◆ </a></span>saveJournal()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void saveJournal </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>fileName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Start saving journal data to the specified file (must be able to write it). </p>
- </div>
- </div>
- <a id="a3ed3c2d0b972bab60891d82efacbc9e2" name="a3ed3c2d0b972bab60891d82efacbc9e2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3ed3c2d0b972bab60891d82efacbc9e2">◆ </a></span>setRestart()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setRestart </td>
- <td>(</td>
- <td class="paramtype">const bool </td>
- <td class="paramname"><em>restart</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="affa464a1d259b8fdb964058925b1b69b" name="affa464a1d259b8fdb964058925b1b69b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#affa464a1d259b8fdb964058925b1b69b">◆ </a></span>setRunning()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void setRunning </td>
- <td>(</td>
- <td class="paramtype">const bool </td>
- <td class="paramname"><em>running</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="a51630e0a6734c0e65762da2aacf54b65" name="a51630e0a6734c0e65762da2aacf54b65"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a51630e0a6734c0e65762da2aacf54b65">◆ </a></span>textureKill()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void textureKill </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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#ae672876e33bcd8c9d60faa11d2f19faf">DefaultGame</a>.</p>
- </div>
- </div>
- <a id="a98d778dfe06e13d5718cbfe11d608f6b" name="a98d778dfe06e13d5718cbfe11d608f6b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a98d778dfe06e13d5718cbfe11d608f6b">◆ </a></span>textureResurrect()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void textureResurrect </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">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Implemented in <a class="el" href="class_default_game.html#ad43528668b1bbfcbcb7f3e925d9845be">DefaultGame</a>.</p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>game/<b>gameInterface.h</b></li>
- <li>game/<b>gameInterface.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>
|