nestopia/doc/details/api/Nes..Api..Cartridge..Profile..Game.html
2012-09-02 13:13:55 -04:00

439 lines
11 KiB
HTML

<HTML>
<HEAD>
<!-- Generated by CppDoc v2.4.1 on June 07, 2008 at 22:48-->
<META NAME="GENERATOR" Content="CppDoc">
<TITLE>Nestopia Core API: Nes::Api::Cartridge::Profile::Game</TITLE>
</HEAD>
<BODY>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#eeeeff">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-overview-summary.html"><B>Overview</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-summary.html"><B>Project</B></a>&nbsp;</TD>
<TD BGCOLOR="navy"> <FONT COLOR="white">&nbsp;<B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-tree.html"><B>Tree</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-deprecated-list.html"><B>Deprecated</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-all.html"><B>Index</B></a>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Nestopia Core API</B></EM>
</TD>
</TR>
<TR>
<TD><FONT SIZE="-2">
<a href="../../index.html" target="_top"><B>FRAMES</B></a> &nbsp;
&nbsp;<a href="../api/Nes..Api..Cartridge..Profile..Game.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
api</FONT>
<BR>
Struct Nes::Api::Cartridge::Profile::Game</H2>
<HR>
<DL>
<DT>struct <B><a href="../api/Nes..Api..Cartridge..Profile.html">Nes::Api::Cartridge::Profile</a>::Game</B></DT></DL>
<p>Game context.
<p>
<HR>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;Input::Adapter</CODE></FONT></TD>
<TD><CODE><B><a href="#adapter">adapter</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utilized controller adapter.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#altTitle">altTitle</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Alternative game title.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#catalog">catalog</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Catalog.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#clss">clss</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;Input::Type[ 5 ]</CODE></FONT></TD>
<TD><CODE><B><a href="#controllers">controllers</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Utilized controllers.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#developer">developer</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Developer.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;uint</CODE></FONT></TD>
<TD><CODE><B><a href="#players">players</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of players.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#portDeveloper">portDeveloper</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Port Developer.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#publisher">publisher</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Publisher.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#region">region</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Region.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#revision">revision</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Revision.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#subClss">subClss</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sub-class.</TD>
</TR>
<TR BGCOLOR="white">
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
<CODE>&nbsp;std::wstring</CODE></FONT></TD>
<TD><CODE><B><a href="#title">title</a></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Game title.</TD>
</TR>
</TABLE>
&nbsp;
<!-- =========== CONSTRUCTOR SUMMARY =========== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white">
<TD><CODE><B><a href="#Game()">Game</a></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<BR>
<BR>
<!-- ============ Field Detail ========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="adapter"><!-- --></A>
<A NAME="adapter"><!-- --></A>
<H3>adapter</H3>
<PRE>
public Input::Adapter <B>adapter</B>;
</PRE>
<DL>
<DD>Utilized controller adapter.
</DD>
</DL>
<HR>
<A NAME="altTitle"><!-- --></A>
<A NAME="altTitle"><!-- --></A>
<H3>altTitle</H3>
<PRE>
public std::wstring <B>altTitle</B>;
</PRE>
<DL>
<DD>Alternative game title.
</DD>
</DL>
<HR>
<A NAME="catalog"><!-- --></A>
<A NAME="catalog"><!-- --></A>
<H3>catalog</H3>
<PRE>
public std::wstring <B>catalog</B>;
</PRE>
<DL>
<DD>Catalog.
</DD>
</DL>
<HR>
<A NAME="clss"><!-- --></A>
<A NAME="clss"><!-- --></A>
<H3>clss</H3>
<PRE>
public std::wstring <B>clss</B>;
</PRE>
<DL>
<DD>Class.
</DD>
</DL>
<HR>
<A NAME="controllers"><!-- --></A>
<A NAME="controllers"><!-- --></A>
<H3>controllers</H3>
<PRE>
public Input::Type <B>controllers</B>[ 5 ];
</PRE>
<DL>
<DD>Utilized controllers.
</DD>
</DL>
<HR>
<A NAME="developer"><!-- --></A>
<A NAME="developer"><!-- --></A>
<H3>developer</H3>
<PRE>
public std::wstring <B>developer</B>;
</PRE>
<DL>
<DD>Developer.
</DD>
</DL>
<HR>
<A NAME="players"><!-- --></A>
<A NAME="players"><!-- --></A>
<H3>players</H3>
<PRE>
public uint <B>players</B>;
</PRE>
<DL>
<DD>Number of players.
</DD>
</DL>
<HR>
<A NAME="portDeveloper"><!-- --></A>
<A NAME="portDeveloper"><!-- --></A>
<H3>portDeveloper</H3>
<PRE>
public std::wstring <B>portDeveloper</B>;
</PRE>
<DL>
<DD>Port Developer.
</DD>
</DL>
<HR>
<A NAME="publisher"><!-- --></A>
<A NAME="publisher"><!-- --></A>
<H3>publisher</H3>
<PRE>
public std::wstring <B>publisher</B>;
</PRE>
<DL>
<DD>Publisher.
</DD>
</DL>
<HR>
<A NAME="region"><!-- --></A>
<A NAME="region"><!-- --></A>
<H3>region</H3>
<PRE>
public std::wstring <B>region</B>;
</PRE>
<DL>
<DD>Region.
</DD>
</DL>
<HR>
<A NAME="revision"><!-- --></A>
<A NAME="revision"><!-- --></A>
<H3>revision</H3>
<PRE>
public std::wstring <B>revision</B>;
</PRE>
<DL>
<DD>Revision.
</DD>
</DL>
<HR>
<A NAME="subClss"><!-- --></A>
<A NAME="subClss"><!-- --></A>
<H3>subClss</H3>
<PRE>
public std::wstring <B>subClss</B>;
</PRE>
<DL>
<DD>Sub-class.
</DD>
</DL>
<HR>
<A NAME="title"><!-- --></A>
<A NAME="title"><!-- --></A>
<H3>title</H3>
<PRE>
public std::wstring <B>title</B>;
</PRE>
<DL>
<DD>Game title.
</DD>
</DL>
<HR>
<BR>
<!-- ============ Constructor Detail ========== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#ccccff">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="Game()"><!-- --></A>
<A NAME="Game"><!-- --></A>
<H3>Game</H3>
<PRE>
public <B>Game</B>() throw();
</PRE>
<DL>
<DD></DD>
</DL>
<HR>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#eeeeff">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-overview-summary.html"><B>Overview</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-summary.html"><B>Project</B></a>&nbsp;</TD>
<TD BGCOLOR="navy"> <FONT COLOR="white">&nbsp;<B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="project-tree.html"><B>Tree</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-deprecated-list.html"><B>Deprecated</B></a>&nbsp;</TD>
<TD BGCOLOR="#eeeeff"> &nbsp;<a href="../../index-all.html"><B>Index</B></a>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Nestopia Core API</B></EM>
</TD>
</TR>
<TR>
<TD><FONT SIZE="-2">
<a href="../../index.html" target="_top"><B>FRAMES</B></a> &nbsp;
&nbsp;<a href="../api/Nes..Api..Cartridge..Profile..Game.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
</TR>
<TR>
<TD VALIGN="top"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
</BODY>
</HTML>