<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csScriptCommon Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csScriptCommon Class Reference</h1><!-- doxytag: class="csScriptCommon" --><!-- doxytag: inherits="scfImplementation1< csScriptCommon, iScript >" -->This intermediate class can be subclassed by implementors of <a class="el" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="scriptcommon_8h-source.html">csplugincommon/script/scriptcommon.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csScriptCommon:</div>
<div class="dynsection">
<p><center><img src="classcsScriptCommon__inherit__graph.png" border="0" usemap="#csScriptCommon__inherit__map" alt="Inheritance graph"></center>
<map name="csScriptCommon__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csScriptCommon, iScript \>" alt="" coords="75,161,413,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csScriptCommon \>" alt="" coords="5,84,288,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="297,7,353,33"><area shape="rect" href="structiScript.html" title="This provides the interface to a scripting language interpreter." alt="" coords="312,84,373,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="36,7,257,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsScriptCommon-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiScriptValue.html">iScriptValue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScriptCommon.html#0831d2643d12f5d631064966c737fe22">Call</a> (const char *, const <a class="el" href="classcsRefArray.html">csRefArray</a>< <a class="el" href="structiScriptValue.html">iScriptValue</a> > &=<a class="el" href="classcsRefArray.html">csRefArray</a>< <a class="el" href="structiScriptValue.html">iScriptValue</a> >())=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Calls a subroutine in the script. <a href="#0831d2643d12f5d631064966c737fe22"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a><br>
< <a class="el" href="structiScriptValue.html">iScriptValue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScriptCommon.html#83624bf5629bbac3821bfb742d51189d">Retrieve</a> (const char *)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the value of a variable in the script interpreter. <a href="#83624bf5629bbac3821bfb742d51189d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScriptCommon.html#68ddb4368e3402a74cdadabf3aba58ec">Store</a> (const char *name, <a class="el" href="structiScriptValue.html">iScriptValue</a> *)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a variable in the script interpreter. <a href="#68ddb4368e3402a74cdadabf3aba58ec"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="71e6b2df2118209ae1d3d513fd72ef3a"></a><!-- doxytag: member="csScriptCommon::~csScriptCommon" ref="71e6b2df2118209ae1d3d513fd72ef3a" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScriptCommon.html#71e6b2df2118209ae1d3d513fd72ef3a">~csScriptCommon</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf213144347ec2ef4ee989d8a60df632"></a><!-- doxytag: member="csScriptCommon::csScriptCommon" ref="bf213144347ec2ef4ee989d8a60df632" args="(iBase *parent)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScriptCommon.html#bf213144347ec2ef4ee989d8a60df632">csScriptCommon</a> (<a class="el" href="structiBase.html">iBase</a> *parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b43f17f735569e52a7331ecb3cb73a2f"></a><!-- doxytag: member="csScriptCommon::csScriptCommon" ref="b43f17f735569e52a7331ecb3cb73a2f" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsScriptCommon.html#b43f17f735569e52a7331ecb3cb73a2f">csScriptCommon</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This intermediate class can be subclassed by implementors of <a class="el" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a>.
<p>
It implements the deprecated methods in <a class="el" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a> by forwarding calls to the new methods which have replaced them.<p>
When the deprecated methods are removed, this will no longer be neccessary.
<p>Definition at line <a class="el" href="scriptcommon_8h-source.html#l00090">90</a> of file <a class="el" href="scriptcommon_8h-source.html">scriptcommon.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0831d2643d12f5d631064966c737fe22"></a><!-- doxytag: member="csScriptCommon::Call" ref="0831d2643d12f5d631064966c737fe22" args="(const char *, const csRefArray< iScriptValue > &=csRefArray< iScriptValue >())=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiScriptValue.html">iScriptValue</a>> csScriptCommon::Call </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 <a class="el" href="classcsRefArray.html">csRefArray</a>< <a class="el" href="structiScriptValue.html">iScriptValue</a> > & </td>
<td class="paramname"> <em>args</em> = <code><a class="el" href="classcsRefArray.html">csRefArray</a>< <a class="el" href="structiScriptValue.html">iScriptValue</a> >()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Calls a subroutine in the script.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the subroutine. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>An optional array of arguments to pass to the subroutine. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The return value of the subroutine. If the subroutine does not exist or encounters a runtime error then it returns 0. If it returns no value then it returns an <a class="el" href="structiScriptValue.html" title="This provides the interface to a value stored in the scripting language's native...">iScriptValue</a> with a bitmask of 0. </dd></dl>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Scripting languages that support pass-by-reference may change the values of the arguments. </dd></dl>
<p>Implements <a class="el" href="structiScript.html#1ae85fb45e1ca774776c727b174b92d1">iScript</a>.</p>
</div>
</div><p>
<a class="anchor" name="83624bf5629bbac3821bfb742d51189d"></a><!-- doxytag: member="csScriptCommon::Retrieve" ref="83624bf5629bbac3821bfb742d51189d" args="(const char *)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiScriptValue.html">iScriptValue</a>> csScriptCommon::Retrieve </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the value of a variable in the script interpreter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the variable to retrieve. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the variable, or 0 if it does not exist. </dd></dl>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The name is given without any special characters (e.g. the dollar prefix in Perl). </dd></dl>
<p>Implements <a class="el" href="structiScript.html#6b0ed3f043b393ab6735fa91ce1d7057">iScript</a>.</p>
</div>
</div><p>
<a class="anchor" name="68ddb4368e3402a74cdadabf3aba58ec"></a><!-- doxytag: member="csScriptCommon::Store" ref="68ddb4368e3402a74cdadabf3aba58ec" args="(const char *name, iScriptValue *)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csScriptCommon::Store </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"><a class="el" href="structiScriptValue.html">iScriptValue</a> * </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets a variable in the script interpreter.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the variable to set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value to set the variable to. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the variable could not be stored (e.g. illegal name, or variable already exists and is immutable). </dd></dl>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The name is given without any special characters (e.g. the dollar prefix in Perl). </dd></dl>
<p>Implements <a class="el" href="structiScript.html#61644764188eb0fc5bf24fec0341c422">iScript</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csplugincommon/script/<a class="el" href="scriptcommon_8h-source.html">scriptcommon.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
1004
