Files
OpenArena/doc/xml/class_open_arena_1_1_player.xml
2006-07-19 00:15:26 -04:00

262 lines
13 KiB
XML

<?xml version='1.0' encoding='iso-8859-1' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.4.7">
<compounddef id="class_open_arena_1_1_player" kind="class" prot="public">
<compoundname>OpenArena::Player</compoundname>
<includes local="no">player.h</includes>
<sectiondef kind="public-func">
<memberdef kind="function" id="class_open_arena_1_1_player_1452e91c114a3fbed6a976dca04f79152" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void OpenArena::Player::Load</definition>
<argsstring>()</argsstring>
<name>Load</name>
<briefdescription>
<para>Write brief comment for Load here. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="exception"><parameteritem>
<parameternamelist>
<parametername>&lt;exception</parametername>
</parameternamelist>
<parameterdescription>
<para>class&gt; Description of criteria for throwing this exception.</para></parameterdescription>
</parameteritem>
</parameterlist>
Write detailed description for Load here.</para><para><simplesect kind="remark"><para>Write remarks for Load here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" line="39" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.cpp" bodystart="5" bodyend="7"/>
</memberdef>
<memberdef kind="function" id="class_open_arena_1_1_player_13dc79d7777ce43928da9150d334956cd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void OpenArena::Player::Save</definition>
<argsstring>()</argsstring>
<name>Save</name>
<briefdescription>
<para>Write brief comment for Save here. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="exception"><parameteritem>
<parameternamelist>
<parametername>&lt;exception</parametername>
</parameternamelist>
<parameterdescription>
<para>class&gt; Description of criteria for throwing this exception.</para></parameterdescription>
</parameteritem>
</parameterlist>
Write detailed description for Save here.</para><para><simplesect kind="remark"><para>Write remarks for Save here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" line="55" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.cpp" bodystart="9" bodyend="11"/>
</memberdef>
<memberdef kind="function" id="class_open_arena_1_1_player_17febc0eb2e888ef25ca493a5aa5486e4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void OpenArena::Player::CreateCharacter</definition>
<argsstring>()</argsstring>
<name>CreateCharacter</name>
<briefdescription>
<para>Write brief comment for CreateCharacter here. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="exception"><parameteritem>
<parameternamelist>
<parametername>&lt;exception</parametername>
</parameternamelist>
<parameterdescription>
<para>class&gt; Description of criteria for throwing this exception.</para></parameterdescription>
</parameteritem>
</parameterlist>
Write detailed description for CreateCharacter here.</para><para><simplesect kind="remark"><para>Write remarks for CreateCharacter here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" line="71" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.cpp" bodystart="23" bodyend="25"/>
</memberdef>
<memberdef kind="function" id="class_open_arena_1_1_player_1aa4e2dcd1aa0f46869d859d451e5ebee" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void OpenArena::Player::AddItem</definition>
<argsstring>(unsigned int item)</argsstring>
<name>AddItem</name>
<param>
<type>unsigned int</type>
<declname>item</declname>
</param>
<briefdescription>
<para>Write brief comment for AddItem here. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>item</parametername>
</parameternamelist>
<parameterdescription>
<para>Description of parameter item.</para></parameterdescription>
</parameteritem>
</parameterlist>
<parameterlist kind="exception"><parameteritem>
<parameternamelist>
<parametername>&lt;exception</parametername>
</parameternamelist>
<parameterdescription>
<para>class&gt; Description of criteria for throwing this exception.</para></parameterdescription>
</parameteritem>
</parameterlist>
Write detailed description for AddItem here.</para><para><simplesect kind="remark"><para>Write remarks for AddItem here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" line="92" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.cpp" bodystart="13" bodyend="16"/>
</memberdef>
<memberdef kind="function" id="class_open_arena_1_1_player_1c99914695b86395979431498e329f96e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void OpenArena::Player::RemoveItem</definition>
<argsstring>(unsigned int item)</argsstring>
<name>RemoveItem</name>
<param>
<type>unsigned int</type>
<declname>item</declname>
</param>
<briefdescription>
<para>Write brief comment for RemoveItem here. </para> </briefdescription>
<detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>item</parametername>
</parameternamelist>
<parameterdescription>
<para>Description of parameter item.</para></parameterdescription>
</parameteritem>
</parameterlist>
<parameterlist kind="exception"><parameteritem>
<parameternamelist>
<parametername>&lt;exception</parametername>
</parameternamelist>
<parameterdescription>
<para>class&gt; Description of criteria for throwing this exception.</para></parameterdescription>
</parameteritem>
</parameterlist>
Write detailed description for RemoveItem here.</para><para><simplesect kind="remark"><para>Write remarks for RemoveItem here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" line="111" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.cpp" bodystart="18" bodyend="21"/>
</memberdef>
</sectiondef>
<sectiondef kind="public-attrib">
<memberdef kind="variable" id="class_open_arena_1_1_player_12aa998fde9ee743bd6d1a3118280db2a" prot="public" static="no" mutable="no">
<type><ref refid="class_open_arena_1_1_control_scheme" kindref="compound">ControlScheme</ref></type>
<definition>ControlScheme OpenArena::Player::controls</definition>
<argsstring></argsstring>
<name>controls</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" line="113" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" bodystart="113" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="class_open_arena_1_1_player_15d97fc74963ae2c2fede23ec627df63a" prot="public" static="no" mutable="no">
<type><ref refid="class_open_arena_1_1_camera" kindref="compound">Camera</ref></type>
<definition>Camera OpenArena::Player::camera</definition>
<argsstring></argsstring>
<name>camera</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" line="114" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" bodystart="114" bodyend="-1"/>
</memberdef>
</sectiondef>
<briefdescription>
<para>Write brief comment for <ref refid="class_open_arena_1_1_player" kindref="compound">Player</ref> here. </para> </briefdescription>
<detaileddescription>
<para>Write detailed description for <ref refid="class_open_arena_1_1_player" kindref="compound">Player</ref> here.</para><para><simplesect kind="remark"><para>Write remarks for <ref refid="class_open_arena_1_1_player" kindref="compound">Player</ref> here.</para></simplesect>
<simplesect kind="see"><para>Separate items with the &apos;|&apos; character. </para></simplesect>
</para> </detaileddescription>
<collaborationgraph>
<node id="52">
<label>OpenArena::Camera</label>
<link refid="class_open_arena_1_1_camera"/>
<childnode refid="53" relation="usage">
<edgelabel>m_vUpVector
m_vView
m_vStrafe
m_vPosition</edgelabel>
</childnode>
</node>
<node id="53">
<label>OpenArena::Vec3d</label>
<link refid="class_open_arena_1_1_vec3d"/>
</node>
<node id="48">
<label>OpenArena::Player</label>
<link refid="class_open_arena_1_1_player"/>
<childnode refid="49" relation="usage">
<edgelabel>controls</edgelabel>
</childnode>
<childnode refid="52" relation="usage">
<edgelabel>camera</edgelabel>
</childnode>
</node>
<node id="49">
<label>OpenArena::ControlScheme</label>
<link refid="class_open_arena_1_1_control_scheme"/>
<childnode refid="50" relation="usage">
<edgelabel>weaponPrev
fireSecondary
lookLeft
rollRight
forward
weaponNext
quickMouseLook
toggleConsole
backward
moveRight
lookDown
toggleFPS
moveLeft
lookUp
toggleMouseLook
toggleLights
moveUp
rollLeft
moveDown
lookRight
firePrimary</edgelabel>
</childnode>
</node>
<node id="51">
<label>OpenArena::listNode&lt; uint8 &gt;</label>
<link refid="class_open_arena_1_1list_node"/>
<childnode refid="51" relation="usage">
<edgelabel>next</edgelabel>
</childnode>
</node>
<node id="50">
<label>OpenArena::list&lt; uint8 &gt;</label>
<link refid="class_open_arena_1_1list"/>
<childnode refid="51" relation="usage">
<edgelabel>head
tail
currPos</edgelabel>
</childnode>
</node>
</collaborationgraph>
<location file="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" line="22" bodyfile="/Users/tomhicks/Documents/workspaces/OpenArena/openarena/src/player.h" bodystart="21" bodyend="119"/>
<listofallmembers>
<member refid="class_open_arena_1_1_player_1aa4e2dcd1aa0f46869d859d451e5ebee" prot="public" virt="non-virtual"><scope>OpenArena::Player</scope><name>AddItem</name></member>
<member refid="class_open_arena_1_1_player_15d97fc74963ae2c2fede23ec627df63a" prot="public" virt="non-virtual"><scope>OpenArena::Player</scope><name>camera</name></member>
<member refid="class_open_arena_1_1_player_12aa998fde9ee743bd6d1a3118280db2a" prot="public" virt="non-virtual"><scope>OpenArena::Player</scope><name>controls</name></member>
<member refid="class_open_arena_1_1_player_17febc0eb2e888ef25ca493a5aa5486e4" prot="public" virt="non-virtual"><scope>OpenArena::Player</scope><name>CreateCharacter</name></member>
<member refid="class_open_arena_1_1_player_1452e91c114a3fbed6a976dca04f79152" prot="public" virt="non-virtual"><scope>OpenArena::Player</scope><name>Load</name></member>
<member refid="class_open_arena_1_1_player_1c99914695b86395979431498e329f96e" prot="public" virt="non-virtual"><scope>OpenArena::Player</scope><name>RemoveItem</name></member>
<member refid="class_open_arena_1_1_player_13dc79d7777ce43928da9150d334956cd" prot="public" virt="non-virtual"><scope>OpenArena::Player</scope><name>Save</name></member>
</listofallmembers>
</compounddef>
</doxygen>