351 lines
36 KiB
HTML
351 lines
36 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: Inheriting from application registered class</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('doc_adv_inheritappclass.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="PageDoc"><div class="header">
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Inheriting from application registered class </div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="textblock"><p>A script class cannot directly inherit from an application registered class, as the script classes are not compiled into native machine code like the application classes are.</p>
|
||
|
|
<p>It is however possible to emulate the inheritance by using a proxy class to hide the underlying differences in an abstract layer. The proxy class has two parts, one is the C++ side that the application sees, and the other is the script side that the scripts can see and inherit from.</p>
|
||
|
|
<p>The following is an example implementation of such a proxy class.</p>
|
||
|
|
<div class="fragment"><div class="line"><span class="comment">// On the C++ side</span></div>
|
||
|
|
<div class="line"><span class="keyword">class </span>FooScripted</div>
|
||
|
|
<div class="line">{</div>
|
||
|
|
<div class="line"><span class="keyword">public</span>:</div>
|
||
|
|
<div class="line"> <span class="comment">// Public interface that we want the script to be able to override </span></div>
|
||
|
|
<div class="line"> <span class="keywordtype">void</span> CallMe()</div>
|
||
|
|
<div class="line"> {</div>
|
||
|
|
<div class="line"> <span class="comment">// If the script side is still alive, then call the scripted function</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span>( !m_isDead->Get() )</div>
|
||
|
|
<div class="line"> {</div>
|
||
|
|
<div class="line"> <a class="code" href="classas_i_script_engine.html">asIScriptEngine</a> *engine = m_obj->GetEngine();</div>
|
||
|
|
<div class="line"> <a class="code" href="classas_i_script_context.html">asIScriptContext</a> *ctx = engine-><a class="code" href="classas_i_script_engine.html#a32391ee83e58083b406ba068ab2ee049">RequestContext</a>();</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// GetMethodByDecl returns the virtual function on the script class</span></div>
|
||
|
|
<div class="line"> <span class="comment">// thus when calling it, the VM will execute the derived method</span></div>
|
||
|
|
<div class="line"> ctx-><a class="code" href="classas_i_script_context.html#a43976f42dfc6c1af23e132d36265173a">Prepare</a>(m_obj->GetObjectType()->GetMethodByDecl(<span class="stringliteral">"void CallMe()"</span>));</div>
|
||
|
|
<div class="line"> ctx-><a class="code" href="classas_i_script_context.html#a10d3c152b25d07584999f4d9fe5ce8b1">SetObject</a>(m_obj);</div>
|
||
|
|
<div class="line"> ctx-><a class="code" href="classas_i_script_context.html#a8e52894432737acac2e1a422e496bf84">Execute</a>();</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> engine-><a class="code" href="classas_i_script_engine.html#a22e42bf32902cbd6885731a6beeaca20">ReturnContext</a>(ctx);</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordtype">int</span> m_value;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// A factory function that can be used by the script side to create</span></div>
|
||
|
|
<div class="line"> <span class="keyword">static</span> FooScripted *Factory()</div>
|
||
|
|
<div class="line"> {</div>
|
||
|
|
<div class="line"> <a class="code" href="classas_i_script_context.html">asIScriptContext</a> *ctx = <a class="code" href="group__api__principal__functions.html#gad3a20dc58093b92a5a44c7b6ada34a10">asGetActiveContext</a>();</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Get the function that is calling the factory so we can be certain it is the FooScript script class</span></div>
|
||
|
|
<div class="line"> <a class="code" href="classas_i_script_function.html">asIScriptFunction</a> *func = ctx-><a class="code" href="classas_i_script_context.html#a1c101300447f2909e5d188409a7180f6">GetFunction</a>(0);</div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span>( func-><a class="code" href="classas_i_script_function.html#af930b362c37e5c4c117485d0bd4a34fb">GetObjectType</a>() == 0 || std::string(func-><a class="code" href="classas_i_script_function.html#af930b362c37e5c4c117485d0bd4a34fb">GetObjectType</a>()-><a class="code" href="classas_i_type_info.html#a49f83d3a9158331029324bfbe9ae46a8">GetName</a>()) != <span class="stringliteral">"FooScripted"</span> )</div>
|
||
|
|
<div class="line"> {</div>
|
||
|
|
<div class="line"> ctx-><a class="code" href="classas_i_script_context.html#a6f0f071215e0f7effc0b765043f01275">SetException</a>(<span class="stringliteral">"Invalid attempt to manually instantiate FooScript_t"</span>);</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> 0;</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Get the this pointer from the calling function so the FooScript C++</span></div>
|
||
|
|
<div class="line"> <span class="comment">// class can be linked with the FooScript script class</span></div>
|
||
|
|
<div class="line"> <a class="code" href="classas_i_script_object.html">asIScriptObject</a> *obj = <span class="keyword">reinterpret_cast<</span><a class="code" href="classas_i_script_object.html">asIScriptObject</a>*<span class="keyword">></span>(ctx-><a class="code" href="classas_i_script_context.html#a4f6761a7a0c872dda681d8e180830ff9">GetThisPointer</a>(0));</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">new</span> FooScripted(obj);</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Reference counting</span></div>
|
||
|
|
<div class="line"> <span class="keywordtype">void</span> AddRef()</div>
|
||
|
|
<div class="line"> {</div>
|
||
|
|
<div class="line"> m_refCount++;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Increment also the reference counter to the script side so</span></div>
|
||
|
|
<div class="line"> <span class="comment">// it isn't accidentally destroyed before the C++ side</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span>( !m_isDead->Get() )</div>
|
||
|
|
<div class="line"> m_obj->AddRef();</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> <span class="keywordtype">void</span> Release()</div>
|
||
|
|
<div class="line"> { </div>
|
||
|
|
<div class="line"> <span class="comment">// Release the script instance too</span></div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span>( !m_isDead->Get() )</div>
|
||
|
|
<div class="line"> m_obj->Release();</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">if</span>( --m_refCount == 0 ) <span class="keyword">delete</span> <span class="keyword">this</span>;</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Assignment operator</span></div>
|
||
|
|
<div class="line"> FooScripted &operator=(<span class="keyword">const</span> FooScripted &o)</div>
|
||
|
|
<div class="line"> {</div>
|
||
|
|
<div class="line"> <span class="comment">// Copy only the content, not the script proxy class</span></div>
|
||
|
|
<div class="line"> m_value = o.m_value;</div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"><span class="keyword">protected</span>:</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// The constructor and destructor are indirectly called</span></div>
|
||
|
|
<div class="line"> FooScripted(<a class="code" href="classas_i_script_object.html">asIScriptObject</a> *obj) : m_obj(0), m_isDead(0), m_value(0), m_refCount(1)</div>
|
||
|
|
<div class="line"> {</div>
|
||
|
|
<div class="line"> <span class="comment">// Get the weak ref flag for the script object to</span></div>
|
||
|
|
<div class="line"> <span class="comment">// avoid holding a strong reference to the script class</span></div>
|
||
|
|
<div class="line"> m_isDead = obj-><a class="code" href="classas_i_script_object.html#a9ccca7fe3453219377fc9bd190bf7903">GetWeakRefFlag</a>();</div>
|
||
|
|
<div class="line"> m_isDead-><a class="code" href="classas_i_lockable_shared_bool.html#a1183742552ce6b952cc3742bd456d787">AddRef</a>();</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> m_obj = obj;</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> ~FooScripted()</div>
|
||
|
|
<div class="line"> {</div>
|
||
|
|
<div class="line"> <span class="comment">// Release the weak ref flag</span></div>
|
||
|
|
<div class="line"> m_isDead-><a class="code" href="classas_i_script_object.html#a4bed3c3ac9f16294985835747aa122d3">Release</a>();</div>
|
||
|
|
<div class="line"> }</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Reference count</span></div>
|
||
|
|
<div class="line"> <span class="keywordtype">int</span> m_refCount;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// The C++ side holds a weak link to the script side to</span></div>
|
||
|
|
<div class="line"> <span class="comment">// avoid a circular reference between the C++ side and</span></div>
|
||
|
|
<div class="line"> <span class="comment">// script side</span></div>
|
||
|
|
<div class="line"> <a class="code" href="classas_i_lockable_shared_bool.html">asILockableSharedBool</a> *m_isDead;</div>
|
||
|
|
<div class="line"> <a class="code" href="classas_i_script_object.html">asIScriptObject</a> *m_obj;</div>
|
||
|
|
<div class="line">};</div>
|
||
|
|
</div><!-- fragment --><p>This type is registered with the engine as the following:</p>
|
||
|
|
<div class="fragment"><div class="line"><span class="keywordtype">void</span> RegisterFooScripted(<a class="code" href="classas_i_script_engine.html">asIScriptEngine</a> *engine)</div>
|
||
|
|
<div class="line">{</div>
|
||
|
|
<div class="line"> engine-><a class="code" href="classas_i_script_engine.html#a29c6c087c8c5b5cdb6271cfd161cc5a6">RegisterObjectType</a>(<span class="stringliteral">"FooScripted_t"</span>, 0, <a class="code" href="angelscript_8h.html#a855d86fa9ee15b9f75e553ee376b5c7aa9450e038342b36c745858d2e5ae4b861">asOBJ_REF</a>);</div>
|
||
|
|
<div class="line"> engine-><a class="code" href="classas_i_script_engine.html#a9f122dd87394f3a83ac766ea19f37317">RegisterObjectBehaviour</a>(<span class="stringliteral">"FooScripted_t"</span>, <a class="code" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a0b3db16eea35213b6f41f8d19dc1bd4c">asBEHAVE_FACTORY</a>, <span class="stringliteral">"FooScripted_t @f()"</span>, <a class="code" href="angelscript_8h.html#a78f8f2c7f1c88b12e74a5ac47b4184ae">asFUNCTION</a>(FooScripted::Factory), <a class="code" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4a68ae43cc91cdfc3fa4590c9e6164e4f4">asCALL_CDECL</a>);</div>
|
||
|
|
<div class="line"> engine-><a class="code" href="classas_i_script_engine.html#a9f122dd87394f3a83ac766ea19f37317">RegisterObjectBehaviour</a>(<span class="stringliteral">"FooScripted_t"</span>, <a class="code" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a1dfa5b72ad69a7bf70636d4fcb1b1d84">asBEHAVE_ADDREF</a>, <span class="stringliteral">"void f()"</span>, <a class="code" href="angelscript_8h.html#a7345e6b3afabec24efd0ff77886d49a6">asMETHOD</a>(FooScripted, AddRef), <a class="code" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4aea516c8742acc1edff6a43dc1bb09e96">asCALL_THISCALL</a>);</div>
|
||
|
|
<div class="line"> engine-><a class="code" href="classas_i_script_engine.html#a9f122dd87394f3a83ac766ea19f37317">RegisterObjectBehaviour</a>(<span class="stringliteral">"FooScripted_t"</span>, <a class="code" href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a7134ce13c81967191af401a1e5170a0c">asBEHAVE_RELEASE</a>, <span class="stringliteral">"void f()"</span>, <a class="code" href="angelscript_8h.html#a7345e6b3afabec24efd0ff77886d49a6">asMETHOD</a>(FooScripted, Release), <a class="code" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4aea516c8742acc1edff6a43dc1bb09e96">asCALL_THISCALL</a>);</div>
|
||
|
|
<div class="line"> engine-><a class="code" href="classas_i_script_engine.html#ad74043be9cc30f105c62f482ca720574">RegisterObjectMethod</a>(<span class="stringliteral">"FooScripted_t"</span>, <span class="stringliteral">"FooScripted_t &opAssign(const FooScripted_t &in)"</span>, <a class="code" href="angelscript_8h.html#a7345e6b3afabec24efd0ff77886d49a6">asMETHOD</a>(FooScripted, <span class="keyword">operator</span>=), <a class="code" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4aea516c8742acc1edff6a43dc1bb09e96">asCALL_THISCALL</a>);</div>
|
||
|
|
<div class="line"> engine-><a class="code" href="classas_i_script_engine.html#ad74043be9cc30f105c62f482ca720574">RegisterObjectMethod</a>(<span class="stringliteral">"FooScripted_t"</span>, <span class="stringliteral">"void CallMe()"</span>, <a class="code" href="angelscript_8h.html#a7345e6b3afabec24efd0ff77886d49a6">asMETHOD</a>(FooScripted, CallMe), <a class="code" href="angelscript_8h.html#a3ec92ea3c4762e44c2df788ceccdd1e4aea516c8742acc1edff6a43dc1bb09e96">asCALL_THISCALL</a>);</div>
|
||
|
|
<div class="line"> engine-><a class="code" href="classas_i_script_engine.html#a0aa35bf824180fe6aed685b40f0e8c34">RegisterObjectProperty</a>(<span class="stringliteral">"FooScripted_t"</span>, <span class="stringliteral">"int m_value"</span>, <a class="code" href="angelscript_8h.html#a717eccea17214bc1eb64bb9789c4915a">asOFFSET</a>(FooScripted, m_value));</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --><p>The script side is declared as <a class="el" href="doc_script_shared.html">shared</a> so it can be used in all script modules. It is also declared as <a class="el" href="doc_script_class_inheritance.html#doc_script_class_inheritance_2">abstract</a> so it cannot be instantiated by itself, only as a parent class of another script class.</p>
|
||
|
|
<p>This script section should preferably be included automatically by the application in all the modules that should be able to derive from the FooScripted class.</p>
|
||
|
|
<pre>
|
||
|
|
// On the script side
|
||
|
|
shared abstract class FooScripted
|
||
|
|
{
|
||
|
|
// Allow scripts to create instances
|
||
|
|
FooScripted()
|
||
|
|
{
|
||
|
|
// Create the C++ side of the proxy
|
||
|
|
@m_obj = FooScripted_t();
|
||
|
|
<br />
|
||
|
|
|
||
|
|
}</pre><pre> // The copy constructor performs a deep copy
|
||
|
|
FooScripted(const FooScripted &o)
|
||
|
|
{
|
||
|
|
// Create a new C++ instance and copy content
|
||
|
|
@m_obj = FooScripted_t();
|
||
|
|
m_obj = o.m_obj; <br />
|
||
|
|
"
|
||
|
|
}</pre><pre> // Do a deep a copy of the C++ object
|
||
|
|
FooScripted &opAssign(const FooScripted &o)
|
||
|
|
{
|
||
|
|
// copy content of C++ instance
|
||
|
|
m_obj = o.m_obj;
|
||
|
|
return this;
|
||
|
|
}</pre><pre> // The script side forwards the call to the C++ side
|
||
|
|
void CallMe() { m_obj.CallMe(); }</pre><pre> // The C++ side property is exposed to the script through accessors
|
||
|
|
int m_value
|
||
|
|
{
|
||
|
|
get { return m_obj.m_value; }
|
||
|
|
set { m_obj.m_value = value; }
|
||
|
|
}</pre><pre> // The script class can be implicitly cast to the C++ type through the opImplCast method
|
||
|
|
FooScripted_t @opImplCast() { return m_obj; }</pre><pre> // Hold a reference to the C++ side of the proxy
|
||
|
|
private FooScripted_t @m_obj;
|
||
|
|
}
|
||
|
|
</pre><p>Now the scripts classes can derive from the FooScripted class <br />
|
||
|
|
and access the properties and methods of the parent class normally.</p>
|
||
|
|
<pre>
|
||
|
|
// Implement a script class that derives from the application class
|
||
|
|
class FooDerived : FooScripted
|
||
|
|
{
|
||
|
|
void CallMe()
|
||
|
|
{
|
||
|
|
m_value += 1;
|
||
|
|
}
|
||
|
|
}</pre><pre> void main()
|
||
|
|
{
|
||
|
|
// When newly created the m_value is 0
|
||
|
|
FooDerived d;
|
||
|
|
assert( d.m_value == 0 );</pre><pre> // When calling the method the m_value is incremented with 1
|
||
|
|
d.CallMe();
|
||
|
|
assert( d.m_value == 1 );
|
||
|
|
}
|
||
|
|
</pre><p>It is of course also possible to create an instance of the scripted class from the application and access it through the FooScripted C++ proxy, thus making it transparent from the rest of the application that the implementation is actually in the script.</p>
|
||
|
|
<div class="fragment"><div class="line">FooScripted *CreateFooDerived(<a class="code" href="classas_i_script_engine.html">asIScriptEngine</a> *engine)</div>
|
||
|
|
<div class="line">{</div>
|
||
|
|
<div class="line"> <span class="comment">// Create an instance of the FooDerived script class that inherits from the FooScripted C++ class</span></div>
|
||
|
|
<div class="line"> <a class="code" href="classas_i_script_object.html">asIScriptObject</a> *obj = <span class="keyword">reinterpret_cast<</span><a class="code" href="classas_i_script_object.html">asIScriptObject</a>*<span class="keyword">></span>(engine-><a class="code" href="classas_i_script_engine.html#a3101479b4340bc16bb9acb8e8d554266">CreateScriptObject</a>(mod->GetTypeInfoByName(<span class="stringliteral">"FooDerived"</span>)));</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Get the pointer to the C++ side of the FooScripted class</span></div>
|
||
|
|
<div class="line"> FooScripted *obj2 = *<span class="keyword">reinterpret_cast<</span>FooScripted**<span class="keyword">></span>(obj-><a class="code" href="classas_i_script_object.html#a6a8a3c7d1e103e43923614b719e3cb3a">GetAddressOfProperty</a>(0));</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Increase the reference count to the C++ object, as this is what will </span></div>
|
||
|
|
<div class="line"> <span class="comment">// be used to control the life time of the object from the application side </span></div>
|
||
|
|
<div class="line"> obj2->AddRef();</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Release the reference to the script side</span></div>
|
||
|
|
<div class="line"> obj-><a class="code" href="classas_i_script_object.html#a4bed3c3ac9f16294985835747aa122d3">Release</a>();</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="keywordflow">return</span> obj2;</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"><span class="keywordtype">void</span> Foo(<a class="code" href="classas_i_script_engine.html">asIScriptEngine</a> *engine)</div>
|
||
|
|
<div class="line">{</div>
|
||
|
|
<div class="line"> FooScripted *obj = CreateFooDerived(engine);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Once the object is created the application can access it normally through</span></div>
|
||
|
|
<div class="line"> <span class="comment">// the FooScripted pointer, without having to know that the implementation</span></div>
|
||
|
|
<div class="line"> <span class="comment">// is actually done in the script.</span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// When newly created the m_value is 0</span></div>
|
||
|
|
<div class="line"> assert( obj->m_value == 0 );</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// When calling the method the m_value is incremented with 1 by the script </span></div>
|
||
|
|
<div class="line"> obj->CallMe();</div>
|
||
|
|
<div class="line"> assert( obj->m_value == 1 );</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Release the object to destroy the instance (this will also destroy the script side)</span></div>
|
||
|
|
<div class="line"> obj->Release();</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --> </div></div><!-- contents -->
|
||
|
|
</div><!-- PageDoc -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<div class="ttc" id="aclassas_i_script_engine_html_ad74043be9cc30f105c62f482ca720574"><div class="ttname"><a href="classas_i_script_engine.html#ad74043be9cc30f105c62f482ca720574">asIScriptEngine::RegisterObjectMethod</a></div><div class="ttdeci">virtual int RegisterObjectMethod(const char *obj, const char *declaration, const asSFuncPtr &funcPointer, asDWORD callConv, void *auxiliary=0, int compositeOffset=0, bool isCompositeIndirect=false)=0</div><div class="ttdoc">Registers a method for the object type.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_lockable_shared_bool_html_a1183742552ce6b952cc3742bd456d787"><div class="ttname"><a href="classas_i_lockable_shared_bool.html#a1183742552ce6b952cc3742bd456d787">asILockableSharedBool::AddRef</a></div><div class="ttdeci">virtual int AddRef() const =0</div><div class="ttdoc">Adds a reference to the shared boolean.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_engine_html_a32391ee83e58083b406ba068ab2ee049"><div class="ttname"><a href="classas_i_script_engine.html#a32391ee83e58083b406ba068ab2ee049">asIScriptEngine::RequestContext</a></div><div class="ttdeci">virtual asIScriptContext * RequestContext()=0</div><div class="ttdoc">Request a context.</div></div>
|
||
|
|
<div class="ttc" id="aangelscript_8h_html_a7e38df5b10ec8cbf2a688f1d114097c5a0b3db16eea35213b6f41f8d19dc1bd4c"><div class="ttname"><a href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a0b3db16eea35213b6f41f8d19dc1bd4c">asBEHAVE_FACTORY</a></div><div class="ttdeci">@ asBEHAVE_FACTORY</div><div class="ttdoc">Factory.</div><div class="ttdef"><b>Definition:</b> angelscript.h:362</div></div>
|
||
|
|
<div class="ttc" id="aangelscript_8h_html_a7e38df5b10ec8cbf2a688f1d114097c5a7134ce13c81967191af401a1e5170a0c"><div class="ttname"><a href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a7134ce13c81967191af401a1e5170a0c">asBEHAVE_RELEASE</a></div><div class="ttdeci">@ asBEHAVE_RELEASE</div><div class="ttdoc">Release.</div><div class="ttdef"><b>Definition:</b> angelscript.h:368</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_context_html"><div class="ttname"><a href="classas_i_script_context.html">asIScriptContext</a></div><div class="ttdoc">The interface to the virtual machine.</div><div class="ttdef"><b>Definition:</b> angelscript.h:2717</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_context_html_a1c101300447f2909e5d188409a7180f6"><div class="ttname"><a href="classas_i_script_context.html#a1c101300447f2909e5d188409a7180f6">asIScriptContext::GetFunction</a></div><div class="ttdeci">virtual asIScriptFunction * GetFunction(asUINT stackLevel=0)=0</div><div class="ttdoc">Returns the function at the specified callstack level.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_type_info_html_a49f83d3a9158331029324bfbe9ae46a8"><div class="ttname"><a href="classas_i_type_info.html#a49f83d3a9158331029324bfbe9ae46a8">asITypeInfo::GetName</a></div><div class="ttdeci">virtual const char * GetName() const =0</div><div class="ttdoc">Returns a temporary pointer to the name of the datatype.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_context_html_a8e52894432737acac2e1a422e496bf84"><div class="ttname"><a href="classas_i_script_context.html#a8e52894432737acac2e1a422e496bf84">asIScriptContext::Execute</a></div><div class="ttdeci">virtual int Execute()=0</div><div class="ttdoc">Executes the prepared function.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_engine_html_a29c6c087c8c5b5cdb6271cfd161cc5a6"><div class="ttname"><a href="classas_i_script_engine.html#a29c6c087c8c5b5cdb6271cfd161cc5a6">asIScriptEngine::RegisterObjectType</a></div><div class="ttdeci">virtual int RegisterObjectType(const char *obj, int byteSize, asDWORD flags)=0</div><div class="ttdoc">Registers a new object type.</div></div>
|
||
|
|
<div class="ttc" id="aangelscript_8h_html_a855d86fa9ee15b9f75e553ee376b5c7aa9450e038342b36c745858d2e5ae4b861"><div class="ttname"><a href="angelscript_8h.html#a855d86fa9ee15b9f75e553ee376b5c7aa9450e038342b36c745858d2e5ae4b861">asOBJ_REF</a></div><div class="ttdeci">@ asOBJ_REF</div><div class="ttdoc">A reference type.</div><div class="ttdef"><b>Definition:</b> angelscript.h:250</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_context_html_a10d3c152b25d07584999f4d9fe5ce8b1"><div class="ttname"><a href="classas_i_script_context.html#a10d3c152b25d07584999f4d9fe5ce8b1">asIScriptContext::SetObject</a></div><div class="ttdeci">virtual int SetObject(void *obj)=0</div><div class="ttdoc">Sets the object for a class method call.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_engine_html"><div class="ttname"><a href="classas_i_script_engine.html">asIScriptEngine</a></div><div class="ttdoc">The engine interface.</div><div class="ttdef"><b>Definition:</b> angelscript.h:1092</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_engine_html_a9f122dd87394f3a83ac766ea19f37317"><div class="ttname"><a href="classas_i_script_engine.html#a9f122dd87394f3a83ac766ea19f37317">asIScriptEngine::RegisterObjectBehaviour</a></div><div class="ttdeci">virtual int RegisterObjectBehaviour(const char *obj, asEBehaviours behaviour, const char *declaration, const asSFuncPtr &funcPointer, asDWORD callConv, void *auxiliary=0, int compositeOffset=0, bool isCompositeIndirect=false)=0</div><div class="ttdoc">Registers a behaviour for the object type.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_object_html_a9ccca7fe3453219377fc9bd190bf7903"><div class="ttname"><a href="classas_i_script_object.html#a9ccca7fe3453219377fc9bd190bf7903">asIScriptObject::GetWeakRefFlag</a></div><div class="ttdeci">virtual asILockableSharedBool * GetWeakRefFlag() const =0</div><div class="ttdoc">Returns the weak ref flag for the object.</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="aclassas_i_script_engine_html_a3101479b4340bc16bb9acb8e8d554266"><div class="ttname"><a href="classas_i_script_engine.html#a3101479b4340bc16bb9acb8e8d554266">asIScriptEngine::CreateScriptObject</a></div><div class="ttdeci">virtual void * CreateScriptObject(const asITypeInfo *type)=0</div><div class="ttdoc">Creates an object defined by its type.</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="aclassas_i_script_engine_html_a22e42bf32902cbd6885731a6beeaca20"><div class="ttname"><a href="classas_i_script_engine.html#a22e42bf32902cbd6885731a6beeaca20">asIScriptEngine::ReturnContext</a></div><div class="ttdeci">virtual void ReturnContext(asIScriptContext *ctx)=0</div><div class="ttdoc">Return a context when it won't be used anymore.</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_lockable_shared_bool_html"><div class="ttname"><a href="classas_i_lockable_shared_bool.html">asILockableSharedBool</a></div><div class="ttdoc">A lockable shared boolean.</div><div class="ttdef"><b>Definition:</b> angelscript.h:4077</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_function_html"><div class="ttname"><a href="classas_i_script_function.html">asIScriptFunction</a></div><div class="ttdoc">The interface for a script function description.</div><div class="ttdef"><b>Definition:</b> angelscript.h:3823</div></div>
|
||
|
|
<div class="ttc" id="aangelscript_8h_html_a7e38df5b10ec8cbf2a688f1d114097c5a1dfa5b72ad69a7bf70636d4fcb1b1d84"><div class="ttname"><a href="angelscript_8h.html#a7e38df5b10ec8cbf2a688f1d114097c5a1dfa5b72ad69a7bf70636d4fcb1b1d84">asBEHAVE_ADDREF</a></div><div class="ttdeci">@ asBEHAVE_ADDREF</div><div class="ttdoc">AddRef.</div><div class="ttdef"><b>Definition:</b> angelscript.h:366</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="aclassas_i_script_context_html_a6f0f071215e0f7effc0b765043f01275"><div class="ttname"><a href="classas_i_script_context.html#a6f0f071215e0f7effc0b765043f01275">asIScriptContext::SetException</a></div><div class="ttdeci">virtual int SetException(const char *info, bool allowCatch=true)=0</div><div class="ttdoc">Sets an exception, which aborts the execution.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_object_html"><div class="ttname"><a href="classas_i_script_object.html">asIScriptObject</a></div><div class="ttdoc">The interface for an instance of a script object.</div><div class="ttdef"><b>Definition:</b> angelscript.h:3413</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="aclassas_i_script_context_html_a43976f42dfc6c1af23e132d36265173a"><div class="ttname"><a href="classas_i_script_context.html#a43976f42dfc6c1af23e132d36265173a">asIScriptContext::Prepare</a></div><div class="ttdeci">virtual int Prepare(asIScriptFunction *func)=0</div><div class="ttdoc">Prepares the context for execution of the function.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_object_html_a4bed3c3ac9f16294985835747aa122d3"><div class="ttname"><a href="classas_i_script_object.html#a4bed3c3ac9f16294985835747aa122d3">asIScriptObject::Release</a></div><div class="ttdeci">virtual int Release() const =0</div><div class="ttdoc">Decrease reference counter.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_function_html_af930b362c37e5c4c117485d0bd4a34fb"><div class="ttname"><a href="classas_i_script_function.html#af930b362c37e5c4c117485d0bd4a34fb">asIScriptFunction::GetObjectType</a></div><div class="ttdeci">virtual asITypeInfo * GetObjectType() const =0</div><div class="ttdoc">Returns the object type for class or interface method.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_context_html_a4f6761a7a0c872dda681d8e180830ff9"><div class="ttname"><a href="classas_i_script_context.html#a4f6761a7a0c872dda681d8e180830ff9">asIScriptContext::GetThisPointer</a></div><div class="ttdeci">virtual void * GetThisPointer(asUINT stackLevel=0)=0</div><div class="ttdoc">Returns a pointer to the object, if a class method is being executed.</div></div>
|
||
|
|
<div class="ttc" id="aclassas_i_script_object_html_a6a8a3c7d1e103e43923614b719e3cb3a"><div class="ttname"><a href="classas_i_script_object.html#a6a8a3c7d1e103e43923614b719e3cb3a">asIScriptObject::GetAddressOfProperty</a></div><div class="ttdeci">virtual void * GetAddressOfProperty(asUINT prop)=0</div><div class="ttdoc">Returns a pointer to the property referenced by prop.</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>
|
||
|
|
<div class="ttc" id="agroup__api__principal__functions_html_gad3a20dc58093b92a5a44c7b6ada34a10"><div class="ttname"><a href="group__api__principal__functions.html#gad3a20dc58093b92a5a44c7b6ada34a10">asGetActiveContext</a></div><div class="ttdeci">AS_API asIScriptContext * asGetActiveContext()</div><div class="ttdoc">Returns the currently active context.</div></div>
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="footer">Generated on Sat Dec 5 2020 23:20:24 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>
|