| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279 |
- <!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>gameplay: Main Page</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.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
- <td width="100%"/>
- <td><a href="http://gameplay3d.io/"><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 reference</span></a></td><td width="12px"/>
- <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 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 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>
- <!-- 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </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_target.html">ScriptTarget</a> </li>
- <li class="navelem"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html">EventRegistry</a> </li>
- </ul>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> </div>
- <div class="headertitle">
- <div class="title">gameplay::ScriptTarget::EventRegistry Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <!-- doxytag: class="gameplay::ScriptTarget::EventRegistry" -->
- <p><code>#include <ScriptTarget.h></code></p>
- <p><a href="classgameplay_1_1_script_target_1_1_event_registry-members.html">List of all members.</a></p>
- <table class="memberdecls">
- <tr><td colspan="2"><h2><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a471018e3cca45ff9b50d794c140e13fd">EventRegistry</a> ()</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#af7f541403ca12160587760f81a25b5ef">~EventRegistry</a> ()</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a20ff0d90606b639ddb78d37235811a83">addEvent</a> (const char *name, const char *args=NULL)</td></tr>
- <tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a65e9c3ab0c0f4d472cd75a3fd1fed596">getEventCount</a> () const </td></tr>
- <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a0d3db724c808bd987acdc7bfec4c930e">getEvent</a> (unsigned int index) const </td></tr>
- <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a1fac259e18fa24cf4cde3e4d8f1823f4">getEvent</a> (const char *name) const </td></tr>
- </table>
- <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
- <div class="textblock"><p><a class="el" href="classgameplay_1_1_script.html">Script</a> event registry that defines the supported script events for a <a class="el" href="classgameplay_1_1_script_target.html">ScriptTarget</a>.</p>
- <p>This class should generally only be used via the GP_REGISTER_SCRIPT_EVENTS macro. </p>
- </div><hr/><h2>Constructor & Destructor Documentation</h2>
- <a class="anchor" id="a471018e3cca45ff9b50d794c140e13fd"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::EventRegistry" ref="a471018e3cca45ff9b50d794c140e13fd" args="()" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a471018e3cca45ff9b50d794c140e13fd">gameplay::ScriptTarget::EventRegistry::EventRegistry</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Constructor. </p>
- </div>
- </div>
- <a class="anchor" id="af7f541403ca12160587760f81a25b5ef"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::~EventRegistry" ref="af7f541403ca12160587760f81a25b5ef" args="()" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#af7f541403ca12160587760f81a25b5ef">gameplay::ScriptTarget::EventRegistry::~EventRegistry</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Destructor. </p>
- </div>
- </div>
- <hr/><h2>Member Function Documentation</h2>
- <a class="anchor" id="a20ff0d90606b639ddb78d37235811a83"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::addEvent" ref="a20ff0d90606b639ddb78d37235811a83" args="(const char *name, const char *args=NULL)" -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a>* <a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a20ff0d90606b639ddb78d37235811a83">gameplay::ScriptTarget::EventRegistry::addEvent</a> </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>args</em> = <code>NULL</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Adds a registered event to the registry.</p>
- <dl class="params"><dt><b>Parameters:</b></dt><dd>
- <table class="params">
- <tr><td class="paramname">name</td><td>The name of the script event. </td></tr>
- <tr><td class="paramname">args</td><td>The argument string for the event.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="return"><dt><b>Returns:</b></dt><dd>The added event. </dd></dl>
- <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_script_controller.html#acb739b7fa547e0c17ec2c83003a142b2">ScriptController::executeFunction</a> </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a0d3db724c808bd987acdc7bfec4c930e"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::getEvent" ref="a0d3db724c808bd987acdc7bfec4c930e" args="(unsigned int index) const " -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a>* <a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a0d3db724c808bd987acdc7bfec4c930e">gameplay::ScriptTarget::EventRegistry::getEvent</a> </td>
- <td>(</td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>index</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Returns the event with the given index.</p>
- <dl class="params"><dt><b>Parameters:</b></dt><dd>
- <table class="params">
- <tr><td class="paramname">index</td><td>The index of the event to retrieve. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="return"><dt><b>Returns:</b></dt><dd>The event for the given index. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a1fac259e18fa24cf4cde3e4d8f1823f4"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::getEvent" ref="a1fac259e18fa24cf4cde3e4d8f1823f4" args="(const char *name) const " -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a>* <a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a0d3db724c808bd987acdc7bfec4c930e">gameplay::ScriptTarget::EventRegistry::getEvent</a> </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>name</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Returns the event that matches the given name.</p>
- <dl class="params"><dt><b>Parameters:</b></dt><dd>
- <table class="params">
- <tr><td class="paramname">name</td><td>The name of the event to search for. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="return"><dt><b>Returns:</b></dt><dd>The matching event, or NULL if no such event exists. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a65e9c3ab0c0f4d472cd75a3fd1fed596"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::getEventCount" ref="a65e9c3ab0c0f4d472cd75a3fd1fed596" args="() const " -->
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a65e9c3ab0c0f4d472cd75a3fd1fed596">gameplay::ScriptTarget::EventRegistry::getEventCount</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div>
- <div class="memdoc">
- <p>Returns the number of registered script events.</p>
- <dl class="return"><dt><b>Returns:</b></dt><dd>The number of script events registered. </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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </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  <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>
|