Transcendence Community Wiki - modding:xml

0.99c_-_1.0_rc1

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

0.99c_-_1.0_rc1. Changes in XML elements between 0.99c and 1.0 RC1 FIXME This is *very* rough draft. Please contribute. * Two new system events (can be used with objRegisterForSystemEvents) * OnSystemWeaponFire * aWeaponObj - the ship firing the weapon

adventuredesc

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Overview defines the properties and behavior of an adventure. Starting Ship Classes An adventure has some control over the set of starting ship classes to offer the player and the location (the star system) where the player will start the game. The following properties are available:

adventures_and_extensions

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

NOTE: Some features described in this article (particularly those related to libraries) are only available in version 1.09 and above. Adventures Transcendence is a game engine that can run a variety of adventures. Each adventure is a complete game: the player chooses an adventure to start playing and continues playing that adventure until the game ends.

ai

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

AI topics XML elements combatstyle There are four AI combat styles: * combatstyle=“standoff” * combatstyle=“noretreat” * combatstyle=“flyby” * and no combat style All except noretreat seem to dictate engagement range and nothing else. Standoff enemies will fight at the maximum range of their weapons or close to it. Flyby enemies will make close approaches. Default enemies and noretreat enemies are in between. Noretreat also will make a ship not escape when its shields are down.…

api_version

Anonymous (anonymous@undisclosed.example.com) — 2025-09-23T02:07:00+00:00

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 using 1.1+ features must declare itself compatible by adding a new property in its root element:

armor

Anonymous (anonymous@undisclosed.example.com) — 2017-04-13T07:19:41+00:00

Damage fraction by level These are the percentages of how often you would encounter certain damage types at each level. For instance, blast 0.25 at level 3 means that about 25% of the damage you encounter at level 3 is blast damage. These values are used in balance calculations

artwork_scales

Anonymous (anonymous@undisclosed.example.com) — 2017-02-21T01:21:08+00:00

This article describes how to calculate the size of artwork from the physical size of objects in the game. Planets & Asteroids This scale is generally used for large-scale objects (larger than 10 kilometers) that the player does not generally dock with (i.e., is generally not on the same plane).

autodefensedevice

Anonymous (anonymous@undisclosed.example.com) — 2017-01-31T20:51:13+00:00

Overview An AutoDefenseDevice is a miscellaneous device, acting as a weapon that fires without the player's control. It is often used for missile defense. Attributes rechargeTime= DEPRECATED: Replaced by fireRate fireRate= The time in 1/60 sec between shots. Defaults to 15.

cargoholddevice

Anonymous (anonymous@undisclosed.example.com) — 2017-01-31T21:10:39+00:00

Overview A cargo hold device is a miscellaneous device that increases maximum cargo capacity. Usually one per ship and limited by maxCargoSpace. Attributes cargoSpace= The number of tons to increase max cargo capacity by. Negative values automatically clip to 0.

cyberdeckdevice

Anonymous (anonymous@undisclosed.example.com) — 2017-02-05T00:00:18+00:00

Overview A CyberDeckDevice is a miscellaneous (and usually virtual) device that carries out cyberattacks, which inflict special effects without physical damage. They work only on ships and cannot be fired without a target. Their fire rate is locked at one attack per second.

damage_descriptor

Anonymous (anonymous@undisclosed.example.com) — 2018-07-18T06:42:08+00:00

A damage descriptor string is used to specify a type and amount of damage. It also includes modifiers for special damage (such as radioactive contamination). A damage string consists of a single damage specifier plus zero or more special damage modifiers

designtype

Anonymous (anonymous@undisclosed.example.com) — 2018-08-09T18:53:45+00:00

A DesignType is a XML tag that defines a chunk of game data. Most XML tags contained directly under a root level element are DesignType tags. DesignType Types Instantiated DesignTypes These are types that you can deal with instances of directly. * ItemType as itemStructs

device

Anonymous (anonymous@undisclosed.example.com) — 2017-06-04T21:03:01+00:00

Summary Overview A device is an item that can be installed in a device slot to serve a particular function for its user. All the following elements are in this category. * * * All device elements can have these attributes

