mirror of
https://github.com/Nimac0/SDL_Minigame
synced 2026-01-12 07:53:43 +00:00
247 lines
13 KiB
HTML
247 lines
13 KiB
HTML
<!-- HTML header for doxygen 1.10.0-->
|
|
<!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.13.2" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<title>VEGO-Engine: DataComponent 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeDarkModeToggle.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeParagraphLink.init()
|
|
</script>
|
|
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
</script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.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>
|
|
<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"/>
|
|
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
|
|
<link href="custom.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">VEGO-Engine
|
|
<span id="projectnumber"> 0.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></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 */
|
|
$(function(){initNavTree('classDataComponent.html',''); initResizable(true); });
|
|
/* @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="classDataComponent-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">DataComponent Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classDataComponent.html" title="DataComponent class to centrally store data about an entity such as stats.">DataComponent</a> class to centrally store data about an entity such as stats.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="DataComponent_8h_source.html">DataComponent.h</a>></code></p>
|
|
<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:a1d9bc3a1c818e646be5d093119edeb01" id="r_a1d9bc3a1c818e646be5d093119edeb01"><td class="memItemLeft" align="right" valign="top"><a id="a1d9bc3a1c818e646be5d093119edeb01" name="a1d9bc3a1c818e646be5d093119edeb01"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>DataComponent</b> ()</td></tr>
|
|
<tr class="memdesc:a1d9bc3a1c818e646be5d093119edeb01"><td class="mdescLeft"> </td><td class="mdescRight">The data component only has a default constructor. <br /></td></tr>
|
|
<tr class="separator:a1d9bc3a1c818e646be5d093119edeb01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dd53c6cb91e572090c2b6853881f8c9" id="r_a1dd53c6cb91e572090c2b6853881f8c9"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a1dd53c6cb91e572090c2b6853881f8c9"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a1dd53c6cb91e572090c2b6853881f8c9">setEntry</a> (const std::string &key, const T &value)</td></tr>
|
|
<tr class="memdesc:a1dd53c6cb91e572090c2b6853881f8c9"><td class="mdescLeft"> </td><td class="mdescRight">Set a key-value pair of any type in the data map. <br /></td></tr>
|
|
<tr class="separator:a1dd53c6cb91e572090c2b6853881f8c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e71b0bec578a208eb716676e3ccf667" id="r_a6e71b0bec578a208eb716676e3ccf667"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a6e71b0bec578a208eb716676e3ccf667"><td class="memTemplItemLeft" align="right" valign="top">std::optional< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a6e71b0bec578a208eb716676e3ccf667">getEntry</a> (std::string key) const</td></tr>
|
|
<tr class="memdesc:a6e71b0bec578a208eb716676e3ccf667"><td class="mdescLeft"> </td><td class="mdescRight">Get a value of type T from the data map. <br /></td></tr>
|
|
<tr class="separator:a6e71b0bec578a208eb716676e3ccf667"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classDataComponent.html" title="DataComponent class to centrally store data about an entity such as stats.">DataComponent</a> class to centrally store data about an entity such as stats. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a6e71b0bec578a208eb716676e3ccf667" name="a6e71b0bec578a208eb716676e3ccf667"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e71b0bec578a208eb716676e3ccf667">◆ </a></span>getEntry()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::optional< T > DataComponent::getEntry </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>key</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a value of type T from the data map. </p>
|
|
<p>e.g. </p><div class="fragment"><div class="line"><a class="code hl_function" href="#a6e71b0bec578a208eb716676e3ccf667">getEntry<int></a>(<span class="stringliteral">"speed"</span>).value();</div>
|
|
<div class="ttc" id="aclassDataComponent_html_a6e71b0bec578a208eb716676e3ccf667"><div class="ttname"><a href="#a6e71b0bec578a208eb716676e3ccf667">DataComponent::getEntry</a></div><div class="ttdeci">std::optional< T > getEntry(std::string key) const</div><div class="ttdoc">Get a value of type T from the data map.</div><div class="ttdef"><b>Definition</b> DataComponent.h:33</div></div>
|
|
</div><!-- fragment --><p> in this case the key is "speed" and the value is returned as an integer</p>
|
|
<p>the value() or value_or() is NEEDED to handle the optional return type </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>The name to retrieve the value from </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>An optional of type T containing the value if it exists and matches in typeid, otherwise std::nullopt </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1dd53c6cb91e572090c2b6853881f8c9" name="a1dd53c6cb91e572090c2b6853881f8c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1dd53c6cb91e572090c2b6853881f8c9">◆ </a></span>setEntry()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void DataComponent::setEntry </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>key</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const T &</td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a key-value pair of any type in the data map. </p>
|
|
<p>e.g. </p><div class="fragment"><div class="line"><a class="code hl_function" href="#a1dd53c6cb91e572090c2b6853881f8c9">setEntry</a>(<span class="stringliteral">"speed"</span>, 180);</div>
|
|
<div class="ttc" id="aclassDataComponent_html_a1dd53c6cb91e572090c2b6853881f8c9"><div class="ttname"><a href="#a1dd53c6cb91e572090c2b6853881f8c9">DataComponent::setEntry</a></div><div class="ttdeci">void setEntry(const std::string &key, const T &value)</div><div class="ttdoc">Set a key-value pair of any type in the data map.</div><div class="ttdef"><b>Definition</b> DataComponent.h:23</div></div>
|
|
</div><!-- fragment --><p> in this case the key is "speed" and the value is set to an integer of 180 </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>The name to store the value under </td></tr>
|
|
<tr><td class="paramname">value</td><td>The value to store of type T </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/<a class="el" href="DataComponent_8h_source.html">DataComponent.h</a></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="classDataComponent.html">DataComponent</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.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|