TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
							<!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>TorqueScript Reference: Message Queue (Dispatcher)</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="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">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Message Queue (Dispatcher)<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga3af09e5d706d7ee5df49ea6e50169f6f" id="r_ga3af09e5d706d7ee5df49ea6e50169f6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageQueueFunctions.html#ga3af09e5d706d7ee5df49ea6e50169f6f">dispatchMessage</a> (queueName, event, data)</td></tr>
<tr class="separator:ga3af09e5d706d7ee5df49ea6e50169f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga859440234824c5f62086d1ec9260f3c1" id="r_ga859440234824c5f62086d1ec9260f3c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageQueueFunctions.html#ga859440234824c5f62086d1ec9260f3c1">dispatchMessageObject</a> (queueName, message)</td></tr>
<tr class="separator:ga859440234824c5f62086d1ec9260f3c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaecc153aed30de58eb7a5d7a00b9b7478" id="r_gaecc153aed30de58eb7a5d7a00b9b7478"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageQueueFunctions.html#gaecc153aed30de58eb7a5d7a00b9b7478">isQueueRegistered</a> (queueName)</td></tr>
<tr class="separator:gaecc153aed30de58eb7a5d7a00b9b7478"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab2e766f900eb4018d86d80a4ace6fda9" id="r_gab2e766f900eb4018d86d80a4ace6fda9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageQueueFunctions.html#gab2e766f900eb4018d86d80a4ace6fda9">registerMessageListener</a> (queueName, listener)</td></tr>
<tr class="separator:gab2e766f900eb4018d86d80a4ace6fda9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9024bb2be44716e206795a307c8fded9" id="r_ga9024bb2be44716e206795a307c8fded9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageQueueFunctions.html#ga9024bb2be44716e206795a307c8fded9">registerMessageQueue</a> (queueName)</td></tr>
<tr class="separator:ga9024bb2be44716e206795a307c8fded9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ee7bd71ad6e7edd10f0ca922b464866" id="r_ga8ee7bd71ad6e7edd10f0ca922b464866"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageQueueFunctions.html#ga8ee7bd71ad6e7edd10f0ca922b464866">unregisterMessageListener</a> (queueName, listener)</td></tr>
<tr class="separator:ga8ee7bd71ad6e7edd10f0ca922b464866"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5701312715cd4dcc236b671a24dfaa6b" id="r_ga5701312715cd4dcc236b671a24dfaa6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageQueueFunctions.html#ga5701312715cd4dcc236b671a24dfaa6b">unregisterMessageQueue</a> (queueName)</td></tr>
<tr class="separator:ga5701312715cd4dcc236b671a24dfaa6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga3af09e5d706d7ee5df49ea6e50169f6f" name="ga3af09e5d706d7ee5df49ea6e50169f6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3af09e5d706d7ee5df49ea6e50169f6f">&#9670;&#160;</a></span>dispatchMessage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> dispatchMessage </td>
          <td>(</td>
          <td class="paramtype">queueName&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">event&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">data&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Dispatches a message to given message queue </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queueName</td><td>The queue to dispatch to </td></tr>
    <tr><td class="paramname">event</td><td>The message you are passing </td></tr>
    <tr><td class="paramname">data</td><td>Data </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true on success and false otherwise </dd></dl>

</div>
</div>
<a id="ga859440234824c5f62086d1ec9260f3c1" name="ga859440234824c5f62086d1ec9260f3c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga859440234824c5f62086d1ec9260f3c1">&#9670;&#160;</a></span>dispatchMessageObject()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> dispatchMessageObject </td>
          <td>(</td>
          <td class="paramtype">queueName&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">message&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Dispatches a message object to the given queue </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queueName</td><td>The name of the queue to dispatch object to </td></tr>
    <tr><td class="paramname">message</td><td>The message object </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaecc153aed30de58eb7a5d7a00b9b7478" name="gaecc153aed30de58eb7a5d7a00b9b7478"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaecc153aed30de58eb7a5d7a00b9b7478">&#9670;&#160;</a></span>isQueueRegistered()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isQueueRegistered </td>
          <td>(</td>
          <td class="paramtype">queueName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Checks whether message queue is registered </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queueName</td><td>The name of the queue to check </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if registered and false if not </dd></dl>

</div>
</div>
<a id="gab2e766f900eb4018d86d80a4ace6fda9" name="gab2e766f900eb4018d86d80a4ace6fda9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab2e766f900eb4018d86d80a4ace6fda9">&#9670;&#160;</a></span>registerMessageListener()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> registerMessageListener </td>
          <td>(</td>
          <td class="paramtype">queueName&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">listener&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Registers a message listener on a message queue </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queueName</td><td>The name of the message queue </td></tr>
    <tr><td class="paramname">listener</td><td>The name of the listener to register </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true on success, and false otherwise (probably not found) </dd></dl>

</div>
</div>
<a id="ga9024bb2be44716e206795a307c8fded9" name="ga9024bb2be44716e206795a307c8fded9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9024bb2be44716e206795a307c8fded9">&#9670;&#160;</a></span>registerMessageQueue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> registerMessageQueue </td>
          <td>(</td>
          <td class="paramtype">queueName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Registers given message queue </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queueName</td><td>The name of the message queue </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No Return Value </dd></dl>

</div>
</div>
<a id="ga8ee7bd71ad6e7edd10f0ca922b464866" name="ga8ee7bd71ad6e7edd10f0ca922b464866"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ee7bd71ad6e7edd10f0ca922b464866">&#9670;&#160;</a></span>unregisterMessageListener()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> unregisterMessageListener </td>
          <td>(</td>
          <td class="paramtype">queueName&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">listener&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Unregisters the message listener on given message queue </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">queueName</td><td>The name of the message queue </td></tr>
    <tr><td class="paramname">listener</td><td>The name of the listener to unregister </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No Return Value </dd></dl>

</div>
</div>
<a id="ga5701312715cd4dcc236b671a24dfaa6b" name="ga5701312715cd4dcc236b671a24dfaa6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5701312715cd4dcc236b671a24dfaa6b">&#9670;&#160;</a></span>unregisterMessageQueue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> unregisterMessageQueue </td>
          <td>(</td>
          <td class="paramtype">queueName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Unregisters given message queue </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">The</td><td>name of the message queue </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No Return Value </dd></dl>

</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>