192 lines
11 KiB
HTML
192 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.7"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>godot-cpp-utils: utils::GameMode 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="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome-sidebar-only.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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">godot-cpp-utils
|
|
</div>
|
|
<div id="projectbrief">A collection of utility classes, functions and macros for use with Godot and GDExtension.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.7 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.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>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="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.svg" 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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('classutils_1_1GameMode.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</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)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classutils_1_1GameMode-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">utils::GameMode Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Stores session-relevant data.
|
|
<a href="classutils_1_1GameMode.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="game__mode_8hpp_source.html">game_mode.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for utils::GameMode:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classutils_1_1GameMode.png" alt=""/>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aa1b190a57e4106951a559301665739ec"><td class="memItemLeft" align="right" valign="top"><a id="aa1b190a57e4106951a559301665739ec" name="aa1b190a57e4106951a559301665739ec"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>_begin</b> ()</td></tr>
|
|
<tr class="memdesc:aa1b190a57e4106951a559301665739ec"><td class="mdescLeft"> </td><td class="mdescRight">Called when the match begins. <br /></td></tr>
|
|
<tr class="separator:aa1b190a57e4106951a559301665739ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae69ff36bf1c3f60fad279e9991ca2d82"><td class="memItemLeft" align="right" valign="top"><a id="ae69ff36bf1c3f60fad279e9991ca2d82" name="ae69ff36bf1c3f60fad279e9991ca2d82"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>_end</b> ()</td></tr>
|
|
<tr class="memdesc:ae69ff36bf1c3f60fad279e9991ca2d82"><td class="mdescLeft"> </td><td class="mdescRight">Called when the match is ending. <br /></td></tr>
|
|
<tr class="separator:ae69ff36bf1c3f60fad279e9991ca2d82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaeddac05bf7ddc1ea1a2b55c55ed5015"><td class="memItemLeft" align="right" valign="top"><a id="aaeddac05bf7ddc1ea1a2b55c55ed5015" name="aaeddac05bf7ddc1ea1a2b55c55ed5015"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>set_player_scene</b> (gd::Ref< gd::PackedScene > scene)</td></tr>
|
|
<tr class="separator:aaeddac05bf7ddc1ea1a2b55c55ed5015"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a16d63e869318fd0f09b230d038ec519d"><td class="memItemLeft" align="right" valign="top"><a id="a16d63e869318fd0f09b230d038ec519d" name="a16d63e869318fd0f09b230d038ec519d"></a>
|
|
gd::Ref< gd::PackedScene > </td><td class="memItemRight" valign="bottom"><b>get_player_scene</b> () const</td></tr>
|
|
<tr class="separator:a16d63e869318fd0f09b230d038ec519d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:ae69a33c169e648bbbea6cb76112962dd"><td class="memItemLeft" align="right" valign="top"><a id="ae69a33c169e648bbbea6cb76112962dd" name="ae69a33c169e648bbbea6cb76112962dd"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>GDCLASS</b> (<a class="el" href="classutils_1_1GameMode.html">GameMode</a>, gd::Resource)</td></tr>
|
|
<tr class="separator:ae69a33c169e648bbbea6cb76112962dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a739b647a3d4aabc4c994ba35d7a3ed5f"><td class="memItemLeft" align="right" valign="top"><a id="a739b647a3d4aabc4c994ba35d7a3ed5f" name="a739b647a3d4aabc4c994ba35d7a3ed5f"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>_bind_methods</b> ()</td></tr>
|
|
<tr class="separator:a739b647a3d4aabc4c994ba35d7a3ed5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a7e7258b38b17cde56ba9b130bbaf9908"><td class="memItemLeft" align="right" valign="top"><a id="a7e7258b38b17cde56ba9b130bbaf9908" name="a7e7258b38b17cde56ba9b130bbaf9908"></a>
|
|
gd::Ref< gd::PackedScene > </td><td class="memItemRight" valign="bottom"><b>player_scene</b> {}</td></tr>
|
|
<tr class="memdesc:a7e7258b38b17cde56ba9b130bbaf9908"><td class="mdescLeft"> </td><td class="mdescRight">The scene to instantiate when spawning a player. <br /></td></tr>
|
|
<tr class="separator:a7e7258b38b17cde56ba9b130bbaf9908"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Stores session-relevant data. </p>
|
|
<p>Contains any data that is only needed for the duration of the current session/match. Use <a class="el" href="classutils_1_1GameState.html" title="Parent class for saved game state.">GameState</a> instead if you want data to be saved between sessions. Will be destroyed when a level is loaded that does not match the same game mode class. </p>
|
|
</div><hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="game__mode_8hpp_source.html">game_mode.hpp</a></li>
|
|
<li>game_mode.cpp</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"><b>utils</b></li><li class="navelem"><a class="el" href="classutils_1_1GameMode.html">GameMode</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|