User Tools

Site Tools


modding:xml:api_version

This is an old revision of the document!


Every extension declares the version of Transcendence that it is compatible with. This allows the Transcendence engine to maintain the greatest level of compatibility while still adding new features and evolving the API.

Starting with Transcendence version 1.08e, the method for declaring the compatibility version has itself changed. An extension that is aware of all the changes in 1.08e must declare itself compatible by adding a new property in its root element:

<TranscendenceExtension ...
   apiVersion="12"
   ...
   >
...

This new property, apiVersion will be used in future versions to track the API that the extension wishes to use. (Note the lack of a period in the version.)

Extensions may still use the older version property to specify that they wish to be compatible with older versions.

API Version 12

Engine version: 1.08e and above.

  • apiVersion property used to specify compatibility version.
  • Player ship classes must use “00200000_PlayerShip” attribute in order to appear as a player ship in Stars of the Pilgrim adventure.
  • Engine validates existence of sound references. I.e., types cannot refer to non-existent sound UNIDs.
  • An extension/adventure cannot define multiple types of the same UNID (an error will be reported). In previous versions one of the types was silently ignored.

API Version 1.1

Engine version: 1.04 and above.

NOTE: You must use version=“1.1” to access this API version.

API Version 1.0

Engine version: 1.0 and above.

NOTE: You must use version=“1.0” to access this API version.

  • For version 1.0 and below, when defining weapons, passthrough should not equal “0” (or it will default to “50”).
  • For version 1.0 and below, when defining <SmokeTrail> effects there was a bug with emitSpeed. Double the normal speed for compatibility.
  • For version 1.0 and below, when defining weapons, the shield damage modified used a different calculation because we only allocated 3 bits for the damage range.
modding/xml/api_version.1347744218.txt.gz · Last modified: 2014/12/27 04:40 (external edit)