dice_range

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

A dice range is a number generated through the use of dice notation. In Transcendence, dice ranges are used primarily to simulate damage variation on weapons. However, dice ranges also have other uses, such as generating a single item in varying quantities across different stations of the same type.

dockscreen

Anonymous (anonymous@undisclosed.example.com) — 2017-10-24T06:48:11+00:00

Discuss this page. Summary * * unid= * name= * “={code}” Runs TLisp code. Must return a string * desc= * type= * “canvas” * “itemPicker” * “deviceSelector” * “weaponsSelector” * “armorSelector

drivedevice

Anonymous (anonymous@undisclosed.example.com) — 2017-04-13T07:23:33+00:00

Overview A drive device is a miscellaneous device that increases the maneuverability of a ship. One per ship by default. Basic Attributes * maxSpeed= The maximum speed (in % of light-speed) when this drive is enabled. Applies only if it is greater than the ship's default value.

economytype

Anonymous (anonymous@undisclosed.example.com) — 2016-07-04T06:59:31+00:00

Overview is used to define new currencies. The default currency is Credits, which serves as the baseline for conversion/exchange rates. This can be used to create new economies, such as Rin, or the other currencies introduced in Eternity Port.

effecttype

Anonymous (anonymous@undisclosed.example.com) — 2018-03-16T11:57:51+00:00

Summary * EffectType: If this contains an Effect or multiple subelements, then it is considered a dynamically created group of effects. If there is one subelement, then it becomes a simple effect creator. If there are none, then it becomes a Null creator.

events

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Pages that List Events * SpaceObject * DesignType Unclassified Found inside Found inside When a communication menu messages is shown. Item Events

game_lifecycle

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Creating a New Game When a new game is created, the engine follows these steps: * Load adventure: We load the adventure that the player has selected. This may potentially enable or disable various extensions based on the requirements of each extension and the adventure itself.

game_seconds

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

In Transcendence, a game second is a unit of time measurement. An actual second is equivalent to 30 ticks, which in turn is equivalent to 60 game seconds. Certain parameters use ticks as a unit of measurement, and some events are called after specific intervals measured in ticks. For instance:

image

Anonymous (anonymous@undisclosed.example.com) — 2017-02-12T07:32:35+00:00

Summary * * UNID= * bitmap= * “[directory]/[name].bmp” * bitmask= * “[directory]/[name].jpg” * loadOnUse=

itemtable

Anonymous (anonymous@undisclosed.example.com) — 2017-02-12T07:12:46+00:00

Summary * . Contains multiple generators. All child generators and their children can have chance (100 by default) and count (1 by default). Each generator is tested for chance and if successful will run a number of times based on count

itemtype

Anonymous (anonymous@undisclosed.example.com) — 2017-09-26T05:19:26+00:00

Overview defines the properties and behavior of a type of item. Weapons, shields, and armor are all considered items. Basic Properties UNID= The UNID of the item type. name= The name of the item type. Use name syntax to express both the singular and plural forms (if necessary).

itemtype_talk_page

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Talk page for itemtype Item Type:: Talk Page cargo space Can a cargo hold give a negative cargo space? showReference I think it has something to do with showing the hp damage and whatnot in item screens. data Older attribute used to store and retrieve misc data.

listoptions

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Discuss this page on this page's Talk Page. FIXME Please correct any inaccuracies. From the XML'd elementDocument ListOptions is a child element of For actual example of use see a mod like Conduct no-buy. …

lookup

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Discuss this page on this page's Talk Page. FIXME Please correct any inaccuracies. From the XML'd elementDocument Lookup is a child element of or of (itself a child element of

). For actual example of use you can see Transcendence.xml (one pasted below) or one of a large number of mods.

lookup_talk_page

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

This is the Talk Page for Lookup Lookup: Talk Page Item lookup table data from Transcendence.xml " This was all originally in a format like ..." " " I am not sure it is a good idea that we replicate all this information on the wiki. First of all, it is a lot of work to maintain between releases, where these things

miscellaneousdevice

Anonymous (anonymous@undisclosed.example.com) — 2017-02-01T02:50:04+00:00

