<!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: ivaria/script.h Source File (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><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>ivaria/script.h</h1><a href="script_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 1999 by Brandon Ehle <azverkan@yahoo.com></span>
<a name="l00003"></a>00003 <span class="comment"> (C) 2003-2007 by Mat Sutcliffe <oktal@gmx.co.uk></span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_IVARIA_SCRIPT_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IVARIA_SCRIPT_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="scf_8h.html" title="Crystal Space Shared Class Facility (SCF).">csutil/scf.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="ref_8h.html" title="Smart Pointers.">csutil/ref.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="refarr_8h.html" title="Smart Pointer array.">csutil/refarr.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="string_8h.html" title="String interface.">iutil/string.h</a>"</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a>;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiScriptObject.html" title="This provides the interface to an object in an object-oriented scripting language...">iScriptObject</a>;
<a name="l00035"></a>00035
<a name="l00054"></a><a class="code" href="structiScriptValue.html">00054</a> <span class="keyword">struct </span><a class="code" href="structiScriptValue.html" title="This provides the interface to a value stored in the scripting language&#39;s native...">iScriptValue</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00055"></a>00055 {
<a name="l00056"></a>00056 SCF_INTERFACE (<a class="code" href="structiScriptValue.html" title="This provides the interface to a value stored in the scripting language&#39;s native...">iScriptValue</a>, 2, 0, 0);
<a name="l00057"></a>00057
<a name="l00059"></a>00059 <span class="keyword">enum</span>
<a name="l00060"></a>00060 {
<a name="l00061"></a><a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5543a7258a6f7fc7bd993a74ddd33df459">00061</a> <a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5543a7258a6f7fc7bd993a74ddd33df459">tInt</a> = 0x01,
<a name="l00062"></a><a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5579d087cc9f09e5f37f44b192c7107f2b">00062</a> <a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5579d087cc9f09e5f37f44b192c7107f2b">tFloat</a> = 0x02,
<a name="l00063"></a><a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d55f415457eba09c69bb6c92e9bb6d077bb">00063</a> <a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d55f415457eba09c69bb6c92e9bb6d077bb">tDouble</a> = 0x04,
<a name="l00064"></a><a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d55ad4a4391975e74717c2805fa4e9f02c2">00064</a> <a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d55ad4a4391975e74717c2805fa4e9f02c2">tString</a> = 0x08,
<a name="l00065"></a><a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d554022efc46c9a81078021a3e582ee5dc3">00065</a> <a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d554022efc46c9a81078021a3e582ee5dc3">tBool</a> = 0x10,
<a name="l00066"></a><a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5576422382c763edbdad4701346810675f">00066</a> <a class="code" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5576422382c763edbdad4701346810675f">tObject</a> = 0x20
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00070"></a>00070 <span class="keyword">virtual</span> <a class="code" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a>* <a class="code" href="structiScriptValue.html#18fc51f238d3bac1eaba6ae59865b9be" title="Returns a reference to the iScript to which this value belongs.">GetScript</a> () = 0;
<a name="l00071"></a>00071
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <a class="code" href="structiScriptValue.html#d9633d54d3371bd7d633cf54b2e37b71" title="Returns a bitmask indicating which types the value can be coerced into.">GetTypes</a> () <span class="keyword">const</span> = 0;
<a name="l00074"></a>00074
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiScriptValue.html#aeec546d90eab40ccd574b9d67de7162" title="Returns this value as an int.">GetInt</a> () <span class="keyword">const</span> = 0;
<a name="l00077"></a>00077
<a name="l00079"></a>00079 <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structiScriptValue.html#ed417d583e61e37207af93e487bbc944" title="Returns this value as a float.">GetFloat</a> () <span class="keyword">const</span> = 0;
<a name="l00080"></a>00080
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="structiScriptValue.html#eacc15fa78547302d4c40d0233a0c18f" title="Returns this value as a double.">GetDouble</a> () <span class="keyword">const</span> = 0;
<a name="l00083"></a>00083
<a name="l00085"></a>00085 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iString></a> <a class="code" href="structiScriptValue.html#8c53536b942e7a410718d5093f9fb8e7" title="Returns this value as a string.">GetString</a> () <span class="keyword">const</span> = 0;
<a name="l00086"></a>00086
<a name="l00088"></a>00088 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptValue.html#0fac2ba374af82e167ddd5b380d8fb71" title="Returns this value as a bool.">GetBool</a> () <span class="keyword">const</span> = 0;
<a name="l00089"></a>00089
<a name="l00091"></a>00091 <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iScriptObject></a> <a class="code" href="structiScriptValue.html#2e20ce8e2873bd17df256253d2c7ad47" title="Returns this value as a reference to a script object.">GetObject</a> () <span class="keyword">const</span> = 0;
<a name="l00092"></a>00092 };
<a name="l00093"></a>00093
<a name="l00102"></a><a class="code" href="structiScriptObject.html">00102</a> <span class="keyword">struct </span><a class="code" href="structiScriptObject.html" title="This provides the interface to an object in an object-oriented scripting language...">iScriptObject</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00103"></a>00103 {
<a name="l00104"></a>00104 SCF_INTERFACE (<a class="code" href="structiScriptObject.html" title="This provides the interface to an object in an object-oriented scripting language...">iScriptObject</a>, 2, 0, 0);
<a name="l00105"></a>00105
<a name="l00109"></a>00109 <span class="keyword">virtual</span> <a class="code" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a>* <a class="code" href="structiScriptObject.html#1780349ab8f38544c2911488a2ed620b" title="Returns a reference to the iScript to which this object belongs.">GetScript</a> () = 0;
<a name="l00110"></a>00110
<a name="l00117"></a>00117 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iString></a> <a class="code" href="structiScriptObject.html#be5da03ed5f151d9778c1d4edfba3cb6" title="Returns the name of this object&#39;s class.">GetClass</a> () <span class="keyword">const</span> = 0;
<a name="l00118"></a>00118
<a name="l00126"></a>00126 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#09b8d49d912f544d92b19b39e3862441" title="Returns a boolean specifying whether or not the object &quot;is a&quot; or is derived...">IsA</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *) <span class="keyword">const</span> = 0;
<a name="l00127"></a>00127
<a name="l00129"></a>00129 <a class="code" href="cssysdef_8h.html#69b27a22db26f4a2bb7a26a85d2ab06b" title="A variant of CS_DEPRECATED_METHOD that also emits the message msg on compilers that...">CS_DEPRECATED_METHOD_MSG</a>(<span class="stringliteral">"use IsA() instead"</span>)
<a name="l00130"></a>00130 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#cb5eebb45500ca4e7b9d373f59e2d17c" title="Deprecated version of IsA().">IsType</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *) <span class="keyword">const</span> = 0;
<a name="l00131"></a>00131
<a name="l00141"></a>00141 <span class="keyword">virtual</span> <span class="keywordtype">void</span>* <a class="code" href="structiScriptObject.html#6d5c93ac054b188e80491f8c0b463ce5" title="If the object is from the cspace module, this will return its pointer.">GetPointer</a> () = 0;
<a name="l00142"></a>00142
<a name="l00149"></a>00149 <a class="code" href="cssysdef_8h.html#6aa75111b26a9a9e9cc8213e8e245d97" title="Use the CS_DEPRECATED_METHOD macro in front of method declarations to indicate that...">CS_DEPRECATED_METHOD</a>
<a name="l00150"></a>00150 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#cf68f97511740f07c8a7d2ee0a66fa4e" title="If the object is from the cspace module, this will allow you to change the reference...">SetPointer</a> (<span class="keywordtype">void</span>*) = 0;
<a name="l00151"></a>00151
<a name="l00162"></a>00162 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00163"></a>00163 <span class="keyword">const</span> <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray<iScriptValue></a> &args = <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray<iScriptValue></a> ()) = 0;
<a name="l00164"></a>00164
<a name="l00175"></a>00175 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="structiScriptValue.html" title="This provides the interface to a value stored in the scripting language&#39;s native...">iScriptValue</a> *value) = 0;
<a name="l00176"></a>00176
<a name="l00186"></a>00186 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> <a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name) = 0;
<a name="l00187"></a>00187
<a name="l00189"></a>00189 <span class="comment">//@@@ Lots more deprecated methods below</span>
<a name="l00190"></a>00190
<a name="l00191"></a><a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">00191</a> <span class="preprocessor"> #define CS_DEPRECATED_METHOD_MSG_CALL CS_DEPRECATED_METHOD_MSG \</span>
<a name="l00192"></a>00192 <span class="preprocessor"> ("use Call(const char*, const csRefArray<iScriptValue>&) instead")</span>
<a name="l00193"></a><a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">00193</a> <span class="preprocessor"></span><span class="preprocessor"> #define CS_DEPRECATED_METHOD_MSG_SET(NEW_METHOD) CS_DEPRECATED_METHOD_MSG \</span>
<a name="l00194"></a>00194 <span class="preprocessor"> ("use " NEW_METHOD "(const char*, iScriptValue*) instead")</span>
<a name="l00195"></a><a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">00195</a> <span class="preprocessor"></span><span class="preprocessor"> #define CS_DEPRECATED_METHOD_MSG_GET(NEW_METHOD) CS_DEPRECATED_METHOD_MSG \</span>
<a name="l00196"></a>00196 <span class="preprocessor"> ("use " NEW_METHOD "(const char*) instead")</span>
<a name="l00197"></a>00197 <span class="preprocessor"></span>
<a name="l00198"></a>00198 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00199"></a>00199 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...)
<a name="l00200"></a>00200 <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(3, 4) = 0;
<a name="l00201"></a>00201 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00202"></a>00202 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> &ret, const <span class="keywordtype">char</span> *fmt, ...)
<a name="l00203"></a>00203 <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(4, 5) = 0;
<a name="l00204"></a>00204 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00205"></a>00205 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">float</span> &ret, const <span class="keywordtype">char</span> *fmt, ...)
<a name="l00206"></a>00206 CS_GNUC_PRINTF(4, 5) = 0;
<a name="l00207"></a>00207 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00208"></a>00208 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">double</span> &ret, const <span class="keywordtype">char</span> *fmt, ...)
<a name="l00209"></a>00209 CS_GNUC_PRINTF(4, 5) = 0;
<a name="l00210"></a>00210 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00211"></a>00211 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (const <span class="keywordtype">char</span> *name, <a class="code" href="classcsRef.html" title="A smart pointer.">csRef</a><<a class="code" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a>>&, const <span class="keywordtype">char</span> *fmt, ...)
<a name="l00212"></a>00212 CS_GNUC_PRINTF(4, 5) = 0;
<a name="l00213"></a>00213 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00214"></a>00214 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (const <span class="keywordtype">char</span> *name, <a class="code" href="classcsRef.html" title="A smart pointer.">csRef</a><<a class="code" href="structiScriptObject.html" title="This provides the interface to an object in an object-oriented scripting language...">iScriptObject</a>>&,
<a name="l00215"></a>00215 const <span class="keywordtype">char</span> *fmt, ...) CS_GNUC_PRINTF(4, 5) = 0;
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>("<a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a>")
<a name="l00218"></a>00218 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> data) = 0;
<a name="l00219"></a>00219 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>("<a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a>")
<a name="l00220"></a>00220 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">float</span> data) = 0;
<a name="l00221"></a>00221 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>("<a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a>")
<a name="l00222"></a>00222 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">double</span> data) = 0;
<a name="l00223"></a>00223 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>("<a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a>")
<a name="l00224"></a>00224 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">char</span> const *data) = 0;
<a name="l00225"></a>00225 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>("<a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a>")
<a name="l00226"></a>00226 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a> (const <span class="keywordtype">char</span> *name, iScriptObject *data) = 0;
<a name="l00227"></a>00227 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>("<a class="code" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">Set</a>")
<a name="l00228"></a>00228 virtual <span class="keywordtype">bool</span> SetTruth (const <span class="keywordtype">char</span> *name, <span class="keywordtype">bool</span> isTrue) = 0;
<a name="l00229"></a>00229
<a name="l00230"></a>00230 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>("<a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a>")
<a name="l00231"></a>00231 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> &data) const = 0;
<a name="l00232"></a>00232 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>("<a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a>")
<a name="l00233"></a>00233 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">float</span> &data) const = 0;
<a name="l00234"></a>00234 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>("<a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a>")
<a name="l00235"></a>00235 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a> (const <span class="keywordtype">char</span> *name, <span class="keywordtype">double</span> &data) const = 0;
<a name="l00236"></a>00236 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>("<a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a>")
<a name="l00237"></a>00237 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a> (const <span class="keywordtype">char</span> *name, <a class="code" href="classcsRef.html" title="A smart pointer.">csRef</a><iString>&) const = 0;
<a name="l00238"></a>00238 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>("<a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a>")
<a name="l00239"></a>00239 virtual <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a> (const <span class="keywordtype">char</span> *name, <a class="code" href="classcsRef.html" title="A smart pointer.">csRef</a><iScriptObject>&) const = 0;
<a name="l00240"></a>00240 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>("<a class="code" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">Get</a>")
<a name="l00241"></a>00241 virtual <span class="keywordtype">bool</span> GetTruth (const <span class="keywordtype">char</span> *name, <span class="keywordtype">bool</span> &isTrue) const = 0;
<a name="l00242"></a>00242 };
<a name="l00243"></a>00243
<a name="l00249"></a><a class="code" href="structiScript.html">00249</a> struct <a class="code" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a> : public virtual <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a>
<a name="l00250"></a>00250 {
<a name="l00251"></a>00251 SCF_INTERFACE (<a class="code" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a>, 2, 0, 0);
<a name="l00252"></a>00252
<a name="l00258"></a>00258 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> RunText (<span class="keyword">const</span> <span class="keywordtype">char</span> *text) = 0;
<a name="l00259"></a>00259
<a name="l00265"></a>00265 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> LoadModule (<span class="keyword">const</span> <span class="keywordtype">char</span> *name) = 0;
<a name="l00266"></a>00266
<a name="l00273"></a>00273 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> LoadModule (<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keyword">const</span> <span class="keywordtype">char</span> *filename) = 0;
<a name="l00274"></a>00274
<a name="l00281"></a>00281 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> LoadModuleNative (<span class="keyword">const</span> <span class="keywordtype">char</span> *path, <span class="keyword">const</span> <span class="keywordtype">char</span> *filename) = 0;
<a name="l00282"></a>00282
<a name="l00293"></a>00293 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name,
<a name="l00294"></a>00294 <span class="keyword">const</span> <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray<iScriptValue></a> &args = <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray<iScriptValue></a> ()) = 0;
<a name="l00295"></a>00295
<a name="l00297"></a>00297 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> RValue (<span class="keywordtype">int</span> value) = 0;
<a name="l00298"></a>00298
<a name="l00300"></a>00300 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> RValue (<span class="keywordtype">float</span> value) = 0;
<a name="l00301"></a>00301
<a name="l00303"></a>00303 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> RValue (<span class="keywordtype">double</span> value) = 0;
<a name="l00304"></a>00304
<a name="l00306"></a>00306 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> RValue (<span class="keyword">const</span> <span class="keywordtype">char</span> *value) = 0;
<a name="l00307"></a>00307
<a name="l00309"></a>00309 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> RValue (<span class="keywordtype">bool</span> value) = 0;
<a name="l00310"></a>00310
<a name="l00312"></a>00312 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> RValue (iScriptObject *value) = 0;
<a name="l00313"></a>00313
<a name="l00322"></a>00322 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptObject></a> New (<span class="keyword">const</span> <span class="keywordtype">char</span> *type,
<a name="l00323"></a>00323 <span class="keyword">const</span> <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray<iScriptValue></a> &args = <a class="code" href="classcsRefArray.html" title="An array of smart pointers.">csRefArray<iScriptValue></a> ()) = 0;
<a name="l00324"></a>00324
<a name="l00334"></a>00334 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Store (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="structiScriptValue.html" title="This provides the interface to a value stored in the scripting language&#39;s native...">iScriptValue</a> *value) = 0;
<a name="l00335"></a>00335
<a name="l00343"></a>00343 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iScriptValue></a> Retrieve (<span class="keyword">const</span> <span class="keywordtype">char</span> *name) = 0;
<a name="l00344"></a>00344
<a name="l00352"></a>00352 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Remove (<span class="keyword">const</span> <span class="keywordtype">char</span> *name) = 0;
<a name="l00353"></a>00353
<a name="l00355"></a>00355 <span class="comment">//@@@ Lots more deprecated methods below.</span>
<a name="l00356"></a>00356
<a name="l00357"></a>00357 <a class="code" href="cssysdef_8h.html#69b27a22db26f4a2bb7a26a85d2ab06b" title="A variant of CS_DEPRECATED_METHOD that also emits the message msg on compilers that...">CS_DEPRECATED_METHOD_MSG</a>(<span class="stringliteral">"use New() instead"</span>)
<a name="l00358"></a>00358 <span class="keyword">virtual</span> <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iScriptObject></a> NewObject (<span class="keyword">const</span> <span class="keywordtype">char</span> *type,
<a name="l00359"></a>00359 <span class="keyword">const</span> <span class="keywordtype">char</span> *ctorFormat, ...) <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(3, 4) = 0;
<a name="l00360"></a>00360
<a name="l00361"></a>00361 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00362"></a>00362 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> <span class="keywordtype">char</span> *format, ...)
<a name="l00363"></a>00363 <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(3, 4) = 0;
<a name="l00364"></a>00364 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00365"></a>00365 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> &ret, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...)
<a name="l00366"></a>00366 <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(4, 5) = 0;
<a name="l00367"></a>00367 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00368"></a>00368 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">float</span> &ret, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...)
<a name="l00369"></a>00369 <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(4, 5) = 0;
<a name="l00370"></a>00370 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00371"></a>00371 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">double</span> &ret, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...)
<a name="l00372"></a>00372 <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(4, 5) = 0;
<a name="l00373"></a>00373 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00374"></a>00374 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iString></a>&, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...)
<a name="l00375"></a>00375 <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(4, 5) = 0;
<a name="l00376"></a>00376 <a class="code" href="script_8h.html#18c2d5865e185193e7c3aaa67add8d8d">CS_DEPRECATED_METHOD_MSG_CALL</a>
<a name="l00377"></a>00377 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiScriptObject.html#648a202dfe9bce6ca194a3ea0e6b38ad" title="Calls a method in the object.">Call</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iScriptObject></a> &ret,
<a name="l00378"></a>00378 <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...) <a class="code" href="cssysdef_8h.html#8e48e51430e3babbaf943b676c17ec31">CS_GNUC_PRINTF</a>(4, 5) = 0;
<a name="l00379"></a>00379
<a name="l00380"></a>00380 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>(<span class="stringliteral">"Store"</span>)
<a name="l00381"></a>00381 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Store (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> data) = 0;
<a name="l00382"></a>00382 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>(<span class="stringliteral">"Store"</span>)
<a name="l00383"></a>00383 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Store (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">float</span> data) = 0;
<a name="l00384"></a>00384 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>(<span class="stringliteral">"Store"</span>)
<a name="l00385"></a>00385 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Store (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">double</span> data) = 0;
<a name="l00386"></a>00386 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>(<span class="stringliteral">"Store"</span>)
<a name="l00387"></a>00387 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Store (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">char</span> <span class="keyword">const</span> *data) = 0;
<a name="l00388"></a>00388 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>(<span class="stringliteral">"Store"</span>)
<a name="l00389"></a>00389 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Store (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, iScriptObject *data) = 0;
<a name="l00390"></a>00390 <a class="code" href="script_8h.html#87f2ca8c78096e4a6e17f3e97f44dc0d">CS_DEPRECATED_METHOD_MSG_SET</a>(<span class="stringliteral">"Store"</span>)
<a name="l00391"></a>00391 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> SetTruth (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">bool</span> isTrue) = 0;
<a name="l00392"></a>00392
<a name="l00393"></a>00393 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>(<span class="stringliteral">"Retrieve"</span>)
<a name="l00394"></a>00394 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Retrieve (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> &data) <span class="keyword">const</span> = 0;
<a name="l00395"></a>00395 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>(<span class="stringliteral">"Retrieve"</span>)
<a name="l00396"></a>00396 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Retrieve (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">float</span> &data) <span class="keyword">const</span> = 0;
<a name="l00397"></a>00397 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>(<span class="stringliteral">"Retrieve"</span>)
<a name="l00398"></a>00398 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Retrieve (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">double</span> &data) <span class="keyword">const</span> = 0;
<a name="l00399"></a>00399 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>(<span class="stringliteral">"Retrieve"</span>)
<a name="l00400"></a>00400 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Retrieve (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iString></a>&) <span class="keyword">const</span> = 0;
<a name="l00401"></a>00401 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>(<span class="stringliteral">"Retrieve"</span>)
<a name="l00402"></a>00402 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Retrieve (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iScriptObject></a>&) <span class="keyword">const</span> = 0;
<a name="l00403"></a>00403 <a class="code" href="script_8h.html#aadf5022b9f6481db3a912d9e28b2c87">CS_DEPRECATED_METHOD_MSG_GET</a>(<span class="stringliteral">"Retrieve"</span>)
<a name="l00404"></a>00404 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> GetTruth (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">bool</span> &isTrue) <span class="keyword">const</span> = 0;
<a name="l00405"></a>00405
<a name="l00406"></a>00406 <span class="preprocessor"> #undef CS_DEPRECATED_METHOD_MSG_CALL</span>
<a name="l00407"></a>00407 <span class="preprocessor"></span><span class="preprocessor"> #undef CS_DEPRECATED_METHOD_MSG_SET</span>
<a name="l00408"></a>00408 <span class="preprocessor"></span><span class="preprocessor"> #undef CS_DEPRECATED_METHOD_MSG_GET</span>
<a name="l00409"></a>00409 <span class="preprocessor"></span>};
<a name="l00410"></a>00410
<a name="l00411"></a>00411 <span class="preprocessor">#endif // __CS_IVARIA_SCRIPT_H__</span>
</pre></div><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
>
2271
