User Tools

Site Tools


modding:xml:api_version

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
modding:xml:api_version [2013/09/02 19:43] gpmmodding:xml:api_version [2017/01/16 19:42] (current) – Added APIs 29-34 xephyr
Line 16: Line 16:
  
 The following API versions are implemented: The following API versions are implemented:
 +
 +====API Version 34====
 +
 +Transcendence 1.7 Beta 5
 +
 +[[http://ministry.kronosaur.com/record.hexm?id=66822|Full API spec on Ministry]]
 +
 +====API Version 33====
 +
 +Transcendence 1.7 Beta 4
 +
 +[[http://ministry.kronosaur.com/record.hexm?id=62046|Full API spec on Ministry]]
 +
 +====API Version 32====
 +
 +Transcendence 1.7 Beta 3
 +
 +[[http://ministry.kronosaur.com/record.hexm?id=61158|Full API spec on Ministry]]
 +
 +====API Version 31====
 +
 +Transcendence 1.7 Beta 1
 +
 +[[http://ministry.kronosaur.com/record.hexm?id=57824|Full API spec on Ministry]]
 +
 +====API Version 30====
 +
 +Transcendence 1.7 Alpha 2
 +
 +[[http://ministry.kronosaur.com/record.hexm?id=54396|Full API spec on Ministry]]
 +
 +====API Version 29====
 +
 +Transcendence 1.7 stream
 +
 +[[http://ministry.kronosaur.com/record.hexm?id=8048|Full API spec on Ministry]]
 +
 +====API Version 27====
 +====API Version 26====
 +====API Version 25====
 +====API Version 24====
 +====API Version 23====
 +====API Version 22====
 +====API Version 22====
 +Transcendence 1.3 and above.
  
 ====API Version 14==== ====API Version 14====
-**[IN PROGRESS]** 
 Transcendence 1.2 Beta 1 and above. Transcendence 1.2 Beta 1 and above.
  
 === Dynamic Effects === === Dynamic Effects ===
 +Dynamic effects are visual effects whose parameters are modified at runtime. A dynamic effect uses the <GetParameters> event on an <EventType> to dynamically set the effect parameters. For example:
 +
 +  <EffectType UNID="..."
 +        instance="creator"
 +        >
 +     <Effect>
 +        <Ray
 +           style="..."
 +           ...
 +           >
 +           
 +           <Events>
 +              <GetParameters>
 +                 (block Nil
 +                    ...
 +              
 +                    {
 +                       length: ...
 +                       width: ...
 +                       intensity: ...
 +                       }
 +                    )
 +              </GetParameters>
 +           </Events>
 +        </Ray>
 +     </Effect>
 +  </EffectType>
 +
 +In the above example, the parameters for the <Ray> effect are being set by the <GetParameters> function, which returns a struct. Each field in the struct represents a parameter in the <Ray> element to be set.
 +
 +The **instance** parameter on <EffectType> defines when <GetParameters> is called to set the effect parameters. The valid instances are:
 +
 +  * creator: The effect parameters are defined each time the effect is created (e.g., when the weapon is fired).
 +  * game: The effect parameters are defined once at the beginning of the game and shared. For example, if multiple weapons use the same effect, all will use the same parameters.
 +  * owner: The effect parameters are defined once per effect owner. For example, if multiple weapons use the same effect, the effect will be defined separately for each weapon.
  
 +NOTE: As of API version 14, only the <Ray> effect supports dynamic effects.
  
 === Enhancement Devices === === Enhancement Devices ===
modding/xml/api_version.1378151017.txt.gz · Last modified: 2014/12/27 04:40 (external edit)