<!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: iScriptValue Struct 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>iScriptValue Struct Reference</h1><!-- doxytag: class="iScriptValue" --><!-- doxytag: inherits="iBase" -->This provides the interface to a value stored in the scripting language's native format, be it a numeric or string value or a reference to an object.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="script_8h-source.html">ivaria/script.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iScriptValue:</div>
<div class="dynsection">
<p><center><img src="structiScriptValue__inherit__graph.png" border="0" usemap="#iScriptValue__inherit__map" alt="Inheritance graph"></center>
<map name="iScriptValue__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="25,7,81,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiScriptValue-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <br>
<a class="el" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5543a7258a6f7fc7bd993a74ddd33df459">tInt</a> = 0x01,
<a class="el" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5579d087cc9f09e5f37f44b192c7107f2b">tFloat</a> = 0x02,
<a class="el" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d55f415457eba09c69bb6c92e9bb6d077bb">tDouble</a> = 0x04,
<a class="el" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d55ad4a4391975e74717c2805fa4e9f02c2">tString</a> = 0x08,
<br>
<a class="el" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d554022efc46c9a81078021a3e582ee5dc3">tBool</a> = 0x10,
<a class="el" href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d5576422382c763edbdad4701346810675f">tObject</a> = 0x20
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Datatype constants, used to make a bitmask. <a href="structiScriptValue.html#d533a17afe13e35a05a8baed22b44d55">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiScriptValue.html#0fac2ba374af82e167ddd5b380d8fb71">GetBool</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns this value as a bool. <a href="#0fac2ba374af82e167ddd5b380d8fb71"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="structiScriptValue.html#eacc15fa78547302d4c40d0233a0c18f">GetDouble</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns this value as a double. <a href="#eacc15fa78547302d4c40d0233a0c18f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structiScriptValue.html#ed417d583e61e37207af93e487bbc944">GetFloat</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns this value as a float. <a href="#ed417d583e61e37207af93e487bbc944"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiScriptValue.html#aeec546d90eab40ccd574b9d67de7162">GetInt</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns this value as an int. <a href="#aeec546d90eab40ccd574b9d67de7162"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiScriptObject.html">iScriptObject</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiScriptValue.html#2e20ce8e2873bd17df256253d2c7ad47">GetObject</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns this value as a reference to a script object. <a href="#2e20ce8e2873bd17df256253d2c7ad47"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiScript.html">iScript</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiScriptValue.html#18fc51f238d3bac1eaba6ae59865b9be">GetScript</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to the <a class="el" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a> to which this value belongs. <a href="#18fc51f238d3bac1eaba6ae59865b9be"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsRef.html">csRef</a><br>
< <a class="el" href="structiString.html">iString</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structiScriptValue.html#8c53536b942e7a410718d5093f9fb8e7">GetString</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns this value as a string. <a href="#8c53536b942e7a410718d5093f9fb8e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="structiScriptValue.html#d9633d54d3371bd7d633cf54b2e37b71">GetTypes</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a bitmask indicating which types the value can be coerced into. <a href="#d9633d54d3371bd7d633cf54b2e37b71"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This provides the interface to a value stored in the scripting language's native format, be it a numeric or string value or a reference to an object.
<p>
The script interpreter (<a class="el" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a>) returns one of these from method and subroutine calls, and property and variable gets, and accepts one in method and subroutine arguments, and property and variable sets.<p>
This is a constant value such as 3 or "hello, world" and as such you generally cannot change the value stored in an <a class="el" href="structiScriptValue.html" title="This provides the interface to a value stored in the scripting language's native...">iScriptValue</a> object. To change the value of a variable in the script, construct a new <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 class="el" href="structiScript.html#43476da75107c1047a7efaed67968c25" title="Creates a new script value container object and returns it.">iScript::RValue()</a> and pass it to <a class="el" href="structiScript.html#61644764188eb0fc5bf24fec0341c422" title="Sets a variable in the script interpreter.">iScript::Store()</a> or <a class="el" href="structiScriptObject.html#819ed9b9f2eef80a1e7b6cccc2f164eb" title="Sets the value of a property in the script object.">iScriptObject::Set()</a>.<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiScript.html#43476da75107c1047a7efaed67968c25" title="Creates a new script value container object and returns it.">iScript::RValue()</a></li><li><a class="el" href="structiScript.html#6b0ed3f043b393ab6735fa91ce1d7057" title="Gets the value of a variable in the script interpreter.">iScript::Retrieve()</a></li><li><a class="el" href="structiScriptObject.html#d81a5d92dc87c43ba588be50b8cb0e8c" title="Gets the value of a property in the script object.">iScriptObject::Get()</a> </li></ul>
<p>Definition at line <a class="el" href="script_8h-source.html#l00054">54</a> of file <a class="el" href="script_8h-source.html">script.h</a>.</p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="d533a17afe13e35a05a8baed22b44d55"></a><!-- doxytag: member="iScriptValue::@82" ref="d533a17afe13e35a05a8baed22b44d55" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Datatype constants, used to make a bitmask.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="d533a17afe13e35a05a8baed22b44d5543a7258a6f7fc7bd993a74ddd33df459"></a><!-- doxytag: member="tInt" ref="d533a17afe13e35a05a8baed22b44d5543a7258a6f7fc7bd993a74ddd33df459" args="" -->tInt</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d533a17afe13e35a05a8baed22b44d5579d087cc9f09e5f37f44b192c7107f2b"></a><!-- doxytag: member="tFloat" ref="d533a17afe13e35a05a8baed22b44d5579d087cc9f09e5f37f44b192c7107f2b" args="" -->tFloat</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d533a17afe13e35a05a8baed22b44d55f415457eba09c69bb6c92e9bb6d077bb"></a><!-- doxytag: member="tDouble" ref="d533a17afe13e35a05a8baed22b44d55f415457eba09c69bb6c92e9bb6d077bb" args="" -->tDouble</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d533a17afe13e35a05a8baed22b44d55ad4a4391975e74717c2805fa4e9f02c2"></a><!-- doxytag: member="tString" ref="d533a17afe13e35a05a8baed22b44d55ad4a4391975e74717c2805fa4e9f02c2" args="" -->tString</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d533a17afe13e35a05a8baed22b44d554022efc46c9a81078021a3e582ee5dc3"></a><!-- doxytag: member="tBool" ref="d533a17afe13e35a05a8baed22b44d554022efc46c9a81078021a3e582ee5dc3" args="" -->tBool</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="d533a17afe13e35a05a8baed22b44d5576422382c763edbdad4701346810675f"></a><!-- doxytag: member="tObject" ref="d533a17afe13e35a05a8baed22b44d5576422382c763edbdad4701346810675f" args="" -->tObject</em> </td><td>
</td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="script_8h-source.html#l00059">59</a> of file <a class="el" href="script_8h-source.html">script.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0fac2ba374af82e167ddd5b380d8fb71"></a><!-- doxytag: member="iScriptValue::GetBool" ref="0fac2ba374af82e167ddd5b380d8fb71" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iScriptValue::GetBool </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns this value as a bool.
<p>
</div>
</div><p>
<a class="anchor" name="eacc15fa78547302d4c40d0233a0c18f"></a><!-- doxytag: member="iScriptValue::GetDouble" ref="eacc15fa78547302d4c40d0233a0c18f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double iScriptValue::GetDouble </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns this value as a double.
<p>
</div>
</div><p>
<a class="anchor" name="ed417d583e61e37207af93e487bbc944"></a><!-- doxytag: member="iScriptValue::GetFloat" ref="ed417d583e61e37207af93e487bbc944" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float iScriptValue::GetFloat </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns this value as a float.
<p>
</div>
</div><p>
<a class="anchor" name="aeec546d90eab40ccd574b9d67de7162"></a><!-- doxytag: member="iScriptValue::GetInt" ref="aeec546d90eab40ccd574b9d67de7162" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iScriptValue::GetInt </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns this value as an int.
<p>
</div>
</div><p>
<a class="anchor" name="2e20ce8e2873bd17df256253d2c7ad47"></a><!-- doxytag: member="iScriptValue::GetObject" ref="2e20ce8e2873bd17df256253d2c7ad47" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiScriptObject.html">iScriptObject</a>> iScriptValue::GetObject </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns this value as a reference to a script object.
<p>
</div>
</div><p>
<a class="anchor" name="18fc51f238d3bac1eaba6ae59865b9be"></a><!-- doxytag: member="iScriptValue::GetScript" ref="18fc51f238d3bac1eaba6ae59865b9be" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiScript.html">iScript</a>* iScriptValue::GetScript </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a reference to the <a class="el" href="structiScript.html" title="This provides the interface to a scripting language interpreter.">iScript</a> to which this value belongs.
<p>
</div>
</div><p>
<a class="anchor" name="8c53536b942e7a410718d5093f9fb8e7"></a><!-- doxytag: member="iScriptValue::GetString" ref="8c53536b942e7a410718d5093f9fb8e7" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsRef.html">csRef</a><<a class="el" href="structiString.html">iString</a>> iScriptValue::GetString </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns this value as a string.
<p>
</div>
</div><p>
<a class="anchor" name="d9633d54d3371bd7d633cf54b2e37b71"></a><!-- doxytag: member="iScriptValue::GetTypes" ref="d9633d54d3371bd7d633cf54b2e37b71" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned iScriptValue::GetTypes </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a bitmask indicating which types the value can be coerced into.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="script_8h-source.html">script.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
>
3573
