Transcendence Community Wiki

User Tools

Site Tools

Trace:
modding:function:legend:modder_s_index

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:function:legend:modder_s_index [2014/01/24 17:47] – additions to and clean up of Item Modifiers section spongejrmodding:function:legend:modder_s_index [2014/12/27 04:40] (current) – external edit 127.0.0.1
Line 1: Line 1:
-=====Function Legend===== +this is the updated legend page (if you have something important from this page contact RPC ): 
- +http://transcendence.kronosaur.com/wiki/modding/function/legend
-This page will contain a legend for terms often used when talking about Transcendence functions and their syntax. +
- +
-=====Data Types===== +
-====Atom==== +
- +
-An **atom** is anything that is not a list. In Transcendence this boils down to numbers, strings, literals, primitives, and lambdas. +
- +
-  * Atom Functions +
-    * isatom  +
- +
-====List==== +
- +
-A **list** is an ordered sequence of atoms and/or other lists. Items can be added and removed from lists in place, and lists can be searched and accessed with various functions. There are many Transcendence functions that return lists of various kinds of game objects based on location and criteria. +
- +
-Lists are the only container data structure available in transcendence. However, a list of lists such as ( (key1 value1) (key2 value2) ...) can be used as a relational array with the (lookup) function. +
- +
-  * Basic List Functions +
-    * append +
-    * count +
-    * item +
-    * list +
-    * shuffle +
-    * find +
-    * subset +
-  * Iterating Functions +
-    * enum +
-    * enumWhile +
-    * filter +
-  * In-Place Modification Functions +
-    * lnkAppend +
-    * lnkRemove +
-    * lnkRemoveNil +
-    * lnkReplace +
- +
-====Number==== +
- +
-**Numbers** in Transcendence are signed integers of a limited size //(2^32-1?)//. They behave pretty much as integers could be expected to. +
- +
-  * Math functions +
-    * add +
-    * divide +
-    * max +
-    * min +
-    * modulo +
-    * multiply +
-    * power +
-    * sqrt +
-    * subtract +
- +
- +
-====Literal==== +
- +
-A **literal** is a sequence of non-whitespace characters or a parenthesis enclosure prefixed with a ' (apostrophe), such as 'theLiteral or '(literal (list)). Once created, a literal is indistinguishable from a string. Literals tend to be used when code-like tokens are desired, such as in __(set 'name (objGetName theShip))__, or __(shpOrder theShip 'wait)__. +
- +
-Trivia: The "q" in (setq) is short for "quote", as the function is a shorthand for and optimization of (set 'varname data), or (set quote...). +
- +
- +
-====String==== +
- +
-A **string** is a sequence of characters surrounded by " (double quotes). Strings are used for nearly all text output to the player, as well as for some internal utility. +
- +
-Despite being sequences, strings are considered atoms, and most of the list manipulation functions do not work on them. +
- +
-   * String Functions +
-     * cat +
-     * count +
-     * find +
-     * int +
-     * isint +
-     * strCapitalize +
-     * strFind +
-     * subset +
-     * subst +
- +
-====Lambda==== +
- +
-A **lambda** is a function stored as data: it is a list of arguments to take and an expression to substitute the arguments into. Typically that expression is a **block**, to allow for multiple sequential expressions and local variables, but this is not required. +
- +
-If a lambda is referenced anywhere but as first element of a parenthesis contraption, it is considered data, so you can copy the functionality to another lambda or overwrite its containing variable with a different lambda. If a lambda is printed, its code is shown. +
- +
-Lambdas-as-data are always truth values, regardless of their return values, so you can have variables containing optional functions (or nil) and gate their execution such as with __(if a (a))__ to avoid errors about expected function names. +
- +
-   * Lambda Related Functions +
-     * isFunction +
- +
-====Primitives==== +
- +
-A **primitive** is an in-built native function provided by Transcendence.exe to the tlisp environment, such as (for) or (if) or (objUnregisterForSystemEvents). There's not much you can do with primitives aside from call them, copy them to other names (e.g., __(setq * multiply)__), or accidentally mask them with variables (__(setq list (list 10 20 30))__ could give you no end of confusion, for example...). +
- +
-   * Primitive Related Functions +
-     * isFunction +
-     * isPrimitive +
- +
- +
-====Subordinates==== +
-//This section needs to be expanded// +
- +
- +
-=====Game Object References===== +
- +
-Game object references are numbers or lists that represent specific instances or configurations of objects. They are internal representations that should be considered black boxes which can be created or retrieved, stored, and then passed back to functions that manipulate them, but never directly altered in script. +
- +
-====itemStruct==== +
- +
-An **itemStruct** describes a specific qunatity of a specific item in a specific condition (installed, damaged, enhancement type/level, data set by itmSetData etc). They do not, however, represent a specific location of an item; 5 helium3 fuel rods on your ship will have the same itemStruct as 5 helium3 fuel rods stored on a Charon frigate. +
- +
-====spaceObject==== +
- +
-A **spaceObject** is an instance of a station (star, planet, space station) or a ship that exists somewhere within the current system. As spaceObjects are thin carriers for C++ pointers, it's possible to crash the game by mishandling them. In particular, they can't be stored for longer than a single invocation of an event because they become invalid when the system changes (or possibly even when the objects are destroyed). +
- +
-====objectID==== +
- +
-An **objectID** is a global and saveable reference to a specific spaceObject that can be safely stored in persistant data. You an create one for a given spaceObject with objGetID, and you can convert the ID back to an object with objGetObjByID, which simply returns 'nil' if the object is not currently or no longer available. +
- +
-=====Item Metadata===== +
- +
-====Known==== +
- +
-An item is considered un**known** if the player does not know anything about the item except for its general type. Items are unknown at the start of the game if their ItemType definition has a unknownType="<UNID>" field, in which case they will appear as if they were of the unknownType until identified. (The engine will randomly pick one of the list of names given for each item type at startup.) +
- +
-Some kinds of equipment will be identified when installed (such as cargo expansions) or used (such as weapons), but many types of item that use the identification feature need to set the known status in script. Once an item is known, via any means, the status cannot be revoked. +
- +
-  * Known-status functions +
-    * itmIsKnown +
-    * itmSetKnown +
- +
-====Reference==== +
- +
-An item is considered **referenced** when is statistics (such as damage or resistance) are known by the player. This only applies to equipment items. Reference status cannot be revoked once applied. +
- +
-While the functions to manage referenced status are still available, this feature has been unused since sometime around version 1.0 of Transcendence. All items are now natively referenced from the beginning of the game. The functions only appear in the Rowena's Weapons and Armor ROMs, which now never spawn. +
- +
-  * Reference Functions +
-    * itmSetReference +
-    * itmHasReference +
- +
- +
- +
-===== Parameter Notes ===== +
- +
-==== Font Sizes ==== +
- +
-When dealing with fonts in DockScreens there are several sizes that can be used: +
- +
-<code> +
-Small +
-Text +
-TextBold +
-Medium +
-MediumBold +
-MediumHeavyBold +
-Large +
-LargeBold +
-Header +
-SubTitle +
-SubTitleBold +
-Title +
-</code> +
- +
-=====Criteria===== +
- +
-These codes are used in various functions that need to check for or list spaceobjects. +
- +
-<code> +
-G         Stargates only +
-G:xyz;    Stargate with ID 'xyz' +
-s         Include ships +
-t         Include stations (including planets) +
-T         Include structure-scale stations +
-T:xyz;    Include stations with attribute 'xyz' +
-A         Active objects only (i.e., objects that can attack) +
-B:xyz;    Only objects with attribute 'xyz' +
-D:xyz;    Only objects with data 'xyz' +
-E         Enemy objects only +
-F         Friendly objects only +
-H         Only objects whose base = source +
-M         Manufactured objects only (i.e., no planets or asteroids) +
-N         Return only the nearest object to the source +
-N:nn;     Return only objects within nn light-seconds +
-NN:nn;    Return only nearest object if it's within nn light seconds (just combination of two above codes) +
-O:abc;    Ships whose order is abc [docked, patrol, escort etc...] +
-P         only objects visible to source +
-J         only objects from a given sovereign +
-K         only objects that cannot attack +
-R:nn;     Return only objects greater than nn light-seconds away +
-V         Include Virtual objects +
-Z         Exclude player +
-z         Only include player +
-b         Beam Objects +
-m         Missile Objects +
-X         Objects targeting Source +
-S:d       returns objects sorted by distance (in ascending order) +
-S:D       returns objects sorted by distance (in descending order) +
-I:angle   returns only objects that intersect a line from the source at the given angle +
-+xyz;     Include objects with the given attribute +
--xyz;     Exclude objects with the given attribute +
-+unid:UNID                   Return ships of type UNID.  +
-+isPlayerClass:true/false    Filter based on presence of PlayerSettings in object's type, ships only. +
-</code> +
-Note: Virtual stations are not searched by default through t; therefore you should use V as well if searching for a virtual station. +
- +
-==== TypFind Criteria ==== +
- +
-These are codes used to enumerate types with the [[modding:function:typFind]] function. +
- +
-<code> +
-* = all types +
-$ = currency UNID +
-a = an adventureDesc UNID +
-b = item table UNID +
-c = effect type UNID +
-d = dock screen UNID +
-e = space environment UNID +
-f = overlay UNID (apparently original name was 'energy field') +
-g = globals UNID (currently returns nothing?) +
-h = ship table UNID +
-i = item type UNID +
-m = image UNID +
-n = system node UNID (currently returns nothing?) +
-p = power UNID +
-q = system table UNID  +
-s = ship class UNID +
-t = station type UNID +
-u = sound UNID (currently returns nothing?) +
-v = sovereign UNID +
-w = name generator UNID (currently returns nothing?) +
-y = system type UNID +
-z = system map UNID  +
-_ = template type UNID // We don't support enumerating template types (TSE/CDesignType.cpp) +
- +
-V = Include Virtual types  +
- +
-+isPlayerClass:true/false = filters in/out ship classes with playersettings +
-+unid:[a unid] = returns the requested unid if extant, or nil +
-</code> +
- +
-  * There is currently no way to get a list of only vitual types except filtering one list against the other. +
-  * Use +attrib and -attrib to select attributes +
-  * Type codes are only additive, e.g., "$q" will return both currencies and system tables in one list. +
-  * There appears to be some way to use > >= < <= $ # and a number to do aditional filtering. (I haven't been able to make this do anything obvious -Weaver) +
- +
- +
- +
-====Name Flags==== +
- +
-These flags are used for controlling the formatting of names of items, ships and stations. +
- +
-Flags can be added together to create a certain formatting, ie. 3 would be pluralized and capitalized. +
-<code> +
-0x001 (1)   = capitalize +
-0x002 (2)   = pluralize +
-0x004 (4)   = prefix with 'the' or 'a' +
-0x008 (8)   = prefix with count (or 'a') +
-0x010 (16)  = prefix with count +
-0x020 (32)  = no modifiers +
-0x040 (64)  = prefix with 'the' or 'this' or 'these' +
-0x080 (128) = short form of name +
-0x100 (256) = actual name +
-</code> +
- +
-====Damage Types==== +
-Damage types are represented as integers or hexadecimal values in script +
-<code> +
--1       - Generic +
-0  (0x0) - Laser +
-1  (0x1) - Kinetic +
-2  (0x2) - Particle +
-3  (0x3) - Blast +
-4  (0x4) - Ion +
-5  (0x5) - Thermo +
-6  (0x6) - Positron +
-7  (0x7) - Plasma +
-8  (0x8) - Antimatter +
-9  (0x9) - Nano +
-10 (0xA) - Graviton +
-11 (0xB) - Singularity +
-12 (0xC) - DarkAcid +
-13 (0xD) - DarkSteel +
-14 (0xE) - DarkLightning +
-15 (0xF) - DarkFire +
-</code> +
- +
-====Frequency==== +
-The game uses frequency values to say how often something appears in the game. The known values are: +
-<code> +
-* Common: 20 +
-* Uncommon: 10 +
-* Rare: 4 +
-* VeryRare: 1 +
-</code> +
-====Level Distribution==== +
-A string with series of 5 characters separated by spaces. Each character represents a level. '-' means no chance for an occurance at that level. 'c' means it is common for an occurance at that level. 'u' means it is uncommon for an occurance at that level. 'r' means it is rare for an occurance at that level and 'v' means it is very rare for an occurance at that level. +
- +
-An example LevelString would be +
-  vrucu rv--- +
-Which translates to +
-  * Level 1: VeryRare +
-  * Level 2: Rare +
-  * Level 3: Uncommon +
-  * Level 4: Common +
-  * Level 5: Uncommon +
-  * Level 6: Rare +
-  * Level 7: VeryRare +
- +
-In practice this means more level 4 items will be generated than level 5 and 3, which in turn will generate more than level 2 and 6, which in turn will generate more than level 1 and 7. +
- +
-====Enhancements==== +
- +
-Enhancements on items are reported as hexadecimal values (sometimes converted to integers) +
-This is a list of known enhancements and their values: +
-<code> +
-Y and X are hexadecimal values (0-F) +
- +
---  SHIELD +
- +
-    --  DAMAGE REFLECT  - Damage Bounces off shields +
-        0x03YX - Refect damage type Y with X chance +
- +
-    --  DAMAGE TRANSPARENCY - Damage Passes throught shield +
-        0x83YX - Pass throught damage type Y with X change +
- +
---  ARMOR +
- +
-    --  REGENERATION +
-        0x0200 +
- +
-    --  DECAY +
-        0x8200 +
- +
-    --  IMUNITIES +
-        0x0B00 - RADIATION +
-        0x0B10 - BLINDING +
-        0x0B20 - EMP +
-        0x0B30 - DEVICE DAMAGE +
-        0x0B40 - DISINTEGRATION +
-        0x0C00 - BLINDING/EMP/DEVICE DAMAGE +
- +
-    --  INTERFERES WITH SHIELDS +
-        0x8C00 +
- +
-    --  REGENERATES NEAR SUN +
-        0x0D00 +
- +
-    --  REFUELS REACTOR NEAR SUN +
-        0x0E00 +
- +
---  WEAPON +
- +
-    --  DAMAGE BONUS - Adds from 10 to 150% damage bonus +
-        0x010X +
- +
-    --  DAMAGE PENALTY - Adds from 10 to 150% damage penalty +
-        0x810X +
- +
-    --  SPEED - Increases shooting speed of weapon up till 30/sec +
-        0x100X - X can be 2, 4, 6 or 8 +
- +
-    --  DECREASE SPEED +
-        0x900X - X can be 2, 4, 6 or 8 +
- +
---  SHIELD/ARMOR +
- +
-    --  HP BONUS - Adds from 10 to 150% HP bonus of armor/shield +
-        0x010X +
- +
-    --  HP PENALTY +
-        0x810X +
- +
-    --  DAMAGE REDUCTION +
-        0x060X - reduce ENERGY damage +
-        0x070X - reduce MATTER damage +
-        0x08YX - reduce Y and Y+1 type damage +
-        0x09YX - reduce Y type damage +
-        0x0AYX - reduce type Y damage and Y+2 type damage with 1.5X +
- +
-    --  DAMAGE INCREASE +
-        0x860X - increase ENERGY damage +
-        0x870X - increase MATTER damage +
-        0x88YX - increase Y and Y+1 type damage +
-        0x89YX - increase Y type damage +
-        0x8AYX - increase type Y damage and Y+2 type damage with 1.5X +
- +
---  SHIELD/WEAPON +
- +
-    --  EFFICIENCY - Decreases the energy consumption of weapon +
-        0x0F0X +
- +
-    --  DECREASE EFFICIENCY +
-        0x8F0X +
- +
-</code> +
-====Categories==== +
- +
-When you retrieve the category of an item in script, it is given as an integer. +
-The category can be inferred from this list: +
- +
-<code> +
-1    (0x0001) - Misc Item +
-2    (0x0002) - Armor +
-4    (0x0004) - Weapon +
-8    (0x0008) - Special Devices (Patch Spider, Jumpdrive, Enhancers) +
-16   (0x0010) - Missile Launcher +
-64   (0x0040) - Reactor +
-128  (0x0080) - Shield +
-256  (0x0100) - Cargo bay +
-512  (0x0200) - Fuel +
-1024 (0x0400) - Ammo +
-2048 (0x0800) - Drive +
-4096 (0x1000) - Useable +
-</code> +
-====Item Criteria==== +
-When retrieving items based on item criteria, these are the flags used: +
-<code> +
-*   all categories +
-a   armor +
-b   miscellaneous devices (Patch Spider, Jumpdrive, Enhancers) +
-c   cargo hold +
-d   device (weapon, shield, drive, etc.) +
-f   fuel +
-l   launcher +
-m   missile/ammo +
-r   reactor +
-s   shields +
-t   miscellaneous +
-u   useable (armor coating, ROM, etc.) +
-v   drive +
-w   weapon (including launchers) +
-I   is installed +
-D   is damaged +
-N   is not damaged +
-S   is usable +
-V   is Virtual +
-U   is not installed +
-</code> +
- +
-Some special attributes +
- +
-<code> +
-canBeDamaged:true  only items that can be damaged +
-damageType:Laser   only items that have a certain damage type. Also limits to weapons (obviously) +
-unid:0xXXXX        only items with matching UNID +
-</code> +
- +
-In addition there exists a special syntax for negating, filtering on levels etc... +
- +
-<code> +
-~                  Negate. Eg. w~l will match weapons that are not launchers. +
-^                  Force. Eg. a^u will match armors that are usable +
-&lt; and &gt;      Less than and Greater than. There are several ways to use these operators +
-  &lt;=$500        Items that cost less than 500 credits +
-  &gt;=#25         Items where there are greater than 25 in the stack. Used when getting items from objects +
-  &lt;=6           Items below level 6 +
-L                  New in 1.04. Level Constraint. Eg. L:1-5 selects levels between 1 and 5 (inclusive). Replaces above syntax. +
- +
-F                  Rarity. Eg. F:cu will only select Common or Uncommon items  +
-</code> +
- +
- +
-====Item Modifiers==== +
-There are some modifiers which can be used.  Modifiers are case sensitive.  Modifiers can be added freely in mods.   +
- +
-|  **Modifier**  |  **Description**  |  **Used**  | +
-|100MW      |  |used in   2 items  | +
-|Alien                      |Item is not found in Human space    |used in  22 items  | +
-|AntiMatter                 |Item is involved in antimatter industry    |used in   4 items  | +
-|Ares                       |Item used or made by the Ares faction    |used in  16 items  | +
-|Armor                    |Item used as armor or to make armor    |used in   7 items  | +
-|ArmorEnhance               |Item that enhances armor    |used in  15 items  | +
-|ArmorRepair                |Item that repairs armor    |used in   7 items  | +
-|Art                        |Item such as a crystal  |used in   6 items  | +
-|Auton                      |Item is an auton    |used in   7 items  | +
-|Barricade                  |Large depolyable armor-like protective item    |used in   3 items  | +
-|BasicAmmo                  |Item is a type of ammo    |used in   6 items  | +
-|BlackMarketID              |This is a black market ID    |used in   1 items  | +
-|Bushido                    |Item is sold by Bushido corp    |used in  18 items  | +
-|CannotOrder                |Items cannot be ordered  |used in   9 items  | +
-|Commonwealth               |Items made or used by the Commonwealth Faction  |used in  31 items  | +
-|CommonwealthFleet          |Items made or used by the Commonwealth Fleet  |used in   6 items  | +
-|ConfirmRefuel              |If used as fuel, item will prompt for confirmation  |used in   1 items  | +
-|Consumable                 |Item is consumable (missiles/ammo/treasure)  |used in 192 items  | +
-|ContrabandBox              |Item containing illegal items  |used in   1 items  | +
-|Disposable                 |???  |used in   3 items  | +
-|Dwarg                      |Items made or used by the Dwarg faction  |used in   7 items  | +
-|EI                         |Item is made by Earth Industries corporation  |used in  32 items  | +
-|EnergyWeapon               |Items that are energy based weapons  |used in  41 items  | +
-|Explosive                  |Items that explode or can be used in explosive items  |used in   4 items  | +
-|Ferian                     |Items used or made by the Ferian faction  |used in   1 items  | +
-|FieldCrystal               |???  |used in   6 items  | +
-|Food                       |Item is human food or drink  |used in  41 items  | +
-|FreshFood                  |Items that are edible, but rot after a set time  |used in   4 items  | +
-|Fuel                       |Item is starship fuel  |used in   8 items  | +
-|HaloGem                    |Item is a Halo gem  |used in   3 items  | +
-|Heliotropes                |Items made or used by the Heliotrope faction  |used in   3 items  | +
-|HereticROM                 |ROM found in the heretic system (quest)  |used in   2 items  | +
-|HereticStargate            |???  |used in   1 items  | +
-|Hexphase                   |Item used in armors and explosives  |used in   3 items  | +
-|Howitzer                   |A type of powerful non-launcher weapon  |used in   7 items  | +
-|HyperglyphRod              |Quest Item  |used in   1 items  | +
-|ID                         |Item is an ID  |used in   2 items  | +
-|Illegal                    |Item is illegal in Human Space  |used in  14 items  | +
-|Info                      |Item consists of digital information  |used in  33 items  | +
-|IocrymCyberneticTower      |Quest Item  |used in   1 items  | +
-|LamplighterDataROM         |Quest Item  |used in   1 items  | +
-|LamplighterPrototype       |Quest Item  |used in   1 items  | +
-|LesserData                 |???  |used in   1 items  | +
-|LongzhuSphere              |Item that is a Longzhu sphere  |used in   1 items  | +
-|Luminous                   |Items created or used by the Luminous faction  |used in   7 items  | +
-|Lux                        |Item is human luxury good  |used in  37 items  | +
-|MAGLauncher                |A launcher that uses MAG ammo  |used in   7 items  | +
-|MRADExperiment             |???  |used in   1 items  | +
-|MajorItem                  |Item       Device/Shield/Weapon  |used in 188 items  | +
-|Makayev                    |Item is sold by Makayev corp  |used in  28 items  | +
-|MakayevLauncher            |A launcher made by the Makayev corporation  |used in   4 items  | +
-|Meds                       |Item is human medicine  |used in  13 items  | +
-|Military                   |Item is restricted to military in Human space  |used in 117 items  | +
-|MilitaryID                 |Item is a military ID  |used in   1 items  | +
-|MinersHold                 |Miner's cargohold  |used in   1 items  | +
-|MinorItem                  |Item       Armor/Enhancements  |used in 134 items  | +
-|Missile                    |Item is ammo or missile  |used in  37 items  | +
-|NAMI                       |Items made by the NAMI corporation  |used in  36 items  | +
-|NAMIHeavyLauncher          |Heavy launcher by NAMI  |used in   3 items  | +
-|NAMILauncher               |Launcher by NAMI  |used in   7 items  | +
-|NAMIMineLauncher           |Mine Launcher by NAMI  |used in   2 items  | +
-|NeurohackROM               |A quest item  |used in   1 items  | +
-|NotForSale                 |Items are not for sale at stations  |used in  76 items  | +
-|Nuclear                    |Item is involved in nuclear industry  |used in   4 items  | +
-|OmskArmor                  |Armors by Omsk  |used in   3 items  | +
-|OmskDS                     |Omsk related item ???  |used in   5 items  | +
-|OmskDeflector              |Shield by Omsk  |used in   2 items  | +
-|Ore                        |Items that can be mined from asteroids  |used in  18 items  | +
-|PremiumAmmo                |A type of ammo  |used in   7 items  | +
-|Psionic                    |???  |used in   5 items  | +
-|QuantumCPU                 |Device required to use certain data cubes  |used in   1 items  | +
-|Rasiermesser               |Item is sold by Rasiermesser corp  |used in  31 items  | +
-|RasiermesserLauncher       |Launcher made by the Rasiermesser corp  |used in   2 items  | +
-|Res                        |Item is a resource needed for industry  |used in  32 items  | +
-|RingerValuable             |Item is used by Ringers  |used in   5 items  | +
-|Ringers                    |Item used or created by Ringers  |used in   1 items  | +
-|Sapiens                    |Item used or created by Sapiens  |used in   1 items  | +
-|SealedContainer            |Quest Item  |used in   1 items  | +
-|Slaves                     |Coffins containing human slaves  |used in   1 items  | +
-|SmugglersHold              |Cargo hold that allows smuggling  |used in   1 items  | +
-|Solon                      |Types of device  |used in   1 items  | +
-|Soul                       |Item contains (possibly dormant) intelligence of HIG III or above  |used in   5 items  | +
-|Specialty                  |Item is not a commodity; for sale only in specific stations  |used in  47 items  | +
-|Taikon                     |Types of device  |used in   8 items  | +
-|Teraton                    |Item used or created by Teraton  |used in   3 items  | +
-|TiledArmor                 |Type of armor  |used in   4 items  | +
-|Urak                       |Item used or created by Urak  |used in   5 items  | +
-|Volatile                   |Item with unstable/explosive properties  |used in   4 items  | +
-|WeaponEnhancer             |Item that enhances weapons  |used in   7 items  | +
-|ZeroPoint                  |Item is used in Zero-point energy industry  |used in   5 items  | +
-|centauriWarlords           |Items used or created by the Centauri warlords  |used in   4 items  | +
-|qianlongArchcannon         |Quest Item  |used in   1 items  | +
-|sungSlavers                |Items used or created by the Sung slavers  |used in   9 items  | +
-|unknown                    |Items that are unknown  |used in  16 items  | +
- +
- +
- +
- +
- +
-The following modifiers are not given in Transcendence.xml +
- +
-====Ship Orders==== +
- +
-These are the orders used in vanilla or known to exist. They all have slightly different function signatures. The number preceding is the internal order number. Not all of the orders can be used with shpOrder. See this thread for more information: +
- +
-http://www.neurohack.com/transcendence/forums/viewtopic.php?p=42708#p42708 +
- +
-//needs to be expanded with signatures and more descriptions// +
- +
-  1    guard                      Guard target +
-  2    dock                       Dock with target +
-  3    attack                     Attack target +
-  4    wait                       Unsure. Wait at position for a time in seconds +
-  5    gate                       Go to nearest gate (or specified gate) and use it +
-  6    gateOnThreat +
-  7    gateOnStationDestroyed +
-  8    patrol                     Patrol a target at a set distance (in ls) +
-  9    escort                     Escort target +
-  10   scavenge +
-  11   followPlayerThroughGate +
-  12   attackNearestEnemy         Name says it all +
-  13   tradeRoute +
-  14   wander                     Wander around the system +
-  15   loot                       Loot target (must be a wreck) +
-  16   hold                       Hold position (optionally for a certain period) +
-  17   mine                       Mine a target object (only for Ferian Controller) +
-  18   waitForPlayer +
-  19   attackPlayerOnReturn +
-  20   follow                     Follow target +
-  21   navPath +
-  22   goto                       Go to target +
-  23   waitForTarget +
-  24   waitForEnemy +
-  25   bombard                    Bombard target +
-  26   approach                   Approach a marker until a certain distance? +
-  27   aim                        Aim at target +
-  28   orbit                      Orbit around a target at a set distance (in ls) +
-  29   holdCourse                 Hold a certain course for a certain time (in ticks) +
-  30   turnTo                     Turn the ship in direction (angular) +
-  31   attackHold                 Attack target but hold position (no chasing) +
-  32   attackStation              (Found in TSE/Utilites.cpp, no idea what it does) +
- +
- +
- +
-====Data Fields==== +
-The functions objGetDataField and typGetDataField access predetermined data tags, of which these are known: +
- +
- +
-  cargoSpace +
-  explosion +
-  fireAccuracy  +
-  fireRangeAdj +
-  fireRateAdj  +
-  launcher  +
-  launcherUNID +
-  level +
-  maxSpeed +
-  maneuver +
-  manufacturer +
-  name - combined class and type +
-  primaryArmor +
-  primaryArmorUNID +
-  primaryWeapon +
-  primaryWeaponRange +
-  primaryWeaponRangeAdj +
-  primaryWeaponUNID +
-  score +
-  shield +
-  shieldsUNID +
-  thrustToWeight +
-  speed                 - speed of missile or a weapons projectile +
-new fields in 1.04 +
- +
-  deviceSlots           - available for ships, used for devices +
-  deviceSlotsNonWeapons - total number of device slots that take non-weapons +
-  deviceSlotsWeapons    - total number of device slots that take weapons +
-  genericName           - <del>manufactuer/</del>class/type as string - unlike ticket says, does not give manuf. +
-  hullMass              - mass of hull without items/devices in tons +
-  maxArmorMass          - max size of compatable armor segments in kilograms +
-  maxCargoSpace         - max possible cargo space with expansions in tons +
-  fuelCapacity          - max fuel in reactor/shipclass, fuel provided by fuel items +
-  fuelCriteria          - criteria string of fuel that reactorDevice/shipClass takes +
-  fuelEfficency         - reactorDevice (and shipclass) attribute +
-  power                 - max power output of reactorDevice/shipclass +
-  maxSpeed              - driveDevice max speed provided +
-  thrust                - thrust provided by driveDevice, maybe ship? +
-  cargoSpace            - amount that a cargoDevice will increase cargospace +
-  armorItems            - list of armor items from shipClass +
-  deviceItems           - list of device items from shipclass +
-  category              - data field on item for 'weapon' 'shield' etc +
- +
- +
-====Sovereigns==== +
- +
-Mainly from [[http://neurohack.com/transcendence/forums/viewtopic.php?f=2&t=3226|this]] forum page. +
- +
-Superseded by [[http://neurohack.com/transcendence/forums/viewtopic.php?p=39977#p39977|this]]  +
- +
- +
-===Dispositions=== +
- +
-  Friendly            Will not fight back (unless scripted or prompted by AI) +
-  Neutral             Will attack if attacked. +
-  Enemy               Will openly attack. +
- +
-All Sovereigns are Friendly to others of same Sovereign. +
- +
- +
-===Alignments=== +
- +
-  Destructive Chaos   Enemy to all not of exactly same Sov +
-  Constructive Chaos  Enemy to Destructive. Neutral to Neutral. +
-                      and Constructive Order, Friendly to Constructive Chaos +
-  Destructive Order   Enemy to Constructive. Neutral to Neutral and Destructive Order. +
-                      Enemy to Destructive Chaos. +
-  Constructive Order  Enemy to Destructive. Neutral to Neutral +
-                      and Constructive Chaos. Friendly to Constructive Order. +
-  Neutral             Enemy to Destructive Chaos. Neutral to everyone else. +
- +
-====Messages==== +
- +
-These are the IDs of the messages sent to the player throughout the game. Use ''plyEnableMessage'' to turn them on or off. +
- +
-  commsHint +
-  dockHint +
-  mapHint +
-  autopilotHint +
-  gateHint +
-  useItemHint +
-  refuelHint +
-  enableDeviceHint +
-  switchMissileHint +
-  fireMissileHint +
- +
-Also, you can use ''allHints'' to enable/disable all hints +
-==== Random Notes ==== +
-Dbglog has a limit of 931 characters.+
modding/function/legend/modder_s_index.1390585632.txt.gz · Last modified: 2014/12/27 04:40 (external edit)