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

Last change on this file since 27 was 27, checked in by sz, 15 years ago

the most recent framscript XML

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