source: java/FramclipsePlugin/src/main/resources/framscript.xml @ 35

Last change on this file since 35 was 29, checked in by sz, 15 years ago
  • Property svn:mime-type set to text/plain
File size: 246.5 KB
Line 
1<?xml version="1.0"?>
2<!DOCTYPE framscript SYSTEM "framscript.dtd">
3<?xml-stylesheet type="text/xsl" href="framscript.xsl"?>
4<framscript>
5        <type name="expdef" context="expdef file">
6                <element name="code" type="string"/>
7                <element name="info" type="string"/>
8                <element name="name" type="string"/>
9                <element name="neurons" type="string"/>
10        </type>
11        <type name="prop" context="properties file">
12                <element name="flags" type="integer"/>
13                <element name="group" type="string"/>
14                <element name="help" type="string"/>
15                <element name="id" type="string"/>
16                <element name="name" type="string"/>
17                <element name="type" type="string"/>
18        </type>
19        <type name="stat" context="state file">
20                <element name="flags" type="integer"/>
21                <element name="group" type="string"/>
22                <element name="help" type="string"/>
23                <element name="id" type="string"/>
24                <element name="name" type="string"/>
25                <element name="type" type="string"/>
26        </type>
27        <type name="style" context="style file">
28<description><![CDATA[General visual style properties.]]></description>
29                <element name="code" type="string"/>
30                <element name="info" type="string"/>
31                <element name="name" type="string"/>
32                <element name="neurons" type="integer" min="0" max="1"/>
33                <element name="smooth" type="integer" min="0" max="1"/>
34                <element name="style" type="string"/>
35                <element name="tex" type="integer" min="0" max="2"/>
36                <element name="rebuild" function="true"/>
37                <element name="streload" function="true"/>
38        </type>
39        <type name="show" context="show file">
40<description><![CDATA[Show properties for the Framsticks Theater (from the *.show file).]]></description>
41                <element name="code" type="string"/>
42                <element name="dispinfo" type="integer" min="0" max="2"/>
43                <element name="expdef" type="string"/>
44                <element name="info" type="string"/>
45                <element name="mode" type="integer" min="0" max="2"/>
46                <element name="name" type="string"/>
47                <element name="regname" type="string"/>
48                <element name="show" type="string"/>
49                <element name="showlog" type="integer" min="0" max="1"/>
50                <element name="switchmode" type="integer" min="0" max="2"/>
51                <element name="switchshows" type="string">
52                        <description><![CDATA[names of the shows participating in automatic switching (comma separated). Use * as a wildcard.]]></description>
53                </element>
54                <element name="switchtime" type="integer" min="0" max="9999">
55                        <description><![CDATA[time between switching (seconds)]]></description>
56                </element>
57                <element name="userspeed" type="integer" min="0" max="5" default="3"/>
58                <element name="about" function="true"/>
59                <element name="dummy" function="true">
60                        <description><![CDATA[This is the empty item in the Theater's menu]]></description>
61                </element>
62                <element name="reload" function="true"/>
63        </type>
64        <type name="class" context="neuro file">
65                <element name="code" type="string"/>
66                <element name="description" type="string"/>
67                <element name="icon" type="string"/>
68                <element name="longname" type="string"/>
69                <element name="name" type="string"/>
70                <element name="prefinputs" type="integer"/>
71                <element name="preflocation" type="integer" min="0" max="2"/>
72                <element name="prefoutput" type="integer" min="0" max="1"/>
73                <element name="vhints" type="integer"/>
74        </type>
75        <type name="script" context="script file">
76                <element name="code" type="string"/>
77                <element name="group" type="string"/>
78                <element name="help" type="string"/>
79                <element name="name" type="string"/>
80        </type>
81        <type name="Collision" context="Global context">
82<description><![CDATA[Used in collision handlers (On___Collision). Contains the detailed information about the colliding parts (Part1,Part2 and their associated MechParts and Creatures). See the onFoodCollision() function in standard.expdef]]></description>
83                <element name="Creature1" type="Object"/>
84                <element name="Creature2" type="Object"/>
85                <element name="MechPart1" type="Object"/>
86                <element name="MechPart2" type="Object"/>
87                <element name="Part1" type="Object"/>
88                <element name="Part2" type="Object"/>
89        </type>
90        <type name="CrCollision" context="Global context">
91<description><![CDATA[Used in creature collision handlers (On___CrCollision).]]></description>
92                <element name="Creature1" type="Object"/>
93                <element name="Creature2" type="Object"/>
94        </type>
95        <type name="Creature" context="Global context">
96<description><![CDATA[The object inside the simulated world, including its physical structure, neural network and performance data. Food pieces, obstacles and other movable objects can be implemented as Creatures even though the are not "alive". See also: Population.]]></description>
97                <element name="bodysim" type="integer" min="0" max="1" default="1">
98                        <description><![CDATA[(Physical) body simulation can be disabled for individual objects which makes them immovable. Disabled objects can still participate in collisions depending on their collisions masks.
99
100Bugs: the standard collision handler does not work for disabled objects when ODE simulation is used. It means that these objects won't physically interact with other objects. The custom (scripting) handlers work as expected.]]></description>
101                </element>
102                <element name="buildproblems" type="integer"/>
103                <element name="c_velocity" type="float"/>
104                <element name="c_vertpos" type="float"/>
105                <element name="c_vertvelocity" type="float"/>
106                <element name="center_x" type="float">
107                        <description><![CDATA[Center of gravity]]></description>
108                </element>
109                <element name="center_y" type="float">
110                        <description><![CDATA[Center of gravity]]></description>
111                </element>
112                <element name="center_z" type="float">
113                        <description><![CDATA[Center of gravity]]></description>
114                </element>
115                <element name="distance" type="float"/>
116                <element name="drive" type="XYZ">
117                        <description><![CDATA[Measured in global coordinates]]></description>
118                </element>
119                <element name="energ0" type="float"/>
120                <element name="energy" type="float"/>
121                <element name="energy_b" type="float"/>
122                <element name="energy_m" type="float"/>
123                <element name="energy_p" type="float"/>
124                <element name="geno" type="Geno">
125                        <description><![CDATA[Source genotype for this creature]]></description>
126                </element>
127                <element name="genotype" type="string"/>
128                <element name="gnum" type="integer"/>
129                <element name="group" type="untyped"/>
130                <element name="idleen" type="float"/>
131                <element name="index" type="integer">
132                        <description><![CDATA[Index of this Creature in its Population.]]></description>
133                </element>
134                <element name="info" type="string">
135                        <description><![CDATA[Additional info or comments]]></description>
136                </element>
137                <element name="lifespan" type="integer"/>
138                <element name="liveModel" type="Model">
139                        <description><![CDATA[A Model object that is a copy of the current (temporary) geometry of this creature]]></description>
140                </element>
141                <element name="localDrive" type="XYZ">
142                        <description><![CDATA[Measured in local coordinates, that is, with respect to the current creature orientation
143See also: Creature.orient]]></description>
144                </element>
145                <element name="model" type="Model">
146                        <description><![CDATA[Source Model for this creature]]></description>
147                </element>
148                <element name="name" type="string"/>
149                <element name="nnenabled" type="integer" min="0" max="1"/>
150                <element name="numjoints" type="integer"/>
151                <element name="numneurons" type="integer"/>
152                <element name="numparts" type="integer"/>
153                <element name="orient" type="Orient">
154                        <description><![CDATA[By convention, the orientation of the creature is equal to the orientation of its first Part]]></description>
155                </element>
156                <element name="othermask" type="integer" min="0" max="2147483647" default="0"/>
157                <element name="perf" type="integer" min="0" max="2">
158                        <description><![CDATA[Initial value of this property is taken from Population.enableperf]]></description>
159                </element>
160                <element name="pos_x" type="float">
161                        <description><![CDATA[(pos_x,pos_y,pos_z) is the point of minimal coordinates ("bottom left corner") of the creature, including imaginary Part sizes (Part.s, usually 1.0). See also: Creature.moveAbs]]></description>
162                </element>
163                <element name="pos_y" type="float">
164                        <description><![CDATA[See Creature.pos_x]]></description>
165                </element>
166                <element name="pos_z" type="float">
167                        <description><![CDATA[See Creature.pos_x]]></description>
168                </element>
169                <element name="selfcol" type="integer" min="0" max="1">
170                        <description><![CDATA[Enable/disable detection of self-collisions (within a creature body). They can only occur when using the ODE simulation engine. If enabled, the creature will have its sticks collide during lifespan.]]></description>
171                </element>
172                <element name="selfcolstate" type="integer" min="0" max="1">
173                        <description><![CDATA[Current self-collision state]]></description>
174                </element>
175                <element name="selfmask" type="integer" min="0" max="2147483647" default="0"/>
176                <element name="signals" type="CreatureSignals"/>
177                <element name="size_x" type="float">
178                        <description><![CDATA[(size_x,size_y,size_z) are dimensions of the axis-aligned bounding box of the creature, including the imaginary part sizes (Part.s, usually 1.0). A creature consisting of a single default Part has the size of (2.0,2.0,2.0) - twice the Part.s value (like a sphere diameter is twice its radius).
179See also: Creature.moveAbs]]></description>
180                </element>
181                <element name="size_y" type="float">
182                        <description><![CDATA[See Creature.size_x]]></description>
183                </element>
184                <element name="size_z" type="float">
185                        <description><![CDATA[See Creature.size_x]]></description>
186                </element>
187                <element name="uid" type="string"/>
188                <element name="user1" type="untyped"/>
189                <element name="user2" type="untyped"/>
190                <element name="user3" type="untyped"/>
191                <element name="velocity" type="float"/>
192                <element name="vertpos" type="float"/>
193                <element name="vertvel" type="float"/>
194                <element name="currentGeometryAsF0" function="true" type="string"><arguments/></element>
195                <element name="getJoint" function="true" type="Joint">
196                        <arguments>
197                                <argument name="index" type="integer"/>
198                        </arguments>
199                </element>
200                <element name="getMechJoint" function="true" type="MechJoint">
201                        <arguments>
202                                <argument name="index" type="integer"/>
203                        </arguments>
204                </element>
205                <element name="getMechPart" function="true" type="MechPart">
206                        <arguments>
207                                <argument name="index" type="integer"/>
208                        </arguments>
209                </element>
210                <element name="getNeuro" function="true" type="Neuro">
211                        <arguments>
212                                <argument name="index" type="integer"/>
213                        </arguments>
214                </element>
215                <element name="getNeuroDef" function="true" type="NeuroDef">
216                        <arguments>
217                                <argument name="index" type="integer"/>
218                        </arguments>
219                </element>
220                <element name="getPart" function="true" type="Part">
221                        <arguments>
222                                <argument name="index" type="integer"/>
223                        </arguments>
224                </element>
225                <element name="localToWorld" function="true" type="XYZ">
226                        <description><![CDATA[Local coordinates are measured with respect to the first Part position and orientation]]></description>
227                        <arguments>
228                                <argument name="x" type="float"/>
229                                <argument name="y" type="float"/>
230                                <argument name="z" type="float"/>
231                        </arguments>
232                </element>
233                <element name="move" function="true" type="void">
234                        <description><![CDATA[Shift the creature by a given vector.]]></description>
235                        <arguments>
236                                <argument name="x" type="float"/>
237                                <argument name="y" type="float"/>
238                                <argument name="z" type="float"/>
239                        </arguments>
240                </element>
241                <element name="moveAbs" function="true" type="void">
242                        <description><![CDATA[Moves the creature so that its origin (pos_x,pos_y,pos_z) is placed at the given location. The origin is the point of minimal coordinates ("bottom left corner"), including imaginary part sizes (Part.s, usually 1.0).
243Assuming a simple single-stick creature "X" having parts at (0,0,0) and (1,0,0),
244
245origin (pos_x,pos_y,pos_z) = (-1,-1,-1)
246size (size_x,size_y,size_z) = (3,2,2)
247
248The following example places the bottom of a creature at a given location (x,y,z):
249Creature.moveAbs(x-(Creature.size_x/2),y-(Creature.size_y/2),z-1.0)
250(assuming that the part size is 1.0)]]></description>
251                        <arguments>
252                                <argument name="x" type="float"/>
253                                <argument name="y" type="float"/>
254                                <argument name="z" type="float"/>
255                        </arguments>
256                </element>
257                <element name="moveLocal" function="true" type="void">
258                        <description><![CDATA[Local coordinates are measured with respect to the first Part position and orientation]]></description>
259                        <arguments>
260                                <argument name="x" type="float"/>
261                                <argument name="y" type="float"/>
262                                <argument name="z" type="float"/>
263                        </arguments>
264                </element>
265                <element name="rotate" function="true" type="void">
266                        <description><![CDATA[Rotate the creature around X, Y and Z axes. Should only be used immediately after creating a new creature (before the first simulation step is performed for this creature), otherwise the further simulation could be disturbed.]]></description>
267                        <arguments>
268                                <argument name="x" type="float"/>
269                                <argument name="y" type="float"/>
270                                <argument name="z" type="float"/>
271                        </arguments>
272                </element>
273                <element name="rotateLocal" function="true" type="void">
274                        <description><![CDATA[Rotate the creature around (local) X, Y and Z axes. Should only be used immediately after creating a new creature (before the first simulation step is performed for this creature), otherwise further simulation can be disturbed.]]></description>
275                        <arguments>
276                                <argument name="x" type="float"/>
277                                <argument name="y" type="float"/>
278                                <argument name="z" type="float"/>
279                        </arguments>
280                </element>
281                <element name="worldToLocal" function="true" type="XYZ">
282                        <description><![CDATA[Local coordinates are measured with respect to the first Part position and orientation]]></description>
283                        <arguments>
284                                <argument name="x" type="float"/>
285                                <argument name="y" type="float"/>
286                                <argument name="z" type="float"/>
287                        </arguments>
288                </element>
289        </type>
290        <type name="CreaturesGroup" context="Global context">
291<description><![CDATA[A set of Creature objects, sharing some high level simulation properties (performance calculation, NN simulation, collision detection, event handling). The groups usually have different roles in the experiment (Creatures groups and Food group in standard.expdef)]]></description>
292                <element name="bodysim" type="integer" min="0" max="1" default="1">
293                        <description><![CDATA[Enable/disable physical body simulation. This is the initial value of Creature.bodysim for all objects created in this group. For details, see the documentation of Creature.bodysim.]]></description>
294                </element>
295                <element name="colmask" type="integer" min="0" max="65535" default="0">
296                        <description><![CDATA[DEPRECATED. You should use selfmask and othermask (these masks are also much easier to understand than the old colmask field).]]></description>
297                </element>
298                <element name="death" type="integer" min="0" max="1" default="1">
299                        <description><![CDATA[Do creatures die when no energy?]]></description>
300                </element>
301                <element name="em_dyn" type="float" min="0" max="1" default="0">
302                        <description><![CDATA[Energy requirements for a muscle
303moving a stick]]></description>
304                </element>
305                <element name="em_stat" type="float" min="0" max="1" default="0">
306                        <description><![CDATA[Energy requirements for a muscle
307resisting an external force]]></description>
308                </element>
309                <element name="en_assim" type="float" min="0" max="1" default="0">
310                        <description><![CDATA[Maximal energy gain produced by a vertical specialized stick.
311Horizontal specialized sticks get half of this value.]]></description>
312                </element>
313                <element name="enableperf" type="integer" min="0" max="2" default="1">
314                        <description><![CDATA[Stabilization means no significant movement during a specified period of time.]]></description>
315                </element>
316                <element name="energy" type="integer" min="0" max="1" default="1">
317                        <description><![CDATA[If turned off, creature's energy will be constant]]></description>
318                </element>
319                <element name="index" type="integer"/>
320                <element name="killnostable" type="integer" min="0" max="10000000" default="1000000">
321                        <description><![CDATA[Creatures that fail to stabilize after the specified waiting period (e.g. because they are continuously rolling) will be killed. 0 disables this feature.]]></description>
322                </element>
323                <element name="name" type="string"/>
324                <element name="nnsim" type="integer" min="0" max="2" default="1">
325                        <description><![CDATA[Stabilization means no significant movement during a specified period of time.]]></description>
326                </element>
327                <element name="othermask" type="integer" min="0" max="2147483647" default="0">
328                        <description><![CDATA[See selfmask.]]></description>
329                </element>
330                <element name="perfperiod" type="integer" min="0" max="1000000" default="100">
331                        <description><![CDATA[Defines how often onUpdate() events are called. Also used to compute partial performance of creatures (distance, speed, etc.) and to determine stabilization.]]></description>
332                </element>
333                <element name="selfcol" type="integer" min="0" max="1" default="0">
334                        <description><![CDATA[Detect collisions within creature bodies (only applicable for the ODE simulation engine). This is the initial value of Creature.selfcol for all objects created in this group. If enabled, creatures with self-colliding genotypes are not born, and others will have their sticks collide during lifespan.]]></description>
335                </element>
336                <element name="selfmask" type="integer" min="0" max="2147483647" default="0">
337                        <description><![CDATA[Collisions between objects can be handled in two ways:
338 - standard 'mechanical' collision (simple 'rebound' effect)
339 - special script handler (On[GROUPNAME]Collision function)
340
341In the script handler function, use the Collision object to access the two colliding parts of two creatures.
342The first part in the Collision object (i.e. Collision.Creature1) always concerns the creature that belongs to [GROUPNAME].
343The handler is called once for each creature that collides with the creature from [GROUPNAME].
344
345Collision masks determine which one will be used (none and both are also possible). On each collision, selfmask and othermask of the colliding objects are logically ANDed. 16 lower bits (0xffff) enable the standard handler. 16 higher bits (0xffff0000) enable the custom handler.
346Examples:
347
3481.With one group, all possible combinations of the collision handlers are as follows:
349  - ignore collisions (e.g. selfmask=othermask=0)
350  - use standard handling (e.g. selfmask=othermask=1)
351  - use custom handling (e.g. selfmask=othermask=0x10000)
352  - use standard and custom handling (e.g. selfmask=othermask=0x10001)
353
3542.Two groups yield more interesting cases. Let us consider the 'standard.expdef' setting:
355  Creatures: selfmask=0x10001, othermask=0x20001
356  Food colmask = selfmask=0x20002, othermask=0x10002
357There are three possible scenarios:
358- creature and creature: collision value = 0x10001 & 0x20001 = 1 -> Standard handling will be used (1 is one of the lower 16 bits)
359- food and food: collision value = 0x20002 & 0x10002 = 2 -> As above.
360- creature and food: collision value = (0x10001 & 0x10002) or (0x20002 & 0x20001) = 0x10000 or 0x20000 -> Custom handling will be used (higher 16 bits).
361]]></description>
362                </element>
363                <element name="size" type="integer"/>
364                <element name="stabilperiod" type="integer" min="0" max="1000000" default="100">
365                        <description><![CDATA["Performance sampling period" for the stabilization phase.]]></description>
366                </element>
367                <element name="stabledist" type="float" min="0" max="1" default="0.01">
368                        <description><![CDATA[A creature is considered stabilized when its center of gravity stays within the specified distance after the "Sampling period while waiting" has elapsed.]]></description>
369                </element>
370                <element name="createFromGeno" function="true" type="Creature">
371                        <description><![CDATA[uses the supplied Geno object]]></description>
372                        <arguments>
373                                <argument type="Geno"/>
374                        </arguments>
375                </element>
376                <element name="createFromGenotype" function="true" type="Creature">
377                        <description><![CDATA[uses the selected Genotype object]]></description>
378<arguments/></element>
379                <element name="createFromString" function="true" type="Creature">
380                        <description><![CDATA[uses the supplied string argument]]></description>
381                        <arguments>
382                                <argument name="genotype" type="string"/>
383                        </arguments>
384                </element>
385                <element name="delete" function="true" type="void">
386                        <description><![CDATA[delete creature]]></description>
387                        <arguments>
388                                <argument name="creature index" type="integer"/>
389                        </arguments>
390                </element>
391                <element name="findCreatureAt" function="true" type="Creature">
392                        <arguments>
393                                <argument name="point" type="Vector"/>
394                                <argument name="vector" type="Vector"/>
395                        </arguments>
396                </element>
397                <element name="findUID" function="true" type="integer">
398                        <arguments>
399                                <argument name="uid" type="string"/>
400                        </arguments>
401                </element>
402                <element name="get" function="true" type="Creature">
403                        <arguments>
404                                <argument name="index" type="integer"/>
405                        </arguments>
406                </element>
407                <element name="kill" function="true" type="void">
408                        <description><![CDATA[kill creature]]></description>
409                        <arguments>
410                                <argument name="creature index" type="integer"/>
411                        </arguments>
412                </element>
413                <element name="senseCreaturesProperty" function="true" type="float">
414                        <description><![CDATA[arguments:
415 - x,y,z (sensor position)
416 - property (name, name[index] or Class:id). name[index] can be used for Vector objects inside the user fields, eg "user2[10]"
417 - exclude (creature object)
418works like a smell sensor for a given property (for all creatures in this group except "exclude").
419The following function reproduces the "classic" framsticks "S" sensor:
420function smellReceptorValue(x,y,z,exclude)
421{
422var i,s=0; for(i=0;i<Populations.size;i++)
423        s+=Populations[0].senseCreaturesProperty(x,y,z,"energy",exclude);
424return s;
425}]]></description>
426                        <arguments>
427                                <argument name="x" type="float"/>
428                                <argument name="y" type="float"/>
429                                <argument name="z" type="float"/>
430                                <argument name="propertyname" type="string"/>
431                                <argument name="exclude" type="Creature"/>
432                        </arguments>
433                </element>
434        </type>
435        <type name="CreatureSignals" context="Global context">
436<description><![CDATA[Signal sources associated with the creature. See also: Signal, WorldSignals, NeuroSignals]]></description>
437                <element name="size" type="integer">
438                        <description><![CDATA[Number of signals in this set]]></description>
439                </element>
440                <element name="add" function="true" type="Signal">
441                        <description><![CDATA[Create a new signal]]></description>
442                        <arguments>
443                                <argument name="channel" type="string"/>
444                        </arguments>
445                </element>
446                <element name="addProperty" function="true" type="Signal">
447                        <description><![CDATA[Create a signal that automatically reflects one of the creature's properties (i.e. its power is equal to the property value).
448Example:
449Creature.signals.addProperty("energy","energy"); //then, Neuro.signals.receive("energy") in custom neuron would work similarly to the built-in smell sensor]]></description>
450                        <arguments>
451                                <argument name="channel" type="string"/>
452                                <argument name="property" type="untyped"/>
453                        </arguments>
454                </element>
455                <element name="clear" function="true" type="void">
456                        <description><![CDATA[Delete all signals]]></description>
457<arguments/></element>
458                <element name="get" function="true" type="Signal">
459                        <description><![CDATA[Access individual signals (index=0 .. size-1)]]></description>
460                        <arguments>
461                                <argument name="index" type="integer"/>
462                        </arguments>
463                </element>
464                <element name="receive" function="true" type="float">
465                        <description><![CDATA[Receive the aggregated signal power in a given channel.]]></description>
466                        <arguments>
467                                <argument name="channel" type="string"/>
468                        </arguments>
469                </element>
470                <element name="receiveFilter" function="true" type="float">
471                        <description><![CDATA[Receive the aggregated signal power in a given channel.
472
473Additional filtering options:
474- Max distance only receives the neighbor signals (based on their physical location)
475- Flavor filtering: only signals having the flavor close to the specified one will be received. The filter value is the maximum allowed difference.]]></description>
476                        <arguments>
477                                <argument name="channel" type="string"/>
478                                <argument name="max distance" type="float"/>
479                                <argument name="flavor" type="float"/>
480                                <argument name="filter" type="float"/>
481                        </arguments>
482                </element>
483                <element name="receiveSet" function="true" type="Vector">
484                        <description><![CDATA[Get all signals in the specified range. Returns a readonly vector object containing Signal objects (individual signals can be accessed as result[0], .., result[result.size-1]).]]></description>
485                        <arguments>
486                                <argument name="channel" type="string"/>
487                                <argument name="max distance" type="float"/>
488                        </arguments>
489                </element>
490                <element name="receiveSingle" function="true" type="Signal">
491                        <description><![CDATA[Find the signal source having the highest signal power (including the distance)]]></description>
492                        <arguments>
493                                <argument name="channel" type="string"/>
494                                <argument name="max distance" type="float"/>
495                        </arguments>
496                </element>
497        </type>
498        <type name="Dictionary" context="Global context">
499<description><![CDATA[Dictionary associates stored values with string keys ("key" is the first argument in get/set/remove functions). Integer "key" can be used to enumerate all elements.
500Example: var d=Dictionary.new(); d.set("name","John"); d.set("age",44);
501var i,element; for(i=0;i<d.size;i++) element=d.get(i);]]></description>
502                <element name="size" type="integer"/>
503                <element name="toString" type="string"/>
504                <element name="clear" function="true" type="void"><arguments/></element>
505                <element name="find" function="true" type="string">
506                        <description><![CDATA[returns the element key or null if not found]]></description>
507                        <arguments>
508                                <argument name="value" type="untyped"/>
509                        </arguments>
510                </element>
511                <element name="get" function="true" type="untyped">
512                        <arguments>
513                                <argument name="key" type="untyped"/>
514                        </arguments>
515                </element>
516                <element name="new" function="true" type="Dictionary"><arguments/></element>
517                <element name="remove" function="true" type="void">
518                        <arguments>
519                                <argument name="key" type="untyped"/>
520                        </arguments>
521                </element>
522                <element name="set" function="true" type="void">
523                        <arguments>
524                                <argument name="key" type="untyped"/>
525                                <argument name="value" type="untyped"/>
526                        </arguments>
527                </element>
528        </type>
529        <type name="File" context="Global context">
530<description><![CDATA[Provides read/write access to the filesystem. Used in the experiment definition to save the experiment state (onExpSave). Other (general purpose) use of this class is rather limited. Files are created in the "scripts_output" subdirectory of the directory where the Framsticks executable is located.]]></description>
531                <element name="EOF" type="integer" min="0" max="1"/>
532                <element name="info" type="string"/>
533                <element name="name" type="string"/>
534                <element name="path" type="string"/>
535                <element name="pathseparator" type="string"/>
536                <element name="append" function="true" type="File ">
537                        <arguments>
538                                <argument name="filename" type="string"/>
539                                <argument name="description" type="string"/>
540                        </arguments>
541                </element>
542                <element name="appendDirect" function="true" type="File ">
543                        <arguments>
544                                <argument name="filename" type="string"/>
545                                <argument name="description" type="string"/>
546                        </arguments>
547                </element>
548                <element name="close" function="true" type="string">
549                        <description><![CDATA[returns file contents if it has been buffered]]></description>
550<arguments/></element>
551                <element name="create" function="true" type="File">
552                        <arguments>
553                                <argument name="filename" type="string"/>
554                                <argument name="description" type="string"/>
555                        </arguments>
556                </element>
557                <element name="createDirect" function="true" type="File">
558                        <arguments>
559                                <argument name="filename" type="string"/>
560                                <argument name="description" type="string"/>
561                        </arguments>
562                </element>
563                <element name="exists" function="true" type="integer" min="0" max="1">
564                        <description><![CDATA[Sample:
565File.exists("default.sim") -> return 0 or 1]]></description>
566<arguments/></element>
567                <element name="flush" function="true" type="void">
568                        <description><![CDATA[useful for unbuffered disk files only (openDirect, appendDirect)]]></description>
569<arguments/></element>
570                <element name="new" function="true" type="File "><arguments/></element>
571                <element name="newFromString" function="true" type="File ">
572                        <arguments>
573                                <argument name="text" type="string"/>
574                        </arguments>
575                </element>
576                <element name="open" function="true" type="File ">
577                        <arguments>
578                                <argument name="filename" type="string"/>
579                        </arguments>
580                </element>
581                <element name="readLine" function="true" type="string"><arguments/></element>
582                <element name="readObject" function="true" type="void">
583                        <arguments>
584                                <argument type="Object"/>
585                        </arguments>
586                </element>
587                <element name="readUntilEOF" function="true" type="string"><arguments/></element>
588                <element name="system" function="true" type="integer">
589                        <description><![CDATA[Invokes a system command, returns its return code (0 usually means it was completed successfully)
590
591Example:
592File.system("wget",["-O","/tmp/filename","http://example.com/file"]);]]></description>
593                        <arguments>
594                                <argument name="executable" type="string"/>
595                                <argument name="string arguments" type="Vector"/>
596                        </arguments>
597                </element>
598                <element name="writeComment" function="true" type="void">
599                        <arguments>
600                                <argument name="anything" type="string"/>
601                        </arguments>
602                </element>
603                <element name="writeNameObject" function="true" type="void">
604                        <arguments>
605                                <argument name="name" type="string"/>
606                                <argument type="Object"/>
607                        </arguments>
608                </element>
609                <element name="writeObject" function="true" type="void">
610                        <arguments>
611                                <argument type="Object"/>
612                        </arguments>
613                </element>
614                <element name="writeObjectBegin" function="true" type="void">
615                        <arguments>
616                                <argument type="Object"/>
617                        </arguments>
618                </element>
619                <element name="writeObjectEnd" function="true" type="void"><arguments/></element>
620                <element name="writeObjectField" function="true" type="void">
621                        <arguments>
622                                <argument type="Object"/>
623                                <argument name="field index or name" type="untyped"/>
624                        </arguments>
625                </element>
626                <element name="writeObjectFieldForce" function="true" type="void">
627                        <arguments>
628                                <argument type="Object"/>
629                                <argument name="field index or name" type="untyped"/>
630                        </arguments>
631                </element>
632                <element name="writeObjectFields" function="true" type="void">
633                        <arguments>
634                                <argument type="Object"/>
635                        </arguments>
636                </element>
637                <element name="writeObjectFieldsForce" function="true" type="void">
638                        <arguments>
639                                <argument type="Object"/>
640                        </arguments>
641                </element>
642                <element name="writeString" function="true" type="void">
643                        <arguments>
644                                <argument name="anything" type="untyped"/>
645                        </arguments>
646                </element>
647        </type>
648        <type name="GenePool" context="Global context">
649<description><![CDATA[The static GenePool object refers to the "selected group" as described in GenePools]]></description>
650                <element name="fitfun" type="integer" min="0" max="1" default="0">
651                        <description><![CDATA[Enable fitness scaling]]></description>
652                </element>
653                <element name="fitm" type="float" min="0" max="10" default="2">
654                        <description><![CDATA[Lower threshold: how many standard deviations below average?
655(avg - n * stddev) - used for fitness shifting]]></description>
656                </element>
657                <element name="fitma" type="float" min="1" max="10" default="2">
658                        <description><![CDATA[The best genotype is as many times
659better than the average one]]></description>
660                </element>
661                <element name="fitness" type="string">
662                        <description><![CDATA[(intended for advanced users)]]></description>
663                </element>
664                <element name="index" type="integer"/>
665                <element name="name" type="string"/>
666                <element name="size" type="integer">
667                        <description><![CDATA[In standard.expdef, this is equivalent to the number of unique genotypes. Standard experiment definition uses the Genotype.instances field to indicate that some genotypes exist in multiple instances despite having only one item in the group. Other experiment definitions may create multiple copies of the same genotype.]]></description>
668                </element>
669                <element name="totalpop" type="integer">
670                        <description><![CDATA[Takes into account the Genotype.instances field (which may give the total number of instances depending on the experiment definition)]]></description>
671                </element>
672                <element name="addGeno" function="true" type="Genotype">
673                        <description><![CDATA[create new Genotype from the supplied Geno object.
674returns the created Genotype.]]></description>
675                        <arguments>
676                                <argument type="Geno"/>
677                        </arguments>
678                </element>
679                <element name="delete" function="true" type="void">
680                        <description><![CDATA[delete genotype]]></description>
681                        <arguments>
682                                <argument name="genotype index" type="integer"/>
683                        </arguments>
684                </element>
685                <element name="findGeno" function="true" type="integer">
686                        <description><![CDATA[find Genotype matching the supplied Geno object.
687returns genotype index or -1 if not found]]></description>
688                        <arguments>
689                                <argument type="Geno"/>
690                        </arguments>
691                </element>
692                <element name="findUID" function="true" type="integer">
693                        <arguments>
694                                <argument name="uid" type="string"/>
695                        </arguments>
696                </element>
697                <element name="get" function="true" type="Genotype">
698                        <arguments>
699                                <argument name="index" type="integer"/>
700                        </arguments>
701                </element>
702        </type>
703        <type name="GenePools" context="Global context">
704<description><![CDATA[Manages all genotypes in the experiment, organized in one or more groups. Some functions refer to the "selected genotype" i.e. the genotype number "GenePools.genotype" in the pool number "GenePools.group". For example to access the first genoype in the first group you could do:
705GenePools.group=0; GenePools.genotype=0; var name=Genotype.name;
706However, the preferred way doesn't refer to the static Genotype object:
707 var name=GenePools[0][0].name;
708
709Apart from the Genotypes in the group, there is also one temporary Genotype object used by genetic operators and some functions from GenePools. Genotype points to that object when "GenePools.genotype"=-1. The following code accesses that object before adding it to the genotype group:
710GenePools.newGenotype("X");
711 //makes the temporary object from the "X" genotype, GenePools.genotype is now -1
712GenePools.mutateSelected();
713 //the temporary object is mutated
714Genotype.info="my favorite genotype";
715 //modify the temporary object
716GenePools.copySelected(0);
717 //copy the current, i.e. temporary genotype to the genotype group #0]]></description>
718                <element name="genotype" type="integer">
719                        <description><![CDATA[index of the currently selected genotype or -1 if no genotype is selected]]></description>
720                </element>
721                <element name="group" type="integer">
722                        <description><![CDATA[index of the currently selected group (gene pool)]]></description>
723                </element>
724                <element name="size" type="integer"/>
725                <element name="addGroup" function="true" type="void">
726                        <description><![CDATA[add genotype group]]></description>
727                        <arguments>
728                                <argument name="name" type="string"/>
729                        </arguments>
730                </element>
731                <element name="addPerformanceFromCreature" function="true" type="void">
732                        <description><![CDATA[Updates the current Genotype's performance values merging them with the current Creture's performance. It assumes the Genotype.instances has a reasonable value and performs the proper weighting. Use your own function instead if these conditions are not met in your experiment.]]></description>
733<arguments/></element>
734                <element name="clear" function="true" type="void">
735                        <description><![CDATA[remove all groups except the first one]]></description>
736<arguments/></element>
737                <element name="clearGroup" function="true" type="void">
738                        <arguments>
739                                <argument name="index" type="integer"/>
740                        </arguments>
741                </element>
742                <element name="copySelected" function="true" type="void">
743                        <description><![CDATA[copy selected genotype to another group]]></description>
744                        <arguments>
745                                <argument name="groupindex" type="integer"/>
746                        </arguments>
747                </element>
748                <element name="crossoverSelected" function="true" type="void">
749                        <description><![CDATA[Crossover selected genotype with another one (from the genotype group). The resulting genotype is stored in the static Genotype object detached from the genotype group. After calling this function GenePools.genotype is -1 indicating that no genotype from the group is selected.]]></description>
750                        <arguments>
751                                <argument name="other index" type="integer"/>
752                        </arguments>
753                </element>
754                <element name="deleteGroup" function="true" type="void">
755                        <description><![CDATA[remove genotype group]]></description>
756                        <arguments>
757                                <argument name="index" type="integer"/>
758                        </arguments>
759                </element>
760                <element name="deleteOne" function="true" type="void">
761                        <description><![CDATA[delete one individual from the gene pool = decrease 'instances' and delete the genotype if the 'instances' goes to 0]]></description>
762                        <arguments>
763                                <argument name="genotype index" type="integer"/>
764                        </arguments>
765                </element>
766                <element name="deleteSelected" function="true" type="void">
767                        <description><![CDATA[delete selected genotype from the gene pool (uses the selected genotype object)]]></description>
768<arguments/></element>
769                <element name="findGenotype" function="true" type="integer">
770                        <description><![CDATA[find a genotype matching the current genotype. It only makes sense when the current genotype is a result of the genetic operator.]]></description>
771<arguments/></element>
772                <element name="findGenotypeForCreature" function="true" type="integer">
773                        <description><![CDATA[find a genotype matching the selected creature]]></description>
774<arguments/></element>
775                <element name="get" function="true" type="GenePool">
776                        <arguments>
777                                <argument name="index" type="integer"/>
778                        </arguments>
779                </element>
780                <element name="getFromCreature" function="true" type="void">
781                        <description><![CDATA[Copy a genotype from the selected creature. The resulting genotype is stored in the static Genotype object detached from the genotype group.]]></description>
782<arguments/></element>
783                <element name="getFromCreatureObject" function="true" type="void">
784                        <description><![CDATA[Copy a genotype from the creature object passed in argument. The resulting genotype is stored in the static Genotype object detached from the genotype group.]]></description>
785                        <arguments>
786                                <argument type="Creature"/>
787                        </arguments>
788                </element>
789                <element name="likeThisRoulette" function="true" type="integer">
790                        <description><![CDATA[get random genotype similar to the selected one, fitness proportional]]></description>
791                        <arguments>
792                                <argument name="minimum similarity" type="float"/>
793                        </arguments>
794                </element>
795                <element name="mutateSelected" function="true" type="void">
796                        <description><![CDATA[Mutate selected genotype. The resulting genotype is stored in the static Genotype object detached from the genotype group. After calling this function GenePools.genotype is -1 indicating that no genotype from the group is selected.]]></description>
797<arguments/></element>
798                <element name="newGenotype" function="true" type="void">
799                        <description><![CDATA[Make the new genotype from the supplied string and select the genotype. The resulting genotype is stored in the static Genotype object detached from the genotype group. After calling this function GenePools.genotype is -1 indicating that no genotype from the group is selected. (call "copySelected" if you want to add this gentype to the genotype group)]]></description>
800                        <arguments>
801                                <argument name="genotype" type="string"/>
802                        </arguments>
803                </element>
804                <element name="random" function="true" type="integer">
805                        <description><![CDATA[get random genotype]]></description>
806<arguments/></element>
807                <element name="randomLikeThis" function="true" type="integer">
808                        <description><![CDATA[get random genotype similar to the selected one]]></description>
809                        <arguments>
810                                <argument name="minimum similarity" type="float"/>
811                        </arguments>
812                </element>
813                <element name="revroulette" function="true" type="integer">
814                        <description><![CDATA[get reverse fitness proportional genotype]]></description>
815<arguments/></element>
816                <element name="roulette" function="true" type="integer">
817                        <description><![CDATA[get fitness proportional genotype]]></description>
818<arguments/></element>
819                <element name="tournament" function="true" type="integer">
820                        <description><![CDATA[get tournament winner genotype]]></description>
821                        <arguments>
822                                <argument name="genotypes in tournament" type="integer"/>
823                        </arguments>
824                </element>
825                <element name="worst" function="true" type="integer">
826                        <description><![CDATA[get worst genotype]]></description>
827<arguments/></element>
828        </type>
829        <type name="GenMan" context="Global context">
830<description><![CDATA[Manages various genetic operations, using appropriate operators for the argument genotype format.]]></description>
831                <element name="changedProperty" type="integer"/>
832                <element name="changedPropertyId" type="string"/>
833                <element name="f0_c_del" type="float" min="0" max="100" default="5">
834                        <description><![CDATA[]]></description>
835                </element>
836                <element name="f0_c_new" type="float" min="0" max="100" default="5">
837                        <description><![CDATA[]]></description>
838                </element>
839                <element name="f0_c_wei" type="float" min="0" max="100" default="10">
840                        <description><![CDATA[]]></description>
841                </element>
842                <element name="f0_j_del" type="float" min="0" max="100" default="5">
843                        <description><![CDATA[]]></description>
844                </element>
845                <element name="f0_j_new" type="float" min="0" max="100" default="5">
846                        <description><![CDATA[]]></description>
847                </element>
848                <element name="f0_j_rsf" type="float" min="0" max="100" default="10">
849                        <description><![CDATA[]]></description>
850                </element>
851                <element name="f0_j_stf" type="float" min="0" max="100" default="10">
852                        <description><![CDATA[]]></description>
853                </element>
854                <element name="f0_j_stm" type="float" min="0" max="100" default="10">
855                        <description><![CDATA[]]></description>
856                </element>
857                <element name="f0_n_del" type="float" min="0" max="100" default="5">
858                        <description><![CDATA[]]></description>
859                </element>
860                <element name="f0_n_new" type="float" min="0" max="100" default="5">
861                        <description><![CDATA[]]></description>
862                </element>
863                <element name="f0_n_prp" type="float" min="0" max="100" default="10">
864                        <description><![CDATA[]]></description>
865                </element>
866                <element name="f0_nodel_tag" type="integer" min="0" max="1" default="1">
867                        <description><![CDATA[You can tag elements using their 'i' field and the i="mi=d" tag.
868Mutations will not delete such elements.
869The i="mi=dm" combination is allowed.]]></description>
870                </element>
871                <element name="f0_nomod_tag" type="integer" min="0" max="1" default="1">
872                        <description><![CDATA[You can tag elements using their 'i' field and the i="mi=m" tag.
873Mutations will not modify properties of such elements.
874The i="mi=md" combination is allowed.]]></description>
875                </element>
876                <element name="f0_p_asm" type="float" min="0" max="100" default="10">
877                        <description><![CDATA[]]></description>
878                </element>
879                <element name="f0_p_del" type="float" min="0" max="100" default="5">
880                        <description><![CDATA[]]></description>
881                </element>
882                <element name="f0_p_frc" type="float" min="0" max="100" default="10">
883                        <description><![CDATA[]]></description>
884                </element>
885                <element name="f0_p_ing" type="float" min="0" max="100" default="10">
886                        <description><![CDATA[]]></description>
887                </element>
888                <element name="f0_p_mas" type="float" min="0" max="100" default="10">
889                        <description><![CDATA[]]></description>
890                </element>
891                <element name="f0_p_new" type="float" min="0" max="100" default="5">
892                        <description><![CDATA[]]></description>
893                </element>
894                <element name="f0_p_pos" type="float" min="0" max="100" default="10">
895                        <description><![CDATA[]]></description>
896                </element>
897                <element name="f0_p_swp" type="float" min="0" max="100" default="10">
898                        <description><![CDATA[]]></description>
899                </element>
900                <element name="f0Fuzzy_maxRules" type="integer" min="0" max="999">
901                        <description><![CDATA[Maximum number of fuzzy rules]]></description>
902                </element>
903                <element name="f0Fuzzy_maxSets" type="integer" min="0" max="999">
904                        <description><![CDATA[Maximum number of fuzzy sets]]></description>
905                </element>
906                <element name="f0Fuzzy_prob0" type="float" min="0" max="1">
907                        <description><![CDATA[Probability of adding new fuzzy set with simple rule, which uses this set (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
908                </element>
909                <element name="f0Fuzzy_prob1" type="float" min="0" max="1">
910                        <description><![CDATA[Probability of removing fuzzy set (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
911                </element>
912                <element name="f0Fuzzy_prob2" type="float" min="0" max="1">
913                        <description><![CDATA[Probability of adding new rule (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
914                </element>
915                <element name="f0Fuzzy_prob3" type="float" min="0" max="1">
916                        <description><![CDATA[Probability of removing rule (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
917                </element>
918                <element name="f0Fuzzy_prob4" type="float" min="0" max="1">
919                        <description><![CDATA[Probability of adding new input or output to exisitng rule (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
920                </element>
921                <element name="f0Fuzzy_prob5" type="float" min="0" max="1">
922                        <description><![CDATA[Probability of removing input or output from exisitng rule (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
923                </element>
924                <element name="f1_mut_exmod" type="string">
925                        <description><![CDATA[Modifiers that will not be added nor deleted during mutation
926(all: RrLlAaCcFfMmSsIiQqWwEe)]]></description>
927                </element>
928                <element name="f1_nmConn" type="float" min="0" max="100" default="0.1">
929                        <description><![CDATA[]]></description>
930                </element>
931                <element name="f1_nmNeu" type="float" min="0" max="100" default="0.05">
932                        <description><![CDATA[Adds a (connected) neuron or removes a neuron]]></description>
933                </element>
934                <element name="f1_nmProp" type="float" min="0" max="100" default="0.1">
935                        <description><![CDATA[]]></description>
936                </element>
937                <element name="f1_nmVal" type="float" min="0" max="100" default="0.05"/>
938                <element name="f1_nmWei" type="float" min="0" max="100" default="1"/>
939                <element name="f1_smComma" type="float" min="0" max="100" default="0.02"/>
940                <element name="f1_smJunct" type="float" min="0" max="100" default="0.02"/>
941                <element name="f1_smModif" type="float" min="0" max="100" default="0.1">
942                        <description><![CDATA[Modifiers: RrLlAaCcFfMmSsIiQqWwEe]]></description>
943                </element>
944                <element name="f1_smX" type="float" min="0" max="100" default="0.05"/>
945                <element name="f1_xo_propor" type="integer" min="0" max="1" default="1">
946                        <description><![CDATA[Cross over (exchange) corresponding segments of the two parent genotypes?
947
948f1 uses a two-point crossing over.
949If this option is turned on, cut points will be selected proportionally to neural genes.
950Thus, if both parents have the same number of neurons, then this will be preserved in their children.]]></description>
951                </element>
952                <element name="f2_mutAddOper" type="float" min="0" max="1" default="0.4">
953                        <description><![CDATA[]]></description>
954                </element>
955                <element name="f2_mutConnElem" type="float" min="0" max="1" default="0.33">
956                        <description><![CDATA[]]></description>
957                </element>
958                <element name="f2_mutDelOper" type="float" min="0" max="1" default="0.1">
959                        <description><![CDATA[]]></description>
960                </element>
961                <element name="f2_mutHandleOper" type="float" min="0" max="1" default="0.3">
962                        <description><![CDATA[]]></description>
963                </element>
964                <element name="f2_mutJointElem" type="float" min="0" max="1" default="0.33">
965                        <description><![CDATA[]]></description>
966                </element>
967                <element name="f2_mutNeuroElem" type="float" min="0" max="1" default="0.33">
968                        <description><![CDATA[]]></description>
969                </element>
970                <element name="f2_mutPropOper" type="float" min="0" max="1" default="0.2">
971                        <description><![CDATA[]]></description>
972                </element>
973                <element name="f3_mutDelIns" type="float" min="0" max="1" default="0.1">
974                        <description><![CDATA[]]></description>
975                </element>
976                <element name="f3_mutDelInsLength" type="integer" min="1" max="100" default="5">
977                        <description><![CDATA[]]></description>
978                </element>
979                <element name="f3_mutDelInsPerChar" type="float" min="0" max="1" default="0.05">
980                        <description><![CDATA[]]></description>
981                </element>
982                <element name="f3_mutDuplication" type="float" min="0" max="1" default="0.05">
983                        <description><![CDATA[]]></description>
984                </element>
985                <element name="f3_mutSubstitution" type="float" min="0" max="1" default="0.6">
986                        <description><![CDATA[]]></description>
987                </element>
988                <element name="f3_mutSubstPerChar" type="float" min="0" max="1" default="0.1">
989                        <description><![CDATA[]]></description>
990                </element>
991                <element name="f3_mutTranslocation" type="float" min="0" max="1" default="0.15">
992                        <description><![CDATA[]]></description>
993                </element>
994                <element name="f3_xovCrossingOver" type="float" min="0" max="1" default="0.2">
995                        <description><![CDATA[]]></description>
996                </element>
997                <element name="f3_xovGeneTransfer" type="float" min="0" max="1" default="0.8">
998                        <description><![CDATA[]]></description>
999                </element>
1000                <element name="f4_mut_add" type="float" min="0" max="100" default="50">
1001                        <description><![CDATA[mutation: probability of adding a node]]></description>
1002                </element>
1003                <element name="f4_mut_add_conn" type="float" min="0" max="100" default="15">
1004                        <description><![CDATA[add node mutation: probability of adding a neural connection]]></description>
1005                </element>
1006                <element name="f4_mut_add_div" type="float" min="0" max="100" default="20">
1007                        <description><![CDATA[add node mutation: probability of adding a division]]></description>
1008                </element>
1009                <element name="f4_mut_add_neupar" type="float" min="0" max="100" default="5">
1010                        <description><![CDATA[add node mutation: probability of adding a neuron property/modifier]]></description>
1011                </element>
1012                <element name="f4_mut_add_rep" type="float" min="0" max="100" default="10">
1013                        <description><![CDATA[add node mutation: probability of adding a repetition]]></description>
1014                </element>
1015                <element name="f4_mut_add_simp" type="float" min="0" max="100" default="50">
1016                        <description><![CDATA[add node mutation: probability of adding a random, simple gene]]></description>
1017                </element>
1018                <element name="f4_mut_del" type="float" min="0" max="100" default="20">
1019                        <description><![CDATA[mutation: probability of deleting a node]]></description>
1020                </element>
1021                <element name="f4_mut_mod" type="float" min="0" max="100" default="30">
1022                        <description><![CDATA[mutation: probability of changing a node]]></description>
1023                </element>
1024                <element name="gen_extmutinfo" type="integer" min="0" max="2" default="0">
1025                        <description><![CDATA[If active, information about employed mutation method will be stored in the 'info' field of each mutated genotype.]]></description>
1026                </element>
1027                <element name="gen_hilite" type="integer" min="0" max="1" default="1">
1028                        <description><![CDATA[Use colors for genes?
1029(slows down viewing/editing of huge genotypes)]]></description>
1030                </element>
1031                <element name="gen_hist" type="integer" min="0" max="1" default="0">
1032                        <description><![CDATA[Required for phylogenetic analysis]]></description>
1033                </element>
1034                <element name="genoper_f0" type="integer" min="0" max="1">
1035                        <description><![CDATA[]]></description>
1036                </element>
1037                <element name="genoper_f1" type="integer" min="0" max="0">
1038                        <description><![CDATA[]]></description>
1039                </element>
1040                <element name="genoper_f2" type="integer" min="0" max="0">
1041                        <description><![CDATA[]]></description>
1042                </element>
1043                <element name="genoper_f3" type="integer" min="0" max="0">
1044                        <description><![CDATA[]]></description>
1045                </element>
1046                <element name="genoper_f4" type="integer" min="0" max="0">
1047                        <description><![CDATA[]]></description>
1048                </element>
1049                <element name="neuadd_N" type="integer" min="0" max="1">
1050                        <description><![CDATA[Standard neuron
1051
1052Characteristics:
1053   supports any number of inputs
1054   provides output value
1055   does not require location in body
1056
1057
1058Properties:
1059   Inertia (in) float 0..1
1060   Force (fo) float 0..999
1061   Sigmoid (si) float -99999..99999
1062   State (s) float -1..1]]></description>
1063                </element>
1064                <element name="neuadd_Nu" type="integer" min="0" max="1">
1065                        <description><![CDATA[Works like standard neuron (N) but the output value is scaled to 0...+1 instead of -1...+1.
1066Having 0 as one of the saturation states should help in "gate circuits", where input signal is passed through or blocked depending on the other singal.
1067
1068Characteristics:
1069   supports any number of inputs
1070   provides output value
1071   does not require location in body
1072
1073
1074Properties:
1075   Inertia (in) float 0..1
1076   Force (fo) float 0..999
1077   Sigmoid (si) float -99999..99999
1078   State (s) float -1..1]]></description>
1079                </element>
1080                <element name="neuadd_G" type="integer" min="0" max="1">
1081                        <description><![CDATA[Equilibrium sensor.
10820=the stick is horizontal
1083+1/-1=the stick is vertical
1084
1085Characteristics:
1086   does not use inputs
1087   provides output value
1088   should be located on a Joint
1089]]></description>
1090                </element>
1091                <element name="neuadd_T" type="integer" min="0" max="1">
1092                        <description><![CDATA[Touch sensor.
1093-1=no contact
10940=just touching
1095>0=pressing, value depends on the force applied
1096
1097Characteristics:
1098   does not use inputs
1099   provides output value
1100   should be located on a Part
1101
1102
1103Properties:
1104   Range (r) float 0..1]]></description>
1105                </element>
1106                <element name="neuadd_S" type="integer" min="0" max="1">
1107                        <description><![CDATA[Smell sensor. Aggregated "smell of energy" experienced from all energy objects (creatures and food pieces).
1108Close objects have bigger influence than the distant ones: for each energy source, its partial feeling is proportional to its energy/(distance^2)
1109
1110Characteristics:
1111   does not use inputs
1112   provides output value
1113   should be located on a Part
1114]]></description>
1115                </element>
1116                <element name="neuadd_*" type="integer" min="0" max="1">
1117                        <description><![CDATA[Constant value
1118
1119Characteristics:
1120   does not use inputs
1121   provides output value
1122   does not require location in body
1123]]></description>
1124                </element>
1125                <element name="neuadd_|" type="integer" min="0" max="1">
1126                        <description><![CDATA[Characteristics:
1127   uses single input
1128   does not provide output value
1129   should be located on a Joint
1130
1131
1132Properties:
1133   power (p) float 0.01..1
1134   bending range (r) float 0..1]]></description>
1135                </element>
1136                <element name="neuadd_@" type="integer" min="0" max="1">
1137                        <description><![CDATA[Characteristics:
1138   uses single input
1139   does not provide output value
1140   should be located on a Joint
1141
1142
1143Properties:
1144   power (p) float 0.01..1]]></description>
1145                </element>
1146                <element name="neuadd_D" type="integer" min="0" max="1">
1147                        <description><![CDATA[Calculate the difference between the current and previous input value. Multiple inputs are aggregated with respect to their weights
1148
1149Characteristics:
1150   supports any number of inputs
1151   provides output value
1152   does not require location in body
1153]]></description>
1154                </element>
1155                <element name="neuadd_Fuzzy" type="integer" min="0" max="1">
1156                        <description><![CDATA[Refer to publications to learn more about this neuron.
1157
1158Characteristics:
1159   supports any number of inputs
1160   provides output value
1161   does not require location in body
1162
1163
1164Properties:
1165   number of fuzzy sets (ns) integer
1166   number of rules (nr) integer
1167   fuzzy sets (fs) string
1168   fuzzy rules (fr) string]]></description>
1169                </element>
1170                <element name="neuadd_VEye" type="integer" min="0" max="1">
1171                        <description><![CDATA[Refer to publications to learn more about this neuron.
1172
1173Characteristics:
1174   uses single input
1175   provides output value
1176   should be located on a Part
1177
1178
1179Properties:
1180   target.x (tx) float
1181   target.y (ty) float
1182   target.z (tz) float
1183   target shape (ts) string
1184   perspective (p) float 0.1..10
1185   scale (s) float 0.1..100
1186   show hidden lines (h) integer 0..1
1187   output lines count (each line needs four channels) (o) integer 0..99
1188   debug (d) integer 0..1]]></description>
1189                </element>
1190                <element name="neuadd_VMotor" type="integer" min="0" max="1">
1191                        <description><![CDATA[Must be connected to the VEye and properly set up. Refer to publications to learn more about this neuron.
1192
1193Characteristics:
1194   supports any number of inputs
1195   provides output value
1196   does not require location in body
1197
1198
1199Properties:
1200   number of basic features (noIF) integer
1201   number of degrees of freedom (noDim) integer
1202   parameters (params) string]]></description>
1203                </element>
1204                <element name="neuadd_Sti" type="integer" min="0" max="1">
1205                        <description><![CDATA[Characteristics:
1206   uses single input
1207   does not provide output value
1208   should be located on a Part
1209]]></description>
1210                </element>
1211                <element name="neuadd_LMu" type="integer" min="0" max="1">
1212                        <description><![CDATA[Characteristics:
1213   uses single input
1214   does not provide output value
1215   should be located on a Joint
1216
1217
1218Properties:
1219   power (p) float 0.01..1]]></description>
1220                </element>
1221                <element name="neuadd_Water" type="integer" min="0" max="1">
1222                        <description><![CDATA[Output signal:
12230=on or above water surface
12241=under water (deeper than 1)
12250..1=in the transient area just below water surface
1226
1227Characteristics:
1228   does not use inputs
1229   provides output value
1230   should be located on a Part
1231]]></description>
1232                </element>
1233                <element name="neuadd_Energy" type="integer" min="0" max="1">
1234                        <description><![CDATA[The current energy level divided by the initial energy level.
1235Usually falls from initial 1.0 down to 0.0 and then the creature dies. It can rise above 1.0 if enough food is ingested
1236
1237Characteristics:
1238   does not use inputs
1239   provides output value
1240   does not require location in body
1241]]></description>
1242                </element>
1243                <element name="neuadd_Ch" type="integer" min="0" max="1">
1244                        <description><![CDATA[Combines all input signals into a single multichannel output; Note: ChSel and ChMux are the only neurons which support multiple channels. Other neurons discard everything except the first channel.
1245
1246Characteristics:
1247   supports any number of inputs
1248   provides output value
1249   does not require location in body
1250]]></description>
1251                </element>
1252                <element name="neuadd_ChMux" type="integer" min="0" max="1">
1253                        <description><![CDATA[Outputs the selected channel from the second (multichannel) input. The first input is used as the selector value (-1=select first channel, .., 1=last channel)
1254
1255Characteristics:
1256   uses 2 inputs
1257   provides output value
1258   does not require location in body
1259]]></description>
1260                </element>
1261                <element name="neuadd_ChSel" type="integer" min="0" max="1">
1262                        <description><![CDATA[Outputs a single channel (selected by the "ch" parameter) from multichannel input
1263
1264Characteristics:
1265   uses single input
1266   provides output value
1267   does not require location in body
1268
1269
1270Properties:
1271   channel (ch) integer]]></description>
1272                </element>
1273                <element name="neuadd_Rnd" type="integer" min="0" max="1">
1274                        <description><![CDATA[Generates random noise (subsequent random values in the range of -1..+1)
1275
1276Characteristics:
1277   does not use inputs
1278   provides output value
1279   does not require location in body
1280]]></description>
1281                </element>
1282                <element name="neuadd_Sin" type="integer" min="0" max="1">
1283                        <description><![CDATA[Output frequency = f0+input
1284
1285Characteristics:
1286   uses single input
1287   provides output value
1288   does not require location in body
1289
1290
1291Properties:
1292   base frequency (f0) float -1..1
1293   time (t) float 0..6.28319]]></description>
1294                </element>
1295                <element name="add" function="true"/>
1296                <element name="addGroup" function="true"/>
1297                <element name="clear" function="true"/>
1298                <element name="crossOver" function="true" type="Geno">
1299                        <description><![CDATA[returns crossed over genotype]]></description>
1300                        <arguments>
1301                                <argument type="Geno"/>
1302                                <argument type="Geno"/>
1303                        </arguments>
1304                </element>
1305                <element name="getSimplest" function="true" type="Geno">
1306                        <description><![CDATA[returns the simplest genotype for a given encoding (format). 0 means f0, 4 means f4, etc.]]></description>
1307                        <arguments>
1308                                <argument name="format" type="integer"/>
1309                        </arguments>
1310                </element>
1311                <element name="mutate" function="true" type="Geno">
1312                        <description><![CDATA[returns mutated Geno object from supplied Geno]]></description>
1313                        <arguments>
1314                                <argument type="Geno"/>
1315                        </arguments>
1316                </element>
1317                <element name="operReport" function="true" type="void">
1318                        <description><![CDATA[Show available genetic operators]]></description>
1319<arguments/></element>
1320                <element name="remove" function="true"/>
1321                <element name="removeGroup" function="true"/>
1322                <element name="toHTML" function="true" type="string">
1323                        <description><![CDATA[returns genotype expressed as colored HTML]]></description>
1324                        <arguments>
1325                                <argument type="string"/>
1326                        </arguments>
1327                </element>
1328                <element name="toHTMLshort" function="true" type="string">
1329                        <description><![CDATA[returns genotype (abbreviated if needed) expressed as colored HTML]]></description>
1330                        <arguments>
1331                                <argument type="string"/>
1332                        </arguments>
1333                </element>
1334                <element name="validate" function="true" type="Geno">
1335                        <description><![CDATA[returns validated (if possible) Geno object from supplied Geno]]></description>
1336                        <arguments>
1337                                <argument type="Geno"/>
1338                        </arguments>
1339                </element>
1340        </type>
1341        <type name="GenManStats" context="Global context">
1342<description><![CDATA[Statistics for genetic operations.]]></description>
1343                <element name="gen_count" type="integer">
1344                        <description><![CDATA[]]></description>
1345                </element>
1346                <element name="gen_mfailed" type="integer">
1347                        <description><![CDATA[couldn't be performed]]></description>
1348                </element>
1349                <element name="gen_minvalid" type="integer">
1350                        <description><![CDATA[couldn't be repaired]]></description>
1351                </element>
1352                <element name="gen_mutimpr" type="float">
1353                        <description><![CDATA[total cumulative mutation change]]></description>
1354                </element>
1355                <element name="gen_mvalid" type="integer">
1356                        <description><![CDATA[]]></description>
1357                </element>
1358                <element name="gen_mvalidated" type="integer">
1359                        <description><![CDATA[]]></description>
1360                </element>
1361                <element name="gen_xofailed" type="integer">
1362                        <description><![CDATA[couldn't be performed]]></description>
1363                </element>
1364                <element name="gen_xoimpr" type="float">
1365                        <description><![CDATA[total cumulative crossover change]]></description>
1366                </element>
1367                <element name="gen_xoinvalid" type="integer">
1368                        <description><![CDATA[couldn't be repaired]]></description>
1369                </element>
1370                <element name="gen_xovalid" type="integer">
1371                        <description><![CDATA[]]></description>
1372                </element>
1373                <element name="gen_xovalidated" type="integer">
1374                        <description><![CDATA[]]></description>
1375                </element>
1376                <element name="clrstats" function="true" type="void">
1377                        <description><![CDATA[]]></description>
1378<arguments/></element>
1379        </type>
1380        <type name="Geno" context="Global context">
1381<description><![CDATA[All information about a single genotype.
1382This is a genetics-only object which does not contain any performance data. See also: Genotype class]]></description>
1383                <element name="autoname" type="string"/>
1384                <element name="f0genotype" type="string">
1385                        <description><![CDATA[converted to f0 genotype]]></description>
1386                </element>
1387                <element name="format" type="integer">
1388                        <description><![CDATA[Genotype format]]></description>
1389                </element>
1390                <element name="genotype" type="string"/>
1391                <element name="info" type="string">
1392                        <description><![CDATA[Additional information or comments]]></description>
1393                </element>
1394                <element name="isValid" type="integer" min="0" max="1"/>
1395                <element name="name" type="string"/>
1396                <element name="rawgenotype" type="string">
1397                        <description><![CDATA[Genotype, excluding the format specifier]]></description>
1398                </element>
1399                <element name="getConverted" function="true" type="Geno">
1400                        <arguments>
1401                                <argument name="format" type="integer"/>
1402                        </arguments>
1403                </element>
1404                <element name="new" function="true" type="Geno"><arguments/></element>
1405                <element name="newFrom" function="true" type="Geno">
1406                        <arguments>
1407                                <argument name="genotype" type="string"/>
1408                                <argument name="format" type="integer"/>
1409                                <argument name="name" type="string"/>
1410                                <argument name="description" type="string"/>
1411                        </arguments>
1412                </element>
1413                <element name="newFromString" function="true" type="Geno">
1414                        <arguments>
1415                                <argument name="genotype" type="string"/>
1416                        </arguments>
1417                </element>
1418        </type>
1419        <type name="Genotype" context="Global context">
1420<description><![CDATA[A Genotype with the associated performance information. All but one Genotype objects are placed in Genotype Groups. There is also a single static Genotype object not associated with a group, which is used as a temporary storage by genetic operators and some functions from GenePools.]]></description>
1421                <element name="convtrace1" type="string"/>
1422                <element name="distance" type="float"/>
1423                <element name="energ0" type="float"/>
1424                <element name="f0genotype" type="string">
1425                        <description><![CDATA[converted to f0 genotype]]></description>
1426                </element>
1427                <element name="fit" type="float"/>
1428                <element name="fit2" type="float">
1429                        <description><![CDATA[Fitness shifted by (avg-n*stddev)]]></description>
1430                </element>
1431                <element name="geno" type="Geno">
1432                        <description><![CDATA[Geno object for this Genotype]]></description>
1433                </element>
1434                <element name="genotype" type="string"/>
1435                <element name="gnum" type="integer"/>
1436                <element name="info" type="string">
1437                        <description><![CDATA[Additional information or comments]]></description>
1438                </element>
1439                <element name="instances" type="integer">
1440                        <description><![CDATA[Copies of this genotype]]></description>
1441                </element>
1442                <element name="isValid" type="integer" min="0" max="1"/>
1443                <element name="lifespan" type="float">
1444                        <description><![CDATA[Average life span]]></description>
1445                </element>
1446                <element name="name" type="string"/>
1447                <element name="nncon" type="float"/>
1448                <element name="nnsiz" type="float"/>
1449                <element name="num" type="integer"/>
1450                <element name="numconnections" type="float"/>
1451                <element name="numjoints" type="float"/>
1452                <element name="numneurons" type="float"/>
1453                <element name="numparts" type="float"/>
1454                <element name="popsiz" type="integer"/>
1455                <element name="simi" type="float"/>
1456                <element name="strjoints" type="float"/>
1457                <element name="strsiz" type="float"/>
1458                <element name="uid" type="string">
1459                        <description><![CDATA[Unique identifier]]></description>
1460                </element>
1461                <element name="user1" type="untyped"/>
1462                <element name="user2" type="untyped"/>
1463                <element name="user3" type="untyped"/>
1464                <element name="velocity" type="float">
1465                        <description><![CDATA[Average velocity]]></description>
1466                </element>
1467                <element name="vertpos" type="float"/>
1468                <element name="vertvel" type="float"/>
1469                <element name="getModel" function="true" type="Model"><arguments/></element>
1470                <element name="getNormalized" function="true" type="float">
1471                        <arguments>
1472                                <argument name="property name or index" type="untyped"/>
1473                        </arguments>
1474                </element>
1475                <element name="mutate" function="true" type="void"><arguments/></element>
1476        </type>
1477        <type name="GenotypeGroup" context="Global context">
1478<description><![CDATA[The static GenePool object refers to the "selected group" as described in GenePools]]></description>
1479                <element name="fitfun" type="integer" min="0" max="1" default="0">
1480                        <description><![CDATA[Enable fitness scaling]]></description>
1481                </element>
1482                <element name="fitm" type="float" min="0" max="10" default="2">
1483                        <description><![CDATA[Lower threshold: how many standard deviations below average?
1484(avg - n * stddev) - used for fitness shifting]]></description>
1485                </element>
1486                <element name="fitma" type="float" min="1" max="10" default="2">
1487                        <description><![CDATA[The best genotype is as many times
1488better than the average one]]></description>
1489                </element>
1490                <element name="fitness" type="string">
1491                        <description><![CDATA[(intended for advanced users)]]></description>
1492                </element>
1493                <element name="index" type="integer"/>
1494                <element name="name" type="string"/>
1495                <element name="size" type="integer">
1496                        <description><![CDATA[In standard.expdef, this is equivalent to the number of unique genotypes. Standard experiment definition uses the Genotype.instances field to indicate that some genotypes exist in multiple instances despite having only one item in the group. Other experiment definitions may create multiple copies of the same genotype.]]></description>
1497                </element>
1498                <element name="totalpop" type="integer">
1499                        <description><![CDATA[Takes into account the Genotype.instances field (which may give the total number of instances depending on the experiment definition)]]></description>
1500                </element>
1501                <element name="addGeno" function="true" type="Genotype">
1502                        <description><![CDATA[create new Genotype from the supplied Geno object.
1503returns the created Genotype.]]></description>
1504                        <arguments>
1505                                <argument type="Geno"/>
1506                        </arguments>
1507                </element>
1508                <element name="delete" function="true" type="void">
1509                        <description><![CDATA[delete genotype]]></description>
1510                        <arguments>
1511                                <argument name="genotype index" type="integer"/>
1512                        </arguments>
1513                </element>
1514                <element name="findGeno" function="true" type="integer">
1515                        <description><![CDATA[find Genotype matching the supplied Geno object.
1516returns genotype index or -1 if not found]]></description>
1517                        <arguments>
1518                                <argument type="Geno"/>
1519                        </arguments>
1520                </element>
1521                <element name="findUID" function="true" type="integer">
1522                        <arguments>
1523                                <argument name="uid" type="string"/>
1524                        </arguments>
1525                </element>
1526                <element name="get" function="true" type="Genotype">
1527                        <arguments>
1528                                <argument name="index" type="integer"/>
1529                        </arguments>
1530                </element>
1531        </type>
1532        <type name="Interface" context="Global context">
1533<description><![CDATA[Used to query for object member descriptions. Example:
1534var iface=Interface.makeFrom(someobject); var description="this object has "+iface.properties+" properties, first property is "+iface.getId(0);]]></description>
1535                <element name="groups" type="integer"/>
1536                <element name="name" type="string"/>
1537                <element name="properties" type="integer"/>
1538                <element name="findGroupId" function="true" type="integer">
1539                        <arguments>
1540                                <argument name="name" type="string"/>
1541                        </arguments>
1542                </element>
1543                <element name="findId" function="true" type="integer">
1544                        <arguments>
1545                                <argument name="name" type="string"/>
1546                        </arguments>
1547                </element>
1548                <element name="findIdInGroup" function="true" type="integer">
1549                        <arguments>
1550                                <argument name="name" type="string"/>
1551                                <argument name="group name or index" type="untyped"/>
1552                        </arguments>
1553                </element>
1554                <element name="get" function="true" type="untyped">
1555                        <arguments>
1556                                <argument name="index" type="integer"/>
1557                        </arguments>
1558                </element>
1559                <element name="getFlags" function="true" type="integer">
1560                        <arguments>
1561                                <argument name="index" type="integer"/>
1562                        </arguments>
1563                </element>
1564                <element name="getGroup" function="true" type="integer">
1565                        <arguments>
1566                                <argument name="index" type="integer"/>
1567                        </arguments>
1568                </element>
1569                <element name="getGroupName" function="true" type="string">
1570                        <arguments>
1571                                <argument name="index" type="integer"/>
1572                        </arguments>
1573                </element>
1574                <element name="getHelp" function="true" type="string">
1575                        <arguments>
1576                                <argument name="index" type="integer"/>
1577                        </arguments>
1578                </element>
1579                <element name="getId" function="true" type="string">
1580                        <arguments>
1581                                <argument name="index" type="integer"/>
1582                        </arguments>
1583                </element>
1584                <element name="getName" function="true" type="string">
1585                        <arguments>
1586                                <argument name="index" type="integer"/>
1587                        </arguments>
1588                </element>
1589                <element name="getType" function="true" type="string">
1590                        <arguments>
1591                                <argument name="index" type="integer"/>
1592                        </arguments>
1593                </element>
1594                <element name="invoke" function="true" type="void">
1595                        <arguments>
1596                                <argument name="function name or index" type="untyped"/>
1597                                <argument name="arguments" type="Vector"/>
1598                        </arguments>
1599                </element>
1600                <element name="makeFrom" function="true" type="Interface">
1601                        <arguments>
1602                                <argument type="Object"/>
1603                        </arguments>
1604                </element>
1605                <element name="set" function="true" type="void">
1606                        <arguments>
1607                                <argument name="index" type="integer"/>
1608                                <argument name="value" type="untyped"/>
1609                        </arguments>
1610                </element>
1611                <element name="setAllDefault" function="true" type="void"><arguments/></element>
1612                <element name="setDefault" function="true" type="void">
1613                        <arguments>
1614                                <argument name="index" type="integer"/>
1615                        </arguments>
1616                </element>
1617        </type>
1618        <type name="Joint" context="Global context">
1619                <element name="dx" type="float" min="-2" max="2" default="0"/>
1620                <element name="dy" type="float" min="-2" max="2" default="0"/>
1621                <element name="dz" type="float" min="-2" max="2" default="0"/>
1622                <element name="i" type="string"/>
1623                <element name="p1" type="integer" min="-1" max="999999" default="-1"/>
1624                <element name="p2" type="integer" min="-1" max="999999" default="-1"/>
1625                <element name="rotstif" type="float" min="0" max="1" default="1"/>
1626                <element name="rx" type="float"/>
1627                <element name="ry" type="float"/>
1628                <element name="rz" type="float"/>
1629                <element name="stam" type="float" min="0" max="1" default="0.25"/>
1630                <element name="stif" type="float" min="0" max="1" default="1"/>
1631                <element name="Vstyle" type="string"/>
1632        </type>
1633        <type name="Loader" context="Global context">
1634<description><![CDATA[Support for loading files in the Framsticks format. Used in the experiment definition to retrieve experiment state (see OnExpLoad function in standard.expdef). Registered objects (addClass) are handled automaticaly. Loader can call user functions defined by setBreakLabel.]]></description>
1635                <element name="AfterObject" type="integer"/>
1636                <element name="BeforeObject" type="integer"/>
1637                <element name="BeforeUnknown" type="integer"/>
1638                <element name="comment" type="string"/>
1639                <element name="currentObject" type="Object"/>
1640                <element name="firstComment" type="integer" min="0" max="1"/>
1641                <element name="objectName" type="string"/>
1642                <element name="OnComment" type="integer"/>
1643                <element name="OnError" type="integer"/>
1644                <element name="status" type="integer"/>
1645                <element name="abort" function="true" type="void"><arguments/></element>
1646                <element name="addClass" function="true" type="void">
1647                        <arguments>
1648                                <argument type="Object"/>
1649                        </arguments>
1650                </element>
1651                <element name="clearClasses" function="true" type="void"><arguments/></element>
1652                <element name="go" function="true" type="integer"><arguments/></element>
1653                <element name="loadObject" function="true" type="void"><arguments/></element>
1654                <element name="removeClass" function="true" type="void">
1655                        <arguments>
1656                                <argument type="Object"/>
1657                        </arguments>
1658                </element>
1659                <element name="run" function="true" type="integer"><arguments/></element>
1660                <element name="setBreak" function="true" type="void">
1661                        <arguments>
1662                                <argument name="break conditions" type="integer"/>
1663                        </arguments>
1664                </element>
1665                <element name="setBreakLabel" function="true" type="void">
1666                        <arguments>
1667                                <argument name="break condition" type="integer"/>
1668                                <argument name="label" type="string"/>
1669                        </arguments>
1670                </element>
1671                <element name="skipObject" function="true" type="void"><arguments/></element>
1672        </type>
1673        <type name="Math" context="Global context">
1674<description><![CDATA[Mathematical functions library.]]></description>
1675                <element name="pi" type="float"/>
1676                <element name="pi2" type="float"/>
1677                <element name="pi4" type="float"/>
1678                <element name="rnd01" type="float"/>
1679                <element name="rndGaussStd" type="float"/>
1680                <element name="seed" type="integer">
1681                        <description><![CDATA[Random number generator seed.
1682Note: Math.seed influences all future random activity in the simulator, not only Math.rnd01 results.]]></description>
1683                </element>
1684                <element name="time" type="float">
1685                        <description><![CDATA[Number of seconds since the Epoch (00:00:00 UTC/GMT, January 1, 1970)]]></description>
1686                </element>
1687                <element name="twopi" type="float"/>
1688                <element name="abs" function="true" type="float">
1689                        <arguments>
1690                                <argument type="float"/>
1691                        </arguments>
1692                </element>
1693                <element name="acos" function="true" type="float">
1694                        <arguments>
1695                                <argument type="float"/>
1696                        </arguments>
1697                </element>
1698                <element name="asin" function="true" type="float">
1699                        <arguments>
1700                                <argument type="float"/>
1701                        </arguments>
1702                </element>
1703                <element name="atan" function="true" type="float">
1704                        <arguments>
1705                                <argument type="float"/>
1706                        </arguments>
1707                </element>
1708                <element name="atan2" function="true" type="float">
1709                        <arguments>
1710                                <argument name="y" type="float"/>
1711                                <argument name="x" type="float"/>
1712                        </arguments>
1713                </element>
1714                <element name="cos" function="true" type="float">
1715                        <arguments>
1716                                <argument type="float"/>
1717                        </arguments>
1718                </element>
1719                <element name="exp" function="true" type="float">
1720                        <arguments>
1721                                <argument type="float"/>
1722                        </arguments>
1723                </element>
1724                <element name="log" function="true" type="float">
1725                        <arguments>
1726                                <argument type="float"/>
1727                        </arguments>
1728                </element>
1729                <element name="max" function="true" type="untyped">
1730                        <arguments>
1731                                <argument type="untyped"/>
1732                                <argument type="untyped"/>
1733                        </arguments>
1734                </element>
1735                <element name="min" function="true" type="untyped">
1736                        <arguments>
1737                                <argument type="untyped"/>
1738                                <argument type="untyped"/>
1739                        </arguments>
1740                </element>
1741                <element name="pow" function="true" type="float">
1742                        <arguments>
1743                                <argument name="a" type="float"/>
1744                                <argument name="b" type="float"/>
1745                        </arguments>
1746                </element>
1747                <element name="random" function="true" type="integer">
1748                        <description><![CDATA[0..num-1]]></description>
1749                        <arguments>
1750                                <argument name="num" type="integer"/>
1751                        </arguments>
1752                </element>
1753                <element name="rndCustom" function="true" type="float">
1754                        <description><![CDATA[the parameter describes the desired random distribution, being a sum of uniform distributions, eg. rndCustom([-10,-1, -1,1, 1,10]) defines 3 uniform distribution intervals [-1,10) [-1,1), [1,10)]]></description>
1755                        <arguments>
1756                                <argument type="Vector"/>
1757                        </arguments>
1758                </element>
1759                <element name="rndGauss" function="true" type="float">
1760                        <description><![CDATA[rndGaussStd is rndGauss(0,1)]]></description>
1761                        <arguments>
1762                                <argument name="center" type="float"/>
1763                                <argument name="stdandard deviation" type="float"/>
1764                        </arguments>
1765                </element>
1766                <element name="rndUni" function="true" type="float">
1767                        <description><![CDATA[[begin..end)]]></description>
1768                        <arguments>
1769                                <argument name="begin" type="float"/>
1770                                <argument name="end" type="float"/>
1771                        </arguments>
1772                </element>
1773                <element name="sigmoid" function="true" type="float">
1774                        <arguments>
1775                                <argument type="float"/>
1776                        </arguments>
1777                </element>
1778                <element name="sign" function="true" type="integer">
1779                        <arguments>
1780                                <argument type="float"/>
1781                        </arguments>
1782                </element>
1783                <element name="sin" function="true" type="float">
1784                        <arguments>
1785                                <argument type="float"/>
1786                        </arguments>
1787                </element>
1788                <element name="sqrt" function="true" type="float">
1789                        <arguments>
1790                                <argument type="float"/>
1791                        </arguments>
1792                </element>
1793        </type>
1794        <type name="MechJoint" context="Global context">
1795                <element name="dx" type="float"/>
1796                <element name="dy" type="float"/>
1797                <element name="dz" type="float"/>
1798                <element name="part1" type="MechPart"/>
1799                <element name="part2" type="MechPart"/>
1800                <element name="rotstif" type="float"/>
1801                <element name="rotstress" type="float"/>
1802                <element name="rx" type="float"/>
1803                <element name="ry" type="float"/>
1804                <element name="rz" type="float"/>
1805                <element name="stif" type="float"/>
1806                <element name="stress" type="float"/>
1807        </type>
1808        <type name="MechPart" context="Global context">
1809                <element name="fr" type="float"/>
1810                <element name="m" type="float"/>
1811                <element name="orient" type="Orient"/>
1812                <element name="oxx" type="float"/>
1813                <element name="oxy" type="float"/>
1814                <element name="oxz" type="float"/>
1815                <element name="oyx" type="float"/>
1816                <element name="oyy" type="float"/>
1817                <element name="oyz" type="float"/>
1818                <element name="ozx" type="float"/>
1819                <element name="ozy" type="float"/>
1820                <element name="ozz" type="float"/>
1821                <element name="pos" type="XYZ"/>
1822                <element name="s" type="float"/>
1823                <element name="v" type="XYZ"/>
1824                <element name="vol" type="float"/>
1825                <element name="vx" type="float"/>
1826                <element name="vy" type="float"/>
1827                <element name="vz" type="float"/>
1828                <element name="x" type="float"/>
1829                <element name="y" type="float"/>
1830                <element name="z" type="float"/>
1831                <element name="applyForce" function="true" type="void">
1832                        <arguments>
1833                                <argument name="x" type="float"/>
1834                                <argument name="y" type="float"/>
1835                                <argument name="z" type="float"/>
1836                        </arguments>
1837                </element>
1838        </type>
1839        <type name="Model" context="Global context">
1840                <element name="geno" type="Geno"/>
1841                <element name="numconnections" type="integer"/>
1842                <element name="numjoints" type="integer"/>
1843                <element name="numneurons" type="integer"/>
1844                <element name="numparts" type="integer"/>
1845                <element name="se" type="float"/>
1846                <element name="size_x" type="float">
1847                        <description><![CDATA[(size_x,size_y,size_z) are dimensions of the axis-aligned bounding box of the creature, including imaginary Part sizes (Part.s, usually 1.0). A creature consisting of a single default part has the size of (2.0,2.0,2.0) - twice the Part.s value (like a sphere diameter is twice its radius).
1848See also: Creature.moveAbs]]></description>
1849                </element>
1850                <element name="size_y" type="float">
1851                        <description><![CDATA[See Model.size_x]]></description>
1852                </element>
1853                <element name="size_z" type="float">
1854                        <description><![CDATA[See Model.size_x]]></description>
1855                </element>
1856                <element name="Vstyle" type="string"/>
1857                <element name="getJoint" function="true" type="Joint">
1858                        <arguments>
1859                                <argument name="index" type="integer"/>
1860                        </arguments>
1861                </element>
1862                <element name="getNeuroDef" function="true" type="NeuroDef">
1863                        <arguments>
1864                                <argument name="index" type="integer"/>
1865                        </arguments>
1866                </element>
1867                <element name="getPart" function="true" type="Part">
1868                        <arguments>
1869                                <argument name="index" type="integer"/>
1870                        </arguments>
1871                </element>
1872                <element name="newFromGeno" function="true" type="Model">
1873                        <arguments>
1874                                <argument type="Geno"/>
1875                        </arguments>
1876                </element>
1877                <element name="newFromString" function="true" type="Model">
1878                        <arguments>
1879                                <argument name="genotype" type="string"/>
1880                        </arguments>
1881                </element>
1882        </type>
1883        <type name="Neuro" context="Global context">
1884<description><![CDATA[Live Neuron object.]]></description>
1885                <element name="channelCount" type="integer"/>
1886                <element name="creature" type="Creature"/>
1887                <element name="currState" type="float">
1888                        <description><![CDATA[the only difference from the "state" field is that currState, when written, changes the internal neuron state immediately (which disturbs the regular synchronous NN operation). This feature should only be used while controlling the neuron 'from outside' (like a neuro probe) and not in the neuron definition.]]></description>
1889                </element>
1890                <element name="def" type="NeuroDef"/>
1891                <element name="fields" type="Fields">
1892                        <description><![CDATA[Neurons can have different fields depending on their class. Script neurons have their fields defined using the "prop:" syntax. If you develop a custom neuron script you should use the Fields object for accessing your own neuron fields. The Neuro.fields property is meant for accessing the neuron fields from the outside script.
1893Examples:
1894var c=Populations.createFromString("X[N]");
1895Simulator.print("standard neuron inertia="+c.getNeuro(0).fields.in);
1896c=Populations.createFromString("X[Nn,e:0.1]");
1897Simulator.print("noisy neuron error rate="+c.getNeuro(0).fields.e);
1898
1899The Interface object can be used to discover which fields are available for a certain neuron object:
1900c=Populations.createFromString("X[N]");
1901var iobj=Interface.makeFrom(c.getNeuro(0).fields);
1902var i;
1903for(i=0;i<iobj.properties;i++)
1904 Simulator.print(iobj.getId(i)+" ("+iobj.getName(i)+")");]]></description>
1905                </element>
1906                <element name="getInputCount" type="integer"/>
1907                <element name="hold" type="integer" min="0" max="1">
1908                        <description><![CDATA[]]></description>
1909                </element>
1910                <element name="inputSum" type="float"/>
1911                <element name="joint" type="MechJoint"/>
1912                <element name="part" type="MechPart"/>
1913                <element name="position_x" type="float"/>
1914                <element name="position_y" type="float"/>
1915                <element name="position_z" type="float"/>
1916                <element name="signals" type="NeuroSignals"/>
1917                <element name="state" type="float">
1918                        <description><![CDATA[when read, returns the current neuron state.
1919When written, sets the next neuron state (for use in the neuron definition)]]></description>
1920                </element>
1921                <element name="weightedInputSum" type="float"/>
1922                <element name="getInputChannelCount" function="true" type="integer">
1923                        <arguments>
1924                                <argument name="input" type="integer"/>
1925                        </arguments>
1926                </element>
1927                <element name="getInputState" function="true" type="float">
1928                        <arguments>
1929                                <argument name="input" type="integer"/>
1930                        </arguments>
1931                </element>
1932                <element name="getInputStateChannel" function="true" type="float">
1933                        <arguments>
1934                                <argument name="input" type="integer"/>
1935                                <argument name="channel" type="integer"/>
1936                        </arguments>
1937                </element>
1938                <element name="getInputSum" function="true" type="float">
1939                        <arguments>
1940                                <argument name="input" type="integer"/>
1941                        </arguments>
1942                </element>
1943                <element name="getInputWeight" function="true" type="float">
1944                        <arguments>
1945                                <argument name="input" type="integer"/>
1946                        </arguments>
1947                </element>
1948                <element name="getStateChannel" function="true" type="float">
1949                        <arguments>
1950                                <argument name="channel" type="integer"/>
1951                        </arguments>
1952                </element>
1953                <element name="getWeightedInputState" function="true" type="float">
1954                        <arguments>
1955                                <argument name="input" type="integer"/>
1956                        </arguments>
1957                </element>
1958                <element name="getWeightedInputStateChannel" function="true" type="float">
1959                        <arguments>
1960                                <argument name="input" type="integer"/>
1961                                <argument name="channel" type="integer"/>
1962                        </arguments>
1963                </element>
1964                <element name="getWeightedInputSum" function="true" type="float">
1965                        <description><![CDATA[uses any number of inputs starting with the specified input. getWeightedInputSum(0)=weightedInputSum]]></description>
1966                        <arguments>
1967                                <argument name="input" type="integer"/>
1968                        </arguments>
1969                </element>
1970                <element name="setCurrStateChannel" function="true" type="void">
1971                        <description><![CDATA[like "currState"]]></description>
1972                        <arguments>
1973                                <argument name="channel" type="integer"/>
1974                                <argument name="value" type="float"/>
1975                        </arguments>
1976                </element>
1977                <element name="setStateChannel" function="true" type="void">
1978                        <arguments>
1979                                <argument name="channel" type="integer"/>
1980                                <argument name="value" type="float"/>
1981                        </arguments>
1982                </element>
1983        </type>
1984        <type name="NeuroClass" context="Global context">
1985<description><![CDATA[The static NeuroClass object refers to class selected in the NeuroClassLibrary.]]></description>
1986                <element name="description" type="string"/>
1987                <element name="glyph" type="string"/>
1988                <element name="longname" type="string"/>
1989                <element name="name" type="string"/>
1990                <element name="prefinputs" type="integer"/>
1991                <element name="preflocation" type="integer" min="0" max="2"/>
1992                <element name="prefoutput" type="integer" min="0" max="1"/>
1993                <element name="properties" type="Interface"/>
1994                <element name="summary" type="string">
1995                        <description><![CDATA[Textual summary of all features]]></description>
1996                </element>
1997                <element name="visualhints" type="integer"/>
1998        </type>
1999        <type name="NeuroClassLibrary" context="Global context">
2000<description><![CDATA[Set of Neuron classes. You can access the selected class in the static NeuroClass object.]]></description>
2001                <element name="class" type="integer">
2002                        <description><![CDATA[0 ... count-1]]></description>
2003                </element>
2004                <element name="count" type="integer"/>
2005                <element name="findClass" function="true" type="void">
2006                        <arguments>
2007                                <argument name="class name" type="string"/>
2008                        </arguments>
2009                </element>
2010        </type>
2011        <type name="NeuroDef" context="Global context">
2012                <element name="d" type="string"/>
2013                <element name="getInputCount" type="integer"/>
2014                <element name="i" type="string"/>
2015                <element name="j" type="integer" min="-1" max="999999" default="-1"/>
2016                <element name="p" type="integer" min="-1" max="999999" default="-1"/>
2017                <element name="Vstyle" type="string"/>
2018                <element name="getInputNeuroDef" function="true" type="NeuroDef">
2019                        <arguments>
2020                                <argument type="integer"/>
2021                        </arguments>
2022                </element>
2023                <element name="getInputNeuroIndex" function="true" type="integer">
2024                        <arguments>
2025                                <argument type="integer"/>
2026                        </arguments>
2027                </element>
2028                <element name="getInputWeight" function="true" type="float">
2029                        <arguments>
2030                                <argument type="integer"/>
2031                        </arguments>
2032                </element>
2033        </type>
2034        <type name="NeuroSignals" context="Global context">
2035<description><![CDATA[Signals attached to the neuron.
2036See also: Signal, WorldSignals, CreatureSignals.
2037scripts/light.neuro and scripts/seelight.neuro are simple custom neuron examples demonstrating how to send/receive signals between creatures.]]></description>
2038                <element name="size" type="integer"/>
2039                <element name="add" function="true" type="void">
2040                        <description><![CDATA[Create a new signal]]></description>
2041                        <arguments>
2042                                <argument name="channel" type="string"/>
2043                        </arguments>
2044                </element>
2045                <element name="clear" function="true" type="void"><arguments/></element>
2046                <element name="get" function="true" type="Signal">
2047                        <arguments>
2048                                <argument name="index" type="integer"/>
2049                        </arguments>
2050                </element>
2051                <element name="receive" function="true" type="float">
2052                        <description><![CDATA[Receive the aggregated signal power in a given channel.]]></description>
2053                        <arguments>
2054                                <argument name="channel" type="string"/>
2055                        </arguments>
2056                </element>
2057                <element name="receiveFilter" function="true" type="float">
2058                        <description><![CDATA[Receive the aggregated signal power in a given channel.
2059
2060Additional filtering options:
2061- Max distance only receives the neighbor signals (based on their physical location)
2062- Flavor filtering: only signals having the flavor close to the specified one will be received. The filter value is the maximum allowed difference.]]></description>
2063                        <arguments>
2064                                <argument name="channel" type="string"/>
2065                                <argument name="max distance" type="float"/>
2066                                <argument name="flavor" type="float"/>
2067                                <argument name="filter" type="float"/>
2068                        </arguments>
2069                </element>
2070                <element name="receiveSet" function="true" type="Vector">
2071                        <description><![CDATA[Get all signals in the specified range. Returns a readonly vector object containing Signal objects (individual signals can be accessed as result[0] throught result[result.size-1]).]]></description>
2072                        <arguments>
2073                                <argument name="channel" type="string"/>
2074                                <argument name="max distance" type="float"/>
2075                        </arguments>
2076                </element>
2077                <element name="receiveSingle" function="true" type="Signal">
2078                        <description><![CDATA[Find the signal source having the highest signal power (including the distance)]]></description>
2079                        <arguments>
2080                                <argument name="channel" type="string"/>
2081                                <argument name="range" type="float"/>
2082                        </arguments>
2083                </element>
2084        </type>
2085        <type name="ODE" context="Global context">
2086<description><![CDATA[ODE Parameters.]]></description>
2087                <element name="odeairdrag" type="float" min="0" max="0.5" default="0.01">
2088                        <description><![CDATA[A drag force ("air drag") proportional to the velocity of mass centers of moving parts]]></description>
2089                </element>
2090                <element name="odecol2bounce" type="float" min="0" max="1" default="0.1"/>
2091                <element name="odecol2bouncevel" type="float" min="0" max="1" default="0.01"/>
2092                <element name="odecol2mumax" type="float" min="0" max="10" default="1">
2093                        <description><![CDATA[Mu coefficient for Parts with maximal friction (i.e. "FFFFF" in f1)]]></description>
2094                </element>
2095                <element name="odecol2mumin" type="float" min="0" max="10" default="0.1">
2096                        <description><![CDATA[Mu coefficient for Parts with minimal friction (i.e. "fffff" in f1)]]></description>
2097                </element>
2098                <element name="odecol2softcfm" type="float" min="0" max="1" default="0"/>
2099                <element name="odecolbounce" type="float" min="0" max="1" default="0.1"/>
2100                <element name="odecolbouncevel" type="float" min="0" max="1" default="0.01"/>
2101                <element name="odecolmumax" type="float" min="0" max="10" default="5">
2102                        <description><![CDATA[Mu coefficient for Parts with maximal friction (i.e. "FFFFF" in f1)]]></description>
2103                </element>
2104                <element name="odecolmumin" type="float" min="0" max="10" default="0.1">
2105                        <description><![CDATA[Mu coefficient for Parts with minimal friction (i.e. "fffff" in f1)]]></description>
2106                </element>
2107                <element name="odecolsoftcfm" type="float" min="0" max="1" default="0"/>
2108                <element name="odemusclemax" type="float" min="0" max="100" default="10">
2109                        <description><![CDATA[i.e. "MMMMM" if f1]]></description>
2110                </element>
2111                <element name="odemusclemin" type="float" min="0" max="100" default="0">
2112                        <description><![CDATA[i.e. "mmmmm" in f1]]></description>
2113                </element>
2114                <element name="odemusclespeed" type="float" min="0" max="10" default="1">
2115                        <description><![CDATA[Muscle state cannot change faster than the supplied value]]></description>
2116                </element>
2117                <element name="odeseed" type="integer" min="0" max="2">
2118                        <description><![CDATA[Affects collisions.
2119- 'Truly random' is closest to the standard ODE operation. Use Math.seed to influence randomness in ODE collisions
2120- 'Deterministic' automatically calculates random seed in each step based on the current simulation (world) state, which makes the simulation repeatable but more random than 'Fixed'
2121- 'Fixed' is completely deterministic and does not depend on Math.seed. This might negatively affect ODE accuracy
2122]]></description>
2123                </element>
2124                <element name="odeshape" type="integer" min="0" max="1"/>
2125                <element name="odestep" type="float" min="0.001" max="1" default="0.05"/>
2126                <element name="odewaterbuoy" type="float" min="0" max="2" default="1"/>
2127                <element name="odewaterdrag" type="float" min="0.001" max="1" default="0.5"/>
2128                <element name="rayIntersection" function="true" type="float">
2129                        <arguments>
2130                                <argument name="position x" type="float"/>
2131                                <argument name="position y" type="float"/>
2132                                <argument name="position z" type="float"/>
2133                                <argument name="direction x" type="float"/>
2134                                <argument name="direction y" type="float"/>
2135                                <argument name="direction z" type="float"/>
2136                                <argument name="max distance" type="float"/>
2137                        </arguments>
2138                </element>
2139        </type>
2140        <type name="Orient" context="Global context">
2141<description><![CDATA[3D orientation, stored as 3x3 matrix.]]></description>
2142                <element name="x" type="XYZ"/>
2143                <element name="xx" type="float"/>
2144                <element name="xy" type="float"/>
2145                <element name="xz" type="float"/>
2146                <element name="y" type="XYZ"/>
2147                <element name="yx" type="float"/>
2148                <element name="yy" type="float"/>
2149                <element name="yz" type="float"/>
2150                <element name="z" type="XYZ"/>
2151                <element name="zx" type="float"/>
2152                <element name="zy" type="float"/>
2153                <element name="zz" type="float"/>
2154                <element name="between2" function="true" type="void">
2155                        <arguments>
2156                                <argument type="Orient"/>
2157                                <argument type="Orient"/>
2158                                <argument name="amount" type="float"/>
2159                        </arguments>
2160                </element>
2161                <element name="betweenOV" function="true" type="void">
2162                        <arguments>
2163                                <argument type="Orient"/>
2164                                <argument type="XYZ"/>
2165                                <argument name="amount" type="float"/>
2166                        </arguments>
2167                </element>
2168                <element name="clone" function="true" type="Orient"><arguments/></element>
2169                <element name="localToWorld" function="true">
2170                        <arguments>
2171                                <argument name="point" type="XYZ"/>
2172                                <argument name="center" type="XYZ"/>
2173                        </arguments>
2174                </element>
2175                <element name="lookAt" function="true" type="void">
2176                        <arguments>
2177                                <argument name="direction" type="XYZ"/>
2178                                <argument name="up" type="XYZ"/>
2179                        </arguments>
2180                </element>
2181                <element name="new" function="true" type="Orient">
2182                        <arguments>
2183                                <argument name="x" type="float"/>
2184                                <argument name="y" type="float"/>
2185                                <argument name="z" type="float"/>
2186                        </arguments>
2187                </element>
2188                <element name="normalize" function="true" type="void"><arguments/></element>
2189                <element name="reset" function="true" type="void"><arguments/></element>
2190                <element name="revRotate" function="true" type="void">
2191                        <arguments>
2192                                <argument type="Orient"/>
2193                        </arguments>
2194                </element>
2195                <element name="rotate" function="true" type="void">
2196                        <arguments>
2197                                <argument type="Orient"/>
2198                        </arguments>
2199                </element>
2200                <element name="rotate3" function="true" type="void">
2201                        <arguments>
2202                                <argument name="x" type="float"/>
2203                                <argument name="y" type="float"/>
2204                                <argument name="z" type="float"/>
2205                        </arguments>
2206                </element>
2207                <element name="set" function="true" type="void">
2208                        <arguments>
2209                                <argument type="Orient"/>
2210                        </arguments>
2211                </element>
2212                <element name="worldToLocal" function="true">
2213                        <arguments>
2214                                <argument name="point" type="XYZ"/>
2215                                <argument name="center" type="XYZ"/>
2216                        </arguments>
2217                </element>
2218        </type>
2219        <type name="Part" context="Global context">
2220                <element name="as" type="float" min="0" max="1" default="0.25"/>
2221                <element name="dn" type="float" min="0.2" max="5" default="1"/>
2222                <element name="fr" type="float" min="0" max="4" default="0.4"/>
2223                <element name="i" type="string"/>
2224                <element name="ing" type="float" min="0" max="1" default="0.25"/>
2225                <element name="m" type="float" min="0.1" max="999" default="1"/>
2226                <element name="rx" type="float"/>
2227                <element name="ry" type="float"/>
2228                <element name="rz" type="float"/>
2229                <element name="s" type="float" min="0.1" max="10" default="1"/>
2230                <element name="Vstyle" type="string"/>
2231                <element name="x" type="float"/>
2232                <element name="y" type="float"/>
2233                <element name="z" type="float"/>
2234        </type>
2235        <type name="Population" context="Global context">
2236<description><![CDATA[A set of Creature objects, sharing some high level simulation properties (performance calculation, NN simulation, collision detection, event handling). The groups usually have different roles in the experiment (Creatures groups and Food group in standard.expdef)]]></description>
2237                <element name="bodysim" type="integer" min="0" max="1" default="1">
2238                        <description><![CDATA[Enable/disable physical body simulation. This is the initial value of Creature.bodysim for all objects created in this group. For details, see the documentation of Creature.bodysim.]]></description>
2239                </element>
2240                <element name="colmask" type="integer" min="0" max="65535" default="0">
2241                        <description><![CDATA[DEPRECATED. You should use selfmask and othermask (these masks are also much easier to understand than the old colmask field).]]></description>
2242                </element>
2243                <element name="death" type="integer" min="0" max="1" default="1">
2244                        <description><![CDATA[Do creatures die when no energy?]]></description>
2245                </element>
2246                <element name="em_dyn" type="float" min="0" max="1" default="0">
2247                        <description><![CDATA[Energy requirements for a muscle
2248moving a stick]]></description>
2249                </element>
2250                <element name="em_stat" type="float" min="0" max="1" default="0">
2251                        <description><![CDATA[Energy requirements for a muscle
2252resisting an external force]]></description>
2253                </element>
2254                <element name="en_assim" type="float" min="0" max="1" default="0">
2255                        <description><![CDATA[Maximal energy gain produced by a vertical specialized stick.
2256Horizontal specialized sticks get half of this value.]]></description>
2257                </element>
2258                <element name="enableperf" type="integer" min="0" max="2" default="1">
2259                        <description><![CDATA[Stabilization means no significant movement during a specified period of time.]]></description>
2260                </element>
2261                <element name="energy" type="integer" min="0" max="1" default="1">
2262                        <description><![CDATA[If turned off, creature's energy will be constant]]></description>
2263                </element>
2264                <element name="index" type="integer"/>
2265                <element name="killnostable" type="integer" min="0" max="10000000" default="1000000">
2266                        <description><![CDATA[Creatures that fail to stabilize after the specified waiting period (e.g. because they are continuously rolling) will be killed. 0 disables this feature.]]></description>
2267                </element>
2268                <element name="name" type="string"/>
2269                <element name="nnsim" type="integer" min="0" max="2" default="1">
2270                        <description><![CDATA[Stabilization means no significant movement during a specified period of time.]]></description>
2271                </element>
2272                <element name="othermask" type="integer" min="0" max="2147483647" default="0">
2273                        <description><![CDATA[See selfmask.]]></description>
2274                </element>
2275                <element name="perfperiod" type="integer" min="0" max="1000000" default="100">
2276                        <description><![CDATA[Defines how often onUpdate() events are called. Also used to compute partial performance of creatures (distance, speed, etc.) and to determine stabilization.]]></description>
2277                </element>
2278                <element name="selfcol" type="integer" min="0" max="1" default="0">
2279                        <description><![CDATA[Detect collisions within creature bodies (only applicable for the ODE simulation engine). This is the initial value of Creature.selfcol for all objects created in this group. If enabled, creatures with self-colliding genotypes are not born, and others will have their sticks collide during lifespan.]]></description>
2280                </element>
2281                <element name="selfmask" type="integer" min="0" max="2147483647" default="0">
2282                        <description><![CDATA[Collisions between objects can be handled in two ways:
2283 - standard 'mechanical' collision (simple 'rebound' effect)
2284 - special script handler (On[GROUPNAME]Collision function)
2285
2286In the script handler function, use the Collision object to access the two colliding parts of two creatures.
2287The first part in the Collision object (i.e. Collision.Creature1) always concerns the creature that belongs to [GROUPNAME].
2288The handler is called once for each creature that collides with the creature from [GROUPNAME].
2289
2290Collision masks determine which one will be used (none and both are also possible). On each collision, selfmask and othermask of the colliding objects are logically ANDed. 16 lower bits (0xffff) enable the standard handler. 16 higher bits (0xffff0000) enable the custom handler.
2291Examples:
2292
22931.With one group, all possible combinations of the collision handlers are as follows:
2294  - ignore collisions (e.g. selfmask=othermask=0)
2295  - use standard handling (e.g. selfmask=othermask=1)
2296  - use custom handling (e.g. selfmask=othermask=0x10000)
2297  - use standard and custom handling (e.g. selfmask=othermask=0x10001)
2298
22992.Two groups yield more interesting cases. Let us consider the 'standard.expdef' setting:
2300  Creatures: selfmask=0x10001, othermask=0x20001
2301  Food colmask = selfmask=0x20002, othermask=0x10002
2302There are three possible scenarios:
2303- creature and creature: collision value = 0x10001 & 0x20001 = 1 -> Standard handling will be used (1 is one of the lower 16 bits)
2304- food and food: collision value = 0x20002 & 0x10002 = 2 -> As above.
2305- creature and food: collision value = (0x10001 & 0x10002) or (0x20002 & 0x20001) = 0x10000 or 0x20000 -> Custom handling will be used (higher 16 bits).
2306]]></description>
2307                </element>
2308                <element name="size" type="integer"/>
2309                <element name="stabilperiod" type="integer" min="0" max="1000000" default="100">
2310                        <description><![CDATA["Performance sampling period" for the stabilization phase.]]></description>
2311                </element>
2312                <element name="stabledist" type="float" min="0" max="1" default="0.01">
2313                        <description><![CDATA[A creature is considered stabilized when its center of gravity stays within the specified distance after the "Sampling period while waiting" has elapsed.]]></description>
2314                </element>
2315                <element name="createFromGeno" function="true" type="Creature">
2316                        <description><![CDATA[uses the supplied Geno object]]></description>
2317                        <arguments>
2318                                <argument type="Geno"/>
2319                        </arguments>
2320                </element>
2321                <element name="createFromGenotype" function="true" type="Creature">
2322                        <description><![CDATA[uses the selected Genotype object]]></description>
2323<arguments/></element>
2324                <element name="createFromString" function="true" type="Creature">
2325                        <description><![CDATA[uses the supplied string argument]]></description>
2326                        <arguments>
2327                                <argument name="genotype" type="string"/>
2328                        </arguments>
2329                </element>
2330                <element name="delete" function="true" type="void">
2331                        <description><![CDATA[delete creature]]></description>
2332                        <arguments>
2333                                <argument name="creature index" type="integer"/>
2334                        </arguments>
2335                </element>
2336                <element name="findCreatureAt" function="true" type="Creature">
2337                        <arguments>
2338                                <argument name="point" type="Vector"/>
2339                                <argument name="vector" type="Vector"/>
2340                        </arguments>
2341                </element>
2342                <element name="findUID" function="true" type="integer">
2343                        <arguments>
2344                                <argument name="uid" type="string"/>
2345                        </arguments>
2346                </element>
2347                <element name="get" function="true" type="Creature">
2348                        <arguments>
2349                                <argument name="index" type="integer"/>
2350                        </arguments>
2351                </element>
2352                <element name="kill" function="true" type="void">
2353                        <description><![CDATA[kill creature]]></description>
2354                        <arguments>
2355                                <argument name="creature index" type="integer"/>
2356                        </arguments>
2357                </element>
2358                <element name="senseCreaturesProperty" function="true" type="float">
2359                        <description><![CDATA[arguments:
2360 - x,y,z (sensor position)
2361 - property (name, name[index] or Class:id). name[index] can be used for Vector objects inside the user fields, eg "user2[10]"
2362 - exclude (creature object)
2363works like a smell sensor for a given property (for all creatures in this group except "exclude").
2364The following function reproduces the "classic" framsticks "S" sensor:
2365function smellReceptorValue(x,y,z,exclude)
2366{
2367var i,s=0; for(i=0;i<Populations.size;i++)
2368        s+=Populations[0].senseCreaturesProperty(x,y,z,"energy",exclude);
2369return s;
2370}]]></description>
2371                        <arguments>
2372                                <argument name="x" type="float"/>
2373                                <argument name="y" type="float"/>
2374                                <argument name="z" type="float"/>
2375                                <argument name="propertyname" type="string"/>
2376                                <argument name="exclude" type="Creature"/>
2377                        </arguments>
2378                </element>
2379        </type>
2380        <type name="Populations" context="Global context">
2381<description><![CDATA[Manages all Creature objects in the experiment, organized in one or more groups. See also: Creature, Population]]></description>
2382                <element name="creature" type="integer"/>
2383                <element name="group" type="integer"/>
2384                <element name="size" type="integer"/>
2385                <element name="addGroup" function="true" type="void">
2386                        <description><![CDATA[add population]]></description>
2387                        <arguments>
2388                                <argument name="name" type="string"/>
2389                        </arguments>
2390                </element>
2391                <element name="clear" function="true" type="void">
2392                        <description><![CDATA[remove all populations except the first one]]></description>
2393<arguments/></element>
2394                <element name="clearGroup" function="true" type="void">
2395                        <arguments>
2396                                <argument name="index" type="integer"/>
2397                        </arguments>
2398                </element>
2399                <element name="creatBBCollisions" function="true" type="integer">
2400                        <description><![CDATA[Checks approximate collisions for the selected creature.
2401Returns the collision mask calculated as in the regular simulation. The argument is the collision mask substituted for the selected creature (defaults to group colmask for 0)]]></description>
2402                        <arguments>
2403                                <argument name="mask" type="integer"/>
2404                        </arguments>
2405                </element>
2406                <element name="createFromGenotype" function="true" type="Creature">
2407                        <description><![CDATA[uses the selected Genotype object]]></description>
2408<arguments/></element>
2409                <element name="createFromString" function="true" type="Creature">
2410                        <description><![CDATA[uses the supplied string argument]]></description>
2411                        <arguments>
2412                                <argument name="genotype" type="string"/>
2413                        </arguments>
2414                </element>
2415                <element name="deleteGroup" function="true" type="void">
2416                        <description><![CDATA[remove population]]></description>
2417                        <arguments>
2418                                <argument name="index" type="integer"/>
2419                        </arguments>
2420                </element>
2421                <element name="deleteSelected" function="true" type="void">
2422                        <description><![CDATA[applies to the selected Creature]]></description>
2423<arguments/></element>
2424                <element name="findCreatureAt" function="true" type="Creature">
2425                        <arguments>
2426                                <argument name="point" type="Vector"/>
2427                                <argument name="vector" type="Vector"/>
2428                        </arguments>
2429                </element>
2430                <element name="get" function="true" type="Population">
2431                        <arguments>
2432                                <argument name="index" type="integer"/>
2433                        </arguments>
2434                </element>
2435                <element name="killSelected" function="true" type="void">
2436                        <description><![CDATA[applies to the selected Creature]]></description>
2437<arguments/></element>
2438        </type>
2439        <type name="Ref" context="Global context">
2440<description><![CDATA[Reference objects. Useful for returning things from functions.
2441
2442Example:
2443var x=111;
2444square(&x);// '&' creates the Reference object
2445Simulator.print(x);//x is now 12321
2446
2447function square(r)
2448{r.value=r.value*r.value;}
2449//square receives the Reference objects and changes its 'value' field]]></description>
2450                <element name="toString" type="string"/>
2451                <element name="value" type="untyped"/>
2452                <element name="copyFrom" function="true" type="void">
2453                        <description><![CDATA[make the reference point to the same target,]]></description>
2454                        <arguments>
2455                                <argument type="Ref"/>
2456                        </arguments>
2457                </element>
2458                <element name="newO" function="true">
2459                        <description><![CDATA[(for internal use only) use &variablename to create Ref objects.]]></description>
2460                </element>
2461                <element name="newS" function="true">
2462                        <description><![CDATA[(for internal use only) use &variablename to create Ref objects.]]></description>
2463                </element>
2464        </type>
2465        <type name="Shapes" context="Global context">
2466<description><![CDATA[This object defines appearance of the elements of creatures (applies to the 'wireframe' display mode). Default shape definitions make food's "p:" look like a sphere, and manipulator's "p:" look like a robot hand. The model's Vstyle property is the name of the shape. Developers of experiment definitions can introduce new Vstyle(s) for their expdef and provide appropriate shape definitions by calling Shapes.set(...) in the onExpDefLoad() function.]]></description>
2467                <element name="clear" function="true" type="void"><arguments/></element>
2468                <element name="set" function="true" type="void">
2469                        <description><![CDATA[Arguments:
2470
2471- "id" - can be
2472  "1p_STYLENAME": affects a single-Part creature (without Joints)
2473  "p_STYLENAME": affects all normal Parts
2474  "j_STYLENAME": affects Joints
2475     (STYLENAME corresponds to the Model.Vstyle value, and it can be empty).
2476
2477- "definition" is a genotype describing the object shape
2478
2479- "color" can be 0xRRGGBB or one of the special values: -3 = default creature color, -4 = default food color, -5 = default manipulator color
2480
2481Examples:
2482Shapes.set("j_predator","X",0xff0000);//make all predators (i.e. creatures with Vstyle=predator) red
2483Shapes.set("1p_food","...some...genotype...",-4);//change food appearance
2484Shapes.set("p_","//0\np:0,0,0\np:-0.1,0,0\np:0.1,0,0\np:0,-0.1,0\np:0,0.1,0\np:0,0,-0.1\np:0,0,0.1\nj:0,1\nj:0,2\nj:0,3\nj:0,4\nj:0,5\nj:0,6\n",0);//make Parts' orientation axes visible]]></description>
2485                        <arguments>
2486                                <argument name="id" type="string"/>
2487                                <argument name="definition" type="string"/>
2488                                <argument name="color" type="integer"/>
2489                        </arguments>
2490                </element>
2491        </type>
2492        <type name="Signal" context="Global context">
2493<description><![CDATA[Signals broadcast information in a channel (being an abstract communication medium that could be imagined as sound, smell, vision or anything else). There are no sender-receiver associations, although the receiving party can filter out signals (two standard filtering methods are: physical neighborhood and one-dimensional attribute called flavor). Signals attached to neurons and creatures (created in Creature.signals and Neuro.signals) automatically follow the owner's location. Environmental signals (in World.signals) are stationary.
2494
2495Receiving:
2496There are 2 kinds of data you can receive:
24971. aggregating functions (receive and receiveFilter) calculate the overall power of the received signal (based on the distance and the source power).
24982. receiveSet and receiveSingle fetch the individual Signal object(s) so it is possible to transmit something else than just a single number (by using Signal.value) and do more sophisticated processing.
2499
2500Creating: Use "add" in Creature.signals, Neuro.signals, or World.signals.]]></description>
2501                <element name="channel" type="string">
2502                        <description><![CDATA[Channel name, readonly.]]></description>
2503                </element>
2504                <element name="flavor" type="float">
2505                        <description><![CDATA[Signal flavor is can be used to differentiate between signals in a single channel. ]]></description>
2506                </element>
2507                <element name="pos" type="XYZ">
2508                        <description><![CDATA[Signal position, readonly.]]></description>
2509                </element>
2510                <element name="power" type="float">
2511                        <description><![CDATA[Signal power affects the aggregated signal value returned from receive() and receiveFilter().]]></description>
2512                </element>
2513                <element name="value" type="untyped">
2514                        <description><![CDATA[Signal value can be any type. On the receiver side it is only available by accessing the individual Signal objects, i.e. after calling receiveSet() or receiveSingle(). The aggregating function receive() and receiveFilter() ignore this attribute.]]></description>
2515                </element>
2516                <element name="remove" function="true">
2517                        <description><![CDATA[Deletes the signal]]></description>
2518                </element>
2519        </type>
2520        <type name="sim_params" context="Global context">
2521<description><![CDATA[This object groups all simulator parameters so they can be loaded or saved with a single call (see scripts/standard_loadsave.inc). For other purposes please use specific objects, like Simulator, World, Populations, etc.]]></description>
2522                <element name="autosaveperiod" type="integer" min="0" max="100000">
2523                        <description><![CDATA[Save simulation state once every n-th event
2524(events are defined by the script. For 'standard.expdef' it is after each death).
2525Save EXPT file first to initialize name for autosave files.]]></description>
2526                </element>
2527                <element name="bnoise_struct" type="float" min="0" max="10" default="0">
2528                        <description><![CDATA[When >0, body constructs of creatures (position of Parts) will be randomly disturbed when they are created.]]></description>
2529                </element>
2530                <element name="bnoise_vel" type="float" min="0" max="10" default="0">
2531                        <description><![CDATA[Random velocities will be applied to all body Parts (in MechaStick) or rigid segments (in ODE) of newly created creatures.]]></description>
2532                </element>
2533                <element name="changedProperty" type="integer"/>
2534                <element name="changedPropertyId" type="string"/>
2535                <element name="createrr" type="integer" min="0" max="2" default="1"/>
2536                <element name="creatwarnfail" type="integer" min="0" max="1">
2537                        <description><![CDATA[Creatures grown with warnings will not be simulated.]]></description>
2538                </element>
2539                <element name="expdef" type="string">
2540                        <description><![CDATA[Choose the experiment framework
2541(in Windows GUI, confirm by pressing 'Apply')
2542
2543Stop the simulation before selecting another experiment definition.
2544It is a good practice to initialize the experiment before running the simulation.]]></description>
2545                </element>
2546                <element name="expdef_info" type="string"/>
2547                <element name="expdef_title" type="string"/>
2548                <element name="f0_c_del" type="float" min="0" max="100" default="5">
2549                        <description><![CDATA[]]></description>
2550                </element>
2551                <element name="f0_c_new" type="float" min="0" max="100" default="5">
2552                        <description><![CDATA[]]></description>
2553                </element>
2554                <element name="f0_c_wei" type="float" min="0" max="100" default="10">
2555                        <description><![CDATA[]]></description>
2556                </element>
2557                <element name="f0_j_del" type="float" min="0" max="100" default="5">
2558                        <description><![CDATA[]]></description>
2559                </element>
2560                <element name="f0_j_new" type="float" min="0" max="100" default="5">
2561                        <description><![CDATA[]]></description>
2562                </element>
2563                <element name="f0_j_rsf" type="float" min="0" max="100" default="10">
2564                        <description><![CDATA[]]></description>
2565                </element>
2566                <element name="f0_j_stf" type="float" min="0" max="100" default="10">
2567                        <description><![CDATA[]]></description>
2568                </element>
2569                <element name="f0_j_stm" type="float" min="0" max="100" default="10">
2570                        <description><![CDATA[]]></description>
2571                </element>
2572                <element name="f0_n_del" type="float" min="0" max="100" default="5">
2573                        <description><![CDATA[]]></description>
2574                </element>
2575                <element name="f0_n_new" type="float" min="0" max="100" default="5">
2576                        <description><![CDATA[]]></description>
2577                </element>
2578                <element name="f0_n_prp" type="float" min="0" max="100" default="10">
2579                        <description><![CDATA[]]></description>
2580                </element>
2581                <element name="f0_nodel_tag" type="integer" min="0" max="1" default="1">
2582                        <description><![CDATA[You can tag elements using their 'i' field and the i="mi=d" tag.
2583Mutations will not delete such elements.
2584The i="mi=dm" combination is allowed.]]></description>
2585                </element>
2586                <element name="f0_nomod_tag" type="integer" min="0" max="1" default="1">
2587                        <description><![CDATA[You can tag elements using their 'i' field and the i="mi=m" tag.
2588Mutations will not modify properties of such elements.
2589The i="mi=md" combination is allowed.]]></description>
2590                </element>
2591                <element name="f0_p_asm" type="float" min="0" max="100" default="10">
2592                        <description><![CDATA[]]></description>
2593                </element>
2594                <element name="f0_p_del" type="float" min="0" max="100" default="5">
2595                        <description><![CDATA[]]></description>
2596                </element>
2597                <element name="f0_p_frc" type="float" min="0" max="100" default="10">
2598                        <description><![CDATA[]]></description>
2599                </element>
2600                <element name="f0_p_ing" type="float" min="0" max="100" default="10">
2601                        <description><![CDATA[]]></description>
2602                </element>
2603                <element name="f0_p_mas" type="float" min="0" max="100" default="10">
2604                        <description><![CDATA[]]></description>
2605                </element>
2606                <element name="f0_p_new" type="float" min="0" max="100" default="5">
2607                        <description><![CDATA[]]></description>
2608                </element>
2609                <element name="f0_p_pos" type="float" min="0" max="100" default="10">
2610                        <description><![CDATA[]]></description>
2611                </element>
2612                <element name="f0_p_swp" type="float" min="0" max="100" default="10">
2613                        <description><![CDATA[]]></description>
2614                </element>
2615                <element name="f0Fuzzy_maxRules" type="integer" min="0" max="999">
2616                        <description><![CDATA[Maximum number of fuzzy rules]]></description>
2617                </element>
2618                <element name="f0Fuzzy_maxSets" type="integer" min="0" max="999">
2619                        <description><![CDATA[Maximum number of fuzzy sets]]></description>
2620                </element>
2621                <element name="f0Fuzzy_prob0" type="float" min="0" max="1">
2622                        <description><![CDATA[Probability of adding new fuzzy set with simple rule, which uses this set (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
2623                </element>
2624                <element name="f0Fuzzy_prob1" type="float" min="0" max="1">
2625                        <description><![CDATA[Probability of removing fuzzy set (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
2626                </element>
2627                <element name="f0Fuzzy_prob2" type="float" min="0" max="1">
2628                        <description><![CDATA[Probability of adding new rule (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
2629                </element>
2630                <element name="f0Fuzzy_prob3" type="float" min="0" max="1">
2631                        <description><![CDATA[Probability of removing rule (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
2632                </element>
2633                <element name="f0Fuzzy_prob4" type="float" min="0" max="1">
2634                        <description><![CDATA[Probability of adding new input or output to exisitng rule (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
2635                </element>
2636                <element name="f0Fuzzy_prob5" type="float" min="0" max="1">
2637                        <description><![CDATA[Probability of removing input or output from exisitng rule (1=proceed on all genes, 0.1=proceed on ten percent)]]></description>
2638                </element>
2639                <element name="f1_mut_exmod" type="string">
2640                        <description><![CDATA[Modifiers that will not be added nor deleted during mutation
2641(all: RrLlAaCcFfMmSsIiQqWwEe)]]></description>
2642                </element>
2643                <element name="f1_nmConn" type="float" min="0" max="100" default="0.1">
2644                        <description><![CDATA[]]></description>
2645                </element>
2646                <element name="f1_nmNeu" type="float" min="0" max="100" default="0.05">
2647                        <description><![CDATA[Adds a (connected) neuron or removes a neuron]]></description>
2648                </element>
2649                <element name="f1_nmProp" type="float" min="0" max="100" default="0.1">
2650                        <description><![CDATA[]]></description>
2651                </element>
2652                <element name="f1_nmVal" type="float" min="0" max="100" default="0.05"/>
2653                <element name="f1_nmWei" type="float" min="0" max="100" default="1"/>
2654                <element name="f1_smComma" type="float" min="0" max="100" default="0.02"/>
2655                <element name="f1_smJunct" type="float" min="0" max="100" default="0.02"/>
2656                <element name="f1_smModif" type="float" min="0" max="100" default="0.1">
2657                        <description><![CDATA[Modifiers: RrLlAaCcFfMmSsIiQqWwEe]]></description>
2658                </element>
2659                <element name="f1_smX" type="float" min="0" max="100" default="0.05"/>
2660                <element name="f1_xo_propor" type="integer" min="0" max="1" default="1">
2661                        <description><![CDATA[Cross over (exchange) corresponding segments of the two parent genotypes?
2662
2663f1 uses a two-point crossing over.
2664If this option is turned on, cut points will be selected proportionally to neural genes.
2665Thus, if both parents have the same number of neurons, then this will be preserved in their children.]]></description>
2666                </element>
2667                <element name="f2_mutAddOper" type="float" min="0" max="1" default="0.4">
2668                        <description><![CDATA[]]></description>
2669                </element>
2670                <element name="f2_mutConnElem" type="float" min="0" max="1" default="0.33">
2671                        <description><![CDATA[]]></description>
2672                </element>
2673                <element name="f2_mutDelOper" type="float" min="0" max="1" default="0.1">
2674                        <description><![CDATA[]]></description>
2675                </element>
2676                <element name="f2_mutHandleOper" type="float" min="0" max="1" default="0.3">
2677                        <description><![CDATA[]]></description>
2678                </element>
2679                <element name="f2_mutJointElem" type="float" min="0" max="1" default="0.33">
2680                        <description><![CDATA[]]></description>
2681                </element>
2682                <element name="f2_mutNeuroElem" type="float" min="0" max="1" default="0.33">
2683                        <description><![CDATA[]]></description>
2684                </element>
2685                <element name="f2_mutPropOper" type="float" min="0" max="1" default="0.2">
2686                        <description><![CDATA[]]></description>
2687                </element>
2688                <element name="f3_mutDelIns" type="float" min="0" max="1" default="0.1">
2689                        <description><![CDATA[]]></description>
2690                </element>
2691                <element name="f3_mutDelInsLength" type="integer" min="1" max="100" default="5">
2692                        <description><![CDATA[]]></description>
2693                </element>
2694                <element name="f3_mutDelInsPerChar" type="float" min="0" max="1" default="0.05">
2695                        <description><![CDATA[]]></description>
2696                </element>
2697                <element name="f3_mutDuplication" type="float" min="0" max="1" default="0.05">
2698                        <description><![CDATA[]]></description>
2699                </element>
2700                <element name="f3_mutSubstitution" type="float" min="0" max="1" default="0.6">
2701                        <description><![CDATA[]]></description>
2702                </element>
2703                <element name="f3_mutSubstPerChar" type="float" min="0" max="1" default="0.1">
2704                        <description><![CDATA[]]></description>
2705                </element>
2706                <element name="f3_mutTranslocation" type="float" min="0" max="1" default="0.15">
2707                        <description><![CDATA[]]></description>
2708                </element>
2709                <element name="f3_xovCrossingOver" type="float" min="0" max="1" default="0.2">
2710                        <description><![CDATA[]]></description>
2711                </element>
2712                <element name="f3_xovGeneTransfer" type="float" min="0" max="1" default="0.8">
2713                        <description><![CDATA[]]></description>
2714                </element>
2715                <element name="f4_mut_add" type="float" min="0" max="100" default="50">
2716                        <description><![CDATA[mutation: probability of adding a node]]></description>
2717                </element>
2718                <element name="f4_mut_add_conn" type="float" min="0" max="100" default="15">
2719                        <description><![CDATA[add node mutation: probability of adding a neural connection]]></description>
2720                </element>
2721                <element name="f4_mut_add_div" type="float" min="0" max="100" default="20">
2722                        <description><![CDATA[add node mutation: probability of adding a division]]></description>
2723                </element>
2724                <element name="f4_mut_add_neupar" type="float" min="0" max="100" default="5">
2725                        <description><![CDATA[add node mutation: probability of adding a neuron property/modifier]]></description>
2726                </element>
2727                <element name="f4_mut_add_rep" type="float" min="0" max="100" default="10">
2728                        <description><![CDATA[add node mutation: probability of adding a repetition]]></description>
2729                </element>
2730                <element name="f4_mut_add_simp" type="float" min="0" max="100" default="50">
2731                        <description><![CDATA[add node mutation: probability of adding a random, simple gene]]></description>
2732                </element>
2733                <element name="f4_mut_del" type="float" min="0" max="100" default="20">
2734                        <description><![CDATA[mutation: probability of deleting a node]]></description>
2735                </element>
2736                <element name="f4_mut_mod" type="float" min="0" max="100" default="30">
2737                        <description><![CDATA[mutation: probability of changing a node]]></description>
2738                </element>
2739                <element name="filecomm" type="integer" min="0" max="1" default="1">
2740                        <description><![CDATA[Display comments encountered in opened files]]></description>
2741                </element>
2742                <element name="gen_extmutinfo" type="integer" min="0" max="2" default="0">
2743                        <description><![CDATA[If active, information about employed mutation method will be stored in the 'info' field of each mutated genotype.]]></description>
2744                </element>
2745                <element name="gen_hilite" type="integer" min="0" max="1" default="1">
2746                        <description><![CDATA[Use colors for genes?
2747(slows down viewing/editing of huge genotypes)]]></description>
2748                </element>
2749                <element name="gen_hist" type="integer" min="0" max="1" default="0">
2750                        <description><![CDATA[Required for phylogenetic analysis]]></description>
2751                </element>
2752                <element name="genkonw0" type="integer" min="0" max="1">
2753                        <description><![CDATA[Original Framsticks genotype format]]></description>
2754                </element>
2755                <element name="genkonw1" type="integer" min="0" max="1">
2756                        <description><![CDATA[Similarity encoding]]></description>
2757                </element>
2758                <element name="genkonw2" type="integer" min="0" max="1">
2759                        <description><![CDATA[Biological encoding]]></description>
2760                </element>
2761                <element name="genkonw3" type="integer" min="0" max="1">
2762                        <description><![CDATA[Developmental encoding]]></description>
2763                </element>
2764                <element name="genolib" type="GenePools"/>
2765                <element name="genoper_f0" type="integer" min="0" max="1">
2766                        <description><![CDATA[]]></description>
2767                </element>
2768                <element name="genoper_f1" type="integer" min="0" max="0">
2769                        <description><![CDATA[]]></description>
2770                </element>
2771                <element name="genoper_f2" type="integer" min="0" max="0">
2772                        <description><![CDATA[]]></description>
2773                </element>
2774                <element name="genoper_f3" type="integer" min="0" max="0">
2775                        <description><![CDATA[]]></description>
2776                </element>
2777                <element name="genoper_f4" type="integer" min="0" max="0">
2778                        <description><![CDATA[]]></description>
2779                </element>
2780                <element name="groupchk" type="integer" min="0" max="1"/>
2781                <element name="importchk" type="integer" min="0" max="1"/>
2782                <element name="livelib" type="Populations"/>
2783                <element name="loadchk" type="integer" min="0" max="1"/>
2784                <element name="maxjoint" type="float" min="0" max="100" default="2"/>
2785                <element name="minjoint" type="float" min="0" max="100" default="0"/>
2786                <element name="neuadd_N" type="integer" min="0" max="1">
2787                        <description><![CDATA[Standard neuron
2788
2789Characteristics:
2790   supports any number of inputs
2791   provides output value
2792   does not require location in body
2793
2794
2795Properties:
2796   Inertia (in) float 0..1
2797   Force (fo) float 0..999
2798   Sigmoid (si) float -99999..99999
2799   State (s) float -1..1]]></description>
2800                </element>
2801                <element name="neuadd_Nu" type="integer" min="0" max="1">
2802                        <description><![CDATA[Works like standard neuron (N) but the output value is scaled to 0...+1 instead of -1...+1.
2803Having 0 as one of the saturation states should help in "gate circuits", where input signal is passed through or blocked depending on the other singal.
2804
2805Characteristics:
2806   supports any number of inputs
2807   provides output value
2808   does not require location in body
2809
2810
2811Properties:
2812   Inertia (in) float 0..1
2813   Force (fo) float 0..999
2814   Sigmoid (si) float -99999..99999
2815   State (s) float -1..1]]></description>
2816                </element>
2817                <element name="neuadd_G" type="integer" min="0" max="1">
2818                        <description><![CDATA[Equilibrium sensor.
28190=the stick is horizontal
2820+1/-1=the stick is vertical
2821
2822Characteristics:
2823   does not use inputs
2824   provides output value
2825   should be located on a Joint
2826]]></description>
2827                </element>
2828                <element name="neuadd_T" type="integer" min="0" max="1">
2829                        <description><![CDATA[Touch sensor.
2830-1=no contact
28310=just touching
2832>0=pressing, value depends on the force applied
2833
2834Characteristics:
2835   does not use inputs
2836   provides output value
2837   should be located on a Part
2838
2839
2840Properties:
2841   Range (r) float 0..1]]></description>
2842                </element>
2843                <element name="neuadd_S" type="integer" min="0" max="1">
2844                        <description><![CDATA[Smell sensor. Aggregated "smell of energy" experienced from all energy objects (creatures and food pieces).
2845Close objects have bigger influence than the distant ones: for each energy source, its partial feeling is proportional to its energy/(distance^2)
2846
2847Characteristics:
2848   does not use inputs
2849   provides output value
2850   should be located on a Part
2851]]></description>
2852                </element>
2853                <element name="neuadd_*" type="integer" min="0" max="1">
2854                        <description><![CDATA[Constant value
2855
2856Characteristics:
2857   does not use inputs
2858   provides output value
2859   does not require location in body
2860]]></description>
2861                </element>
2862                <element name="neuadd_|" type="integer" min="0" max="1">
2863                        <description><![CDATA[Characteristics:
2864   uses single input
2865   does not provide output value
2866   should be located on a Joint
2867
2868
2869Properties:
2870   power (p) float 0.01..1
2871   bending range (r) float 0..1]]></description>
2872                </element>
2873                <element name="neuadd_@" type="integer" min="0" max="1">
2874                        <description><![CDATA[Characteristics:
2875   uses single input
2876   does not provide output value
2877   should be located on a Joint
2878
2879
2880Properties:
2881   power (p) float 0.01..1]]></description>
2882                </element>
2883                <element name="neuadd_D" type="integer" min="0" max="1">
2884                        <description><![CDATA[Calculate the difference between the current and previous input value. Multiple inputs are aggregated with respect to their weights
2885
2886Characteristics:
2887   supports any number of inputs
2888   provides output value
2889   does not require location in body
2890]]></description>
2891                </element>
2892                <element name="neuadd_Fuzzy" type="integer" min="0" max="1">
2893                        <description><![CDATA[Refer to publications to learn more about this neuron.
2894
2895Characteristics:
2896   supports any number of inputs
2897   provides output value
2898   does not require location in body
2899
2900
2901Properties:
2902   number of fuzzy sets (ns) integer
2903   number of rules (nr) integer
2904   fuzzy sets (fs) string
2905   fuzzy rules (fr) string]]></description>
2906                </element>
2907                <element name="neuadd_VEye" type="integer" min="0" max="1">
2908                        <description><![CDATA[Refer to publications to learn more about this neuron.
2909
2910Characteristics:
2911   uses single input
2912   provides output value
2913   should be located on a Part
2914
2915
2916Properties:
2917   target.x (tx) float
2918   target.y (ty) float
2919   target.z (tz) float
2920   target shape (ts) string
2921   perspective (p) float 0.1..10
2922   scale (s) float 0.1..100
2923   show hidden lines (h) integer 0..1
2924   output lines count (each line needs four channels) (o) integer 0..99
2925   debug (d) integer 0..1]]></description>
2926                </element>
2927                <element name="neuadd_VMotor" type="integer" min="0" max="1">
2928                        <description><![CDATA[Must be connected to the VEye and properly set up. Refer to publications to learn more about this neuron.
2929
2930Characteristics:
2931   supports any number of inputs
2932   provides output value
2933   does not require location in body
2934
2935
2936Properties:
2937   number of basic features (noIF) integer
2938   number of degrees of freedom (noDim) integer
2939   parameters (params) string]]></description>
2940                </element>
2941                <element name="neuadd_Sti" type="integer" min="0" max="1">
2942                        <description><![CDATA[Characteristics:
2943   uses single input
2944   does not provide output value
2945   should be located on a Part
2946]]></description>
2947                </element>
2948                <element name="neuadd_LMu" type="integer" min="0" max="1">
2949                        <description><![CDATA[Characteristics:
2950   uses single input
2951   does not provide output value
2952   should be located on a Joint
2953
2954
2955Properties:
2956   power (p) float 0.01..1]]></description>
2957                </element>
2958                <element name="neuadd_Water" type="integer" min="0" max="1">
2959                        <description><![CDATA[Output signal:
29600=on or above water surface
29611=under water (deeper than 1)
29620..1=in the transient area just below water surface
2963
2964Characteristics:
2965   does not use inputs
2966   provides output value
2967   should be located on a Part
2968]]></description>
2969                </element>
2970                <element name="neuadd_Energy" type="integer" min="0" max="1">
2971                        <description><![CDATA[The current energy level divided by the initial energy level.
2972Usually falls from initial 1.0 down to 0.0 and then the creature dies. It can rise above 1.0 if enough food is ingested
2973
2974Characteristics:
2975   does not use inputs
2976   provides output value
2977   does not require location in body
2978]]></description>
2979                </element>
2980                <element name="neuadd_Ch" type="integer" min="0" max="1">
2981                        <description><![CDATA[Combines all input signals into a single multichannel output; Note: ChSel and ChMux are the only neurons which support multiple channels. Other neurons discard everything except the first channel.
2982
2983Characteristics:
2984   supports any number of inputs
2985   provides output value
2986   does not require location in body
2987]]></description>
2988                </element>
2989                <element name="neuadd_ChMux" type="integer" min="0" max="1">
2990                        <description><![CDATA[Outputs the selected channel from the second (multichannel) input. The first input is used as the selector value (-1=select first channel, .., 1=last channel)
2991
2992Characteristics:
2993   uses 2 inputs
2994   provides output value
2995   does not require location in body
2996]]></description>
2997                </element>
2998                <element name="neuadd_ChSel" type="integer" min="0" max="1">
2999                        <description><![CDATA[Outputs a single channel (selected by the "ch" parameter) from multichannel input
3000
3001Characteristics:
3002   uses single input
3003   provides output value
3004   does not require location in body
3005
3006
3007Properties:
3008   channel (ch) integer]]></description>
3009                </element>
3010                <element name="neuadd_Rnd" type="integer" min="0" max="1">
3011                        <description><![CDATA[Generates random noise (subsequent random values in the range of -1..+1)
3012
3013Characteristics:
3014   does not use inputs
3015   provides output value
3016   does not require location in body
3017]]></description>
3018                </element>
3019                <element name="neuadd_Sin" type="integer" min="0" max="1">
3020                        <description><![CDATA[Output frequency = f0+input
3021
3022Characteristics:
3023   uses single input
3024   provides output value
3025   does not require location in body
3026
3027
3028Properties:
3029   base frequency (f0) float -1..1
3030   time (t) float 0..6.28319]]></description>
3031                </element>
3032                <element name="ncl_N" type="integer" min="0" max="1">
3033                        <description><![CDATA[Standard neuron
3034
3035Characteristics:
3036   supports any number of inputs
3037   provides output value
3038   does not require location in body
3039
3040
3041Properties:
3042   Inertia (in) float 0..1
3043   Force (fo) float 0..999
3044   Sigmoid (si) float -99999..99999
3045   State (s) float -1..1]]></description>
3046                </element>
3047                <element name="ncl_Nu" type="integer" min="0" max="1">
3048                        <description><![CDATA[Works like standard neuron (N) but the output value is scaled to 0...+1 instead of -1...+1.
3049Having 0 as one of the saturation states should help in "gate circuits", where input signal is passed through or blocked depending on the other singal.
3050
3051Characteristics:
3052   supports any number of inputs
3053   provides output value
3054   does not require location in body
3055
3056
3057Properties:
3058   Inertia (in) float 0..1
3059   Force (fo) float 0..999
3060   Sigmoid (si) float -99999..99999
3061   State (s) float -1..1]]></description>
3062                </element>
3063                <element name="ncl_G" type="integer" min="0" max="1">
3064                        <description><![CDATA[Equilibrium sensor.
30650=the stick is horizontal
3066+1/-1=the stick is vertical
3067
3068Characteristics:
3069   does not use inputs
3070   provides output value
3071   should be located on a Joint
3072]]></description>
3073                </element>
3074                <element name="ncl_T" type="integer" min="0" max="1">
3075                        <description><![CDATA[Touch sensor.
3076-1=no contact
30770=just touching
3078>0=pressing, value depends on the force applied
3079
3080Characteristics:
3081   does not use inputs
3082   provides output value
3083   should be located on a Part
3084
3085
3086Properties:
3087   Range (r) float 0..1]]></description>
3088                </element>
3089                <element name="ncl_S" type="integer" min="0" max="1">
3090                        <description><![CDATA[Smell sensor. Aggregated "smell of energy" experienced from all energy objects (creatures and food pieces).
3091Close objects have bigger influence than the distant ones: for each energy source, its partial feeling is proportional to its energy/(distance^2)
3092
3093Characteristics:
3094   does not use inputs
3095   provides output value
3096   should be located on a Part
3097]]></description>
3098                </element>
3099                <element name="ncl_*" type="integer" min="0" max="1">
3100                        <description><![CDATA[Constant value
3101
3102Characteristics:
3103   does not use inputs
3104   provides output value
3105   does not require location in body
3106]]></description>
3107                </element>
3108                <element name="ncl_|" type="integer" min="0" max="1">
3109                        <description><![CDATA[Characteristics:
3110   uses single input
3111   does not provide output value
3112   should be located on a Joint
3113
3114
3115Properties:
3116   power (p) float 0.01..1
3117   bending range (r) float 0..1]]></description>
3118                </element>
3119                <element name="ncl_@" type="integer" min="0" max="1">
3120                        <description><![CDATA[Characteristics:
3121   uses single input
3122   does not provide output value
3123   should be located on a Joint
3124
3125
3126Properties:
3127   power (p) float 0.01..1]]></description>
3128                </element>
3129                <element name="ncl_D" type="integer" min="0" max="1">
3130                        <description><![CDATA[Calculate the difference between the current and previous input value. Multiple inputs are aggregated with respect to their weights
3131
3132Characteristics:
3133   supports any number of inputs
3134   provides output value
3135   does not require location in body
3136]]></description>
3137                </element>
3138                <element name="ncl_Fuzzy" type="integer" min="0" max="1">
3139                        <description><![CDATA[Refer to publications to learn more about this neuron.
3140
3141Characteristics:
3142   supports any number of inputs
3143   provides output value
3144   does not require location in body
3145
3146
3147Properties:
3148   number of fuzzy sets (ns) integer
3149   number of rules (nr) integer
3150   fuzzy sets (fs) string
3151   fuzzy rules (fr) string]]></description>
3152                </element>
3153                <element name="ncl_VEye" type="integer" min="0" max="1">
3154                        <description><![CDATA[Refer to publications to learn more about this neuron.
3155
3156Characteristics:
3157   uses single input
3158   provides output value
3159   should be located on a Part
3160
3161
3162Properties:
3163   target.x (tx) float
3164   target.y (ty) float
3165   target.z (tz) float
3166   target shape (ts) string
3167   perspective (p) float 0.1..10
3168   scale (s) float 0.1..100
3169   show hidden lines (h) integer 0..1
3170   output lines count (each line needs four channels) (o) integer 0..99
3171   debug (d) integer 0..1]]></description>
3172                </element>
3173                <element name="ncl_VMotor" type="integer" min="0" max="1">
3174                        <description><![CDATA[Must be connected to the VEye and properly set up. Refer to publications to learn more about this neuron.
3175
3176Characteristics:
3177   supports any number of inputs
3178   provides output value
3179   does not require location in body
3180
3181
3182Properties:
3183   number of basic features (noIF) integer
3184   number of degrees of freedom (noDim) integer
3185   parameters (params) string]]></description>
3186                </element>
3187                <element name="ncl_Sti" type="integer" min="0" max="1">
3188                        <description><![CDATA[Characteristics:
3189   uses single input
3190   does not provide output value
3191   should be located on a Part
3192]]></description>
3193                </element>
3194                <element name="ncl_LMu" type="integer" min="0" max="1">
3195                        <description><![CDATA[Characteristics:
3196   uses single input
3197   does not provide output value
3198   should be located on a Joint
3199
3200
3201Properties:
3202   power (p) float 0.01..1]]></description>
3203                </element>
3204                <element name="ncl_Water" type="integer" min="0" max="1">
3205                        <description><![CDATA[Output signal:
32060=on or above water surface
32071=under water (deeper than 1)
32080..1=in the transient area just below water surface
3209
3210Characteristics:
3211   does not use inputs
3212   provides output value
3213   should be located on a Part
3214]]></description>
3215                </element>
3216                <element name="ncl_Energy" type="integer" min="0" max="1">
3217                        <description><![CDATA[The current energy level divided by the initial energy level.
3218Usually falls from initial 1.0 down to 0.0 and then the creature dies. It can rise above 1.0 if enough food is ingested
3219
3220Characteristics:
3221   does not use inputs
3222   provides output value
3223   does not require location in body
3224]]></description>
3225                </element>
3226                <element name="ncl_Ch" type="integer" min="0" max="1">
3227                        <description><![CDATA[Combines all input signals into a single multichannel output; Note: ChSel and ChMux are the only neurons which support multiple channels. Other neurons discard everything except the first channel.
3228
3229Characteristics:
3230   supports any number of inputs
3231   provides output value
3232   does not require location in body
3233]]></description>
3234                </element>
3235                <element name="ncl_ChMux" type="integer" min="0" max="1">
3236                        <description><![CDATA[Outputs the selected channel from the second (multichannel) input. The first input is used as the selector value (-1=select first channel, .., 1=last channel)
3237
3238Characteristics:
3239   uses 2 inputs
3240   provides output value
3241   does not require location in body
3242]]></description>
3243                </element>
3244                <element name="ncl_ChSel" type="integer" min="0" max="1">
3245                        <description><![CDATA[Outputs a single channel (selected by the "ch" parameter) from multichannel input
3246
3247Characteristics:
3248   uses single input
3249   provides output value
3250   does not require location in body
3251
3252
3253Properties:
3254   channel (ch) integer]]></description>
3255                </element>
3256                <element name="ncl_Rnd" type="integer" min="0" max="1">
3257                        <description><![CDATA[Generates random noise (subsequent random values in the range of -1..+1)
3258
3259Characteristics:
3260   does not use inputs
3261   provides output value
3262   does not require location in body
3263]]></description>
3264                </element>
3265                <element name="ncl_Sin" type="integer" min="0" max="1">
3266                        <description><![CDATA[Output frequency = f0+input
3267
3268Characteristics:
3269   uses single input
3270   provides output value
3271   does not require location in body
3272
3273
3274Properties:
3275   base frequency (f0) float -1..1
3276   time (t) float 0..6.28319]]></description>
3277                </element>
3278                <element name="nnspeed" type="float" min="0" max="1000" default="1">
3279                        <description><![CDATA[Number of neural network simulation steps in each physics simulation step]]></description>
3280                </element>
3281                <element name="odeairdrag" type="float" min="0" max="0.5" default="0.01">
3282                        <description><![CDATA[A drag force ("air drag") proportional to the velocity of mass centers of moving parts]]></description>
3283                </element>
3284                <element name="odecol2bounce" type="float" min="0" max="1" default="0.1"/>
3285                <element name="odecol2bouncevel" type="float" min="0" max="1" default="0.01"/>
3286                <element name="odecol2mumax" type="float" min="0" max="10" default="1">
3287                        <description><![CDATA[Mu coefficient for Parts with maximal friction (i.e. "FFFFF" in f1)]]></description>
3288                </element>
3289                <element name="odecol2mumin" type="float" min="0" max="10" default="0.1">
3290                        <description><![CDATA[Mu coefficient for Parts with minimal friction (i.e. "fffff" in f1)]]></description>
3291                </element>
3292                <element name="odecol2softcfm" type="float" min="0" max="1" default="0"/>
3293                <element name="odecolbounce" type="float" min="0" max="1" default="0.1"/>
3294                <element name="odecolbouncevel" type="float" min="0" max="1" default="0.01"/>
3295                <element name="odecolmumax" type="float" min="0" max="10" default="5">
3296                        <description><![CDATA[Mu coefficient for Parts with maximal friction (i.e. "FFFFF" in f1)]]></description>
3297                </element>
3298                <element name="odecolmumin" type="float" min="0" max="10" default="0.1">
3299                        <description><![CDATA[Mu coefficient for Parts with minimal friction (i.e. "fffff" in f1)]]></description>
3300                </element>
3301                <element name="odecolsoftcfm" type="float" min="0" max="1" default="0"/>
3302                <element name="odemusclemax" type="float" min="0" max="100" default="10">
3303                        <description><![CDATA[i.e. "MMMMM" if f1]]></description>
3304                </element>
3305                <element name="odemusclemin" type="float" min="0" max="100" default="0">
3306                        <description><![CDATA[i.e. "mmmmm" in f1]]></description>
3307                </element>
3308                <element name="odemusclespeed" type="float" min="0" max="10" default="1">
3309                        <description><![CDATA[Muscle state cannot change faster than the supplied value]]></description>
3310                </element>
3311                <element name="odeseed" type="integer" min="0" max="2">
3312                        <description><![CDATA[Affects collisions.
3313- 'Truly random' is closest to the standard ODE operation. Use Math.seed to influence randomness in ODE collisions
3314- 'Deterministic' automatically calculates random seed in each step based on the current simulation (world) state, which makes the simulation repeatable but more random than 'Fixed'
3315- 'Fixed' is completely deterministic and does not depend on Math.seed. This might negatively affect ODE accuracy
3316]]></description>
3317                </element>
3318                <element name="odeshape" type="integer" min="0" max="1"/>
3319                <element name="odestep" type="float" min="0.001" max="1" default="0.05"/>
3320                <element name="odewaterbuoy" type="float" min="0" max="2" default="1"/>
3321                <element name="odewaterdrag" type="float" min="0.001" max="1" default="0.5"/>
3322                <element name="overwrite" type="integer" min="0" max="1">
3323                        <description><![CDATA[Overwite existing files or create their backups]]></description>
3324                </element>
3325                <element name="randinit" type="float" min="0" max="10" default="0.01">
3326                        <description><![CDATA[Initialize all neuron states with uniform distribution random numbers]]></description>
3327                </element>
3328                <element name="resetonexpdef" type="integer" min="0" max="1" default="1">
3329                        <description><![CDATA[If turned on: when a new experiment definition is selected, default values are loaded for most of the simulator parameters, and gene pools and populations are cleared.
3330When turned off: parameters from previous experiment definition will remain.]]></description>
3331                </element>
3332                <element name="running" type="integer" min="0" max="1">
3333                        <description><![CDATA[for synchronizing the user interface state]]></description>
3334                </element>
3335                <element name="signals" type="WorldSignals"/>
3336                <element name="simil_method" type="integer" min="0" max="1" default="0">
3337                        <description><![CDATA[]]></description>
3338                </element>
3339                <element name="simil_neuro" type="float" min="0" max="100" default="0.5">
3340                        <description><![CDATA[]]></description>
3341                </element>
3342                <element name="simil_partdeg" type="float" min="0" max="100" default="1">
3343                        <description><![CDATA[]]></description>
3344                </element>
3345                <element name="simil_parts" type="float" min="0" max="100" default="0">
3346                        <description><![CDATA[Differing number of parts is also handled by the 'part degree' similarity component.]]></description>
3347                </element>
3348                <element name="simspeed" type="integer">
3349                        <description><![CDATA[steps/second]]></description>
3350                </element>
3351                <element name="simtype" type="integer" min="0" max="1" default="0">
3352                        <description><![CDATA[MechaStick is a fast and simple primary Framsticks simulation engine.
3353ODE is Open Dynamics Engine by Russel Smith et al.
3354
3355NOTE: switching between simulation engines causes removal of all objects in the world (e.g. creatures).]]></description>
3356                </element>
3357                <element name="symAlphaSteps" type="integer" min="2" max="50" default="20">
3358                        <description><![CDATA[Default number of samples per full angle (#1)]]></description>
3359                </element>
3360                <element name="symBetaSteps" type="integer" min="2" max="50" default="20">
3361                        <description><![CDATA[Default number of samples per full angle (#2)]]></description>
3362                </element>
3363                <element name="symPosSteps" type="integer" min="2" max="50" default="10">
3364                        <description><![CDATA[Default number of samples per stick length]]></description>
3365                </element>
3366                <element name="symResultA" type="float"/>
3367                <element name="symResultB" type="float"/>
3368                <element name="symResultC" type="float"/>
3369                <element name="symResultD" type="float"/>
3370                <element name="time" type="integer"/>
3371                <element name="touchrange" type="float" min="0" max="100" default="1"/>
3372                <element name="usercode" type="string">
3373                        <description><![CDATA[This script overrides the experiment definition]]></description>
3374                </element>
3375                <element name="vmdebug" type="integer" min="0" max="1"/>
3376                <element name="world" type="World"/>
3377                <element name="wrldbnd" type="integer" min="0" max="2" default="1"/>
3378                <element name="wrldg" type="float" min="0" max="10" default="1">
3379                        <description><![CDATA[You can adjust gravity for your experiments.
3380The "official" setting used to evaluate and compare creatures is 1.]]></description>
3381                </element>
3382                <element name="wrldmap" type="string">
3383                        <description><![CDATA[Description of the world (Type: Blocks or Heighfield). Enter
3384   r <sizex> <sizey> [seed]
3385to generate a random landscape, or
3386   m <sizex> <sizey> digits
3387   M <sizex> <sizey> numbers
3388to provide height values.
3389
3390See also the WorldMap object.]]></description>
3391                </element>
3392                <element name="wrldsiz" type="float" min="10" max="1000" default="20">
3393                        <description><![CDATA[Side length of the world]]></description>
3394                </element>
3395                <element name="wrldtyp" type="integer" min="0" max="2" default="0"/>
3396                <element name="wrldwat" type="float" min="-20" max="30" default="-1"/>
3397                <element name="add" function="true"/>
3398                <element name="addGroup" function="true"/>
3399                <element name="beep" function="true" type="void">
3400                        <description><![CDATA[Plays a default system sound]]></description>
3401<arguments/></element>
3402                <element name="calculateSymmetry" function="true" type="float">
3403                        <description><![CDATA[Returns bilateral symmetry (0.0 .. 1.0) for a given Model using default precision parameters (symPosSteps,symAlphaSteps,symBetaSteps). Returns the symmetry plane, too (sets symResultA,B,C,D).
3404Note: may take a long time for large creatures.]]></description>
3405                        <arguments>
3406                                <argument name="model" type="Model"/>
3407                        </arguments>
3408                </element>
3409                <element name="calculateSymmetry2" function="true" type="float">
3410                        <description><![CDATA[Returns bilateral symmetry (0.0 .. 1.0) for a given Model using specified precision parameters. Returns the symmetry plane, too (sets symResultA,B,C,D).
3411Note: may take a long time for large creatures.]]></description>
3412                        <arguments>
3413                                <argument name="model" type="Model"/>
3414                                <argument name="posSteps" type="integer"/>
3415                                <argument name="alphaSteps" type="integer"/>
3416                                <argument name="betaSteps" type="integer"/>
3417                        </arguments>
3418                </element>
3419                <element name="calculateSymmetryForPlane" function="true" type="float">
3420                        <description><![CDATA[Returns bilateral symmetry (0.0 .. 1.0) for a given Model and given a specific plane defined by coefficients A, B, C, D.]]></description>
3421                        <arguments>
3422                                <argument name="model" type="Model"/>
3423                                <argument name="A" type="float"/>
3424                                <argument name="B" type="float"/>
3425                                <argument name="C" type="float"/>
3426                                <argument name="D" type="float"/>
3427                        </arguments>
3428                </element>
3429                <element name="checkpoint" function="true" type="void">
3430                        <description><![CDATA[This function was previously called "autosave".]]></description>
3431<arguments/></element>
3432                <element name="clear" function="true"/>
3433                <element name="crossOver" function="true" type="Geno">
3434                        <description><![CDATA[returns crossed over genotype]]></description>
3435                        <arguments>
3436                                <argument type="Geno"/>
3437                                <argument type="Geno"/>
3438                        </arguments>
3439                </element>
3440                <element name="eval" function="true" type="void">
3441                        <arguments>
3442                                <argument name="script expression" type="string"/>
3443                        </arguments>
3444                </element>
3445                <element name="evaluateDistance" function="true" type="float">
3446                        <description><![CDATA[calculate dissimilarity between two models created from Geno objects]]></description>
3447                        <arguments>
3448                                <argument type="Geno"/>
3449                                <argument type="Geno"/>
3450                        </arguments>
3451                </element>
3452                <element name="export" function="true" type="void">
3453                        <description><![CDATA[Save some data to file. arguments:
3454- filename
3455- flags: composed of the following bit values:
3456   1 - experiment (works like "save" and all other bits are ignored)
3457   2 - genotypes
3458   4 - simulator parameters
3459   8 - simulator stats
3460   16 - genepool settings
3461   32 - population settings
3462   64 - do autosave
3463- selected genepool
3464- selected population]]></description>
3465                        <arguments>
3466                                <argument name="filename" type="string"/>
3467                                <argument name="options" type="integer"/>
3468                                <argument name="genepool" type="integer"/>
3469                                <argument name="population" type="integer"/>
3470                        </arguments>
3471                </element>
3472                <element name="getSimplest" function="true" type="Geno">
3473                        <description><![CDATA[returns the simplest genotype for a given encoding (format). 0 means f0, 4 means f4, etc.]]></description>
3474                        <arguments>
3475                                <argument name="format" type="integer"/>
3476                        </arguments>
3477                </element>
3478                <element name="import" function="true" type="void">
3479                        <description><![CDATA[Load some data from file. The second optional argument selects what section(s) will be imported:
3480 1 - experiment (works like "load" and can reset the simulator state!)
3481 2 - genotypes
3482 4 - simulator parameters
3483 8 - genepool settings
3484 16 - population settings
3485 32 - new groups will be created for imported genepools and populations
348664 - allow switching to a different expdef while importing parameters (4)
3487
3488The standard behavior (without the second argument) is to import genotypes, parameters, and genepool and population settings (2+4+8+16). Note that "64" is not included by default, because the expdef change resets all simulator parameters, which contradicts the usual meaning of "import" in Framsticks ("add data", as opposed to "load" meaning "replace data"). Moreover, using the "64" option in scripts can be dengerous, especially all expdef and show scripts should always declare the proper expdef name in their header rather than change the expdef directly. Without the "64" option, it is always safe to "import" any file in a script regardless of the current simulator state.]]></description>
3489                        <arguments>
3490                                <argument name="filename" type="string"/>
3491                                <argument name="options" type="integer"/>
3492                        </arguments>
3493                </element>
3494                <element name="init" function="true" type="void">
3495                        <description><![CDATA[Performs initialization procedures, like resetting counters, states, gene pools, etc.]]></description>
3496<arguments/></element>
3497                <element name="load" function="true" type="void">
3498                        <description><![CDATA[Load experiment file (calls onExpLoad() in the current experiment definition). This function is intended to replace the simulator state; the old state is cleared by automatically calling "resetToDefaults()" (only if "resetonexpdef" is enabled). Use "import" if you don't want to loose the old simulator state.]]></description>
3499                        <arguments>
3500                                <argument name="filename" type="string"/>
3501                        </arguments>
3502                </element>
3503                <element name="loadexpdef" function="true" type="void"><arguments/></element>
3504                <element name="loadNeurons" function="true" type="void">
3505                        <arguments>
3506                                <argument name="directory path" type="string"/>
3507                        </arguments>
3508                </element>
3509                <element name="message" function="true" type="void">
3510                        <description><![CDATA[The second argument can be:
3511 -1 = debugging message
3512 0 = information
3513 1 = warning
3514 2 = error
3515 3 = critical error]]></description>
3516                        <arguments>
3517                                <argument name="text" type="string"/>
3518                                <argument name="level" type="integer"/>
3519                        </arguments>
3520                </element>
3521                <element name="mutate" function="true" type="Geno">
3522                        <description><![CDATA[returns mutated Geno object from supplied Geno]]></description>
3523                        <arguments>
3524                                <argument type="Geno"/>
3525                        </arguments>
3526                </element>
3527                <element name="new" function="true" type="Simulator"><arguments/></element>
3528                <element name="operReport" function="true" type="void">
3529                        <description><![CDATA[Show available genetic operators]]></description>
3530<arguments/></element>
3531                <element name="print" function="true" type="void">
3532                        <description><![CDATA[One argument: message to be printed]]></description>
3533                        <arguments>
3534                                <argument name="text" type="string"/>
3535                        </arguments>
3536                </element>
3537                <element name="rayIntersection" function="true" type="float">
3538                        <arguments>
3539                                <argument name="position x" type="float"/>
3540                                <argument name="position y" type="float"/>
3541                                <argument name="position z" type="float"/>
3542                                <argument name="direction x" type="float"/>
3543                                <argument name="direction y" type="float"/>
3544                                <argument name="direction z" type="float"/>
3545                                <argument name="max distance" type="float"/>
3546                        </arguments>
3547                </element>
3548                <element name="remove" function="true"/>
3549                <element name="removeGroup" function="true"/>
3550                <element name="resetToDefaults" function="true" type="void">
3551                        <description><![CDATA[Clears groups and loads default values for simulator parameters, then calls onExpDefLoad() of the current experiment definition.]]></description>
3552<arguments/></element>
3553                <element name="save" function="true" type="void">
3554                        <description><![CDATA[Save experiment file (calls onExpSave() in the current experiment definition)]]></description>
3555                        <arguments>
3556                                <argument name="filename" type="string"/>
3557                        </arguments>
3558                </element>
3559                <element name="sleep" function="true" type="void">
3560                        <description><![CDATA[Suspends the execution for a specified interval]]></description>
3561                        <arguments>
3562                                <argument name="milliseconds" type="integer"/>
3563                        </arguments>
3564                </element>
3565                <element name="sound" function="true" type="void">
3566                        <description><![CDATA[Generates a simple tone on the speaker]]></description>
3567                        <arguments>
3568                                <argument name="freqency in Hz" type="integer"/>
3569                                <argument name="length in milliseconds" type="integer"/>
3570                        </arguments>
3571                </element>
3572                <element name="start" function="true" type="void">
3573                        <description><![CDATA[called by the user interface]]></description>
3574<arguments/></element>
3575                <element name="step" function="true" type="void"><arguments/></element>
3576                <element name="stop" function="true" type="void">
3577                        <description><![CDATA[the expdef script calls this to stop simulation]]></description>
3578<arguments/></element>
3579                <element name="toHTML" function="true" type="string">
3580                        <description><![CDATA[returns genotype expressed as colored HTML]]></description>
3581                        <arguments>
3582                                <argument type="string"/>
3583                        </arguments>
3584                </element>
3585                <element name="toHTMLshort" function="true" type="string">
3586                        <description><![CDATA[returns genotype (abbreviated if needed) expressed as colored HTML]]></description>
3587                        <arguments>
3588                                <argument type="string"/>
3589                        </arguments>
3590                </element>
3591                <element name="validate" function="true" type="Geno">
3592                        <description><![CDATA[returns validated (if possible) Geno object from supplied Geno]]></description>
3593                        <arguments>
3594                                <argument type="Geno"/>
3595                        </arguments>
3596                </element>
3597                <element name="wrldchg" function="true" type="void"><arguments/></element>
3598        </type>
3599        <type name="Similarity" context="Global context">
3600                <element name="simil_method" type="integer" min="0" max="1" default="0">
3601                        <description><![CDATA[]]></description>
3602                </element>
3603                <element name="simil_neuro" type="float" min="0" max="100" default="0.5">
3604                        <description><![CDATA[]]></description>
3605                </element>
3606                <element name="simil_partdeg" type="float" min="0" max="100" default="1">
3607                        <description><![CDATA[]]></description>
3608                </element>
3609                <element name="simil_parts" type="float" min="0" max="100" default="0">
3610                        <description><![CDATA[Differing number of parts is also handled by the 'part degree' similarity component.]]></description>
3611                </element>
3612                <element name="evaluateDistance" function="true" type="float">
3613                        <description><![CDATA[calculate dissimilarity between two models created from Geno objects]]></description>
3614                        <arguments>
3615                                <argument type="Geno"/>
3616                                <argument type="Geno"/>
3617                        </arguments>
3618                </element>
3619        </type>
3620        <type name="Simulator" context="Global context">
3621<description><![CDATA[The Framsticks simulator.]]></description>
3622                <element name="autosaveperiod" type="integer" min="0" max="100000">
3623                        <description><![CDATA[Save simulation state once every n-th event
3624(events are defined by the script. For 'standard.expdef' it is after each death).
3625Save EXPT file first to initialize name for autosave files.]]></description>
3626                </element>
3627                <element name="createrr" type="integer" min="0" max="2" default="1"/>
3628                <element name="creatwarnfail" type="integer" min="0" max="1">
3629                        <description><![CDATA[Creatures grown with warnings will not be simulated.]]></description>
3630                </element>
3631                <element name="expdef" type="string">
3632                        <description><![CDATA[Choose the experiment framework
3633(in Windows GUI, confirm by pressing 'Apply')
3634
3635Stop the simulation before selecting another experiment definition.
3636It is a good practice to initialize the experiment before running the simulation.]]></description>
3637                </element>
3638                <element name="expdef_info" type="string"/>
3639                <element name="expdef_title" type="string"/>
3640                <element name="filecomm" type="integer" min="0" max="1" default="1">
3641                        <description><![CDATA[Display comments encountered in opened files]]></description>
3642                </element>
3643                <element name="genolib" type="GenePools"/>
3644                <element name="groupchk" type="integer" min="0" max="1"/>
3645                <element name="importchk" type="integer" min="0" max="1"/>
3646                <element name="livelib" type="Populations"/>
3647                <element name="loadchk" type="integer" min="0" max="1"/>
3648                <element name="maxjoint" type="float" min="0" max="100" default="2"/>
3649                <element name="minjoint" type="float" min="0" max="100" default="0"/>
3650                <element name="overwrite" type="integer" min="0" max="1">
3651                        <description><![CDATA[Overwite existing files or create their backups]]></description>
3652                </element>
3653                <element name="resetonexpdef" type="integer" min="0" max="1" default="1">
3654                        <description><![CDATA[If turned on: when a new experiment definition is selected, default values are loaded for most of the simulator parameters, and gene pools and populations are cleared.
3655When turned off: parameters from previous experiment definition will remain.]]></description>
3656                </element>
3657                <element name="running" type="integer" min="0" max="1">
3658                        <description><![CDATA[for synchronizing the user interface state]]></description>
3659                </element>
3660                <element name="simspeed" type="integer">
3661                        <description><![CDATA[steps/second]]></description>
3662                </element>
3663                <element name="time" type="integer"/>
3664                <element name="usercode" type="string">
3665                        <description><![CDATA[This script overrides the experiment definition]]></description>
3666                </element>
3667                <element name="vmdebug" type="integer" min="0" max="1"/>
3668                <element name="world" type="World"/>
3669                <element name="beep" function="true" type="void">
3670                        <description><![CDATA[Plays a default system sound]]></description>
3671<arguments/></element>
3672                <element name="checkpoint" function="true" type="void">
3673                        <description><![CDATA[This function was previously called "autosave".]]></description>
3674<arguments/></element>
3675                <element name="eval" function="true" type="void">
3676                        <arguments>
3677                                <argument name="script expression" type="string"/>
3678                        </arguments>
3679                </element>
3680                <element name="export" function="true" type="void">
3681                        <description><![CDATA[Save some data to file. arguments:
3682- filename
3683- flags: composed of the following bit values:
3684   1 - experiment (works like "save" and all other bits are ignored)
3685   2 - genotypes
3686   4 - simulator parameters
3687   8 - simulator stats
3688   16 - genepool settings
3689   32 - population settings
3690   64 - do autosave
3691- selected genepool
3692- selected population]]></description>
3693                        <arguments>
3694                                <argument name="filename" type="string"/>
3695                                <argument name="options" type="integer"/>
3696                                <argument name="genepool" type="integer"/>
3697                                <argument name="population" type="integer"/>
3698                        </arguments>
3699                </element>
3700                <element name="import" function="true" type="void">
3701                        <description><![CDATA[Load some data from file. The second optional argument selects what section(s) will be imported:
3702 1 - experiment (works like "load" and can reset the simulator state!)
3703 2 - genotypes
3704 4 - simulator parameters
3705 8 - genepool settings
3706 16 - population settings
3707 32 - new groups will be created for imported genepools and populations
370864 - allow switching to a different expdef while importing parameters (4)
3709
3710The standard behavior (without the second argument) is to import genotypes, parameters, and genepool and population settings (2+4+8+16). Note that "64" is not included by default, because the expdef change resets all simulator parameters, which contradicts the usual meaning of "import" in Framsticks ("add data", as opposed to "load" meaning "replace data"). Moreover, using the "64" option in scripts can be dengerous, especially all expdef and show scripts should always declare the proper expdef name in their header rather than change the expdef directly. Without the "64" option, it is always safe to "import" any file in a script regardless of the current simulator state.]]></description>
3711                        <arguments>
3712                                <argument name="filename" type="string"/>
3713                                <argument name="options" type="integer"/>
3714                        </arguments>
3715                </element>
3716                <element name="init" function="true" type="void">
3717                        <description><![CDATA[Performs initialization procedures, like resetting counters, states, gene pools, etc.]]></description>
3718<arguments/></element>
3719                <element name="load" function="true" type="void">
3720                        <description><![CDATA[Load experiment file (calls onExpLoad() in the current experiment definition). This function is intended to replace the simulator state; the old state is cleared by automatically calling "resetToDefaults()" (only if "resetonexpdef" is enabled). Use "import" if you don't want to loose the old simulator state.]]></description>
3721                        <arguments>
3722                                <argument name="filename" type="string"/>
3723                        </arguments>
3724                </element>
3725                <element name="loadexpdef" function="true" type="void"><arguments/></element>
3726                <element name="loadNeurons" function="true" type="void">
3727                        <arguments>
3728                                <argument name="directory path" type="string"/>
3729                        </arguments>
3730                </element>
3731                <element name="message" function="true" type="void">
3732                        <description><![CDATA[The second argument can be:
3733 -1 = debugging message
3734 0 = information
3735 1 = warning
3736 2 = error
3737 3 = critical error]]></description>
3738                        <arguments>
3739                                <argument name="text" type="string"/>
3740                                <argument name="level" type="integer"/>
3741                        </arguments>
3742                </element>
3743                <element name="new" function="true" type="Simulator"><arguments/></element>
3744                <element name="print" function="true" type="void">
3745                        <description><![CDATA[One argument: message to be printed]]></description>
3746                        <arguments>
3747                                <argument name="text" type="string"/>
3748                        </arguments>
3749                </element>
3750                <element name="resetToDefaults" function="true" type="void">
3751                        <description><![CDATA[Clears groups and loads default values for simulator parameters, then calls onExpDefLoad() of the current experiment definition.]]></description>
3752<arguments/></element>
3753                <element name="save" function="true" type="void">
3754                        <description><![CDATA[Save experiment file (calls onExpSave() in the current experiment definition)]]></description>
3755                        <arguments>
3756                                <argument name="filename" type="string"/>
3757                        </arguments>
3758                </element>
3759                <element name="sleep" function="true" type="void">
3760                        <description><![CDATA[Suspends the execution for a specified interval]]></description>
3761                        <arguments>
3762                                <argument name="milliseconds" type="integer"/>
3763                        </arguments>
3764                </element>
3765                <element name="sound" function="true" type="void">
3766                        <description><![CDATA[Generates a simple tone on the speaker]]></description>
3767                        <arguments>
3768                                <argument name="freqency in Hz" type="integer"/>
3769                                <argument name="length in milliseconds" type="integer"/>
3770                        </arguments>
3771                </element>
3772                <element name="start" function="true" type="void">
3773                        <description><![CDATA[called by the user interface]]></description>
3774<arguments/></element>
3775                <element name="step" function="true" type="void"><arguments/></element>
3776                <element name="stop" function="true" type="void">
3777                        <description><![CDATA[the expdef script calls this to stop simulation]]></description>
3778<arguments/></element>
3779        </type>
3780        <type name="stats" context="Global context">
3781                <element name="changedProperty" type="integer"/>
3782                <element name="changedPropertyId" type="string"/>
3783                <element name="gen_count" type="integer">
3784                        <description><![CDATA[]]></description>
3785                </element>
3786                <element name="gen_mfailed" type="integer">
3787                        <description><![CDATA[couldn't be performed]]></description>
3788                </element>
3789                <element name="gen_minvalid" type="integer">
3790                        <description><![CDATA[couldn't be repaired]]></description>
3791                </element>
3792                <element name="gen_mutimpr" type="float">
3793                        <description><![CDATA[total cumulative mutation change]]></description>
3794                </element>
3795                <element name="gen_mvalid" type="integer">
3796                        <description><![CDATA[]]></description>
3797                </element>
3798                <element name="gen_mvalidated" type="integer">
3799                        <description><![CDATA[]]></description>
3800                </element>
3801                <element name="gen_xofailed" type="integer">
3802                        <description><![CDATA[couldn't be performed]]></description>
3803                </element>
3804                <element name="gen_xoimpr" type="float">
3805                        <description><![CDATA[total cumulative crossover change]]></description>
3806                </element>
3807                <element name="gen_xoinvalid" type="integer">
3808                        <description><![CDATA[couldn't be repaired]]></description>
3809                </element>
3810                <element name="gen_xovalid" type="integer">
3811                        <description><![CDATA[]]></description>
3812                </element>
3813                <element name="gen_xovalidated" type="integer">
3814                        <description><![CDATA[]]></description>
3815                </element>
3816                <element name="st_avg_c_velocity" type="float"/>
3817                <element name="st_avg_c_vertpos" type="float"/>
3818                <element name="st_avg_c_vertvelocity" type="float"/>
3819                <element name="st_avg_center_x" type="float"/>
3820                <element name="st_avg_center_y" type="float"/>
3821                <element name="st_avg_center_z" type="float"/>
3822                <element name="st_avg_distance" type="float"/>
3823                <element name="st_avg_fit" type="float"/>
3824                <element name="st_avg_fit2" type="float"/>
3825                <element name="st_avg_gnum" type="float"/>
3826                <element name="st_avg_instances" type="float"/>
3827                <element name="st_avg_lifespan" type="float"/>
3828                <element name="st_avg_num" type="float"/>
3829                <element name="st_avg_numconnections" type="float"/>
3830                <element name="st_avg_numjoints" type="float"/>
3831                <element name="st_avg_numneurons" type="float"/>
3832                <element name="st_avg_numparts" type="float"/>
3833                <element name="st_avg_pos_x" type="float"/>
3834                <element name="st_avg_pos_y" type="float"/>
3835                <element name="st_avg_pos_z" type="float"/>
3836                <element name="st_avg_size_x" type="float"/>
3837                <element name="st_avg_size_y" type="float"/>
3838                <element name="st_avg_size_z" type="float"/>
3839                <element name="st_avg_velocity" type="float"/>
3840                <element name="st_avg_vertpos" type="float"/>
3841                <element name="st_avg_vertvel" type="float"/>
3842                <element name="st_count" type="integer"/>
3843                <element name="st_max_c_velocity" type="float"/>
3844                <element name="st_max_c_vertpos" type="float"/>
3845                <element name="st_max_c_vertvelocity" type="float"/>
3846                <element name="st_max_center_x" type="float"/>
3847                <element name="st_max_center_y" type="float"/>
3848                <element name="st_max_center_z" type="float"/>
3849                <element name="st_max_distance" type="float"/>
3850                <element name="st_max_fit" type="float"/>
3851                <element name="st_max_fit2" type="float"/>
3852                <element name="st_max_gnum" type="float"/>
3853                <element name="st_max_instances" type="float"/>
3854                <element name="st_max_lifespan" type="float"/>
3855                <element name="st_max_num" type="float"/>
3856                <element name="st_max_numconnections" type="float"/>
3857                <element name="st_max_numjoints" type="float"/>
3858                <element name="st_max_numneurons" type="float"/>
3859                <element name="st_max_numparts" type="float"/>
3860                <element name="st_max_pos_x" type="float"/>
3861                <element name="st_max_pos_y" type="float"/>
3862                <element name="st_max_pos_z" type="float"/>
3863                <element name="st_max_size_x" type="float"/>
3864                <element name="st_max_size_y" type="float"/>
3865                <element name="st_max_size_z" type="float"/>
3866                <element name="st_max_velocity" type="float"/>
3867                <element name="st_max_vertpos" type="float"/>
3868                <element name="st_max_vertvel" type="float"/>
3869                <element name="st_min_c_velocity" type="float"/>
3870                <element name="st_min_c_vertpos" type="float"/>
3871                <element name="st_min_c_vertvelocity" type="float"/>
3872                <element name="st_min_center_x" type="float"/>
3873                <element name="st_min_center_y" type="float"/>
3874                <element name="st_min_center_z" type="float"/>
3875                <element name="st_min_distance" type="float"/>
3876                <element name="st_min_fit" type="float"/>
3877                <element name="st_min_fit2" type="float"/>
3878                <element name="st_min_gnum" type="float"/>
3879                <element name="st_min_instances" type="float"/>
3880                <element name="st_min_lifespan" type="float"/>
3881                <element name="st_min_num" type="float"/>
3882                <element name="st_min_numconnections" type="float"/>
3883                <element name="st_min_numjoints" type="float"/>
3884                <element name="st_min_numneurons" type="float"/>
3885                <element name="st_min_numparts" type="float"/>
3886                <element name="st_min_pos_x" type="float"/>
3887                <element name="st_min_pos_y" type="float"/>
3888                <element name="st_min_pos_z" type="float"/>
3889                <element name="st_min_size_x" type="float"/>
3890                <element name="st_min_size_y" type="float"/>
3891                <element name="st_min_size_z" type="float"/>
3892                <element name="st_min_velocity" type="float"/>
3893                <element name="st_min_vertpos" type="float"/>
3894                <element name="st_min_vertvel" type="float"/>
3895                <element name="add" function="true"/>
3896                <element name="addGroup" function="true"/>
3897                <element name="clear" function="true"/>
3898                <element name="clrstats" function="true" type="void">
3899                        <description><![CDATA[]]></description>
3900<arguments/></element>
3901                <element name="remove" function="true"/>
3902                <element name="removeGroup" function="true"/>
3903        </type>
3904        <type name="String" context="Global context">
3905<description><![CDATA[String functions library.]]></description>
3906                <element name="char" function="true" type="string">
3907                        <arguments>
3908                                <argument type="integer"/>
3909                        </arguments>
3910                </element>
3911                <element name="code" function="true" type="integer">
3912                        <arguments>
3913                                <argument type="string"/>
3914                        </arguments>
3915                </element>
3916                <element name="format" function="true" type="string">
3917                        <description><![CDATA[Works like the standard C library "sprintf()" but only one %-argument is accepted.
3918Format string: %[-][+][0][width[.precision]]type
3919 -: left adjust (default is right adjust)
3920 +: place a sign (+ or -) before a number
3921 0: the value should be zero padded
3922 width: minimum field width
3923 precision: minimum number of decimal digits
3924 type: d=decimal integer, x/X=hexadecimal integer, f/g=floating point number, e="scientific" style floating point, t=time
3925Examples:
3926 String.format("|%07.2f|",Math.pi) -> ="|0003.14|"
3927 String.format("|%04x|",255) -> ="|00ff|"
3928 String.format("|%7s|","text") -> ="|   text|"
3929 String.format("|%-7d|",12345) -> ="|12345  |"
3930 String.format("%t",Math.time) -> ="Sun Apr 29 19:22:02 2007"
3931 String.format("%T",Math.time) -> ="2007-05-29 19:22:02"
3932]]></description>
3933                        <arguments>
3934                                <argument name="format" type="string"/>
3935                                <argument name="value" type="untyped"/>
3936                        </arguments>
3937                </element>
3938                <element name="indexOf" function="true" type="integer">
3939                        <description><![CDATA[String.indexOf("abcdef","cd") -> 2
3940String.indexOf("abcdef","dc") -> -1
3941]]></description>
3942                        <arguments>
3943                                <argument type="string"/>
3944                                <argument name="substring" type="string"/>
3945                        </arguments>
3946                </element>
3947                <element name="indexOfStart" function="true" type="integer">
3948                        <description><![CDATA[String.indexOfStart("abcdef","cd",1) -> 2
3949String.indexOfStart("abcdef","cd",3) -> -1
3950]]></description>
3951                        <arguments>
3952                                <argument type="string"/>
3953                                <argument name="substring" type="string"/>
3954                                <argument name="start index" type="integer"/>
3955                        </arguments>
3956                </element>
3957                <element name="left" function="true" type="string">
3958                        <description><![CDATA[String.left("abcdef",3) -> ="abc"]]></description>
3959                        <arguments>
3960                                <argument type="string"/>
3961                                <argument name="number of characters" type="integer"/>
3962                        </arguments>
3963                </element>
3964                <element name="len" function="true" type="integer">
3965                        <description><![CDATA[String.len("abcdef") -> 6]]></description>
3966                        <arguments>
3967                                <argument type="string"/>
3968                        </arguments>
3969                </element>
3970                <element name="parseFloat" function="true" type="float">
3971                        <arguments>
3972                                <argument type="string"/>
3973                        </arguments>
3974                </element>
3975                <element name="parseInt" function="true" type="integer">
3976                        <arguments>
3977                                <argument type="string"/>
3978                        </arguments>
3979                </element>
3980                <element name="replace" function="true" type="string">
3981                        <description><![CDATA[String.replace("abcdef","cd","X") -> "abXef"]]></description>
3982                        <arguments>
3983                                <argument name="search" type="string"/>
3984                                <argument name="substitute" type="string"/>
3985                        </arguments>
3986                </element>
3987                <element name="right" function="true" type="string">
3988                        <description><![CDATA[String.right("abcdef",3) -> ="def"]]></description>
3989                        <arguments>
3990                                <argument type="string"/>
3991                                <argument name="number of characters" type="integer"/>
3992                        </arguments>
3993                </element>
3994                <element name="split" function="true" type="Vector">
3995                        <description><![CDATA[return the vector of substrings, cut at separator positions.
3996subsequent separators give empty words: split("word1---word2-word3","-") -> ["word1","","","word2","word3"]]]></description>
3997                        <arguments>
3998                                <argument type="string"/>
3999                                <argument name="word separator" type="string"/>
4000                        </arguments>
4001                </element>
4002                <element name="split2" function="true" type="Vector">
4003                        <description><![CDATA[return the vector of substrings, cut at separator positions.
4004subsequent separators are treated as one: split2("word1---word2-word3","-") -> ["word1","word2","word3"]]]></description>
4005                        <arguments>
4006                                <argument type="string"/>
4007                                <argument name="word separator" type="string"/>
4008                        </arguments>
4009                </element>
4010                <element name="substr" function="true" type="string">
4011                        <description><![CDATA[String.substr("abcdef",3,2) -> ="de"]]></description>
4012                        <arguments>
4013                                <argument type="string"/>
4014                                <argument name="first character" type="integer"/>
4015                                <argument name="number of characters" type="integer"/>
4016                        </arguments>
4017                </element>
4018                <element name="toLower" function="true" type="string">
4019                        <arguments>
4020                                <argument type="string"/>
4021                        </arguments>
4022                </element>
4023                <element name="toUpper" function="true" type="string">
4024                        <arguments>
4025                                <argument type="string"/>
4026                        </arguments>
4027                </element>
4028        </type>
4029        <type name="Symmetry" context="Global context">
4030                <element name="symAlphaSteps" type="integer" min="2" max="50" default="20">
4031                        <description><![CDATA[Default number of samples per full angle (#1)]]></description>
4032                </element>
4033                <element name="symBetaSteps" type="integer" min="2" max="50" default="20">
4034                        <description><![CDATA[Default number of samples per full angle (#2)]]></description>
4035                </element>
4036                <element name="symPosSteps" type="integer" min="2" max="50" default="10">
4037                        <description><![CDATA[Default number of samples per stick length]]></description>
4038                </element>
4039                <element name="symResultA" type="float"/>
4040                <element name="symResultB" type="float"/>
4041                <element name="symResultC" type="float"/>
4042                <element name="symResultD" type="float"/>
4043                <element name="calculateSymmetry" function="true" type="float">
4044                        <description><![CDATA[Returns bilateral symmetry (0.0 .. 1.0) for a given Model using default precision parameters (symPosSteps,symAlphaSteps,symBetaSteps). Returns the symmetry plane, too (sets symResultA,B,C,D).
4045Note: may take a long time for large creatures.]]></description>
4046                        <arguments>
4047                                <argument name="model" type="Model"/>
4048                        </arguments>
4049                </element>
4050                <element name="calculateSymmetry2" function="true" type="float">
4051                        <description><![CDATA[Returns bilateral symmetry (0.0 .. 1.0) for a given Model using specified precision parameters. Returns the symmetry plane, too (sets symResultA,B,C,D).
4052Note: may take a long time for large creatures.]]></description>
4053                        <arguments>
4054                                <argument name="model" type="Model"/>
4055                                <argument name="posSteps" type="integer"/>
4056                                <argument name="alphaSteps" type="integer"/>
4057                                <argument name="betaSteps" type="integer"/>
4058                        </arguments>
4059                </element>
4060                <element name="calculateSymmetryForPlane" function="true" type="float">
4061                        <description><![CDATA[Returns bilateral symmetry (0.0 .. 1.0) for a given Model and given a specific plane defined by coefficients A, B, C, D.]]></description>
4062                        <arguments>
4063                                <argument name="model" type="Model"/>
4064                                <argument name="A" type="float"/>
4065                                <argument name="B" type="float"/>
4066                                <argument name="C" type="float"/>
4067                                <argument name="D" type="float"/>
4068                        </arguments>
4069                </element>
4070        </type>
4071        <type name="Vector" context="Global context">
4072<description><![CDATA[Vector is 1-dimensional array, indexed by integer value (starting from 0). Multidimensional arrays can be simulated by putting other Vector objects into the Vector.
4073Example:
4074var v=Vector.new();
4075v.add(123); v.add("string");]]></description>
4076                <element name="avg" type="float"/>
4077                <element name="size" type="integer"/>
4078                <element name="stdev" type="float">
4079                        <description><![CDATA[=sqrt(sum((element[i]-avg)^2)/(size-1)) which is estimated population std.dev. from sample std.dev.]]></description>
4080                </element>
4081                <element name="toString" type="string"/>
4082                <element name="add" function="true" type="void">
4083                        <arguments>
4084                                <argument name="value" type="untyped"/>
4085                        </arguments>
4086                </element>
4087                <element name="clear" function="true" type="void"><arguments/></element>
4088                <element name="find" function="true" type="integer">
4089                        <description><![CDATA[returns the element index or -1 if not found]]></description>
4090                        <arguments>
4091                                <argument name="value" type="untyped"/>
4092                        </arguments>
4093                </element>
4094                <element name="get" function="true" type="untyped">
4095                        <arguments>
4096                                <argument name="position" type="integer"/>
4097                        </arguments>
4098                </element>
4099                <element name="new" function="true" type="Vector"><arguments/></element>
4100                <element name="remove" function="true" type="void">
4101                        <arguments>
4102                                <argument name="position" type="integer"/>
4103                        </arguments>
4104                </element>
4105                <element name="set" function="true" type="void">
4106                        <arguments>
4107                                <argument name="position" type="integer"/>
4108                                <argument name="value" type="untyped"/>
4109                        </arguments>
4110                </element>
4111        </type>
4112        <type name="World" context="Global context">
4113<description><![CDATA[Environment properties.]]></description>
4114                <element name="nnspeed" type="float" min="0" max="1000" default="1">
4115                        <description><![CDATA[Number of neural network simulation steps in each physics simulation step]]></description>
4116                </element>
4117                <element name="signals" type="WorldSignals"/>
4118                <element name="simtype" type="integer" min="0" max="1" default="0">
4119                        <description><![CDATA[MechaStick is a fast and simple primary Framsticks simulation engine.
4120ODE is Open Dynamics Engine by Russel Smith et al.
4121
4122NOTE: switching between simulation engines causes removal of all objects in the world (e.g. creatures).]]></description>
4123                </element>
4124                <element name="wrldbnd" type="integer" min="0" max="2" default="1"/>
4125                <element name="wrldg" type="float" min="0" max="10" default="1">
4126                        <description><![CDATA[You can adjust gravity for your experiments.
4127The "official" setting used to evaluate and compare creatures is 1.]]></description>
4128                </element>
4129                <element name="wrldmap" type="string">
4130                        <description><![CDATA[Description of the world (Type: Blocks or Heighfield). Enter
4131   r <sizex> <sizey> [seed]
4132to generate a random landscape, or
4133   m <sizex> <sizey> digits
4134   M <sizex> <sizey> numbers
4135to provide height values.
4136
4137See also the WorldMap object.]]></description>
4138                </element>
4139                <element name="wrldsiz" type="float" min="10" max="1000" default="20">
4140                        <description><![CDATA[Side length of the world]]></description>
4141                </element>
4142                <element name="wrldtyp" type="integer" min="0" max="2" default="0"/>
4143                <element name="wrldwat" type="float" min="-20" max="30" default="-1"/>
4144                <element name="wrldchg" function="true" type="void"><arguments/></element>
4145        </type>
4146        <type name="WorldMap" context="Global context">
4147<description><![CDATA[Environment details for "Blocks" and "Heightfield" world type. The most important concept is a "Map", which is the array of Map elements. Internally, Maps have more elements than could be deduced from the user-supplied World.wrldsiz, as additional rows of element are added to provide smooth transitions to the flat surroundings.
4148
4149Blocks: x/ysize=World.wrldsiz+4 rows of blocks (from which only 2+World.wrldsiz rows are placed within the world boundaries)
4150
4151Smooth: x/ysize=World.wrldsiz+2 rows of vertices (creating World.wrldsiz+1 rows of triangles, everything within the world boundaries)
4152]]></description>
4153                <element name="xsize" type="integer"/>
4154                <element name="ysize" type="integer"/>
4155                <element name="getHeight" function="true" type="float">
4156                        <description><![CDATA[Height at any 2d coordinate]]></description>
4157                        <arguments>
4158                                <argument name="x" type="float"/>
4159                                <argument name="y" type="float"/>
4160                        </arguments>
4161                </element>
4162                <element name="getMap" function="true" type="Object">
4163                        <description><![CDATA[retrieve map cell object]]></description>
4164                        <arguments>
4165                                <argument name="x" type="integer"/>
4166                                <argument name="y" type="integer"/>
4167                        </arguments>
4168                </element>
4169                <element name="intersect" function="true" type="Vector">
4170                        <description><![CDATA[Calculate the intersection point between the world surface and the ray projected from "3d point" towards the given direction. 3D points are actually 3-elements Vector objects. The resulting vector contains the additional fourth element - the intersection point distance. The function returns null if there is no intersection.
4171
4172See "standard_events.inc" file, which uses "intersect" for calculating the world coordinates corresponding to the user-clicked screen location.
4173Bugs: This function does not currently handle the heightfield environment correctly (works as if it was flat)]]></description>
4174                        <arguments>
4175                                <argument name="3d point" type="Vector"/>
4176                                <argument name="3d direction" type="Vector"/>
4177                                <argument name="range" type="float"/>
4178                        </arguments>
4179                </element>
4180        </type>
4181        <type name="WorldSignals" context="Global context">
4182<description><![CDATA[Use this object to create stationary signals, not associated with any moving object and receive signals from any location in the world. There are Creature and Neuro-based variants of this object that automatically operate from the creature's or neuron's position.
4183
4184See also: Signal]]></description>
4185                <element name="size" type="integer">
4186                        <description><![CDATA[Number of signals in this set.]]></description>
4187                </element>
4188                <element name="add" function="true" type="Signal">
4189                        <description><![CDATA[Create a new signal]]></description>
4190                        <arguments>
4191                                <argument name="position" type="XYZ"/>
4192                                <argument name="channel" type="string"/>
4193                        </arguments>
4194                </element>
4195                <element name="clear" function="true" type="void">
4196                        <description><![CDATA[Delete all signals]]></description>
4197<arguments/></element>
4198                <element name="get" function="true" type="Signal">
4199                        <description><![CDATA[Access individual signals (index=0 .. size-1)]]></description>
4200                        <arguments>
4201                                <argument name="index" type="integer"/>
4202                        </arguments>
4203                </element>
4204                <element name="receive" function="true" type="float">
4205                        <description><![CDATA[Receive the aggregated signal power in a given channel.]]></description>
4206                        <arguments>
4207                                <argument name="position" type="XYZ"/>
4208                                <argument name="channel" type="string"/>
4209                        </arguments>
4210                </element>
4211                <element name="receiveFilter" function="true" type="float">
4212                        <description><![CDATA[Receive the aggregated signal power in a given channel.
4213
4214Additional filtering options:
4215- Max distance only receives the neighbor signals (based on their physical location)
4216- Flavor filtering: only signals having the flavor close to the specified one will be received. The filter value is the maximum allowed difference.]]></description>
4217                        <arguments>
4218                                <argument name="position" type="XYZ"/>
4219                                <argument name="channel" type="string"/>
4220                                <argument name="max distance" type="float"/>
4221                                <argument name="flavor" type="float"/>
4222                                <argument name="filter" type="float"/>
4223                        </arguments>
4224                </element>
4225                <element name="receiveSet" function="true" type="Vector">
4226                        <description><![CDATA[Get all signals in the specified range. Returns a readonly vector object containing Signal objects (individual signals can be accessed as result[0] throught result[result.size-1]).]]></description>
4227                        <arguments>
4228                                <argument name="position" type="XYZ"/>
4229                                <argument name="channel" type="string"/>
4230                                <argument name="max distance" type="float"/>
4231                        </arguments>
4232                </element>
4233                <element name="receiveSingle" function="true" type="Signal">
4234                        <description><![CDATA[Find the signal source having the highest signal power (including the distance)]]></description>
4235                        <arguments>
4236                                <argument name="position" type="XYZ"/>
4237                                <argument name="channel" type="string"/>
4238                                <argument name="max distance" type="float"/>
4239                        </arguments>
4240                </element>
4241        </type>
4242        <type name="XYZ" context="Global context">
4243<description><![CDATA[3D vector]]></description>
4244                <element name="length" type="float"/>
4245                <element name="toString" type="string"/>
4246                <element name="x" type="float"/>
4247                <element name="y" type="float"/>
4248                <element name="z" type="float"/>
4249                <element name="add" function="true" type="void">
4250                        <description><![CDATA[Note: it does not return a new object, just modifies the existing one]]></description>
4251                        <arguments>
4252                                <argument type="XYZ"/>
4253                        </arguments>
4254                </element>
4255                <element name="clone" function="true" type="XYZ">
4256                        <description><![CDATA[Note: copying object references does not create new objects. Use clone() if a new object is needed.
4257
4258Example:
4259var o1=(1,2,3), o2=o1, o3=o1.clone();
4260o1.y=9999;
4261//o2 is now (1,9999,3) but o3 is still (1,2,3)]]></description>
4262<arguments/></element>
4263                <element name="get" function="true" type="float">
4264                        <description><![CDATA[this function makes the XYZ objects "indexable" (so you can use [] for accessing subsequent fields, like in Vector)]]></description>
4265                        <arguments>
4266                                <argument name="index" type="integer"/>
4267                        </arguments>
4268                </element>
4269                <element name="new" function="true" type="XYZ">
4270                        <description><![CDATA[3D vectors objects can be also created using the (x,y,z) notation, i.e. var v=(1,2,3) is the same as var v=XYZ.new(1,2,3);]]></description>
4271                        <arguments>
4272                                <argument name="x" type="float"/>
4273                                <argument name="y" type="float"/>
4274                                <argument name="z" type="float"/>
4275                        </arguments>
4276                </element>
4277                <element name="normalize" function="true" type="void">
4278                        <description><![CDATA[scales the vector length to 1.0]]></description>
4279<arguments/></element>
4280                <element name="revRotate" function="true" type="void">
4281                        <arguments>
4282                                <argument type="Orient"/>
4283                        </arguments>
4284                </element>
4285                <element name="rotate" function="true" type="void">
4286                        <arguments>
4287                                <argument type="Orient"/>
4288                        </arguments>
4289                </element>
4290                <element name="scale" function="true" type="void">
4291                        <arguments>
4292                                <argument type="float"/>
4293                        </arguments>
4294                </element>
4295                <element name="set" function="true" type="void">
4296                        <arguments>
4297                                <argument type="XYZ"/>
4298                        </arguments>
4299                </element>
4300                <element name="set3" function="true" type="void">
4301                        <arguments>
4302                                <argument name="x" type="float"/>
4303                                <argument name="y" type="float"/>
4304                                <argument name="z" type="float"/>
4305                        </arguments>
4306                </element>
4307                <element name="sub" function="true" type="void">
4308                        <description><![CDATA[Note: it does not return a new object, just modifies the existing one]]></description>
4309                        <arguments>
4310                                <argument type="XYZ"/>
4311                        </arguments>
4312                </element>
4313        </type>
4314        <type name="ExpParams" context="Experiment definition">
4315                <element name="changedProperty" type="integer"/>
4316                <element name="changedPropertyId" type="string"/>
4317                <element name="add" function="true"/>
4318                <element name="addGroup" function="true"/>
4319                <element name="clear" function="true"/>
4320                <element name="remove" function="true"/>
4321                <element name="removeGroup" function="true"/>
4322        </type>
4323        <type name="ExpState" context="Experiment definition">
4324                <element name="changedProperty" type="integer"/>
4325                <element name="changedPropertyId" type="string"/>
4326                <element name="add" function="true"/>
4327                <element name="addGroup" function="true"/>
4328                <element name="clear" function="true"/>
4329                <element name="remove" function="true"/>
4330                <element name="removeGroup" function="true"/>
4331        </type>
4332        <type name="n" context="Neuron definitions">
4333                <element name="d" type="string"/>
4334                <element name="getInputCount" type="integer"/>
4335                <element name="i" type="string"/>
4336                <element name="j" type="integer" min="-1" max="999999" default="-1"/>
4337                <element name="p" type="integer" min="-1" max="999999" default="-1"/>
4338                <element name="Vstyle" type="string"/>
4339                <element name="getInputNeuroDef" function="true" type="NeuroDef">
4340                        <arguments>
4341                                <argument type="integer"/>
4342                        </arguments>
4343                </element>
4344                <element name="getInputNeuroIndex" function="true" type="integer">
4345                        <arguments>
4346                                <argument type="integer"/>
4347                        </arguments>
4348                </element>
4349                <element name="getInputWeight" function="true" type="float">
4350                        <arguments>
4351                                <argument type="integer"/>
4352                        </arguments>
4353                </element>
4354        </type>
4355        <type name="Neuro" context="Neuron definitions">
4356<description><![CDATA[Live Neuron object.]]></description>
4357                <element name="channelCount" type="integer"/>
4358                <element name="creature" type="Creature"/>
4359                <element name="currState" type="float">
4360                        <description><![CDATA[the only difference from the "state" field is that currState, when written, changes the internal neuron state immediately (which disturbs the regular synchronous NN operation). This feature should only be used while controlling the neuron 'from outside' (like a neuro probe) and not in the neuron definition.]]></description>
4361                </element>
4362                <element name="def" type="NeuroDef"/>
4363                <element name="fields" type="Fields">
4364                        <description><![CDATA[Neurons can have different fields depending on their class. Script neurons have their fields defined using the "prop:" syntax. If you develop a custom neuron script you should use the Fields object for accessing your own neuron fields. The Neuro.fields property is meant for accessing the neuron fields from the outside script.
4365Examples:
4366var c=Populations.createFromString("X[N]");
4367Simulator.print("standard neuron inertia="+c.getNeuro(0).fields.in);
4368c=Populations.createFromString("X[Nn,e:0.1]");
4369Simulator.print("noisy neuron error rate="+c.getNeuro(0).fields.e);
4370
4371The Interface object can be used to discover which fields are available for a certain neuron object:
4372c=Populations.createFromString("X[N]");
4373var iobj=Interface.makeFrom(c.getNeuro(0).fields);
4374var i;
4375for(i=0;i<iobj.properties;i++)
4376 Simulator.print(iobj.getId(i)+" ("+iobj.getName(i)+")");]]></description>
4377                </element>
4378                <element name="getInputCount" type="integer"/>
4379                <element name="hold" type="integer" min="0" max="1">
4380                        <description><![CDATA[]]></description>
4381                </element>
4382                <element name="inputSum" type="float"/>
4383                <element name="joint" type="MechJoint"/>
4384                <element name="part" type="MechPart"/>
4385                <element name="position_x" type="float"/>
4386                <element name="position_y" type="float"/>
4387                <element name="position_z" type="float"/>
4388                <element name="signals" type="NeuroSignals"/>
4389                <element name="state" type="float">
4390                        <description><![CDATA[when read, returns the current neuron state.
4391When written, sets the next neuron state (for use in the neuron definition)]]></description>
4392                </element>
4393                <element name="weightedInputSum" type="float"/>
4394                <element name="getInputChannelCount" function="true" type="integer">
4395                        <arguments>
4396                                <argument name="input" type="integer"/>
4397                        </arguments>
4398                </element>
4399                <element name="getInputState" function="true" type="float">
4400                        <arguments>
4401                                <argument name="input" type="integer"/>
4402                        </arguments>
4403                </element>
4404                <element name="getInputStateChannel" function="true" type="float">
4405                        <arguments>
4406                                <argument name="input" type="integer"/>
4407                                <argument name="channel" type="integer"/>
4408                        </arguments>
4409                </element>
4410                <element name="getInputSum" function="true" type="float">
4411                        <arguments>
4412                                <argument name="input" type="integer"/>
4413                        </arguments>
4414                </element>
4415                <element name="getInputWeight" function="true" type="float">
4416                        <arguments>
4417                                <argument name="input" type="integer"/>
4418                        </arguments>
4419                </element>
4420                <element name="getStateChannel" function="true" type="float">
4421                        <arguments>
4422                                <argument name="channel" type="integer"/>
4423                        </arguments>
4424                </element>
4425                <element name="getWeightedInputState" function="true" type="float">
4426                        <arguments>
4427                                <argument name="input" type="integer"/>
4428                        </arguments>
4429                </element>
4430                <element name="getWeightedInputStateChannel" function="true" type="float">
4431                        <arguments>
4432                                <argument name="input" type="integer"/>
4433                                <argument name="channel" type="integer"/>
4434                        </arguments>
4435                </element>
4436                <element name="getWeightedInputSum" function="true" type="float">
4437                        <description><![CDATA[uses any number of inputs starting with the specified input. getWeightedInputSum(0)=weightedInputSum]]></description>
4438                        <arguments>
4439                                <argument name="input" type="integer"/>
4440                        </arguments>
4441                </element>
4442                <element name="setCurrStateChannel" function="true" type="void">
4443                        <description><![CDATA[like "currState"]]></description>
4444                        <arguments>
4445                                <argument name="channel" type="integer"/>
4446                                <argument name="value" type="float"/>
4447                        </arguments>
4448                </element>
4449                <element name="setStateChannel" function="true" type="void">
4450                        <arguments>
4451                                <argument name="channel" type="integer"/>
4452                                <argument name="value" type="float"/>
4453                        </arguments>
4454                </element>
4455        </type>
4456        <type name="this" context="Fitness formula">
4457<description><![CDATA[A Genotype with the associated performance information. All but one Genotype objects are placed in Genotype Groups. There is also a single static Genotype object not associated with a group, which is used as a temporary storage by genetic operators and some functions from GenePools.]]></description>
4458                <element name="convtrace1" type="string"/>
4459                <element name="distance" type="float"/>
4460                <element name="energ0" type="float"/>
4461                <element name="f0genotype" type="string">
4462                        <description><![CDATA[converted to f0 genotype]]></description>
4463                </element>
4464                <element name="fit" type="float"/>
4465                <element name="fit2" type="float">
4466                        <description><![CDATA[Fitness shifted by (avg-n*stddev)]]></description>
4467                </element>
4468                <element name="geno" type="Geno">
4469                        <description><![CDATA[Geno object for this Genotype]]></description>
4470                </element>
4471                <element name="genotype" type="string"/>
4472                <element name="gnum" type="integer"/>
4473                <element name="info" type="string">
4474                        <description><![CDATA[Additional information or comments]]></description>
4475                </element>
4476                <element name="instances" type="integer">
4477                        <description><![CDATA[Copies of this genotype]]></description>
4478                </element>
4479                <element name="isValid" type="integer" min="0" max="1"/>
4480                <element name="lifespan" type="float">
4481                        <description><![CDATA[Average life span]]></description>
4482                </element>
4483                <element name="name" type="string"/>
4484                <element name="nncon" type="float"/>
4485                <element name="nnsiz" type="float"/>
4486                <element name="num" type="integer"/>
4487                <element name="numconnections" type="float"/>
4488                <element name="numjoints" type="float"/>
4489                <element name="numneurons" type="float"/>
4490                <element name="numparts" type="float"/>
4491                <element name="popsiz" type="integer"/>
4492                <element name="simi" type="float"/>
4493                <element name="strjoints" type="float"/>
4494                <element name="strsiz" type="float"/>
4495                <element name="uid" type="string">
4496                        <description><![CDATA[Unique identifier]]></description>
4497                </element>
4498                <element name="user1" type="untyped"/>
4499                <element name="user2" type="untyped"/>
4500                <element name="user3" type="untyped"/>
4501                <element name="velocity" type="float">
4502                        <description><![CDATA[Average velocity]]></description>
4503                </element>
4504                <element name="vertpos" type="float"/>
4505                <element name="vertvel" type="float"/>
4506                <element name="getModel" function="true" type="Model"><arguments/></element>
4507                <element name="getNormalized" function="true" type="float">
4508                        <arguments>
4509                                <argument name="property name or index" type="untyped"/>
4510                        </arguments>
4511                </element>
4512                <element name="mutate" function="true" type="void"><arguments/></element>
4513        </type>
4514        <type name="Creature" context="Visual style definition">
4515<description><![CDATA[The object inside the simulated world, including its physical structure, neural network and performance data. Food pieces, obstacles and other movable objects can be implemented as Creatures even though the are not "alive". See also: Population.]]></description>
4516                <element name="bodysim" type="integer" min="0" max="1" default="1">
4517                        <description><![CDATA[(Physical) body simulation can be disabled for individual objects which makes them immovable. Disabled objects can still participate in collisions depending on their collisions masks.
4518
4519Bugs: the standard collision handler does not work for disabled objects when ODE simulation is used. It means that these objects won't physically interact with other objects. The custom (scripting) handlers work as expected.]]></description>
4520                </element>
4521                <element name="buildproblems" type="integer"/>
4522                <element name="c_velocity" type="float"/>
4523                <element name="c_vertpos" type="float"/>
4524                <element name="c_vertvelocity" type="float"/>
4525                <element name="center_x" type="float">
4526                        <description><![CDATA[Center of gravity]]></description>
4527                </element>
4528                <element name="center_y" type="float">
4529                        <description><![CDATA[Center of gravity]]></description>
4530                </element>
4531                <element name="center_z" type="float">
4532                        <description><![CDATA[Center of gravity]]></description>
4533                </element>
4534                <element name="distance" type="float"/>
4535                <element name="drive" type="XYZ">
4536                        <description><![CDATA[Measured in global coordinates]]></description>
4537                </element>
4538                <element name="energ0" type="float"/>
4539                <element name="energy" type="float"/>
4540                <element name="energy_b" type="float"/>
4541                <element name="energy_m" type="float"/>
4542                <element name="energy_p" type="float"/>
4543                <element name="geno" type="Geno">
4544                        <description><![CDATA[Source genotype for this creature]]></description>
4545                </element>
4546                <element name="genotype" type="string"/>
4547                <element name="gnum" type="integer"/>
4548                <element name="group" type="untyped"/>
4549                <element name="idleen" type="float"/>
4550                <element name="index" type="integer">
4551                        <description><![CDATA[Index of this Creature in its Population.]]></description>
4552                </element>
4553                <element name="info" type="string">
4554                        <description><![CDATA[Additional info or comments]]></description>
4555                </element>
4556                <element name="lifespan" type="integer"/>
4557                <element name="liveModel" type="Model">
4558                        <description><![CDATA[A Model object that is a copy of the current (temporary) geometry of this creature]]></description>
4559                </element>
4560                <element name="localDrive" type="XYZ">
4561                        <description><![CDATA[Measured in local coordinates, that is, with respect to the current creature orientation
4562See also: Creature.orient]]></description>
4563                </element>
4564                <element name="model" type="Model">
4565                        <description><![CDATA[Source Model for this creature]]></description>
4566                </element>
4567                <element name="name" type="string"/>
4568                <element name="nnenabled" type="integer" min="0" max="1"/>
4569                <element name="numjoints" type="integer"/>
4570                <element name="numneurons" type="integer"/>
4571                <element name="numparts" type="integer"/>
4572                <element name="orient" type="Orient">
4573                        <description><![CDATA[By convention, the orientation of the creature is equal to the orientation of its first Part]]></description>
4574                </element>
4575                <element name="othermask" type="integer" min="0" max="2147483647" default="0"/>
4576                <element name="perf" type="integer" min="0" max="2">
4577                        <description><![CDATA[Initial value of this property is taken from Population.enableperf]]></description>
4578                </element>
4579                <element name="pos_x" type="float">
4580                        <description><![CDATA[(pos_x,pos_y,pos_z) is the point of minimal coordinates ("bottom left corner") of the creature, including imaginary Part sizes (Part.s, usually 1.0). See also: Creature.moveAbs]]></description>
4581                </element>
4582                <element name="pos_y" type="float">
4583                        <description><![CDATA[See Creature.pos_x]]></description>
4584                </element>
4585                <element name="pos_z" type="float">
4586                        <description><![CDATA[See Creature.pos_x]]></description>
4587                </element>
4588                <element name="selfcol" type="integer" min="0" max="1">
4589                        <description><![CDATA[Enable/disable detection of self-collisions (within a creature body). They can only occur when using the ODE simulation engine. If enabled, the creature will have its sticks collide during lifespan.]]></description>
4590                </element>
4591                <element name="selfcolstate" type="integer" min="0" max="1">
4592                        <description><![CDATA[Current self-collision state]]></description>
4593                </element>
4594                <element name="selfmask" type="integer" min="0" max="2147483647" default="0"/>
4595                <element name="signals" type="CreatureSignals"/>
4596                <element name="size_x" type="float">
4597                        <description><![CDATA[(size_x,size_y,size_z) are dimensions of the axis-aligned bounding box of the creature, including the imaginary part sizes (Part.s, usually 1.0). A creature consisting of a single default Part has the size of (2.0,2.0,2.0) - twice the Part.s value (like a sphere diameter is twice its radius).
4598See also: Creature.moveAbs]]></description>
4599                </element>
4600                <element name="size_y" type="float">
4601                        <description><![CDATA[See Creature.size_x]]></description>
4602                </element>
4603                <element name="size_z" type="float">
4604                        <description><![CDATA[See Creature.size_x]]></description>
4605                </element>
4606                <element name="uid" type="string"/>
4607                <element name="user1" type="untyped"/>
4608                <element name="user2" type="untyped"/>
4609                <element name="user3" type="untyped"/>
4610                <element name="velocity" type="float"/>
4611                <element name="vertpos" type="float"/>
4612                <element name="vertvel" type="float"/>
4613                <element name="currentGeometryAsF0" function="true" type="string"><arguments/></element>
4614                <element name="getJoint" function="true" type="Joint">
4615                        <arguments>
4616                                <argument name="index" type="integer"/>
4617                        </arguments>
4618                </element>
4619                <element name="getMechJoint" function="true" type="MechJoint">
4620                        <arguments>
4621                                <argument name="index" type="integer"/>
4622                        </arguments>
4623                </element>
4624                <element name="getMechPart" function="true" type="MechPart">
4625                        <arguments>
4626                                <argument name="index" type="integer"/>
4627                        </arguments>
4628                </element>
4629                <element name="getNeuro" function="true" type="Neuro">
4630                        <arguments>
4631                                <argument name="index" type="integer"/>
4632                        </arguments>
4633                </element>
4634                <element name="getNeuroDef" function="true" type="NeuroDef">
4635                        <arguments>
4636                                <argument name="index" type="integer"/>
4637                        </arguments>
4638                </element>
4639                <element name="getPart" function="true" type="Part">
4640                        <arguments>
4641                                <argument name="index" type="integer"/>
4642                        </arguments>
4643                </element>
4644                <element name="localToWorld" function="true" type="XYZ">
4645                        <description><![CDATA[Local coordinates are measured with respect to the first Part position and orientation]]></description>
4646                        <arguments>
4647                                <argument name="x" type="float"/>
4648                                <argument name="y" type="float"/>
4649                                <argument name="z" type="float"/>
4650                        </arguments>
4651                </element>
4652                <element name="move" function="true" type="void">
4653                        <description><![CDATA[Shift the creature by a given vector.]]></description>
4654                        <arguments>
4655                                <argument name="x" type="float"/>
4656                                <argument name="y" type="float"/>
4657                                <argument name="z" type="float"/>
4658                        </arguments>
4659                </element>
4660                <element name="moveAbs" function="true" type="void">
4661                        <description><![CDATA[Moves the creature so that its origin (pos_x,pos_y,pos_z) is placed at the given location. The origin is the point of minimal coordinates ("bottom left corner"), including imaginary part sizes (Part.s, usually 1.0).
4662Assuming a simple single-stick creature "X" having parts at (0,0,0) and (1,0,0),
4663
4664origin (pos_x,pos_y,pos_z) = (-1,-1,-1)
4665size (size_x,size_y,size_z) = (3,2,2)
4666
4667The following example places the bottom of a creature at a given location (x,y,z):
4668Creature.moveAbs(x-(Creature.size_x/2),y-(Creature.size_y/2),z-1.0)
4669(assuming that the part size is 1.0)]]></description>
4670                        <arguments>
4671                                <argument name="x" type="float"/>
4672                                <argument name="y" type="float"/>
4673                                <argument name="z" type="float"/>
4674                        </arguments>
4675                </element>
4676                <element name="moveLocal" function="true" type="void">
4677                        <description><![CDATA[Local coordinates are measured with respect to the first Part position and orientation]]></description>
4678                        <arguments>
4679                                <argument name="x" type="float"/>
4680                                <argument name="y" type="float"/>
4681                                <argument name="z" type="float"/>
4682                        </arguments>
4683                </element>
4684                <element name="rotate" function="true" type="void">
4685                        <description><![CDATA[Rotate the creature around X, Y and Z axes. Should only be used immediately after creating a new creature (before the first simulation step is performed for this creature), otherwise the further simulation could be disturbed.]]></description>
4686                        <arguments>
4687                                <argument name="x" type="float"/>
4688                                <argument name="y" type="float"/>
4689                                <argument name="z" type="float"/>
4690                        </arguments>
4691                </element>
4692                <element name="rotateLocal" function="true" type="void">
4693                        <description><![CDATA[Rotate the creature around (local) X, Y and Z axes. Should only be used immediately after creating a new creature (before the first simulation step is performed for this creature), otherwise further simulation can be disturbed.]]></description>
4694                        <arguments>
4695                                <argument name="x" type="float"/>
4696                                <argument name="y" type="float"/>
4697                                <argument name="z" type="float"/>
4698                        </arguments>
4699                </element>
4700                <element name="worldToLocal" function="true" type="XYZ">
4701                        <description><![CDATA[Local coordinates are measured with respect to the first Part position and orientation]]></description>
4702                        <arguments>
4703                                <argument name="x" type="float"/>
4704                                <argument name="y" type="float"/>
4705                                <argument name="z" type="float"/>
4706                        </arguments>
4707                </element>
4708        </type>
4709        <type name="Element" context="Visual style definition">
4710<description><![CDATA[Information about current visual element: Part, Joint or Neuro. To be used in _build() or _update() functions.
4711
4712This is a link between a creature's element (part/joint/neuron) and the geometry object (Element.node).
4713Calling Element.useXXX() functions connects the static object references (Creature, Model, Part, Joint, Neuro, MechPart, MechJoint) to the proper creature elements. All these objects are invalid before doing that! E.g. you have to call "Element.useCreature()" before referring to "Creature.energy" in your _build() and _update() functions.]]></description>
4714                <element name="node" type="integer"/>
4715                <element name="useCreature" function="true"/>
4716                <element name="useJoint" function="true"/>
4717                <element name="useJointPart1" function="true"/>
4718                <element name="useJointPart2" function="true"/>
4719                <element name="useMechJoint" function="true"/>
4720                <element name="useMechJointPart1" function="true"/>
4721                <element name="useMechJointPart2" function="true"/>
4722                <element name="useMechPart" function="true"/>
4723                <element name="useModel" function="true"/>
4724                <element name="useNeuro" function="true"/>
4725                <element name="useNeuroJoint" function="true"/>
4726                <element name="useNeuroPart" function="true"/>
4727                <element name="usePart" function="true"/>
4728        </type>
4729        <type name="GeomBuilder" context="Visual style definition">
4730<description><![CDATA[Scene graph access (build and manipulate the 3d object tree)]]></description>
4731                <element name="code" type="string"/>
4732                <element name="currentNode" type="integer"/>
4733                <element name="defaultStyle" type="string"/>
4734                <element name="matrix00" type="float"/>
4735                <element name="matrix01" type="float"/>
4736                <element name="matrix02" type="float"/>
4737                <element name="matrix03" type="float"/>
4738                <element name="matrix10" type="float"/>
4739                <element name="matrix11" type="float"/>
4740                <element name="matrix12" type="float"/>
4741                <element name="matrix13" type="float"/>
4742                <element name="matrix20" type="float"/>
4743                <element name="matrix21" type="float"/>
4744                <element name="matrix22" type="float"/>
4745                <element name="matrix23" type="float"/>
4746                <element name="matrix30" type="float"/>
4747                <element name="matrix31" type="float"/>
4748                <element name="matrix32" type="float"/>
4749                <element name="matrix33" type="float"/>
4750                <element name="rootNode" type="integer"/>
4751                <element name="updatingNode" type="integer"/>
4752                <element name="add" function="true" type="void">
4753                        <description><![CDATA[add a child node to the current node]]></description>
4754                        <arguments>
4755                                <argument name="node" type="integer"/>
4756                        </arguments>
4757                </element>
4758                <element name="addBranch" function="true">
4759                        <description><![CDATA[create the branch node as a child of the current node and make it the new current node]]></description>
4760                </element>
4761                <element name="addTransform" function="true">
4762                        <description><![CDATA[create the transform node as a child of the current node and make it the new current node.]]></description>
4763                </element>
4764                <element name="dump" function="true" type="void">
4765                        <arguments>
4766                                <argument name="node" type="integer"/>
4767                                <argument name="level" type="integer"/>
4768                        </arguments>
4769                </element>
4770                <element name="getBranch" function="true" type="integer">
4771                        <arguments>
4772                                <argument name="branch node" type="integer"/>
4773                                <argument name="branch index" type="integer"/>
4774                        </arguments>
4775                </element>
4776                <element name="matrixMove" function="true" type="void">
4777                        <arguments>
4778                                <argument name="x" type="float"/>
4779                                <argument name="y" type="float"/>
4780                                <argument name="z" type="float"/>
4781                        </arguments>
4782                </element>
4783                <element name="matrixMove1" function="true" type="void">
4784                        <description><![CDATA[MechPart.pos can be used here]]></description>
4785                        <arguments>
4786                                <argument name="xyz" type="integer"/>
4787                        </arguments>
4788                </element>
4789                <element name="matrixOrient" function="true" type="void">
4790                        <arguments>
4791                                <argument name="x" type="float"/>
4792                                <argument name="y" type="float"/>
4793                                <argument name="z" type="float"/>
4794                        </arguments>
4795                </element>
4796                <element name="matrixOrient1" function="true" type="void">
4797                        <description><![CDATA[MechPart.orient can be used here]]></description>
4798                        <arguments>
4799                                <argument name="xyz" type="integer"/>
4800                        </arguments>
4801                </element>
4802                <element name="matrixReset" function="true"/>
4803                <element name="matrixRotate" function="true" type="void">
4804                        <arguments>
4805                                <argument name="x" type="float"/>
4806                                <argument name="y" type="float"/>
4807                                <argument name="z" type="float"/>
4808                        </arguments>
4809                </element>
4810                <element name="matrixRotate1" function="true" type="void">
4811                        <arguments>
4812                                <argument name="xyz" type="integer"/>
4813                        </arguments>
4814                </element>
4815                <element name="matrixScale" function="true" type="void">
4816                        <arguments>
4817                                <argument name="x" type="float"/>
4818                                <argument name="y" type="float"/>
4819                                <argument name="z" type="float"/>
4820                        </arguments>
4821                </element>
4822                <element name="setMatrix" function="true" type="void">
4823                        <description><![CDATA[copy current matrix into specified node]]></description>
4824                        <arguments>
4825                                <argument name="transform node" type="integer"/>
4826                        </arguments>
4827                </element>
4828        </type>
4829        <type name="GL" context="Visual style definition">
4830<description><![CDATA[OpenGL constants used in GeomBuilder and Material functions.]]></description>
4831                <element name="ALPHA_TEST" type="integer"/>
4832                <element name="AMBIENT" type="integer"/>
4833                <element name="AMBIENT_AND_DIFFUSE" type="integer"/>
4834                <element name="BLEND" type="integer"/>
4835                <element name="COLOR_MATERIAL" type="integer"/>
4836                <element name="CULL_FACE" type="integer"/>
4837                <element name="DIFFUSE" type="integer"/>
4838                <element name="EMISSION" type="integer"/>
4839                <element name="LIGHTING" type="integer"/>
4840                <element name="LINE_LOOP" type="integer"/>
4841                <element name="LINE_STRIP" type="integer"/>
4842                <element name="LINES" type="integer"/>
4843                <element name="POINTS" type="integer"/>
4844                <element name="QUAD_STRIP" type="integer"/>
4845                <element name="QUADS" type="integer"/>
4846                <element name="SPECULAR" type="integer"/>
4847                <element name="TEXTURE_2D" type="integer"/>
4848                <element name="TRIANGLE_FAN" type="integer"/>
4849                <element name="TRIANGLE_STRIP" type="integer"/>
4850                <element name="TRIANGLES" type="integer"/>
4851        </type>
4852        <type name="j" context="Visual style definition">
4853                <element name="dx" type="float" min="-2" max="2" default="0"/>
4854                <element name="dy" type="float" min="-2" max="2" default="0"/>
4855                <element name="dz" type="float" min="-2" max="2" default="0"/>
4856                <element name="i" type="string"/>
4857                <element name="p1" type="integer" min="-1" max="999999" default="-1"/>
4858                <element name="p2" type="integer" min="-1" max="999999" default="-1"/>
4859                <element name="rotstif" type="float" min="0" max="1" default="1"/>
4860                <element name="rx" type="float"/>
4861                <element name="ry" type="float"/>
4862                <element name="rz" type="float"/>
4863                <element name="stam" type="float" min="0" max="1" default="0.25"/>
4864                <element name="stif" type="float" min="0" max="1" default="1"/>
4865                <element name="Vstyle" type="string"/>
4866        </type>
4867        <type name="Loader" context="Visual style definition">
4868<description><![CDATA[Loads 3d objects files.
4869Visual styles placed in subdirectories (like "matrix") automatically access the parent directory if the file is not found in their subdirectory.]]></description>
4870                <element name="loaded" type="integer"/>
4871                <element name="load" function="true"/>
4872        </type>
4873        <type name="m" context="Visual style definition">
4874                <element name="se" type="float"/>
4875                <element name="Vstyle" type="string"/>
4876        </type>
4877        <type name="Material" context="Visual style definition">
4878<description><![CDATA[Manipulate 3d objects surface properties (Material objects can be associated with geometry nodes).]]></description>
4879                <element name="ambient" type="integer"/>
4880                <element name="colormat" type="integer"/>
4881                <element name="diffuse" type="integer"/>
4882                <element name="emission" type="integer"/>
4883                <element name="object" type="Object"/>
4884                <element name="shininess" type="float"/>
4885                <element name="specular" type="integer"/>
4886                <element name="texture" type="string"/>
4887                <element name="translucent" type="integer"/>
4888                <element name="care" function="true"/>
4889                <element name="disable" function="true"/>
4890                <element name="dontcare" function="true"/>
4891                <element name="enable" function="true"/>
4892                <element name="new" function="true"/>
4893                <element name="setFlat" function="true"/>
4894                <element name="setSmooth" function="true"/>
4895        </type>
4896        <type name="MechJoint" context="Visual style definition">
4897<description><![CDATA[Current joint properties during the simulation]]></description>
4898                <element name="absorient" type="integer"/>
4899                <element name="calcorient" type="integer"/>
4900                <element name="dx" type="float"/>
4901                <element name="dy" type="float"/>
4902                <element name="dz" type="float"/>
4903                <element name="length" type="float"/>
4904                <element name="orient" type="integer"/>
4905                <element name="rotstif" type="float"/>
4906                <element name="rotstress" type="float"/>
4907                <element name="rx" type="float"/>
4908                <element name="ry" type="float"/>
4909                <element name="rz" type="float"/>
4910                <element name="stif" type="float"/>
4911                <element name="stress" type="float"/>
4912        </type>
4913        <type name="MechPart" context="Visual style definition">
4914<description><![CDATA[Current part properties during the simulation]]></description>
4915                <element name="fr" type="float"/>
4916                <element name="m" type="float"/>
4917                <element name="orient" type="integer"/>
4918                <element name="pos" type="integer"/>
4919                <element name="s" type="float"/>
4920                <element name="vol" type="float"/>
4921                <element name="x" type="float"/>
4922                <element name="y" type="float"/>
4923                <element name="z" type="float"/>
4924        </type>
4925        <type name="n" context="Visual style definition">
4926                <element name="class" type="string"/>
4927                <element name="d" type="string"/>
4928                <element name="getInputCount" type="integer"/>
4929                <element name="i" type="string"/>
4930                <element name="j" type="integer" min="-1" max="999999" default="-1"/>
4931                <element name="p" type="integer" min="-1" max="999999" default="-1"/>
4932                <element name="state" type="float"/>
4933                <element name="Vstyle" type="string"/>
4934                <element name="getInputNeuroDef" function="true" type="NeuroDef">
4935                        <arguments>
4936                                <argument type="integer"/>
4937                        </arguments>
4938                </element>
4939                <element name="getInputNeuroIndex" function="true" type="integer">
4940                        <arguments>
4941                                <argument type="integer"/>
4942                        </arguments>
4943                </element>
4944                <element name="getInputWeight" function="true" type="float">
4945                        <arguments>
4946                                <argument type="integer"/>
4947                        </arguments>
4948                </element>
4949        </type>
4950        <type name="p" context="Visual style definition">
4951                <element name="as" type="float" min="0" max="1" default="0.25"/>
4952                <element name="dn" type="float" min="0.2" max="5" default="1"/>
4953                <element name="fr" type="float" min="0" max="4" default="0.4"/>
4954                <element name="i" type="string"/>
4955                <element name="ing" type="float" min="0" max="1" default="0.25"/>
4956                <element name="m" type="float" min="0.1" max="999" default="1"/>
4957                <element name="rx" type="float"/>
4958                <element name="ry" type="float"/>
4959                <element name="rz" type="float"/>
4960                <element name="s" type="float" min="0.1" max="10" default="1"/>
4961                <element name="Vstyle" type="string"/>
4962                <element name="x" type="float"/>
4963                <element name="y" type="float"/>
4964                <element name="z" type="float"/>
4965        </type>
4966        <type name="Scene" context="Visual style definition">
4967<description><![CDATA[Additional properties to be used in the current view, currently only the background settings]]></description>
4968                <element name="backcolor" type="integer"/>
4969                <element name="worldtexture" type="string"/>
4970        </type>
4971        <type name="VertexBuilder" context="Visual style definition">
4972                <element name="material" type="Object"/>
4973                <element name="node" type="integer">
4974                        <description><![CDATA[This field returns the geometry node for use in GeomBuilder. You have to set all relevant geometry properties before using this field. The usual sequence:
49751. newXXX - selects the geometry type (see your OpenGL manual for explanation)
49762. Set all properties (add vertices, normals, colors, texture coordinates, material). All unspecified properties are assumed to have default values.
49773. Use the resulting node ( GeomBuilder.add(VertexBuilder.node) )]]></description>
4978                </element>
4979                <element name="twosided" type="integer" min="0" max="1"/>
4980                <element name="addCalculatedNormal" function="true">
4981                        <description><![CDATA[calculate the normal vector from 3 coordinates. integer arguments are the vertices' indices. 0,1,2... = first, second, third vertex, -1,-2,-3,... = last, last-1, last-2 vertex]]></description>
4982                </element>
4983                <element name="addColor" function="true"/>
4984                <element name="addNormal" function="true"/>
4985                <element name="addNormal_1" function="true">
4986                        <description><![CDATA[use addNormal instead of this function]]></description>
4987                </element>
4988                <element name="addTexCoord" function="true"/>
4989                <element name="addVertex" function="true"/>
4990                <element name="genTexCoords" function="true"/>
4991                <element name="genTexCoordsXY" function="true"/>
4992                <element name="genTexCoordsXZ" function="true"/>
4993                <element name="genTexCoordsYZ" function="true"/>
4994                <element name="new" function="true" type="void">
4995                        <arguments>
4996                                <argument name="type" type="integer"/>
4997                        </arguments>
4998                </element>
4999                <element name="newLineLoop" function="true"/>
5000                <element name="newLines" function="true"/>
5001                <element name="newLineStrip" function="true"/>
5002                <element name="newPoints" function="true"/>
5003                <element name="newPolygon" function="true"/>
5004                <element name="newQuads" function="true"/>
5005                <element name="newQuadStrip" function="true"/>
5006                <element name="newTriangleFan" function="true"/>
5007                <element name="newTriangles" function="true"/>
5008                <element name="newTriangleStrip" function="true"/>
5009        </type>
5010        <type name="VisParams" context="Visual style definition">
5011                <element name="changedProperty" type="integer"/>
5012                <element name="changedPropertyId" type="string"/>
5013                <element name="modelpan" type="integer" min="0" max="3">
5014                        <description><![CDATA[]]></description>
5015                </element>
5016                <element name="shownames" type="integer" min="0" max="1">
5017                        <description><![CDATA[]]></description>
5018                </element>
5019                <element name="worldpan" type="integer" min="0" max="3">
5020                        <description><![CDATA[]]></description>
5021                </element>
5022                <element name="add" function="true"/>
5023                <element name="addGroup" function="true"/>
5024                <element name="clear" function="true"/>
5025                <element name="remove" function="true"/>
5026                <element name="removeGroup" function="true"/>
5027        </type>
5028        <type name="VisualModel" context="Visual style definition">
5029<description><![CDATA[Visual representation of the Creature object.]]></description>
5030                <element name="args" type="string">
5031                        <description><![CDATA[style parameters: Vstyle=name(args)]]></description>
5032                </element>
5033                <element name="color" type="integer">
5034                        <description><![CDATA[0xBBGGRR, 0x808080=normal, 0x000000=black, 0xffffff=extra bright]]></description>
5035                </element>
5036                <element name="jointshadow" type="float"/>
5037                <element name="partshadow" type="float"/>
5038                <element name="rootNode" type="integer"/>
5039                <element name="style" type="string">
5040                        <description><![CDATA[visual style applied to this object]]></description>
5041                </element>
5042                <element name="getArg" function="true" type="string">
5043                        <description><![CDATA[retrieve single style argument, as in:
5044Vstyle=name(a=1,b=3)
5045VisualModel.getArg("a") returns 1]]></description>
5046                        <arguments>
5047                                <argument name="name" type="string"/>
5048                        </arguments>
5049                </element>
5050        </type>
5051        <type name="VisualStyle" context="Visual style definition">
5052                <element name="changedProperty" type="integer"/>
5053                <element name="changedPropertyId" type="string"/>
5054                <element name="code" type="string"/>
5055                <element name="info" type="string"/>
5056                <element name="modelpan" type="integer" min="0" max="3">
5057                        <description><![CDATA[]]></description>
5058                </element>
5059                <element name="name" type="string"/>
5060                <element name="neurons" type="integer" min="0" max="1"/>
5061                <element name="shownames" type="integer" min="0" max="1">
5062                        <description><![CDATA[]]></description>
5063                </element>
5064                <element name="smooth" type="integer" min="0" max="1"/>
5065                <element name="style" type="string"/>
5066                <element name="tex" type="integer" min="0" max="2"/>
5067                <element name="worldpan" type="integer" min="0" max="3">
5068                        <description><![CDATA[]]></description>
5069                </element>
5070                <element name="add" function="true"/>
5071                <element name="addGroup" function="true"/>
5072                <element name="clear" function="true"/>
5073                <element name="rebuild" function="true"/>
5074                <element name="remove" function="true"/>
5075                <element name="removeGroup" function="true"/>
5076                <element name="streload" function="true"/>
5077        </type>
5078        <type name="World" context="Visual style definition">
5079<description><![CDATA[Environment properties.]]></description>
5080                <element name="nnspeed" type="float" min="0" max="1000" default="1">
5081                        <description><![CDATA[Number of neural network simulation steps in each physics simulation step]]></description>
5082                </element>
5083                <element name="signals" type="WorldSignals"/>
5084                <element name="simtype" type="integer" min="0" max="1" default="0">
5085                        <description><![CDATA[MechaStick is a fast and simple primary Framsticks simulation engine.
5086ODE is Open Dynamics Engine by Russel Smith et al.
5087
5088NOTE: switching between simulation engines causes removal of all objects in the world (e.g. creatures).]]></description>
5089                </element>
5090                <element name="wrldbnd" type="integer" min="0" max="2" default="1"/>
5091                <element name="wrldg" type="float" min="0" max="10" default="1">
5092                        <description><![CDATA[You can adjust gravity for your experiments.
5093The "official" setting used to evaluate and compare creatures is 1.]]></description>
5094                </element>
5095                <element name="wrldmap" type="string">
5096                        <description><![CDATA[Description of the world (Type: Blocks or Heighfield). Enter
5097   r <sizex> <sizey> [seed]
5098to generate a random landscape, or
5099   m <sizex> <sizey> digits
5100   M <sizex> <sizey> numbers
5101to provide height values.
5102
5103See also the WorldMap object.]]></description>
5104                </element>
5105                <element name="wrldsiz" type="float" min="10" max="1000" default="20">
5106                        <description><![CDATA[Side length of the world]]></description>
5107                </element>
5108                <element name="wrldtyp" type="integer" min="0" max="2" default="0"/>
5109                <element name="wrldwat" type="float" min="-20" max="30" default="-1"/>
5110                <element name="wrldchg" function="true" type="void"><arguments/></element>
5111        </type>
5112        <type name="WorldMap" context="Visual style definition">
5113<description><![CDATA[Environment details for "Blocks" and "Heightfield" world type. The most important concept is a "Map", which is the array of Map elements. Internally, Maps have more elements than could be deduced from the user-supplied World.wrldsiz, as additional rows of element are added to provide smooth transitions to the flat surroundings.
5114
5115Blocks: x/ysize=World.wrldsiz+4 rows of blocks (from which only 2+World.wrldsiz rows are placed within the world boundaries)
5116
5117Smooth: x/ysize=World.wrldsiz+2 rows of vertices (creating World.wrldsiz+1 rows of triangles, everything within the world boundaries)
5118]]></description>
5119                <element name="xsize" type="integer"/>
5120                <element name="ysize" type="integer"/>
5121                <element name="getHeight" function="true" type="float">
5122                        <description><![CDATA[Height at any 2d coordinate]]></description>
5123                        <arguments>
5124                                <argument name="x" type="float"/>
5125                                <argument name="y" type="float"/>
5126                        </arguments>
5127                </element>
5128                <element name="getMap" function="true" type="Object">
5129                        <description><![CDATA[retrieve map cell object]]></description>
5130                        <arguments>
5131                                <argument name="x" type="integer"/>
5132                                <argument name="y" type="integer"/>
5133                        </arguments>
5134                </element>
5135                <element name="intersect" function="true" type="Vector">
5136                        <description><![CDATA[Calculate the intersection point between the world surface and the ray projected from "3d point" towards the given direction. 3D points are actually 3-elements Vector objects. The resulting vector contains the additional fourth element - the intersection point distance. The function returns null if there is no intersection.
5137
5138See "standard_events.inc" file, which uses "intersect" for calculating the world coordinates corresponding to the user-clicked screen location.
5139Bugs: This function does not currently handle the heightfield environment correctly (works as if it was flat)]]></description>
5140                        <arguments>
5141                                <argument name="3d point" type="Vector"/>
5142                                <argument name="3d direction" type="Vector"/>
5143                                <argument name="range" type="float"/>
5144                        </arguments>
5145                </element>
5146        </type>
5147        <type name="Signal" context="Signal label formula">
5148<description><![CDATA[Signals broadcast information in a channel (being an abstract communication medium that could be imagined as sound, smell, vision or anything else). There are no sender-receiver associations, although the receiving party can filter out signals (two standard filtering methods are: physical neighborhood and one-dimensional attribute called flavor). Signals attached to neurons and creatures (created in Creature.signals and Neuro.signals) automatically follow the owner's location. Environmental signals (in World.signals) are stationary.
5149
5150Receiving:
5151There are 2 kinds of data you can receive:
51521. aggregating functions (receive and receiveFilter) calculate the overall power of the received signal (based on the distance and the source power).
51532. receiveSet and receiveSingle fetch the individual Signal object(s) so it is possible to transmit something else than just a single number (by using Signal.value) and do more sophisticated processing.
5154
5155Creating: Use "add" in Creature.signals, Neuro.signals, or World.signals.]]></description>
5156                <element name="channel" type="string">
5157                        <description><![CDATA[Channel name, readonly.]]></description>
5158                </element>
5159                <element name="flavor" type="float">
5160                        <description><![CDATA[Signal flavor is can be used to differentiate between signals in a single channel. ]]></description>
5161                </element>
5162                <element name="pos" type="XYZ">
5163                        <description><![CDATA[Signal position, readonly.]]></description>
5164                </element>
5165                <element name="power" type="float">
5166                        <description><![CDATA[Signal power affects the aggregated signal value returned from receive() and receiveFilter().]]></description>
5167                </element>
5168                <element name="value" type="untyped">
5169                        <description><![CDATA[Signal value can be any type. On the receiver side it is only available by accessing the individual Signal objects, i.e. after calling receiveSet() or receiveSingle(). The aggregating function receive() and receiveFilter() ignore this attribute.]]></description>
5170                </element>
5171                <element name="remove" function="true">
5172                        <description><![CDATA[Deletes the signal]]></description>
5173                </element>
5174        </type>
5175        <type name="ClassBrowser" context="Command line interface">
5176<description><![CDATA[Object reference, can be used to provide online hints.]]></description>
5177                <element name="resultCount" type="integer"/>
5178                <element name="getLabel" function="true" type="string">
5179                        <description><![CDATA[Short texual label of the search result.]]></description>
5180                        <arguments>
5181                                <argument name="item" type="integer"/>
5182                        </arguments>
5183                </element>
5184                <element name="getText" function="true" type="string">
5185                        <description><![CDATA[Complete result text.]]></description>
5186                        <arguments>
5187                                <argument name="item" type="integer"/>
5188                        </arguments>
5189                </element>
5190                <element name="getType" function="true" type="integer">
5191                        <description><![CDATA[0 = Unknown
51921 = Context
51932 = Class
51943 = Member
51954 = Integer field
51965 = Float field
51976 = String field
51987 = Object field
51998 = Function]]></description>
5200                        <arguments>
5201                                <argument name="item" type="integer"/>
5202                        </arguments>
5203                </element>
5204                <element name="getTypeName" function="true" type="string">
5205                        <arguments>
5206                                <argument name="item" type="integer"/>
5207                        </arguments>
5208                </element>
5209                <element name="search" function="true" type="integer">
5210                        <description><![CDATA[Searches the class reference and returns the number of  hits (results). getXXX(item) function can be used to retrieve the results.]]></description>
5211                        <arguments>
5212                                <argument name="Text" type="string"/>
5213                        </arguments>
5214                </element>
5215        </type>
5216        <type name="CLI" context="Command line interface">
5217<description><![CDATA[Commandline support functions.]]></description>
5218                <element name="cmdhandler" type="string"/>
5219                <element name="msgtype" type="integer" min="0" max="1"/>
5220                <element name="script" type="string"/>
5221                <element name="stdin" type="Object"/>
5222                <element name="stdout" type="Object"/>
5223                <element name="addMacro" function="true" type="void">
5224                        <arguments>
5225                                <argument name="name" type="string"/>
5226                                <argument name="numargs" type="integer"/>
5227                                <argument name="definition" type="string"/>
5228                                <argument name="helptext" type="string"/>
5229                        </arguments>
5230                </element>
5231                <element name="execute" function="true" type="void">
5232                        <arguments>
5233                                <argument name="command" type="string"/>
5234                        </arguments>
5235                </element>
5236                <element name="listMacros" function="true" type="void"><arguments/></element>
5237                <element name="print" function="true" type="void">
5238                        <arguments>
5239                                <argument name="text" type="string"/>
5240                        </arguments>
5241                </element>
5242                <element name="println" function="true" type="void">
5243                        <arguments>
5244                                <argument name="text" type="string"/>
5245                        </arguments>
5246                </element>
5247                <element name="quit" function="true"/>
5248                <element name="removeMacro" function="true" type="void">
5249                        <description><![CDATA[(numargs==-2) means remove all macros matching the name, otherwise only one definition is removed]]></description>
5250                        <arguments>
5251                                <argument name="name" type="string"/>
5252                                <argument name="numargs" type="integer"/>
5253                        </arguments>
5254                </element>
5255        </type>
5256        <type name="CreatureCharts" context="Command line interface">
5257<description><![CDATA[Manages charts for monitoring creatures performance.
5258This class has no corresponding static object. If you want to use it, you have to create an object or get a reference to the existing object.]]></description>
5259                <element name="creature" type="untyped"/>
5260                <element name="selected" type="integer"/>
5261                <element name="add" function="true">
5262                        <description><![CDATA[return the new Window object with chart as its client
5263arguments: property to be tracked]]></description>
5264                </element>
5265                <element name="addSelected" function="true">
5266                        <description><![CDATA[Add the chart for currenly selected property]]></description>
5267                </element>
5268                <element name="createChart" function="true">
5269                        <description><![CDATA[return the new chart object (can be client for Window)
5270arguments: property to be tracked]]></description>
5271                </element>
5272                <element name="removeAll" function="true"/>
5273                <element name="resetAll" function="true">
5274                        <description><![CDATA[Removes all data from the chart windows.]]></description>
5275                </element>
5276        </type>
5277        <type name="CreatureSelection" context="Command line interface">
5278                <element name="count" type="integer"/>
5279                <element name="add" function="true"/>
5280                <element name="clear" function="true"/>
5281                <element name="get" function="true"/>
5282                <element name="remove" function="true"/>
5283        </type>
5284        <type name="DynaChart" context="Command line interface">
5285<description><![CDATA[Line chart (visual object). Can be used as the client object in the Window.]]></description>
5286                <element name="xscale" type="integer" min="1" max="20"/>
5287                <element name="add" function="true">
5288                        <description><![CDATA[add new value]]></description>
5289                </element>
5290                <element name="clear" function="true" type="void"><arguments/></element>
5291                <element name="new" function="true" type="DynaChart"><arguments/></element>
5292        </type>
5293        <type name="DynaChart2D" context="Command line interface">
5294<description><![CDATA[2D Line chart (visual object). Can be used as the client object in the Window.]]></description>
5295                <element name="memory" type="integer" min="1" max="1000" default="100">
5296                        <description><![CDATA[maximum number of (x,y) pairs drawn in the graph.]]></description>
5297                </element>
5298                <element name="add" function="true" type="void">
5299                        <description><![CDATA[add (x,y) values for the next graph point]]></description>
5300                        <arguments>
5301                                <argument name="x coordinate" type="float"/>
5302                                <argument name="y coordinate" type="float"/>
5303                        </arguments>
5304                </element>
5305                <element name="clear" function="true" type="void"><arguments/></element>
5306                <element name="new" function="true" type="DynaChart2D"><arguments/></element>
5307        </type>
5308        <type name="GLDisplay" context="Command line interface">
5309<description><![CDATA[OpenGL display for the Framsticks Theater application.]]></description>
5310                <element name="active" type="integer" min="0" max="1"/>
5311                <element name="banner" type="string"/>
5312                <element name="desiredsimspeed" type="float" min="0" max="999999" default="0">
5313                        <description><![CDATA[Desired simulation speed in steps/second. 0 = simulation is disabled.]]></description>
5314                </element>
5315                <element name="fps" type="float">
5316                        <description><![CDATA[Frames Per Second (measured)]]></description>
5317                </element>
5318                <element name="fpsvisible" type="integer" min="0" max="1"/>
5319                <element name="maxfps" type="integer" min="1" max="100" default="30"/>
5320                <element name="messagesVisible" type="integer" min="0" max="1"/>
5321                <element name="messagesWindow" type="Object">
5322                        <description><![CDATA[get window object (class Window)]]></description>
5323                </element>
5324                <element name="minfps" type="integer" min="1" max="100" default="5"/>
5325                <element name="simsteps" type="integer" min="0" max="999999" default="0">
5326                        <description><![CDATA[0 = simulation is disabled. In most cases you should use desiredsimspeed as it ensures automatic throttle control.]]></description>
5327                </element>
5328                <element name="size_x" type="integer"/>
5329                <element name="size_y" type="integer"/>
5330                <element name="userspeed" type="float" min="0" max="100" default="1">
5331                        <description><![CDATA[User interface sets this property to adjust simulation speed.]]></description>
5332                </element>
5333                <element name="clearMessages" function="true"/>
5334                <element name="createWindow" function="true" type="Window">
5335                        <description><![CDATA[create and return the new window object.]]></description>
5336                        <arguments>
5337                                <argument name="style" type="integer"/>
5338                                <argument name="title" type="string"/>
5339                                <argument name="client" type="Object"/>
5340                        </arguments>
5341                </element>
5342                <element name="deleteWindow" function="true" type="void">
5343                        <arguments>
5344                                <argument type="Window"/>
5345                        </arguments>
5346                </element>
5347                <element name="draw" function="true"/>
5348                <element name="newCreatureCharts" function="true"/>
5349                <element name="newSimStatsCharts" function="true"/>
5350                <element name="quit" function="true"/>
5351                <element name="resume" function="true"/>
5352                <element name="stop" function="true"/>
5353        </type>
5354        <type name="NeuroDiagram" context="Command line interface">
5355<description><![CDATA[Can be used as the client object in the Window.]]></description>
5356                <element name="hide" function="true" type="void"><arguments/></element>
5357                <element name="new" function="true"/>
5358                <element name="showCreature" function="true" type="void">
5359                        <arguments>
5360                                <argument type="Creature"/>
5361                        </arguments>
5362                </element>
5363                <element name="showModel" function="true" type="void">
5364                        <arguments>
5365                                <argument type="Model"/>
5366                        </arguments>
5367                </element>
5368        </type>
5369        <type name="RowFormat" context="Command line interface">
5370<description><![CDATA[Used for creating simple listings of objects (in command line applications). There is only one shared RowFormat object. In order to use RowFormat you should first configure it, by adding column definitions (prepare or addColumn), i.e. defining column names and widths. Then, the "format" method can be invoked on a number of objects (of the same class) returning the formatted rows of the table.
5371
5372Example:
5373RowFormat.clear();
5374RowFormat.prepare(Genotype.*,"name/20,strsiz/5,nnsiz/5,fit/6");
5375CLI.println(RowFormat.format(Genotype.*));]]></description>
5376                <element name="fieldsep" type="string">
5377                        <description><![CDATA[The character used for separating columns]]></description>
5378                </element>
5379                <element name="fillchar" type="string">
5380                        <description><![CDATA[The characted used for padding the columns contents]]></description>
5381                </element>
5382                <element name="header" type="string">
5383                        <description><![CDATA[Contains the field names with the same formatting applied (i.e. with fill and separators)]]></description>
5384                </element>
5385                <element name="addColumn" function="true" type="void">
5386                        <description><![CDATA[Low level call, adds a single column. "prepare" is better.]]></description>
5387                        <arguments>
5388                                <argument name="Field#" type="integer"/>
5389                                <argument name="Column width" type="integer"/>
5390                        </arguments>
5391                </element>
5392                <element name="clear" function="true" type="void">
5393                        <description><![CDATA[Remove all existing column definitions.]]></description>
5394<arguments/></element>
5395                <element name="format" function="true" type="string">
5396                        <description><![CDATA[Returns the formatted string taking data from the supplied object.]]></description>
5397                        <arguments>
5398                                <argument name="Object" type="Object"/>
5399                        </arguments>
5400                </element>
5401                <element name="prepare" function="true" type="void">
5402                        <description><![CDATA[Adds a number of columns, described as FIELD_NAME/WIDTH, columns are separated by "," (comma). Existing column definitions are not removed. Usually you will need to call "clear()" before "prepare".]]></description>
5403                        <arguments>
5404                                <argument name="Object" type="Object"/>
5405                                <argument name="Column Descriptions" type="string"/>
5406                        </arguments>
5407                </element>
5408        </type>
5409        <type name="ShowManager" context="Command line interface">
5410                <element name="changedProperty" type="integer"/>
5411                <element name="changedPropertyId" type="string"/>
5412                <element name="code" type="string"/>
5413                <element name="dispinfo" type="integer" min="0" max="2"/>
5414                <element name="expdef" type="string"/>
5415                <element name="info" type="string"/>
5416                <element name="mode" type="integer" min="0" max="2"/>
5417                <element name="name" type="string"/>
5418                <element name="regname" type="string"/>
5419                <element name="show" type="string"/>
5420                <element name="showlog" type="integer" min="0" max="1"/>
5421                <element name="switchmode" type="integer" min="0" max="2"/>
5422                <element name="switchshows" type="string">
5423                        <description><![CDATA[names of the shows participating in automatic switching (comma separated). Use * as a wildcard.]]></description>
5424                </element>
5425                <element name="switchtime" type="integer" min="0" max="9999">
5426                        <description><![CDATA[time between switching (seconds)]]></description>
5427                </element>
5428                <element name="userspeed" type="integer" min="0" max="5" default="3"/>
5429                <element name="about" function="true"/>
5430                <element name="add" function="true"/>
5431                <element name="addGroup" function="true"/>
5432                <element name="clear" function="true"/>
5433                <element name="dummy" function="true">
5434                        <description><![CDATA[This is the empty item in the Theater's menu]]></description>
5435                </element>
5436                <element name="reload" function="true"/>
5437                <element name="remove" function="true"/>
5438                <element name="removeGroup" function="true"/>
5439        </type>
5440        <type name="SignalView" context="Command line interface">
5441                <element name="labels" type="string">
5442                        <description><![CDATA[The label formula should return a text to be displayed over the signal source, presumably by reading some values from the supplied Signal object. It is especially useful for more sophisticated signal usage scenarios with Signal.value holding object references (the default signal label only shows <XXX Object at xxxxx> in such cases)]]></description>
5443                </element>
5444                <element name="mode" type="integer" min="0" max="2"/>
5445                <element name="addMap" function="true" type="void">
5446                        <arguments>
5447                                <argument name="channel" type="string"/>
5448                                <argument name="color" type="integer"/>
5449                        </arguments>
5450                </element>
5451                <element name="addSignals" function="true" type="void">
5452                        <arguments>
5453                                <argument name="channel" type="string"/>
5454                                <argument name="color" type="integer"/>
5455                                <argument name="angle_x" type="integer"/>
5456                                <argument name="angle_y" type="integer"/>
5457                                <argument name="angle_z" type="integer"/>
5458                        </arguments>
5459                </element>
5460                <element name="addSignalsFilter" function="true" type="void">
5461                        <arguments>
5462                                <argument name="channel" type="string"/>
5463                                <argument name="color" type="integer"/>
5464                                <argument name="angle_x" type="integer"/>
5465                                <argument name="angle_y" type="integer"/>
5466                                <argument name="angle_z" type="integer"/>
5467                                <argument name="flavor" type="integer"/>
5468                                <argument name="filter" type="integer"/>
5469                        </arguments>
5470                </element>
5471                <element name="clear" function="true"/>
5472        </type>
5473        <type name="SimStatsCharts" context="Command line interface">
5474<description><![CDATA[Manages charts for monitoring simulator statistics.
5475This class has no corresponding static object. If you want to use it, you have to create an object or get a reference to the existing object.]]></description>
5476                <element name="selected" type="integer"/>
5477                <element name="add" function="true"/>
5478                <element name="createChart" function="true"/>
5479                <element name="removeAll" function="true"/>
5480                <element name="resetAll" function="true">
5481                        <description><![CDATA[Removes all data from the chart windows.]]></description>
5482                </element>
5483                <element name="sscAddSelected" function="true"/>
5484        </type>
5485        <type name="TrackingCam" context="Command line interface">
5486<description><![CDATA[Camera object with the automatic target tracking ability.]]></description>
5487                <element name="cam_change" type="integer" min="0" max="5" default="3"/>
5488                <element name="cam_chspeed" type="float" min="0.1" max="10" default="1"/>
5489                <element name="cam_dir" type="float" min="0" max="360" default="30"/>
5490                <element name="cam_distrac" type="integer" min="0" max="1" default="0">
5491                        <description><![CDATA[Suspend automatic tracking when the camera is moved manually]]></description>
5492                </element>
5493                <element name="cam_h" type="float" min="0" max="360" default="45">
5494                        <description><![CDATA[0=side view, 90=top view]]></description>
5495                </element>
5496                <element name="cam_restrac" type="integer" min="0" max="100" default="10">
5497                        <description><![CDATA[Restore automatic tracking after some period of time
5498(0 to never restore automatic tracking)]]></description>
5499                </element>
5500                <element name="cam_tracking" type="integer" min="0" max="3" default="1"/>
5501                <element name="cam_trspeed" type="float" min="0.1" max="10" default="5"/>
5502                <element name="cam_zoom" type="float" min="0.2" max="3" default="0.8"/>
5503                <element name="cam_restore" function="true" type="void">
5504                        <description><![CDATA[Update camera position and restore automatic tracking]]></description>
5505<arguments/></element>
5506                <element name="moveTarget" function="true" type="void">
5507                        <description><![CDATA[notify about the target location/size change]]></description>
5508                        <arguments>
5509                                <argument name="location x" type="float"/>
5510                                <argument name="location y" type="float"/>
5511                                <argument name="location z" type="float"/>
5512                                <argument name="target size" type="float"/>
5513                        </arguments>
5514                </element>
5515                <element name="setTarget" function="true" type="void">
5516                        <description><![CDATA[select a new target for the camera]]></description>
5517                        <arguments>
5518                                <argument name="location x" type="float"/>
5519                                <argument name="location y" type="float"/>
5520                                <argument name="location z" type="float"/>
5521                                <argument name="target size" type="float"/>
5522                        </arguments>
5523                </element>
5524                <element name="setViewDir" function="true" type="void">
5525                        <description><![CDATA[heading: 0..360, height: -90..+90]]></description>
5526                        <arguments>
5527                                <argument name="heading angle" type="float"/>
5528                                <argument name="height angle" type="float"/>
5529                        </arguments>
5530                </element>
5531        </type>
5532        <type name="VisualStyle" context="Command line interface">
5533                <element name="changedProperty" type="integer"/>
5534                <element name="changedPropertyId" type="string"/>
5535                <element name="code" type="string"/>
5536                <element name="info" type="string"/>
5537                <element name="modelpan" type="integer" min="0" max="3">
5538                        <description><![CDATA[]]></description>
5539                </element>
5540                <element name="name" type="string"/>
5541                <element name="neurons" type="integer" min="0" max="1"/>
5542                <element name="shownames" type="integer" min="0" max="1">
5543                        <description><![CDATA[]]></description>
5544                </element>
5545                <element name="smooth" type="integer" min="0" max="1"/>
5546                <element name="style" type="string"/>
5547                <element name="tex" type="integer" min="0" max="2"/>
5548                <element name="worldpan" type="integer" min="0" max="3">
5549                        <description><![CDATA[]]></description>
5550                </element>
5551                <element name="add" function="true"/>
5552                <element name="addGroup" function="true"/>
5553                <element name="clear" function="true"/>
5554                <element name="rebuild" function="true"/>
5555                <element name="remove" function="true"/>
5556                <element name="removeGroup" function="true"/>
5557                <element name="streload" function="true"/>
5558        </type>
5559        <type name="Window" context="Command line interface">
5560<description><![CDATA[Window object, used in the Framsticks Theater application.
5561This class has no corresponding static object. If you want to use it, you have to create an object or get a reference to the existing object.
5562 See also: GLDisplay]]></description>
5563                <element name="backcolor" type="integer">
5564                        <description><![CDATA[format: 0xAABBGGRR (alpha,blue,green,red)]]></description>
5565                </element>
5566                <element name="client" type="Object">
5567                        <description><![CDATA[what is displayed in the window]]></description>
5568                </element>
5569                <element name="pos_x" type="integer"/>
5570                <element name="pos_y" type="integer"/>
5571                <element name="size_x" type="integer"/>
5572                <element name="size_y" type="integer"/>
5573                <element name="style" type="integer">
5574                        <description><![CDATA[bitfield:
55751 - border
55762 - title
55774 - Opaque background
55788 - Close button
557916 - resizable]]></description>
5580                </element>
5581                <element name="title" type="string"/>
5582        </type>
5583</framscript>
Note: See TracBrowser for help on using the repository browser.