group__cpp__kodi__addon__game___cheat_operations.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">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kodi Development: 6. Cheat operations</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</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="kodi-dev.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kodi Development
   &#160;<span id="projectnumber">20.0</span>
   </div>
   <div id="projectbrief">for Binary and Script based Add-Ons</div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.svg"
               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.svg" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__cpp__kodi__addon__game___cheat_operations.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">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">Modules</a>  </div>
  <div class="headertitle">
<div class="title">6. Cheat operations<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> &raquo; <a class="el" href="group__cpp__kodi__addon.html">Interface - kodi::addon</a> &raquo; <a class="el" href="group__cpp__kodi__addon__instances.html">Addon type instances</a> &raquo; <a class="el" href="group__cpp__kodi__addon__game.html">Game</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>Cheat operations</b> </p>
<hr  />
<p><b>Cheat operation parts in interface:</b><br  />
 Copy this to your project and extend with your parts or leave functions complete away where not used or supported.</p>
<p><em>Header parts:</em> </p><div class="fragment"><div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___cheat_operations.html#gad9ed70e54b8d8fd85f2f3c6aafbd19b6">CheatReset</a>() <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___cheat_operations.html#gaded225dac331a0351f1fc1f3d5ed43eb">GetMemory</a>(<a class="code" href="group__cpp__kodi__addon__game___defs___game_types.html#gaf52d501cc2ba9de915c80313887b2a87">GAME_MEMORY</a> type, uint8_t*&amp; data, <span class="keywordtype">size_t</span>&amp; size) <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___cheat_operations.html#gaf8f9d20efdc34b53355d778c48afffc2">SetCheat</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> enabled, <span class="keyword">const</span> std::string&amp; code) <span class="keyword">override</span>;</div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___cheat_operations_html_gad9ed70e54b8d8fd85f2f3c6aafbd19b6"><div class="ttname"><a href="group__cpp__kodi__addon__game___cheat_operations.html#gad9ed70e54b8d8fd85f2f3c6aafbd19b6">kodi::addon::CInstanceGame::CheatReset</a></div><div class="ttdeci">virtual GAME_ERROR CheatReset()</div><div class="ttdoc">Reset the cheat system.</div><div class="ttdef"><b>Definition:</b> Game.h:916</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___cheat_operations_html_gaded225dac331a0351f1fc1f3d5ed43eb"><div class="ttname"><a href="group__cpp__kodi__addon__game___cheat_operations.html#gaded225dac331a0351f1fc1f3d5ed43eb">kodi::addon::CInstanceGame::GetMemory</a></div><div class="ttdeci">virtual GAME_ERROR GetMemory(GAME_MEMORY type, uint8_t *&amp;data, size_t &amp;size)</div><div class="ttdoc">Get a region of memory.</div><div class="ttdef"><b>Definition:</b> Game.h:931</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___cheat_operations_html_gaf8f9d20efdc34b53355d778c48afffc2"><div class="ttname"><a href="group__cpp__kodi__addon__game___cheat_operations.html#gaf8f9d20efdc34b53355d778c48afffc2">kodi::addon::CInstanceGame::SetCheat</a></div><div class="ttdeci">virtual GAME_ERROR SetCheat(unsigned int index, bool enabled, const std::string &amp;code)</div><div class="ttdoc">Set a cheat code.</div><div class="ttdef"><b>Definition:</b> Game.h:946</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs___game_types_html_gaf52d501cc2ba9de915c80313887b2a87"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs___game_types.html#gaf52d501cc2ba9de915c80313887b2a87">GAME_MEMORY</a></div><div class="ttdeci">GAME_MEMORY</div><div class="ttdoc">Game Memory</div><div class="ttdef"><b>Definition:</b> game.h:600</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs_html_gad0fb9f502cf7b3a84f8edb0dc6cbd6ef"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a></div><div class="ttdeci">GAME_ERROR</div><div class="ttdoc">Game add-on error codes</div><div class="ttdef"><b>Definition:</b> game.h:34</div></div>
</div><!-- fragment --><p> <em>Source parts:</em> </p><div class="fragment"><div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::CheatReset()</div>
<div class="line">{</div>
<div class="line">  <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::GetMemory(<a class="code" href="group__cpp__kodi__addon__game___defs___game_types.html#gaf52d501cc2ba9de915c80313887b2a87">GAME_MEMORY</a> type, uint8_t*&amp; data, <span class="keywordtype">size_t</span>&amp; size)</div>
<div class="line">{</div>
<div class="line">  <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::SetCheat(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> index, <span class="keywordtype">bool</span> enabled, <span class="keyword">const</span> std::string&amp; code)</div>
<div class="line">{</div>
<div class="line">  <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs_html_ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a></div><div class="ttdeci">@ GAME_ERROR_NOT_IMPLEMENTED</div><div class="ttdoc">the method that the frontend called is not implemented</div><div class="ttdef"><b>Definition:</b> game.h:42</div></div>
</div><!-- fragment --> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__cpp__kodi__addon__game___cheat_operations__header__addon__auto__check"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__game___cheat_operations__header__addon__auto__check.html">Group header include</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__cpp__kodi__addon__game___cheat_operations__source__addon__auto__check"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__game___cheat_operations__source__addon__auto__check.html">Group source include</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad9ed70e54b8d8fd85f2f3c6aafbd19b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad9ed70e54b8d8fd85f2f3c6aafbd19b6">&#9670;&nbsp;</a></span>CheatReset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CheatReset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reset the cheat system. </p>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the cheat system was reset </dd></dl>

</div>
</div>
<a id="gaded225dac331a0351f1fc1f3d5ed43eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaded225dac331a0351f1fc1f3d5ed43eb">&#9670;&nbsp;</a></span>GetMemory()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> GetMemory </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__cpp__kodi__addon__game___defs___game_types.html#gaf52d501cc2ba9de915c80313887b2a87">GAME_MEMORY</a>&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&amp;&#160;</td>
          <td class="paramname"><em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t &amp;&#160;</td>
          <td class="paramname"><em>size</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get a region of memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of memory to retrieve </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Set to the region of memory; must remain valid until <a class="el" href="group__cpp__kodi__addon__game___operation.html#ga03d0df14967c92b5ae74ab7e322f74ba" title="Unload the current game.">UnloadGame()</a> is called </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Set to the size of the region of memory</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if data was set to a valid buffer </dd></dl>

</div>
</div>
<a id="gaf8f9d20efdc34b53355d778c48afffc2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf8f9d20efdc34b53355d778c48afffc2">&#9670;&nbsp;</a></span>SetCheat()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> SetCheat </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>index</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enabled</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>code</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set a cheat code. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td></td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">enabled</td><td></td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">code</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the cheat was set </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <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.1 </li>
  </ul>
</div>
</body>
</html>