cpp
/
GamePlay
mirror of https://github.com/gameplay3d/GamePlay


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
							<!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"/>
<title>Script Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->
<table class="header" border="0">
<tbody>
<tr>
<td id="logo"><a href="http://gameplay3d.org/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
<td width="100%"/>
<td><a href="http://gameplay3d.org/"><span class="button">overview</span></a></td><td width="12px"/>
<td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
<td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
<td><a href="http://www.gameplay3d.org/forums"><span class="button">forums</span></a></td>
<td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
</tr>
</tbody>
</table>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               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.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></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 id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>gameplay</b>      </li>
      <li class="navelem"><a class="el" href="classgameplay_1_1_script.html">Script</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">gameplay::Script Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="gameplay::Script" --><!-- doxytag: inherits="gameplay::Ref" -->
<p><code>#include &lt;Script.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gameplay::Script:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classgameplay_1_1_script.png" usemap="#gameplay::Script_map" alt=""/>
  <map id="gameplay::Script_map" name="gameplay::Script_map">
<area href="classgameplay_1_1_ref.html" alt="gameplay::Ref" shape="rect" coords="0,0,105,24"/>
</map>
 </div></div>

<p><a href="classgameplay_1_1_script-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script.html#a8b296af219762d7fa7f54a820947e7dc">Scope</a> { <a class="el" href="classgameplay_1_1_script.html#a8b296af219762d7fa7f54a820947e7dcaab4c13774b342e27d113c28ede53d211">GLOBAL</a>, 
<a class="el" href="classgameplay_1_1_script.html#a8b296af219762d7fa7f54a820947e7dcadcb485553dc4543c13377f87d7049011">PROTECTED</a>
 }</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script.html#a04fb324f5e1516e266878eb5cff4d216">getPath</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_script.html#a8b296af219762d7fa7f54a820947e7dc">Scope</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script.html#ac4b2c54ce65347f65504b8ce30f684e1">getScope</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script.html#ae3490b858b389b8105751cff5461c2f1">functionExists</a> (const char *name) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script.html#aa77a095f2379c541410f394cfc8eaff9">reload</a> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Represents a script that has been loaded by the scripting system. </p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a8b296af219762d7fa7f54a820947e7dc"></a><!-- doxytag: member="gameplay::Script::Scope" ref="a8b296af219762d7fa7f54a820947e7dc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classgameplay_1_1_script.html#a8b296af219762d7fa7f54a820947e7dc">gameplay::Script::Scope</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Defines the scope of a script environment. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a8b296af219762d7fa7f54a820947e7dcaab4c13774b342e27d113c28ede53d211"></a><!-- doxytag: member="GLOBAL" ref="a8b296af219762d7fa7f54a820947e7dcaab4c13774b342e27d113c28ede53d211" args="" -->GLOBAL</em>&nbsp;</td><td>
<p>Global scripts execute in a single shared environment that is accessible to all other scripts in the system. Global scripts can use code from other global scripts and other scripts can use code from a global script.</p>
<p>Scripts that execute in the global environment must be careful to not override other variables or functions that already exist in the global environment (unless this is intended). Because of this, script naming conventions and the use of unique namespaces is important to prevent naming collisions with other global code. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a8b296af219762d7fa7f54a820947e7dcadcb485553dc4543c13377f87d7049011"></a><!-- doxytag: member="PROTECTED" ref="a8b296af219762d7fa7f54a820947e7dcadcb485553dc4543c13377f87d7049011" args="" -->PROTECTED</em>&nbsp;</td><td>
<p>Protected scripts execute in a more limited sandbox environment that by default does not allow other scripts to see their variables or functions. Variables and functions in a protected script can be named the same as those in other scripts without collision issues.</p>
<p>Although global code cannot access protected scripts, protected scripts can acceess global code. Similarly, protected scripts can expose variables and functions to the global environment using explicit notation, although the same precautions noted for the GLOBAL scope should be used when doing this, to prevent naming collisions.</p>
<p>Protected scripts are best used when associated with a single game object, since these scripts are not cached the same way global scripts are. Each time a protected script is loaded, a new instance of the script is loaded. This allows protected scripts to store per-instance state, since it will not be shared by multiple instances.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_script_target.html">ScriptTarget</a> </dd></dl>
</td></tr>
</table>
</dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae3490b858b389b8105751cff5461c2f1"></a><!-- doxytag: member="gameplay::Script::functionExists" ref="ae3490b858b389b8105751cff5461c2f1" args="(const char *name) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classgameplay_1_1_script.html#ae3490b858b389b8105751cff5461c2f1">gameplay::Script::functionExists</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Determines if a function with the given name exists in the script.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>Name of the function.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the function exists, false otherwise. </dd></dl>

</div>
</div>
<a class="anchor" id="a04fb324f5e1516e266878eb5cff4d216"></a><!-- doxytag: member="gameplay::Script::getPath" ref="a04fb324f5e1516e266878eb5cff4d216" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="classgameplay_1_1_script.html#a04fb324f5e1516e266878eb5cff4d216">gameplay::Script::getPath</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the path from which this <a class="el" href="classgameplay_1_1_script.html">Script</a> was loaded.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The script's path. </dd></dl>

</div>
</div>
<a class="anchor" id="ac4b2c54ce65347f65504b8ce30f684e1"></a><!-- doxytag: member="gameplay::Script::getScope" ref="ac4b2c54ce65347f65504b8ce30f684e1" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgameplay_1_1_script.html#a8b296af219762d7fa7f54a820947e7dc">Scope</a> <a class="el" href="classgameplay_1_1_script.html#ac4b2c54ce65347f65504b8ce30f684e1">gameplay::Script::getScope</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the scope of this script.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The scope of this script. </dd></dl>

</div>
</div>
<a class="anchor" id="aa77a095f2379c541410f394cfc8eaff9"></a><!-- doxytag: member="gameplay::Script::reload" ref="aa77a095f2379c541410f394cfc8eaff9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classgameplay_1_1_script.html#aa77a095f2379c541410f394cfc8eaff9">gameplay::Script::reload</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Reloads this script.</p>
<p>The code in the script will be reloaded and any functions and variables will be overwritten into the script's envrionment.</p>
<p>If the script is GLOBAL in scope, it will simply be re-run, replacing any existing global variables and functions. If the script has changed, any previous variables or functions that do not exist in the updated script will remain in the global environment.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the script is successfully reloaded, false otherwise. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></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>


<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 24 2015 15:29:44 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>