TorqueEngine
/
Torque2D
kopia lustrzana https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
							<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: Scripting Engine Callbacks</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="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="t2d-stylesheet-extra.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">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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="#typedef-members">Typedefs</a>  </div>
  <div class="headertitle"><div class="title">Scripting Engine Callbacks<div class="ingroups"><a class="el" href="group__ts_scripting.html">TorqueScript Bindings</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga3b1618755db8dcc0264d9adbd7944801" id="r_ga3b1618755db8dcc0264d9adbd7944801"><td class="memItemLeft" align="right" valign="top">typedef const char *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__console__callbacks.html#ga3b1618755db8dcc0264d9adbd7944801">StringCallback</a>) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td></tr>
<tr class="separator:ga3b1618755db8dcc0264d9adbd7944801"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga82b43b62df148a3ef01de7f8e8035d58" id="r_ga82b43b62df148a3ef01de7f8e8035d58"><td class="memItemLeft" align="right" valign="top">typedef S32(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__console__callbacks.html#ga82b43b62df148a3ef01de7f8e8035d58">IntCallback</a>) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td></tr>
<tr class="separator:ga82b43b62df148a3ef01de7f8e8035d58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacea87d3b8941b7ffcea991099d630d3a" id="r_gacea87d3b8941b7ffcea991099d630d3a"><td class="memItemLeft" align="right" valign="top">typedef F32(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__console__callbacks.html#gacea87d3b8941b7ffcea991099d630d3a">FloatCallback</a>) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td></tr>
<tr class="separator:gacea87d3b8941b7ffcea991099d630d3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae7bde538b4003b19dca7a9279b5f79b6" id="r_gae7bde538b4003b19dca7a9279b5f79b6"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__console__callbacks.html#gae7bde538b4003b19dca7a9279b5f79b6">VoidCallback</a>) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td></tr>
<tr class="separator:gae7bde538b4003b19dca7a9279b5f79b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3daa15ec563ddf01edfcf67f9515cf89" id="r_ga3daa15ec563ddf01edfcf67f9515cf89"><td class="memItemLeft" align="right" valign="top">typedef bool(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__console__callbacks.html#ga3daa15ec563ddf01edfcf67f9515cf89">BoolCallback</a>) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td></tr>
<tr class="separator:ga3daa15ec563ddf01edfcf67f9515cf89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga73457ddc96b5e0366926bfd1f6c762ce" id="r_ga73457ddc96b5e0366926bfd1f6c762ce"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__console__callbacks.html#ga73457ddc96b5e0366926bfd1f6c762ce">ConsumerCallback</a>) (<a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5">ConsoleLogEntry::Level</a> level, const char *consoleLine)</td></tr>
<tr class="separator:ga73457ddc96b5e0366926bfd1f6c762ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The scripting engine makes heavy use of callbacks to represent function exposed to the scripting language. StringCallback, IntCallback, FloatCallback, VoidCallback, and BoolCallback all represent exposed script functions returning different types.</p>
<p>ConsumerCallback is used with the function <a class="el" href="namespace_con.html#a648038e7c75ddf17ab4ca01ffa347d27">Con::addConsumer</a>; functions registered with <a class="el" href="namespace_con.html#a648038e7c75ddf17ab4ca01ffa347d27">Con::addConsumer</a> are called whenever something is outputted to the console. For instance, the <a class="el" href="class_telnet_console.html">TelnetConsole</a> registers itself with the console so it can echo the console over the network.</p>
<dl class="section note"><dt>Note</dt><dd>Callbacks to the scripting language - for instance, onExit(), which is a script function called when the engine is shutting down - are handled using <a class="el" href="namespace_con.html#a443c03c63fe60016f5bbfb99e1ccbee5">Con::executef()</a> and kin. </dd></dl>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga3daa15ec563ddf01edfcf67f9515cf89" name="ga3daa15ec563ddf01edfcf67f9515cf89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3daa15ec563ddf01edfcf67f9515cf89">&#9670;&#160;</a></span>BoolCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef bool(* BoolCallback) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga73457ddc96b5e0366926bfd1f6c762ce" name="ga73457ddc96b5e0366926bfd1f6c762ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga73457ddc96b5e0366926bfd1f6c762ce">&#9670;&#160;</a></span>ConsumerCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* ConsumerCallback) (<a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5">ConsoleLogEntry::Level</a> level, const char *consoleLine)</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="gacea87d3b8941b7ffcea991099d630d3a" name="gacea87d3b8941b7ffcea991099d630d3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacea87d3b8941b7ffcea991099d630d3a">&#9670;&#160;</a></span>FloatCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef F32(* FloatCallback) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga82b43b62df148a3ef01de7f8e8035d58" name="ga82b43b62df148a3ef01de7f8e8035d58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga82b43b62df148a3ef01de7f8e8035d58">&#9670;&#160;</a></span>IntCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef S32(* IntCallback) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="ga3b1618755db8dcc0264d9adbd7944801" name="ga3b1618755db8dcc0264d9adbd7944801"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3b1618755db8dcc0264d9adbd7944801">&#9670;&#160;</a></span>StringCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef const char *(* StringCallback) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a id="gae7bde538b4003b19dca7a9279b5f79b6" name="gae7bde538b4003b19dca7a9279b5f79b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae7bde538b4003b19dca7a9279b5f79b6">&#9670;&#160;</a></span>VoidCallback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* VoidCallback) (<a class="el" href="class_sim_object.html">SimObject</a> *obj, S32 argc, const char *argv[])</td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>