doxygen/index.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<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>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<!-- Disable default Doxygen header
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Stratagus
   &#160;<span id="projectnumber">3.3.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
-->
<!-- Begin of Stratagus header -->
<pre width="80">
         _________ __                 __
        /   _____//  |_____________ _/  |______     ____  __ __  ______
        \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
        /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ \
       /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
               \/                  \/          \//_____/            \/
    ______________________                           ______________________
                          T H E   W A R   B E G I N S
                   Stratagus - A free fantasy real time strategy game engine
</pre>
<hr />
<!-- End of Stratagus header -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">Stratagus Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1><a class="anchor" id="Introduction"></a>
Introduction</h1>
<p>Welcome to the source code documentation of the Stratagus engine. Extract the source documentation with doxygen (<a href="http://www.doxygen.org">http://www.doxygen.org</a>) tool.</p>
<p>Any help to improve this documention is welcome. If you didn't understand something or you found an error or a wrong spelling or wrong grammar please write an email (including a patch :).</p>
<h1><a class="anchor" id="Information"></a>
Information</h1>
<p>Visit the <a href="https://github.com/Wargus/stratagus">https://github.com/Wargus/stratagus</a> web page for the latest news and <a href="../index.html">Stratagus Info</a> for other documentation.</p>
<h1><a class="anchor" id="Modules"></a>
Modules</h1>
<p>This are the main modules of the Stratagus engine.</p>
<h2><a class="anchor" id="Map"></a>
Map</h2>
<p>Handles the map. A map is made from tiles.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="map_8h.html">map.h</a> </dd>
<dd>
<a class="el" href="map_8cpp.html">map.cpp</a> </dd>
<dd>
<a class="el" href="tileset_8h.html">tileset.h</a> </dd>
<dd>
<a class="el" href="tileset_8cpp.html">tileset.cpp</a></dd></dl>
<h2><a class="anchor" id="Unit"></a>
Unit</h2>
<p>Handles units. Units are ships, flyers, buildings, creatures, machines.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="unit_8h.html">unit.h</a> </dd>
<dd>
<a class="el" href="unit_8cpp.html">unit.cpp</a> </dd>
<dd>
<a class="el" href="unittype_8h.html">unittype.h</a> </dd>
<dd>
<a class="el" href="unittype_8cpp.html">unittype.cpp</a></dd></dl>
<h2><a class="anchor" id="Missile"></a>
Missile</h2>
<p>Handles missiles. Missiles are all other sprites on map which are no unit.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="missile_8h.html">missile.h</a> </dd>
<dd>
<a class="el" href="missile_8cpp.html">missile.cpp</a></dd></dl>
<h2><a class="anchor" id="Player"></a>
Player</h2>
<p>Handles players, all units are owned by a player. A player could be controlled by a human or a computer.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="player_8h.html">player.h</a> </dd>
<dd>
<a class="el" href="player_8cpp.html">player.cpp</a> </dd>
<dd>
<a class="el" href="classCPlayer.html" title="Diplomacy states for CommandDiplomacy.">CPlayer</a></dd></dl>
<h2><a class="anchor" id="Sound"></a>
Sound</h2>
<p>Handles the high and low level of the sound. There are the background music support, voices and sound effects. Following low level backends are supported: OSS and SDL.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000068">Todo:</a></b></dt><dd><p class="startdd">adpcm file format support for sound effects </p>
<p class="interdd">better separation of low and high level, assembler mixing support. </p>
<p class="enddd">Streaming support of ogg/mp3 files.</p>
</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="sound_8h.html">sound.h</a> </dd>
<dd>
<a class="el" href="sound_8cpp.html">sound.cpp</a> </dd>
<dd>
<a class="el" href="script__sound_8cpp.html">script_sound.cpp</a> </dd>
<dd>
<a class="el" href="sound__id_8cpp.html">sound_id.cpp</a> </dd>
<dd>
<a class="el" href="sound__server_8cpp.html">sound_server.cpp</a> </dd>
<dd>
<a class="el" href="unitsound_8cpp.html">unitsound.cpp</a> </dd>
<dd>
sdl_audio.cpp </dd>
<dd>
ogg.cpp </dd>
<dd>
wav.cpp</dd></dl>
<h2><a class="anchor" id="Video"></a>
Video</h2>
<p>Handles the high and low level of the graphics. This also contains the sprite and linedrawing routines.</p>
<p>See page <a class="el" href="VideoModule.html">Module - Video</a> for more information upon supported features and video platforms.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="video_8h.html">video.h</a> </dd>
<dd>
<a class="el" href="video_8cpp.html">video.cpp</a></dd></dl>
<h2><a class="anchor" id="Network"></a>
Network</h2>
<p>Handles the high and low level of the network protocol. The network protocol is needed for multiplayer games.</p>
<p>See page <a class="el" href="NetworkModule.html">Module - Network</a> for more information upon supported features and API.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="network_8h.html">network.h</a> </dd>
<dd>
<a class="el" href="network_8cpp.html">network.cpp</a></dd></dl>
<h2><a class="anchor" id="Pathfinder"></a>
Pathfinder</h2>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="pathfinder_8h.html">pathfinder.h</a> </dd>
<dd>
<a class="el" href="pathfinder_8cpp.html">pathfinder.cpp</a></dd></dl>
<h2><a class="anchor" id="AI"></a>
AI</h2>
<p>There are currently two AI's. The old one is very hardcoded, but does things like placing buildings better than the new. The old AI shouldn't be used. The new is very flexible, but very basic. It includes none optimations.</p>
<p>See page <a class="el" href="AiModule.html">Module - AI</a> for more information upon supported features and API.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="ai__local_8h.html">ai_local.h</a> </dd>
<dd>
<a class="el" href="ai_8h.html">ai.h</a> </dd>
<dd>
<a class="el" href="ai_8cpp.html">ai.cpp</a></dd></dl>
<h2><a class="anchor" id="CCL"></a>
CCL</h2>
<p>CCL is Craft Configuration Language, which is used to configure and customize Stratagus.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="script_8h.html">script.h</a> </dd>
<dd>
<a class="el" href="script_8cpp.html">script.cpp</a></dd></dl>
<h2><a class="anchor" id="Icon"></a>
Icon</h2>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icons_8h.html">icons.h</a> </dd>
<dd>
<a class="el" href="icons_8cpp.html">icons.cpp</a></dd></dl>
<h2><a class="anchor" id="Editor"></a>
Editor</h2>
<p>This is the integrated editor, it shouldn't be a perfect editor. It is used to test new features of the engine.</p>
<p>See page <a class="el" href="EditorModule.html">Module - Editor</a> for more information upon supported features and API.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="editor_8h.html">editor.h</a> </dd>
<dd>
<a class="el" href="editor_8cpp.html">editor.cpp</a> </dd></dl>
</div></div><!-- PageDoc -->
</div><!-- contents -->

<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 10 2022 20:03:34 for Stratagus by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17</small></address>
<!-- Begin of Stratagus footer -->
(C) Copyright 1998-2012 by The <a href="https://launchpad.net/stratagus">Stratagus</a> Project under the <a href="../gpl.html">GNU General Public License</a>.<br/>
All trademarks and copyrights on this page are owned by their respective owners.<br/>
<!-- End of Stratagus footer -->
</body>
</html>