4345 lines
245 KiB
HTML
4345 lines
245 KiB
HTML
<!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">
|
|
<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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>AngelScript: asIScriptEngine 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<link href="doxygen.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 id="projectlogo"><img alt="Logo" src="aslogo_small.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">AngelScript
|
|
</div>
|
|
</td>
|
|
<td> <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>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classas_i_script_engine.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</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 class="header">
|
|
<div class="summary">
|
|
<a href="classas_i_script_engine-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">asIScriptEngine Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__api__principal__interfaces.html">Principal interfaces</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The engine interface.
|
|
<a href="classas_i_script_engine.html#details">More...</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><td colspan="2"><div class="groupHeader">Memory management</div></td></tr>
|
|
<tr class="memitem:aa95a5d9b5d9e7e6a230fedf056eaf8ce"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aa95a5d9b5d9e7e6a230fedf056eaf8ce">AddRef</a> () const =0</td></tr>
|
|
<tr class="memdesc:aa95a5d9b5d9e7e6a230fedf056eaf8ce"><td class="mdescLeft"> </td><td class="mdescRight">Increase reference counter. <a href="classas_i_script_engine.html#aa95a5d9b5d9e7e6a230fedf056eaf8ce">More...</a><br /></td></tr>
|
|
<tr class="separator:aa95a5d9b5d9e7e6a230fedf056eaf8ce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae91a45da75af9234b87e825b5c08b81"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aae91a45da75af9234b87e825b5c08b81">Release</a> () const =0</td></tr>
|
|
<tr class="memdesc:aae91a45da75af9234b87e825b5c08b81"><td class="mdescLeft"> </td><td class="mdescRight">Decrease reference counter. <a href="classas_i_script_engine.html#aae91a45da75af9234b87e825b5c08b81">More...</a><br /></td></tr>
|
|
<tr class="separator:aae91a45da75af9234b87e825b5c08b81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28c3800620d4aeaca75d084391eb758e"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a28c3800620d4aeaca75d084391eb758e">ShutDownAndRelease</a> ()=0</td></tr>
|
|
<tr class="memdesc:a28c3800620d4aeaca75d084391eb758e"><td class="mdescLeft"> </td><td class="mdescRight">Shuts down the engine then decrease the reference counter. <a href="classas_i_script_engine.html#a28c3800620d4aeaca75d084391eb758e">More...</a><br /></td></tr>
|
|
<tr class="separator:a28c3800620d4aeaca75d084391eb758e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Engine properties</div></td></tr>
|
|
<tr class="memitem:a1bce4e5f573a2ca0ff55163e28f761dd"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a1bce4e5f573a2ca0ff55163e28f761dd">SetEngineProperty</a> (<a class="el" href="angelscript_8h.html#a53c2e8a74ade77c928316396394ebe0f">asEEngineProp</a> property, <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> value)=0</td></tr>
|
|
<tr class="memdesc:a1bce4e5f573a2ca0ff55163e28f761dd"><td class="mdescLeft"> </td><td class="mdescRight">Dynamically change some engine properties. <a href="classas_i_script_engine.html#a1bce4e5f573a2ca0ff55163e28f761dd">More...</a><br /></td></tr>
|
|
<tr class="separator:a1bce4e5f573a2ca0ff55163e28f761dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5531bf5310a0c933aa698725a6828e5f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a5531bf5310a0c933aa698725a6828e5f">GetEngineProperty</a> (<a class="el" href="angelscript_8h.html#a53c2e8a74ade77c928316396394ebe0f">asEEngineProp</a> property) const =0</td></tr>
|
|
<tr class="memdesc:a5531bf5310a0c933aa698725a6828e5f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve current engine property settings. <a href="classas_i_script_engine.html#a5531bf5310a0c933aa698725a6828e5f">More...</a><br /></td></tr>
|
|
<tr class="separator:a5531bf5310a0c933aa698725a6828e5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Compiler messages</div></td></tr>
|
|
<tr class="memitem:a74192fe950808eb72a64e3e371f0ea02"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a74192fe950808eb72a64e3e371f0ea02">SetMessageCallback</a> (const <a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> &callback, void *obj, <a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> callConv)=0</td></tr>
|
|
<tr class="memdesc:a74192fe950808eb72a64e3e371f0ea02"><td class="mdescLeft"> </td><td class="mdescRight">Sets a message callback that will receive compiler messages. <a href="classas_i_script_engine.html#a74192fe950808eb72a64e3e371f0ea02">More...</a><br /></td></tr>
|
|
<tr class="separator:a74192fe950808eb72a64e3e371f0ea02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada64567fc9621e5e98160c7f03efa064"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ada64567fc9621e5e98160c7f03efa064">ClearMessageCallback</a> ()=0</td></tr>
|
|
<tr class="memdesc:ada64567fc9621e5e98160c7f03efa064"><td class="mdescLeft"> </td><td class="mdescRight">Clears the registered message callback routine. <a href="classas_i_script_engine.html#ada64567fc9621e5e98160c7f03efa064">More...</a><br /></td></tr>
|
|
<tr class="separator:ada64567fc9621e5e98160c7f03efa064"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a936ce6566af958bb75ba1c0945d8b03a"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a936ce6566af958bb75ba1c0945d8b03a">WriteMessage</a> (const char *section, int row, int col, <a class="el" href="angelscript_8h.html#a8badcd23652646db5c5c6981dc73d4f5">asEMsgType</a> type, const char *message)=0</td></tr>
|
|
<tr class="memdesc:a936ce6566af958bb75ba1c0945d8b03a"><td class="mdescLeft"> </td><td class="mdescRight">Writes a message to the message callback. <a href="classas_i_script_engine.html#a936ce6566af958bb75ba1c0945d8b03a">More...</a><br /></td></tr>
|
|
<tr class="separator:a936ce6566af958bb75ba1c0945d8b03a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">JIT compiler</div></td></tr>
|
|
<tr class="memitem:aee4f910163604203a27db1ffea3b1c9c"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aee4f910163604203a27db1ffea3b1c9c">SetJITCompiler</a> (<a class="el" href="classas_i_j_i_t_compiler.html">asIJITCompiler</a> *compiler)=0</td></tr>
|
|
<tr class="memdesc:aee4f910163604203a27db1ffea3b1c9c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the JIT compiler. <a href="classas_i_script_engine.html#aee4f910163604203a27db1ffea3b1c9c">More...</a><br /></td></tr>
|
|
<tr class="separator:aee4f910163604203a27db1ffea3b1c9c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fb6db9085df3c7d487c0d58de76bb83"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_j_i_t_compiler.html">asIJITCompiler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a2fb6db9085df3c7d487c0d58de76bb83">GetJITCompiler</a> () const =0</td></tr>
|
|
<tr class="memdesc:a2fb6db9085df3c7d487c0d58de76bb83"><td class="mdescLeft"> </td><td class="mdescRight">Returns the JIT compiler. <a href="classas_i_script_engine.html#a2fb6db9085df3c7d487c0d58de76bb83">More...</a><br /></td></tr>
|
|
<tr class="separator:a2fb6db9085df3c7d487c0d58de76bb83"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Global functions</div></td></tr>
|
|
<tr class="memitem:a2f84b9b51733f22c68b8448b02c2f1c7"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a2f84b9b51733f22c68b8448b02c2f1c7">RegisterGlobalFunction</a> (const char *declaration, const <a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> &funcPointer, <a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> callConv, void *auxiliary=0)=0</td></tr>
|
|
<tr class="memdesc:a2f84b9b51733f22c68b8448b02c2f1c7"><td class="mdescLeft"> </td><td class="mdescRight">Registers a global function. <a href="classas_i_script_engine.html#a2f84b9b51733f22c68b8448b02c2f1c7">More...</a><br /></td></tr>
|
|
<tr class="separator:a2f84b9b51733f22c68b8448b02c2f1c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72aa1a3a5ac88a5a1dba4fa3655141d6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a72aa1a3a5ac88a5a1dba4fa3655141d6">GetGlobalFunctionCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:a72aa1a3a5ac88a5a1dba4fa3655141d6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of registered functions. <a href="classas_i_script_engine.html#a72aa1a3a5ac88a5a1dba4fa3655141d6">More...</a><br /></td></tr>
|
|
<tr class="separator:a72aa1a3a5ac88a5a1dba4fa3655141d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf2b79cef75adb4099a24e3412e4ea79"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_script_function.html">asIScriptFunction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aaf2b79cef75adb4099a24e3412e4ea79">GetGlobalFunctionByIndex</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> index) const =0</td></tr>
|
|
<tr class="memdesc:aaf2b79cef75adb4099a24e3412e4ea79"><td class="mdescLeft"> </td><td class="mdescRight">Returns the registered function. <a href="classas_i_script_engine.html#aaf2b79cef75adb4099a24e3412e4ea79">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf2b79cef75adb4099a24e3412e4ea79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42edd02e95731c795e13706400e8665a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_script_function.html">asIScriptFunction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a42edd02e95731c795e13706400e8665a">GetGlobalFunctionByDecl</a> (const char *declaration) const =0</td></tr>
|
|
<tr class="memdesc:a42edd02e95731c795e13706400e8665a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the registered function. <a href="classas_i_script_engine.html#a42edd02e95731c795e13706400e8665a">More...</a><br /></td></tr>
|
|
<tr class="separator:a42edd02e95731c795e13706400e8665a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Global properties</div></td></tr>
|
|
<tr class="memitem:aacd32f32b2922b8ffaed204812013169"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aacd32f32b2922b8ffaed204812013169">RegisterGlobalProperty</a> (const char *declaration, void *pointer)=0</td></tr>
|
|
<tr class="memdesc:aacd32f32b2922b8ffaed204812013169"><td class="mdescLeft"> </td><td class="mdescRight">Registers a global property. <a href="classas_i_script_engine.html#aacd32f32b2922b8ffaed204812013169">More...</a><br /></td></tr>
|
|
<tr class="separator:aacd32f32b2922b8ffaed204812013169"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa69f6b37f9c7bdf9b52b9c1692daf048"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aa69f6b37f9c7bdf9b52b9c1692daf048">GetGlobalPropertyCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:aa69f6b37f9c7bdf9b52b9c1692daf048"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of registered global properties. <a href="classas_i_script_engine.html#aa69f6b37f9c7bdf9b52b9c1692daf048">More...</a><br /></td></tr>
|
|
<tr class="separator:aa69f6b37f9c7bdf9b52b9c1692daf048"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93bd686853a48647d2136792e27380fb"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a93bd686853a48647d2136792e27380fb">GetGlobalPropertyByIndex</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> index, const char **name, const char **nameSpace=0, int *typeId=0, bool *isConst=0, const char **configGroup=0, void **pointer=0, <a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> *accessMask=0) const =0</td></tr>
|
|
<tr class="memdesc:a93bd686853a48647d2136792e27380fb"><td class="mdescLeft"> </td><td class="mdescRight">Returns the detail on the registered global property. <a href="classas_i_script_engine.html#a93bd686853a48647d2136792e27380fb">More...</a><br /></td></tr>
|
|
<tr class="separator:a93bd686853a48647d2136792e27380fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07e85878869e4d0597c1177d767dc717"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a07e85878869e4d0597c1177d767dc717">GetGlobalPropertyIndexByName</a> (const char *name) const =0</td></tr>
|
|
<tr class="memdesc:a07e85878869e4d0597c1177d767dc717"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the property. <a href="classas_i_script_engine.html#a07e85878869e4d0597c1177d767dc717">More...</a><br /></td></tr>
|
|
<tr class="separator:a07e85878869e4d0597c1177d767dc717"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91a4cc8af51ca439ca82b9b6630439b3"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a91a4cc8af51ca439ca82b9b6630439b3">GetGlobalPropertyIndexByDecl</a> (const char *decl) const =0</td></tr>
|
|
<tr class="memdesc:a91a4cc8af51ca439ca82b9b6630439b3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the property. <a href="classas_i_script_engine.html#a91a4cc8af51ca439ca82b9b6630439b3">More...</a><br /></td></tr>
|
|
<tr class="separator:a91a4cc8af51ca439ca82b9b6630439b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Object types</div></td></tr>
|
|
<tr class="memitem:a29c6c087c8c5b5cdb6271cfd161cc5a6"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a29c6c087c8c5b5cdb6271cfd161cc5a6">RegisterObjectType</a> (const char *obj, int byteSize, <a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> flags)=0</td></tr>
|
|
<tr class="memdesc:a29c6c087c8c5b5cdb6271cfd161cc5a6"><td class="mdescLeft"> </td><td class="mdescRight">Registers a new object type. <a href="classas_i_script_engine.html#a29c6c087c8c5b5cdb6271cfd161cc5a6">More...</a><br /></td></tr>
|
|
<tr class="separator:a29c6c087c8c5b5cdb6271cfd161cc5a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0aa35bf824180fe6aed685b40f0e8c34"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a0aa35bf824180fe6aed685b40f0e8c34">RegisterObjectProperty</a> (const char *obj, const char *declaration, int byteOffset, int compositeOffset=0, bool isCompositeIndirect=false)=0</td></tr>
|
|
<tr class="memdesc:a0aa35bf824180fe6aed685b40f0e8c34"><td class="mdescLeft"> </td><td class="mdescRight">Registers a property for the object type. <a href="classas_i_script_engine.html#a0aa35bf824180fe6aed685b40f0e8c34">More...</a><br /></td></tr>
|
|
<tr class="separator:a0aa35bf824180fe6aed685b40f0e8c34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad74043be9cc30f105c62f482ca720574"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ad74043be9cc30f105c62f482ca720574">RegisterObjectMethod</a> (const char *obj, const char *declaration, const <a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> &funcPointer, <a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> callConv, void *auxiliary=0, int compositeOffset=0, bool isCompositeIndirect=false)=0</td></tr>
|
|
<tr class="memdesc:ad74043be9cc30f105c62f482ca720574"><td class="mdescLeft"> </td><td class="mdescRight">Registers a method for the object type. <a href="classas_i_script_engine.html#ad74043be9cc30f105c62f482ca720574">More...</a><br /></td></tr>
|
|
<tr class="separator:ad74043be9cc30f105c62f482ca720574"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f122dd87394f3a83ac766ea19f37317"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a9f122dd87394f3a83ac766ea19f37317">RegisterObjectBehaviour</a> (const char *obj, <a class="el" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5">asEBehaviours</a> behaviour, const char *declaration, const <a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> &funcPointer, <a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> callConv, void *auxiliary=0, int compositeOffset=0, bool isCompositeIndirect=false)=0</td></tr>
|
|
<tr class="memdesc:a9f122dd87394f3a83ac766ea19f37317"><td class="mdescLeft"> </td><td class="mdescRight">Registers a behaviour for the object type. <a href="classas_i_script_engine.html#a9f122dd87394f3a83ac766ea19f37317">More...</a><br /></td></tr>
|
|
<tr class="separator:a9f122dd87394f3a83ac766ea19f37317"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2d89b82561b7f9843f35693c664589f"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ae2d89b82561b7f9843f35693c664589f">RegisterInterface</a> (const char *name)=0</td></tr>
|
|
<tr class="memdesc:ae2d89b82561b7f9843f35693c664589f"><td class="mdescLeft"> </td><td class="mdescRight">Registers a script interface. <a href="classas_i_script_engine.html#ae2d89b82561b7f9843f35693c664589f">More...</a><br /></td></tr>
|
|
<tr class="separator:ae2d89b82561b7f9843f35693c664589f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a43bd2c12c94a55c22be76d209de93f1a"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a43bd2c12c94a55c22be76d209de93f1a">RegisterInterfaceMethod</a> (const char *intf, const char *declaration)=0</td></tr>
|
|
<tr class="memdesc:a43bd2c12c94a55c22be76d209de93f1a"><td class="mdescLeft"> </td><td class="mdescRight">Registers a script interface method. <a href="classas_i_script_engine.html#a43bd2c12c94a55c22be76d209de93f1a">More...</a><br /></td></tr>
|
|
<tr class="separator:a43bd2c12c94a55c22be76d209de93f1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2667fbe30dd00ed14bc14e6ef7fc725"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ac2667fbe30dd00ed14bc14e6ef7fc725">GetObjectTypeCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:ac2667fbe30dd00ed14bc14e6ef7fc725"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of registered object types. <a href="classas_i_script_engine.html#ac2667fbe30dd00ed14bc14e6ef7fc725">More...</a><br /></td></tr>
|
|
<tr class="separator:ac2667fbe30dd00ed14bc14e6ef7fc725"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afac08d4f81e587031c7863574c6783ba"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#afac08d4f81e587031c7863574c6783ba">GetObjectTypeByIndex</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> index) const =0</td></tr>
|
|
<tr class="memdesc:afac08d4f81e587031c7863574c6783ba"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object type interface by index. <a href="classas_i_script_engine.html#afac08d4f81e587031c7863574c6783ba">More...</a><br /></td></tr>
|
|
<tr class="separator:afac08d4f81e587031c7863574c6783ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">String factory</div></td></tr>
|
|
<tr class="memitem:ac6598c07c36652b0270b4c2d61db1f01"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ac6598c07c36652b0270b4c2d61db1f01">RegisterStringFactory</a> (const char *datatype, <a class="el" href="classas_i_string_factory.html">asIStringFactory</a> *factory)=0</td></tr>
|
|
<tr class="memdesc:ac6598c07c36652b0270b4c2d61db1f01"><td class="mdescLeft"> </td><td class="mdescRight">Registers the string factory. <a href="classas_i_script_engine.html#ac6598c07c36652b0270b4c2d61db1f01">More...</a><br /></td></tr>
|
|
<tr class="separator:ac6598c07c36652b0270b4c2d61db1f01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb3935d85494231e2f02af5816ba9830"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#afb3935d85494231e2f02af5816ba9830">GetStringFactoryReturnTypeId</a> (<a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> *flags=0) const =0</td></tr>
|
|
<tr class="memdesc:afb3935d85494231e2f02af5816ba9830"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type id of the type that the string factory returns. <a href="classas_i_script_engine.html#afb3935d85494231e2f02af5816ba9830">More...</a><br /></td></tr>
|
|
<tr class="separator:afb3935d85494231e2f02af5816ba9830"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Default array type</div></td></tr>
|
|
<tr class="memitem:ac9451feece1297eba8d1649036039e82"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ac9451feece1297eba8d1649036039e82">RegisterDefaultArrayType</a> (const char *type)=0</td></tr>
|
|
<tr class="memdesc:ac9451feece1297eba8d1649036039e82"><td class="mdescLeft"> </td><td class="mdescRight">Registers the type that should be used as the default array. <a href="classas_i_script_engine.html#ac9451feece1297eba8d1649036039e82">More...</a><br /></td></tr>
|
|
<tr class="separator:ac9451feece1297eba8d1649036039e82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae86e5444979b0abd92777be83c53fc80"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ae86e5444979b0abd92777be83c53fc80">GetDefaultArrayTypeId</a> () const =0</td></tr>
|
|
<tr class="memdesc:ae86e5444979b0abd92777be83c53fc80"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type id of the registered type. <a href="classas_i_script_engine.html#ae86e5444979b0abd92777be83c53fc80">More...</a><br /></td></tr>
|
|
<tr class="separator:ae86e5444979b0abd92777be83c53fc80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Enums</div></td></tr>
|
|
<tr class="memitem:abed6e77f2a532c8a4f528650fa137d37"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#abed6e77f2a532c8a4f528650fa137d37">RegisterEnum</a> (const char *type)=0</td></tr>
|
|
<tr class="memdesc:abed6e77f2a532c8a4f528650fa137d37"><td class="mdescLeft"> </td><td class="mdescRight">Registers an enum type. <a href="classas_i_script_engine.html#abed6e77f2a532c8a4f528650fa137d37">More...</a><br /></td></tr>
|
|
<tr class="separator:abed6e77f2a532c8a4f528650fa137d37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d331153596dd39838f3bed2a861af18"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a4d331153596dd39838f3bed2a861af18">RegisterEnumValue</a> (const char *type, const char *name, int value)=0</td></tr>
|
|
<tr class="memdesc:a4d331153596dd39838f3bed2a861af18"><td class="mdescLeft"> </td><td class="mdescRight">Registers an enum value. <a href="classas_i_script_engine.html#a4d331153596dd39838f3bed2a861af18">More...</a><br /></td></tr>
|
|
<tr class="separator:a4d331153596dd39838f3bed2a861af18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b4307dab64061be43db84ffb97e3782"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a4b4307dab64061be43db84ffb97e3782">GetEnumCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:a4b4307dab64061be43db84ffb97e3782"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of registered enum types. <a href="classas_i_script_engine.html#a4b4307dab64061be43db84ffb97e3782">More...</a><br /></td></tr>
|
|
<tr class="separator:a4b4307dab64061be43db84ffb97e3782"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adedc8b2ad11a84ec12aef4f98e27a4c4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#adedc8b2ad11a84ec12aef4f98e27a4c4">GetEnumByIndex</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> index) const =0</td></tr>
|
|
<tr class="memdesc:adedc8b2ad11a84ec12aef4f98e27a4c4"><td class="mdescLeft"> </td><td class="mdescRight">Returns the registered enum type. <a href="classas_i_script_engine.html#adedc8b2ad11a84ec12aef4f98e27a4c4">More...</a><br /></td></tr>
|
|
<tr class="separator:adedc8b2ad11a84ec12aef4f98e27a4c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Funcdefs</div></td></tr>
|
|
<tr class="memitem:a03c1a2cc23ae4b742c927f3472a1a4f7"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a03c1a2cc23ae4b742c927f3472a1a4f7">RegisterFuncdef</a> (const char *decl)=0</td></tr>
|
|
<tr class="memdesc:a03c1a2cc23ae4b742c927f3472a1a4f7"><td class="mdescLeft"> </td><td class="mdescRight">Registers a function definition. <a href="classas_i_script_engine.html#a03c1a2cc23ae4b742c927f3472a1a4f7">More...</a><br /></td></tr>
|
|
<tr class="separator:a03c1a2cc23ae4b742c927f3472a1a4f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a48aceb1556f88ce3bec3e0f84abe127f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a48aceb1556f88ce3bec3e0f84abe127f">GetFuncdefCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:a48aceb1556f88ce3bec3e0f84abe127f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of registered function definitions. <a href="classas_i_script_engine.html#a48aceb1556f88ce3bec3e0f84abe127f">More...</a><br /></td></tr>
|
|
<tr class="separator:a48aceb1556f88ce3bec3e0f84abe127f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad4228220347347384c0aa0e0dd8308c6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ad4228220347347384c0aa0e0dd8308c6">GetFuncdefByIndex</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> index) const =0</td></tr>
|
|
<tr class="memdesc:ad4228220347347384c0aa0e0dd8308c6"><td class="mdescLeft"> </td><td class="mdescRight">Returns a registered function definition. <a href="classas_i_script_engine.html#ad4228220347347384c0aa0e0dd8308c6">More...</a><br /></td></tr>
|
|
<tr class="separator:ad4228220347347384c0aa0e0dd8308c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Typedefs</div></td></tr>
|
|
<tr class="memitem:addb24466769dc52be96c7e37d5305245"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#addb24466769dc52be96c7e37d5305245">RegisterTypedef</a> (const char *type, const char *decl)=0</td></tr>
|
|
<tr class="memdesc:addb24466769dc52be96c7e37d5305245"><td class="mdescLeft"> </td><td class="mdescRight">Registers a typedef. <a href="classas_i_script_engine.html#addb24466769dc52be96c7e37d5305245">More...</a><br /></td></tr>
|
|
<tr class="separator:addb24466769dc52be96c7e37d5305245"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0ebbbb86ea0e314cc2695f6276ebe507"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a0ebbbb86ea0e314cc2695f6276ebe507">GetTypedefCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:a0ebbbb86ea0e314cc2695f6276ebe507"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of registered typedefs. <a href="classas_i_script_engine.html#a0ebbbb86ea0e314cc2695f6276ebe507">More...</a><br /></td></tr>
|
|
<tr class="separator:a0ebbbb86ea0e314cc2695f6276ebe507"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a635cd008ea123b510c66fbddcea735f5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a635cd008ea123b510c66fbddcea735f5">GetTypedefByIndex</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> index) const =0</td></tr>
|
|
<tr class="memdesc:a635cd008ea123b510c66fbddcea735f5"><td class="mdescLeft"> </td><td class="mdescRight">Returns a registered typedef. <a href="classas_i_script_engine.html#a635cd008ea123b510c66fbddcea735f5">More...</a><br /></td></tr>
|
|
<tr class="separator:a635cd008ea123b510c66fbddcea735f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Configuration groups</div></td></tr>
|
|
<tr class="memitem:ac81014e50dd7efc1920adcb3fd2d1e5d"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ac81014e50dd7efc1920adcb3fd2d1e5d">BeginConfigGroup</a> (const char *groupName)=0</td></tr>
|
|
<tr class="memdesc:ac81014e50dd7efc1920adcb3fd2d1e5d"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new dynamic configuration group. <a href="classas_i_script_engine.html#ac81014e50dd7efc1920adcb3fd2d1e5d">More...</a><br /></td></tr>
|
|
<tr class="separator:ac81014e50dd7efc1920adcb3fd2d1e5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4cc5ed7ea71811655f7910d298bb5a02"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a4cc5ed7ea71811655f7910d298bb5a02">EndConfigGroup</a> ()=0</td></tr>
|
|
<tr class="memdesc:a4cc5ed7ea71811655f7910d298bb5a02"><td class="mdescLeft"> </td><td class="mdescRight">Ends the configuration group. <a href="classas_i_script_engine.html#a4cc5ed7ea71811655f7910d298bb5a02">More...</a><br /></td></tr>
|
|
<tr class="separator:a4cc5ed7ea71811655f7910d298bb5a02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab607be7fe727cdcce502d2beedbf4c0a"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ab607be7fe727cdcce502d2beedbf4c0a">RemoveConfigGroup</a> (const char *groupName)=0</td></tr>
|
|
<tr class="memdesc:ab607be7fe727cdcce502d2beedbf4c0a"><td class="mdescLeft"> </td><td class="mdescRight">Removes a previously registered configuration group. <a href="classas_i_script_engine.html#ab607be7fe727cdcce502d2beedbf4c0a">More...</a><br /></td></tr>
|
|
<tr class="separator:ab607be7fe727cdcce502d2beedbf4c0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a570df3e676f2d9e03e87d97b8cede1c7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a570df3e676f2d9e03e87d97b8cede1c7">SetDefaultAccessMask</a> (<a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> defaultMask)=0</td></tr>
|
|
<tr class="memdesc:a570df3e676f2d9e03e87d97b8cede1c7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the access mask that should be used for subsequent registered entities. <a href="classas_i_script_engine.html#a570df3e676f2d9e03e87d97b8cede1c7">More...</a><br /></td></tr>
|
|
<tr class="separator:a570df3e676f2d9e03e87d97b8cede1c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a605f114814f1f64804c04391816d948b"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a605f114814f1f64804c04391816d948b">SetDefaultNamespace</a> (const char *nameSpace)=0</td></tr>
|
|
<tr class="memdesc:a605f114814f1f64804c04391816d948b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current default namespace for registrations and searches. <a href="classas_i_script_engine.html#a605f114814f1f64804c04391816d948b">More...</a><br /></td></tr>
|
|
<tr class="separator:a605f114814f1f64804c04391816d948b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a257a25e285faa25e8cf08e455528def7"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a257a25e285faa25e8cf08e455528def7">GetDefaultNamespace</a> () const =0</td></tr>
|
|
<tr class="memdesc:a257a25e285faa25e8cf08e455528def7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current default namespace. <a href="classas_i_script_engine.html#a257a25e285faa25e8cf08e455528def7">More...</a><br /></td></tr>
|
|
<tr class="separator:a257a25e285faa25e8cf08e455528def7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Script modules</div></td></tr>
|
|
<tr class="memitem:a9f7cdc52b59034e6e55eb8a56b427aa4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_script_module.html">asIScriptModule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a9f7cdc52b59034e6e55eb8a56b427aa4">GetModule</a> (const char *module, <a class="el" href="angelscript_8h.html#ae4cf50de5273eb8c03c6e91e6e014f0c">asEGMFlags</a> flag=<a class="el" href="angelscript_8h.html#ae4cf50de5273eb8c03c6e91e6e014f0ca2feb963eb04c221e251867bc3a93d79d">asGM_ONLY_IF_EXISTS</a>)=0</td></tr>
|
|
<tr class="memdesc:a9f7cdc52b59034e6e55eb8a56b427aa4"><td class="mdescLeft"> </td><td class="mdescRight">Return an interface pointer to the module. <a href="classas_i_script_engine.html#a9f7cdc52b59034e6e55eb8a56b427aa4">More...</a><br /></td></tr>
|
|
<tr class="separator:a9f7cdc52b59034e6e55eb8a56b427aa4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb0ce55e5846eb18afdcf906aeb67cf7"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#afb0ce55e5846eb18afdcf906aeb67cf7">DiscardModule</a> (const char *module)=0</td></tr>
|
|
<tr class="memdesc:afb0ce55e5846eb18afdcf906aeb67cf7"><td class="mdescLeft"> </td><td class="mdescRight">Discard a module. <a href="classas_i_script_engine.html#afb0ce55e5846eb18afdcf906aeb67cf7">More...</a><br /></td></tr>
|
|
<tr class="separator:afb0ce55e5846eb18afdcf906aeb67cf7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a457cf6202cc64ce8ee242dcc97d3422f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a457cf6202cc64ce8ee242dcc97d3422f">GetModuleCount</a> () const =0</td></tr>
|
|
<tr class="memdesc:a457cf6202cc64ce8ee242dcc97d3422f"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of modules. <a href="classas_i_script_engine.html#a457cf6202cc64ce8ee242dcc97d3422f">More...</a><br /></td></tr>
|
|
<tr class="separator:a457cf6202cc64ce8ee242dcc97d3422f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a31b95df21e6f1990cf84b3b286067675"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_script_module.html">asIScriptModule</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a31b95df21e6f1990cf84b3b286067675">GetModuleByIndex</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> index) const =0</td></tr>
|
|
<tr class="memdesc:a31b95df21e6f1990cf84b3b286067675"><td class="mdescLeft"> </td><td class="mdescRight">Get a module by index. <a href="classas_i_script_engine.html#a31b95df21e6f1990cf84b3b286067675">More...</a><br /></td></tr>
|
|
<tr class="separator:a31b95df21e6f1990cf84b3b286067675"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Script functions</div></td></tr>
|
|
<tr class="memitem:aaf67dc0b1f26be437ccbcc0ac5f330c9"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_script_function.html">asIScriptFunction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aaf67dc0b1f26be437ccbcc0ac5f330c9">GetFunctionById</a> (int funcId) const =0</td></tr>
|
|
<tr class="memdesc:aaf67dc0b1f26be437ccbcc0ac5f330c9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the function by its id. <a href="classas_i_script_engine.html#aaf67dc0b1f26be437ccbcc0ac5f330c9">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf67dc0b1f26be437ccbcc0ac5f330c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Type identification</div></td></tr>
|
|
<tr class="memitem:ad1f6fecb0f53fd7966736b01f65c3dcb"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ad1f6fecb0f53fd7966736b01f65c3dcb">GetTypeIdByDecl</a> (const char *decl) const =0</td></tr>
|
|
<tr class="memdesc:ad1f6fecb0f53fd7966736b01f65c3dcb"><td class="mdescLeft"> </td><td class="mdescRight">Returns a type id by declaration. <a href="classas_i_script_engine.html#ad1f6fecb0f53fd7966736b01f65c3dcb">More...</a><br /></td></tr>
|
|
<tr class="separator:ad1f6fecb0f53fd7966736b01f65c3dcb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ae23fcde6af0d816ff97097cd443281"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a3ae23fcde6af0d816ff97097cd443281">GetTypeDeclaration</a> (int typeId, bool includeNamespace=false) const =0</td></tr>
|
|
<tr class="memdesc:a3ae23fcde6af0d816ff97097cd443281"><td class="mdescLeft"> </td><td class="mdescRight">Returns a type declaration. <a href="classas_i_script_engine.html#a3ae23fcde6af0d816ff97097cd443281">More...</a><br /></td></tr>
|
|
<tr class="separator:a3ae23fcde6af0d816ff97097cd443281"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39b7207a6c4c55a5cbf10eab2ccfb8e6"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a39b7207a6c4c55a5cbf10eab2ccfb8e6">GetSizeOfPrimitiveType</a> (int typeId) const =0</td></tr>
|
|
<tr class="memdesc:a39b7207a6c4c55a5cbf10eab2ccfb8e6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the size of a primitive type. <a href="classas_i_script_engine.html#a39b7207a6c4c55a5cbf10eab2ccfb8e6">More...</a><br /></td></tr>
|
|
<tr class="separator:a39b7207a6c4c55a5cbf10eab2ccfb8e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55cc2d9592651538efcf79eb8106a867"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a55cc2d9592651538efcf79eb8106a867">GetTypeInfoById</a> (int typeId) const =0</td></tr>
|
|
<tr class="memdesc:a55cc2d9592651538efcf79eb8106a867"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type interface for type. <a href="classas_i_script_engine.html#a55cc2d9592651538efcf79eb8106a867">More...</a><br /></td></tr>
|
|
<tr class="separator:a55cc2d9592651538efcf79eb8106a867"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aea2583b8aa724779b7c37df8b7fa437b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aea2583b8aa724779b7c37df8b7fa437b">GetTypeInfoByName</a> (const char *name) const =0</td></tr>
|
|
<tr class="memdesc:aea2583b8aa724779b7c37df8b7fa437b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type interface by name. <a href="classas_i_script_engine.html#aea2583b8aa724779b7c37df8b7fa437b">More...</a><br /></td></tr>
|
|
<tr class="separator:aea2583b8aa724779b7c37df8b7fa437b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab00808f9b762c4badf508ed511789d1b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ab00808f9b762c4badf508ed511789d1b">GetTypeInfoByDecl</a> (const char *decl) const =0</td></tr>
|
|
<tr class="memdesc:ab00808f9b762c4badf508ed511789d1b"><td class="mdescLeft"> </td><td class="mdescRight">Returns a type by declaration. <a href="classas_i_script_engine.html#ab00808f9b762c4badf508ed511789d1b">More...</a><br /></td></tr>
|
|
<tr class="separator:ab00808f9b762c4badf508ed511789d1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Script execution</div></td></tr>
|
|
<tr class="memitem:a2630e1cd03ffab0fee9b820bf0afe42a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_script_context.html">asIScriptContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a2630e1cd03ffab0fee9b820bf0afe42a">CreateContext</a> ()=0</td></tr>
|
|
<tr class="memdesc:a2630e1cd03ffab0fee9b820bf0afe42a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new script context. <a href="classas_i_script_engine.html#a2630e1cd03ffab0fee9b820bf0afe42a">More...</a><br /></td></tr>
|
|
<tr class="separator:a2630e1cd03ffab0fee9b820bf0afe42a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3101479b4340bc16bb9acb8e8d554266"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a3101479b4340bc16bb9acb8e8d554266">CreateScriptObject</a> (const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:a3101479b4340bc16bb9acb8e8d554266"><td class="mdescLeft"> </td><td class="mdescRight">Creates an object defined by its type. <a href="classas_i_script_engine.html#a3101479b4340bc16bb9acb8e8d554266">More...</a><br /></td></tr>
|
|
<tr class="separator:a3101479b4340bc16bb9acb8e8d554266"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2b1543ea6d24b912aebeb77e6764269"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ab2b1543ea6d24b912aebeb77e6764269">CreateScriptObjectCopy</a> (void *obj, const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:ab2b1543ea6d24b912aebeb77e6764269"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of a script object. <a href="classas_i_script_engine.html#ab2b1543ea6d24b912aebeb77e6764269">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2b1543ea6d24b912aebeb77e6764269"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9de3c5e4465f699ad698740d6037e1a6"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a9de3c5e4465f699ad698740d6037e1a6">CreateUninitializedScriptObject</a> (const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:a9de3c5e4465f699ad698740d6037e1a6"><td class="mdescLeft"> </td><td class="mdescRight">Creates an uninitialized script object defined by its type. <a href="classas_i_script_engine.html#a9de3c5e4465f699ad698740d6037e1a6">More...</a><br /></td></tr>
|
|
<tr class="separator:a9de3c5e4465f699ad698740d6037e1a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4a4cea1cfeea361b8a44d80f3d928e3"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_script_function.html">asIScriptFunction</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ab4a4cea1cfeea361b8a44d80f3d928e3">CreateDelegate</a> (<a class="el" href="classas_i_script_function.html">asIScriptFunction</a> *func, void *obj)=0</td></tr>
|
|
<tr class="memdesc:ab4a4cea1cfeea361b8a44d80f3d928e3"><td class="mdescLeft"> </td><td class="mdescRight">Create a delegate for an object and method. <a href="classas_i_script_engine.html#ab4a4cea1cfeea361b8a44d80f3d928e3">More...</a><br /></td></tr>
|
|
<tr class="separator:ab4a4cea1cfeea361b8a44d80f3d928e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9180da5fd475f52916be6b39e522fabb"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a9180da5fd475f52916be6b39e522fabb">AssignScriptObject</a> (void *dstObj, void *srcObj, const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:a9180da5fd475f52916be6b39e522fabb"><td class="mdescLeft"> </td><td class="mdescRight">Copy one script object to another. <a href="classas_i_script_engine.html#a9180da5fd475f52916be6b39e522fabb">More...</a><br /></td></tr>
|
|
<tr class="separator:a9180da5fd475f52916be6b39e522fabb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82873d3769ded547894a7c3d52c220fd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a82873d3769ded547894a7c3d52c220fd">ReleaseScriptObject</a> (void *obj, const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:a82873d3769ded547894a7c3d52c220fd"><td class="mdescLeft"> </td><td class="mdescRight">Release the object pointer. <a href="classas_i_script_engine.html#a82873d3769ded547894a7c3d52c220fd">More...</a><br /></td></tr>
|
|
<tr class="separator:a82873d3769ded547894a7c3d52c220fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade1d309876c876c733d437a53e708c28"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ade1d309876c876c733d437a53e708c28">AddRefScriptObject</a> (void *obj, const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:ade1d309876c876c733d437a53e708c28"><td class="mdescLeft"> </td><td class="mdescRight">Increase the reference counter for the script object. <a href="classas_i_script_engine.html#ade1d309876c876c733d437a53e708c28">More...</a><br /></td></tr>
|
|
<tr class="separator:ade1d309876c876c733d437a53e708c28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32c9d9aac77a67eeb046fc67d7473fa2"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a32c9d9aac77a67eeb046fc67d7473fa2">RefCastObject</a> (void *obj, <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *fromType, <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *toType, void **newPtr, bool useOnlyImplicitCast=false)=0</td></tr>
|
|
<tr class="memdesc:a32c9d9aac77a67eeb046fc67d7473fa2"><td class="mdescLeft"> </td><td class="mdescRight">Returns the handle on a successful reference cast to desired type. <a href="classas_i_script_engine.html#a32c9d9aac77a67eeb046fc67d7473fa2">More...</a><br /></td></tr>
|
|
<tr class="separator:a32c9d9aac77a67eeb046fc67d7473fa2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab31103bef62096445fe03632de691827"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_lockable_shared_bool.html">asILockableSharedBool</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ab31103bef62096445fe03632de691827">GetWeakRefFlagOfScriptObject</a> (void *obj, const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type) const =0</td></tr>
|
|
<tr class="memdesc:ab31103bef62096445fe03632de691827"><td class="mdescLeft"> </td><td class="mdescRight">Returns the weak ref flag from the object. <a href="classas_i_script_engine.html#ab31103bef62096445fe03632de691827">More...</a><br /></td></tr>
|
|
<tr class="separator:ab31103bef62096445fe03632de691827"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Context pooling</div></td></tr>
|
|
<tr class="memitem:a32391ee83e58083b406ba068ab2ee049"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classas_i_script_context.html">asIScriptContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a32391ee83e58083b406ba068ab2ee049">RequestContext</a> ()=0</td></tr>
|
|
<tr class="memdesc:a32391ee83e58083b406ba068ab2ee049"><td class="mdescLeft"> </td><td class="mdescRight">Request a context. <a href="classas_i_script_engine.html#a32391ee83e58083b406ba068ab2ee049">More...</a><br /></td></tr>
|
|
<tr class="separator:a32391ee83e58083b406ba068ab2ee049"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22e42bf32902cbd6885731a6beeaca20"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a22e42bf32902cbd6885731a6beeaca20">ReturnContext</a> (<a class="el" href="classas_i_script_context.html">asIScriptContext</a> *ctx)=0</td></tr>
|
|
<tr class="memdesc:a22e42bf32902cbd6885731a6beeaca20"><td class="mdescLeft"> </td><td class="mdescRight">Return a context when it won't be used anymore. <a href="classas_i_script_engine.html#a22e42bf32902cbd6885731a6beeaca20">More...</a><br /></td></tr>
|
|
<tr class="separator:a22e42bf32902cbd6885731a6beeaca20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5ba9fe99b72c60392cdaeef164f2c65"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ae5ba9fe99b72c60392cdaeef164f2c65">SetContextCallbacks</a> (<a class="el" href="angelscript_8h.html#a2925360becae92319e68abb23a61fd56">asREQUESTCONTEXTFUNC_t</a> requestCtx, <a class="el" href="angelscript_8h.html#a3ffcfca5bd3be4f4c633408a6b209476">asRETURNCONTEXTFUNC_t</a> returnCtx, void *param=0)=0</td></tr>
|
|
<tr class="memdesc:ae5ba9fe99b72c60392cdaeef164f2c65"><td class="mdescLeft"> </td><td class="mdescRight">Register context callbacks for pooling. <a href="classas_i_script_engine.html#ae5ba9fe99b72c60392cdaeef164f2c65">More...</a><br /></td></tr>
|
|
<tr class="separator:ae5ba9fe99b72c60392cdaeef164f2c65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">String interpretation</div></td></tr>
|
|
<tr class="memitem:a57ecbd86ae9370684877c755e83cef0d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="angelscript_8h.html#a012a602727ca3fe1efa27053bc58cbca">asETokenClass</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a57ecbd86ae9370684877c755e83cef0d">ParseToken</a> (const char *string, size_t stringLength=0, <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> *tokenLength=0) const =0</td></tr>
|
|
<tr class="memdesc:a57ecbd86ae9370684877c755e83cef0d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the class and length of the first token in the string. <a href="classas_i_script_engine.html#a57ecbd86ae9370684877c755e83cef0d">More...</a><br /></td></tr>
|
|
<tr class="separator:a57ecbd86ae9370684877c755e83cef0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Garbage collection</div></td></tr>
|
|
<tr class="memitem:a17511a1de72ecdb836b974768f2ec422"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a17511a1de72ecdb836b974768f2ec422">GarbageCollect</a> (<a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> flags=<a class="el" href="angelscript_8h.html#ac06582350753eb4d89d6ba9442eadf9da31e476bfb875b0f4fb209a3ef2540709">asGC_FULL_CYCLE</a>, <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> numIterations=1)=0</td></tr>
|
|
<tr class="memdesc:a17511a1de72ecdb836b974768f2ec422"><td class="mdescLeft"> </td><td class="mdescRight">Perform garbage collection. <a href="classas_i_script_engine.html#a17511a1de72ecdb836b974768f2ec422">More...</a><br /></td></tr>
|
|
<tr class="separator:a17511a1de72ecdb836b974768f2ec422"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a166e6cdd0cb35bcfd942824d8e882783"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a166e6cdd0cb35bcfd942824d8e882783">GetGCStatistics</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> *currentSize, <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> *totalDestroyed=0, <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> *totalDetected=0, <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> *newObjects=0, <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> *totalNewDestroyed=0) const =0</td></tr>
|
|
<tr class="memdesc:a166e6cdd0cb35bcfd942824d8e882783"><td class="mdescLeft"> </td><td class="mdescRight">Obtain statistics from the garbage collector. <a href="classas_i_script_engine.html#a166e6cdd0cb35bcfd942824d8e882783">More...</a><br /></td></tr>
|
|
<tr class="separator:a166e6cdd0cb35bcfd942824d8e882783"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52a7644b48cbc771e33db5070814f6df"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a52a7644b48cbc771e33db5070814f6df">NotifyGarbageCollectorOfNewObject</a> (void *obj, <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:a52a7644b48cbc771e33db5070814f6df"><td class="mdescLeft"> </td><td class="mdescRight">Notify the garbage collector of a new object that needs to be managed. <a href="classas_i_script_engine.html#a52a7644b48cbc771e33db5070814f6df">More...</a><br /></td></tr>
|
|
<tr class="separator:a52a7644b48cbc771e33db5070814f6df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39a5f221baa01d43e7471c0e9f5378e4"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a39a5f221baa01d43e7471c0e9f5378e4">GetObjectInGC</a> (<a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> idx, <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> *seqNbr=0, void **obj=0, <a class="el" href="classas_i_type_info.html">asITypeInfo</a> **type=0)=0</td></tr>
|
|
<tr class="memdesc:a39a5f221baa01d43e7471c0e9f5378e4"><td class="mdescLeft"> </td><td class="mdescRight">Gets an object in the garbage collector. <a href="classas_i_script_engine.html#a39a5f221baa01d43e7471c0e9f5378e4">More...</a><br /></td></tr>
|
|
<tr class="separator:a39a5f221baa01d43e7471c0e9f5378e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58ceeafd780dea3543e0ede4106199fd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a58ceeafd780dea3543e0ede4106199fd">GCEnumCallback</a> (void *reference)=0</td></tr>
|
|
<tr class="memdesc:a58ceeafd780dea3543e0ede4106199fd"><td class="mdescLeft"> </td><td class="mdescRight">Used by the garbage collector to enumerate all references held by an object. <a href="classas_i_script_engine.html#a58ceeafd780dea3543e0ede4106199fd">More...</a><br /></td></tr>
|
|
<tr class="separator:a58ceeafd780dea3543e0ede4106199fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe95ce0e45d914fec478fa112a7bb8dd"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#abe95ce0e45d914fec478fa112a7bb8dd">ForwardGCEnumReferences</a> (void *ref, <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:abe95ce0e45d914fec478fa112a7bb8dd"><td class="mdescLeft"> </td><td class="mdescRight">Used to forward GC callback to held value types that may contain references. <a href="classas_i_script_engine.html#abe95ce0e45d914fec478fa112a7bb8dd">More...</a><br /></td></tr>
|
|
<tr class="separator:abe95ce0e45d914fec478fa112a7bb8dd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60cdec608a18f6ebc0aebe29a143183f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a60cdec608a18f6ebc0aebe29a143183f">ForwardGCReleaseReferences</a> (void *ref, <a class="el" href="classas_i_type_info.html">asITypeInfo</a> *type)=0</td></tr>
|
|
<tr class="memdesc:a60cdec608a18f6ebc0aebe29a143183f"><td class="mdescLeft"> </td><td class="mdescRight">Used to forward GC callback to held value types that may contain references. <a href="classas_i_script_engine.html#a60cdec608a18f6ebc0aebe29a143183f">More...</a><br /></td></tr>
|
|
<tr class="separator:a60cdec608a18f6ebc0aebe29a143183f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac3d5b7c9920b4f98405a19e515ceb26"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aac3d5b7c9920b4f98405a19e515ceb26">SetCircularRefDetectedCallback</a> (<a class="el" href="angelscript_8h.html#ad39eb868abeebf44bb67fd3965f8bc5f">asCIRCULARREFFUNC_t</a> callback, void *param=0)=0</td></tr>
|
|
<tr class="memdesc:aac3d5b7c9920b4f98405a19e515ceb26"><td class="mdescLeft"> </td><td class="mdescRight">Set a callback for capturing more info on circular reference for debugging. <a href="classas_i_script_engine.html#aac3d5b7c9920b4f98405a19e515ceb26">More...</a><br /></td></tr>
|
|
<tr class="separator:aac3d5b7c9920b4f98405a19e515ceb26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">User data</div></td></tr>
|
|
<tr class="memitem:aabee8d6ef426c434adee85ec6d57f940"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#aabee8d6ef426c434adee85ec6d57f940">SetUserData</a> (void *data, <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> type=0)=0</td></tr>
|
|
<tr class="memdesc:aabee8d6ef426c434adee85ec6d57f940"><td class="mdescLeft"> </td><td class="mdescRight">Register the memory address of some user data. <a href="classas_i_script_engine.html#aabee8d6ef426c434adee85ec6d57f940">More...</a><br /></td></tr>
|
|
<tr class="separator:aabee8d6ef426c434adee85ec6d57f940"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a701aa6a7ddf51a22c62281f3dec9a772"><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a701aa6a7ddf51a22c62281f3dec9a772">GetUserData</a> (<a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> type=0) const =0</td></tr>
|
|
<tr class="memdesc:a701aa6a7ddf51a22c62281f3dec9a772"><td class="mdescLeft"> </td><td class="mdescRight">Returns the address of the previously registered user data. <a href="classas_i_script_engine.html#a701aa6a7ddf51a22c62281f3dec9a772">More...</a><br /></td></tr>
|
|
<tr class="separator:a701aa6a7ddf51a22c62281f3dec9a772"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8fa4fc9aacb99db6d4be0a5542b85e35"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a8fa4fc9aacb99db6d4be0a5542b85e35">SetEngineUserDataCleanupCallback</a> (<a class="el" href="angelscript_8h.html#aa3dd561bcccb3d5e4966966d7eb2715c">asCLEANENGINEFUNC_t</a> callback, <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> type=0)=0</td></tr>
|
|
<tr class="memdesc:a8fa4fc9aacb99db6d4be0a5542b85e35"><td class="mdescLeft"> </td><td class="mdescRight">Set the function that should be called when the engine is destroyed. <a href="classas_i_script_engine.html#a8fa4fc9aacb99db6d4be0a5542b85e35">More...</a><br /></td></tr>
|
|
<tr class="separator:a8fa4fc9aacb99db6d4be0a5542b85e35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7523853b9a9bf7dab603fa6a06393d51"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a7523853b9a9bf7dab603fa6a06393d51">SetModuleUserDataCleanupCallback</a> (<a class="el" href="angelscript_8h.html#a5a01d6871440c3b6261da54a8308c452">asCLEANMODULEFUNC_t</a> callback, <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> type=0)=0</td></tr>
|
|
<tr class="memdesc:a7523853b9a9bf7dab603fa6a06393d51"><td class="mdescLeft"> </td><td class="mdescRight">Set the function that should be called when the module is destroyed. <a href="classas_i_script_engine.html#a7523853b9a9bf7dab603fa6a06393d51">More...</a><br /></td></tr>
|
|
<tr class="separator:a7523853b9a9bf7dab603fa6a06393d51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acaced7eb9ebe013ede23f7593daf58e3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#acaced7eb9ebe013ede23f7593daf58e3">SetContextUserDataCleanupCallback</a> (<a class="el" href="angelscript_8h.html#a761b892984e5af51e0f6e37c27dfadb6">asCLEANCONTEXTFUNC_t</a> callback, <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> type=0)=0</td></tr>
|
|
<tr class="memdesc:acaced7eb9ebe013ede23f7593daf58e3"><td class="mdescLeft"> </td><td class="mdescRight">Set the function that should be called when a context is destroyed. <a href="classas_i_script_engine.html#acaced7eb9ebe013ede23f7593daf58e3">More...</a><br /></td></tr>
|
|
<tr class="separator:acaced7eb9ebe013ede23f7593daf58e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae75ee087fe6608cf0af1c24794ca73c7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#ae75ee087fe6608cf0af1c24794ca73c7">SetFunctionUserDataCleanupCallback</a> (<a class="el" href="angelscript_8h.html#a6c0fcc7fee72733c9feb03c0bbf8f5d6">asCLEANFUNCTIONFUNC_t</a> callback, <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> type=0)=0</td></tr>
|
|
<tr class="memdesc:ae75ee087fe6608cf0af1c24794ca73c7"><td class="mdescLeft"> </td><td class="mdescRight">Set the function that should be called when a function is destroyed. <a href="classas_i_script_engine.html#ae75ee087fe6608cf0af1c24794ca73c7">More...</a><br /></td></tr>
|
|
<tr class="separator:ae75ee087fe6608cf0af1c24794ca73c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afa31e7c28c63a2c876d8e08305cf5d75"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#afa31e7c28c63a2c876d8e08305cf5d75">SetTypeInfoUserDataCleanupCallback</a> (<a class="el" href="angelscript_8h.html#aca9bfb1e5a93426df269bd10d88e5cb3">asCLEANTYPEINFOFUNC_t</a> callback, <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> type=0)=0</td></tr>
|
|
<tr class="memdesc:afa31e7c28c63a2c876d8e08305cf5d75"><td class="mdescLeft"> </td><td class="mdescRight">Set the function that should be called when a type info is destroyed. <a href="classas_i_script_engine.html#afa31e7c28c63a2c876d8e08305cf5d75">More...</a><br /></td></tr>
|
|
<tr class="separator:afa31e7c28c63a2c876d8e08305cf5d75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4654e2cae0690c50e19b177f1ec54592"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#a4654e2cae0690c50e19b177f1ec54592">SetScriptObjectUserDataCleanupCallback</a> (<a class="el" href="angelscript_8h.html#ab89ff127aa05aef3793646b377e9c724">asCLEANSCRIPTOBJECTFUNC_t</a> callback, <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> type=0)=0</td></tr>
|
|
<tr class="memdesc:a4654e2cae0690c50e19b177f1ec54592"><td class="mdescLeft"> </td><td class="mdescRight">Set the function that should be called when a script object is destroyed. <a href="classas_i_script_engine.html#a4654e2cae0690c50e19b177f1ec54592">More...</a><br /></td></tr>
|
|
<tr class="separator:a4654e2cae0690c50e19b177f1ec54592"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Exception handling</div></td></tr>
|
|
<tr class="memitem:addce6a202934a4918f7776b2f77c43fd"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classas_i_script_engine.html#addce6a202934a4918f7776b2f77c43fd">SetTranslateAppExceptionCallback</a> (<a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> callback, void *param, int callConv)=0</td></tr>
|
|
<tr class="memdesc:addce6a202934a4918f7776b2f77c43fd"><td class="mdescLeft"> </td><td class="mdescRight">Register the exception translation callback. <a href="classas_i_script_engine.html#addce6a202934a4918f7776b2f77c43fd">More...</a><br /></td></tr>
|
|
<tr class="separator:addce6a202934a4918f7776b2f77c43fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The engine is the central object. It is where the application <a class="el" href="doc_register_api_topic.html">registers the application interface</a> that the scripts should be able to use, and it is where the application can <a class="el" href="doc_compile_script.html">request modules to build scripts</a> and <a class="el" href="doc_call_script_func.html">contexts to execute them</a>.</p>
|
|
<p>The engine instance is created with a call to <a class="el" href="group__api__principal__functions.html#gacb6a62345d9cca6c9b5a3dac67d80d0b">asCreateScriptEngine</a>.</p>
|
|
<p>It is allowed to have multiple instances of script engines, but there is rarely a need for it. Even if the application needs to expose different interfaces to different types of scripts this can usually be accomplished through the use of <a class="el" href="doc_adv_dynamic_config.html">configuration groups</a> and <a class="el" href="doc_adv_access_mask.html">access profiles</a>. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aa95a5d9b5d9e7e6a230fedf056eaf8ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa95a5d9b5d9e7e6a230fedf056eaf8ce">◆ </a></span>AddRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::AddRef </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of references to this object.</dd></dl>
|
|
<p>Call this method when storing an additional reference to the object. Remember that the first reference that is received from <a class="el" href="group__api__principal__functions.html#gacb6a62345d9cca6c9b5a3dac67d80d0b">asCreateScriptEngine</a> is already accounted for. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade1d309876c876c733d437a53e708c28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade1d309876c876c733d437a53e708c28">◆ </a></span>AddRefScriptObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::AddRefScriptObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>A pointer to the object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This calls the add ref method of the object to increase the reference count. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9180da5fd475f52916be6b39e522fabb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9180da5fd475f52916be6b39e522fabb">◆ </a></span>AssignScriptObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::AssignScriptObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>dstObj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>srcObj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstObj</td><td>A pointer to the destination object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srcObj</td><td>A pointer to the source object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the objects. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>One of the arguments is null </td></tr>
|
|
<tr><td class="paramname">asNOT_SUPPORTED</td><td>The object type is a ref type and value assignment has been turned off</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This calls the assignment operator to copy the object from one to the other.</p>
|
|
<p>This only works for objects. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac81014e50dd7efc1920adcb3fd2d1e5d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac81014e50dd7efc1920adcb3fd2d1e5d">◆ </a></span>BeginConfigGroup()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::BeginConfigGroup </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>groupName</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">groupName</td><td>The name of the configuration group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>Another group with the same name already exists. </td></tr>
|
|
<tr><td class="paramname">asNOT_SUPPORTED</td><td>Nesting configuration groups is not supported.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Starts a new dynamic configuration group. This group can be setup so that it is only visible to specific modules, and it can also be removed when it is no longer used.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_adv_dynamic_config.html">Dynamic configurations</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada64567fc9621e5e98160c7f03efa064"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada64567fc9621e5e98160c7f03efa064">◆ </a></span>ClearMessageCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::ClearMessageCallback </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error.</dd></dl>
|
|
<p>Call this method to remove the message callback. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2630e1cd03ffab0fee9b820bf0afe42a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2630e1cd03ffab0fee9b820bf0afe42a">◆ </a></span>CreateContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_script_context.html">asIScriptContext</a>* asIScriptEngine::CreateContext </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the new script context.</dd></dl>
|
|
<p>This method creates a context that will be used to execute the script functions. The context interface created will have its reference counter already increased.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classas_i_script_engine.html#a32391ee83e58083b406ba068ab2ee049">RequestContext</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab4a4cea1cfeea361b8a44d80f3d928e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4a4cea1cfeea361b8a44d80f3d928e3">◆ </a></span>CreateDelegate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_script_function.html">asIScriptFunction</a>* asIScriptEngine::CreateDelegate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classas_i_script_function.html">asIScriptFunction</a> * </td>
|
|
<td class="paramname"><em>func</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>obj</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">func</td><td>The object method </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>The object pointer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The new delegate instance </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3101479b4340bc16bb9acb8e8d554266"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3101479b4340bc16bb9acb8e8d554266">◆ </a></span>CreateScriptObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void* asIScriptEngine::CreateScriptObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the object to create. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the new object if successful, or null if not.</dd></dl>
|
|
<p>This method is used to create an object based on it's type. The method will call the object type's default factory. If the object type doesn't have a default factory the call will fail and no object will be created.</p>
|
|
<p>Created objects will have their reference counter set to 1 so the application needs to release the pointer when it will no longer use it.</p>
|
|
<p>If the type is a registered value type, then the memory for the object will be allocated using the <a class="el" href="group__api__memory__functions.html#ga527ab125defc58aa40cc151a25582a31">default memory routine</a>. To destroy and and deallocate the object it is best to use <a class="el" href="classas_i_script_engine.html#a82873d3769ded547894a7c3d52c220fd">ReleaseScriptObject</a>.</p>
|
|
<p>The method only works for objects, for primitive types and object handles the method doesn't do anything and returns a null pointer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2b1543ea6d24b912aebeb77e6764269"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2b1543ea6d24b912aebeb77e6764269">◆ </a></span>CreateScriptObjectCopy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void* asIScriptEngine::CreateScriptObjectCopy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>A pointer to the source object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the new object if successful, or null if not.</dd></dl>
|
|
<p>This method is used to create a copy of an existing object.</p>
|
|
<p>This only works for objects, for primitive types and object handles the method doesn't do anything and returns a null pointer. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9de3c5e4465f699ad698740d6037e1a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9de3c5e4465f699ad698740d6037e1a6">◆ </a></span>CreateUninitializedScriptObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void* asIScriptEngine::CreateUninitializedScriptObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the object to create. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the new object if successful, or null if not.</dd></dl>
|
|
<p>This method can only be used to create instances of script classes.</p>
|
|
<p>The returned object will only be initialized so far that there are no invalid pointers or references. The constructor of the script class will not be invoked.</p>
|
|
<p>If the script class has any registered types as members, the default constructor for those members will be executed.</p>
|
|
<p>This method is meant for objects that will be initialized manually by the application, e.g. when restoring a serialized object. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb0ce55e5846eb18afdcf906aeb67cf7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb0ce55e5846eb18afdcf906aeb67cf7">◆ </a></span>DiscardModule()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::DiscardModule </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>module</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">module</td><td>The name of the module </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asNO_MODULE</td><td>The module was not found.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Discards a module and frees its memory. Any pointers that the application holds to this module will be invalid after this call. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4cc5ed7ea71811655f7910d298bb5a02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4cc5ed7ea71811655f7910d298bb5a02">◆ </a></span>EndConfigGroup()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::EndConfigGroup </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asERROR</td><td>Can't end a group that hasn't been begun.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Ends the current configuration group. Once finished a config group cannot be changed, but it can be removed when it is no longer used.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_adv_dynamic_config.html">Dynamic configurations</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe95ce0e45d914fec478fa112a7bb8dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe95ce0e45d914fec478fa112a7bb8dd">◆ </a></span>ForwardGCEnumReferences()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::ForwardGCEnumReferences </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>ref</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The object pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the object</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This should be used by reference types that implement the <a class="el" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a08ccf78a37567b5dd192ff5d95c6667b">asBEHAVE_ENUMREFS</a> behaviour when the object holds a value type that can in turn contain references.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_gc_object.html">Garbage collected objects</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60cdec608a18f6ebc0aebe29a143183f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60cdec608a18f6ebc0aebe29a143183f">◆ </a></span>ForwardGCReleaseReferences()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::ForwardGCReleaseReferences </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>ref</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ref</td><td>The object pointer </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the object</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This should be used by reference types that implement the <a class="el" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a4275ebe0b4852f2d4a10d4d9db333fe9">asBEHAVE_RELEASEREFS</a> behaviour when the object holds a value type that can in turn contain references.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_gc_object.html">Garbage collected objects</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a17511a1de72ecdb836b974768f2ec422"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a17511a1de72ecdb836b974768f2ec422">◆ </a></span>GarbageCollect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GarbageCollect </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> </td>
|
|
<td class="paramname"><em>flags</em> = <code><a class="el" href="angelscript_8h.html#ac06582350753eb4d89d6ba9442eadf9da31e476bfb875b0f4fb209a3ef2540709">asGC_FULL_CYCLE</a></code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>numIterations</em> = <code>1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>Set to a combination of the <a class="el" href="angelscript_8h.html#ac06582350753eb4d89d6ba9442eadf9d">asEGCFlags</a>. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">numIterations</td><td>The number of iterations to perform when not doing a full cycle </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>1 if the cycle wasn't completed, 0 if it was.</dd></dl>
|
|
<p>This method will free script objects that can no longer be reached. When the engine is released the garbage collector will automatically do a full cycle to release all objects still alive. If the engine is long living it is important to call this method every once in a while to free up memory allocated by the scripts. If a script does a lot of allocations before returning it may be necessary to implement a line callback function that calls the garbage collector during execution of the script.</p>
|
|
<p>It is not necessary to do a full cycle with every call. This makes it possible to spread out the garbage collection time over a large period, thus not impacting the responsiveness of the application.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_gc.html">Garbage collection</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a58ceeafd780dea3543e0ede4106199fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58ceeafd780dea3543e0ede4106199fd">◆ </a></span>GCEnumCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::GCEnumCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>reference</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">reference</td><td>A pointer to the referenced object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>When processing the <a class="el" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a08ccf78a37567b5dd192ff5d95c6667b">asBEHAVE_ENUMREFS</a> call the called object should call GCEnumCallback for each of the references it holds to other objects. If the object holds a value type that may contain references, then use the <a class="el" href="classas_i_script_engine.html#abe95ce0e45d914fec478fa112a7bb8dd">ForwardGCEnumReferences</a>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_gc_object.html">Garbage collected objects</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae86e5444979b0abd92777be83c53fc80"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae86e5444979b0abd92777be83c53fc80">◆ </a></span>GetDefaultArrayTypeId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GetDefaultArrayTypeId </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The type id, or a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The default array type hasn't been registered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a257a25e285faa25e8cf08e455528def7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a257a25e285faa25e8cf08e455528def7">◆ </a></span>GetDefaultNamespace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const char* asIScriptEngine::GetDefaultNamespace </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The current default namespace </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5531bf5310a0c933aa698725a6828e5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5531bf5310a0c933aa698725a6828e5f">◆ </a></span>GetEngineProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> asIScriptEngine::GetEngineProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a53c2e8a74ade77c928316396394ebe0f">asEEngineProp</a> </td>
|
|
<td class="paramname"><em>property</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>One of the <a class="el" href="angelscript_8h.html#a53c2e8a74ade77c928316396394ebe0f">asEEngineProp</a> values. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The value of the property, or 0 if it is an invalid property.</dd></dl>
|
|
<p>Calling this method lets you determine the current value of the engine properties. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adedc8b2ad11a84ec12aef4f98e27a4c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adedc8b2ad11a84ec12aef4f98e27a4c4">◆ </a></span>GetEnumByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a>* asIScriptEngine::GetEnumByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the enum type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type info of the registered enum type, or null on error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b4307dab64061be43db84ffb97e3782"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b4307dab64061be43db84ffb97e3782">◆ </a></span>GetEnumCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> asIScriptEngine::GetEnumCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of registered enum types. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad4228220347347384c0aa0e0dd8308c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad4228220347347384c0aa0e0dd8308c6">◆ </a></span>GetFuncdefByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a>* asIScriptEngine::GetFuncdefByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the funcdef. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type info of the funcdef.</dd></dl>
|
|
<p>This function does not increase the reference count of the returned function definition. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a48aceb1556f88ce3bec3e0f84abe127f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a48aceb1556f88ce3bec3e0f84abe127f">◆ </a></span>GetFuncdefCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> asIScriptEngine::GetFuncdefCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of registered funcdefs. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf67dc0b1f26be437ccbcc0ac5f330c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf67dc0b1f26be437ccbcc0ac5f330c9">◆ </a></span>GetFunctionById()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_script_function.html">asIScriptFunction</a>* asIScriptEngine::GetFunctionById </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>funcId</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">funcId</td><td>The id of the function or method. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the function description interface, or null if not found.</dd></dl>
|
|
<p>This does not increment the reference count of the returned function interface. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a166e6cdd0cb35bcfd942824d8e882783"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a166e6cdd0cb35bcfd942824d8e882783">◆ </a></span>GetGCStatistics()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::GetGCStatistics </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> * </td>
|
|
<td class="paramname"><em>currentSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> * </td>
|
|
<td class="paramname"><em>totalDestroyed</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> * </td>
|
|
<td class="paramname"><em>totalDetected</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> * </td>
|
|
<td class="paramname"><em>newObjects</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> * </td>
|
|
<td class="paramname"><em>totalNewDestroyed</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">currentSize</td><td>The current number of objects known to the garbage collector. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">totalDestroyed</td><td>The total number of objects destroyed by the garbage collector. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">totalDetected</td><td>The total number of objects detected as garbage with circular references. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">newObjects</td><td>The current number of objects in the new generation. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">totalNewDestroyed</td><td>The total number of objects destroyed while still in the new generation.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method can be used to query the number of objects that the garbage collector is keeping track of. If the number is very large then it is probably time to call the <a class="el" href="classas_i_script_engine.html#a17511a1de72ecdb836b974768f2ec422">GarbageCollect</a> method so that some of the objects ca be freed.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_gc.html">Garbage collection</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a42edd02e95731c795e13706400e8665a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42edd02e95731c795e13706400e8665a">◆ </a></span>GetGlobalFunctionByDecl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_script_function.html">asIScriptFunction</a>* asIScriptEngine::GetGlobalFunctionByDecl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>declaration</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">declaration</td><td>The signature of the function. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The function object, or null on error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf2b79cef75adb4099a24e3412e4ea79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf2b79cef75adb4099a24e3412e4ea79">◆ </a></span>GetGlobalFunctionByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_script_function.html">asIScriptFunction</a>* asIScriptEngine::GetGlobalFunctionByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the registered global function. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The function object, or null on error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a72aa1a3a5ac88a5a1dba4fa3655141d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a72aa1a3a5ac88a5a1dba4fa3655141d6">◆ </a></span>GetGlobalFunctionCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> asIScriptEngine::GetGlobalFunctionCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of registered functions. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a93bd686853a48647d2136792e27380fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a93bd686853a48647d2136792e27380fb">◆ </a></span>GetGlobalPropertyByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GetGlobalPropertyByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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>nameSpace</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int * </td>
|
|
<td class="paramname"><em>typeId</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>isConst</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char ** </td>
|
|
<td class="paramname"><em>configGroup</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void ** </td>
|
|
<td class="paramname"><em>pointer</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> * </td>
|
|
<td class="paramname"><em>accessMask</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the global variable. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">name</td><td>Receives the name of the property. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">nameSpace</td><td>Receives the namespace of the property. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">typeId</td><td>Receives the typeId of the property. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">isConst</td><td>Receives the constness indicator of the property. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">configGroup</td><td>Receives the config group in which the property was registered. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">pointer</td><td>Receives the pointer of the property. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">accessMask</td><td>Receives the access mask of the property. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td><em>index</em> is too large. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa69f6b37f9c7bdf9b52b9c1692daf048"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa69f6b37f9c7bdf9b52b9c1692daf048">◆ </a></span>GetGlobalPropertyCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> asIScriptEngine::GetGlobalPropertyCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of registered global properties. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a91a4cc8af51ca439ca82b9b6630439b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a91a4cc8af51ca439ca82b9b6630439b3">◆ </a></span>GetGlobalPropertyIndexByDecl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GetGlobalPropertyIndexByDecl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>decl</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">decl</td><td>The declaration of the property to search for. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The index of the matching property or negative on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asNO_GLOBAL_VAR</td><td>No matching property was found. </td></tr>
|
|
<tr><td class="paramname">asINVALID_DECLARATION</td><td>The given declaration is invalid. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07e85878869e4d0597c1177d767dc717"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07e85878869e4d0597c1177d767dc717">◆ </a></span>GetGlobalPropertyIndexByName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GetGlobalPropertyIndexByName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the property. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The index of the matching property or negative on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asNO_GLOBAL_VAR</td><td>No matching property was found. </td></tr>
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The name and scope for search cannot be determined.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The search for global properties will be performed in the default namespace as given by <a class="el" href="classas_i_script_engine.html#a605f114814f1f64804c04391816d948b">SetDefaultNamespace</a> unless the name is prefixed with a scope, using the scoping operator ::. If the scope starts with :: it will be used as the absolute scope, otherwise it will be relative to the default namespace. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2fb6db9085df3c7d487c0d58de76bb83"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2fb6db9085df3c7d487c0d58de76bb83">◆ </a></span>GetJITCompiler()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_j_i_t_compiler.html">asIJITCompiler</a>* asIScriptEngine::GetJITCompiler </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a pointer to the JIT compiler </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f7cdc52b59034e6e55eb8a56b427aa4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f7cdc52b59034e6e55eb8a56b427aa4">◆ </a></span>GetModule()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_script_module.html">asIScriptModule</a>* asIScriptEngine::GetModule </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>module</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ae4cf50de5273eb8c03c6e91e6e014f0c">asEGMFlags</a> </td>
|
|
<td class="paramname"><em>flag</em> = <code><a class="el" href="angelscript_8h.html#ae4cf50de5273eb8c03c6e91e6e014f0ca2feb963eb04c221e251867bc3a93d79d">asGM_ONLY_IF_EXISTS</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">module</td><td>The name of the module </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flag</td><td>One of the <a class="el" href="angelscript_8h.html#ae4cf50de5273eb8c03c6e91e6e014f0c">asEGMFlags</a> flags </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the module interface</dd></dl>
|
|
<p>Use this method to get access to the module interface, which will let you build new scripts, and enumerate functions and types in existing modules.</p>
|
|
<p>If <a class="el" href="angelscript_8h.html#ae4cf50de5273eb8c03c6e91e6e014f0ca0843ab784ed9a9ea6cb47d915825186f">asGM_ALWAYS_CREATE</a> is informed as the flag the previous module with the same name will be discarded, thus any pointers that the engine holds to it will be invalid after the call. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a31b95df21e6f1990cf84b3b286067675"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a31b95df21e6f1990cf84b3b286067675">◆ </a></span>GetModuleByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_script_module.html">asIScriptModule</a>* asIScriptEngine::GetModuleByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the module. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the module or null on error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a457cf6202cc64ce8ee242dcc97d3422f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a457cf6202cc64ce8ee242dcc97d3422f">◆ </a></span>GetModuleCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> asIScriptEngine::GetModuleCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of modules. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a39a5f221baa01d43e7471c0e9f5378e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39a5f221baa01d43e7471c0e9f5378e4">◆ </a></span>GetObjectInGC()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GetObjectInGC </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>idx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> * </td>
|
|
<td class="paramname"><em>seqNbr</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void ** </td>
|
|
<td class="paramname"><em>obj</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classas_i_type_info.html">asITypeInfo</a> ** </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">idx</td><td>The index of the desired object </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">seqNbr</td><td>The sequence number of the obtained object </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">obj</td><td>The object pointer </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">type</td><td>The type of the obtained object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The index is not valid </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afac08d4f81e587031c7863574c6783ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afac08d4f81e587031c7863574c6783ba">◆ </a></span>GetObjectTypeByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a>* asIScriptEngine::GetObjectTypeByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The registered object type interface for the type, or null if not found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2667fbe30dd00ed14bc14e6ef7fc725"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2667fbe30dd00ed14bc14e6ef7fc725">◆ </a></span>GetObjectTypeCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> asIScriptEngine::GetObjectTypeCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of object types registered by the application. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a39b7207a6c4c55a5cbf10eab2ccfb8e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a39b7207a6c4c55a5cbf10eab2ccfb8e6">◆ </a></span>GetSizeOfPrimitiveType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GetSizeOfPrimitiveType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>typeId</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">typeId</td><td>The type id of the type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The size of the type in bytes, or zero if it is not a primitive type.</dd></dl>
|
|
<p>This method can be used to return the size of any built-in primitive type, and also for script declared or application registered enums. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afb3935d85494231e2f02af5816ba9830"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afb3935d85494231e2f02af5816ba9830">◆ </a></span>GetStringFactoryReturnTypeId()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GetStringFactoryReturnTypeId </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> * </td>
|
|
<td class="paramname"><em>flags</em> = <code>0</code></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The type id of the type that the string type returns, or a negative value on error. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">flags</td><td>The <a class="el" href="angelscript_8h.html#a335bd4a1384b6e408bf9b37ffdeb54c7">type modifiers</a> for the return type </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asNO_FUNCTION</td><td>The string factory has not been registered. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3ae23fcde6af0d816ff97097cd443281"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3ae23fcde6af0d816ff97097cd443281">◆ </a></span>GetTypeDeclaration()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual const char* asIScriptEngine::GetTypeDeclaration </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>typeId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>includeNamespace</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">typeId</td><td>The type id of the type. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">includeNamespace</td><td>Set to true if the namespace should be included in the formatted declaration. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A null terminated string with the type declaration, or null if not found. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a635cd008ea123b510c66fbddcea735f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a635cd008ea123b510c66fbddcea735f5">◆ </a></span>GetTypedefByIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a>* asIScriptEngine::GetTypedefByIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The index of the typedef. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type info of the typedef. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0ebbbb86ea0e314cc2695f6276ebe507"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0ebbbb86ea0e314cc2695f6276ebe507">◆ </a></span>GetTypedefCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> asIScriptEngine::GetTypedefCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of registered typedefs. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad1f6fecb0f53fd7966736b01f65c3dcb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1f6fecb0f53fd7966736b01f65c3dcb">◆ </a></span>GetTypeIdByDecl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::GetTypeIdByDecl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>decl</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">decl</td><td>The declaration of the type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error, or the type id of the type. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td><em>decl</em> is not a valid type.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Translates a type declaration into a type id. The returned type id is valid for as long as the type is valid, so you can safely store it for later use to avoid potential overhead by calling this function each time. Just remember to update the type id, any time the type is changed within the engine, e.g. when recompiling script declared classes, or changing the engine configuration.</p>
|
|
<p>The type id is based on a sequence number and depends on the order in which the type ids are queried, thus is not guaranteed to always be the same for each execution of the application. The <a class="el" href="angelscript_8h.html#ae8c3a67a97321be53181e9ed396ad83a">asETypeIdFlags</a> can be used to obtain some information about the type directly from the id.</p>
|
|
<p>A base type yields the same type id whether the declaration is const or not, however if the const is for the subtype then the type id is different, e.g. string@ isn't the same as const string@ but string is the same as const string.</p>
|
|
<p>This method is only able to return the type id that are not specific for a script module, i.e. built-in types and application registered types. Type ids for script declared types should be obtained through the script module's <a class="el" href="classas_i_script_module.html#a7fbc2bd888b248d2c2ee2d953b49eefc">GetTypeIdByDecl</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab00808f9b762c4badf508ed511789d1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab00808f9b762c4badf508ed511789d1b">◆ </a></span>GetTypeInfoByDecl()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a>* asIScriptEngine::GetTypeInfoByDecl </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>decl</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">decl</td><td>The declaration of the type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type or null on error.</dd></dl>
|
|
<p>Translates a type declaration into the type info. The returned type is valid for as long as the type is valid, so you can safely store it for later use to avoid potential overhead from calling this function each time. Just remember to update the type info pointer any time the type is changed within the engine, e.g. when recompiling script declared classes, or changing the engine configuration. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55cc2d9592651538efcf79eb8106a867"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55cc2d9592651538efcf79eb8106a867">◆ </a></span>GetTypeInfoById()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a>* asIScriptEngine::GetTypeInfoById </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>typeId</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">typeId</td><td>The type id of the type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type interface for the type, or null if not found.</dd></dl>
|
|
<p>This does not increment the reference count of the returned type. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aea2583b8aa724779b7c37df8b7fa437b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aea2583b8aa724779b7c37df8b7fa437b">◆ </a></span>GetTypeInfoByName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_type_info.html">asITypeInfo</a>* asIScriptEngine::GetTypeInfoByName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type interface for the type, or null if not found.</dd></dl>
|
|
<p>The search for types will be performed in the default namespace as given by <a class="el" href="classas_i_script_engine.html#a605f114814f1f64804c04391816d948b">SetDefaultNamespace</a> unless the name is prefixed with a scope, using the scoping operator ::. If the scope starts with :: it will be used as the absolute scope, otherwise it will be relative to the default namespace. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a701aa6a7ddf51a22c62281f3dec9a772"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a701aa6a7ddf51a22c62281f3dec9a772">◆ </a></span>GetUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void* asIScriptEngine::GetUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>An identifier specifying the user data to get. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The pointer to the user data. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab31103bef62096445fe03632de691827"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab31103bef62096445fe03632de691827">◆ </a></span>GetWeakRefFlagOfScriptObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_lockable_shared_bool.html">asILockableSharedBool</a>* asIScriptEngine::GetWeakRefFlagOfScriptObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>The object </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The object type </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The weak ref flag, if the object supports weak references.</dd></dl>
|
|
<p>As long as the weak ref flag is not set, the owning object is still alive. Once the weak ref flag is set, the object is dead and should no longer be accessed. Check if the flag is set with the <a class="el" href="classas_i_lockable_shared_bool.html#abab39fc60f00ae8941423258ffc2c3c6">asILockableSharedBool::Get</a> method.</p>
|
|
<p>This method doesn't increase the reference to the returned shared boolean. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a52a7644b48cbc771e33db5070814f6df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a52a7644b48cbc771e33db5070814f6df">◆ </a></span>NotifyGarbageCollectorOfNewObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::NotifyGarbageCollectorOfNewObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>A pointer to the newly created object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The sequence number of the added object, or a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>Either the object or the type is null</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method should be called when a new garbage collected object is created. The GC will then store a reference to the object so that it can automatically detect whether the object is involved in any circular references that should be released.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_gc_object.html">Garbage collected objects</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a57ecbd86ae9370684877c755e83cef0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a57ecbd86ae9370684877c755e83cef0d">◆ </a></span>ParseToken()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#a012a602727ca3fe1efa27053bc58cbca">asETokenClass</a> asIScriptEngine::ParseToken </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>string</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>stringLength</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ac8186f029686800b7ce36bde4a55c815">asUINT</a> * </td>
|
|
<td class="paramname"><em>tokenLength</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">string</td><td>The string to parse. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">stringLength</td><td>The length of the string. Can be 0 if the string is null terminated. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">tokenLength</td><td>Gives the length of the identified token. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>One of the <a class="el" href="angelscript_8h.html#a012a602727ca3fe1efa27053bc58cbca">asETokenClass</a> values.</dd></dl>
|
|
<p>This function is useful for those applications that want to tokenize strings into tokens that the script language uses, e.g. IDEs providing syntax highlighting, or intellisense. It can also be used to parse the meta data strings that may be declared for script entities. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a32c9d9aac77a67eeb046fc67d7473fa2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32c9d9aac77a67eeb046fc67d7473fa2">◆ </a></span>RefCastObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RefCastObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>fromType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>toType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void ** </td>
|
|
<td class="paramname"><em>newPtr</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>useOnlyImplicitCast</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>A pointer to the object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">fromType</td><td>The type of the object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">toType</td><td>The desired type for the cast. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">newPtr</td><td>The new pointer to the object if successful. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">useOnlyImplicitCast</td><td>If only the implicit reference cast operators should be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>A null pointer was supplied</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method is used to cast an pointer to a different type. While both the new and old pointers are expected to refer to the same instance, the address of the pointers are not necessarily the same.</p>
|
|
<p>If the cast is successful the <em>newPtr</em> will be set to the new pointer, and the reference counter will be incremented. If the cast is not successful, the <em>newPtr</em> will be set to null, and the reference count left unchanged. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9451feece1297eba8d1649036039e82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9451feece1297eba8d1649036039e82">◆ </a></span>RegisterDefaultArrayType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterDefaultArrayType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The name of the template type, e.g. array<T> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The type is not a template type </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abed6e77f2a532c8a4f528650fa137d37"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abed6e77f2a532c8a4f528650fa137d37">◆ </a></span>RegisterEnum()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterEnum </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The name of the enum type. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type id on success, or a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_NAME</td><td><em>type</em> is null, not an identifier, or it is a reserved keyword. </td></tr>
|
|
<tr><td class="paramname">asALREADY_REGISTERED</td><td>Another type with this name already exists. </td></tr>
|
|
<tr><td class="paramname">asERROR</td><td>The <em>type</em> couldn't be parsed. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The type name is already taken.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method registers an enum type in the engine. The enum values should then be registered with <a class="el" href="classas_i_script_engine.html#a4d331153596dd39838f3bed2a861af18">RegisterEnumValue</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4d331153596dd39838f3bed2a861af18"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d331153596dd39838f3bed2a861af18">◆ </a></span>RegisterEnumValue()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterEnumValue </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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">int </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The name of the enum type. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the enum value. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The integer value of the enum value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asWRONG_CONFIG_GROUP</td><td>The enum <em>type</em> was registered in a different configuration group. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The <em>type</em> is invalid. </td></tr>
|
|
<tr><td class="paramname">asALREADY_REGISTERED</td><td>The <em>name</em> is already registered for this enum.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method registers an enum value for a previously registered enum type. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03c1a2cc23ae4b742c927f3472a1a4f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03c1a2cc23ae4b742c927f3472a1a4f7">◆ </a></span>RegisterFuncdef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterFuncdef </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>decl</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">decl</td><td>The declaration of the function definition. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type id on success, else a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The <em>decl</em> parameter is not given. </td></tr>
|
|
<tr><td class="paramname">asINVALID_DECLARATION</td><td><em>decl</em> is not a valid function definition. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The name of the funcdef conflicts with another name.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p><a class="el" href="doc_datatypes_funcptr.html">Funcdefs</a> are used to define the signature of function pointers. If the application is going to receive function pointers from scripts, it is necessary to first register the funcdef before registering the function or property that will be used to receive it.</p>
|
|
<p>Funcdefs are usually registered as global entities, but can also be registered as a child of a class. To do this simply prefix the name of the funcdef with the name of the class and the scope operator to specify which class should be the owner. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2f84b9b51733f22c68b8448b02c2f1c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f84b9b51733f22c68b8448b02c2f1c7">◆ </a></span>RegisterGlobalFunction()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterGlobalFunction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>declaration</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> & </td>
|
|
<td class="paramname"><em>funcPointer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> </td>
|
|
<td class="paramname"><em>callConv</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>auxiliary</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">declaration</td><td>The declaration of the global function in script syntax. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">funcPointer</td><td>The function pointer. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callConv</td><td>The calling convention for the function. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">auxiliary</td><td>A helper object for use with some calling conventions. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error, or the function id if successful. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asNOT_SUPPORTED</td><td>The calling convention is not supported. </td></tr>
|
|
<tr><td class="paramname">asWRONG_CALLING_CONV</td><td>The function's calling convention doesn't match <em>callConv</em>. </td></tr>
|
|
<tr><td class="paramname">asINVALID_DECLARATION</td><td>The function declaration is invalid. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The function name is already used elsewhere. </td></tr>
|
|
<tr><td class="paramname">asALREADY_REGISTERED</td><td>The function has already been registered with the same parameter list. </td></tr>
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The <em>auxiliary</em> pointer wasn't set according to calling convention.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method registers system functions that the scripts may use to communicate with the host application.</p>
|
|
<p>The <em>auxiliary</em> pointer can optionally be used with <a class="el" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4a750c26b6a6e0c9ccbb93078f532ef8ce">asCALL_GENERIC</a>. For the calling convention <a class="el" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4aa241a0c1deedaa2d55eb99a83829efad">asCALL_THISCALL_ASGLOBAL</a> the <em>auxiliary</em> is required.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_register_func.html">Registering a function</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aacd32f32b2922b8ffaed204812013169"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacd32f32b2922b8ffaed204812013169">◆ </a></span>RegisterGlobalProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterGlobalProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>declaration</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>pointer</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">declaration</td><td>The declaration of the global property in script syntax. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pointer</td><td>The address of the property that will be used to access the property value. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The index of the property on success, or a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_DECLARATION</td><td>The declaration has invalid syntax. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The declaration is a reference. </td></tr>
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The pointer is null. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The name is already taken.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Use this method to register a global property that the scripts will be able to access as global variables. The property may optionally be registered as const, if the scripts shouldn't be allowed to modify it.</p>
|
|
<p>When registering the property, the application must pass the address to the actual value. The application must also make sure that this address remains valid throughout the life time of this registration, i.e. until the engine is released or the dynamic configuration group is removed.</p>
|
|
<p>Upon success the function returns the index of the registered property <br />
|
|
that can be used to lookup the info with <a class="el" href="classas_i_script_engine.html#a93bd686853a48647d2136792e27380fb">GetGlobalPropertyByIndex</a>. Note that this index may not stay valid after a <a class="el" href="doc_adv_dynamic_config.html">dynamic config group</a> has been removed, which would reorganize the internal structure. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2d89b82561b7f9843f35693c664589f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2d89b82561b7f9843f35693c664589f">◆ </a></span>RegisterInterface()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterInterface </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the interface. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type id of the interface on success, else a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_NAME</td><td>The <em>name</em> is null, or a reserved keyword. </td></tr>
|
|
<tr><td class="paramname">asALREADY_REGISTERED</td><td>An object type with this name already exists. </td></tr>
|
|
<tr><td class="paramname">asERROR</td><td>The <em>name</em> is not a proper identifier. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The <em>name</em> is already used elsewhere.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This registers an interface that script classes can implement. By doing this the application can register functions and methods that receives an <a class="el" href="classas_i_script_object.html">asIScriptObject</a> and still be sure that the class implements certain methods needed by the application.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_use_script_class.html#doc_use_script_class_3">Receiving script classes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a43bd2c12c94a55c22be76d209de93f1a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a43bd2c12c94a55c22be76d209de93f1a">◆ </a></span>RegisterInterfaceMethod()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterInterfaceMethod </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>intf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>declaration</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">intf</td><td>The name of the interface. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">declaration</td><td>The method declaration. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asWRONG_CONFIG_GROUP</td><td>The interface was registered in another configuration group. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td><em>intf</em> is not an interface type. </td></tr>
|
|
<tr><td class="paramname">asINVALID_DECLARATION</td><td>The <em>declaration</em> is invalid. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The method name is already taken.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This registers a method that the class that implements the script interface must have. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f122dd87394f3a83ac766ea19f37317"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f122dd87394f3a83ac766ea19f37317">◆ </a></span>RegisterObjectBehaviour()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterObjectBehaviour </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5">asEBehaviours</a> </td>
|
|
<td class="paramname"><em>behaviour</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>declaration</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> & </td>
|
|
<td class="paramname"><em>funcPointer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> </td>
|
|
<td class="paramname"><em>callConv</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>auxiliary</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>compositeOffset</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isCompositeIndirect</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>The name of the type. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">behaviour</td><td>One of the object behaviours from <a class="el" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5">asEBehaviours</a>. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">declaration</td><td>The declaration of the method in script syntax. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">funcPointer</td><td>The method or function pointer. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callConv</td><td>The calling convention for the method or function. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">auxiliary</td><td>A helper object for use with some calling conventions. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">compositeOffset</td><td>The offset to the composite object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">isCompositeIndirect</td><td>Set to false if the composite object is inline, and true if it is refered to by pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error, or the function id is successful. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asWRONG_CONFIG_GROUP</td><td>The object type was registered in a different configuration group. </td></tr>
|
|
<tr><td class="paramname">asINVALID_ARG</td><td><em>obj</em> is not set, or a global behaviour is given in <em>behaviour</em>, or the <em>objForThiscall</em> pointer wasn't set according to calling convention. </td></tr>
|
|
<tr><td class="paramname">asWRONG_CALLING_CONV</td><td>The function's calling convention isn't compatible with <em>callConv</em>. </td></tr>
|
|
<tr><td class="paramname">asNOT_SUPPORTED</td><td>The calling convention or the behaviour signature is not supported. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The <em>obj</em> parameter is not a valid object name. </td></tr>
|
|
<tr><td class="paramname">asINVALID_DECLARATION</td><td>The <em>declaration</em> is invalid. </td></tr>
|
|
<tr><td class="paramname">asILLEGAL_BEHAVIOUR_FOR_TYPE</td><td>The <em>behaviour</em> is not allowed for this type. </td></tr>
|
|
<tr><td class="paramname">asALREADY_REGISTERED</td><td>The behaviour is already registered with the same signature.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Use this method to register behaviour functions that will be called by the virtual machine to perform certain operations, such as memory management, math operations, comparisons, etc.</p>
|
|
<p>The <em>declaration</em> must form a valid function signature, but the give function name will not be used or stored in the application so there is no need to provide a meaningful function name.</p>
|
|
<p>The <em>auxiliary</em> pointer can optionally be used with <a class="el" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4a750c26b6a6e0c9ccbb93078f532ef8ce">asCALL_GENERIC</a>. For the calling conventions <a class="el" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4aa241a0c1deedaa2d55eb99a83829efad">asCALL_THISCALL_ASGLOBAL</a>, <a class="el" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4a613a388ed51315f6fce19f3824d6b17a">asCALL_THISCALL_OBJFIRST</a> and asCALL_THISCALL_OBJLAST the <em>auxiliary</em> is required.</p>
|
|
<p>In case the method to be registered is part of a composite member, then the compositeOffset should be used to give the offset to the composite member, and the method pointer should be method of the composite member. If the composite member is inline then set isCompositeIndirect as false, else set it to true for proper indirection.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_register_func.html">Registering a function</a>, <a class="el" href="doc_reg_opbeh.html">Registering operator behaviours</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad74043be9cc30f105c62f482ca720574"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad74043be9cc30f105c62f482ca720574">◆ </a></span>RegisterObjectMethod()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterObjectMethod </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>declaration</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> & </td>
|
|
<td class="paramname"><em>funcPointer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> </td>
|
|
<td class="paramname"><em>callConv</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>auxiliary</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>compositeOffset</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isCompositeIndirect</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>The name of the type. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">declaration</td><td>The declaration of the method in script syntax. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">funcPointer</td><td>The method or function pointer. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callConv</td><td>The calling convention for the method or function. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">auxiliary</td><td>A helper object for use with some calling conventions. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">compositeOffset</td><td>The offset to the composite object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">isCompositeIndirect</td><td>Set to false if the composite object is inline, and true if it is refered to by pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error, or the function id if successful. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asWRONG_CONFIG_GROUP</td><td>The object type was registered in a different configuration group. </td></tr>
|
|
<tr><td class="paramname">asNOT_SUPPORTED</td><td>The calling convention is not supported. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The <em>obj</em> parameter is not a valid object name. </td></tr>
|
|
<tr><td class="paramname">asINVALID_DECLARATION</td><td>The <em>declaration</em> is invalid. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The name conflicts with other members. </td></tr>
|
|
<tr><td class="paramname">asWRONG_CALLING_CONV</td><td>The function's calling convention isn't compatible with <em>callConv</em>. </td></tr>
|
|
<tr><td class="paramname">asALREADY_REGISTERED</td><td>The method has already been registered with the same parameter list. </td></tr>
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The <em>auxiliary</em> pointer wasn't set according to calling convention.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Use this method to register a member method for the type. The method that is registered may be an actual class method, or a global function that takes the object pointer as either the first or last parameter. Or it may be a global function implemented with the generic calling convention.</p>
|
|
<p>The <em>auxiliary</em> pointer can optionally be used with <a class="el" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4a750c26b6a6e0c9ccbb93078f532ef8ce">asCALL_GENERIC</a>. For the calling conventions <a class="el" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4a613a388ed51315f6fce19f3824d6b17a">asCALL_THISCALL_OBJFIRST</a> and asCALL_THISCALL_OBJLAST the <em>auxiliary</em> is required.</p>
|
|
<p>In case the method to be registered is part of a composite member, then the compositeOffset should be used to give the offset to the composite member, and the method pointer should be method of the composite member. If the composite member is inline then set isCompositeIndirect as false, else set it to true for proper indirection.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_register_func.html">Registering a function</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0aa35bf824180fe6aed685b40f0e8c34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0aa35bf824180fe6aed685b40f0e8c34">◆ </a></span>RegisterObjectProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterObjectProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>declaration</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>byteOffset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>compositeOffset</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>isCompositeIndirect</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>The name of the type. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">declaration</td><td>The property declaration in script syntax. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">byteOffset</td><td>The offset into the memory block where this property is found. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">compositeOffset</td><td>The offset to the composite object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">isCompositeIndirect</td><td>Set to false if the composite object is inline, and true if it is refered to by pointer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The index of the property on success, or a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asWRONG_CONFIG_GROUP</td><td>The object type was registered in a different configuration group. </td></tr>
|
|
<tr><td class="paramname">asINVALID_OBJECT</td><td>The <em>obj</em> does not specify an object type. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The <em>obj</em> parameter has invalid syntax. </td></tr>
|
|
<tr><td class="paramname">asINVALID_DECLARATION</td><td>The <em>declaration</em> is invalid. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The name conflicts with other members.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Use this method to register a member property of a class. The property must be local to the object, i.e. not a global variable or a static member. The easiest way to get the offset of the property is to use the asOFFSET macro.</p>
|
|
<div class="fragment"><div class="line"><span class="keyword">struct </span>MyType {<span class="keywordtype">float</span> prop;};</div>
|
|
<div class="line">r = engine-><a class="code" href="classas_i_script_engine.html#a0aa35bf824180fe6aed685b40f0e8c34">RegisterObjectProperty</a>(<span class="stringliteral">"MyType"</span>, <span class="stringliteral">"float prop"</span>, <a class="code" href="angelscript_8h.html#a717eccea17214bc1eb64bb9789c4915a">asOFFSET</a>(MyType, prop)));</div>
|
|
</div><!-- fragment --><p>In case the property to be registered is part of a composite member, then the compositeOffset should be used to give the offset to the composite member, and byteOffset should be the offset to the property in that composite member. If the composite member is inline then set isCompositeIndirect as false, else set it to true for proper indirection.</p>
|
|
<p>The method returns the index of the property upon success. This can be used to look up the property in the object type with <a class="el" href="classas_i_type_info.html#a48f468bd5b6b0e22c852b40639a7a2b5">asITypeInfo::GetProperty</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a29c6c087c8c5b5cdb6271cfd161cc5a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a29c6c087c8c5b5cdb6271cfd161cc5a6">◆ </a></span>RegisterObjectType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterObjectType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>byteSize</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> </td>
|
|
<td class="paramname"><em>flags</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>The name of the type. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">byteSize</td><td>The size of the type in bytes. Only necessary for value types. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flags</td><td>One or more of the asEObjTypeFlags. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type id on success or a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The flags are invalid. </td></tr>
|
|
<tr><td class="paramname">asINVALID_NAME</td><td>The name is invalid. </td></tr>
|
|
<tr><td class="paramname">asALREADY_REGISTERED</td><td>Another type of the same name already exists. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The name conflicts with other symbol names. </td></tr>
|
|
<tr><td class="paramname">asLOWER_ARRAY_DIMENSION_NOT_REGISTERED</td><td>When registering an array type the array element must be a primitive or a registered type. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The array type was not properly formed. </td></tr>
|
|
<tr><td class="paramname">asNOT_SUPPORTED</td><td>The array type is not supported, or already in use preventing it from being overloaded.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Use this method to register new types that should be available to the scripts. Reference types, which have their memory managed by the application, should be registered with <a class="el" href="angelscript_8h.html#a855d86fa9ee15b9f75e553ee376b5c7aa9450e038342b36c745858d2e5ae4b861">asOBJ_REF</a>. Value types, which have their memory managed by the engine, should be registered with <a class="el" href="angelscript_8h.html#a855d86fa9ee15b9f75e553ee376b5c7aa9fc16a8ac0f30f9ff9c6568e0b7be91d">asOBJ_VALUE</a>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_register_type.html">Registering an object type</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac6598c07c36652b0270b4c2d61db1f01"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6598c07c36652b0270b4c2d61db1f01">◆ </a></span>RegisterStringFactory()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterStringFactory </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>datatype</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classas_i_string_factory.html">asIStringFactory</a> * </td>
|
|
<td class="paramname"><em>factory</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">datatype</td><td>The datatype that the string factory returns </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">factory</td><td>The pointer to the factory object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error, or the function id if successful. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The <em>factory</em> is null. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The <em>datatype</em> is not a valid type, or it is a reference or handle.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Use this function to register a string factory that will be called during compilation to create instances of a string constant. The string factory will also be used while saving bytecode in order to get the raw string data for serialization.</p>
|
|
<p>The data type that represents the string type should be informed without reference or handle token, as the script engine will assume a const reference anyway.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_strings.html">Custom string type</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="addb24466769dc52be96c7e37d5305245"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#addb24466769dc52be96c7e37d5305245">◆ </a></span>RegisterTypedef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RegisterTypedef </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>decl</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The name of the new typedef </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">decl</td><td>The datatype that the typedef represents </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The type id on success, else a negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_NAME</td><td>The <em>type</em> is null, is not an identifier, or it is a reserved keyword. </td></tr>
|
|
<tr><td class="paramname">asALREADY_REGISTERED</td><td>A type with the same name already exists. </td></tr>
|
|
<tr><td class="paramname">asINVALID_TYPE</td><td>The <em>decl</em> is not a primitive type. </td></tr>
|
|
<tr><td class="paramname">asNAME_TAKEN</td><td>The name is already used elsewhere.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method registers an alias for a data type.</p>
|
|
<p>Currently typedefs can only be registered for built-in primitive types. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae91a45da75af9234b87e825b5c08b81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae91a45da75af9234b87e825b5c08b81">◆ </a></span>Release()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::Release </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of references to this object.</dd></dl>
|
|
<p>Call this method when you will no longer use the references that you own.</p>
|
|
<p>If you know that the engine is supposed to be shut down, then it is recommended to call the <a class="el" href="classas_i_script_engine.html#a28c3800620d4aeaca75d084391eb758e">ShutDownAndRelease</a> method instead. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a82873d3769ded547894a7c3d52c220fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82873d3769ded547894a7c3d52c220fd">◆ </a></span>ReleaseScriptObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::ReleaseScriptObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classas_i_type_info.html">asITypeInfo</a> * </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>A pointer to the object. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the object.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This calls the release method of the object to release the reference.</p>
|
|
<p>If the type is a value type, the method will destroy the object and deallocate the memory using the <a class="el" href="group__api__memory__functions.html#ga527ab125defc58aa40cc151a25582a31">default memory routine</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab607be7fe727cdcce502d2beedbf4c0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab607be7fe727cdcce502d2beedbf4c0a">◆ </a></span>RemoveConfigGroup()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::RemoveConfigGroup </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>groupName</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">groupName</td><td>The name of the configuration group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asCONFIG_GROUP_IS_IN_USE</td><td>The group is in use and cannot be removed.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Remove the configuration group. If something in the configuration group is currently in use, the function will return with an error code. Examples of uses are compiled modules that have function calls to functions in the group and global variables of types registered in the group.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_adv_dynamic_config.html">Dynamic configurations</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a32391ee83e58083b406ba068ab2ee049"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32391ee83e58083b406ba068ab2ee049">◆ </a></span>RequestContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classas_i_script_context.html">asIScriptContext</a>* asIScriptEngine::RequestContext </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>An unprepared context</dd></dl>
|
|
<p>This method will invoke the registered request context callback and return an available context in an unprepared state.</p>
|
|
<p>Contexts obtained through this method shouldn't be released, instead they should be returned to the origin with a call to <a class="el" href="classas_i_script_engine.html#a22e42bf32902cbd6885731a6beeaca20">ReturnContext</a>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classas_i_script_engine.html#a2630e1cd03ffab0fee9b820bf0afe42a">CreateContext</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a22e42bf32902cbd6885731a6beeaca20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a22e42bf32902cbd6885731a6beeaca20">◆ </a></span>ReturnContext()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::ReturnContext </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classas_i_script_context.html">asIScriptContext</a> * </td>
|
|
<td class="paramname"><em>ctx</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>The context that should be returned to the origin </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac3d5b7c9920b4f98405a19e515ceb26"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac3d5b7c9920b4f98405a19e515ceb26">◆ </a></span>SetCircularRefDetectedCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::SetCircularRefDetectedCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ad39eb868abeebf44bb67fd3965f8bc5f">asCIRCULARREFFUNC_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>param</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>The callback function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">param</td><td>Optional parameter that will be passed back to the callback function</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This callback is meant to be used during development to help identify scripts that are creating circular references. As the callback will be invoked when the objects in the circular reference are detected, but before they are destroyed, the application can investigate their content to get hints where the objects are created from.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_gc.html">Garbage collection</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae5ba9fe99b72c60392cdaeef164f2c65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5ba9fe99b72c60392cdaeef164f2c65">◆ </a></span>SetContextCallbacks()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::SetContextCallbacks </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a2925360becae92319e68abb23a61fd56">asREQUESTCONTEXTFUNC_t</a> </td>
|
|
<td class="paramname"><em>requestCtx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a3ffcfca5bd3be4f4c633408a6b209476">asRETURNCONTEXTFUNC_t</a> </td>
|
|
<td class="paramname"><em>returnCtx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>param</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">requestCtx</td><td>The request context callback function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">returnCtx</td><td>The return context callback function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">param</td><td>An optional parameter that will be passed to the callback </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>Only one of the context functions is informed</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method can be used by the application to implement a context pool, or to perform custom configuration on the contexts that the engine uses internally.</p>
|
|
<p>This can for example be used to debug calls to initialize global variables when building modules, or to detect script exceptions that may occur in script class destructors when called from the garbage collector. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acaced7eb9ebe013ede23f7593daf58e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acaced7eb9ebe013ede23f7593daf58e3">◆ </a></span>SetContextUserDataCleanupCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::SetContextUserDataCleanupCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a761b892984e5af51e0f6e37c27dfadb6">asCLEANCONTEXTFUNC_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A pointer to the function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>An identifier specifying which user data the callback is to be used with.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The function given with this call will be invoked when a context is destroyed if any <a class="el" href="classas_i_script_context.html#a263dc70abb2a8c77adcea7c9ede0a479">user data</a> has been registered with the context.</p>
|
|
<p>The function is called from within the context destructor, so the callback should not be used for anything but cleaning up the user data itself. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a570df3e676f2d9e03e87d97b8cede1c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a570df3e676f2d9e03e87d97b8cede1c7">◆ </a></span>SetDefaultAccessMask()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> asIScriptEngine::SetDefaultAccessMask </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> </td>
|
|
<td class="paramname"><em>defaultMask</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">defaultMask</td><td>The default access bit mask. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The previous default mask.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_adv_access_mask.html">Access masks and exposing different interfaces</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a605f114814f1f64804c04391816d948b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a605f114814f1f64804c04391816d948b">◆ </a></span>SetDefaultNamespace()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::SetDefaultNamespace </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>nameSpace</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">nameSpace</td><td>The namespace that should be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The namespace is invalid</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Call this method to set the default namespace for which the following calls should assume. This applies to registration of the application interface and also to the functions that searches for registered entities.</p>
|
|
<p>Nested namespaces can be informed by separating them with the scope token, i.e. :: </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1bce4e5f573a2ca0ff55163e28f761dd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1bce4e5f573a2ca0ff55163e28f761dd">◆ </a></span>SetEngineProperty()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::SetEngineProperty </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a53c2e8a74ade77c928316396394ebe0f">asEEngineProp</a> </td>
|
|
<td class="paramname"><em>property</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>value</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">property</td><td>One of the <a class="el" href="angelscript_8h.html#a53c2e8a74ade77c928316396394ebe0f">asEEngineProp</a> values. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The new value of the property. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>Invalid property.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>With this method you can change the way the script engine works in some regards. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8fa4fc9aacb99db6d4be0a5542b85e35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fa4fc9aacb99db6d4be0a5542b85e35">◆ </a></span>SetEngineUserDataCleanupCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::SetEngineUserDataCleanupCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#aa3dd561bcccb3d5e4966966d7eb2715c">asCLEANENGINEFUNC_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A pointer to the function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>An identifier specifying which user data the callback is to be used with.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The function given with this call will be invoked when the engine is destroyed if any <a class="el" href="classas_i_script_engine.html#aabee8d6ef426c434adee85ec6d57f940">user data</a> has been registered with the engine.</p>
|
|
<p>The function is called from within the engine destructor, so the callback should not be used for anything but cleaning up the user data itself. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae75ee087fe6608cf0af1c24794ca73c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae75ee087fe6608cf0af1c24794ca73c7">◆ </a></span>SetFunctionUserDataCleanupCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::SetFunctionUserDataCleanupCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a6c0fcc7fee72733c9feb03c0bbf8f5d6">asCLEANFUNCTIONFUNC_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A pointer to the function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>An identifier specifying which user data the callback is to be used with.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The function given with this call will be invoked when a function is destroyed if any <a class="el" href="classas_i_script_function.html#a9dd036ce8e91d335eb5a3ad8851f1a41">user data</a> has been registered with the function.</p>
|
|
<p>The function is called from within the function destructor, so the callback should not be used for anything but cleaning up the user data itself. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee4f910163604203a27db1ffea3b1c9c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee4f910163604203a27db1ffea3b1c9c">◆ </a></span>SetJITCompiler()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::SetJITCompiler </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classas_i_j_i_t_compiler.html">asIJITCompiler</a> * </td>
|
|
<td class="paramname"><em>compiler</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">compiler</td><td>A pointer to the JIT compiler </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error.</dd></dl>
|
|
<p>This method is used to set the JIT compiler. The engine will automatically invoke the JIT compiler when it is set after compiling scripts or loading pre-compiled byte code.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="doc_adv_jit.html">How to build a JIT compiler</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a74192fe950808eb72a64e3e371f0ea02"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74192fe950808eb72a64e3e371f0ea02">◆ </a></span>SetMessageCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::SetMessageCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> & </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>obj</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5428f0c940201e5f3bbb28304aeb81bc">asDWORD</a> </td>
|
|
<td class="paramname"><em>callConv</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A function or class method pointer. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">obj</td><td>The object for methods, or an optional parameter for functions. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callConv</td><td>The calling convention. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value for an error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>One of the arguments is incorrect, e.g. obj is null for a class method. </td></tr>
|
|
<tr><td class="paramname">asNOT_SUPPORTED</td><td>The arguments are not supported, e.g. asCALL_GENERIC.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method sets the callback routine that will receive compiler messages. The callback routine can be either a class method, e.g: </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> MyClass::MessageCallback(<span class="keyword">const</span> <a class="code" href="structas_s_message_info.html">asSMessageInfo</a> *msg);</div>
|
|
<div class="line">r = engine-><a class="code" href="classas_i_script_engine.html#a74192fe950808eb72a64e3e371f0ea02">SetMessageCallback</a>(<a class="code" href="angelscript_8h.html#a7345e6b3afabec24efd0ff77886d49a6">asMETHOD</a>(MyClass,MessageCallback), &obj, <a class="code" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4aea516c8742acc1edff6a43dc1bb09e96">asCALL_THISCALL</a>);</div>
|
|
</div><!-- fragment --><p> or a global function, e.g: </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> MessageCallback(<span class="keyword">const</span> <a class="code" href="structas_s_message_info.html">asSMessageInfo</a> *msg, <span class="keywordtype">void</span> *param);</div>
|
|
<div class="line">r = engine-><a class="code" href="classas_i_script_engine.html#a74192fe950808eb72a64e3e371f0ea02">SetMessageCallback</a>(<a class="code" href="angelscript_8h.html#a78f8f2c7f1c88b12e74a5ac47b4184ae">asFUNCTION</a>(MessageCallback), param, <a class="code" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4a68ae43cc91cdfc3fa4590c9e6164e4f4">asCALL_CDECL</a>);</div>
|
|
</div><!-- fragment --><p> It is recommended to register the message callback routine right after creating the engine, as some of the registration functions can provide useful information to better explain errors. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7523853b9a9bf7dab603fa6a06393d51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7523853b9a9bf7dab603fa6a06393d51">◆ </a></span>SetModuleUserDataCleanupCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::SetModuleUserDataCleanupCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a5a01d6871440c3b6261da54a8308c452">asCLEANMODULEFUNC_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A pointer to the function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>An identifier specifying which user data the callback is to be used with.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The function given with this call will be invoked when the module is destroyed if any <a class="el" href="classas_i_script_module.html#a06582e57e7101df4157ee36c81867c13">user data</a> has been registered with the module.</p>
|
|
<p>The function is called from within the module destructor, so the callback should not be used for anything but cleaning up the user data itself. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4654e2cae0690c50e19b177f1ec54592"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4654e2cae0690c50e19b177f1ec54592">◆ </a></span>SetScriptObjectUserDataCleanupCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::SetScriptObjectUserDataCleanupCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#ab89ff127aa05aef3793646b377e9c724">asCLEANSCRIPTOBJECTFUNC_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A pointer to the function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>An identifier specifying which user data the callback is to be used with.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The function given with this call will be invoked when a script object instance is destroyed if any <a class="el" href="classas_i_script_object.html#ac85cea9bca5dd3868e027285e44dd6d0">user data</a> has been registered with the type.</p>
|
|
<p>The function is called from within the script object destructor, so the callback should not be used for anything but cleaning up the user data itself. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="addce6a202934a4918f7776b2f77c43fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#addce6a202934a4918f7776b2f77c43fd">◆ </a></span>SetTranslateAppExceptionCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::SetTranslateAppExceptionCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structas_s_func_ptr.html">asSFuncPtr</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>param</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>callConv</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>The callback function/method that should be called upon an exception. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">param</td><td>A user defined parameter, or the object pointer on which the callback is called. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callConv</td><td>The calling convention of the callback function/method. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asNOT_SUPPORTED</td><td>Calling convention must not be asCALL_GENERIC, or the routine's calling convention is not supported. </td></tr>
|
|
<tr><td class="paramname">asINVALID_ARG</td><td><em>param</em> must not be null for class methods. </td></tr>
|
|
<tr><td class="paramname">asWRONG_CALLING_CONV</td><td><em>callConv</em> isn't compatible with the routines' calling convention.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This callback function will be called by the VM when an application exception is raised, which allow the application to translate the exception into a useful string to inform in <a class="el" href="classas_i_script_context.html#a6f0f071215e0f7effc0b765043f01275">SetException</a>.</p>
|
|
<p>The callback function signature must be either:</p>
|
|
<pre> void (*)(<a class="el" href="classas_i_script_context.html" title="The interface to the virtual machine.">asIScriptContext</a> *, void *);</pre><p>or</p>
|
|
<pre> void (param::*)(<a class="el" href="classas_i_script_context.html" title="The interface to the virtual machine.">asIScriptContext</a> *);</pre><p>See <a class="el" href="doc_cpp_exceptions.html#doc_cpp_exceptions_1">Exceptions</a> for an example on how to use this. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afa31e7c28c63a2c876d8e08305cf5d75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afa31e7c28c63a2c876d8e08305cf5d75">◆ </a></span>SetTypeInfoUserDataCleanupCallback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void asIScriptEngine::SetTypeInfoUserDataCleanupCallback </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#aca9bfb1e5a93426df269bd10d88e5cb3">asCLEANTYPEINFOFUNC_t</a> </td>
|
|
<td class="paramname"><em>callback</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">callback</td><td>A pointer to the function </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>An identifier specifying which user data the callback is to be used with.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The function given with this call will be invoked when a type info is destroyed if any <a class="el" href="classas_i_type_info.html#a5e8ea071f1c1f3b7c6dfc1950bec73f4">user data</a> has been registered with the type.</p>
|
|
<p>The function is called from within the type info destructor, so the callback should not be used for anything but cleaning up the user data itself. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aabee8d6ef426c434adee85ec6d57f940"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aabee8d6ef426c434adee85ec6d57f940">◆ </a></span>SetUserData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void* asIScriptEngine::SetUserData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a76fc6994aba7ff6c685a62c273c057e3">asPWORD</a> </td>
|
|
<td class="paramname"><em>type</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>A pointer to the user data. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>An identifier specifying the user data to set. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The previous pointer stored in the engine.</dd></dl>
|
|
<p>This method allows the application to associate a value, e.g. a pointer, with the engine instance.</p>
|
|
<p>The type values 1000 through 1999 are reserved for use by the official add-ons.</p>
|
|
<p>Optionally, a callback function can be <a class="el" href="classas_i_script_engine.html#a8fa4fc9aacb99db6d4be0a5542b85e35">registered</a> to clean up the user data when the engine is destroyed. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a28c3800620d4aeaca75d084391eb758e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28c3800620d4aeaca75d084391eb758e">◆ </a></span>ShutDownAndRelease()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::ShutDownAndRelease </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>The number of references to this object.</dd></dl>
|
|
<p>Call this method when you know it is time to shut down the engine. This will automatically discard all the script modules and run a complete garbage collection cycle.</p>
|
|
<p>Calling this method rather than the ordinary <a class="el" href="classas_i_script_engine.html#aae91a45da75af9234b87e825b5c08b81">Release</a> method will avoid potential memory leaks if for example there are objects in the modules or garbage collector that indirectly holds a reference to the engine. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a936ce6566af958bb75ba1c0945d8b03a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a936ce6566af958bb75ba1c0945d8b03a">◆ </a></span>WriteMessage()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual int asIScriptEngine::WriteMessage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>section</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>row</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>col</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="angelscript_8h.html#a8badcd23652646db5c5c6981dc73d4f5">asEMsgType</a> </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>message</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">section</td><td>The name of the script section. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">row</td><td>The row number. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">col</td><td>The column number. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The message type. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>The message text. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A negative value on error. </dd></dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname">asINVALID_ARG</td><td>The section or message is null.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>This method can be used by the application to write messages to the same message callback that the script compiler uses. This is useful for example if a preprocessor is used. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="angelscript_8h.html">angelscript.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div class="ttc" id="aclassas_i_script_engine_html_a74192fe950808eb72a64e3e371f0ea02"><div class="ttname"><a href="classas_i_script_engine.html#a74192fe950808eb72a64e3e371f0ea02">asIScriptEngine::SetMessageCallback</a></div><div class="ttdeci">virtual int SetMessageCallback(const asSFuncPtr &callback, void *obj, asDWORD callConv)=0</div><div class="ttdoc">Sets a message callback that will receive compiler messages.</div></div>
|
|
<div class="ttc" id="aangelscript_8h_html_a78f8f2c7f1c88b12e74a5ac47b4184ae"><div class="ttname"><a href="angelscript_8h.html#a78f8f2c7f1c88b12e74a5ac47b4184ae">asFUNCTION</a></div><div class="ttdeci">#define asFUNCTION(f)</div><div class="ttdoc">Returns an asSFuncPtr representing the function specified by the name.</div><div class="ttdef"><b>Definition:</b> angelscript.h:675</div></div>
|
|
<div class="ttc" id="aangelscript_8h_html_a7345e6b3afabec24efd0ff77886d49a6"><div class="ttname"><a href="angelscript_8h.html#a7345e6b3afabec24efd0ff77886d49a6">asMETHOD</a></div><div class="ttdeci">#define asMETHOD(c, m)</div><div class="ttdoc">Returns an asSFuncPtr representing the class method specified by class and method name.</div><div class="ttdef"><b>Definition:</b> angelscript.h:740</div></div>
|
|
<div class="ttc" id="aangelscript_8h_html_a3ec92ea3c4762e44c2df788ceccdd1e4aea516c8742acc1edff6a43dc1bb09e96"><div class="ttname"><a href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4aea516c8742acc1edff6a43dc1bb09e96">asCALL_THISCALL</a></div><div class="ttdeci">@ asCALL_THISCALL</div><div class="ttdoc">A thiscall class method.</div><div class="ttdef"><b>Definition:</b> angelscript.h:232</div></div>
|
|
<div class="ttc" id="aclassas_i_script_engine_html_a0aa35bf824180fe6aed685b40f0e8c34"><div class="ttname"><a href="classas_i_script_engine.html#a0aa35bf824180fe6aed685b40f0e8c34">asIScriptEngine::RegisterObjectProperty</a></div><div class="ttdeci">virtual int RegisterObjectProperty(const char *obj, const char *declaration, int byteOffset, int compositeOffset=0, bool isCompositeIndirect=false)=0</div><div class="ttdoc">Registers a property for the object type.</div></div>
|
|
<div class="ttc" id="aangelscript_8h_html_a3ec92ea3c4762e44c2df788ceccdd1e4a68ae43cc91cdfc3fa4590c9e6164e4f4"><div class="ttname"><a href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4a68ae43cc91cdfc3fa4590c9e6164e4f4">asCALL_CDECL</a></div><div class="ttdeci">@ asCALL_CDECL</div><div class="ttdoc">A cdecl function.</div><div class="ttdef"><b>Definition:</b> angelscript.h:226</div></div>
|
|
<div class="ttc" id="astructas_s_message_info_html"><div class="ttname"><a href="structas_s_message_info.html">asSMessageInfo</a></div><div class="ttdoc">Represents a compiler message.</div><div class="ttdef"><b>Definition:</b> angelscript.h:767</div></div>
|
|
<div class="ttc" id="aangelscript_8h_html_a717eccea17214bc1eb64bb9789c4915a"><div class="ttname"><a href="angelscript_8h.html#a717eccea17214bc1eb64bb9789c4915a">asOFFSET</a></div><div class="ttdeci">#define asOFFSET(s, m)</div><div class="ttdoc">Returns the offset of an attribute in a struct.</div><div class="ttdef"><b>Definition:</b> angelscript.h:672</div></div>
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="classas_i_script_engine.html">asIScriptEngine</a></li>
|
|
<li class="footer">Generated on Sat Dec 5 2020 23:20:25 for AngelScript by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|