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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
							<!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: Packages</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">Packages<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:ga36099abd9ed2e330ac95151e06dd33f1" id="r_ga36099abd9ed2e330ac95151e06dd33f1"><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__PackageFunctions.html#ga36099abd9ed2e330ac95151e06dd33f1">activatePackage</a> (packageName)</td></tr>
<tr class="separator:ga36099abd9ed2e330ac95151e06dd33f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadab906fa0cda2d36aa862dca8ffa7248" id="r_gadab906fa0cda2d36aa862dca8ffa7248"><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__PackageFunctions.html#gadab906fa0cda2d36aa862dca8ffa7248">deactivatePackage</a> (packageName)</td></tr>
<tr class="separator:gadab906fa0cda2d36aa862dca8ffa7248"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3ce2d15307a1e73f679349055da957e1" id="r_ga3ce2d15307a1e73f679349055da957e1"><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__PackageFunctions.html#ga3ce2d15307a1e73f679349055da957e1">isPackage</a> (packageName)</td></tr>
<tr class="separator:ga3ce2d15307a1e73f679349055da957e1"><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="ga36099abd9ed2e330ac95151e06dd33f1" name="ga36099abd9ed2e330ac95151e06dd33f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga36099abd9ed2e330ac95151e06dd33f1">&#9670;&#160;</a></span>activatePackage()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> activatePackage </td>
          <td>(</td>
          <td class="paramtype">packageName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the activatePackage function to activate a package definition and to re-define all functions named within this package with the definitions provided in the package body. This pushes the newly activated package onto the top of the package stack. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">packagename</td><td>The name or ID of an existing package. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PackageFunctions.html#gadab906fa0cda2d36aa862dca8ffa7248">deactivatePackage</a>, <a class="el" href="group__PackageFunctions.html#ga3ce2d15307a1e73f679349055da957e1">isPackage</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> deactivatePackage </td>
          <td>(</td>
          <td class="paramtype">packageName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the deactivatePackage function to deactivate a package definition and to pop any definitions from this package off the package stack. This also causes any subsequently stacked packages to be popped. i.e. If any packages were activated after the one specified in packageName, they too will be deactivated and popped. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">packagename</td><td>The name or ID of an existing package. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PackageFunctions.html#ga36099abd9ed2e330ac95151e06dd33f1">activatePackage</a>, <a class="el" href="group__PackageFunctions.html#ga3ce2d15307a1e73f679349055da957e1">isPackage</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isPackage </td>
          <td>(</td>
          <td class="paramtype">packageName&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the isPackage function to check if the name or ID specified in packageName is a valid package. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">packagename</td><td>The name or ID of an existing package. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if packageName is a valid package, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PackageFunctions.html#ga36099abd9ed2e330ac95151e06dd33f1">activatePackage</a>, <a class="el" href="group__PackageFunctions.html#gadab906fa0cda2d36aa862dca8ffa7248">deactivatePackage</a> </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>