123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344 |
- <!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>UAS2: cFoci Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <link href="doxygen.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <!-- Generated by Doxygen 1.6.2 -->
- <div class="navigation" id="top">
- <div class="tabs">
- <ul>
- <li><a href="main.html"><span>Main Page</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div class="tabs">
- <ul>
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- </div>
- <div class="contents">
- <h1>cFoci Class Reference</h1><!-- doxytag: class="cFoci" --><!-- doxytag: inherits="cObject" --><div class="dynheader">
- Inheritance diagram for cFoci:</div>
- <div class="dynsection">
- <div class="center">
- <img src="classc_foci.png" usemap="#cFoci_map" alt=""/>
- <map id="cFoci_map" name="cFoci_map">
- <area href="classc_object.html" alt="cObject" shape="rect" coords="0,0,56,24"/>
- </map>
- </div>
- </div>
- <p><a href="classc_foci-members.html">List of all members.</a></p>
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classc_foci.html#a41f243574a1d553ceec220e6340705c5">cFoci</a> (DWORD dwGUID, <a class="el" href="structc_location.html">cLocation</a> &Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classc_foci.html#a7d2ce50fcb0fd2ea29100a298f605d41">cFoci</a> (DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight, BOOL fSelectable=TRUE, BOOL fEquippable=FALSE, BOOL fStackable=TRUE, BOOL fIsOwned=TRUE)</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classc_message.html">cMessage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classc_foci.html#a3bc1269885b79029363ac5aef3e3ab42">CreatePacket</a> ()</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classc_message.html">cMessage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classc_foci.html#a975187acbcd68a5eea4da58699cd8459">CreatePacketContainer</a> (DWORD Container, DWORD ItemModelID)</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classc_foci.html#aaff209edaf2b89126ada579f2340c3d4">Assess</a> (<a class="el" href="classc_client.html">cClient</a> *pcAssesser)</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classc_foci.html#a549837928abee7411c3801917fe9ddb4">Action</a> (<a class="el" href="classc_client.html">cClient</a> *who)</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25b436f35f7ac644f48a99ac76c8fadf"></a><!-- doxytag: member="cFoci::GetItemModelID" ref="a25b436f35f7ac644f48a99ac76c8fadf" args="()" -->
- DWORD </td><td class="memItemRight" valign="bottom"><b>GetItemModelID</b> ()</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd8071d98515546f76de5b39de75be35"></a><!-- doxytag: member="cFoci::GetContainerID" ref="acd8071d98515546f76de5b39de75be35" args="()" -->
- DWORD </td><td class="memItemRight" valign="bottom"><b>GetContainerID</b> ()</td></tr>
- <tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d05215d9b520bfe60c38d473250d4a4"></a><!-- doxytag: member="cFoci::m_dwItemModelID" ref="a7d05215d9b520bfe60c38d473250d4a4" args="" -->
- DWORD </td><td class="memItemRight" valign="bottom"><b>m_dwItemModelID</b></td></tr>
- <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e8a335609a5736afceaa988d00a80db"></a><!-- doxytag: member="cFoci::m_wWeight" ref="a8e8a335609a5736afceaa988d00a80db" args="" -->
- WORD </td><td class="memItemRight" valign="bottom"><b>m_wWeight</b></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99e307ac8091db01f93df8beb7ad37f1"></a><!-- doxytag: member="cFoci::m_dwValue" ref="a99e307ac8091db01f93df8beb7ad37f1" args="" -->
- DWORD </td><td class="memItemRight" valign="bottom"><b>m_dwValue</b></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93d071c20bce23db4d0f558663467573"></a><!-- doxytag: member="cFoci::m_fIsStackable" ref="a93d071c20bce23db4d0f558663467573" args="" -->
- BOOL </td><td class="memItemRight" valign="bottom"><b>m_fIsStackable</b></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a61bebed88548db348e24bf9dffdd8e72"></a><!-- doxytag: member="cFoci::m_fEquippable" ref="a61bebed88548db348e24bf9dffdd8e72" args="" -->
- BOOL </td><td class="memItemRight" valign="bottom"><b>m_fEquippable</b></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9cf4fcb0c8d18735641a0e0c2949cf98"></a><!-- doxytag: member="cFoci::m_fIsSolid" ref="a9cf4fcb0c8d18735641a0e0c2949cf98" args="" -->
- BOOL </td><td class="memItemRight" valign="bottom"><b>m_fIsSolid</b></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1f24ffe2dfc1a925457fa2d364f632ce"></a><!-- doxytag: member="cFoci::m_strDescription" ref="a1f24ffe2dfc1a925457fa2d364f632ce" args="" -->
- std::string </td><td class="memItemRight" valign="bottom"><b>m_strDescription</b></td></tr>
- </table>
- <hr/><h2>Constructor & Destructor Documentation</h2>
- <a class="anchor" id="a41f243574a1d553ceec220e6340705c5"></a><!-- doxytag: member="cFoci::cFoci" ref="a41f243574a1d553ceec220e6340705c5" args="(DWORD dwGUID, cLocation &Loc, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">cFoci::cFoci </td>
- <td>(</td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>dwGUID</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structc_location.html">cLocation</a> & </td>
- <td class="paramname"> <em>Loc</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>dwModel</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"> <em>flScale</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">BOOL </td>
- <td class="paramname"> <em>fSolid</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>dwIcon</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::string </td>
- <td class="paramname"> <em>strName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::string </td>
- <td class="paramname"> <em>strDescription</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td><code> [inline]</code></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>A constructor.</p>
- <p>Called whenever a foci object is initialized in the world. </p>
- </div>
- </div>
- <a class="anchor" id="a7d2ce50fcb0fd2ea29100a298f605d41"></a><!-- doxytag: member="cFoci::cFoci" ref="a7d2ce50fcb0fd2ea29100a298f605d41" args="(DWORD dwGUID, DWORD dwContainer, DWORD dwModel, float flScale, BOOL fSolid, DWORD dwIcon, std::string strName, std::string strDescription, DWORD dwValue, WORD wWeight, BOOL fSelectable=TRUE, BOOL fEquippable=FALSE, BOOL fStackable=TRUE, BOOL fIsOwned=TRUE)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">cFoci::cFoci </td>
- <td>(</td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>dwGUID</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>dwContainer</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>dwModel</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">float </td>
- <td class="paramname"> <em>flScale</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">BOOL </td>
- <td class="paramname"> <em>fSolid</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>dwIcon</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::string </td>
- <td class="paramname"> <em>strName</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::string </td>
- <td class="paramname"> <em>strDescription</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>dwValue</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">WORD </td>
- <td class="paramname"> <em>wWeight</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">BOOL </td>
- <td class="paramname"> <em>fSelectable</em> = <code>TRUE</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">BOOL </td>
- <td class="paramname"> <em>fEquippable</em> = <code>FALSE</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">BOOL </td>
- <td class="paramname"> <em>fStackable</em> = <code>TRUE</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">BOOL </td>
- <td class="paramname"> <em>fIsOwned</em> = <code>TRUE</code></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td><code> [inline]</code></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>A constructor.</p>
- <p>Called whenever a foci object is initialized in a container. </p>
- </div>
- </div>
- <hr/><h2>Member Function Documentation</h2>
- <a class="anchor" id="a549837928abee7411c3801917fe9ddb4"></a><!-- doxytag: member="cFoci::Action" ref="a549837928abee7411c3801917fe9ddb4" args="(cClient *who)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void cFoci::Action </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> * </td>
- <td class="paramname"> <em>who</em></td>
- <td> ) </td>
- <td><code> [virtual]</code></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Handles the actions of foci objects.</p>
- <p>This function is called whenever a foci is used or should perform an action. </p>
- <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
- </div>
- </div>
- <a class="anchor" id="aaff209edaf2b89126ada579f2340c3d4"></a><!-- doxytag: member="cFoci::Assess" ref="aaff209edaf2b89126ada579f2340c3d4" args="(cClient *pcAssesser)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void cFoci::Assess </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classc_client.html">cClient</a> * </td>
- <td class="paramname"> <em>pcAssesser</em></td>
- <td> ) </td>
- <td><code> [virtual]</code></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Handles the assessment of foci objects.</p>
- <p>This function is called whenever a foci is assessed by a client.</p>
- <p>Returns a Game Event (0x0000F7B0) server message of type Identify Object (0x000000C9). </p>
- <p>Reimplemented from <a class="el" href="classc_object.html">cObject</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a3bc1269885b79029363ac5aef3e3ab42"></a><!-- doxytag: member="cFoci::CreatePacket" ref="a3bc1269885b79029363ac5aef3e3ab42" args="()" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cFoci::CreatePacket </td>
- <td>(</td>
- <td class="paramname"></td>
- <td> ) </td>
- <td><code> [virtual]</code></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Handles the message sent for the creation of foci in the world.</p>
- <p>This function is called whenever a foci should be created in the world for a client.</p>
- <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classc_message.html">cMessage</a> - Returns a Create Object (0x0000F745) server message. </dd></dl>
- <p>Implements <a class="el" href="classc_object.html">cObject</a>.</p>
- </div>
- </div>
- <a class="anchor" id="a975187acbcd68a5eea4da58699cd8459"></a><!-- doxytag: member="cFoci::CreatePacketContainer" ref="a975187acbcd68a5eea4da58699cd8459" args="(DWORD Container, DWORD ItemModelID)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classc_message.html">cMessage</a> cFoci::CreatePacketContainer </td>
- <td>(</td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>Container</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">DWORD </td>
- <td class="paramname"> <em>ItemModelID</em></td><td> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td><td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Handles the message sent for the creation of foci in a container.</p>
- <p>This function is called whenever a foci should be created in the inventory of another object.</p>
- <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classc_message.html">cMessage</a> - Returns a Create Object (0x0000F745) server message. </dd></dl>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>E:/uas2/Server/<a class="el" href="_object_8h_source.html">Object.h</a></li>
- <li>E:/uas2/Server/<a class="el" href="c_foci_8cpp.html">cFoci.cpp</a></li>
- </ul>
- </div>
- <hr size="1"/><address style="text-align: right;"><small>Generated by
- <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
- </body>
- </html>
|