You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
347 lines
21 KiB
HTML
347 lines
21 KiB
HTML
2 years ago
|
<!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"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
||
|
|
<title>Otter: Otter.Session Class Reference</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(initResizable);
|
||
|
|
$(window).load(resizeHeight);
|
||
|
|
</script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||
|
|
</script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectlogo"><img alt="Logo" src="otterlogosmall.png"/></td>
|
||
|
|
<td style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">Otter
|
||
|
|
 <span id="projectnumber">0.9.8.91</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">2d Game Development Framework based on SFML.Net</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="namespaces.html"><span>Packages</span></a></li>
|
||
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li>
|
||
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
|
|
<span class="left">
|
||
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
alt=""/>
|
||
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
|
|
</span><span class="right">
|
||
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="navrow2" class="tabs2">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</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><!-- top -->
|
||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
|
|
<div id="nav-tree">
|
||
|
|
<div id="nav-tree-contents">
|
||
|
|
<div id="nav-sync" class="sync"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
||
|
|
class="ui-resizable-handle">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function(){initNavTree('class_otter_1_1_session.html','');});
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Properties</a></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="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
||
|
|
<a href="#properties">Properties</a> |
|
||
|
|
<a href="class_otter_1_1_session-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Otter.Session Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class that represents a player session. Use this for maintaining and using information about a player. For example a two player game might have two sessions, one for each player, each with their own controls configured and save data.
|
||
|
|
<a href="class_otter_1_1_session.html#details">More...</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a6fc778fb3d82977440d8b4f2bd7713ce"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_session.html#a6fc778fb3d82977440d8b4f2bd7713ce">GetController< T ></a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a6fc778fb3d82977440d8b4f2bd7713ce"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <a class="el" href="class_otter_1_1_controller.html" title="Component representing a group of Button and Axis classes. The controller updates all buttons and axe...">Controller</a> as a specific type of <a class="el" href="class_otter_1_1_controller.html" title="Component representing a group of Button and Axis classes. The controller updates all buttons and axe...">Controller</a>. <a href="#a6fc778fb3d82977440d8b4f2bd7713ce">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6fc778fb3d82977440d8b4f2bd7713ce"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aba93ed7ef24e9ce2b4332e84e697e0cb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_session.html#aba93ed7ef24e9ce2b4332e84e697e0cb">Session</a> (<a class="el" href="class_otter_1_1_game.html">Game</a> game, string name)</td></tr>
|
||
|
|
<tr class="memdesc:aba93ed7ef24e9ce2b4332e84e697e0cb"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a>. <a href="#aba93ed7ef24e9ce2b4332e84e697e0cb">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aba93ed7ef24e9ce2b4332e84e697e0cb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||
|
|
Static Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a0d7c7f4ce80a44fdadceafbcca00fa87"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_otter_1_1_session.html">Session</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_session.html#a0d7c7f4ce80a44fdadceafbcca00fa87">Create</a> (string name)</td></tr>
|
||
|
|
<tr class="memdesc:a0d7c7f4ce80a44fdadceafbcca00fa87"><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a> using the current <a class="el" href="class_otter_1_1_game.html#a9f00ae7b894cd7b30e3604afe44a3750" title="A reference to the active Game instance. ">Game.Instance</a>. <a href="#a0d7c7f4ce80a44fdadceafbcca00fa87">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a0d7c7f4ce80a44fdadceafbcca00fa87"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad5f4e9b553f64ab6ee9eb1225e2d2831"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5f4e9b553f64ab6ee9eb1225e2d2831"></a>
|
||
|
|
static <a class="el" href="class_otter_1_1_session.html">Session</a> </td><td class="memItemRight" valign="bottom"><b>Create</b> (Enum name)</td></tr>
|
||
|
|
<tr class="separator:ad5f4e9b553f64ab6ee9eb1225e2d2831"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
||
|
|
Public Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a4123e2680d2ebb30bc2c7a82b95aeb62"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_session.html#a4123e2680d2ebb30bc2c7a82b95aeb62">Name</a> = ""</td></tr>
|
||
|
|
<tr class="memdesc:a4123e2680d2ebb30bc2c7a82b95aeb62"><td class="mdescLeft"> </td><td class="mdescRight">The name of this <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a>. This is important as it will determine the name of save data files and you can also find a session by name. <a href="#a4123e2680d2ebb30bc2c7a82b95aeb62">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a4123e2680d2ebb30bc2c7a82b95aeb62"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6121a049a62fa8263e527c59238687c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_controller.html">Controller</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_session.html#a6121a049a62fa8263e527c59238687c9">Controller</a> = new <a class="el" href="class_otter_1_1_controller.html">Controller</a>()</td></tr>
|
||
|
|
<tr class="memdesc:a6121a049a62fa8263e527c59238687c9"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="class_otter_1_1_controller.html" title="Component representing a group of Button and Axis classes. The controller updates all buttons and axe...">Controller</a> to use for this <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a>. <a href="#a6121a049a62fa8263e527c59238687c9">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6121a049a62fa8263e527c59238687c9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
|
||
|
|
Properties</h2></td></tr>
|
||
|
|
<tr class="memitem:a345b553d5291ea507dd547055d86d4b3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_session.html#a345b553d5291ea507dd547055d86d4b3">Id</a><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="memdesc:a345b553d5291ea507dd547055d86d4b3"><td class="mdescLeft"> </td><td class="mdescRight">The Id of this session in the <a class="el" href="class_otter_1_1_game.html" title="ᶜ(ᵔᴥᵔ)ᵓ Core class Otter. Create a Game, and then use Game.Start(); to run it. ">Game</a>. <a href="#a345b553d5291ea507dd547055d86d4b3">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a345b553d5291ea507dd547055d86d4b3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2ee11b9310487ad4027401e69dea57c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2ee11b9310487ad4027401e69dea57c3"></a>
|
||
|
|
<a class="el" href="class_otter_1_1_data_saver.html">DataSaver</a> </td><td class="memItemRight" valign="bottom"><b>Data</b><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="separator:a2ee11b9310487ad4027401e69dea57c3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa1722939df1ff73281fa5df7864423c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_game.html">Game</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_session.html#aa1722939df1ff73281fa5df7864423c2">Game</a><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="memdesc:aa1722939df1ff73281fa5df7864423c2"><td class="mdescLeft"> </td><td class="mdescRight">The game that manages this session. <a href="#aa1722939df1ff73281fa5df7864423c2">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa1722939df1ff73281fa5df7864423c2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Class that represents a player session. Use this for maintaining and using information about a player. For example a two player game might have two sessions, one for each player, each with their own controls configured and save data. </p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a class="anchor" id="aba93ed7ef24e9ce2b4332e84e697e0cb"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Otter.Session.Session </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype"><a class="el" href="class_otter_1_1_game.html">Game</a> </td>
|
||
|
|
<td class="paramname"><em>game</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>name</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Create a new <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a>. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">game</td><td>The <a class="el" href="class_otter_1_1_game.html" title="ᶜ(ᵔᴥᵔ)ᵓ Core class Otter. Create a Game, and then use Game.Start(); to run it. ">Game</a> that the session is tied to.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a0d7c7f4ce80a44fdadceafbcca00fa87"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static <a class="el" href="class_otter_1_1_session.html">Session</a> Otter.Session.Create </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Create a new <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a> using the current <a class="el" href="class_otter_1_1_game.html#a9f00ae7b894cd7b30e3604afe44a3750" title="A reference to the active Game instance. ">Game.Instance</a>. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6fc778fb3d82977440d8b4f2bd7713ce"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">T Otter.Session.GetController< T > </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets the <a class="el" href="class_otter_1_1_controller.html" title="Component representing a group of Button and Axis classes. The controller updates all buttons and axe...">Controller</a> as a specific type of <a class="el" href="class_otter_1_1_controller.html" title="Component representing a group of Button and Axis classes. The controller updates all buttons and axe...">Controller</a>. </p>
|
||
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||
|
|
<table class="tparams">
|
||
|
|
<tr><td class="paramname">T</td><td>The type of <a class="el" href="class_otter_1_1_controller.html" title="Component representing a group of Button and Axis classes. The controller updates all buttons and axe...">Controller</a>.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_controller.html" title="Component representing a group of Button and Axis classes. The controller updates all buttons and axe...">Controller</a> as type T.</dd></dl>
|
||
|
|
<div class="typeconstraint">
|
||
|
|
<dl><dt><b>Type Constraints</b><dt><dd>
|
||
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
||
|
|
<tr><td valign="top"><em>T</em></td><td> :</td><td valign="top"><em>Controller</em></td><td> </td></tr>
|
||
|
|
</table>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a class="anchor" id="a6121a049a62fa8263e527c59238687c9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_controller.html">Controller</a> Otter.Session.Controller = new <a class="el" href="class_otter_1_1_controller.html">Controller</a>()</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The <a class="el" href="class_otter_1_1_controller.html" title="Component representing a group of Button and Axis classes. The controller updates all buttons and axe...">Controller</a> to use for this <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a4123e2680d2ebb30bc2c7a82b95aeb62"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.Session.Name = ""</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The name of this <a class="el" href="class_otter_1_1_session.html" title="Class that represents a player session. Use this for maintaining and using information about a player...">Session</a>. This is important as it will determine the name of save data files and you can also find a session by name. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
|
<a class="anchor" id="aa1722939df1ff73281fa5df7864423c2"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_game.html">Game</a> Otter.Session.Game</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The game that manages this session. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a345b553d5291ea507dd547055d86d4b3"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.Session.Id</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The Id of this session in the <a class="el" href="class_otter_1_1_game.html" title="ᶜ(ᵔᴥᵔ)ᵓ Core class Otter. Create a Game, and then use Game.Start(); to run it. ">Game</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Core/Session.cs</li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="namespace_otter.html">Otter</a></li><li class="navelem"><a class="el" href="class_otter_1_1_session.html">Session</a></li>
|
||
|
|
<li class="footer">Generated on Thu May 12 2016 18:16:52 for Otter by
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|