Overview A MiscellaneousDevice is a device that does not fit in any particular category. Its user can invoke it to activate a special function. If the device has a capacitor, then it can only be invoked when the capacitor is full. Basic Attributes

missiontype

Anonymous (anonymous@undisclosed.example.com) — 2017-02-07T01:26:21+00:00

Overview defines the properties and behavior of a type of mission, represented as a mission object. The relationship between a MissionType and a mission object is similar to that between a StationType and a station object. A MissionType is like a template for a mission object; multiple mission objects may be instantiated per MissionType.

overlaytype

Anonymous (anonymous@undisclosed.example.com) — 2017-01-21T07:10:41+00:00

Overview defines a type of attachment or enhancement to space object instances. For example, the pteravore attack which attaches on to a ship and drains fuel is implemented as an OverlayType. Basic Attributes UNID= The UNID of this type. disarm=

playersettings

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Overview The element is a sub-element of . It defines the properties necessary to turn a ship into a player ship class. If a ship class has no the engine checks any inherited bases classes. If no element is found the ship class is not considered a player ship.

power

Anonymous (anonymous@undisclosed.example.com) — 2017-02-12T07:08:45+00:00

Summary * * name= * attributes= * key= * . Determines whether the player can attempt to invoke this power. * Code * Return * True: * Nil: * . Determines whether the player's attempt to invoke this power will be successful.

ref

Anonymous (anonymous@undisclosed.example.com) — 2017-02-05T18:09:35+00:00

FIXME! Note: merge into designtype. These articles describe various modding topics in more detail. Dockscreens * Dockscreens Items Ships & Stations * AI Systems & Topology * Game Lifecycle TransLISP * Events (Itemtype Events) (Shield Events) (Weapon Events) Miscellaneous * Uncategorized Information From George

repairerdevice

Anonymous (anonymous@undisclosed.example.com) — 2017-01-31T22:32:30+00:00

RepairerDevice A RepairerDevice is a miscellaneous device that repairs the armor on a ship. Repairing occurs every 10 ticks, or 3 times per second. The rate at which the device repairs an armor segment depends on that segment's level. Basic Attributes

shields

Anonymous (anonymous@undisclosed.example.com) — 2017-06-28T06:35:42+00:00

Overview Shields are installable item types that absorb damage. The element defines their characteristics. Basic Attributes This section is incomplete. powerUse= The amount of power consumed while the shield is recharging, in tenths of megawatts.

shield_devices

Anonymous (anonymous@undisclosed.example.com) — 2017-02-05T18:08:41+00:00

~~GOTO>modding:xml:shields~~

shipclass

Anonymous (anonymous@undisclosed.example.com) — 2017-07-25T00:53:01+00:00

Discuss this page. Summary * * manufacturer= [string] * class= [string] * type= [string] * armorCriteria= [criteria_item] * deviceCriteria= [criteria_item] * level= [whole] * drivePowerUse= [whole] * inertialessDrive= [boolean]

shiptable

Anonymous (anonymous@undisclosed.example.com) — 2017-02-12T07:26:21+00:00

Summary * or . Runs multiple generators. All child generators may have chance (100 by default) and count (1 by default). Each generator is tested for chance and if successful will run a number of times based on count. *

solardevice

Anonymous (anonymous@undisclosed.example.com) — 2017-06-03T01:06:18+00:00

Overview A SolarDevice is a miscellaneous device that refuels a ship using light from nearby stars. Basic Attributes refuel= The maximum rate (in 1/10 MW) at which this device can generate fuel for your reactor. The power generated depends on the light intensity at the user's current position.

sound

Anonymous (anonymous@undisclosed.example.com) — 2017-02-12T07:31:07+00:00

Summary * * unid= * filename= * “[directory]/[name].[extension]”

soundtrack

Anonymous (anonymous@undisclosed.example.com) — 2017-01-30T00:19:37+00:00

Overview defines music tracks to play during the game, as well as tracks specific to missions and intro/ending tracks. Soundtrack Life Cycle The engine selects which track to play based on a priority system when a player enters a system.

