Ignore:
Timestamp:
09/19/17 02:35:09 (4 years ago)
Author:
sz
Message:

updated for the Framsticks release v5.0rc11 (mostly documentation improvements)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • java/Framclipse/com.framsticks.framclipse/res/framscript.xml

    r693 r699  
    128128                        <description><![CDATA[Note that the index changes depending on the current creature position in the population. Use Creature.uid if you need a permanent identifier that persists through the entire object lifetime.]]></description>
    129129                </element>
     130                <element name="num" type="integer">
     131                        <description><![CDATA[Acts as a unique identifier, but less strict than "uid". Unlike "uid", "num" can be changed and therefore can be saved and restored, providing persistence and continuity beyond a single application run. "num" is only guaranteed to be unique if it is autogenerated and not changed by the user, otherwise it is user's responsibility to manage the proper values of "num". Autogenerated "num" is always equal to the largest previously used "num" + 1. The largest previously used value is stored in Simulator.last_creature_num and can be changed as well (and is automatically saved and restored as a part of the Simulator state). Limitation: being a 32-bit integer, "num" overflows at about 2 billion counts.
     132See also: uid]]></description>
     133                </element>
    130134                <element name="gnum" type="integer"/>
    131135                <element name="buildproblems" type="integer" flags="34"/>
     
    365369                </element>
    366370                <element name="uid" type="string" flags="1">
    367                         <description><![CDATA[Unique identifier]]></description>
     371                        <description><![CDATA[Unique identifier that is generated on object creation. "uid" is only unique during a single application run. Subsequent runs generate the same sequence of uid values.
     372See also: num]]></description>
    368373                </element>
    369374                <element name="signals" type="CreatureSignals" flags="35"/>
     
    479484        </type>
    480485        <type name="CreatureSnapshot" context="Global context">
    481 <description><![CDATA[A data object consisting of the same fields as the serialized Creature. Typically used for reading a Creature back from a file, then Population.add(snapshot_object) creates the Creature object from the snapshot.]]></description>
     486<description><![CDATA[A data object consisting of the same fields as the serialized Creature. Typically used for reading a Creature back from a file; Population.add(snapshot_object) recreates the Creature object from the snapshot. When the creature is added to a population and it happens to collide with the terrain, the creature will be automatically moved upwards just enough to avoid the collision.
     487Serialized Creature preserves most of its data fields (including the 'data' dictionary) but only keeps aggregated information about its physical state, which is body orientation and location of the bounding box center. Individual physical body parts' locations, states and neuron states are lost.
     488Restoring the state of a formerly living, serialized creature using its CreatureSnapshot is not perfect. Apart from losing information about individual body and brain parts and their states, the usual flow of calculating performance may be disturbed, which is related to the 'performance sampling period' being interrupted as well as the specifics of the 'freezing period' mechanism. In consequence, the intended behavior of 'lifespan', 'steps_in_lifespan', and performance fields may be broken. For example, when period=100, after every 100 'steps_in_lifespan', the 'lifespan' increases by 100 and the new performance data is calculated. When the period is interrupted by saving/restoring, 'steps_in_lifespan' continues to increase from the saved value, but performance counters will be waiting another full 100 steps before the next update, losing the information from the unfinished period. The resulting 'lifespan' will be lower than it would have been without interruptions, and will be inconsistent with 'steps_in_lifespan'. Because of these issues, it is strongly advised to thoroughly inspect and test the behavior of the restored Creatures in various moments in their lifepspan, and use CreatureSnapshot only when necessary.
     489See also: scripts/standard_exploadsave.inc
     490See also: Population.add()
     491]]></description>
    482492                <element name="new" function="true" type="Creature"><arguments/></element>
    483493                <element name="name" type="string" max="40"/>
     
    485495                <element name="info" type="string">
    486496                        <description><![CDATA[Additional info or comments]]></description>
     497                </element>
     498                <element name="num" type="integer">
     499                        <description><![CDATA[Acts as a unique identifier, but less strict than "uid". Unlike "uid", "num" can be changed and therefore can be saved and restored, providing persistence and continuity beyond a single application run. "num" is only guaranteed to be unique if it is autogenerated and not changed by the user, otherwise it is user's responsibility to manage the proper values of "num". Autogenerated "num" is always equal to the largest previously used "num" + 1. The largest previously used value is stored in Simulator.last_creature_num and can be changed as well (and is automatically saved and restored as a part of the Simulator state). Limitation: being a 32-bit integer, "num" overflows at about 2 billion counts.
     500See also: uid]]></description>
    487501                </element>
    488502                <element name="gnum" type="integer"/>
     
    544558                </element>
    545559                <element name="uid" type="string">
    546                         <description><![CDATA[Unique identifier]]></description>
     560                        <description><![CDATA[Unique identifier that is generated on object creation. "uid" is only unique during a single application run. Subsequent runs generate the same sequence of uid values.
     561See also: num]]></description>
    547562                </element>
    548563        </type>
     
    17041719                <element name="numneurons" type="integer" flags="16"/>
    17051720                <element name="numconnections" type="integer" flags="16"/>
    1706                 <element name="num" type="integer"/>
     1721                <element name="num" type="integer">
     1722                        <description><![CDATA[Acts as a unique identifier, but less strict than "uid". Unlike "uid", "num" can be changed and therefore can be saved and restored, providing persistence and continuity beyond a single application run. "num" is only guaranteed to be unique if it is autogenerated and not changed by the user, otherwise it is user's responsibility to manage the proper values of "num". "Genotype.num" is generated on adding a Genotype object to a group, unless it already has a non-zero "num" (previously autogenerated or user-assigned). Autogenerated "num" is always equal to the largest previously used "num" + 1. The largest previously used value is stored in Simulator.last_genotype_num and can be changed as well (and is automatically saved and restored as a part of the Simulator state). Limitation: being a 32-bit integer, "num" overflows at about 2 billion counts.
     1723See also: uid]]></description>
     1724                </element>
    17071725                <element name="gnum" type="integer"/>
    17081726                <element name="popsiz" type="integer" deprecated="true" flags="8226">
     
    17511769                </element>
    17521770                <element name="uid" type="string" flags="1">
    1753                         <description><![CDATA[Unique identifier]]></description>
     1771                        <description><![CDATA[Unique identifier that is generated on object creation. "uid" is only unique during a single application run. Subsequent runs generate the same sequence of uid values.
     1772See also: num]]></description>
    17541773                </element>
    17551774                <element name="getModel" function="true" type="Model" flags="32"><arguments/></element>
     
    30733092                </element>
    30743093                <element name="add" function="true" type="Creature" flags="34">
    3075                         <arguments>
    3076                                 <argument name="genotype object or geno object or string genotype" type="untyped"/>
     3094                        <description><![CDATA[Adding CreatureSnapshot object automatically copies the CreatureSnapshot fields into the Creature, including creature location (the center of the bounding box is preserved) and orientation.
     3095See also: CreatureSnapshot]]></description>
     3096                        <arguments>
     3097                                <argument name="Genotype object or Geno object or string genotype or CreatureSnapshot object" type="untyped"/>
    30773098                        </arguments>
    30783099                </element>
     
    34803501                <element name="time" type="integer" deprecated="true" flags="8226">
    34813502                        <description><![CDATA[Simulator.time will be removed because of its misleading name, please use Simulator.stepNumber instead.]]></description>
     3503                </element>
     3504                <element name="last_genotype_num" type="integer" min="0" max="-1" default="0" flags="32">
     3505                        <description><![CDATA[See: Genotype.num]]></description>
     3506                </element>
     3507                <element name="last_creature_num" type="integer" min="0" max="-1" default="0" flags="32">
     3508                        <description><![CDATA[See: Creature.num]]></description>
    34823509                </element>
    34833510                <element name="stepNumber" type="integer" flags="34"/>
     
    46584685                <element name="time" type="integer" deprecated="true" flags="8226">
    46594686                        <description><![CDATA[Simulator.time will be removed because of its misleading name, please use Simulator.stepNumber instead.]]></description>
     4687                </element>
     4688                <element name="last_genotype_num" type="integer" min="0" max="-1" default="0" flags="32">
     4689                        <description><![CDATA[See: Genotype.num]]></description>
     4690                </element>
     4691                <element name="last_creature_num" type="integer" min="0" max="-1" default="0" flags="32">
     4692                        <description><![CDATA[See: Creature.num]]></description>
    46604693                </element>
    46614694                <element name="stepNumber" type="integer" flags="34"/>
     
    56505683                <element name="numneurons" type="integer" flags="16"/>
    56515684                <element name="numconnections" type="integer" flags="16"/>
    5652                 <element name="num" type="integer"/>
     5685                <element name="num" type="integer">
     5686                        <description><![CDATA[Acts as a unique identifier, but less strict than "uid". Unlike "uid", "num" can be changed and therefore can be saved and restored, providing persistence and continuity beyond a single application run. "num" is only guaranteed to be unique if it is autogenerated and not changed by the user, otherwise it is user's responsibility to manage the proper values of "num". "Genotype.num" is generated on adding a Genotype object to a group, unless it already has a non-zero "num" (previously autogenerated or user-assigned). Autogenerated "num" is always equal to the largest previously used "num" + 1. The largest previously used value is stored in Simulator.last_genotype_num and can be changed as well (and is automatically saved and restored as a part of the Simulator state). Limitation: being a 32-bit integer, "num" overflows at about 2 billion counts.
     5687See also: uid]]></description>
     5688                </element>
    56535689                <element name="gnum" type="integer"/>
    56545690                <element name="popsiz" type="integer" deprecated="true" flags="8226">
     
    56975733                </element>
    56985734                <element name="uid" type="string" flags="1">
    5699                         <description><![CDATA[Unique identifier]]></description>
     5735                        <description><![CDATA[Unique identifier that is generated on object creation. "uid" is only unique during a single application run. Subsequent runs generate the same sequence of uid values.
     5736See also: num]]></description>
    57005737                </element>
    57015738                <element name="getModel" function="true" type="Model" flags="32"><arguments/></element>
     
    57615798                <element name="index" type="integer" flags="35">
    57625799                        <description><![CDATA[Note that the index changes depending on the current creature position in the population. Use Creature.uid if you need a permanent identifier that persists through the entire object lifetime.]]></description>
     5800                </element>
     5801                <element name="num" type="integer">
     5802                        <description><![CDATA[Acts as a unique identifier, but less strict than "uid". Unlike "uid", "num" can be changed and therefore can be saved and restored, providing persistence and continuity beyond a single application run. "num" is only guaranteed to be unique if it is autogenerated and not changed by the user, otherwise it is user's responsibility to manage the proper values of "num". Autogenerated "num" is always equal to the largest previously used "num" + 1. The largest previously used value is stored in Simulator.last_creature_num and can be changed as well (and is automatically saved and restored as a part of the Simulator state). Limitation: being a 32-bit integer, "num" overflows at about 2 billion counts.
     5803See also: uid]]></description>
    57635804                </element>
    57645805                <element name="gnum" type="integer"/>
     
    59996040                </element>
    60006041                <element name="uid" type="string" flags="1">
    6001                         <description><![CDATA[Unique identifier]]></description>
     6042                        <description><![CDATA[Unique identifier that is generated on object creation. "uid" is only unique during a single application run. Subsequent runs generate the same sequence of uid values.
     6043See also: num]]></description>
    60026044                </element>
    60036045                <element name="signals" type="CreatureSignals" flags="35"/>
Note: See TracChangeset for help on using the changeset viewer.