File: X3DCastleScript.TCasScriptX3DValueList.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (161 lines) | stat: -rw-r--r-- 10,077 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: X3DCastleScript: Class TCasScriptX3DValueList</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TCasScriptX3DValueList"></a><h1 class="cio">Class TCasScriptX3DValueList</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="X3DCastleScript.html">X3DCastleScript</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TCasScriptX3DValueList = class(<a class="normal" href="CastleScript.TCasScriptValueList.html">TCasScriptValueList</a>)</code></p>
<h2 class="description">Description</h2>
<div class="nodescription">no description available, TCasScriptValueList description follows</div><a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TFPGObjectList</li>
<li class="ancestor"><a class="normal" href="CastleScript.TCasScriptValueList.html">TCasScriptValueList</a></li>
<li class="thisitem">TCasScriptX3DValueList</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="X3DCastleScript.TCasScriptX3DValueList.html#Create">Create</a></b>(AFreeObjects: boolean);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a  href="X3DCastleScript.TCasScriptX3DValueList.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="X3DCastleScript.TCasScriptX3DValueList.html#Add">Add</a></b>(FieldOrEvent: <a  href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</a>);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="X3DCastleScript.TCasScriptX3DValueList.html#BeforeExecute">BeforeExecute</a></b>;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="X3DCastleScript.TCasScriptX3DValueList.html#AfterExecute">AfterExecute</a></b>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="X3DCastleScript.TCasScriptX3DValueList.html#ResetLastEventTimes">ResetLastEventTimes</a></b>;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DCastleScript.TCasScriptX3DValueList.html#FieldOrEvents">FieldOrEvents</a></b>: <a  href="X3DFields.html#TX3DFieldOrEventList">TX3DFieldOrEventList</a> read FFieldOrEvents;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(AFreeObjects: boolean);</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Add"></a><code>procedure <b>Add</b>(FieldOrEvent: <a  href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Create <a class="normal" href="CastleScript.TCasScriptValue.html">TCasScriptValue</a> descendant suitable to hold FieldOrEvent value, and add it to Items. FieldOrEvent is added to <a class="normal" href="X3DCastleScript.TCasScriptX3DValueList.html#FieldOrEvents">FieldOrEvents</a> list, so we keep all information.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="BeforeExecute"></a><code>procedure <b>BeforeExecute</b>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="AfterExecute"></a><code>procedure <b>AfterExecute</b>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ResetLastEventTimes"></a><code>procedure <b>ResetLastEventTimes</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Clear the memory when the last events were generated from this script. For each script output-capable field (inputOutput or outputOnly) on this list, we keep track of when it last generated an event.

<p>This is needed to avoid loops.

<p><i>Some background info why this is needed:</i>

<p>X3D spec says (4.4.8.3 Execution model): Nodes that contain output events shall produce at most one event per field per timestamp. [...] This also applies to scripts.

<p>&quot;[...]&quot; above talks about ROUTE breaking rule, we handle this generally in <a class="normal" href="X3DNodes.TX3DRoute.html">TX3DRoute</a>. The trouble with script is that it can make loops even without the help of ROUTEs: script receives it's inputs, and sends it's outputs, so when you send an output that causes your own input you made a loop... The most trivial example of this is when on receiving inputOutput you will set the very same inputOutput field, thus making a loop.

<p>Scripts with directOutput (although not implemented yet) can cause even more trouble, as you can generate input event on another node that will get back to you. If two scripts generate events on each other, this can again make a loop, without the help of ROUTEs.

<p>So we have to secure against this. This is done pretty much like with ROUTEs: we just remember the last timestamp, and ignore sending events again.</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="FieldOrEvents"></a><code>property <b>FieldOrEvents</b>: <a  href="X3DFields.html#TX3DFieldOrEventList">TX3DFieldOrEventList</a> read FFieldOrEvents;</code></td>
</tr>
<tr><td colspan="2">
<p>
List of field/events associated with this list's CasScript variables. This list is read-only (use <a class="normal" href="X3DCastleScript.TCasScriptX3DValueList.html#Add">Add</a> to add here). It always has the same Count as our own count.</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  _paq.push(["trackPageView"]);
  _paq.push(["enableLinkTracking"]);

  (function() {
    var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
    _paq.push(["setTrackerUrl", u+"piwik.php"]);
    _paq.push(["setSiteId", "1"]);
    var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
    g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
  })();
</script>
<!-- End Piwik Code -->

<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&amp;rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:13</em>
</span>
</td></tr></table></body></html>