sovereign

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Overview There are new sovereign alignments here. Basic Attributes UNID= The UNID of the sovereign. alignment= A civilization can be categorized by its belief systems and values. See: Sovereign alignment for more information.

spaceobject

Anonymous (anonymous@undisclosed.example.com) — 2017-03-08T04:10:48+00:00

Summary * or * Zero or one . Can use either maxDist + portAngle + portCount + portRadius or x + y * bringToFront= * “true” * sendToBack= * “true” * maxDist= * portAngle=

stationtype

Anonymous (anonymous@undisclosed.example.com) — 2017-04-13T07:15:48+00:00

stationtype. Summary * * Zero or one * * * * * * Zero or one * Zero or one * criteria= * Zero or one

systemmap

Anonymous (anonymous@undisclosed.example.com) — 2017-02-07T00:39:34+00:00

NOTE: The SystemMap type is a new design type slated for official support in version 1.1. The documentation here is preliminary and may change between now and the release of 1.1. This documentation is current as of version 1.07; some features may not work in 1.06a and below.

systemtype

Anonymous (anonymous@undisclosed.example.com) — 2017-08-30T23:19:11+00:00

Summary * SystemType * backgroundID= * noExtraEncounters= * noRandomEncounters= * spaceEnvironmentTileSize= * spaceScale= * timeScale= * 1 SystemType * 0|1+ AntiTrojan * debugOnly= [boolean] * probability= [whole]

templatetype

Anonymous (anonymous@undisclosed.example.com) — 2017-01-21T19:00:47+00:00

Overview A TemplateType is a DesignType that can be used to generate randomized, dynamic types. Unlike static types (which are defined in the same way in every single game), dynamic types can vary dramatically by game. For instance, the following template creates a weapon that shoots either positron, plasma or antimatter.

topology_node

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Overview A topology node is an abstract representation of a star system. Each has the following properties: * A unique ID, often called the node ID, used to refer to it. * The UNID of the system type that should be created at this node. * The name of the system that should be created at this node.

topology_nodes

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

See: topology node

transcendenceadventure

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Discuss this page on this page's Talk Page. FIXME Please correct any inaccuracies. Overview This is only used for 'adventures'. That is to say files that go in the extensions directory to provide an alternative game start (with new system topology, etc.). It is not included in the Transcendence

transcendenceextension

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Discuss this page on this page's Talk Page. FIXME Please correct any inaccuracies. This is only used for extensions (mod files that go in the extensions directory). It is not included in the Transcendence XML'd elementDocument. Actual examples of this in use can be seen in almost any mod, such as

transcendencemodule

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Discuss this page on this page's Talk Page. FIXME Please correct any inaccuracies. This is used for Transcendence source files other than Transcendence.xml. Actual examples of this in use can be seen in those source files. It is not included in the Transcendence

transcendenceuniverse

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Discuss this page on this page's Talk Page. FIXME Please correct any inaccuracies. From the XML'd elementDocument START OF DOCUMENT

unid

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Discuss this page on this page's Talk Page. UNID UNID stands for “universal (or unique, some says) identifier”, which is required to define and store most in-game data (entities) except hard-coded elements (such as the opening screen, background graphics, etc.)

weapon

Anonymous (anonymous@undisclosed.example.com) — 2018-07-09T08:39:31+00:00

Overview Weapons are item types that fire projectiles. The element defines both the way in which projectiles are fired (e.g., the rate of fire, the power consumed, etc.) and the nature of the projectiles themselves (e.g., the speed of the projectile, the damage caused, etc.)

weapon_devices

Anonymous (anonymous@undisclosed.example.com) — 2017-02-05T18:07:16+00:00

~~GOTO>modding:xml:Weapon~~

weapon_with_multiple_projectiles

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

Example 2 This is a weapon that fires multiple projectiles:

xml

Anonymous (anonymous@undisclosed.example.com) — 2014-12-27T04:40:56+00:00

FIXME This is a work in progress. XML elements used in Transcendence are detailed in documents available on Xelerus, but they are not guaranteed to be up to date or all-inclusive. Root level elements Note that prefixing any xml file name with _ will disable an extension (see Wolfy's Universal Mod and Utilities Manager).