zengine/doc/html/namespaceZE.html

204 lines
11 KiB
HTML
Raw Normal View History

2002-11-21 05:40:49 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ZE Namespace Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
2002-12-22 04:31:15 +00:00
<!-- Generated by Doxygen 1.3-rc2 -->
2002-11-21 05:40:49 +00:00
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>ZE Namespace Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Namespace for <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> classes and utility functions.
<p>
2002-12-05 00:05:06 +00:00
<p>
2002-11-21 05:40:49 +00:00
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Class for use in <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a>.</em> <a href="classZE_1_1ZConfigFile.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html">ZCF_Variable</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Variable class.</em> <a href="classZE_1_1ZConfigFile_1_1ZCF__Variable.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZConfigFile_1_1ZCF__Section.html">ZCF_Section</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZConfigFile.html">ZConfigFile</a> Section class.</em> <a href="classZE_1_1ZConfigFile_1_1ZCF__Section.html#_details">More...</a><em></em></font><br><br></td></tr>
2002-11-21 05:40:49 +00:00
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZEngine.html">ZEngine</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Main <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> Singleton Class.</em> <a href="classZE_1_1ZEngine.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZFont.html">ZFont</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZFont.html">ZFont</a> class for basic Font use.</em> <a href="classZE_1_1ZFont.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZImage.html">ZImage</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZImage.html">ZImage</a> class for basic Image use.</em> <a href="classZE_1_1ZImage.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZMusic.html">ZMusic</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZMusic.html">ZMusic</a> class for playing full length music (eg. ogg or wav).</em> <a href="classZE_1_1ZMusic.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZObject.html">ZObject</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZObject.html">ZObject</a> base class for other <a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> objects.</em> <a href="classZE_1_1ZObject.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZRect.html">ZRect</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZEngine.html">ZEngine</a> class for simplified rectangle use.</em> <a href="classZE_1_1ZRect.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZSound.html">ZSound</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZSound.html">ZSound</a> class for playing sound effects. (WAV).</em> <a href="classZE_1_1ZSound.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classZE_1_1ZTimer.html">ZTimer</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classZE_1_1ZTimer.html">ZTimer</a> class for Timer use.</em> <a href="classZE_1_1ZTimer.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
<tr><td nowrap align=right valign=top>string&nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html#a0">_GetError</a> (int line, string file, string str)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Error handling Utiltity function.</em> <a href="#a0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html#a1">_LogError</a> (int line, string file, string str)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Error handling Utiltity function.</em> <a href="#a1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>string&nbsp;</td><td valign=bottom><a class="el" href="namespaceZE.html#a2">FormatStr</a> (const char *fmtstr,...)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Parses a string and interprets variable arguments, similar to sprintf.</em> <a href="#a2"></a><em></em></font><br><br></td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a name="a0" doxytag="ZE::_GetError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> string ZE::_GetError </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>line</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>file</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>str</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2002-12-05 00:05:06 +00:00
Get string describing error given appropriate details. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>line</em>&nbsp;</td><td>Line error occured on. </td></tr>
<tr><td valign=top><em>file</em>&nbsp;</td><td>Name of file error occured in. </td></tr>
<tr><td valign=top><em>str</em>&nbsp;</td><td>More detail on error. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>String describing error. </dd></dl>
</td>
2002-11-21 05:40:49 +00:00
</tr>
</table>
<a name="a1" doxytag="ZE::_LogError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ZE::_LogError </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">int&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>line</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>file</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>string&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>str</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2002-12-05 00:05:06 +00:00
Log error to stderr, describing error given appropriate details. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>line</em>&nbsp;</td><td>Line error occured on. </td></tr>
<tr><td valign=top><em>file</em>&nbsp;</td><td>Name of file error occured in. </td></tr>
<tr><td valign=top><em>str</em>&nbsp;</td><td>More detail on error. </td></tr>
</table>
</dl>
</td>
2002-11-21 05:40:49 +00:00
</tr>
</table>
<a name="a2" doxytag="ZE::FormatStr"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> string ZE::FormatStr </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const char *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>fmtstr</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>...&nbsp;</td>
<td class="mdname" nowrap>&nbsp;</td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
2002-12-05 00:05:06 +00:00
Takes identifiers out of fmtstr and parses them, replacing them with cooresponding values in the variable arguments list. For more detail view stdarg documentation. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign=top><em>fmtstr</em>&nbsp;</td><td>defines format of resulting string </td></tr>
<tr><td valign=top><em>...</em>&nbsp;</td><td>variable number of arguments after fmtstr </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>string of parsed and combined string </dd></dl>
</td>
2002-11-21 05:40:49 +00:00
</tr>
</table>
2002-12-22 04:31:15 +00:00
<hr><address style="align: right;"><small>Generated on Sat Dec 21 23:20:23 2002 for ZEngine by
2002-11-21 05:40:49 +00:00
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
2002-12-22 04:31:15 +00:00
width=110 height=53></a>1.3-rc2 </small></address>
2002-11-21 05:40:49 +00:00
</body>
</html>