| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.3.1"/>
- <title>TorqueScript Reference: BehaviorComponent 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="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 style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></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 class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="classBehaviorComponent-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">BehaviorComponent Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Inherits <a class="el" href="classDynamicConsoleMethodComponent.html">DynamicConsoleMethodComponent</a>.</p>
- <p>Inherited by <a class="el" href="classScene.html">Scene</a>, and <a class="el" href="classSceneObject.html">SceneObject</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a191700f13d3e43312e84217f6b69f9ee"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a191700f13d3e43312e84217f6b69f9ee">addBehavior</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi)</td></tr>
- <tr class="separator:a191700f13d3e43312e84217f6b69f9ee"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a75cf9aca6491d3442a30255e50929c07"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a75cf9aca6491d3442a30255e50929c07">clearBehaviors</a> ()</td></tr>
- <tr class="separator:a75cf9aca6491d3442a30255e50929c07"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a24eff746b90533b916b2b3aa0f27d8f3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a24eff746b90533b916b2b3aa0f27d8f3">connect</a> (outputBehavior, inputBehavior, outputName, inputName)</td></tr>
- <tr class="separator:a24eff746b90533b916b2b3aa0f27d8f3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5021752e2f48900d3a7cb3ffdab1f7a9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a5021752e2f48900d3a7cb3ffdab1f7a9">disconnect</a> (outputBehavior, inputBehavior, outputName, inputName)</td></tr>
- <tr class="separator:a5021752e2f48900d3a7cb3ffdab1f7a9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7d996d1d925e53a122b1f3cf57f5abce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a7d996d1d925e53a122b1f3cf57f5abce">getBehavior</a> (string BehaviorTemplateName)</td></tr>
- <tr class="separator:a7d996d1d925e53a122b1f3cf57f5abce"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aed9520e4500354682950371b062d974d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#aed9520e4500354682950371b062d974d">getBehaviorByIndex</a> (int index)</td></tr>
- <tr class="separator:aed9520e4500354682950371b062d974d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88ee692a8690fd9de215f7ece20623b5"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a88ee692a8690fd9de215f7ece20623b5">getBehaviorConnection</a> (outputBehavior, outputName, connectionIndex)</td></tr>
- <tr class="separator:a88ee692a8690fd9de215f7ece20623b5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad50805919d99adf0f65c6b94bd9e5dfd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ad50805919d99adf0f65c6b94bd9e5dfd">getBehaviorConnectionCount</a> (outputBehavior, outputName)</td></tr>
- <tr class="separator:ad50805919d99adf0f65c6b94bd9e5dfd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab6dc6b3eb09a1d6f8f4c8ec9a4108d17"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ab6dc6b3eb09a1d6f8f4c8ec9a4108d17">getBehaviorCount</a> ()</td></tr>
- <tr class="separator:ab6dc6b3eb09a1d6f8f4c8ec9a4108d17"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae81bec76a6acbc925694c5a050198609"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ae81bec76a6acbc925694c5a050198609">raise</a> (outputBehavior, outputName,[deltaTime])</td></tr>
- <tr class="separator:ae81bec76a6acbc925694c5a050198609"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5f71e751ee5ab7b8ea61e31a77983f4b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a5f71e751ee5ab7b8ea61e31a77983f4b">removeBehavior</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi,[bool deleteBehavior=true])</td></tr>
- <tr class="separator:a5f71e751ee5ab7b8ea61e31a77983f4b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a753fb3072cd4e96d997755452bc13071"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a753fb3072cd4e96d997755452bc13071">reOrder</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> inst,[int desiredIndex=0])</td></tr>
- <tr class="separator:a753fb3072cd4e96d997755452bc13071"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a191700f13d3e43312e84217f6b69f9ee"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool addBehavior </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> </td>
- <td class="paramname"><em>bi</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add a behavior to the object </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">bi</td><td>The behavior instance to add </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether or not the behavior was successfully added </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a75cf9aca6491d3442a30255e50929c07"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void clearBehaviors </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clear all behavior instances </p>
- <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a24eff746b90533b916b2b3aa0f27d8f3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool connect </td>
- <td>(</td>
- <td class="paramtype">outputBehavior </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">inputBehavior </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">outputName </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">inputName </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connects a behavior output to a behavior input. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
- <tr><td class="paramname">inputBehavior</td><td>The behavior that owns the input. </td></tr>
- <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
- <tr><td class="paramname">inputName</td><td>The input name owned by the input behavior. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the connection was successful or not. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a5021752e2f48900d3a7cb3ffdab1f7a9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool disconnect </td>
- <td>(</td>
- <td class="paramtype">outputBehavior </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">inputBehavior </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">outputName </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">inputName </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connects a behavior output to a behavior input. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
- <tr><td class="paramname">inputBehavior</td><td>The behavior that owns the input. </td></tr>
- <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
- <tr><td class="paramname">inputName</td><td>The input name owned by the input behavior. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the disconnection was successful or not. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a7d996d1d925e53a122b1f3cf57f5abce"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int getBehavior </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>BehaviorTemplateName</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>gets a behavior </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">BehaviorTemplateName</td><td>The name of the template of the behavior instance you want </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>(<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi) The behavior instance you requested </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aed9520e4500354682950371b062d974d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int getBehaviorByIndex </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets a particular behavior </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">index</td><td>The index of the behavior to get </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>(<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi) The behavior instance you requested </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a88ee692a8690fd9de215f7ece20623b5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string getBehaviorConnection </td>
- <td>(</td>
- <td class="paramtype">outputBehavior </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">outputName </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">connectionIndex </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets a comma-delimited list of connections on the behavior output on the specified behavior. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
- <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
- <tr><td class="paramname">connectionIndex</td><td>The connection index. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns a comma-delimited list of connections on the behavior output on the specified behavior of the format <OutputBehavior>,<InputBehavior>,<OutputName>,<InputName>. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ad50805919d99adf0f65c6b94bd9e5dfd"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int getBehaviorConnectionCount </td>
- <td>(</td>
- <td class="paramtype">outputBehavior </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">outputName </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the number of connections on the behavior output on the specified behavior. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
- <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The number of connections on the behavior output on the specified behavior. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab6dc6b3eb09a1d6f8f4c8ec9a4108d17"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int getBehaviorCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the count of behaviors on an object </p>
- <dl class="section return"><dt>Returns</dt><dd>(int count) The number of behaviors on an object </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ae81bec76a6acbc925694c5a050198609"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool raise </td>
- <td>(</td>
- <td class="paramtype">outputBehavior </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">outputName </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Raise a signal on the behavior output on the specified behavior. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
- <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
- <tr><td class="paramname">[deltaTime]</td><td>Optional time-delta (ms) when the raise should occur. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the signal raise was successful or not. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a5f71e751ee5ab7b8ea61e31a77983f4b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool removeBehavior </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> </td>
- <td class="paramname"><em>bi</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">bi</td><td>The behavior instance to remove </td></tr>
- <tr><td class="paramname">deleteBehavior</td><td>Whether or not to delete the behavior </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the behavior was successfully removed </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a753fb3072cd4e96d997755452bc13071"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool reOrder </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> </td>
- <td class="paramname"><em>inst</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inst</td><td>The behavior instance you want to reorder </td></tr>
- <tr><td class="paramname">desiredIndex</td><td>The index you want the behavior instance to be reordered to </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether or not the behavior instance was successfully reordered </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.3.1
- </small></address>
- </body>
- </html>
|