XRWS "v ‹ ëext_01.cat ext_01.dat libraries/aiscripts.xsd 144100 1542811842 2055ca7749dc65c4d057f36d6eea25c8
libraries/common.xsd 1026038 1543497992 c6b81297c1f4a5b2c532bddfed1baef2
libraries/drops.xsd 7757 1524728287 6a7dd9e9d8708a24b1dce7fe3ae76d4a
libraries/factions.xsd 16959 1539284040 e60072556bab5f8fd41746e6bf73eeed
libraries/gamestarts.xsd 24378 1543272239 a879efe55a7f18f421afdbbfd804952b
libraries/libraries.xsd 68295 1541886894 c0e0bf84120bf62af2facb33bea602e4
libraries/loadoutrules.xsd 11871 1529335178 8608c909a16b72f69c0a62a2f9835ee6
libraries/material_library.xsd 5960 1535620717 9a6049e525946e65fd7a0d46301f13d9
libraries/md.xsd 112136 1542198014 6492a5ef21f82cb30e29e98b2ddf1026
libraries/objectspawnpoints.xsd 5863 1491479139 8b32521e6d8290ec7769749bee75972f
libraries/objectspawnrules.xsd 7143 1536935167 9d02a185536b00ac52d7f6475e8269cc
libraries/parameters.xsd 126884 1542800046 900b84aa2fab0705a1cc895129029ddd
libraries/people.xsd 900 1491572109 d50f4511a238f3b3455caa2ec9250907
libraries/quotas.xsd 17961 1534932817 8569f906050aec71e9fa625a1b6e35c5
libraries/races.xsd 9055 1537439211 49dbb0a094b842c2c364e850fe6e0be5
libraries/region_definitions.xsd 31485 1537275351 e96ef60350ba44c0a4e163c1fe1e227c
libraries/regionobjectgroups.xsd 3167 1539164675 677e87bd71bbdb0c0f5b980a8308c269
libraries/regionyields.xsd 5166 1526030639 e20a442b32b2726e566cefd4478aae81
libraries/scriptproperties.xsd 8980 1505734149 7e137e33081fec75b9f51a4367e0a769
libraries/sound_library.xsd 24256 1523440184 202193e553d065819526e50027033bf9
libraries/stats.xsd 12092 1543501350 6d571512738d2bebe4cdcd10bb5e7b18
libraries/timeline.xsd 2515 1531476394 5cac130a70419550499189519d20a8f5
libraries/unlocks.xsd 21428 1542800046 a53bb1be86af7cb0782756be5cb10e89
libraries/voicesequences.xsd 4504 1531319808 0c94303fcc1775db3c4b3f7e2c8d0c9c
md/md.xsd 207 1434634445 55fb063dcc1445f92bc2458bab10e858
md/Missions_Bonus.xml 11727 1544792691 d3c78f34f7880d9b973f9ab438efa6d2
Label name
Name of a library interrupt condition set
Name of a library interrupt action set
Name of a library interrupt handler
Resume this action when an interrupt script returns, instead of resuming at a label? This has no effect if a resume attribute was specified in <run_interrupt_script>.
If the action was already completed during the interrupt, the script will continue after the action immediately.
Note that changing the resume attribute has no effect on existing savegames. The resume state will be restored as it was saved before, even if the attribute changes in the script.
Flight behaviour
Flight control model
Command
Attack Enemies Command (no param)
Attack Object Command (param = the target to attack)
Build Expansion Command (no param)
Build Ship Command (no param)
Build Station Command (no param)
Build Upgrades Command (no param)
Collect Command (param = the object to collect)
Dock at Command (param = the object to dock at)
Free Mining Command (no param)
Free Trading Command (no param)
Follow Command (param = the object to follow)
Escort Command (param = the object to escort)
Mining Command (param = the zone where stuff is mined)
Move Command for object (param = the object to fly to)
Move Command for zone (param = the zone to fly to)
Patrol Command (no param)
Police Command (no param)
Protect Command (param = the object to protect)
Refuel Command (param = amount of fuel)
Repair Command (no param)
Scan Object Command (no param)
Support Command (param = the object to support)
Search for Resources Command
Search for Trades Command
Trade Command (param = the object to trade with)
Wait Command
Explore Command
Withdraw from Battle Command
Resupply command
Reconnoiter command
Investigate command
Command action
Stand By Command action (no param)
Calculating parameters action (no param)
Reparing to component Command action (param = component to repair)
Stand By Command action (no param)
Scanning to component Command action (param = component to scan)
Searching resources Command action (no param)
Executing Trade Command action (no param)
Docking Command action (no param)
Undocking (also detach from masstraffic) Command action (no param)
Waiting for a free dock Command action (no param)
Attacking Enemies Command action (no param)
Attacking to Enemy Command action (param = enemy object)
Flying Command action (no param)
Flying to zone Command action (param = destination zone)
Jumping Command action (no param)
Searching for trades Command action (no param)
Waiting for drones to dock (detach from masstraffic) Command action (no param)
Investigating Object Command action (param = object being investigated)
Script version in which this blocking action was added
AI script parameter
Parameter name
Parameter value
List of conditions all of which must be met
List of conditions any one of which must be met
Actions to be performed right before the script switches to a different <attention> block on an attention level change. Blocking actions are not allowed. <break> and <continue> only work on loops within the attention change actions. <resume> is supported.
Time duration until timeout
Conditionally interrupt a blocking action and perform certain actions when the interrupt occurs.
Conditions that must be met in order for the interrupt to occur.
Actions to be performed on an interrupt. Blocking actions are not allowed. <break> and <continue> only work on loops within the interrupt actions.
Reserve space for selling ware to an object.
The container where the reserver(object) wants to reserve space for an amount of ware.
Buy or sell?
We want to buy, this will reduce sell-offer amounts.
We want to sell, this will reduce buy-offer amounts.
Which object to reserve this amount for.
Positive number of units to reserve.
Duration of this reservation (optional, defaults to 1 hour)
Whether the reservation is for a mission trade (optional, defaults to false)
Whether amount should be added to any existing reservation or replace it. (optional, defaults to false)
Whether to check reservations for "supplies" (optional, defaults to false)
Whether to look at the "real" or the "virtual" dataset - virtual reservations are IGNORED for trades. (optional, defaults to false)
The amount that is now reserved for this reserver. Can be different from amount if there already was a reservation. (optional)
Remove a space reservation that was previously added with <add_ware_reservation> (fails silently if there was no matching reservation)
The container from which to remove the reservation.
Type of reservation to remove (optional, defaults to all)
Remove buy reservations only.
Remove sell reservations only.
Whose reservation to remove (optional, all reservations for ware (if specified) will be removed if omitted!)
What reservations to remove (optional, all reservations for reserver (if specified) will be removed if omitted!)
How many units from the reservation to remove (optional, will remove all units if omitted, only has an effect if reserver and ware are specified!)
Whether the reservation is for a mission trade (optional, defaults to false)
Whether the reservation is for a supplies trade (optional, defaults to false)
Whether to look at the "real" or the "virtual" dataset - virtual reservations are IGNORED for trades. (optional, defaults to false)
Dock a masstraffic drone. Any picked up objects will be transferred to the cargostorage of destination (if possible). (blocking)
Destination the drone should dock at. This object must have masstraffic docks defined! (Large+ ships or stations)
If docking process should happen immediately, the drone will be teleported to destination(optional, defaults to false)
If the current command action should be override with this action (optional, defaults to true)
Execute trade procedure, this will create the necessary trade and cause cargo to be transferred from seller to buyer (blocking)
Amount of goods to transfer
Total price of goods in this trade (defaults to 0! takes precedence over price)
Price per unit in this trade (defaults to 0! ignored if totalprice is set)
Should the ware be unbundled on transfer? (turn ware into ammo for the recipient, defaults to false)
Trade to be removed from shopping list, in case this action is aborted. Accessed by <save_ai_action_state>.
Use money from the commanders' account to pay for this trade. Defaults to player account for player-owned ships without commander (optional, defaults to false)
If the current command action should be override with this action (optional, defaults to true)
Execute trade procedure, this will cause cargo to be transferred (blocking)
The trade offer (buy or sell) that is to be acted upon
The object that wants to do the trade (if a ship wants to use a trade offer on a station, that station is the owner and the ship is the tradepartner)
Amount of goods to transfer, can not exceed amount in offer (0=default=all in offer)
Is this using a trade(offer) that is not a Production or Script TradeOffer? (e.g. taken from a Ships' shopping list). Note that you must specify an amount if ware reservations are involved!
Should the ware be unbundled on transfer? (turn ware into ammo for the recipient, defaults to false)
If the current command action should be override with this action (optional, defaults to true)
Move along a dynamic path that will lead to the docking bay (blocking)
Whether the object should abort the previous path points if any (defaults to true)
Destination object (will be derived from docking bay if omitted)
The DockingBay that should be used for docking
Whether the object should fly in the coordinate space of the defined object as opposed to its parent component (defaults to true)
Whether the object should start flying in the coordinate space of the defined object as opposed to its parent component after this movement is done (defaults to false)
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if relativemovemt is true or the ship is flying in a formation (defaults to false)
If the current command action should be override with this action (optional, defaults to true)
Move to dock (blocking)
Whether the object should abort the previous path points if any (defaults to true)
Docking bay component slot (find using <find_dockingbay>)
Flight behaviour overrride, defaults to flightbehaviour.dock
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if the ship is flying in a formation (defaults to false)
Whether the object should keep rotating to match the defined orientation at the end of the path (defaults to false)
Whether the object has to be in the exact given position at the end of the path (defaults to true)
If the current command action should be override with this action (optional, defaults to true)
Move to undock (blocking)
Docking bay component slot
Whether the object should keep rotating to match the defined orientation at the end of the path (defaults to false)
Whether the object has to be in the exact given position at the end of the path (defaults to true)
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if the ship is flying in a formation (defaults to false)
Flight behaviour overrride, defaults to flightbehaviour.dock
If the current command action should be override with this action (optional, defaults to true)
Move through a Jump Gate, after the transition the ship will move out of the way of the gate (blocking)
Whether the object should abort the previous path points if any (defaults to true)
Jump Gate to go through
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if the ship is flying in a formation (defaults to false)
If the current command action should be override with this action (optional, defaults to true)
Move to destination via navmesh (blocking)
Whether the object should abort the previous path points if any (defaults to true)
If object is originates from mass traffic, plot a navmesh path that follows the original traffic lane
The object that has the navmesh to fly over
Whether the object should fly in the coordinate space of the defined object as opposed to its parent component (defaults to false)
Whether the object should start flying in the coordinate space of the defined object as opposed to its parent component after this movement is done (defaults to false)
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if relativemovemt is true or the ship is flying in a formation (defaults to false)
If the current command action should be override with this action (optional, defaults to true)
Radius of the target. Can be used by some flight behaviours (default, -1)
Move to destination by strafing (blocking)
Whether the object should abort the previous path points if any (defaults to true)
Destination object
Whether the object should fly in the coordinate space of the defined object as opposed to its parent component (defaults to false)
Whether the object should start flying in the coordinate space of the defined object as opposed to its parent component after this movement is done (defaults to false)
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if relativemovemt is true or the ship is flying in a formation (defaults to false)
If the current command action should be override with this action (optional, defaults to true)
Radius of the target. Can be used by some flight behaviours (default, -1)
Move to destination (blocking)
Next position to look at for the last target point.
Whether the object should abort the previous path points if any (defaults to true)
Destination object (macro of this object will be used for target point lookup!)
Either a single tag or a list of tags which are required for the target points
Whether the object should fly to the target points in reverse order
Whether the object should fly in the coordinate space of the defined object as opposed to its parent component (defaults to true)
Whether the object should start flying in the coordinate space of the defined object as opposed to its parent component after this movement is done (defaults to false)
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if relativemovemt is true or the ship is flying in a formation (defaults to true)
If the current command action should be override with this action (optional, defaults to true)
Move to destination using waypoint path (blocking)
Next position to look at for the last waypoint.
Whether the object should abort the previous path points if any (defaults to true)
Destination object (will be used for waypoint lookup!)
Either a single tag or a list of tags which are required for the waypoints
Either a single tag or a list of tags which are required for the start waypoint
Whether the object should fly to the waypoints in reverse order
Whether the object should fly in the coordinate space of the defined object as opposed to its parent component (defaults to true)
Whether the object should start flying in the coordinate space of the defined object as opposed to its parent component after this movement is done (defaults to false)
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if relativemovemt is true or the ship is flying in a formation (defaults to true)
If the current command action should be override with this action (optional, defaults to true)
Move to destination (blocking)
Whether the object should abort the previous path points if any (defaults to true)
Whether the object should stop if the movement is approaching to finish (defaults to false)
Whether local highways should be used (defaults to true)
Destination object or space
Whether the object should keep rotating to match the defined orientation at the end of the path (defaults to false)
Whether the object has to be in the exact given position at the end of the path (defaults to true)
Whether the object should fly in the coordinate space of the defined object as opposed to its parent component (defaults to false)
Whether the object should start flying in the coordinate space of the defined object as opposed to its parent component after this movement is done (defaults to false)
If this is true the ship will fly on steering flight control model (while in high attention), this is also implictely true if relativemovemt is true or the ship is flying in a formation (defaults to false)
Let the ship fly in reverse (defaults to false)
If the current command action should be override with this action (optional, defaults to true)
Radius of the target. Can be used by some flight behaviours (default, -1)
Whether the object should boost. The flight control model / behaviour can have the final say over when and if boosting actually happens. (optional, defaults to false)
Whether the object should use travel mode. The flight control model / behaviour can have the final say over when and if travel mode actually happens. (optional, defaults to false)
Receives the true target zone that this move_to will end in, may be a tempzone that has just been created so this move_to can end there (optional)
Resume at specified label. This is only supported in <actions> and <init>. In global interrupts, use <run_interrupt_script> or <abort_called_scripts> instead.
Return to caller. In global interrupts and actions of <on_abort>, <patch> or <editable> elements, this action does not return to the caller and just aborts the current sequence of actions.
Named return value
Return value name
Return value
Unnamed return value
Perform the referenced library interrupt actions in the current script context
Name of the library interrupt action set
Instruct object to re-join the mass traffic, only works for ships that came from mass traffic in the first place!
(blocking) Instruct object to detach from mass traffic, e.g. after executing a trade - OK to call for ships that don't use mass traffic as well
If the current command action should be override with this action (optional, defaults to true)
Run script (blocking)
Save named return value in a variable
Return value name
Actions to be performed when called script returns, in case the attention level changed in the meantime. Blocking actions are not allowed. <break> and <continue> only work on loops within the attention change actions.
Script name
Run order script (blocking)
Actions to be performed when called script returns, in case the attention level changed in the meantime. Blocking actions are not allowed. <break> and <continue> only work on loops within the attention change actions.
AI order to be executed. It must be an object's current order and its state must be orderstate.ready.
Run a script on a global interrupt. The script will be executed on top of the current call-stack if its interrupt priority is high enough.
No further interrupt actions will run after this action. This action is only allowed in global interrupt actions, but not in library actions.
Script name
If true then the scripts called by this script will be aborted before the interrupt script is started.
If false (default) then the interrupt script will be started on top of the callstack.
Label to resume at when the interrupt script returns. By default the script will resume at the current label.
Abort scripts that were called by this script on a global interrupt. No further interrupt actions will run after this action
and this script will resume at the current label. This action is only allowed in global interrupt actions, not in library actions.
Label to resume at after the interrupt. By default the script will resume at the current label.
Wait for blocking action of previous AI script to complete (blocking).
Requires information stored on this object via <save_ai_action_state>. Only a few specific blocking actions are handled here, in other cases no blocking happens.
Value that receives the name of the blocking action of the previous script
Value that receives the event source object of the blocking action of the previous script
Value that receives the first parameter of the blocking action of the previous script (depends on the action).
For <execute_custom_trade> this is the buyer.
Value that receives the second parameter of the blocking action of the previous script (depends on the action).
For <execute_custom_trade> this is the trade.
Randomly select an appropriate flight behaviour for the given entity
Sets the current command for the script's entity. The command data will remain valid until either it's overwritten or this script ends. It becomes valid again automatically when a called script returns.
Primary command parameter (meaning depends on command)
Secondary command parameter (meaning depends on command)
Sets the current command action for the script's entity. The command action data will remain valid until either it's overwritten or this script ends. It becomes valid again automatically when a called script returns. The following blocking actions can override it: move_to actions ....
Primary command action parameter (meaning depends on command action)
Sets the default flight behaviour for this unit (can still be overridden per move_to order)
Overrides this unit's default flight control model
Resets the unit to use the default flight control model
Enables/disabled collision avoidance for this object
Whether this object should use octree path finding to navigate to its target
Whether this object should use dynamically avoid nearby ships of similar or smaller size
Enables/disables flight assist for this object
Start shooting a weapon
Which weapon set to shoot with (true for primary, false for secondary)
Only weapons/turrets set to the specified mode will shoot at the target, defaults to any.
Shoot at target when the opportunity arises
Which weapon set to shoot with (true for primary, false for secondary)
Optional list of additional targets that may be fired upon if opportunity arises (not supported together with largetarget=true). The object specified by the target attribute must not be in this list (will be ignored and an error will be logged otherwise)
Tolerance angle
Prevent target from being overridden? Default is false
Is the target a very large object, e.g. a station? Default is false (does not support additonal targets)
Only weapons/turrets set to the specified mode will shoot at the target(s), defaults to any.
Stop moving
Stop shooting
Which weapon set to stop shooting (true for primary, false for secondary)
Wait (sleep) for specified time duration (blocking)
Label
AI script actions
Actions in all sub-nodes will be performed.
A randomly selected sub-node action will be performed. The chances of selection can be specified by using weights on the actions.
Actions in sub-nodes will be performed only if the value matches.
Can be followed by <do_elseif> and/or <do_else>.
Actions in sub-nodes will be performed only if the conditions in the previous nodes are not met and if this action's values matches.
Can be followed by <do_elseif> and/or <do_else>.
Actions in sub-nodes will be performed only if the conditions in the previous nodes are not met.
Actions in sub-nodes will be performed in a loop while the value matches.
Conditions that must be met in order for the global interrupt to occur.
Actions to be performed on the global interrupt. Blocking actions are not allowed. <break> and <continue> only work on loops within the interrupt actions.
Will the interrupt event be consumed by this handler when the conditions are met, preventing it from triggering further handlers in this script callstack?
Default is true - set to false to allow the event to be passed on, so that multiple handlers in the callstack can be triggered simultaneously.
Note that handlers are first triggered in the current script, then in the caller, and so on. The event processing stops as soon as a handler consumes the event.
Interrupt actions are always deferred until after the event processing.
Global interrupt handler for this AI script and any called scripts. Can reference a library interrupt handler.
Library of named interrupts and interrupt conditions in global namespace
Library definition of a global interrupt handler. Can be referenced by any AI script.
Globally unique handler name
Library definition of conditions that must be met in order for an interrupt to occur. Can be referenced by interrupt handlers in any AI script.
Globally unique condition set name
Library definition of actions that can be referenced by interrupts or by <include_interrupt_actions> in any AI script.
Globally unique action set name
Global interrupt handlers and library definitions
Order category type
Order parameter type
Internal parameter that is hidden in the UI. Parameters of this type must be optional, i.e. have a default value.
Boolean parameter
Untyped number input from slider (input param "max" required)
Length input from slider (input param "max" required)
Time input from slider (input param "max" required)
Money input from slider (input param "max" required)
Object selected by player
Space selected by player
Position in space, result is [$space, $position]
Ware selected by player
Trade deal selected by player (including trade partner, ware, amount and price - only to be used in special trade orders)
Build task selected by player (only to be used in special build orders)
Formation shape selected by player
A list of any other order parameter type (input param "type" is required, additional input params for that type are valid)
Macro
Valid input param for list: Type of the list elements
Valid input param for number/length/time/money, default is 1
Valid input param for number/length/time/money, default is 0
Valid input param for number/length/time/money
Valid input param for number/length/time/money/position, start value for selection in UI (of same type as the expected result)
Valid input param for object (list of allowed classes) and position (expected result space class, class.zone or class.sector)
Valid input param for object/position (space or container)
Valid input param for object (faction)
Valid input param for object (boolean, for preventing current object from being selected, default is true)
Valid input param for object (ware transport type, for selecting object with mining capability) and ware (zone, for selecting mining resources)
Valid input param for object (boolean, whether object can attack)
Valid input param for object (boolean or ware transport type, for selecting object with appropriate cargo storage)
Valid input param for object (boolean or ware, for selecting object with cargo)
Valid input param for object (controllable, for selecting object that can be commander of the controllable)
Valid input param for object (boolean, for selecting object with unit storage)
Valid input param for object (boolean)
Valid input param for object (boolean)
Valid input param for object (boolean)
Valid input param for object (boolean)
Valid input param for object (boolean, for selecting object that is target of a buildmodule)
Valid input param for object (boolean or ware)
Valid input param for object (boolean or ware)
Valid input param for object (boolean)
Valid input param for object (boolean, for selecting object in state construction)
Valid input param for ware (container, for selecting cargo of given container)
Valid input param for ware (container, for selecting ware that the container has buy offers for)
Valid input param for ware (container, for selecting ware that the container has sell offers for)
Valid input param for ware (container, for selecting ware that the container can carry)
Valid input param for bool (if false parameter is set to value)
Valid input param for bool (if true parameter is set to value)
Definition of an order, determining this AI script as the associated order script. Script parameters must be defined as order parameters.
NOTE: During setup of order parameters, the script keyword "this" is only partially supported since the entity is not determined yet.
"this" can only be used to access the following properties: exists, object, defensible, container, station, ship, zone, sector, cluster.
For example, "this.object" and "this.zone" are always supported, but "this.type" will not work until the script has started.
Order parameters (AI script parameters with additional order-related properties)
AI order script parameter
Internal parameter required by the UI for player input of this order parameter. The order parameter type determines which input parameters are expected.
Input parameter name
Input parameter value
Declares that the script is capable of handling an "edit" event for this parameter while in the "critical" state, provided
that the defined edit conditions are met. This declaration only affects the critical state, as all parameters are editable anyway in the started (non-critical) state.
Non-event conditions that determine whether editing the parameter is currently possible. The checks are triggered by the UI or by the script system (e.g. <edit_order_param>) when necessary.
Actions to be performed immediately when the player or a script edits the parameter. The provided event.* properties are the same as for <event_object_order_param_edited>.
Interrupt-specific actions (<run_interrupt_script>, <abort_called_scripts>) are not supported.
To perform interrupt actions, the script needs to define an actual interrupt handler and listen to <event_object_order_param_edited>.
Parameter name
Localised parameter name displayed in the UI
Default value. If required="false" then a default value must be supplied.
If user input is required, a default value does not have to be supplied, but if it is, it may be taken into account by the UI.
Special constant value that marks the order as infinite. In other words, if the parameter value matches this value, the order becomes an infinite order.
Infinite orders in the order queue have special behaviors (see infinite attribute of <order> element). The existence of this attribute also allows
the user to create this order as a default order (which must be infinite). In this case, this order parameter is hidden from the UI, it is automatically
initialised to the the infinitevalue, and the attributes "default" and "required" have no effect.
Is parameter input by user required? Default is true, unless a default value is provided. If false then the input UI is skipped (but parameter may be edited by the user later)
Is UI visibility of the parameter restricted to the advanced UI mode? Default is false (parameter is always visible). An advanced parameter must be neither required nor internal.
Skill requirement for the pilot of a player-owned ship, to determine whether this order is selectable in the UI. The UI will check this requirement
when selecting a default order. To prevent exploits, the default order is supposed to get cleared when the player changes the ship's pilot.
Minimal required combined skill value
Filter criteria to determine for a player-owned object whether this order is selectable in the UI. For the case of an unselectable order,
the reason can be provided as TextDB reference in the text attribute. There can be multiple elements of this type with different reason texts.
Reason for the order not being selectable (TextDB reference)
Location definition for visualisation in the UI. The location may be queried by the UI at any time after the order is set up.
There can be multiple subsequent location elements, and each location element can have a condition. In this case, for each location element
the condition is evaluated until a valid location element is found, which will then be used.
Optional condition expression. If the condition is not met then this location element is regarded as invalid.
Should the location element be available even if there are parameters that have not been set up in the UI yet? Default is false.
Note that the location definition still relies on certain parameters, so the condition expression is required to check for the
existence of these parameters, e.g. condition="$object?".
Reference object or space of the location
Additional location objects (can be null or omitted, otherwise it must be a list or group of objects). Cannot be combined with position.
Position (offset) relative to the reference object or space (can be null or omitted). Cannot be combined with additionalobjects.
Radius around order location (can be zero or omitted)
Globally unique order ID
Localised order name displayed in the UI
Localised order description displayed in the UI
Is this an infinite order? Default is false. Infinite orders in the order queue have a theoretically infinite duration, but they have special termination conditions:
If a sync point exists, the order terminates when the order has reached the sync point and it is released, otherwise it terminates when a next order is ready in the queue.
Even if the infinite attribute value is false, this order can become infinite if there is a param element with an infinitevalue attribute.
Default orders must be infinite since they should not terminate until another order is ready. Any order with an infinite or infinitevalue attribute can be used as default order.
Allows the order to be cancelled by specific player actions even if it is in the critical state (default is false).
This causes the order script to be aborted like in the non-critical case. The script has to clean up the order state
in the on_abort node. Note that usually the critical state indicates an irreversible process that cannot be cancelled.
AI Script root element
AI script parameter
Parameter name
Default value (parameter is required if default value not supplied)
Non-blocking AI script actions for initialization (will be performed immediately when the script is started, before setting up global interrupt events)
Non-blocking AI script actions for patching a script of an older version (will be performed when loading the script from a save)
Script version at which this patch element was added (it will only be applied when loading a script of an older version)
If true, the patch actions will be performed as early as possible while importing the script, before setting up global interrupt events.
If false or omitted, the patch actions will be performed only when the savegame is fully loaded.
With early="true" accessing and manipulating other objects is not safe, because at that point the game is not fully loaded yet.
However, this is useful for setting up variables that are required for global interrupt events.
Actions for minimum attention level
Minimum attention level
Non-blocking AI script actions for cleanup, in case the script is aborted (will be performed right before the script is terminated).
If the script is aborted as a result of the entity being killed, the event data of <event_object_destroyed> can be accessed.
Set to true if the actions should only be performed if the entity is killed.
Signature
The interrupt priority. In order for this script to be triggered by a global interrupt handler, this priority must be higher than the previous interrupt priority (default is 0).
Script version. The version has to be increased when new blocking actions are inserted.
Name of the value that will receive the result
Name of the group to which the result will be added (group will be created if it does not exist yet)
Group of objects
Object
Destructible
Entity
Ship
Station
Containing space (zone, sector, cluster, or galaxy)
Cluster
Room
Sector
Zone
HoloMap
Actor object (NPC)
Target object
Target component
Target component slot
Asteroid
Weapon
Source object
Killer object
Killed object
Attacker object
Attacked object
Attacked component object
Damaged component
Repaired component
Build module
Production module
Buyer object
Seller object
Buyer object (attribute must be present if seller not supplied)
Seller object (attribute must be present if buyer not supplied)
Trade Offer
Trade offer to match. All other attributes and amount check nodes are ignored.
Build Task
Ware
SignalLeak object
Object which performs the scanning, or group of objects (attribute must be present if scanned not supplied)
Object which is scanned, or group of objects (attribute must be present if scanner not supplied)
Object which performs the hacking, or group of objects (attribute must be present if hacked not supplied)
Object which is hacked, or group of objects (attribute must be present if hacker not supplied)
Attacker object (ship or station) which is doing the locking (attribute must be present if target not supplied)
The attacker's lock target object (attribute must be present if attacker not supplied)
The attacker's lock target component (either the whole target object or a contained component)
Object which performs the observation, or group of objects (attribute must be present if observed not supplied)
Object which is observed, or group of objects (attribute must be present if observer not supplied)
Object which is attacking the target (attribute must be present if target not supplied)
Object which is attacked, or group of objects (attribute must be present if attacker not supplied)
Object which is claimed, or group of objects (attribute must be present if pilot not supplied)
The claiming entity, or group of entities (attribute must be present if claimed not supplied)
Minimal required number of free slots for actor NPCs
Is a free slot for a mission actor NPC required?
Cutscene key name
List
Table
AI order
Start this order immediately? If true, the order is inserted as the current order. If there is an active current order, it will be interrupted, so that it restarts
when the new order is completed. If the current order cannot be interrupted (i.e. it's in the critical state) the new order is inserted right after it.
This attribute has no effect when creating a default order.
If true then the found objects are appended to the value used as the result. Should the value used as the result not be a list, it will become one, losing its previous value (default false)
If true then the result is a list of all found objects, otherwise the result is a random object or null (default is true for count_ conditions, false for find_ actions)
If true then an error message will be produced if no result is found (default is false)
If true then the search does not stop at contained objects, but these objects and their sub-components are searched recursively as well (default is false)
If true then the search will include contained objects (of class object, e.g. docked ships). Sub-components of these objects are not included, unless the recursive attribute is set.
The recursive attribute takes precedence over includeobjects. Default is false.
Offset from reference object
Comment for documentation purposes only
Container (ship or station)
Crate (on first-person platform)
Macro
Macro name (either a plain macro string or a script expression that evaluates to a string or macro)
Construction plan
Module type limit. Integer or a script expression that evaluates to an integer
Object is docked?
Known to player?
Is the station connected to a mass traffic network?
Text page ID
Text page ID (defaults to the speaker's voice page if not supplied)
Line ID in a text page
Conversation section name
Conversation name
Negate condition?
Negate filter outcome? The negation applies to the whole element, e.g. <match_content negate="true"> matches objects which do NOT have the specified content.
Colour Value (0 - 255)
Mass traffic network ID
Discount/commission amount as percentage of a ware's price variation range, valid range from 1 to 100.
NOTE: This is not the actual discount/commission percentage, which depends on the ware that the price modifier is applied to. Discounts/Commissions apply to all sell/buy offers of object/faction respectively.
Group of event objects (can be supplied instead of a single event object). The check attribute does not apply. The group is required to exist but may be empty.
Adding/removing group members is possible even after the event is set up.
Produce an error message if the provided event object does not exist? Default is true.
NOTE: If the event object is a variable or a changeable property, changing it at a later time has no direct effect on this event condition,
i.e. it is not re-enabled automatically. It is only updated under certain conditions, e.g. when loading a savegame or when
the event condition is restarted explicitly (resetting MD cue or starting AI script).
Notification text to be displayed, either a single string with possible line breaks (left-aligned), or a list of strings.
In a list, each pair of strings defines a single row (left-aligned and right-aligned text).
In the list you can use [ string, r, g, b ] instead of a simple string to specify an RGB text color, with color values between 0 and 255.
The default color is determined by the notification priority (a priority above 1 will turn the color red).
Numbers are also accepted instead of strings.
The maximum number of rows is 4 in the message ticker (<show_ticker_message>), and 7 in the target monitor (<show_interactive_message>)
Version status
Proof of concept only
Under development
Test version
Release candidate
Released
Waiting for other assets
Selection type (used with select sub-nodes)
One
Random
Random, excluding an item that can be optionally specified by code
Choose
Weight which determines the chance of this node being selected
Operation to perform (default is set)
Set value (default operation if not supplied, default action is to set to 1 if no random range supplied)
Add to value (default is to add 1 if no random range supplied)
Subtract from value (default is to subtract 1 if no random range supplied)
Insert value into the list as the specified list element, moving all following elements. Insertion at list count + 1 is allowed. (Default value is null if no random range supplied)
Kill method
Unknown
Collected
Collided
Context killed
Hit by area damage
Hit by bomb
Hit by bullet
Hit by mine
Hit by missile
Attacked in low attention
Removed
Self-destructed
Suffocated
Target point discarded
Timed out
Weapon swap
Argon
Boron
Split
Drone
Kha'ak
Paranid
Teladi
Terran
Xenon
Argon
Boron
Drone
Kha'ak
Split
Paranid
Teladi
Terran
Xenon
Race (species)
Alliance of the Word
Antigone Republic
Argon Federation
Civilian
Criminal
Hatikvah Free League
Holy Order of the Pontifex
Kha'ak
Ministry of Finance
Ownerless
Paranid
Player
Scale Plate Pact
Smuggler
Teladi Company
Xenon
Alliance of the Word
Antigone Republic
Argon Federation
Civilian
Criminal
Hatikvah Free League
Holy Order of the Pontifex
Kha'ak
Ministry of Finance
Ownerless
Paranid
Player
Scale Plate Pact
Smuggler
Teladi Company
Xenon
Faction
Owner faction
Owner faction, or list of owner factions
Directional Quadrant
Room type
All weapons (including mining or repair lasers!)
Combat weapons (default)
Mining weapons
Repair weapons
Any mode applies
Attack all enemies
Defend against attackers (default for non-mining weapons)
Mining asteroids (default for mining weapons)
Attempt to shoot down missiles
Automatically target the current target (player only)
Do not shoot
Dock is either empty or the docked ship is stationary
A ship is in its final docking manoeuvre
A ship is currently being retrieved
A ship is currently being retrieved, it will undock as soon as this is done
A ship is currently being stored
A ship is currently undocking
Ship type
Align so that refpos/refobj is on the left side
Align so that refobj-bounding-box is on the left side (requires valid refobject!)
Align so that refpos/refobj is on the right side
Align so that refobj-bounding-box is on the right side (requires valid refobject!)
Orientation that looks directly at refpos/refobj-center
Orientation that looks directly at refobj-bounding-box (requires valid refobject!)
Orientation that looks away from refpos/refobj-center
Orientation that looks away from refobj-bounding-box (requires valid refobject!)
Player activity
No activity
Long-Range Scanning activity
Object Scanning activity
Travel drive
No alert
Red alert
Yellow alert
Component
Positional
Ad Sign (child of an object)
Build Module
Cargo Bay
Construction
Control Component
Control Panel
Destructible
Dock Area
Engine
Hacker Probe
Habitation Module
Interior
Launcher
Lock
Nav Context
Production
Radar
Scanner
Shield Generator
Storage Module
Turret
Walkable Module (Docking Bay or Build Module)
Weapon
Ad Sign Object (child of a zone)
Asteroid
Bomb
Collectable
Container
Controllable
Defensible
Drop
Explosive
Gate
Highway Entry Gate
Highway Exit Gate
Lockbox
Mine
Mission Board
Missile
Nav Beacon
Nebula
Object
Resource Probe
Satellite
Ship
XS sized ship
S sized ship
M sized ship
L sized ship
XL sized ship
Station
Area
Cluster
Galaxy
Highway
Sector
Zone
Entity
Player
Non-player
Computer
NPC
Room
Cockpit
Control Room
Docking bay
Transporter room
Actor (entity) type
Actor (entity) role
Skill type
Control posting lookup
Subordinate assignment
Control position lookup
Room population type
Flat (linear) distribution, default if no profile specified
Higher numbers are more likely
Lower numbers are more likely
Numbers in the middle of the range are more likely
Higher and lower numbers are more likely than those in the middle
Position in conversation menu (a free position is selected if not supplied). This can be either a fixed named value, or a variable script expression (providing the option number between 1 and 6).
Hidden player choice that is selected when the player presses the "close conversation" button
Top left corner (default)
Middle of screen (targeting)
Near weapon monitor
Near event monitor
Near speedbar
Difficulty level
Trivial difficulty level
Very easy difficulty level
Easy difficulty level
Medium difficulty level
Hard difficulty level
Very hard difficulty level
Impossible difficulty level
Upkeep alert level
Low upkeep alert level
Medium upkeep alert level
High upkeep alert level
Logbook category
Logbook interaction type
Starts guidance to the object from the logbook UI
Opens the map focused on the object from the logbook UI
Conversation view type, defining the desired camera direction
Behaviour to compare the relation range
Relation is in range (default)
Relation is greater than or equal
Relation is greater than
Relation is less than or equal
Relation is less than
Relation is not in range
unsupported - Dummy, no param
param = radius
param = radius
param = radius
param = radius
unsupported
unsupported
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
param = distance
Implicitly defines the interactions and the icon this target point should have
Faction mood type
Faction mood level
Order is in the parameter setup process, not all parameters have been provided yet. In this state the order cannot be enabled.
Order is disabled (this state is automatically entered when parameter setup is complete)
Order is enabled but not running yet. In this state, an order in the queue is started when it becomes the current order (which is always the first order, except in order loops).
A default order is started if no order in the queue is ready.
Order script has started and has not entered the critical state or the finish state.
Order script has entered its critical state. In this state, the order cannot be cancelled directly any more, and parameters can only be edited if allowed by the order definition.
Moving or disabling the order is not possible any more. Requests to cancel the order can be made, but they are not necessarily processed immediately; the cancelling behaviour
is order-specific. To handle a cancel request in the critical state, the order script stack has to listen to <event_object_order_cancelled> with immediate="false".
If not cancelled, the order can optionally leave the critical state by entering the finish state.
Optional state that can be entered by the order script for finalisation actions. Disabling, moving and editing the order is not possible any more.
The critical state cannot be entered any more. The order can be cancelled instantly at any time (unlike in the critical state, cancel requests are not passed to the script stack
and cannot fail). This state could e.g. be useful if the actual order is already completed but the ship should move "out of the way" before continuing with the next order.
Engines.
Weapons.
Shields.
Turrets.
Shield groups.
Turret groups.
Ammunition.
Units (drones).
Software.
Thrusters.
Ability drones.
Add loadout elements (not used for loadout generation).
Remove loadout elements (not used for loadout generation).
Loadout flag bitmask (use as many as required).
Object has ship production facilities
Object has faction leader on board
Object has ship equipping facilities but no ship production
Prop flag bitmask (use as many as required).
Object has been destroyed.
Object has been damaged. Param = string describing the severity: low, medium, high
Object has acquired loot. Param = string describing the value: low, medium, high
Connection tag
Connection group tag
State of component
Is integrated to the parent? (built-in component)
Is either hull or shield invulnerable, i.e it cannot take damage? Note: An object can be vulnerable but still indestructible.
Is hull invulnerable, i.e it cannot take take damage?
Is shield invulnerable, i.e it cannot take damage?
Can the object not be destroyed through damage?
Only include operational components? (default true) Otherwise also include construction and wrecked components. Affects attributes class and exactclass.
Is functional?
Is a surface element?
Is a module?
Known to player?
Known to faction? (Faction or list of factions)
Suspicious?
Leads to this destination? (could be space, gate or highway exit gate)
Component contains a trade offer?
Does the provided faction have knowledge of trade offers of the container?
Offer tag
Is a free mission offer location available at the container?
Is a free signal leak location available at the object?
Is object from mass traffic?
Is build module currently building
Is build module currently busy
Can be built by this object?
Can be built by any of these objects? (list or group)
Can build class? If null, filter is not applied.
Can equip class? If null, filter is not applied.
Can build equipment ware (or list of wares)?
Can build macro?
Weapon mode
Weapon type
Primary purpose
Deployable category
Does objects relation allow it to attack provided object or faction. True if relation is 'kill' or if relation is 'killmilitary' and provided object has primarypurpose.fight
May object be attacked by provided object or faction, based on their relations. True if relation is 'kill' or if relation is 'killmilitary' and object has primarypurpose.fight
Can object be picked up by another object?
Is the object commandeerable
Is the object a unit
Does the object have a commander
Is the object capturable
Is the gate an accelerator
Is the object 'active'? Applicable for gates.
Signal Leak type
Is the actor a control entity?
Is the actor a mission actor?
Is the actor a faction representative?
Is the actor temporary?
Is the station capable of claiming ownership of a space?
Is the station a trade station
Is the station a shipyard
Is the station an equipment dock
Is the station a defence station
Is the station a planned defence station, taking future modules into accounts
Is the station a headquarters
Is the station a pirate base
Job identification string or list of job ID strings
Is the ship and those in its command structure organised correctly, as defined by their jobs?
Tag or list of tags to compare with the defined job category tags
Encounter identification string or list of encounter ID strings
Is the ship an encounter job ship?
Room has a control panel of the specified type
Include only normal zones (not temporary, not gate zone and not highway)?
Include temporary zones?
Is the sector contested?
Is the sector contested by provided faction?
Include only normal clusters (not presentation cluster, not venturer cluster)?
Wrecked components that can be restored (exclusive with 'repairable' and 'needsrepair')
Damaged components that can be repaired but may still be functional (exclusive with 'restorable' and 'needsrepair')
Damaged components that are no longer functional and can be repaired (exclusive with 'restorable' and 'repairable')
Class or list of classes (do not use in conjunction with 'exactclass' attribute)
Exact class or list of exact classes, not taking subclasses into account (do not use in conjunction with 'class' attribute)
Entity class or list of classes (do not use with 'exactclass')
Entity's exact class (or list of classes), not taking subclasses into account (do not use with 'class')
Object class or list of classes (do not use with 'exactclass')
Object's exact class (or list of classes), not taking subclasses into account (do not use with 'class')
Station class
Ship class
Room class or list of classes (do not use in conjunction with 'exactclass' attribute)
Room's exact class or list of exact classes, not taking subclasses into account (do not use in conjunction with 'class' attribute)
Ship group for random macro selection
Reference to ShipDB entry (either a plain ID string or a script expression that evaluates to an ID string)
Is the ship capturable? (default is based on class)
Is the ship sellable? (default is true)
Character group for random macro selection
Existing actor to be used instead of creating a new NPC (only useful with variable expressions in scripts)
Reference to CharacterDB entry (either a plain ID string or a script expression that evaluates to an ID string)
Module group for random macro selection
Reference to ModuleDB entry (either a plain ID string or a script expression that evaluates to an ID string)
Room group for random macro selection
Reference to RoomDB entry (either a plain ID string or a script expression that evaluates to an ID string)
Prop group for random macro selection
Reference to PropDB entry (either a plain ID string or a script expression that evaluates to an ID string)
Station group for random construction plan selection
A station macro (either a plain macro string or a script expression that evaluates to a string or macro) to place instead of a construction plan. This station macro MUST have a moduleset defined for it.
Reference to StationDB entry (either a plain ID string or a script expression that evaluates to an ID string)
An object macro (either a plain macro string or a script expression that evaluates to a string or macro).
Exact value (takes priority over min/max/profile/scale)
List of values (takes priority over min/max/profile/scale, ignored if exact is set)
Minimum random number (ignored if exact is set)
Maximum random number (ignored if exact is set)
Random number profile (ignored if exact is set)
Scale of random number profile (ignored if exact is set or if profile is flat)
Optional source for fixed random number seed (must be an object, usually a ship/station, with a job/god spawn source)
Name of loop counter variable
If true then loop counter counts from the max value down to 1
Exact number (takes priority over list and min/max)
List of numbers (takes priority over min/max, ignored if exact is set)
Minimum number (ignored if exact is set)
Maximum number (ignored if exact is set)
Event object (required if group attribute not supplied)
Percentage chance of condition being checked (condition fails if not)
Chance percentage of action being performed (action is skipped if not)
Weight of action which determines its chance of being selected (only evaluated in <do_any> blocks)
Value to match (checked for non-zero if no comparison range is specified)
X coordinate
Y coordinate
Z coordinate
Position value, used in preference to coordinates if supplied
An object (or any positional). Requires a space context to which its relative position is calculated. If also coordinates or a position value are supplied, they are interpreted as relative to the object.
Reference space to be used if the object attribute is supplied. Defaults to the space supplied by the parent XML node, if applicable, otherwise to the object's parent space.
Distance from specified position
Yaw rotation
Pitch rotation
Roll rotation
Rotation value, used in preference to angles if supplied
Allow the generated position to also use the up/down axis, defaults to true
Radius to indicate necessary space required for a safe position (optional, typically defaults to the radius of the bounding box if an object or macro is supplied)
Angle tolerance from the specified direction
Direction for safepos checks. Based on the orientation of the 'directionobject' if provided. Can be combined with 'direction2'
Direction for safepos checks. Based on the orientation of the 'directionobject' if provided. Can be combined with 'direction' but ignored if opposing
Direction object for safepos checks. If direction is not specified, the direction is considered to be from the base position to this object
Avoid the firing range of turrets
Avoid the plot box of stations
Allow the generated position to also use the up/down axis, defaults to true
Radius to indicate necessary space required for a safe position (defaults to created object radius if null)
Avoid the firing range of turrets
Avoid the plot box of stations
Position of this object will be used as refposition, for boundingbox orientations the box of this object will be used.
Position the orientation refers to (e.g. look_at means look from position to refposition), ignored if refobject is set
Red.
Green.
Blue.
Choice text
Optional, set to true to highlight the option and to indicate that it is mission-related (defaults to false)
Optional, determines whether the option is selectable. Defaults to true if not supplied.
Optional, specifies the default confidence of the player option for the smalltalk mini-game (1 to 5, default is 0, i.e. no confidence is displayed)
Optional, specifies the tooltip displayed for this option.
Interactive notification data
Text displayed during interactive notification to prompt player to interact
Interactive notification parameter passed to <event_player_interaction>
Secondary interactive notification parameter passed to <event_player_interaction>
Should the flashing effect of the target monitor be suppressed?
Conversation actor entity (use attribute context and template instead to provide an NPC template instead of an entity as conversation actor)
Controllable object context of the provided NPC template (when using template attribute instead of the actor attribute)
Conversation actor NPC template (can be used instead of actor attribute to provide an NPC template, requires context attribute)
Position of help text (defined in parameters.xml) - defaults to 0
Duration of help text display. If not provided, a suitable duration will be calculated.
Add help text to logbook? Default is false
Pause keeps the help text open (default is true)
Name of the group to which all spawned ware containers will be added (optional, group will be created if it does not exist yet)
Name of the value that will receive a list of all spawned ware types (optional)
Name of the value that will receive a list of ware amounts, corresponding to the wares result list.
Should the ware be unbundled (turn ware into ammo/units) on transfer? (optional, defaults to false)
Do the wares to be dropped come from ammo/unit storage? (optional, defaults to false)
Object the boost is towards (takes preference over 'faction')
Faction the boost is towards ('otherobject' takes preference if provided)
Decay rate
Decay delay
Is the relation boost silent, i.e. without player notification? See <event_player_relation_changed>
List of NPC templates (size must match with other lists)
List of roles to reassign people (size must match with other lists)
List of amounts (size must match with other lists)
List of roles currently assigned to help identify people (size must match with other lists)
List of roles to reassign people (size must match with other lists)
List of races to help identify people (size must match with other lists)
List of skills to help identify people (size must match with other lists)
Are the skills exact or used to find a suitable tier (defaults to false)
Set skills to visible or invisible. Skills are hidden unless explicitly made visible.
Is there a custom comm handler for player-initiated comm.?
If so, this suppresses the generic <event_conversation_started> handler to avoid interference.
Set whether currently in transit or not? In transit actors do not activly control objects.
Set whether currently busy or not? Busy actors do not activly control objects.
Set whether the actor is a mission actor or not.
Set whether the actor is remote commable or not.
Set whether the actor is temporary or not.
Is the actor hidden in their room
Set trades to visible or invisible. Trades are hidden unless explicitly made visible. (e.g. Shady Guy)
(optional) single ware or list of wares to set, add or remove, ommitting this will clear the list if append and remove are false
Should the specified ware(s) be added to the existing exclusion list? (defaults to false which will replace or remove existing entries)
Should the specified ware(s) be removed from the existing exclusion list? (defaults to false which will add or replace existing entries)
(optional) single ware or list of wares to set, add or remove, ommitting this will clear the list if append and remove are false (default)
Should the specified ware(s) be added to the existing inclusion list? (defaults to false which will replace or remove existing entries)
Should the specified ware(s) be removed from the existing inclusion list? (defaults to false which will add or replace existing entries)
Author details
Author name
Author alias
Author contact details
File reference
File name
File description
Internal version number
Date of current version
Status of current version
Match filter
Match any of the specified filters (attributes and sub-elements)
Match filter for the parent of the object
Match filter for the context of the object
Match filter for the children of the objects
Match filter for the contained objects of the objects
Match filter for amount of children defined in the macro of the objects
Match hull percentage
Match max hull percentage
Match shield percentage
Match object secrecy level
Match attention level
Min attention level (not compared if not supplied)
Max attention level (not compared if not supplied)
Exact attention level (not compared if not supplied)
Match by reveal percentage filter
Match filter for the ship's pilot
Match by distance filter. Distance can be checked either to an object or to a position. The reference space, if supplied, must contain the searched objects. min and/or max must be set.
X coordinate
Y coordinate
Z coordinate
Position value, used in preference to coordinates if supplied
Object, used in preference to coordinates if supplied. If no space context is supplied, the object's sector is used, so the searched objects are required to be in the same sector.
Reference space which has to contain both the reference (object or position) and the searched objects.
Minimal distance (min distance is not compared if not supplied)
Maximal distance (max distance is not compared if not supplied)
Match by distance by jumpgates. Calculation based on the sectors of the objects. Checking distance of clusters will check between two random sectors within them.
Min distance by jumpgates (not compared if not supplied)
Max distance by jumpgates (not compared if not supplied)
Origin object for the distance calculation. Passing cluster will base the check on a random sector.
Match by size filter. Size is based on diameter of the bounding box. min and/or max must be set.
Minimal size of the bounding box (min size is not compared if not supplied)
Maximal size (max size is not compared if not supplied)
Match by view angle filter. Can be checked either to an object or to a position AND rotation. The reference space, if supplied, must contain the searched objects.
X coordinate
Y coordinate
Z coordinate
Pitch (rotation around x axis)
Yaw (rotation around y axis)
Roll (rotation around Z axis)
Object, used in preference to coordinates if supplied. If no space context is supplied, the object's sector is used, so the searched objects are required to be in the same sector.
Reference space which has to contain both the reference (object or position/rotation) and the searched objects.
The vertical viewing angle (full range from top to bottom)
The horizontal viewing angle (full range from left to right)
Match filter for available buy offers
Match filter for available sell offers
Match filter for build tasks
Match filter for products of a Container or Production Module. The match is valid if the object produces any of the supplied wares, even if there are no current sell offers.
Match filter for resources of a Container or Production Module. The match is valid if the object consumes any of the supplied wares, even if there are no current buy offers.
Match filter for the cargo wares of a container class object (e.g. Ships, Stations)
Match filter for the non-cargo wares of an object (e.g. Collectable Ware Drops, Asteroids)
Match filter for the basket wares of a job ship
Match by relation filter. Relation of 'faction' or 'object' is checked against filtered object.
Object to reference (takes preference over 'faction')
Faction to reference ('object' takes preference if provided)
Relation range
Match by relation filter. Relation of filtered object is checked against 'faction' or 'object'.
Object to reference (takes preference over 'faction')
Faction to reference ('object' takes preference if provided)
Relation range
Match filter for a dock
Is dock free?
Dock compatibility size
Is this docking bay an internal storage bay? (defaults to false)
Does dock allow building?
Does dock allow trading?
Is dock exclusive for player-controlled ship?
Is dock exclusive for venturers?
Specific venture platform with which venture dock must be associated (can be null)
Match filter for stored units on a Defensible object (including both available and unavailable)
Match filter for available units on a Defensible object
Match filter for unavailable units on a Defensible object
Match filter for the cargo of a storage module or container class objects (e.g. Ships, Stations)
Match filter for the non-cargo wares of an object (e.g. Collectable Ware Drops, Asteroids)
Match filter for loadout installed on defensible class objects (e.g. Ships, Stations)
Match filter for weapon mods installed on defensible class objects (e.g. Ships, Stations)
Match filter for engine mods installed on objects (e.g. Ships, Stations)
Match filter for shield mods installed on defensible class objects (e.g. Ships, Stations)
Match filter for ship mods installed on ships
Match filter for paint mods installed on ships
Match filter for any equipmentmod installed on defensible class objects
Match filter for the buyer of the trade
Match filter for the seller of the trade
List of wares
Ware or list of wares
Exact number (takes priority over min/max)
Minimum number (ignored if exact is set)
Maximum number (ignored if exact is set)
Secrecy level (omit for all)
Unit Category to match
Range for the total amount of the trade offer wares
Range for the min amount of the trade offer wares
Range for the total price of the trade offer
Range for the min price of the trade offer
Filter by the amount in the trade, not including reservations
Filter by the amount in the trade in addition to the amount reserved
(optional) tradepartner that will do the trading. If specified this MUST be the object that does ware reservations.
(optional) single ware or list of wares to filter offers for
Should the ware be unbundled (turn ware into ammo/units) on transfer?
Should the ware be bundled (convert ammo/unit -> ware) on transfer?
A list of wares or table of ware amounts that the loadout should contain. List may contain repeats if more than one of an item is required.
A list of macros or table of macro amount that the loadout should contain. List may contain repeats if more than one of an item is required.
Weapon macro of weapon on which weapon mod should be installed (any if not specified)
Weapon mod ware (from equipmentmods.xml, defines a quality level and primary property of weapon mod, any if not specified)
Engine mod ware (from equipmentmods.xml, defines a quality level and primary property of engine mod, any if not specified)
Shield group context on which shield mod should be installed (macro path as string, object's primary shield group if not specified)
Shield group on which shield mod should be installed (object's primary shield group if not specified)
Shield mod ware (from equipmentmods.xml, defines a quality level and primary property of shield mod, any if not specified)
Ship mod ware (from equipmentmods.xml, defines a quality level and primary property of ship mod, any if not specified)
Paint mod ware (from equipmentmods.xml, defines a quality level and primary property of paint mod, any if not specified)
Position relative to a given space or object
Rotation in space
Bounding box relative to a given space or object
Safe position relative to a given space or object
Create the object using a safe position
Orientation in space
Component Offset
Exact number (takes priority over min/max)
Minimum number (ignored if exact is set)
Maximum number (ignored if exact is set)
Faction or list of factions
Specification tag or list of tags
Ship size
Faction or list of factions
Specification tag or list of tags
Ship size
If true then an error message will be produced if no matching ship entry is found (default is true). Note that no ship will be created in either case.
Faction or list of factions
Specification tag or list of tags
Character race (species)
Faction or list of factions
Specification tag or list of tags
Character race or list of races
If true then an error message will be produced if no matching character entry is found (default is true). Note that no NPC will be created in either case.
Faction or list of factions
Race
Specification tag or list of tags
Production ware
Faction or list of factions
Module race
Specification tag or list of tags
Production ware
If true then an error message will be produced if no matching module entry is found (default is true). Note that no module will be created in either case.
Race
Specification tag or list of tags
Security level (not available from scripts)
Minimum security level
Maximum security level
Economy level (not available from scripts)
Minimum economy level
Maximum economy level
Maintenance level (not available from scripts)
Minimum maintenance level
Maximum maintenance level
Specification tag or list of tags
Macro that props can be attached to
Prop flags (not available from scripts)
Faction or list of factions
Race
Specification tag or list of tags
Production ware
Faction or list of factions
Station race
Specification tag or list of tags
Production ware
If true then an error message will be produced if no matching station entry is found (default is true). Note that no station will be created in either case.
Source of discount/commission, can be an object or a faction
Required type of discount/commission source
Source is an object (ship or station)
Source is a faction
Loadout id
Loadout name
Loadout icon name
Can be used for building?
Can be used by jobs?
Can be used by player?
Loadout was generated?
Macro name
Macro path
Optional item?
Debug-only item?
Macro name
Macro path
Connection group
Exact number/percentage of slots to fill (takes priority over min/max)
Minimum number/percentage of slots to fill (ignored if exact is set)
Maximum number/percentage of slots to fill (ignored if exact is set)
Exact/min/max values are percentages?
Optional item?
Macro name
Exact number of ammunution units (takes priority over min/max)
Minimum number of ammunution units (ignored if exact is set)
Maximum number of ammunution units (ignored if exact is set)
Percentage chance of being present
Optional item?
Ware name
Percentage chance of being present
Minimum value
Maximum value
Percentage chance of being set
Macro name
Optional item?
Selection element (used if selection attribute present)
Equipment mods
The percentage chance that an equipment mod may be installed on this ship. Also the chance that additional equipment mods may be installed. Given as a float between 0 and 1.
Engine mod specification
Engine mod ware (from equipmentmods.xml, defines a quality level and primary property of engine mod)
Weapon mod specification
Weapon mod ware (from equipmentmods.xml, defines a quality level and primary property of weapon mod)
Weapon macro of weapon on which weapon mod should be installed
Shield mod specification
Shield group context on which shield mod should be installed (macro path as string, object itself if not specified)
Shield group context (main ship context if not specified)
Shield group on which shield mod should be installed (context's null group if not specified)
Ship mod specification
Ship mod ware (from equipmentmods.xml, defines a quality level and primary property of ship mod)
Criteria for selecting a suitable ship from the ShipDB.
If combined with a static ShipDB reference in the ref attribute, the nodes of the referenced type take precedence.
<select> cannot be combined with a variable ShipDB reference.
Owner faction selection (if missing and a pilot node is present, the pilot's faction will be used)
Override the owner faction of the generated NPCs to the owner defined in this node (otherwise the owner may be random based on the character reference)
Pilot
The loadout that the ship should be given. Can be defined as a reference to a loadout definition or as a level to which the ship should be outfitted.
The percentage level to which this ship should be fitted out with randomly generated equipment. Given as a float between 0 and 1.
A reference to a loadout definition as defined in loadouts.xml
A reference to a loadout created by a script
Paint mod specification
Paint mod ware (from paintmods.xml, defines a quality level and visual properties of a paint mod)
Default ware basket to select wares to be added from. This basket definition is required when neither basket nor list are defined in a wares element.
When used in the JobDB or referenced from it, this basket is optional and overrides the job's basket.
Ammo the ship is spawned with
Fill percentage
Fill amount
Cargo the ship is spawned with
Maximum cargo space fill percent of the ware(s) added from this ware node. If specified together with fillvalue, the lower amount is used.
Maximum credit value of the ware(s) added from this ware node. If specified together with fillpercent, the lower amount is used.
Chance that the node will be processed.
Ware basket to select wares to be added from. Takes priority over wares defined in list attribute, and over any default basket.
If no default basket is provided via the <basket> element or via the job definition, either basket or list attribute must be supplied.
List of wares to be chosen from ( script-list syntax using [] !)
If this is set to true, ALL wares in the basket/list will be added, evenly distributred according to fillpercent/fillvalue, otherwise a single ware will be randomly selected.
By default cargo nodes are skipped for ships that are RE-spawned by the Job Engine. If this is set to true, this node will be processed every time this ship is spawned for a job. Wares nodes are always processed for non-job related ship creation.
Inventory the ship is spawned with
Fill amount
Fill value
Chance that the node will be processed.
Ware basket to select wares to be added from. Takes priority over wares defined in list attribute, and over any default basket.
If no default basket is provided via the <basket> element or via the job definition, either basket or list attribute must be supplied.
List of wares to be chosen from ( script-list syntax using [] !)
If this is set to true, ALL wares in the basket/list will be added, evenly distributred according to fillpercent/fillvalue, otherwise a single ware will be randomly selected.
Drop object
DropDB reference
Drone Units. Currently interferes with loadouts.
People on board the ship (as npc templates)
PeopleDB reference (takes precidence over locally defined people)
Criteria for selecting a suitable character from the CharacterDB.
If combined with a static CharacterDB reference in the ref attribute, the nodes of the referenced type take precedence.
<select> cannot be combined with a variable CharacterDB reference.
NPC name (random name will be chosen if not supplied)
Name string expression
Owner faction selection (if the NPC is used as pilot it will override the ship's owner)
Voice page ID. Instead of directly supplying a page ID, the tags attribute can be used to specify requirements for the random page selection.
Either a single tag or a list of tags which are required for the voice page.
Character skills
Skill (value between 0 and 15, representing steps of 1/3 of a star, up to 5 stars)
Skill type
Stock definition.
The ID of the stock entry that the character should use.
Clothing mod specification
Clothing mod ware (from clothingmods.xml, defines a quality level and visual properties of a clothing mod)
Production compatibilities
Station module limits (defaults to 20)
Module reference
Criteria for selecting a suitable module from the ModuleDB.
If combined with a static ModuleDB reference in the ref attribute, the nodes of the referenced type take precedence.
<select> cannot be combined with a variable ModuleDB reference.
Criteria for selecting a suitable station from the StationDB.
If combined with a static StationDB reference in the ref attribute, the nodes of the referenced type take precedence.
<select> cannot be combined with a variable StationDB reference.
Station name (default name will be used if not supplied)
Name string expression
Owner faction selection
The loadout that the ship should be given. Can be defined as a reference to a loadout definition or as a level to which the ship should be outfitted.
The percentage level to which this ship should be fitted out with randomly generated equipment. Given as a float between 0 and 1.
Station name (default name will be used if not supplied)
Name string expression
Owner faction selection
Fill percentage
Person
Weight of this role selection
Loadout elements cannot contain script expressions
Macro elements
Engines
Weapons
Shields (ungrouped)
Turrets (ungrouped)
Group elements
Shield groups
Turret groups
Ammunition elements
Ammunition
Units (drones)
Software elements
Software
Value elements (currently unused)
Virtual macro elements
Thrusters
Add a TextDB line to the texts to be spoken. Cannot be combined with attributes 'page' and 'line' in parent element.
Adds the name of a value to the texts to be spoken. Requires that a name has been defined in the correct format. Cannot be combined with attributes 'page' and 'line' in parent element.
A component, object, macro, faction, race, or ware
Adds the description of a value to the texts to be spoken. Requires that a description has been defined in the correct format. Cannot be combined with attributes 'page' and 'line' in parent element.
A component, object, macro, faction, race, or ware
Event for when repair of a component has been requested (object = the object containing the damaged component - e.g. a ship or station, param = the damaged component, param2 = whether to make the damaged component a priority for repair)
Event for when a UI control is triggered (param = screen ID, param2 = control ID, param3 = screen parameters)
Screen ID
Control ID
Event for when a unit has been destroyed (object = the object owning the unit, param = the unit's category, param2 = the unit's mk)
The destroyed unit's category
Event for when a unit has started building/welding (object = the object on which the unit operates, param = the unit's mk)
Event for when a unit has stopped building/welding (object = the object on which the unit operates, param = the unit's mk)
Event for when a unit has started repairing/welding (object = the object on which the unit operates, param = the unit's mk)
Event for when a unit has stopped repairing/welding (object = the object on which the unit operates, param = the unit's mk)
Event for when a boarding operation has been created (param = boarding operation id)
Event for when a boarding operation has been started (param = boarding operation id)
Operation ID
Event for when a boarding operation has been removed (param = boarding operation id)
Operation ID
Event for when a boarding operation has had its phase changed (param = boarding operation id, param2 = new boardingphase, param3 = old boardingphase)
Operation ID
Event for when a boarding support mission was NOT successful (object = boarding commander)
Event for when a boarding support mission was successful (object = boarding commander)
Event for when an object aborts charging boost (object = boosting object)
Event for when an object starts charging boost (object = boosting object)
Event for when an object starts boosting (object = boosting object)
Event for when an object stops boosting (object = boosting object)
Event for when a build related to the object begins (object = buildmodule/buildingobject/buildingobjectcommander, param = buildmodule, param2 = constructionsequence, param3 = buildtask)
Event for when a build related to the object finishes (object = buildmodule/buildingobject/buildingobjectcommander, param = buildmodule, param2 = constructionsequence, param3 = buildtask)
Event for when a build related to the object partially finishes construction. List of completed components is provided. (object = buildmodule/buildingobject/buildingobjectcommander, param = buildmodule, param2 = list, param3 = buildtask)
Event for when a build related to the object is cancelled (object = buildmodule/buildingobject/buildingobjectcommander, param = buildmodule, param2 = constructionsequence, param3 = buildtask)
Event for when a build task is added (object = building object, param = build task)
Event for when a ship is constructed to operational state (object = buildingobject, param = ship, param2 = buildtask)
Event for when a station is constructed to operational state (object = buildingobject, param = station, param2 = buildtask)
Event for when a control entity is set on a controllable (object = controllable or entity, param = entity)
Event for when a control entity is removed from a controllable (object = controllable or entity, param = entity, param2 = kill method)
Event for when a conversation is finished (object = actor (entity or list containing context and template), param = outcome, param2 = outcome parameter)
Conversation outcome (the name of the last section chosen by the player, or the conversation name in case of a non-interactive conversation)
The outcome parameter (the last choice parameter as provided by <add_player_choice>, <add_player_choice_sub>, or a menu selection),
or the conversation parameter in case of a non-interactive conversation (as provided by <start_conversation>)
Event for when the next section in a conversation is triggered (object = actor (entity or list containing context and template), param = section name, param2 = choice parameter, param3 = minigame score or null)
Prefix of conversation section name that has to be matched
The parameter associated with the player choice, as provided by <add_player_choice>, <add_player_choice_sub>, or a menu selection
Event for when a sub-conversation returns to the previous section (object = actor (entity or list containing context and template), param = section name, param2 = base parameter, param3 = return parameter)
Prefix of conversation section name that has to be matched
The value provided by this previous section when it started the sub-conversation (baseparam of <add_player_choice_sub>, <add_player_choice_subconv>, or of the menu selection).
The value provided by the player choice that returned to this previous section (returnparam of <add_player_choice_return> or of the menu selection).
Event for when a conversation is started (object = actor (entity or list containing context and template), param = conversation name, param2 = conversation parameter)
Prefix of conversation name that has to be matched
The parameter associated with the conversation, as provided by <start_conversation>
Event for when the player shuold be warned, e.g. on station explosion (param = component, param2 = text line)
Component that is the reason for the warning
Text line
Event for when the camera of a cutscene is created (param = cutscene key string)
Event for when a cutscene sends a signal (param = cutscene key string)
Signal ID name
Event for when a cutscene starts (param = cutscene key string)
Event for when a cutscene ends (param = cutscene key string)
Event for when an object is pinged by a long range scan. (object = scanned object, param = true iff the result was 'identified')
Was the result 'identified'?
Event for when an object sends out a long range scan wave. (object = scanning object or player)
Event for when a character starts an animation. (object = player/npc, param = animation ID)
Animation ID
Event for when a character finishes an animation. (object = player/npc, param = animation ID)
Animation ID
Event for when a npc finishes their walk. (object = npc)
Event for when npc slots are validated in an interior which could have blocked slots (object = interior or object of interior, param = interior, param2 = was this a recalculation of an already validated interior?)
Was this validation a recalculation of a previously validated interior?
Event for when a target lock is acquired (requires attribute attacker and/or target) (object = attacker if supplied, otherwise target object, param = the other object, param2 = locking weapon, param3 = target component)
Event for when a target lock attempt is initiated (requires attribute attacker and/or target) (object = attacker if supplied, otherwise target object, param = the other object, param2 = locking weapon, param3 = target component)
Event for when a target lock is lost (requires attribute attacker and/or target) (object = attacker if supplied, otherwise target object, param = the other object, param2 = locking weapon, param3 = target component)
Event for when a mass traffic ship is removed from a zone. If zone is provided then it is the event object (object = zone, param = mass traffic ship), otherwise object or group must be provided (object = mass traffic ship)
Event for when an object has been caught doing an illegal activity (see <report_illegal_activity>), like hacking or certain types of scanning (param = caught object, param2 = victim of the activity [optional])
The object doing the illegal activity (attribute must be present if victim not supplied)
The victim of the activity (attribute must be present if object not supplied)
Event for when a target waypoint is approached (but not necessarily yet reached) by a flying object (object = approaching object, param = remaining time)
Event for when a flying object arrives at a target waypoint (object = arriving object)
Event fired when the gravidar of an object has performed a scan (object = object of gravidar)
Event for the specified object being attacked (object = attacked object, param = attacker, param2 = kill method, param3 = attacked component)
Event for when the specified object attacks an object (object = attacker, param = attacked object, param2 = kill method, param3 = attacked component)
Event for the specified object's shield being damaged (object = event source, param = damaged component, param2 = new shield value, param3 = damage)
Event for the specified object's hull being damaged - includes hulls of children (object = event source, param = damaged component, param2 = new hull value, param3 = damage)
Event for the specified object's hull being repaired - includes hulls of children (object = event source, param = repaired component, param2 = new hull value, param3 = repaired value)
Event for the specified components's hull climbing above the function threshold, rendering the object functional again - includes hulls of children (object = parent object, param = affected component)
Event for the specified components's hull falling below the function threshold, rendering the object non-functional - includes hulls of children (object = parent object, param = affected component)
Event for the specified object being abandoned by its NPCs (object = abandoned object)
Event for the specified object changing attention level (object = attention changing object, param = new attention level, param2 = previous attention level)
New attention level
Previous attention level
Event for the specified object changing cluster (object = cluster changing object, param = new cluster, param2 = previous cluster)
Event for the specified object changing object (object = object changing object, param = new object, param2 = previous object)
Event for the specified object changing owner (object = owner changing object, param = new owner faction, param2 = previous owner faction, param3 = true previous owner faction)
Event for the specified object changing sector (object = sector changing object, param = new sector, param2 = previous sector)
Event for the specified object changing room (object = room changing object, param = new room, param2 = previous room)
Event for the specified object changing zone (object = zone changing object, param = new zone, param2 = previous zone)
Event for the specified object changing state (object = state changing object, param = new state, param2 = previous state)
Event for any object within the specified space changing owner (object = space or container which contains the object, param = object changing ownership, param2 = new owner faction, param3 = previous owner faction)
Space which contains the object (i.e. zone, sector or cluster), or direct container context (ship or station)
Event for any entity within the specified space changing owner (object = space or container which contains the entity, param = entity changing ownership, param2 = new owner faction, param3 = previous owner faction)
Space which is contains the entity (i.e. zone, sector or cluster), or direct container context (ship or station)
Event for when an object is claimed or a NPC claims an object (requires attribute claimed and/or pilot) (do not use with player.entity) (object = claimed if supplied, otherwise pilot, param = the other object)
Event for the specified object collecting ammo (object = collecting object, param = weapon macro, param2 = amount)
Ammo amount
Event for the specified object collecting a powerup (object = collecting object)
Event for the specified object collecting a resource (object = collecting object, param = ware, param2 = amount)
Ware amount
Event for the specified object collecting a ware drop (object = collecting object, param = ware, param2 = amount, param3 = collected object)
Ware amount
The collected object
Event for when the specified object collides (object = colliding object, param = other colliding object)
The other object involved in the collision
Event for when the construction sequence for a station has been created, e.g. requested via <create_construction_sequence> (object = station, param = constructionsequence if successful, param2 = true if successful)
Event for when an object is triggered (object = trigger object, param = triggerer)
The triggering object
Event for when a subordinate receives a new commander (object = subordinate, param = new commander, param2 = previous commander, param3 = new assignment)
Previous commander (can be null)
Event for when a subordinate changes assignments without changing commander (object = source player/entity/subordinate/commander, param = subordinate, param2 = previous assignment, param3 = new assignment)
Previous assignment
Event for when a Controllable object activates a weapon (object = Controllable, param = Weapon, param2 = ammo type (null if unlimited), param3 = ammo amount (not set if unlimited))
Ammo type
Ammo amount
Event for when a Controllable object activates a weapon (object = Controllable, param = Weapon)
Event for when a Controllable object activates a weapon group (object = Controllable, param = weapongroup index, param2 = true for primary, false for secondary group)
Event for when a Controllable object deactivates a weapon group (object = Controllable, param = weapongroup index, param2 = true for primary, false for secondary group)
Event for the specified object being destroyed (object = destroyed object, param = killer, param2 = kill method, param3 = was parent killed)
Event for the specified object docking (object = docking object, param = dock object, param2 = zone)
Event for the specified object starting to dock (object = docking object, param = dock, param2 = zone)
Event for an object docking at the specified container (object = container object, param = docking object, param2 = new context, param3 = old context)
Container object (station or ship, required if group attribute not supplied)
Event for an object starting to dock at the specified container (object = container object, param = docking object, param2 = new context, param3 = old context)
Container object (station or ship, required if group attribute not supplied)
If object is a ship: Event for the specified object getting a free docking bay assigned for docking (object = docking ship)
If object is a docking bay: Event for the specified object getting a ship assigned to it (object = assigned docking bay)
If object is the player entity: Event for the player's ship context getting a free docking bay assigned (object = player)
Event for a ship being assigned to a dock of the specified container (object = container object, param = dock, param2 = assigned ship)
If object is a ship: Event for the specified object getting the dock unassigned for a docking bay (object = ship getting dock unassigned)
If object is a docking bay: Event for the specified object getting a ship unassigned from it (object = unassigned docking bay)
If object is the player entity: Event for the player's ship context getting the dock unassigned (object = player)
Event for an unassigned dock of an object from the specified container (object = container object, param = dock unassigned object)
Container object (station or ship, required if group attribute not supplied)
Event for the specified object being denied docking (object = docking object)
Event for the specified object being incapable of docking (object = docking object)
Event for the specified object being too far from the docking target (object = docking object)
Event for the specified object being put into the queue for a free docking bay (object = docking object)
Event for the specified object having aborted a docking process (object = docking object, param = previously assigned docking bay)
Event for the specified object being cleared to undock (object = docked object)
Event for the specified object dropping objects (object = dropping object, param = list of dropped objects)
Event for the specified object finding drops on its Gravidar scanner (object = scanning object, param = list of drops found)
Event for the specified object finding an enemy on its Gravidar scanner (object = scanning object, param = enemy)
Event for the specified object entering an anomaly (object = entering object, param = entry anomaly, param2 = exit anomaly)
Event for a venture mission being completed (param = transaction id, param2 = venture mission name, param3 = number of returned ships)
Event for the specified object entering a gate (object = entering object, param = entry gate, param2 = exit gate)
Event for when the object becomes visible on the gravidar of any player-owned object (object = entering object)
Event for when the object is no longer visible on the gravidar of any player-owned object (object = leaving object)
Event for when the alert level of an object changes (object = object changing the alert level, param = new alert level string, param2 = old alert level string)
Alert level string
Previous alert level string
Event for when the traffic level of an object changes (object = object changing the traffic level, param = new traffic level string, param2 = old traffic level string)
Traffic level string
Previous traffic level string
Event for when a missile is launched at the specified object (object = target object, param = target component, param2 = missile, param3 = missile source)
Event for when the specified object kills an object/component (object = killer, param = killed object/component, param2 = kill method)
Event for the specified object launching a missile (object = missile launching object, param = target component, param2 = missile)
Event for when the entities money gets updated (object = entity of the account, param = oldamount, param2 = newamount)
Event for when an AI order in an object's order queue gets enabled (entering the ready state), when the default order gets enabled,
or when there is a new current order that should be started, even if already enabled before (object = the object receiving the order, param = order)
Event for when the a running AI order is cancelled (object = the order's owner object, param = order, param2 = true iff the order is not in the critical state and is cancelled immediately).
NOTE: If param2 is true then the order (event.param) was already cancelled and was either reset or does not exist any more.
Is the order cancelled immediately? This is true except for orders in the critical state.
Orders in the critical state can handle cancel requests by listening to this event with immediate="false".
Event for when the running AI order is finished (object = the order's owner object, param = order).
Note that it is possible that the order no longer exists.
Event for when a parameter of a running AI order in the critical state is edited (object = the order's owner object, param = order, param2 = order param name, param3 = order param value)
Order param name string
New order param value
Event for when the sync point of an infinite AI order in an object's order queue gets released, indicating that the order should finish (object = the order's owner object, param = order)
Event for when the specified object is picked up by another object (object = pickup, param = collector)
Event for when the specified object picks up another object (object = collector, param = pickup)
Event for the specified object being signalled (object = signalled object, param = custom, usually to specify type of signal, param2 = custom, param3 = custom)
Event for when a new subordinate is added to a commander (object = new commander, param = subordinate, param2 = new assignment)
Event for when a subordinate is removed from a commander (object = old commander, param = subordinate, param2 = old commander)
Previous commander
Event for when an object's target is invalid, e.g. went through a jump gate, does not exist any more etc. (object = object with an invalid target, param = invalid target, param2 = true iff the target is actually not reachable)
Invalid target
Is the target unreachable?
Event for the specified object undocking (object = undocking object, param = dock, param2 = zone)
Event for the specified object starting to undock (object = undocking object, param = dock, param2 = zone)
Event for an object undocking from the specified container (object = container object, param = undocking object, param2 = new context, param3 = old context)
Container object (station or ship, required if group attribute not supplied)
Event for an object starting to undock from the specified container (object = container object, param = undocking object, param2 = new context, param3 = old context)
Container object (station or ship, required if group attribute not supplied)
Event for god creating a station (object = containing space, param = station)
Space which contains the created station
Event for god creating a base factory with the modules to be constructed (object = containing space, param = station, param2 = list of module macros)
Space which contains the created factory
Event for god creating an object (object = containing space, param = object)
Space which contains the created object
Event for the specified object changing a weapon mode (object = object changing the weapon mode, param = weapon, param2 = new weapon mode)
Weapon for which the mode will be changed (optional)
New weapon mode in which the weapon will be changed (optional)
Event on an object or a space, e.g. zone, for when any object enters it or is created in it (object = entered space/container, param = entering object, param2 = new context of entering object, param3 = old context of entering object).
Space which is entered (i.e. zone, sector or cluster), or direct container context which is entered (ship or station)
Event on an object or a space, e.g. zone, for when any object leaves it or is removed (object = left space/container, param = leaving object, param2 = new context of leaving object, param3 = old context of leaving object).
Space which is left (i.e. zone, sector or cluster), or direct container context which is left (ship or station)
Event on an object or a space, e.g. zone, for when any entity enters it or is created in it (object = entered space/room/container, param = entering entity, param2 = new context of entering entity, param3 = old context of entering entity).
Space or room which is entered (i.e. room, zone, sector or cluster), or direct container context which is entered (ship or station)
Event on an object or a space, e.g. zone, for when any entity leaves it or is removed (object = left space/room/container, param = leaving entity, param2 = new context of leaving entity, param3 = old context of leaving entity).
Space or room which is left (i.e. room, zone, sector or cluster), or direct container context which is left (ship or station)
Event for when the player attacks an object from their currently controlled object (param = attacked object, param2 = kill method, param3 = attacked component)
Event for when the player aborts charging boost
Event for when the player starts charging boost
Event for when the player starts boosting
Event for when the player stops boosting
Event for when a player-owned station's build plot changes (param = station, param2 = old build plot max, param3 = old build plot center)
Station for which build plot changed
Event for when a player-owned station's paid build plot size changes (param = station, param2 = old paid build plot size)
Station for which build plot changed
Event for when a player-owned build starts (param = buildprocessor, param2 = constructionsequence, param3 = buildtask)
Event for when a player-owned build finishes (param = buildprocessor, param2 = constructionsequence, param3 = buildtask)
Event for when a player-owned build partially finishes. List of completed components is provided. (param = buildprocessor, param2 = list, param3 = buildtask)
Event for when a player-owned build is cancelled (param = buildprocessor, param2 = constructionsequence, param3 = buildtask)
Event for when a player-owned ship is constructed to operational state (param = ship, param2 = buildtask)
Event for when a player-owned station is constructed to operational state (param = station, param2 = buildtask)
Event for when a player-owned productionmodule has started production of a ware (param = productionmodule, param2 = product ware, param3 = whether this is a research project) (see also event_player_production_finished)
Event for when a player-owned productionmodule has finished production of a ware (param = productionmodule, param2 = product ware, param3 = whether this was a research project) (see also event_player_production_started)
Event for when the player changes activity (param = new activity, param2 = old activity)
Event for when the player changes target (param = new target)
Event for when a player responds to an interactive notification (param = interaction param, param2 = secondary interaction param)
Interaction parameter
Secondary interaction parameter
Event for when the player successfully teleports. (param = new room, param2 = old room, param3 = is shortcut instead of real teleport)
Is this a shortcut instead of a real teleport?
Event for when the player failed to teleport. (param = destination room, param2 = is shortcut instead of real teleport)
Is this a shortcut instead of a real teleport?
Event for when a player owned object is attacked (object = attacked object, param = attacker, param2 = kill method, param3 = attacked component)
Event for when a player owned object, including the player, attacks another object (param = attacker, param2 = attacked object, param3 = kill method)
Event for when the player faction claims an object (param = claimed object, param2 = pilot)
Event for when the player collects ammo (param = weapon macro, param2 = amount)
Ammo amount
Event for when the player crafts ammo from inventory wares (param = weapon macro, param2 = amount)
Ammo amount
Event for when the player collects a powerup
Event for when the player collects a ware drop (param = ware, param2 = amount, param3 = collected object)
Ware amount
The collected object
Event for when a commission for the player is added (object = source object or source faction, param = display name, param2 = commission amount, param3 = end time)
Event for when a discount for the player is added (object = source object or source faction, param = display name, param2 = discount amount, param3 = end time)
Event for when the player ship activates a weapon (param = Weapon, param2 = ammo type (null if unlimited), param3 = ammo amount (not set if unlimited))
Ammo type
Ammo amount
Event for when the player ship deactivates a weapon (param = Weapon)
Event for when the player ship activates a weapon group (param = weapongroup index, param2 = true for primary, false for secondary group)
Event for when the player ship deactivates a weapon group (param = weapongroup index, param2 = true for primary, false for secondary group)
Event for when the player is created (no parameters)
Event for when an object (station module, station, ship, ...) is discovered or scanned by the player and added to the scan memory (param = object, param2 = scan level)
Scan level (0 if object was discovered, positive if object was actively scanned)
Event for when an object is detected by the player and added to the long range scan memory (param = object)
Event for when a mission offer is discovered by the player and added to the mission offer memory (param = mission offer cue)
Mission offer MD cue
Event for when an object is hacked by the player (param = hacked, param2 = hacker, param3 = control panel type)
Event for when a missile is launched at the player (param = target component, param2 = missile, param3 = missile source)
Event for when the player kills an object from their currently controlled object (param = killed object, param2 = kill method)
Event for when the player launches a missile (param = target component, param2 = missile)
Event for when the player is granted a licence for another faction (param = licenceref, use .type or .faction)
Event for when the player has lost a licence for another faction (param = licenceref, use .type or .faction)
Event for when the player money gets updated (param = oldamount, param2 = newamount)
Event for when a player owned object has collected a resource (object = collecting object, param = ware, param2 = amount)
Ware amount
Event for when a player owned object was killed (param = killed object, param2 = killer object, param3 = kill method)
Event for when a player owned object, including player, kills an object (param = killer object, param2 = killed object, param3 = kill method)
Event for when the player opens a crate and claims all its content (param = crate)
Event for when the player's current weapon runs out of ammo (param = weapon macro, param2 = ranout of ammo due to the shot)
When true, then we fired and ran out of ammo, otherwise we didn't have ammo in the first place.
Event for when a faction or an object's control entity changes the relation towards the player (object = entity or null, param = faction or null, param2 = [new relation, old relation], param3 = relationchangereason).
NOTE: On permanent faction changes, object is null. On relation boosts, object is non-null, and param is either null (silent boost) or faction.player (non-silent boost).
See <set_relation_boost> and <add_relation_boost>.
The reason for relationship change
Event for when the player starts control
Event for when the player stops control
Event for when the player adds a new subordinate to squad (param = subordinate)
Event for when the player removes a subordinate from squad (param = subordinate)
Event for when a trade is discovered by the player and added to the trade memory (param = tradeoffer)
Event for when a player trade is cancelled (param = tradeoffer)
Event for when the player completes a trade (param = tradeoffer)
Event for when the player starts a trade (param = tradeoffer)
Event for when volatile wares in the player's inventory self-destruct (param = table of lost volatile wares with corresponding amounts)
Event is raised when the player ship travel mode begins charging (param = time when the mode is fully charged)
Event is raised when the player ship travel mode aborts an ongoing charging process
Event is raised when the player ship travel mode is done charging
Event is raised when the player begins unlocking a signal leak (param = signal leak being unlocked)
Event is raised when the player fails to unlock a signal leak (param = signal leak being unlocked)
Event is raised when the player has successfully unlock a signal leak (param = signal leak being unlocked)
Event is raised when the player is not currently able to unlock a signal leak (param = signal leak being unlocked)
Event is raised when the player has repaired a signal leak (param = signal leak that was repaired, param2 = object that the signal leak was attached to)
Event is raised when the player has successfully unlocked a platform trigger (e.g. a button, panel, door) that required wares to be consumed in order to activate (param = trigger component, param2 = trigger group tag)
Event is raised when the player or a player-owned object has successfully attached a bomb (param = bomb that was attached)
Event is raised when the player has unlocked a blueprint (param = blueprint's module macro, param2 = blueprint's ware)
Event is raised when the player has created signal leaks (param = list of signal leaks)
Event for the player entering an anomaly (param = entry anomaly, param2 = exit anomaly)
Event for when the player has engaged the autopilot (param = target, param2 = next target on the way to target which may be identical to target)
Event for when the has completed loading a savegame (param = gameversion, param2 = build number, param3 = original gameversion of savegame)
Game version number of the loaded save, multiplied by 100. e.g. 251 for version 2.51
Build number of the loaded save, e.g. 187332
Game version number this save was started with, multiplied by 100. e.g. 125 for version 1.25
Event for when a new game has been started and the universe populated
Event for when a (deep)scan is aborted (requires attribute scanner and/or scanned) (object = scanner if supplied, otherwise scanned, param = the other object, param2 = true iff object is scanner)
Event for when a (deep)scan is finished (requires attribute scanner and/or scanned) (object = scanner if supplied, otherwise scanned, param = the other object, param2 = true iff object is scanner)
Event for when a (deep)scan is started (requires attribute scanner and/or scanned) (object = scanner if supplied, otherwise scanned, param = the other object, param2 = true iff object is scanner)
Event for when a hack is aborted (requires attribute hacker and/or hacked) (object = hacker if supplied, otherwise hacked, param = the other object, param2 = true iff object is hacker)
Event for when a hack is finished (requires attribute hacker and/or hacked) (object = hacker if supplied, otherwise hacked, param = the other object, param2 = true iff object is hacker, param3 = the score result of the minigame (0 if no minigame was played))
Event for when a hack is started (requires attribute hacker and/or hacked) (object = hacker if supplied, otherwise hacked, param = the other object, param2 = true iff object is hacker)
Event for when an object is hacked (requires attribute hacker and/or hacked) (object = hacker if supplied, otherwise hacked, param = the other object, param2 = true iff object is hacker)
Event for when a hack is aborted (requires attribute hacker and/or hacked) (object = hacker if supplied, otherwise hacked object, param = the other object, param2 = true iff object is hacker, param3 = control panel type)
Event for when a hack is finished (requires attribute hacker and/or hacked) (object = hacker if supplied, otherwise hacked, param = the other object, param2 = true iff object is hacker, param3 = control panel type)
Event for when an object starts an observation (requires attribute observer and/or observed) (object = observer or observed, param = observer, param2 = observed, param3 = range length)
Event for when an observation is stopped (requires attribute observer and/or observed) (object = observer or observed, param = observer, param2 = observed)
Event for when an object signals it will attack a target (requires attribute attacker and/or target) (object = attacker or target, param = attacker, param2 = target)
Event for when an object signals it will stop an attack (requires attribute attacker and/or target) (object = attacker or target, param = attacker, param2 = target)
Event for when an actor has finished speaking (object = actor, param = page, param2 = line, param3 = interrupted - 0 if fully finished, 1 if interrupted, 2 if not even started )
Event for when a trade is cancelled, (object = either buyer or seller - see following documentation, param = tradeoffer) (If tradeoffer is provided, listened object = tradeoffer owner) : (otherwise buyer and/or seller must be provided, listened object = seller if supplied, otherwise buyer)
Event for when a trade is completed (object = either buyer or seller - see following documentation, param = tradeoffer) (If tradeoffer is provided, listened object = tradeoffer owner) : (otherwise buyer and/or seller must be provided, listened object = seller if supplied, otherwise buyer)
Event for when a trade is started (object = either buyer or seller - see following documentation, param = tradeoffer) (If tradeoffer is provided, listened object = tradeoffer owner) : (otherwise buyer and/or seller must be provided, listened object = seller if supplied, otherwise buyer)
Event for when an object has been detached from all mass traffic networks that restrict its movement (object = detached object)
Event for when a mass traffic network has been removed (object = the zone that owned the network, param = the removed network's ID)
Event for the specified weapon firing (object = the weapon, param = fired bullet/missile/bomb)
Event for an object launching a countermeasure (object = the launching defensible, param = launched countermeasure)
Event for an object launching a mine (object = the launching defensible, param = launched mine)
Event for an object launching a lasertower (object = the launching defensible, param = launched lasertower)
Event for lasertower being launched (object = the space which the satellite was launched in, param = the launching defensible, param2 = launched lasertower)
Space which the lasertower was launched in
The object which launched the lasertower
Event for mine being launched (object = the space which the mine was launched in, param = the launching defensible, param2 = launched mine)
Space which the mine was launched in
The object which launched the mine
Event for an object launching a navigation beacon (object = the launching defensible, param = launched navigation beacon)
Event for navbeacon being launched (object = the space which the navbeacon was launched in, param = the launching defensible, param2 = launched navbeacon)
Space which the navbeacon was launched in
The object which launched the navbeacon
Event for an object launching a satellite (object = the launching defensible, param = launched satellite)
Event for satellite being launched (object = the space which the satellite was launched in, param = the launching defensible, param2 = launched satellite)
Space which the satellite was launched in
The object which launched the satellite
Event for an object launching a resourceprobe (object = the launching defensible, param = launched resourceprobe)
Event for resourceprobe being launched (object = the space which the satellite was launched in, param = the launching defensible, param2 = launched resourceprobe)
Space which the resourceprobe was launched in
The object which launched the resourceprobe
Event for when inventory wares were added to entity (object = entity, param = table of wares with corresponding amounts)
Event for when inventory wares were removed from entity (object = entity, param = table of wares with corresponding amounts)
Event for when supply wares were added to container object (object = container, param = table of wares with corresponding amounts)
Event for when supply wares were removed from container object (object = container, param = table of wares with corresponding amounts)
Event for when supply orders(as wares) were added to container object (object = container, param = table of wares with corresponding amounts)
Event for when supply orders(as wares) were removed from container object (object = container, param = table of wares with corresponding amounts)
Event for when an object has started production of a ware (object = container or productionmodule, param = productionmodule, param2 = product ware, param3 = whether this is a research project) (see also event_object_production_finished)
Event for when an object has finished production of a ware (object = container or productionmodule, param = productionmodule, param2 = product ware, param3 = whether this was a research project) (see also event_object_production_started)
Event for when an object has had props generated (object = the populated component or its container, param = component which was populated)
Event for when an object has props about to be despawned (object = the populated component or its container, param = component which was populated)
Event for when an object has interiors about to be despawned (object = the populated controllable)
Event for when a player-owned object has discovered a previously undiscovered area (param = sector, param2 = center position of discovered hex in sector)
Event for when the universe generation process has been completed (all stations have been built) at game start.
Event for when a job ship has been activated in the galaxy, either spawned directly in space or when being finished at a shipyard (param = jobship)
Event for when a faction headquarters has been changed (param = faction, param2 = new faction headquarters station)
Value is in specified range (both value and range can use expressions)
Value to match (checked for non-zero if no comparison range is specified)
Game age value is in specified range (both value and range can use time expressions)
Time value range
Check an object against filters
Check whether the weapon is currently active
Check whether the weapon is installed/available
Count matching clusters and check if count is in specified range
Number of clusters
(Yields a list of clusters unless attribute multiple is used)
Count matching gates
Number of gates
(Yields a list of gates unless attribute multiple is used)
Count matching rooms
Number of rooms
(Yields a list of rooms unless attribute multiple is used)
Count matching dockingbays
Number of dockingbays
(Yields a list of dockingbays unless attribute multiple is used)
Count matching contacts found via a gravidar
Scanning object
Number of objects
(Yields a list of components unless attribute multiple is used)
Count matching components contained in an object
Parent object for component search
Number of components
(Yields a list of components unless attribute multiple is used)
Count matching objects
Number of objects
(Yields a list of objects unless attribute multiple is used)
Count matching sectors
Number of sectors
(Yields a list of sectors unless attribute multiple is used)
Count matching ships
Number of ships
(Yields a list of ships unless attribute multiple is used)
Count matching stations
Number of stations
(Yields a list of stations unless attribute multiple is used)
Count matching zones
Number of zones
(Yields a list of zones unless attribute multiple is used)
Output debug text
Text
Percentage chance of the debug text being displayed (used this instead of the condition chance, so that the condition does not fail)
Include the source of this debug_text (defaults to true)
Debug output filter (optional, default is scripts)
check that the object matches the criteria
check that an object in the group matches the criteria
check that all objects in the group match the criteria (empty group returns true)
Remove a variable
Set a variable value
Abort the current hack for this object
Abort the current player scan
Abort all running AI scripts on an entity.
Set alert level
Activate the ship's landing gears
Deactivate the ship's landing gears
Animate a chair to suit the using NPC
The NPC slot related to the chair
The NPC using or set to use the chair
Activation state for the chair (defaults to 'invalid')
Have the chair animate to its active position
Have the chair animation to its inactive position
Have the chair remain in its current activation state
(optional) delay the animation by the specified amount of time
Trigger an animation
The component to trigger the animation on
The tag list to find specific parts to trigger the animation on (if neither this nor a group is supplied, the animation is triggered on the entire component)
The group ID (which may be a string or a tag) used to find specific parts to trigger the animation on (if neither this nor tags are supplied, the animation is triggered on the entire component; has no effect if tags are also specified)
The animation trigger
(optional) delay the animation by the specified amount of time
Activate weapon group
Set to true if it's a primary, false if it's a secondary group
Add NPC actor to a room. This action fails if the actor could not be connected to that room.
Room to place the actor (Placed without position. Not to be combined with 'slot')
The slot to place the actor (Takes precidence over 'room')
Set the roomslot of the actor to the provided slot if it is a valid NPC slot (defaults to true)
Trigger the default animations for this room slot on the actor (defaults to true)
Activation state for the chair if the slot is a chair slot (defaults to 'activate_chair'. Using 'invalid' will keep the chair in it current activation state)
Have the chair animate to its active position
Have the chair animation to its inactive position
Have the chair remain in its current activation state
Whether the actor was successfully added
Add ammo to a defensible object (see also <remove_ammo> and <deplete_ammo>) NOTE: when used with unit macros storage limits are ignored! Use <add_units> instead!
Amount to be added (can be negative)
Removes ammo from a defensible object (see also <add_ammo> and <deplete_ammo>)
Amount to be removed (can be negative)
Depletes ammo of a defensible object (see also <add_ammo> and <remove_ammo>). If macro is not supplied then ammo will be removed from all weapons.
Evaluates the ammo storage of the given object. Returns lists containing amounts, wares and macros for the used ammo types. Indices of the lists are in sync. Also returns total ammo capacity from launchers (excludes base object ammo capacity)
List of max amounts for the ware/macro types (see other result lists, indices match)
List of macro names for the ammo types (see other result lists, indices match)
List of wares for the ammo types (see other result lists, indices match)
Total ammo capacity for this type provided by launchers (excludes ammo capacity of base object)
Evaluates the habitation storage needed to store workforce resources for the specified amount of workers and time. Returns cargo volume of required container storage.
The race that the workforce resources are for.
The time for which to calculate the resource needs. (defaults to the production time of the workunit ware, typically 1h)
The number of workers the resource needs are calculated for. (defaults to the product amount of the workunit ware, typically 300)
Whether the workunit_busy ware should be used to calculate necessary resources (workunit_idle applies when station production is dormant and uses considerably fewer resources) (defaults to true)
Whether secondary workforce resources(not required to maintain workforce, but increase efficiency if present) should be considered. (defaults to true)
Volume of container storage required.
Evaluates the default unit storage of the given object. Returns lists containing unit categories, mks, macros and amounts. Indices of the lists are in sync.
The percentage level to which this object should be fitted out with randomly generated units. Given as a float between 0 and 1. (special value: -1 means stick to whatever was last set with <set_loadout_level />
List of amounts for the unit types (see other result lists, indices match)
List of unit categories the unit types (see other result lists, indices match)
List of macro names for the unit types (see other result lists, indices match)
List of mks for the unit types to be used together with the respective category (see other result lists, indices match)
Evaluates the default deployable storage of the given object. Returns lists containing deployable categories, mks, macros and amounts. Indices of the lists are in sync.
The percentage level to which this object should be fitted out with randomly generated deployables. Given as a float between 0 and 1. (special value: -1 means stick to whatever was last set with <set_loadout_level />
List of amounts for the deployable types (see other result lists, indices match)
List of deployable categories the deployable types (see other result lists, indices match)
List of macro names for the deployable types (see other result lists, indices match)
List of mks for the deployable types to be used together with the respective category (see other result lists, indices match)
Evaluates the default missile storage of the given object. Returns lists containing missile macros and amounts. Indices of the lists are in sync.
The percentage level to which this object should be fitted out with randomly generated units. Given as a float between 0 and 1. (special value: -1 means stick to whatever was last set with <set_loadout_level />
List of amounts for the missile types (see other result lists, indices match)
List of macro names for the missile types (see other result lists, indices match)
Add cargo to an object
The amount successfully added
Remove cargo from an object
The amount successfully removed
Add price commission for target faction to object/faction(=target gets bonus pay for sales), if object and faction are specified, object takes precedence!
Name of commission, only required if target is faction.player
How long this commission lasts. Will last forever if ommitted!
Add price commission for player faction to object/faction(=target gets bonus pay for sales), if object and faction are specified, object takes precedence!
Identifier string for the discount
Name of commission, only required if target is faction.player
How long this commission lasts. Will last forever if ommitted!
Remove price commission for target faction from object/faction, if object and faction are specified, object takes precedence!
Remove price commission for player faction from object/faction, if object and faction are specified, object takes precedence!
Identifier string for the discount
Add default wares to a ship or station based on its productions and buildmodules
Minimum percentage of storage filled
Maximum percentage of storage filled
Chance per ware that an extreme (0 or max) value will be added (ignoring the lower/upper limits) (optional)
Add skill value to either 'entity' or a npctemplate on 'object'
Add supplies to an object
Remove supplies from an object
Add supply orders to an object
Remove supply order from an object
Add trade ware (use only on trading stations)
Allow buying this tradeware (optional, defaults to true)
Allow selling this tradeware (optional, defaults to false)
Lock price to average price of ware, otherwise price is calculated based on storage amounts (optional, defaults to false)
Remove trade ware (-> trading stations)
Generate reports of wares which are either in short supply, insufficient or overflowing
Reports related to build modules
Reports related to habitation modules and workforce
Reports related to production modules
Enable debug logging of the reports (debug, optional, defaults to false)
insufficient ware report table (ware is the key and the value is the amount of time this ware has been insufficient)
shortage ware report table (ware is the key and the value is the amount of time this ware has been in short supply)
overflow ware report table (ware is the key and the value is the amount of time this product has been at max capacity)
Add research for the player
Add price discount for target faction to object/faction(=target gets stuff cheaper), if object and faction are specified, object takes precedence!
Name of discount, only required if target is faction.player
How long this discount lasts. Will last forever if ommitted!
Add price discount for player faction to object/faction(=target gets stuff cheaper), if object and faction are specified, object takes precedence!
Identifier string for the discount
Name of discount, only required if target is faction.player
How long this discount lasts. Will last forever if 0 or ommitted!
Remove price discount for target faction from object/faction, if object and faction are specified, object takes precedence!
Remove price discount for player faction from object/faction, if object and faction are specified, object takes precedence!
Identifier string for the discount
Add watchdogs units of a station to its zone's masstraffic
Query the earliest time at which this unlock may be triggered again.
Set the earliest time at which this unlock may be triggered again.
Add a camera view request without NPC voice to the conversation (if not supplied then this is just a dummy action to trigger the conversation manager)
Add global faction relation
Relation boost value
The reason for relationship change
Get factions by matching relation (object or faction attribute required)
Object to reference (takes preference over 'faction')
Faction to reference ('object' takes preference if provided)
Set a faction's mood to a certain level
Reset a faction's mood to its default level
Set a faction to known/unknown to the player. Does not add encyclopedia entry for faction - see documentation for add_encyclopedia_entry.
Faction to set known/unknown
Set a faction's headquarters to the specified station. Will fail if the station's owner is not the correct faction.
Set a component to known/unknown to the player. Does not add encyclopedia entry for component (except for spaces) - see documentation for add_encyclopedia_entry.
Component to set known/unknown
Stations only. Update the snapshot of the station's current configuration for use in the map?
(De)Activates the loot magnet of the playership
Add inventory to an entity (entity defaults to player, amount defaults to 1)
Remove inventory from an entity (entity defaults to player, amount defaults to 1)
Add licence to a faction (defaults to player faction)
Licence to add (takes precident over 'licencefaction' and 'type' pair)
The licence issuing faction. Ignored if 'licence' is provided
Type of licence. Ignored if 'licence' is provided
Remove licence from a faction (defaults to player faction)
Licence to remove (takes precident over 'licencefaction' and 'type' pair)
The licence issuing faction. Ignored if 'licence' is provided
Type of licence. Ignored if 'licence' is provided
Add an NPC voice line to the conversation
Speaker (optional, an entity or a list of [controllable_context, npc_template], defaults to the conversation actor if not supplied)
Look in the direction of the specified component
Hide the player's conversation choices until after the NPC line has been spoken? Default is false (don't hide).
This has no effect if the choices were already visible before the start of this line.
Check for errors resolving an object name or description? Default is true
Add a player choice text to the conversation. When chosen, <event_conversation_next_section> will be triggered but the conversation stack will not be changed.
Name of next conversation section
Optional parameter that is passed to <event_conversation_next_section>. Can be of any data type.
Add a player choice text to the conversation. When chosen, <event_conversation_next_section> will be triggered,
and a sub-conversation will be started which can return to this section (see <add_player_choice_return>).
Name of next conversation section
Optional parameter that is passed to <event_conversation_next_section>. Can be of any data type.
Optional parameter that is evaluated immediately, but stored until the sub-conversation returns
and <event_conversation_returned_to_section> is triggered. Can be of any data type.
Add a player choice text to the conversation. When chosen, <event_conversation_started> will be triggered,
and a sub-conversation with a different actor will be started which will return to this section when it ends (unless the player aborts the conversation as a whole).
Name of next conversation section
Optional parameter that is passed to <event_conversation_started>. Can be of any data type.
Optional parameter that is evaluated immediately, but stored until the sub-conversation returns
and <event_conversation_returned_to_section> is triggered. Can be of any data type.
Add a player choice text to the conversation. When chosen, the current sub-conversation will return to the previous section that
started it (see <add_player_choice_sub> and <add_player_choice_subconv>), and <event_conversation_returned_to_section> will be triggered.
This action also defines the behaviour of the "Back" button.
Optional parameter that is passed to <event_conversation_returned_to_section>. Can be of any data type.
Set the section to which the conversation returns when the player selects an <add_player_choice_return> option without any sub-section active. The default return section is "g_finish".
This action can be performed only once per conversation and only if no sub-section is already active.
Name of conversation section to return to
Optional value that is passed as param2 to <event_conversation_returned_to_section>.
Add relation boost (otherobject or faction attribute required)
Relation boost value
The reason for relationship change
Add an object or a list/group of objects to a group (the group is created if it does not exist yet)
Object to add to the group (cannot be used with attributes list or group)
List of objects to add to the group (cannot be used with attributes object or group)
Group of objects to add to the group (cannot be used with attributes object or list)
Produce an error message if an inserted object or list element is not an existing object? (default is true)
Add tolerance boost (otherobject or faction attribute required)
Tolerance boost value
Aim turret at target
Turret
Add units to an object (either 'macro' is to be provided or both 'category' and 'mk')
The faction that made the units - defaults to the owner of the object if not provided
Add the unit as currently unavailable (default = false)
Remove units from an object (either 'macro' is to be provided or both 'category' and 'mk')
Remove the unit from currently unavailable units (default = false)
Request units from an object and make them unavailable (either 'macro' is to be provided or both 'category' and 'mk')
Return units from an object and make them available
Allows or disallows escaping from the current conversation section (e.g. with Esc). Only the current section is affected, default is allow.
Should Escape be possible in current conversation section?
Append an element at the end of a list.
Value to be appended to the list
Appends a construction plan to a station that already exists. The construction plan for the station can be empty.
The station to which the construction sequence should be attached. This station must already be connected to the gamegraph, otherwise use create_station action.
Evaluate needed storage modules based on production requirements
Macro or list of macros of production modules used to evaluate needed storage
Macro or list of macros of storage modules already present
List of storage module macros which can be selected
Result list of storage module macros
Apply damage from an attack to target, returns if target was killed
Result of attack including which component was hit.
True if the object or module has been destroyed.
The module that has been attacked (if one exists). Will match the passed-in module, provided it was a valid module of the object. NOTE: the returned module can already be destroyed!
The surface element that has been attacked (if one exists). Will match the passed-in surface element, provided it was a valid surface element of the object. NOTE: the returned surface element can already be destroyed!
Attack a specific module of the object (optional, defaults to a random operational module, if there are any, or the object as a whole otherwise.)
Attack a specific surface element of the object (optional, defaults to a random operational surface element of the module/object, if there are any.)
Evaluates the value, and if it does not match, shows a modal message box and prints an error message
Message text to be displayed on assertion failure
Determines on how many assertion failures the message box may pop up (default is 1).
Note that resetting or refreshing the MD resets the counter.
Assign NPC actor as the control entity for the specified control post of the specified object
Move the actor to the object's control room instantly. (defaults to false)
Start the suitable AI scripts on the actor. (defaults to true)
Move the NPC actor to its default location for its control post
Start suitable AI scripts on a control entity which has not been initialised yet
Remove NPC actor the control entity of its type of the specified object
Get all control entities of the specified object
Remove the pilot control entity of the specified object
Attach an object to the target using the 'limpet' connection (only supported on ships so far)
Whether the currect offset of object relative to target should be kept, uses target center otherwise (defaults: true)
Abort the most inner <do_while> or (counted) <do_all> loop.
Break formation as a formation leader. No effect if the object is not a formation leader
Cease fire
Turret in this mode should stop firing, defaults to any.
Change relation of the attacked object towards the attacker
This value will be set to true if there was an effect on the relation (or at least the relation boost decay), otherwise it is set to false.
The action can fail in several cases, e.g. if attacker and victim are of the same faction.
Change relation of the boarded object towards the boarder
Is this a boarding attempt or the end of a successful boarding operation?
This value will be set to true if there was an effect on the relation (or at least the relation boost decay), otherwise it is set to false.
The action can fail in several cases, e.g. if attacker and victim are of the same faction.
Change relation of the killed object towards the killer
This value will be set to true if there was an effect on the relation (or at least the relation boost decay), otherwise it is set to false.
The action can fail in several cases, e.g. if attacker and victim are of the same faction.
Check if object has line of sight to the target (uses ray casts)
Check if a ship is inside the designated area. Ignores mass traffic (as long as it's in the lane) and ships that have collision avoidance currently disabled (due to docking or parking).
Check if a build location is free. Takes highways and objects like stations and gates into account, but ignores ships or asteroids.
Adds a blocked area to a zone. Stationary ships inside the zone will be moved outside it, and current move_to targets inside it are invalidated. Ships that are ignored in check_is_area_obstructed are ignored here as well. Always be sure to remove any blocked areas as soon as they are no longer needed.
Used to associate this area with the user
Removes a blocked area from a zone.
Used to associate this area with the user
Notify the game that a target is being observed by this entity now (target: the observed object; range: the distance in which observation is actually happening)
The observer object
The observed object
The distance in which observation is actually happening
Notify the game that a target is no longer being observed by this entity
The observer object
The previously observed object
Notify the game that a target is being attacked by this entity now
The attacker object
The attacked object
Notify the game that a target is no longer being attacked by this entity
The attacker object
The previously attacked object
Report illegal activity
The object doing the illegal activity
The victim of the activity
Claim the target ship using pilot. ATTENTION: this moves 'this' to $target! All further this.* calls will correspond to $target!
Ship that will be claimed. Must be ownerless.
Pilot that will do the claiming. Will be moved from its current controllable to target.
Faction that will take owership of ship. Will default to ownership of pilot controllable if ommitted.
Clamp trade amount value based on buyer/seller storage situation (bundle/unbundle states are taken into account and the appropriate storages - cargo, ammo or units - are checked)
The trade to check
Initial amount to clamp based on buyer/seller storage limits (optional, defaults to 2147483647)
The buyer to look at for free storage limitations (optional, either buyer or seller must be specified)
The seller to look at for stored item limitations (optional, either buyer or seller must be specified)
Should the ware be bundled (convert ammo/unit -> ware) on transfer? (optional, defaults to the trade offer bundle flag)
Should the ware be unbundled (turn ware into ammo/units) on transfer? (optional, defaults to the trade offer unbundle flag)
Should the passed-in tradedeal amount be updated if the clamp results in a reduction of amount? (optional, defaults to false, DO NOT USE FOR TRADE OFFERS!)
Amount clamped so it both matches what seller has and what buyer can store.
Clear the list of objects for which collisions are disabled
Clear a group, i.e. remove all members from it
Clear a list (equivalent to resizing to 0 elements)
Clear a table, i.e. remove all keys and values from it
Get buildership position outside of the stations boundaries, requires using 'position', 'space' and 'macro' OR an already placed 'construction'
Assign a construction vessel to work for a build module of a build storage. Construction vessel is not yet deployed to aid in building.
Deploy a construction vessel to begin work for a build module of a build storage.
Disengage a construction vessel from a build module
Build Module or Construction Vessel
Connect a ship to a trade location (= reserve parking space)
If result is null then the operation failed.
Trade Location ComponentSlot (find using <find_tradeoffer_parking_slot>)
Disconnect a ship from a trade location (= free up parking space)
(optional) the Trade Location ComponentSlot to disconnect from. (if supplied, additional validation will be performed)
Add a build task to construct a ship
Container object that has a build module
Macro to build (overriden by the macro of buildobject if provided)
Existing object to be built as a new object
Specific faction to be used (optional)
Loadout ID (must be valid in 'macro' or the macro of 'buildobject')
Price of the constructed object
Add a build task to expand a station
Container object that has a build module
Existing object to be expanded
Construction plan ID string or constructionsequence value
Price of the expansion
Add a build task to upgrade or restock a ship
People definitions
People to be added to the object from NPC templates existing on the building object
People to be added to the object from matching people or workforce on the building object (or from nowhere otherwise)
Force the people to be added regardless of available matching NPCs on the providing object (defaults to false)
People to be added to the object from NPC templates existing on the building object
People to be added to the object from matching people or workforce on the building object (or from nowhere otherwise)
Force the people to be removed, regardless of available free space on the receiving object (defaults to true)
Container object that has a build module
Existing object to be upgraded or restocked
Loadout ID (must be valid in the macro of 'buildobject')
Table of ammo types (ware or macro) with assigned amounts
Table of unit types (ware or macro) with assigned amounts
Price of the upgrade
Get build people definitions in the form of a set of lists, either to be removed or added
Result list of amounts
Result list of roles used to identify people
Result list of roles to reassign people
Result list of races used to identify people
Result list of skills used to identify people
Result list of people (if 'removed' == true, then these people are currently on the built object, otherwise, the building object)
Get the people set to be removed (defaults to false)
Reassign people's roles
Reassign people's roles
Transfer people as defined in a build order, or by this definition
People to be added to the object from NPC templates existing on the building object
People to be added to the object from matching people or workforce on the building object (or from nowhere otherwise)
Build containing the people definition
Object recieving the people
Object providing the people
List of people successfully transferred from otherobject to object
Add a build task to an object
Remove a build task from an object
Begin processing a build task
Container object that has a build processor
Specific build module to be used (optional, ignored if build processor is supplied)
Specific build processor to be used (optional, overrides build module if supplied)
Reserve a build plot, creating the base station and build storage
Initial build plot dimensions, with the base station in the centre
Length of the plot on the X axis
Length of the plot on the Y axis
Length of the plot on the Z axis
Created build storage
Set the build plot of an object to be a given size.
Station or BuildStorage of which the plot will be extendedm
Should the build plot be allowed to be reduced from its current size? Defaults to false.
Is this plot size paid for (defaults to false)
Extend the length of a build plot (potentially shifing the BuildStorage's position)
Station or BuildStorage of which the plot will be extended
Extension of the plot length on the negative X axis
Extension of the plot length on the negative Y axis
Extension of the plot length on the negative Z axis
Extension of the plot length on the positive X axis
Extension of the plot length on the positive Y axis
Extension of the plot length on the positive Z axis
Should the build plot be allowed to reduce in size if necessary. Defaults to false.
Clear a build after a build is finished
Build module to be cleared
Build processor to be cleared
Commandeer an object to be used by faction logic
Release a commandeered object (job ships restart their orders)
Release a ship from its job
Find waiting job ship(s)
Find waiting subordinate(s)
Get the possible subordinate jobs and the number of missing desired ships
Is the commander initialising (defaults to false)? If false, subordinates flagged to not rebuild are ignored
Result list of job IDs (paired with amount)
Result list of desired ship amounts (paired with jobs)
Get the possible subordinate macro(s) of a job ship
Is the commander initialising (defaults to false)? If false, subordinates flagged to not rebuild are ignored
Organise a job ship's subordinate hierarchy based on job definitions
Get suitable job(s) by their category and basket data
Faction or list of factions
Specification tag or list of tags
Ship size
Ware to be matched to job basket
Find suitable jobs even if the Job Engine is deactivated?
Find multiple definitions? If true, the result values return a list. If false (default), the results returns a single value.
Result job id or list of job id's
Request a new job ship for a purpose
Object requesting the ship to be created (can also be a space)
Zone to become the ship's main job zone
Ware requested to be transported by the job ship.
Result ship (may not be connected to universe)
Remove the request for a job ship (ship is removed if it does not exist in the universe)
Set the time after which a job ship will be unregistered as a requested ship (will not happen at the exact time)
Find requested job ship(s). Allows specialised filtering by 'requester', 'ware', 'includeexisting' and 'includewaiting'.
The object which requested the ship (if null, the ships are not filtered by requester)
The ware associated with the ship request (if null, the ships are not filtered by ware)
Include ships which are in the universe (defaults to true)
Include ships which are waiting to be created in the universe (defaults to true. do not use with groups)
Order the commander's needed subordinates from the buildobject, placing them in its build order queue
Is the commander initialising (defaults to false)? If false, subordinates flagged to not rebuild are ignored
List containing the resulting build orders
Trigger the orders for this ship's job to start
Inform the job engine that a waiting ship is ready for use
Set the time at which a job ship is treated as expired
Skip the current iteration of the most inner <do_while> or (counted) <do_all> loop, and continue with the next iteration.
Create an AI unit from the provided object
Create an empty group
Name of the group to be created
Create a list of given element count (default is 0), filled with null values. Use [] syntax instead for lists with fixed size/content.
Number of elements
Create formation on a object. If that object has already a formation, it only changes the shape. Nested formations supported.
Object for which this formation should be created (can be any member of an existing formation or a new leader)
Formation shape
Parameter for formation shape, see formation shape documentation
Whether the entire formation shape should roll with the leader (optional, defaults to false)
Whether individual members should mimic the roll orientation of the leader (optional, defaults to true)
Maximum number of ships per line of formation shape (optional, defaults to 20).
If the amount of ships exceed this number, the formation will split creating lines up to this maximum amount.
Does not affect the following formation shapes: wshape, eagle, twin, triangle, dartvertical and darthorizontal.
Create a crate in a room
Room slot to place the crate
Create a Lockbox (wrapped inside its own object)
Zone to create the lockbox in. (takes precedence from sector)
Sector to create the lockbox in using position in the sector space. Creates a tempzone if a zone does not exist at the coordinates
Create a mission board object
Zone to create the mission board in. (takes precedence from sector)
Sector to create the mission board in using position in the sector space. Creates a tempzone if a zone does not exist at the coordinates
Create an Object
Zone to create the object in. (takes precedence from sector)
Sector to create the object in using position in the sector space. Creates a tempzone if a zone does not exist at the coordinates
Create a signal leak on an object or in space
Specify voice pageID and a text ID or a list of text IDs for this signal leak. A random one will be chosen if multiple are provided. Only valid and required for type signalleaktype.voice!
List of line IDs or single line ID in a text page
Object (or zone) to create the signal leak in. (takes precedence from sector)
Sector to create the signal leak in using position in the sector space. Creates a tempzone if a zone does not exist at the coordinates
Slot to connect the signal leak to (only works for 'info' or 'mission' slots on objects, ignored for zone signal leaks)
Specify voice pageID and a text ID or a list of text IDs for an existing signal leak. A random one will be chosen if multiple are provided. Only valid and required for type signalleaktype.voice!
List of line IDs or single
The signal leak to update
Creates an AI order and adds it to an object's order queue
AI order parameter
Parameter name
Parameter value
Order ID
Create as default order of the object? Instead of being added to the order queue, the order will replace the previous default order.
Creates an AI trade order and adds it to an object's order queue. A trade deal is created based on the given trade offer,
so the trade can be performed in the future even if the trade offer changes or disappears in the meantime.
The trade order ID is hard-coded. The trade deal is associated with the order (accessible via $order.trade) and is passed
to the order as the "trade" parameter.
Price per piece (defaults to the trade offer price)
Should the ware be bundled (convert ammo/unit -> ware) on transfer? (optional, defaults to the trade offer bundle flag)
Should the ware be unbundled (turn ware into ammo/units) on transfer? (optional, defaults to the trade offer unbundle flag)
Create an orientation(rotation) value. refobject takes priority over refposition if both are supplied
Position the orientation originates at (e.g. look_at means look from position towards refposition)
The maximum pitch angle to be returned, in positive degrees (default: 90, i.e. no restriction)
Create a construction sequence for a station randomly, connecting station modules with each other (but not applying the result to the station automatically).
Since it takes a lot of CPU time to calculate the result, the action is completed instantly and the result will be provided later via <event_object_construction_sequence_created>.
To retrieve the result immediately as part of the action, use the child element <immediate>, but be aware that it will block the rest of the game until the result is available.
Provide the construction sequence immediately. The action will block the game until the result is available.
Name of the variable that will receive the resulting construction sequence. In case of failure the result will be null.
The station for which the construction sequence should be created. Its plot bounding box will be used as a constraint,
and the station will receive the event <event_object_construction_sequence_created>.
List of macros of functional modules to be added to the construction sequence
List of macros of connector modules that are allowed in the construction sequence to connect functional modules.
The algorithm may use a connector macro multiple times; it is not necessary to have duplicates in the list.
Construction direction bias (omit or set to 0.0 to use default, or use range 0.1 to 10.0 where less than 1.0 prefers vertical connections, 1.0 is balanced, and greater than 1.0 prefers horizontal connections)
Optional existing construction sequence that should be extended
Time limit for the computationally intensive part of the generation algorithm (default is no limit). See also the failsafe attribute.
Prevent failure of the sequence generation (default is true), in case the generator fails to connect all modules. Normally a failure
only occurs by reaching the timeout (if timeout attribute is present) or if the input to the generator does not allow for enough flexibility
(e.g. if no connectors are supplied or the plot size is too small). To prevent failure, the remaining unconnected modules will be added in
free space without any connections. This additional step can only fail if the plot size is too limited to allow adding the missing modules.
Remove entries from the construction sequence that use the provided macros, also detaching all descendant entries in the connection tree.
It is possible that more entries get removed than requested in the macro list.
Element for defining variable names that will receive the results
Resulting construction sequence
List of existing components that are associated with input sequence entries but are removed in the result sequence (only returned if object is supplied)
Total removal cost
Object that the construction sequence belongs to (if supplied, it affects attribute 'costs' and result attribute 'removed')
Existing construction sequence from which entries should be removed
List of macros of functional modules to be removed from the construction sequence.
In order to remove multiple entries of the same macro, provide the macro multiple times.
List of macros of connector modules which may be removed in addition to the functional modules,
except for the ones that are still required to keep the remaining sequence connected.
It is not necessary to have duplicates in the list.
Optional table of existing station components, with numeric cost values assigned to them. The action seeks to minimise the total cost of removed functional modules.
For all sequence entries for which no cost is defined, a cost of 1.0 will be assumed for functional modules, and 0.0 for connectors.
If object is provided, a cost of 0.0 will be assumed for all functional modules that do not exist in the object (i.e. have not been built yet).
Generate a loadout for a given object
A construction sequence for which loadouts should be generated. Loadouts will be generated an entry at a time.
A macro (ship or station) for which a loadout should be generated. Loadout will be returned as a single entry. Ignored if a sequence is provided.
A module macro (station module) for which a loadout should be generated. Loadout will be returned as a single entry. Optional, ignored unless macro is provided.
Faction to use for selecting equipment.
Additional faction to use for selecting equipment, where licences for both selling and buying are required. Ignored if wares or macros are supplied.
A list of wares or table of ware amounts, from which the loadout should be generated. If neither wares nor macros are provided, default items for faction will be used.
A list of macros or table of macro amounts, from which the loadout should be generated. Ignored if wares are provided. If neither wares nor macros are provided, default items for faction will be used.
If a list of wares or macros is supplied, use repeated entries to indicate quantity, otherwise quantity is unlimited. Default is false (unlimited). Ignored if wares or macros are specified as a table, or if neither are specified.
The level of the loadout that should be generated. This should be a value between 0 and 1. If variation is non-zero, it will add variation to this number. Defaults to value defined in parameters.xml.
Allows an amount of variation on both the number of slots filled on a given entry in the sequence and what the slots can be filled with. Defaults to value defined in parameters.xml.
When generating a default loadout with no supplied ware or macro lists, select only items for which the supplied faction has blueprints. Has no effect for non-player factions. Defaults to false.
Loadout flags for elements to generate (add/remove flags not used in this case).
Invert the loadout flags provided in 'flags' attribute.
A list of loadouts that have been generated for the given construction sequence. The index of each loadout refers to the index of the construction plan entry in the sequence.
Optional variable to receive used items. Contents will follow the format of data supplied, i.e. wares if wares were supplied, macros if macros were supplied, and repeated if repeat parameter is true. Not populated if no ware/macro list is provided at all.
Optional variable to receive remaining items. Contents will follow the format of data supplied, i.e. wares if wares were supplied, macros if macros were supplied. If repeat is false then the remaining items will be the same as the originally-supplied list because quantities are unlimited. Not populated if no ware/macro list is provided at all.
Get a loadout via an ID
ID string of the loadout
Macro of which the loadout is defined for
Result loadout
Create a loadout using a fixed loadout definition
Result loadout
Apply the specified loadout to an object or construction sequence at the specified index.
The loadout that should be applied.
Object to apply the loadout to. Either a ship, or a station module.
A sequence to which the loadout should be applied. If sequence is given, index must also be given, as a loadout is applied to a specific entry in the sequence.
The index of the entry in the sequence to which the loadout that should be applied. Must be supplied if sequence is also supplied.
Loadout flags for elements to apply, and operations (add/remove) to perform.
Add one or more equipment mods to a ship
Ship to add the equipment mods to.
Add paint mod to a ship
Ship to add the paint mod to.
Paint mod ware (from paintmods.xml, defines a quality level and visual properties of a paint mod)
Set the specified loadout level for an object. Allowed range: 0.0 to 1.0. This loadout level will be used as the default for subsequent functions working with it (e.g. <evaluate_unit_storage />)
Object loadout level applies to. Either a ship or station.
Create a random position value within the bounding box of a component (the resulting value is relative to the component)
Create a random position value outside the bounding box of a component (the resulting value is relative to the component)
The minimum distance the generated point will have from the edge of the component's bounding box in each axis.
The maximum distance the generated point will have from the edge of the component's bounding box in each axis.
Create a trade offer and if provided, add it to an object
Setting the seller object makes this a Sell type offer. Also setting buyer negates this.
Setting the buyer object makes this a Buy type offer. Also setting seller negates this.
Object for the offer to be localiased on
The price of a single item
The real amount we desire if available funds would not matter (optional, defaults to amount)
Is the ware amount fixed? Ignored if minamount is set
Should the ware be unbundled (turn ware into ammo/units) on transfer? (optional, defaults to false)
Should the ware be bundled (convert ammo/unit -> ware) on transfer? (optional, defaults to false)
Should this tradeoffer only be available to the player faction? (defaults to true, will allow *all* factions to trade if set to false)
Is the trade for a mission (defaults to false)
Remove a trade offer from an object
Create a position value just outside the bounding box of a component, in the direction of the given position (the resulting value is relative to the component).
If the given position is inside the bounding box, it will be used as the result.
The distance the generated point will have from the edge of the component's bounding box.
Check if a position is inside an object's bounding box
Create a position value directly on the surface of an object, in the direction of the given position (the resulting value is relative to the space, or the object if no space was supplied).
The rotation value will be set from the surface normal.
If no position is supplied, it will be randomized in a sphere around the object.
If the position return value is null, no raycast was performed. This can happen if the collision mesh was not loaded yet. To handle this case, wait a second or so and retry.
Optional rotation that will be applied to the result in addition to the rotation based on the surface normal.
Sub component of object to aim the raycast at (otherwise object center) (optional)
If specified, the result will be moved by this distance along the surface normal. Can also be negative.
Create a position value
Create a position value
Reference position
Rotation at the reference position
Create a rotation value
Create a ship
Either a Dockslot, DockingBay component or Container component to spawn in (takes precedence from zone or sector)
Is the ship for a mission (defaults to false)
Is the ship commandeerable by faction logic (defaults to false)
Zone to spawn in (used if dock is omitted or invalid, take precedence from sector)
Sector to create the ship in using position in the sector space. Creates a tempzone if a zone does not exist at the coordinates
Default script name
Create a station
Construction plan ID string or constructionsequence value
Zone to create the station in. (takes precedence from sector)
Sector to create the station in using position in the sector space. Creates a tempzone if a zone does not exist at the coordinates
State of the new station. Defaults to construction
Create a factory
Zone to create the station in. (takes precedence from sector)
Sector to create the station in using position in the sector space. Creates a tempzone if a zone does not exist at the coordinates
Race of the factory, used to get a valid set (overridden by 'set')
Module set ID used to construct this factory
Create and add a module to an object
Object to add the module to
Create and add a dynamic interior to an object
Object to add the interior to
Optional module within the object where the interior should be added
Corridor macro
Door macro slot or connection name withing corridor (random door is selected if not supplied)
Room macro
Name to be applied to new interior
Remove a dynamic interior from an object
Object to remove the interior from (any one of interior, corridor or room component can be supplied)
Interior to remove
Corridor to remove (ignored if interior provided)
Room to remove (ignored if interior or corridor provided)
Set the rooms of a dynamic interior to private so contained NPC slots and waypoints can only be found by querying the rooms specifically, not via their contexts
Object containing the interior (any one of interior, corridor or room component can be supplied)
Interior to set privacy for
Corridor used to find interior to set privacy for (ignored if interior provided)
Room used to find interior to set privacy for (ignored if interior or corridor provided)
Are the dynamic interior rooms private? (default is true)
Create a control entity for the specified object
Create a NPC from a NPC template on an object
Object containing the NPC template. If 'slot' not provided, NPC will attempt to be placed on 'object'
Room slot
Is the npc required to be successfully created and placed in a room? (defaults to false)
Create a NPC template and place it on an object
Other object to contain an existing template if 'template' is prodived. If 'otherobject' is not provided, default to 'object'
NPC to use as a base when creating the template - Must be provided if 'template' or 'macro' is not
Existing NPC template to base when creating the template (taken from either 'object' or 'otherobject' if provided) - Must be provided if 'entity' or 'macro' is not
Macro of the new NPC template - Must be provided if 'entity' or 'template' is not
Entity role this template will be set to
Remove a NPC template from an object
Send an event to a running cutscene
Event string that is sent to the cutscene
Output debug text
Text
Include the context of this debug_text (defaults to true)
Debug output filter (optional, default is scripts)
Output debug text to logfile in game\logs folder under My Documents\Egosoft. Text will only be logged to a file if the game has been started with parameter -scriptlogfiles !
Text
Filename (required, allowed extensions: .txt, .csv, .log and .xml - otherwise .txt is appended automatically.)
Sub-Directory of logs folder (optional, defaults to blank)
Controls whether the text should be appended to an existing logfile of the same name or overwrite and create a new file (optional, defaults to true)
Controls whether the text should also be written to the regular 'scripts' debug output (optional, defaults to false)
Deplete yield for a certain ware in a zone of a specific region. If container is provided, attempt to add the wares to it (which may affect the deleted amount)
If provided, the wares will attempt to be added to the container object. The wares successfully transferred will then be depleted from the region
Amount to be drained from the region, this value will contain the actual amount that was drained after the command has been executed
Get the highest local resource yield in a sector
The ware for which to get the highest yield
The name of the yield definition (see libraries/regionyields.xml for valid values)
Where to look for the resource in.
The highest yield value (total amount in a box with 32km long edges)
Determine rate at which the refobject can drain resources from the supplied region in the specified zone (averaged using available colletector drones)
Rate at which the specified resource can be drained from the region by the refobject (float)
Add an anomaly as a set destination of another. The destination will be picked at random on transition.
Destroy specified object
Show explosion effect? Default is false
Destroy specified group
Show explosion effect? Default is false
Restore specified object from the wreck state
The hull value to set after restoring the object
Recursivly repair contained components (default = false)
Disable collisions between the object and the target
Does all collision checks but disables all reaction to the checks = no collision. Only works for objects in visible attention.
Dock ship instantly at the pre-selected docking bay (<request_docking> must have been performed successfully before!)
Drop ware from cargo bay (if possible)
Drop all illegal cargo from cargo bay
Faction to check ware legality against (optional, if ommitted only wares that are globally illegal will be dropped)
Drop all illegal wares from entity inventory
Faction to check ware legality against (optional, if ommitted only wares that are globally illegal will be dropped)
Drop ware from inventory (if possible)
Eject all NPCs from the object (they will use escape pods. Cannot be used for ship_xs!)
Eject all people (passengers) from the object (they will use escape pods. Cannot be used for ship_xs!)
Maximum number of people to eject (eject all if not supplied)
Disable collisions between the object and the target
Find asteroid in cluster near specified position
Cluster
Reference object or space (defaults to cluster if not supplied)
Whether this should return a rock that can be collected or an asteroid that needs to be broken up first
If true the command will return a list of asteroids and will automatically do a view check, see viewangle and maxdistance attributes!
If multiple is true this controls the forward angle to see if asteroids are in range (defaults to 30°)
If multiple is true this controls the maximum distance at which asteroids can be found (defaults to 3000m)
Only include asteroids that contain the specified ware as resource (ignored by default)
Find matching buy offer(s)
object that will do the trading (usually a trade ship)
(optional) only find buy offers on this buyer
(optional) filter for wares that the seller produces (and does not need itself)
(optional) zone or sector in which to look for offers, defaults to zone of tradepartner
(optional) exclude empty trade offers (amount = 0, desired amount > 0)? (defaults to true)
(optional) exclude mission trade offers? (defaults to true)
(optional) take reservations into account when checking if a trade is empty? (defaults to true)
Find closest object that has an octree
Reference object for distance check
Find closest resource
After evaluation this position will be treated as relative to refobject.
a single ware or list of wares that needs to be available as a resource in the region
(optional) minimum resource yield that the region/zone needs to provide
Reference object for distance check
(optional, resultvalue) list of all the resources that can be gathered in the found zone
(resultvalue) the zone where the requested resource can be found (mutually exclusive with sector)
(resultvalue) the sector where the requested resource can be found (mutually exclusive with zone)
(resultvalue) distance from the refposition to to the result position
(resultvalue) the position relative to the returned space (sector or zone) where the requested resource can be found
Find closest part of a station
Reference object for distance check
Find the closest position in a sector that the player hasn't uncovered yet. May return null if none exists.
The reference position in sector coordinates.
The center of the valid range in sector coordinates. Required if and only if range is valid.
The sector in which to look for undiscovered areas.
(optional) The range in which to look for undiscovered hexes. Also requires rangecenter to be valid.
The center of the nearest undiscovered hex in sector coordinates if there is one within range, null if there is none.
Find matching cluster(s)
Find matching cluster(s) within 'maxdistance' jumps of 'object'
If true then the found clusters are appended to 'name' list and 'distances' table. Should the values 'name' or 'distances' not be a list or table respectively, they will become one, losing their previous value (default false)
Minimum number of Jump Gates or Orbital Accelerators to 'object'
Maximum number of Jump Gates or Orbital Accelerators to 'object' (omit to have no jump distance limit)
Object or Cluster to check jump distances to
Table of clusters and distances. Key = cluster, value = jump distance
Search a macro for a connected macro or macros, optionally of a certain type.
The name of the variable where the result should be saved.
Add a class filter to the search so that only children of a certain class are returned. If not provided, all children will be returned.
Find matching room(s)
Find matching dock(s)
Find dockingbay for trade
Trader ship
Find gravidar contact(s)
Scanning object
Find signal leak locations at an object
Do not include slots currently filled by a signal leak (defaults to false)
Find npc slot in an object, walkable module or room
Container or room
Do not include slots currently reserved by a NPC (defaults to true)
Do not include slots which are blocked by obstacles such as props (defaults to true)
Find npc waypoint in an object, walkable module or room
Container or room
Do not include slots which are blocked by obstacles such as props (defaults to true)
Find a crate slot in a walkable module or room
Container or room
Do not include slots currently taken by a crate (defaults to true)
Find matching component(s) contained in an object
Parent object for component search
Find resource (random location in cluster)
a single ware or list of wares that needs to be available as a resource in the region
(optional) minimum resource yield that the region/zone needs to provide
Reference object for distance check or a cluster for all contained regions
(optional) snap result position to the size of a region grid (defaults to true)
(optional, resultvalue) list of all the resources that can be gathered in the found zone. If used with multiple="true", gives a list of lists of resources synchronized with the zone list from $zone.
(resultvalue) the zone where the requested resource can be found (mutually exclusive with sector)
(resultvalue) the sector where the requested resource can be found (mutually exclusive with zone)
(resultvalue) the position relative to the returned space (sector or zone) where the requested resource can be found
Check an object against filters
Ends all repair mass traffic networks for an object
The time the network should end (defaults to 'as soon as possible' if not supplied)
Find a repair mass traffic network for an object that doesn't have an end time set already
The ID of the mass traffic network - IMPORTANT: this will become invalid if a savegame is loaded
Find position in mass traffic network where the object would be at the specified time (only works for ships originating from mass traffic!)
Find random position in mass traffic network
Minimal time after beginning of path
Minimal time until end of path
Find matching object(s)
Find matching sector(s)
Find matching sell offer(s)
object that will do the trading (usually a trade ship)
(optional) filter for wares that the buyer can use(and does not produce itself)
(optional) only find sell offers on this seller
(optional) zone or sector in which to look for offers, defaults to zone of tradepartner
(optional) exclude empty trade offers (amount = 0, desired amount > 0)? (defaults to true)
(optional) exclude mission trade offers? (defaults to true)
(optional) take reservations into account when checking if a trade is empty? (defaults to true)
Find matching ship(s)
Find matching station(s)
Find matching gate(s)
Find tradeoffer location parking ComponentSlot
Object (container) that has the tradeoffer locations.
(optional) If supplied the list of slots will be sorted by distance to refobject.
(optional) If supplied the slot for this trade will be preferred.
Include slots that are marked as occupied (defaults to false)
Find matching zone(s) - includes highways by default
Fire turret
Turret
Get attack strength against target
Include damage of defence drones (defaults to true)
Get character macro or reference by filtering via category parameters
Faction or list of factions
Specification tag or list of tags
Race
Find multiple definitions? If true, the result values return a list. If false (default), the results returns a single value.
Result macro (list if 'multiple' is true. Less performant than 'reference')
Result character reference (list if 'multiple' is true)
Get docking approach pos
Docking bay component slot (find using <find_dockingbay>)
Get gate approach pos
Jumpgate
Get global path from start to end (multiple=0 returns first value. multiple=1 returns whole path as lists)
(Yields a list of components when attribute multiple is used, otherwise first value)
(Yields a list of positions when attribute multiple is used, otherwise first value)
Return the whole path or the first pair of Component and offset?
Whether the path should include local highway entrance/exit points or not (defaults to true)
Get jump path from start to end (multiple=0 returns first value. multiple=1 returns whole path as lists)
(Yields a list of components when attribute multiple is used, otherwise first value)
Return the whole path or the first component?
Get the internal highway offset which is closest to this position
Co-ordinate space for the position (can be a space or object)
Get a safe position in a zone or sector
Required if using zone coordinates (takes precedence over sector if both are specified), result will be in zone coordinates relative to this zone.
Required if using sector coordinates (ignored if zone is specified), result will be in sector coordinates relative to this sector.
Get the percentage of hexes in an area that are being covered by player-owned satellites
The center of the target area.
The radius of the target area
The sector the position is relative to
Get ship macro or reference by filtering via category parameters
Faction or list of factions
Specification tag or list of tags
Ship size or list of sizes
Find multiple definitions? If true, the result values return a list. If false (default), the results returns a single value.
Result macro (list if 'multiple' is true. Less performant than 'reference')
Result ship reference (list if 'multiple' is true)
Get module macro or reference by filtering via category parameters
Faction or list of factions
Race
Specification tag or list of tags
Production ware
The set from which the module should be taken. If used with reference (as opposed to macro), this attribute will have no effect.
Find multiple definitions? If true, the result values return a list. If false (default), the results returns a single value.
Result macro (list if 'multiple' is true. Less performant than 'reference')
Result module reference (list if 'multiple' is true)
Get station macro of a module set
Module set race
Module set type string
Module set ID (takes preference over 'race' or 'type')
Result macro
Get construction plan by filtering via category parameters
Faction or list of factions
Race
Specification tag or list of tags
Find multiple definitions? If true, the result values return a list. If false (default), the results returns a single value.
Result construction plan (list if 'multiple' is true)
Get room macro or reference by filtering via category parameters
Race
Specification tag or list of tags
Find multiple definitions? If true, the result values return a list. If false (default), the results returns a single value.
Result macro (list if 'multiple' is true. Less performant than 'reference')
Result doors (list of macroslots for a single macro, a list of lists of macroslots for multiple macros, nothing if only references are returned)
Result module reference (list if 'multiple' is true)
Get position list of matching target points from a macro
Either a single tag or a list of tags which are required for the target points
Get position list of matching waypoints from a component, starting from a start waypoint and progressing along the links until the end is reached
Either a single tag or a list of tags which are required for the waypoints
Either a single tag or a list of tags which are required for the start waypoint (matched in addition to the other required tags, if they are defined)
Get list of text IDs in given range on a TextDB page
Lower bound of text ID range (default is 0)
Upper bound of text ID range (default is no upper bound). Note that text IDs outside the signed integer range cannot be found.
Factor used as a filter for found text IDs. The list will contain only text IDs that are multiples of this factor. Default is no factor.
Get trade parking position (for L and XL trade ships that cannot dock directly), optionally gets the quadrant of the ship where the traffic lanes are.
Trade dock component slot (find using <find_tradeoffer_parking_slot>)
Return "approach" position (defaults to false). If false, this is the position at which masstraffic lanes snap to the tradeoffer location for optimal connection.
Space that the resulting position and rotation should be relative to (optional, defaults to the tradeoffercomponent)
Get a single or multiple definitions for wares from the WareDB.
The faction or factions for which the wares should be defined - this will filter the result down to what this faction can produce.
A filtered list of wares.
Get reserved space for ware (optionally object specific) on an object.
The container to query for reserved amounts of the specified ware.
Reservation type
Buy reservations only.
Sell reservations only.
Only count reservations for a specific object. If 'mission' is true, the object must be player owned and will return all player owned mission reservations (optional)
Whether the reservation is for a mission trade (optional, defaults to false)
Whether the reservation is for a supply trade (optional, defaults to false)
Whether to look at the "real" or the "virtual" dataset - virtual reservations are IGNORED for trades. (optional, defaults to false)
The amount that is reserved for this reserver (or all reservers).
Get a safe position for leaving a zone towards a destination (destination must be in same sector!)
Radius to indicate necessary space required for a safe position
Get the zone at this sector position (may return null if none exists)
Hint an object / zone ( precaching of assets )
Object to prehint
Zone to prehint
Hint an actor's animation sequence ( precaching of assets )
Animation sequence type
Animation sequence behavior
Check if target object is in all specified quadrants of object, returns false if target is not detected at all
Scanning object
The object to look for
Join formation. No effect if there is no formation in the object.
Object joining the formation
Formation leader
Launch countermeasures against enemy missile locks or incoming missiles
Whether a new batch of countermeasures has been queued for launch
Launch laser tower
Deployable category from which macro will be selected if not supplied
Launch mine
Deployable category from which macro will be selected if not supplied
Launch navigation beacon
Deployable category from which macro will be selected if not supplied
Launch resource probe
Deployable category from which macro will be selected if not supplied
Launch satellite
Deployable category from which macro will be selected if not supplied
Launch drone
Unit category from which macro will be selected if not supplied
Launch a ship of the specified ship group from masstraffic docks. Will attempt to avoid docks that are in use (e.g. while trading)
The drone that was launched (if any)
The object launching the drone.
Unit category from which the used macro will be selected
The target which is to be picked up by the drone (optional, used to determine ideal launch direction)
Ware to be transported, used to find best matching macro from shipgroup (optional, ignored if pickup=true)
Is this a pickup run? If true, an empty transport ship will be launched (optional, defaults to false)
Launch war drones. This uses mass traffic, so both objects need to be stationary for the whole duration.
Ensure that you kill the resulting mass traffic network when you're done with it, and wait until it's finished before moving away.
The newly created mass traffic network.
The object launching the drones.
The target which is to be attacked by drones. Must have a nav mesh.
The amount of drones to be launched. If undefined, all available units will be used.
Launch repair drones. This uses mass traffic, so both objects need to be stationary for the whole duration.
Ensure that you kill the resulting mass traffic network when you're done with it, and wait until it's finished before moving away.
The ID of the newly created mass traffic network - IMPORTANT: this will become invalid if a savegame is loaded
The object launching the drones.
The target which is to be repaired by repair drones. Must have a nav mesh.
List of components that need to be repaired
The amount of drones to be launched. If undefined, all available units will be used.
Leave formation as a formation WingMan. No effect if the object is not a formation WingMan
Open a menu as part of a conversation, which will be suspended until the menu is closed
Name of menu to be opened as part of the conversation
First menu parameter
Second menu parameter
Open a menu
Name of menu to be opened
First menu parameter
Second menu parameter
Pick up a target object (connect it to the ship)
Ship to which the picked up object will be connected
Prepare the pickup process, this makes sure the target stops rotating and is properly aligned for pickup (optional, defaults to false)
Sort a list of collectables by price value. Note: Sorting collectables with identical price values will retain their relative order from the input list. Consider shuffling the collectables list first.
Collecting object, used to filter out collectables which can't be stored
List of collectables
Result list of sorted collectables
Start playing a cutscene
Player interaction event
Parameter referenced by the cutscene, must have either object or number attribute
Parameter name
Reference object
Numeric value
Show cutscene in target monitor?
Sound ID name
Optional caption text string. Requires targetmonitor="true".
Maximal duration of target monitor cutscene. If supplied, the cutscene will end after the timeout. Requires targetmonitor="true".
Name of render target on which the cutscene should be played (ignored for target monitor cutscenes)
Name of the value that will receive the cutscene ID as result. This can be used as cutscene argument in <stop_cutscene>. If <play_cutscene> fails the result may be null in some cases.
Raise an event to a registered callback in a lua script.
Name of the event
Optional parameter. Has to be a string, number or component.
Removes an account from the object if any, so the object will use the faction's account instead. Optionally the remaining money can be transferred to the faction account.
Transfer remaining money to faction account? Defaults to false.
Remove NPC actor from the room it is in (e.g. landing platform)
Remove an object from a group
Remove the commander of an object
Remove faction representative
Remove a variable
Check whether a NPC can walk do a destination
Addional offset to the start position, either the 'start' slot/component or the NPCs position if 'start' was not provided
Addional offset to the end slot/component position
Object or component slot to start from. Combined with 'start' position. (optional, NPC uses current position if not provided)
Object or component slot destination. Combined with 'end' position.
Check if the NPC is currently able to move. NPCs can not move if in low attention or are hidden. (defaults to true)
Check whether the weapon is currently active
Check whether the weapon is installed/available
Request docking procedure for ship, result is true if the request was queued. Check this.ship.assigneddock to see if the request was granted.
Whether the ship should be using a high priority dock, defaults to false (will fall back to the other kind of dock if no matching ones exist)
Whether the ship must use a dock that supports building, defaults to false
Whether the ship must use a dock that supports trading, defaults to false
Whether the ship may also use a dock that only allows the player to dock, defaults to false
Whether the ship must use a dock that is only meant for venturing, defaults to false
Specific venture platform with which venture dock must be associated (can be null)
Request undocking procedure for ship, result is true if the request was queued. If the ship is docked, this is always either granted or queued.
Whether the ship should be using a high priority dock, defaults to false (will fall back to the other kind of dock if no matching ones exist)
Whether the ship may also use a dock that only allows the player to dock, defaults to false
Whether the ship must use a dock that is exclusively meant for venturing (only applies when ship is coming out of storage), defaults to false
Specific venture platform with which venture dock must be associated (can be null)
Request this ship to be taken out of internal ship storage, result is true if the request was queued. If the ship is docked, this is always either granted or queued.
Whether the ship should be using a high priority dock, defaults to false (will fall back to the other kind of dock if no matching ones exist)
Whether the ship may also use a dock that only allows the player to dock, defaults to false
Whether the ship must use a dock that is exclusively meant for venturing (only applies when ship is coming out of storage), defaults to false
Specific venture platform with which venture dock must be associated (can be null)
Remove assigned dock or docking request for ship (the latter only works if the container is specified)
Whether the request should be processed immediately (defaults to false). If not instant the assignment will be removed as soon as the ship is at a safe distance, which is defined in the dockingbay macro.
Remove undocking request for ship
Remove retrieval request for ship
Add a quota to a zone's main mass traffic network. Must supply either a macro or ship group. If no end time is supplied you need to store it and stop the quota when you no longer need it.
The ID of the created quota
The station where the mass traffic ships should start
The station where the mass traffic ships should end
The time the quota should start (defaults to now if not supplied)
The time the quota should end (defaults to never if not supplied)
Ship group for random macro selection
Make a mass traffic quota stop
The time the quota should end at the earliest (defaults to now if not supplied)
Get all macros currently active in a zone's main mass traffic network
The list of macros in the network
The amount of ships with each macro in the network
Get all units of a category currently active in a mass traffic network
The category of units to get
(A list with the index being the 'mk' of the unit)
Request a ship to be spawned in a zone's mass traffic network
The station where the mass traffic ship should start
The station where the mass traffic ship should end
Minimum flight time
Ship group for random macro selection (taken from zone's master quota if not supplied)
Request boarding support by the player (triggers an MD cue to select a mission)
Forced mission type, prevents random selection (see md/BoardingSupport.xml)
Request from a ship to lock the Gate for going through (Use 'unlock' true to unlock)
Ship requesting the Gate
Gate to lock (or unlock if 'unlock' = true) for the ship
Unlock the Gate for this ship. Safe to call if not requested befor (Optional, Default: false)
Whether or not the Gate request is successful
Notify the boarder that boarding support by the player failed
Notify the boarder that boarding support by the player was successful
Notify interested parties that universe generation is complete
Create a boarding operation and add it as an inbound operation on the target
Threshold value to launch boarding pods (0 - 100) - Actual behaviour of this value depends on the boarding handler
Threshold value to begin insertion into the hull (0 - 100) - Actual behaviour of this value depends on the boarding handler
Result operation
Add an attacker to the boarding operation and configure their behaviour and use of marines
Amount of marines by skill level to match against role tiers
List of amounts (size must match with other lists)
List of skills to help identify people (size must match with other lists)
Inform the boarding operation that an attacker has dispatched a number of marines to board the target (the creation of marines and activation of their AI behaviour is not handled by this action)
Amount of marines by skill level to match against role tiers
List of amounts (size must match with other lists)
List of skills to help identify people (size must match with other lists)
List of marine npc templates
Object which currently contains the marines
Transfer a list of marines from a boarding operation to an object
Object to transfer the marines to
List of NPC templates
List of people successfully transferred from otherobject to object
Transfer a marine from an object to the internals of a boarding operation
Object containing the marine to transfer
Set the status of a marine taking part in a boarding operation
Trigger the boarding operation to start, adding AI orders to related ships and firing the 'event_boarding_operation_started' event
Force the boarding operation to end, removing it from the target's list of inbound boarding operations
Set the phase of the boarding operation
Request a component to be repaired (only listened to from scripts)
The component to be repaired
Whether repairing another component should wait and this one should start immediately
Reset relation boost (otherobject or faction attribute required)
Reset tolerance boost (otherobject or faction attribute required)
Reset turret
Turret
Resize a list (if the list grows, it will contain new null values at the end)
New number of elements
Reward the player
Money reward
Save the state of the current AI script blocking action on the blackboard of an entity that is going to take over control when restarting a script (can be the same entity).
The AI script actions <wait_for_prev_script> and <finalize_prev_script> will process the information to make sure that the current AI action (e.g. trade) ends in a clean way.
Entity that will receive the AI action state information. To be used when a new script is supposed to start on the entity, aborting the previous entity's script.
The new script should perform <wait_for_prev_script> and <finalize_prev_script>.
Entity from which the AI action state information is retrieved, basically immediately before the entity's script is aborted.
Assigns an account to the object if the object does not have an own account yet.
Tells this object to use the account of otherobject. Optionally can transfer the money in the account to the object supplied as transferto (may be the same as otherobject).
If otherobject and transferto are invalid / omitted this behaves like <remove_object_account />
(optional) The object whose account to share, will default to faction account of transferto object if omitted!
(optional) The object to which any money in the actors account should be transferred. (money will be lost if omitted)
Assigns a max budget to an object
Amount max budget is set to
Assigns a min budget
Amount min budget is set to
Reserve the roomslot for this actor
Component slot to reserve as the ultimate destination
Clear the current roomslot of this actor
Set a chair slot as the current chair for this actor
Component slot to set as the chair slot
Clear the current chair of this actor
Lets the actor walk to the target (as long as the player can watch it)
Speed of the character in m/s
Component slot to walk to
Component slot to reserve as the ultimate destination (NPC's current roomslot cleared if invalid)
Start an actor's animation sequence
Animation sequence type
Animation sequence behavior (if omitted, uses roomslot tags to decide behaviour)
Perform a transition to the next sequence (defaults to false)
Perform an immediate transition to the next sequence (blending from the current one, default is false)
Set an actor's emotion morph target
Emotion name
Clear an actor's emotion morph target
Set an actor's lookat target component
Target component
Clear an actor's lookat target
Have an actor touch something with hand
Specification tag or list of tags
false to use right hand (default), true to use left hand
Have an actor untouch something
false to use right hand (default), true to use left hand
Attach a tool to an actor
Tool Name
false to use right hand (default), true to use left hand
Remove a currently held tool from the actor
false to use right hand (default), true to use left hand
Transfers amount from one entity to another, if possible
Amount to be transferred
Actually transferred amount
Set a buildanchor to the specified buildmodule
Build module to be used (ignored if build processor is supplied)
Build processor to be used (overrides build module if supplied)
Build anchor to be used
Sets the cockpit boarder tint for use in certain activities
Set the object to activated or deactivated
Activate object? (default is true)
Set the object to be capturable or not
Is the object capturable? (default is based on class)
Set docking at the object to be enabled or not
Are any ships allowed to dock at the object? (default is true)
Set the boarder of the object
The object to be boarded
The object performing the boarding operation
Remove the association between the object and its boarder
Set friend list of a mine that supports this (mine will treat everyone else as foe, regardless of faction relations)
The mine whose friend list should be set
Faction or list of factions to be set as friends
Set foe list of a mine that supports this (mine will treat everyone else as friend, regardless of faction relations)
The mine whose foe list should be set
Faction or list of factions to be set as foes
Clea friend/foe list of a mine that supports this (mine will revert to using faction relations)
The mine whose foe list should be cleared
Set the object to be visible in the map or in the UI or not
Is the object visible? (default is true)
Set the object to be sellable
Is the object sellable? (default is true)
Set the commander of an object
Object to be the commander
Assignment for this subordinate on the commander
Set the state of a running AI order to the specified state, if the state transition is supported.
Explicit state changes with this action are optional. See orderstate documentation in scriptproperties.html.
Order state
Enter critical state of order script. This requires the order to be in the active state.
Enter finish state of order script. This requires the order to be in the active or critical state.
Mark the sync point of a running AI order as reached. This action is a requirement for all infinite orders.
Once the sync point of such an order is reached, the sync point is ready to be released by a signal, which will terminate the
order (<event_object_order_syncpoint_released>). For player orders, the signal behaviour can be controlled in the UI.
On queued infinite orders that do not use the sync point signalling system, the sync point is released (the order ends) as soon as the next order is ready in the queue.
On default orders, this action only affects the UI display. There is no effect on finite orders.
Changes an order parameter, as if edited by the player in the UI. Note that this has side effects for already running orders and can fail in some cases.
If the order is in the started state (non-critical), it will be reset and start over. If in the critical state, any <editable> actions will be performed
and <event_order_param_edited> will be triggered. You can check with "$order.isparameditable.<param>" whether a param is currently editable.
Editing a param fails if:
(1) the order is in the critical state and the param has no <editable> node that allows editing, or
(2) the order is the default order or in a critical state and the param decides whether the order is infinite (i.e. it has an infinitevalue), or
(3) the order is in the finish state.
Parameter name as string
New parameter value
Set an object's minimum hull value (percentage)
Set an object's minimum shield value (percentage)
Set an object's hull value (percentage)
Set an object's name
New object name
Clear an object's name and revert to default
Set an object's description
New object description
Clear an object's description and revert to default
Set a controllable object's wing name
New wing name
Set relation change behaviour for an object when attacked or killed
Object
Disable relation change? (true = disabled; false = default behaviour)
Set an object's shield value (percentage)
Sets the scanned level of an object to the maximum level of the player's scanner
Sets an object as hacked
If this is a ship or station, all content in the given build stage is set as hacked. If this is a subcomponent, it and *all* content is set as hacked.
Duration of the hack
The object performing the hacking
Name of the value that will receive the list of hacked components
Name of the value that will receive the list of ejected drops
Hack an object via a control panel type
The hacking entity (optional)
Hacking score (0-5)
Set the room to be locked or not
Is the room locked? (default is true)
Set doors with optional matching group or tags in the room to be locked or not
Group tag
Specification tag or list of tags
Are the doors locked? (default is true)
Set platform triggers with optional matching group or tags in the room to require certain inventory wares for activation
Group tag
Specification tag or list of tags
The required inventory ware
The required inventory ware amount (default is 1)
Are the wares consumed on use? If true, there is also an event when the trigger was "unlocked" by the player. (default is false)
Whether the object (which can be any destructible subcomponent of an object!) can drop something
Whether this setting should be propagated to all child destructibles
Sets the drop for the object
Drop string identifier (drop is cleared if not supplied)
Attempt to spawn an existing ship in a dock (bypassing dock request checks)
Spawn the drop defined for the object
Drop string identifier (will drop whatever is currently defined in the object if not supplied)
Have a drop be instantly collected by an object
Have an asteroid be instantly collected by a ship
Sets/changes the page of an actor (entity)
Sets/changes the type of an actor (entity)
Sets/changes the role of an actor (entity)
Sets/changes the role of a npc template
Set global faction relation
Relation boost value
The reason for relationship change
Reset faction relation to base value in factions.xml
Set faction relations to be locked
Should the factions relations towards others not change
Set this mass traffic objects persistance in the game
Should object be persistent? (default is true)
Set this region objects persistance in the game
Should object be persistent? (default is true)
Set this mass traffic network's end time. Note that the time will be adjusted so that no ships are underway when the network is removed.
The end time (default is the current time)
Sets the owner faction of an object
(No owner is set if null or not supplied)
Set the owner faction of the control entities (defaults to false)
Sets the cover owner faction of an object (cover owner is cleared if faction is null or not supplied)
Set player activity (mode mission)
Set player position in room
Trigger a teleport to a object
Have the player take control if it is free (defaults to true)
Instant teleportation (defaults to false)
Allow the teleportation, even if the research criteria is not fulfilled (defaults to false)
Set relation boost (otherobject or faction attribute required)
Relation boost value
The reason for relationship change
Set faction representative
Entity to be assigned to the sector as faction representative
Set the objects current hack target
Set the player's current scan target
Set skill value to either 'entity' or a npctemplate on 'object'
Apply experience to either individual 'entity' or crew aboard 'object' (identified by npctemplate for an individual crew member or role for a group )
Experience (from libraries/experiences.xml)
Set the traits of an entity
Set the traits of a npc template
Set tolerance boost (otherobject or faction attribute required)
Tolerance boost value
Set allowed weapon systems (weapon system not listed will keep current state)
Specifically allow the use of certain weapon types (separated by space)
Specifically disallow the use of certain weapon types (separated by space)
Optional, set to true to make disallowed weapon systems stop firing immediately (defaults to false, weapons will shoot until they lose their current target)
Set trade restrictions for the object
Define an override for the trade restrictions per ware
Affected ware
Restriction for this ware
Object for which the restrictions will be set.
Global restriction to only trade with the own faction
Set turret targets
Priority target for each turret. If it can't attack, it will choose from the target list
If preferredtarget is not provided, clear the existing preferred target (defaults to true)
List of target objects for turrets
Stop shooting old targets which are not provided in the new target list (defaults to true)
Turrets in the specified mode will choose from these targets (defaults to any)
Set a variable value
Set the weapon mode of a weapon or group of weapons. When weaponmode is omitted, it is reset to default.
Weapon mode, or null to reset to default
Set up parameters for a conversation mini-game. It will be started when the player selects an option with a positive default confidence.
Number of repetitions of the mini-game with the same parameters (default is 1)
Mini-game difficulty level (1-5), which influences the choice of mini-game curve (default is 1)
Mini-game caption text (default is no text)
Number of passes over the curve, i.e. number of tries (default is 1)
Cursor speed in passes per second (default is 1.0)
Curve scale, not implemented, do not use (default is 1.0)
Show text from help text page if it was not shown before (when using line attribute), or show custom text (when using custom attribute)
Line (text ID) on help text page. Text will be shown if not shown before, or if force attribute value is true
Always show help text? If true, the help is shown even if the help text ID was already used before (ignored when using custom attribute)
Custom help text, takes precedence over line attribute
Suppress sound effect?
Remove display of a help text
Set to true to remove all help texts from display queue. Takes precedence over line attribute.
Specific line (text ID) to be removed from display queue (removing custom texts specifically is not supported). If attribute is not supplied, the currently displayed hint is removed.
Show help text for input function (e.g. INPUT_ACTION_QUICKSAVE or INPUT_STATE_ROLL_LEFT). Keyboard/controller use is detected automatically.
Input function name (see inputmap.xml)
Show a non-interactive notification in the message ticker
Maximal duration of notification. If not supplied, the notification will end after a default timeout (currently 5s).
The priority, an integer between 0 and 9 (default is 1).
Unqueued notifications can only be aborted and replaced by unqueued notifications of same or higher priority, or by cutscenes. The queue for queued notifications is also sorted by priority.
NOTE: Non-silent interactive events (notifications and cutscenes with flashing target monitor) are generally treated as having a higher priority than any non-interactive events.
Optional value to delay the display of this ticker message if a message with a higher priority can be displayed before.
The message will be displayed after all queued ticker messages with higher priorities have started being displayed and subsequently the specified delay has passed.
In case there is no message with a higher priority in the ticker and no such message is added in the same frame, the message will be displayed without delay.
Sound ID name (default is "notification_generic" if omitted)
Show an interactive notification in the target monitor
Player interaction event
Caption text string
Maximal duration of notification. If not supplied, the notification will end after a default timeout (currently 5s).
The priority, an integer between 0 and 9 (default is 1).
Unqueued notifications can only be aborted and replaced by unqueued notifications of same or higher priority, or by cutscenes. The queue for queued notifications is also sorted by priority.
NOTE: Non-silent interactive events (notifications and cutscenes with flashing target monitor) are generally treated as having a higher priority than any non-interactive events.
Sound ID name
The faction for which the notoriety ladder should be displayed (optional)
The object for which the notoriety ladder should be displayed (optional). Takes precedence if both faction and object are supplied.
true iff a relation effect (blinking effect in faction bar) should be shown
(optional) ID of resulting notification object
Shuffle elements of a list randomly
Signal an object and/or a group of objects using param and param2, each object will receive this signal as if it were an event
(optional) delay this signal by the specified amount of time
Play (speak) text
Speech priority. Speeches of lower priority will be interrupted. Default is 0.
Allow interrupting a speech of the same priority? Default is true.
Speech recipient, i.e. the character being spoken to (optional). Pass an NPC if this is a background speech between two NPCs, which affects the voice style of the speech. Default is the player (if omitted or null).
Is this a background speech and is the player able to hear this over comm? Note that a speech in background and a speech over comm are two separate properties,
and this flag only indicates a preference, which can be partially or fully ignored.
- If the player is the speaker or this is a broadcast, the speech is always in foreground.
- If a recipient is specified, the speech is in background depending on whether the recipient is an NPC or the player.
- If the speech is in background and the recipient is in hearing range of the speaker, the speech will be over comm only if backgroundcomm is enabled and the player is not within hearing range.
(Otherwise it is assumed that the player is required to be close to the speaker to hear the speech.)
Is this a broadcast speech of an entity to a group of people over comm? This implies background speech, but may cause a different comm filter to be applied. Default is false.
Check for errors resolving an object name or description? Default is true
Start engine booster
Start a conversation on this actor
Optional parameter that is passed to <event_conversation_started>. Can be of any data type.
Type that affects how the conversation is started
Default conversation type
Unqueued conversation (start conversation only if there is no conversation already running)
Take over a previous conversation. When using this type, the player does not automatically return to the default position when the previous conversation ends.
Priority of conversation for the case of multiple simultaneous requests (min=0, max=100, default=0)
Cancel an active conversation (if providing a conversation actor, the conversation is only cancelled if the actor matches)
Optional conversation name. If supplied then the conversation is only aborted if the conversation name matches.
Should conversation be aborted even if Escape was explicitly disabled via <allow_conversation_escape>?
Cancels all existing AI orders in the object's order queue
Cancels an AI order and removes it from the owner object's order queue
Starts a long range scan for the object
Stops a long range scan for the object
Start an AI script, aborting previously running scripts
AI script parameter
Parameter name
Parameter value
Script name
Stop engine booster
Stop a running cutscene
Key name of the cutscene to be aborted (ignored if cutscene attribute is supplied)
Cutscene identifier as returned by <play_cutscene> (takes precedence over key attribute)
Stop firing at a specific target
Turret in the specified mode will stop shooting at the target(s), defaults to any.
Search in a text for sub-strings and substitutes them
Definition of a sub-string in the text and a replacement string. All occurrences of the sub-string will be replaced.
Sub-string which is expected to occur in the text
New text which will replace the occurrences of the sub-string
Name of the value that will receive the result text. If source is not supplied then this value is also used as text source.
Source text. If not supplied, the text attribute is used instead.
Trigger an autosave
Trigger a boarding process via an MD cue, including mission guidance for the player
The marine commander that controls the boarding operation
The target object to be boarded
The boarder faction, which is trying to take ownership of the target (default is the player faction)
Undock ship
Sets the state of the ship's dockingbay to 'undocking'
Unlock an achievement (no effect if it was already unlocked)
Achievement name
Indicate achievement progress (no effect if it was already unlocked). This does not unlock the achievement when max progress is reached (100%), use <unlock_achievement> instead in this case.
Achievement name
Integer value of current progress
Integer value of maximal progress
Initiate a trade between an object and the player's primary ship.
Returns true if the trade was successfully initiated, otherwise false.
The trade to be initiated.
Optionally, override the amount of the ware to be traded (This could have changed since the deal was made).
Update certain parameters of a trade
The trade to update
New amount for the trade (optional, should already be adjusted to be the amount we can afford)
New desiredamount for the trade (optional, how much we *really* want, ignoring financial constraints)
New price (per unit) for the trade (optional)
Upgrade an object by using a macro and percentage ($object.hasmultimacroupgrades must be true)
Upgrade an object by using a tag and percentage ($object.hasmultimacroupgrades must be false)
Upgrade tag
Get price estimate for the buildslot (macro, sequence, stage), if wares are purchased by object
Build Sequence
Build Stage
Get the credit value of an object
Object of which to base resource prices
Calculate the sell price of the object? Default is false
Retrieve the dockslot that a pilot entity is currently using for docking.
NOTE: This action is not supposed to be used normally, it only exists for fixing a bug that appears in early game versions.
Pilot
Warp object to different location
Zone to warp to (take precedence from sector)
Sector to warp the object in using position in the sector space. Creates a tempzone if a zone does not exist at the coordinates
Sort trade list. Note: Sorting trades with identical sort values will retain their relative order from the input list. Consider shuffling the trade list first.
List of trades to sort
Reference object to sort trades by distances or offeramounts (required for sorter="distance", optional for sorter="offeramount")
Sort people list. Note: Sorting people with identical sort values will retain their relative order from the input list. Consider shuffling the templatelist first.
List of NPC templates to sort
Skill to sort by (required for sorter="skill", ignored otherwise)
Post to sort for potential skill by (required for sorter="potentialskillforpost", ignored otherwise)
Role to sort for potential skill by (required for sorter="potentialskillforrole", ignored otherwise)
Add experience progress points
Set experience progress points
Add an effect object. If the effect's duration is infinite (value of -1), you need to remove it yourself with remove_effect.
Object to attach the effect to
Effect definition (from libraries/effects.xml)
Remove an existing effect object.
Object the effect is attached to
Effect definition (from libraries/effects.xml)
Play a sound. Does not support looping sounds yet.
Object to act as the sound source.
Sound ID (from libraries/sound_library.xml)
Play music
Sound ID of music track (from libraries/sound_library.xml)
True to prevent automatic scene music change, false (default) to allow automatic change and to disable any existing lock
True to prevent automatic fight music change, false (default) to allow automatic change and to disable any existing lock
Stop music
True to prevent automatic re-enabling of scene music, false (default) to allow re-enabling and to disable any existing lock
True to prevent automatic re-enabling of fight music, false (default) to allow re-enabling and to disable any existing lock
Write an entry into the logbook
Logbook entry text, either a single string with possible line breaks, or a list of strings in notification format (see <show_notification>).
When using the notification format and both left and right columns of a row contain text, the texts will be concatenated with a single space as separator.
Separator to be used between left and right texts of a notification row, in case the notification format is used in the text attribute (default is a single space)
Interaction object, depending on the interaction type
Logbook entry title
Optional source entity for logbook entry (either a real entity, in which case the entity name will be used, or an arbitrary name as text)
Optional source faction logbook entry (either a real faction, in which case the faction name will be used, or an arbitrary name as text)
Optional amount of money associated with the logbook entry (if not supplied, or 0, then will not be shown in the logbook)
Optional bonus amount of money associated with the logbook entry (if not supplied, or 0, then will not be shown in the logbook)
Add permanent player subscription to trade offer updates of the specified object. This also immediately adds the current trade offers to the trade memory.
How long this subscription is valid for. Unlimited duration if ommitted. (optional)
Remove permanent player subscription to trade offer updates of the specified object. Offers remain known as long as live view coverage exists.
Forget that there ever was information about trade offers at the specified object (defaults to false)
Store a snapshot of the current trade offers on the specified object in the player trade memory.
Add an entry of an item id into the library of type
Add blueprints to player's blueprint library
Ware or list of wares for which to add blueprints (can be combined with macros and object in a single call)
Macro or list of macros for which to add blueprints (can be combined with wares and object in a single call)
Object (station or ship) for which to add blueprints (can be combined with wares and macros in a single call)
Production method for blueprint(s) (will be the same for all added blueprints, uses default method if not supplied)
Cycle efficiency for blueprint(s) (will be the same for all added blueprints, uses 1.0 if not supplied)
Resource efficiency for blueprint(s) (will be the same for all added blueprints, uses 1.0 if not supplied)
Product efficiency for blueprint(s) (will be the same for all added blueprints, uses 1.0 if not supplied)
Include blueprints for modules (used only with object attribute, default is true)
Include blueprints for equipment in specific loadout elements (used only with object attribute, default is all loadout elements)
Start playership autopilot to the selected destination (follow for moving targets)
Stop playership autopilot
Toggle time warp (SETA). NOTE: Activation requires that SETA is in the player's inventory and the activation conditions are met. For example, SETA is not possible during a conversation.
Patch an object based on its macro, to add components that may be missing when loading a savegame. This action is only required by extensions and should normally only be used when loading a savegame
in which the extension was not active yet. The script is responsible for finding the objects, usually ships or stations, that need patching.
Finds objects with given filter criteria and patches them based on their macro (see <patch_macro>)
Space in which to find objects to be patched. The galaxy is used if no space is supplied.
Installs the given software on object. If the software is not compatible with object this will fail silently!
Uninstalls the given software (and all previous versions) from object. If the software to be uninstalled (or any of its previous versions) are part of the default software, these will remain installed!
Uninstalls all newer versions of software from object. If any of the software versions about to be removed are part of the default software, they will remain installed!
Set the throttle value of the playership.
Value for throttle setting between full reverse (-1) and full forward (1)
Add inventory to a given entity using the entity's stock ID, as defined in the character definition.
The entity that should receive some stock.
Set the stock entry the given entity should use
The entity that gets the stock reference.
The stock reference.
Add clothing mod to an NPC or the player
The NPC or player that should receive clothing mod.
Clothing mod ware (from clothingmods.xml, defines a quality level and visual properties of a clothing mod)
Add workforce of the specified race to a given object. (will not add more than can fit, see $container.workforce.{$race}.capacity)
Remove workforce of the specified race from a given object.
Define equipment wares from the default equipment for the object owners' faction that should not be available for construction (only applies to objects with build modules such as shipyards or equipment docks).
Define equipment wares outside the default equipment for the object owners' faction that should be available for construction regardless (only applies to objects with build modules such as shipyards or equipment docks).
Define ship wares from the default ships for the object owners' faction that should not be available for construction (only applies to objects with build modules such as shipyards or equipment docks).
Define ship wares outside the default ships for the object owners' faction that should be available for construction regardless (only applies to objects with build modules such as shipyards or equipment docks).
Report that the object had an encounter which should be tracked and submitted to the server as potentially relevant for transmission to original owner. Will fail silently if the object does not originate from another universe.
Creates a trade computer entity on the specified object that will attempt to perform the first trade order in the current order queue, provided the tradepartner is the container the object is currently docked at.
After completion of the order the trade computer will remove itself. (see orders.base.tradecomputer)
The trade computer entity, if one was created.
Estimate the time it takes to fly to a target location (takes highways and travel mode into account)
Start position relative to the start component.
Target position relative to the target component.
The ship from which to get the engine parameters. Other parameters can be defined to override individual values. If not provided, all engine parameters must be defined.
Whether local highways are to be included in time estimations.
The maximum forward speed without using boost or travel mode.
The travel drive's thrust factor. Multiplies the forward speed.
The time it takes to charge travel mode.
The time it takes to reach maximum travel speed after charging has finished.
The estimated travel time.
Ware amount
Collectable wares
Selection element (used if selection attribute present)
Chance percentage of spawning any money (default is 100)
Collectable ammo
Selection element (used if selection attribute present)
Collectable fuel
Collectable shieldrestore
Drop definition
Chance percentage of spawning any drops (default is 100)
Minimal amount (default is 1)
Maximal amount
Macro name (required in all cases except for collectable wares - if no macro is supplied in this case, the container macro from WareDB is used)
DropDB document node
List of drop definitions
ID
Name
Description
Active icon id for faction
Inactive icon id for faction
Response id
Response name
Response description
Signal response
Signal id
Signal name
Signal description
Default response
Default ask setting
Signal id
Response id
Ask setting (not normally required, as default in signal definition should be set to player default)
Response setting (only required in this file if behaviour for this faction is not the same as the default)
Named relation range
Relation value
Faction id for relation
Relation value for relation
Relation for one faction to another
Are relations locked? (don't change permanently)
Money
Red
Green
Blue
Type of licence
Licence name (Do not use with 'faction' attribute)
Licence description
Icon for licence
Factions that have granted a license of the specified type (only use with type attribute)
Minimum relation the player must have with this faction to obtain this licence (Only use with 'type' attribute)
Type of licence required as a precursor to this one
Price of the licence
Defines up to which scan level becomes legal if licence is held
Hide licence from user interface (default false)
Licence definition
Color for a faction
Account for a faction
Icons for a faction
Licences for a faction
Relations for a faction
Signal response settings for a faction
Faction id
Faction name
Faction description
Short faction name (i.e. abbreviation)
Name of a flight behaviour set which is used by members of this race. Must correspond to an entry in behaviours.xml
Construction direction bias (omit or set to 0.0 to default from primary race, or use range 0.1 to 10.0 where less than 1.0 prefers vertical connections, 1.0 is balanced, and greater than 1.0 prefers horizontal connections)
Race id
Folice faction for this faction (optional). Police faction must have the police tag. Default is the faction itself if it has the police tag, otherwise no police faction at all.
Tags
Is the faction known to the player (on game start)
Whether the faction should show up in info library/encyclopedia
Definition of a single faction
Faction DB
Item name
Item description
Definition of one name/description text pair
Description of requirement to make this gamestart available
Achievement name
Achievement required to unlock gamestart
Start position of player
Start rotation of player
Macro name of room
Whether player is disembarked from player ship
Interior type
Interior name
Macro name of interior corridor
Connection name within corridor to which room should be attached
Macro name of interior room
Macro name of module within object in which to create interior
Macro path of module within object in which to create interior
Start position of player ship
Start rotation of player ship
Location of player if separate from ship
Dynamically created interior for player to start in
Macro name of galaxy to use for map
Macro name of start zone within galaxy
Macro path of station within galaxy
Macro name of station
Station is trade station (only used with station macro, no check made if not supplied)
Station is shipyard (only used with station macro, no check made if not supplied)
Station is equipment dock (only used with station macro, no check made if not supplied)
Station is defence station (only used with station macro, no check made if not supplied)
Station is pirate base (only used with station macro, no check made if not supplied)
Station is headquarters (only used with station macro, no check made if not supplied)
Macro path of ship within galaxy
Macro name of ship
Macro path of room within galaxy
Macro name of room
Faction name
Whether player ship should be docked
Player ship loadout
Loadout is debug-only
Paint mod
Player ship sloadout
Player ship mods
Player ship macro
Player ship name (if different to that in the player ship macro)
Inventory ware name
Amount of inventory ware
Inventory item
Blueprint ware name
Ware production method
Cycle efficiency
Product efficiency
Resource efficiency
Blueprint
Include blueprints for player-owned stations (defaults to true)
Blueprint ware name
Cycle efficiency
Product efficiency
Resource efficiency
Research item
Timeline entry ID
Timeline entry
Paint theme
Clothing theme
Clothing mod
Player ship
Inventory
Blueprints
Research
Timeline
Theme
Player mods
Player macro
Player name (if different to that in the player macro)
Player starting money
Descriptive text for new game menu
Unlock requirements for gamestart
Map and start location
Player information
Gamestart id
Gamestart name
Gamestart description
Gamestart image
Gamestart cutscene name
Gamestart cutscene voice sequence name
Gamestart intro animation
Gamestart intro animation voice sequence name
Gamestart group number
Gamestart is debug-only
Definition of a single gamestart
Gamestarts
Root element of ships.xml
Ship definition
Ship category used for finding a suitable ship in the ShipDB
ID
Name
Description
Root element of characters.xml
Character (NPC) definition
Character category used for finding a suitable character in the CharacterDB
ID
Name
Description
Root element of modules.xml
Module definition
Module category used for finding a suitable module in the ModuleDB
ID
Root element of rooms.xml
Room definition
Room category used for finding a suitable room in the RoomDB
ID
Root element of props.xml
Prop definition
Prop category used for finding a suitable room in the PropDB
ID
Root element of modulessets.xml
Allow the player to use this module set (defaults to false)
Are construction vessels required for builds related to this set? (defaults to true)
Station macro used as the base for this set
Default race of this set
Root element of stations.xml
Station definition
Station category used for finding a suitable station in the StationDB
ID
Orders
Set as default order of the ship?
Task
Position in zone
Distance from the position
Exact distance from the position
Minimum distance from the position (same as exact if 'max' is omitted)
Maximum distance from the position (min treated as 0 if omitted)
Position the object with a safe position (defaults to true)
Yaw rotation in degrees (ignored for ships, random if not specified for stations and other objects)
Pitch rotation in degrees (ignored for ships, random if not specified for stations and other objects)
Roll rotation in degrees (ignored for ships, random if not specified for stations and other objects)
Root element of jobs.xml
Job definition
Default ware basket to select wares from. This basket definition is used when neither basket nor list are defined in a wares element of the ship definition.
Job category used for finding a suitable job entries in the JobDB
Faction
Specification tag or list of tags
Ship size
Specify orders for the created ship. If this is specified any single <order /> node in the job root is ignored.
Specify tasks for multiple entities on the created ship. If this is specified any single <task /> node in the job root is ignored.
Location
Economy range
Security range
Faction or list of factions
Relation range
Race or list of races, matched against factions' primary races (relation ranges are not taken into account)
Commander
Player encounters
Environment
Modifiers
Job timing
Minimum job processing interval with +/- 25% random variation
First job processing time (interval without variation is used if not specified)
Job expiration time (affects script property .jobexpired). Some time after destruction, the object will be re-created by job engine.
Minimum expiration time in seconds
Maximum expiration time in seconds
Non-mass-traffic ship definition
Subordinates
Mass-traffic ship definition
The minimum delay between a mass traffic object from this job arriving and a new one appearing (defaults to 0)
The minimum delay between a mass traffic object from this job being destroyed and a new one appearing (defaults to 0)
ID
Name
Description
Skips loading of the job completely, as if commented out (defaults to false)
Default active state (defaults to true) - should not be true when defining wing quota
Allow including ship type and variation in ship name? Defaults to true
Skip checks which enforce the basket wares match with the commanders production wares (defaults to false)
Location filter by the range to the sector core which is based on jumpgates and highways. 0 to 1 is within the core. Values exceeding 1 will place the object beyond the core boundary by that factor
Location filter by economy value
Is the location rejected if its economy level exceeds the 'max' value? If false, location is treated as if it has the 'max' value (defaults to true)
Location filter by region wares
Match all wares? Defaults to false
The minimum distance the location should be from a region of the specified type.
The maximum distance the location should be from a region of the specified type.
Location filter by security value
Location filter by sunlight value
Relation range
Exclude placement along ring highways
Is this object to be placed in a zone only inhabited by itself
Chance (0.0 to 1.0) of the god entry to not attempt to be placed in an existing zone and instead create a new zone. No effect if a zone macro is specified.
Height range in meters of which new zones are allowed to be placed in the sector at the core boundary. Allowed height range reduces within the core boundary and increases out of it.
Location filters
Root element of god.xml
Object definitions
Object definition
Object definition
Object initial state
ID
Name
Description
Object owner faction (optional, defaults to ownerless)
Station definitions
Station defaults
Default location parameters
Default placement range for god objects based on the core of the sector which is based on jumpgates and highways. 0 to 1 is within the core. Values exceeding 1 will place the object beyond the core boundary by that factor
Chance (0.0 to 1.0) of the god entry to not attempt to be placed in an existing zone and instead create a new zone. No effect if a zone macro is specified.
Default height range in meters of which new zones are allowed to be placed in the sector at the core boundary. Height range reduces within the core boundary and increases out of it.
Station module limits (defaults to 20 or limited by god defaults for god generated stations)
Station definition
Station definition
ID
Name
Description
Station owner faction
Station entry race
Module set type
Module set (supersedes using 'race' and 'type' to select a set)
Production definitions
Product definition
Module definition
ID
Name
Description
Production ware
Factory owner faction
Module set type
Module set (supersedes using 'race' and 'type' to select a set)
Quota for the whole galaxy, which the job engine will attempt to populate. May be exceeded by requested job ships.
Maximum quota for the whole galaxy, after which the job engine will attempt to remove ships. May be exceeded by requested job ships. (defaults to galaxy quota)
Variation, requires wing attribute
Quotas across all gamestarts
Quota entry for gamestart (or default if 'gamestart' omitted)
Quotas optionally filtered by gamestart
Quotas across all gamestarts
Quota entry for gamestart (or default if 'gamestart' omitted)
Quotas optionally filtered by gamestart
Root element of mapdefaults.xml
Macro definitions
Priority
Name
Description
System (raw text ID)
Music reference (see sound_library.xml)
Fight music reference (see sound_library.xml)
Sunlight
Economy
Security
Red
Green
Blue
Macro name
The mk number of the unit/deployable category
Unit macro
Space-separated list of tags
Space-separated list of factions
Use is restricted
The mk number of the unit/deployable category
Weighting for distribution over unit/deployable capacity
Entry will only be processed for objects that have at least one dockingbay allowing a unit/deployable of the matching size to dock
Entry will only be processed for objects that have at least one dockingbay allowing a unit/deployable of the matching size to undock
Unit type is important for the operation of the ship/station, the system will attempt to ensure at least one unit/deployable of this type is added
Entry will only be processed for objects where available storage supports cargo of at least one of the specified tags
Entry will only be processed for objects where the owner faction matches at least one of the specified tags
If non-empty, entry will only be processed for objects matching exactly one of the specified class(es)
If non-empty, entry will only be processed for objects that have a primary pruposes matching exactly one of the the specified purpose(s)
Loadout rules root node
Unit category
Unit category
Loadout rule type
Space separated list of waregroup names. The wares associated with these groups will be checked against the products and tradewares of the station to see if it fits into this category
Deployable category
Deployable category
Loadout rule type
Space separated list of waregroup names. The wares associated with these groups will be checked against the products and tradewares of the station to see if it fits into this category
Root element of material_library.xml
Name
Source material (must appear earlier in the file)
Name
Cue name
Mission type
Objective action type
Custom objective action, requires attribute customaction
No objective
Achieve Coverage
Acquire crew
Acquire units
Activate something
Assign subordinate
Attack object
Board object
Build module
Build ship
Build station
Buy ware
Collect
Confiscate
Craft
Defend
Deliver ware
Deploy (satellite, mines)
Destroy object
Disembark from your ship (e.g. by using the spacesuit)
Dock at object
Drop
Embark a ship
Enable
Escort
Exchange wares
Explore
Extend
Equip
Find object
Fly to location or object
Follow object
Get up (from chair)
Get up (from chair)
Go to (on platform)
Hack an object
Gain reputation with a faction
Investigate some situation
Join a mission-subscription/squadron/...
Kill actor
Launch something (ship or missile)
Patrol
Pick up object
Pick up a person
Police scan
Protect object
Race
Repair
Research
Restock
Sabotage an object
Scan an object
Secure (ship or location)
Sell ware
Smuggle an item
Steal
Supply
Support
Talk to actor
Track
Transport
Return to your ship and undock
Unlock an object or location
Upgrade
Wait
Mission group lookup
Argon Police
Argon Secret Service
Argon Vs Holy Order war
Argon Vs Xenon war
Antigone Trade Guild
Scale Plate Pact Pirates
Mission thread types for missions and mission offers
Missions are active in parallel
Missions are played through sequentially
Which cue is used as namespace?
Use "this" cue as namespace, even for instances: $foo == this.$foo
Same as "this", but when instantiated, use the static cue: $foo == static.$foo
By default the namespace is inherited from the parent cue. The default for root cues is same as "static".
Priority of "todo" item
Trivial (nice to have)
Low priority
Medium priority
High priority
Critical (game cannot ship without)
Action when cue conditions fail (optional)
Cancel the cue when conditions fail
Complete the cue when conditions fail
Cue state
Disabled (no condition checks)
Waiting (checking conditions)
Active (running actions)
Complete (finished running actions)
Cancelled
Component slot or list of component slots as objective targets (cannot be used in combination with any of the attributes object or group)
Group of objective targets (cannot be used in combination with any of the attributes object or slot)
Optional radius associated with the objective. Default is 0
Change the objective silently? Default is false
Custom action text, required if action="custom"
Objective detail text
Objective end time
Should the target name be shown as unknown if the target is unknown? Default is false.
Briefing step (either as part of the briefing definition, or as reference to it when setting the objective)
Mission name (required if mission or mission offer is created from scratch)
Mission description
Faction that offers the mission (required if mission or mission offer is created from scratch)
Opposition faction to be encountered during the mission
Licence required to accept the mission (licence faction must match 'faction')
(required if mission or mission offer is created from scratch)
Mission group (defined in missiongroups.xml)
Money reward
Arbitrary reward text (takes precedence if both money and text rewards are specified)
Is this mission abortable? (Only used for missions, has no effect on mission offers)
Object that is associated with this mission (e.g. an NPC)
Class, macro or object to be set as the long range scan target (can also be 0 to clear the long range scan target when updating a mission)
Cue reference
Cue name
Internal version number
Date of current version
Status of current version
Author name
Date of change
Change description
Author name
Date of change
Description of change
Priority of change
Objective progress data for progress bar display
Progress display text string (if provided, it's shown in message ticker with progress value, otherwise a progress bar is shown)
Max progress count (rounded to an integer)
Current progress count (rounded to an integer, default is 0 if not supplied)
Mission objective
Definition of briefing steps
Replace briefing steps, i.e. discard all existing steps? This is supported for <update_offer>, >create_mission> (with attribute offercue) and <update_mission>. Default is false.
Definition of briefing steps
Briefing step (either as part of the briefing definition, or as reference to it when setting the objective)
Replace briefing steps, i.e. discard all existing steps? This is supported for <update_offer>, >create_mission> (with attribute offercue) and <update_mission>. Default is false.
Event for when a briefing is started for a mission or mission offer (object = cue, param = list of rendertarget names)
Event for when a briefing is cancelled (object = cue)
Event for when a submission selection is made in a briefing is started for a mission thread or mission thread offer (object = submission cue, param = list of rendertarget names)
Event for when a submission is unselected in a mission thread related briefing (object = submission cue)
Event for when a cue is activated (object = cue)
Event for when a cue is cancelled (object = cue)
Event for when a cue is completed (object = cue)
Event for when a cue is signalled (object = cue). Default is this cue if no cue is specified. (param = Script parameter passed from <signal_cue_instantly>)
Event for when mission guidance is disabled for a mission (object = mission cue). NOTE: Under normal circumstances, this event should not have an effect on a mission.
Event for when mission guidance is enabled for a mission (object = cue). NOTE: Under normal circumstances, this event should not have an effect on a mission.
Event for when a mission is aborted by the player (object = cue)
Event for when a npc is created (param = npc actor)
Event for when a cue offer is accepted (object = cue)
Event for when a character is created on a platform by platform population system, or manually by <create_platform_actor> (param = actor, param2 = entity type, param3 = true iff actor is a representative)
Is actor a representative?
Event for when a marine commander starts a boarding operation (param = commander, param2 = target to be boarded, param3 = boarder faction)
The marine commander that controls the boarding operation
The target object to be boarded
The boarder faction, which is trying to take ownership of the target
Event for when a boarding commander requests support by the player (param = commander, param2 = object being boarded, param3 = forced mission (0 should mean no forced mission))
The platform commander requesting support
The object being boarded by the commander requesting support
Cue is in active state
Cue is in cancelled state
Cue is in complete state
Cue is in disabled state
Cue is in waiting state
Mission guidance is active for the mission cue. NOTE: Under normal circumstances, this information should not have an effect on a mission.
List of conditions all of which must be met
List of conditions any one of which must be met
Show Game-over menu
Quit to desktop
Quit to startmenu
Start capturing a movie (to stop capture, see capture_movie_stop)
Stop capturing a movie
Make a screenshot (optional in a subdirectory)
Sub-folder of the personal screenshot folder where the screenshot will be stored (optional)
Enable Benchmarking (until we call benchmark_stop)
Note: This action is only available in egosoft-internal builds with benchmarking enabled
Sub-folder of the personal folder where the benchmarking results will be stored (optional)
Disable Benchmarking (has to be previously started with benchmark_start)
Note: This action is only available in egosoft-internal builds with benchmarking enabled
Activate an existing mission associated with a cue
Cancel cue
Complete cue
Create an actor object and associate it with this cue
Create a mission and associate it with this cue
Cue associated with a mission offer, whose properties will be copied to the mission. The other mission parameters are optional if offercue is supplied.
End time of the mission
Should mission become active if there is already another mission? Default is true. (Setting to false also prevents the mission being activated automatically when another mission gets deactivated.)
The cue of the mission thread
Mission cue to insert this thread before in the mission-thread
Create the accept event for the mission offer cue
Create a mission offer and associate it with this cue
The actor making the mission offer, used to start the briefing conversation
The offer location component slot (if not supplied then the mission offer has no visible location)
Distance from the offer location for the offer to be displayed in the BBS (unless hidden for another reason)
Duration of the mission
Is the offer hidden from the BBS? If true, the mission offer can only be found via the offer location.
Space location or list of locations the player must be in for the mission to appear in the BBS (unless hidden for another reason)
Create a mission and associate it with this cue
Cue associated with a mission offer, whose properties will be copied to the mission. The other mission parameters are optional if offercue is supplied.
End time of the mission
The mission thread type of this offer
Create a mission-thread offer and associate it with this cue
The actor making the mission offer, used to start the briefing conversation
The offer location component slot (if not supplied then the mission offer has no visible location)
Distance from the offer location for the offer to be displayed in the BBS (unless hidden for another reason)
Duration of the mission
Is the offer hidden from the BBS? If true, the mission offer can only be found via the offer location.
Space location or list of locations the player must be in for the mission to appear in the BBS (unless hidden for another reason)
The mission thread type of this offer
Create an actor object on a platform manually and fire the corresponding <event_platform_actor_created> event.
The room in which the actor should be created
Create a presentation cluster for use by cutscene system (must be destroyed after use)
Create an faction representative actor on a random landing platform in the given sector, and fire the corresponding <event_platform_actor_created> event.
If a representative already exists for this sector, no actor will be created; the result will be the existing actor.
Station on which the faction representative should be created
Create target points and associate them with a mission cue. NOTE: This only works if the mission is currently active, and it will remove previously existing target points of other missions.
Mission cue which will be associated with the target points
Either a single tag or a list of tags which are required for the target points
Sequence identifier string
Sequence stage
Find a mission offer location on a container
Force cue (not for general use)
Perform actions of the referenced library in the context of this cue
Library cue name
Create characters on platforms in the player zone, based on character quotas
Remove all associations of actor NPCs with this cue (the actors will be removed unless referenced outside the MD)
Remove association of cue actor with this cue (the actor will be removed unless referenced outside the MD)
Actor NPC to be removed from the cue. If not supplied, the last created actor will be removed.
Remove the mission associated with this cue, if there is one
Optional indication of why the mission was removed. This can cause additional actions such as displaying a message.
Mission aborted
Mission completed successfully
Tutorial completed successfully
Mission failed
Reason text (for mission failed only)
Optional specification of whether another mission should be activated automatically as replacement for this one, in case this is the currently active mission. By default no new mission is activated automatically.
If this is the current mission, no new mission should be activated. The player has to set a new current mission manually (default setting).
If this is the current mission, the last previously active mission is activated again.
If this is the current sub-mission in a master mission sequence, the next sequential mission will be activated.
Remove the mission offer associated with this cue, if there is one
Remove target points that are associated with the mission cue
Mission cue which is associated with the target points
Reset cue
Add a holomap to a rendertarget
Name of render target on which the cutscene should be played (ignored for event monitor cutscenes)
Remove a holomap
Set the target of the holo map. If necessary, the map will zoom in or out, using the target's parent component as the displayed space. Please make sure that you only go up or down one level of the hierarchy - it will still work if you don't, but might not look as good. This only works if the map is active!
Distance from the map plane (TODO @Owen - perhaps remove this when able to get suitable distance based on the target)
The time the map should take to pan to the new target if necessary. If not provided, the map will use the default time from parameters.xml (Note: this time should be shorter than the zoom time for better visuals)
Whether the map should also display items and spaces the player hasn't visited yet
Activate or deactivate a job
Job ID string
Activate job? (default is true)
Set an objective for the cue's mission (see <create_mission>)
Set the persistence of dynamically created presentation clusters. Whether they should be exported to a savegame or not.
Is the cluster persistent
Update progress count of the objective for the cue's mission. The progress data must already have been set up by <set_objective>.
Current progress count (rounded to an integer)
Max progress count (rounded to an integer, remains unchanged if not supplied)
Update metadata and briefing of an existing mission associated with a cue
End time of the mission (set to 0s to remove existing end time)
Update the current objective end time
End time of the objective
Update metadata and briefing of an existing mission offer associated with a cue
Duration of the mission (set to 0s to remove existing duration)
Update metadata and briefing of an existing mission thread offer associated with a cue
Duration of the mission (set to 0s to remove existing duration)
Have the player leave their current control position and activate first person controls
Undocks the player ship
Set speed of the players currently controlled ship (aborts boost)
Throttle value (defaults to 0) (-1 for full reverse, 0 for stop and 1 for full forward)
Send a signal to a cue, triggering cues that wait for this signal via <event_cue_signalled>
Check for existing cue listeners? If true and there are no listeners for the cue signal, a warning is produced. Default is true.
Signal a cue instantly, triggering cues that wait for this signal via <event_cue_signalled>. Can pass parameter to <event_cue_signalled>
Check for existing cue listeners? If true and there are no listeners for the cue signal, a warning is produced. Default is true.
Script Parameter passed to <event_cue_signalled>
Actions in all sub-nodes will be performed.
A randomly selected sub-node action will be performed. The chances of selection can be specified by using weights on the actions.
Actions in sub-nodes will be performed only if the value matches.
Can be followed by <do_elseif> and/or <do_else>.
Actions in sub-nodes will be performed only if the conditions in the previous nodes are not met and if this action's values matches.
Can be followed by <do_elseif> and/or <do_else>.
Actions in sub-nodes will be performed only if the conditions in the previous nodes are not met.
Actions in sub-nodes will be performed in a loop while the value matches.
Cue name
Cue version number
Define the module name the cue should run in (cue runs in all by default)
Create a new cue instance when activating?
Minimum game time (player age) of first condition check, can be variable and is evaluated when cue is enabled (use only in combination with onfail or checkinterval)
Delay between condition checks, must be constant (do not use with cues containing event conditions)
Action after first time condition is checked (do not use with cues containing event conditions)
Cue conditions all of which must be met to activate the cue
Range of delay time between activation and performing actions
Cue actions
Cue force actions, which will be performed before the actual actions when forcing a cue for debugging
Name of the force actions, used to provide a list of plot shortcuts for testing
Actions for patching a cue of an older version (will be performed when loading the MD script from a save).
Patches are applied to waiting, active, complete or cancelled cues (see state attribute).
This includes library users and instances, except for completed/cancelled instances that have already been deleted.
Cue version at which this patch element was added (it will only be applied when loading a cue of an older version)
Required state that this cue must be in for this patch to be applied (default is complete)
Apply patch only if this cue is complete (default)
Apply patch only if this cue is waiting (conditions are being checked)
Apply patch only if this cue is active (not complete yet because of a delay)
Apply patch only if this cue is cancelled
Sub-cues
Cue
Cue parameter (only used if cue is a reference)
Parameter name
Parameter value
Library cue name (all other cue data is ignored if this is present)
A library cue
Library parameter
Parameter name
Default value (parameter is required if default value not supplied)
Mission Director script root element
Cues
Signature
Object spawn point list root node
The space for which the spawn points are defined
Object spawn point
Spawn position in sector coordinates (unless space is overridden)
Spawn rotation in sector coordinates (unless space is overridden)
Spawn rotation in sector coordinates (unless space is overridden)
Unique (per sector) id
Macro name of the object to spawn
Macro path to another coordinate space to use instead of the sector (usually a station)
The minimum time after which the object may respawn (only happens out-of-sector)
The droplist id (from libraries/drops.xml) to use instead of the macro-defined one
No in-game effect
The macro name of the sector
Station Type
Field Type
The macro name for the spawned object (only used if not specified by a spawn point)
The drop list override for the spawned object (optional, spawned object's default drop list is used if not defined)
Defining this overrides the macro and drop attributes in the parent node
Rule only applies in this sector if defined
If rule applies, the chance in percent that an object is spawned at a randomly selected location
The spawn rule
Rule only applies to stations owned by this faction if defined
Rule only applies to stations inside hazardous regions if defined
Rule only applies to stations of this type if defined
The spawn rule
Rule only applies in sectors owned by this faction if defined
Rule only applies to hazardous regions if defined
Rule only applies to regions with this region definition if defined
Rule only applies to fields of this type if defined
Rule only applies to fields with this resource if defined
Rule only applies to fields with objects at least this large if defined
Rule only applies to fields with objects at most this large if defined
Object spawn rule list root node
Maximum angle away from crosshair center (horizontal or vertical), in positive degrees (default: 180, i.e. no restriction)
Chance value, defaults to 100.
Color value given as ARGB components.
Red color value (0-255, default: 0)
Green color value (0-255, default: 0)
Blue color value (0-255, default: 0)
Alpha value (0-255, default: 255)
Control highlighting options
Red color value (0-255, default: 0)
Green color value (0-255, default: 0)
Blue color value (0-255, default: 0)
Alpha value (0-255, default: 255)
Duration of the highlight effect
Frequency of oscillation effect (default: 0, no oscillation)
Minimum alpha value for oscillation effect (0.0-1.0, default: 0)
Maximum alpha value for oscillation effect (0.0-1.0, default: 1)
Input value
Output value for this point's input value
Default value, used when input is outside of bounds defined by the curve
Full plot price contribution at min or smaller distance
No plot price contribution after max distance
Factor added per object of this category to price calculation, linear scaling between min and max distance
Outline effect
Fill effect
Outline effect
Fill effect
Minimum scan level to trigger this effect
X coordinate
Y coordinate
Z coordinate
Factor of job quotas
Factor of god quotas
Multiplier applied to quota definition of any object entry in god.xml
Multiplier applied to quota definition of any production entry in god.xml
Multiplier applied to quota definition of any station entry in god.xml
Yaw angle
Pitch angle
Roll angle
Position
Rotation
Parameters related to mass traffic objects
Parameters defining how a ship will deviate from the exact mass traffic position over time
The maximum distance a mass traffic object can deviate in each direction
Parameters for the period at which a mass traffic object oscillates in each coordinate. The result will be a random value between the minimum and the maximum period.
Parameters for the phase shift of oscillation. The result will be a random value between the minimum and the maximum phase.
Defines the maximum deviation at which mass traffic objects move
The tag ID for this width setting
The width (in m) to be used on roads with this tag
The default width (in m) to be used when no matching tag is defined
Width factors based on curve angle
Default width factor
Defines the speeds at which mass traffic objects move
The tag ID for this speed setting
The speed (in m/s) to be used on roads with this tag
The default speed (in m/s) to be used when no matching tag is defined
Minimum distance between objects in a lane - this divided by the slowest speed is the time delay between launching ships
The default maximum render distance (evaluated per road, not per object)
The maximum distance for standard mass traffic objects to become a component
The look-ahead time in seconds that mass traffic objects use to determine their rotation
Parameters related to mass traffic ship trails in highway
Trail vertex color for signalling collision with player ship
Trail vertex color for signalling no collision with player ship
Parameters for network setup
Parameters for connecting 'blocklink' waypoints
Maximum number of connections to be made per blocklink waypoint (can be fewer if not enough are in range)
Whether to prune block link connections going to waypoints on the same module that are internally connected (i.e. you can go from A to B, so don't connect to B if you're already connected to A)
Maximum distance between waypoints for block links (if there is no matching blocklink within that distance the one that's closest will be used)
Parameters for connecting 'closelink' waypoints
Maximum distance along the y-axis between waypoints for close links
Maximum distance between waypoints for close links
Parameters for spline tangents
Base tangent length relative to distance between start and end point
Parameters controlling curves between roads
The maximum fraction of a road that can be used for a curve. Should never be larger than 0.5!
The maximum turn speed of mass traffic ships, in degrees per second. This, together with the forward speed, is used to calculate the curve radius.
Curve defining the factor on the spline tangent length depending on the sharpness of the road pair's angle (position: degrees between 0 and 180)
Parameters for static mass traffic nodes from, to and along highways
Parameters for the roads that go along the highway tube
The length of each highway-parallel segment
Will be multiplied with the highway's tube radius to determine the distance of the road from the highway center
Parameters for the roads leading into a highway entry gate
The length of the road
Parameters for the roads leading out of a highway exit gate
The length of the road
Whether to connect stations to local highways in the same zone
Whether to connect stations to highway entry and exit gates in the same zone
Parameters for build mass traffic
The number of individual paths per build mass traffic network
The number of intermediate "welding points" per path
Parameters for repair mass traffic
The number of individual paths per repair mass traffic network, per repaired component
Whether to connect stations in the same zone to each other
Experimental: roads shorter than this length might be skipped over with a shortcut (only considers dynamically roads that start or end at a manually defined waypoint)
Parameters related to attack damage
Effective area for turrets to fire from, limiting damage from very large obects
Multiplier for laser damage
Multiplier for missile damage
Multiplier for turret damage
Multiplier for attack drone bullet damage
Multiplier for attack drone missile damage
The minimum speed of the attacker, used for evasion calculations. Slower or immobile objects will use this value
Parameters related to the defender, negating damage
Factor of how much of a difference the speed between the attacker and defender affects the hit chance
The minimum speed of the defender, used for evasion calculations. Slower or immobile objects will use this value
The minimum size of the defender, used for hit chance calculations. Very large objects will use this value
Factor of how much of a difference the object size and 'maxsize' affects the hit chance
Factor of how much turret damage against a defending capitalship is negated. Simulating the high attention wandering of capships which slows the battle
Factor of how much missile damage against can be avoided by using countermeasures. The higher the value, the more effective the countermeasures are. (factor is only applied if the target has any countermeasures at all)
Factor of how much damage a single defence drone will negate by distracting the attacker. Total result clamped between 0.5 and 1.0
Amount of damage needed to be dealt to destroy one defence drone
The maximum range at which a collectable will be pulled
How strongly the collectable will be pulled (note that the force at a certain range also increases when the range is increased)
The collectable's maximum speed
The sound ID to be played while the magnet is active
Parameters related to rendering
Parameters related to weapon glow
The maximum glow value to be passed on to shaders
Parameters related to sounds
Parameters related to anomaly sounds
The section curve for the sound's pitch depending on the distance to the center (this is additive, so 0 is neutral)
The section curve for the sound's volume depending on the distance to the center (this is a factor, so 1 is neutral)
Parameters related to high speed sounds
The section curve for the delay between individual sound instances depending on the relative speed (input position of 0 is the unboosted maximum speed, 1 is the total maximum speed as defined in the spaceflight parameters)
The minimum speed at which the sound should play (value multiplied with the ship's unboosted maximum speed)
Parameters related to detail sounds of ship engines
Detail sound properties for a specific ship size
The maximum amount of ships of this size to get detail sounds at a time
The maximum amount of ships of this size to get detail sounds at a time
The maximum range at which ships of this size are even considered for detail sounds
The minimum sway amplitude
The maximum sway amplitude
whether the sway direction should be randomized
The first control point of the bezier time curve
The second control point of the bezier time curve
The material for each guidance light
How many guidance lights (per side) can be seen at a time
How long until the line of lights reached the end
Size of each light geometry
Start tangent multiplier - defaults to 1.0, should not get too high (certainly not higher than 2.0) or the spline can stick inside geometry unreasonably often, or look broken in other ways
How far in front of the ship the first lights should appear - property is multiplied with the playership size to get the result
How far along the spline lights should be rendered at most
The half width of the light path (i.e. X offset to the center spline)
The distance between 2 lights along the spline
The initial fadein parameter for lights - the smaller this is the faster the lights fades in. Defaults to 0
The base distance from the head at which to render the elements
The maximum difference in position/rotation between ship and dock point for docking to finish
Position
Rotation
The minimum software that needs to be installed for this set of parameters to be used
Parameters that control the visuals of ships landing
Data for a specific traffic level
The duration of the slowdown sequence in seconds (must be shorter than the landing duration!)
The duration of the align sequence in seconds (must be shorter than the landing duration!)
The maximum suspension movement in metres
The duration of the suspension sequence in seconds
Parameters defining how a landing ship sways around each axis
The traffic level at which this parameter set is used
The duration of the landing sequence in seconds (total duration is this plus the suspension duration)
Parameters that control the visuals of ships taking off
Data for a specific traffic level
The height of the initial release movement in metres
The duration of the initial release sequence in seconds
The start time (counted from the beginning of the takeoff movement) of the align sequence in seconds (must be shorter than the landing duration!)
Parameters defining how a ship taking off sways around each axis
The traffic level at which this parameter set is used
The duration of the takeoff sequence in seconds
The tags for this dock's compatible sizes
The time after which an assignment is cancelled if the ship fails to dock
The maximum distance a ship may have to a station for a dock to be (and stay) assigned
The distance at which an undocking ship is unassigned from the dock it's departing from
The minimum duration a ship will not be stored away after having been retrieved
The minimum duration a player ship in high attention will not be stored away after having been retrieved
The maximum (linear) speed allowed while 'inside' an enclosed docking space
Definitions to control the price calculation of building plots
Distance and contribution factor definition for Gates
Distance and contribution factor definition for Highways
Distance and contribution factor definition for Stations
Additional multiplier for the contribution of a station if it is a Shipyard, Equipment Dock, Military Station or Trading Station
Base price for a 1km * 1km * 1km plot in Credits
The minimum distance between the fully expanded bounding boxes of stations to allow building
The partitioning method. Watershed (slowest), 2: Monotone (fastest), 3: Layer (pretty fast)
The size of tiles on the xz-plane.
The size of the non-navigable border around the heightfield.
The xz-plane cell size to use for fields, in m. Must be larger than 0.
The y-axis cell size to use for fields, in m. Must be larger than 0.
The maximum slope that is considered walkable, in degrees. Must be at least 0, and less than 90.
Maximum ledge height that is considered to still be traversable, in m. Must be at least 0.
The maximum allowed length for contour edges along the border of the mesh.
The maximum distance a simplified contour's border edges should deviate from the original raw contour. Must not be negative.
The minimum number of cells allowed to form isolated island areas.
Any regions with a span count smaller than this value will, if possible, be merged with larger regions.
The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. Must be at least 3.
Sets the sampling distance to use when generating the detail mesh. (For height detail only.) Must be either 0 or at least 0.9
The maximum distance the detail mesh surface should deviate from heightfield data in voxel units. (For height detail only.)
Parameters for various systems related to navigation on platforms. Note that many values are very technical and don't make much sense without knowing the context.
Parameters used during navmesh generation. Default data.
Parameters used during navmesh generation for objects smaller than the threshold. Data from default node are used where not overridden.
The maximum size of the navmesh object's bounding box (in m, half length of longest box edge) that can use these parameter overrides.
A race-specific set of character parameters.
Different speeds of this race's characters, in m/s.
The maximum slow-walking speed, in m/s.
The maximum walking speed, in m/s.
The maximum run speed, in m/s.
The race ID for this set of character parameters.
The width of the body (radius, not diameter), in m.
The height of the body, in m.
The maximum walking acceleration, in m/s^2.
The maximum allowed number of simultaneously active agents.
Defines how close a collision element must be before it is considered for steering behaviors. Will be multiplied with the agent's race-specific width.
The path visibility optimization range. Will be multiplied with the agent's race-specific width.
Whether agents should calculate a smooth steering direction.
Whether crowd agents optimize their path by visibility.
Whether crowd agents optimize their path by topology.
Whether crowd agents should avoid obstacles.
Whether agents that are very close to each other should separate.
AI agent separation weight.
Player agent separation weight.
Character width used to calculate the pick extents for character placement
Maximum character width with tolerance (0.1) already deducted to determine walkable surfaces
Maximum character height with tolerance (0.6) already deducted to determine walkable surfaces
Path finding parameters
Maximum distances used to find navmesh polygons (used inside the Recast library)
Default values used for most cases
Smaller values used when we can't have any false positives
The maximum number of iterations in a single path finding call
Whether to use the DT_FINDPATH_ANY_ANGLE option for sliced path finding (can find shortcuts using line-of-sight checks)
Traversal costs for the various floor types (all must be >= 1)
Default cost for areas not covered by the other cases (must be >= 1)
Cost for areas tagged 'walk_conveyor' (must be >= 1)
Cost for areas tagged 'walk_dockingbay' (must be >= 1)
Speeds for platform conveyor belts
The tag ID for this speed setting
The speed (in m/s) of conveyor belts with this tag
The default speed (in m/s) to be used when no matching tag is defined
Curve radii for platform conveyor belts
The tag ID for this curve radius
The curve radius (in m) of conveyor belts with this tag
Ranges for proximity trigger parts
The tag ID for this range setting
The range (in m, x and z coordinates only) of proximity triggers with this tag
The range (in m, y coordinate only) of proximity triggers with this tag
The default range (in m, x and z coordinates only) to be used when no matching tag is defined
The default range (in m, y coordinate only) to be used when no matching tag is defined
The travel speeds used for calculating edge costs for path finding
The average travel speed (in m/s) of ships in space (should take boosting into account)
The average travel speed of ships in highways (0 = min speed, 1 = max speed)
Parameters related to workforce
Workforce update behaviour
Update interval in seconds
Update interval variation (= interval +/- variation)
Workforce growth behaviour
Ratio of habitation amount / habitation capacity.
Lower end of the habitation fill ratio value. If the value drops below this, always use factor->max for calculating effective growth rate.
Upper end of the habitation fill ratio value. If the value exceeds this, always use factor->min for calculating effective growth rate.
Factor to apply to final growth rate based on current habitation ratio.
Minimum factor applied to growth rate when habitation fill ratio exceeds ratio->max
Maximum factor applied to growth rate when habitation fill ratio drops below ratio->min
Time interval between workforce growth evaluations
Base growth rate per evaluation (modified by other rules)
Parameters related to upgrades. Used to determine reserved space for necessary resources.
Resource amount multipliers per category
Parameters controlling the parameters for detecting and responding to resource shortages.
Time thresholds for sending reports and requesting remedies
Minimum time a production needs to be able to run for, before available resource are not considered in "low" supply
Time thresholds for sending events notifying the universe about a producer suffering from extended resource shortage
Time thresholds that a ware must have been in "low" supply before a warning is sent
Time thresholds for sending reports and requesting remedies
Time thresholds that a ware must have been in "low" supply before a transporter is requested
After having been "low" on a ware for the specified time(in seconds) any transporter that can transport this ware is requested
After having been "low" on a ware for the specified time(in seconds) a transporter that exclusively transports the ware is requested
Time threshold that controls after which amount of time on being low/out of a resource the production (and zone) is considered not viable and will be abandoned
Percentage thresholds for ware amounts in production storage
Parameters defining exclusion zone sizes for different dock types
Parameters related to 3D pointers
Mappings from mouse cursor ID to icon material
Mapping from mouse cursor ID to icon material
The mouse cursor ID
The icon material to be used when this cursor is set - if left empty the game will display a small sphere instead
The scale of the element (sphere or icon plane)
Properties for the VR mouse pointer
The offset of the pointer origin relative to the VR center offset
The default length of the pointer if nothing is being pointed at
The width of the pointer
The material to be put on the pointer
The base scale of the icon shown at the end of the line, will be modified by the distance to the camera to keep the screen size consistent
Parameters related to aim indicators of weapons
The base color for the indicator
The base scale of the indicator
The material to be put on the indicator
Render distance factor, 1.0 would put the pointer at the exact distance of the raycast hit
Base value for logarithmic calculation of number of cargo bays shown depending on fill status of storage module.
Mining damage factors to estimate efficiency while shooting at asteroids
Damage factor for turrets
Damage factor for front-mounted weapons
Factors to estimate how much of the max speed is used on average
Speed factor for the mining ship
Speed factor for the mining ship's collector units
How far asteroid drops are estimated to fly compared to the asteroid size.
The time over which maximum acceleration can be achieved (this only affects visuals and not actual movement)
Parameters that control movement-dependent scaling of jet parts on engines or objects
The strength of influence the current acceleration has on the jet scale
The strength of influence the current velocity has on the jet scale
Additional scale factor, applied before enforcing the maximum
The maximum jet scale that the code can set
Parameters that control movement-dependent glow values on engines or objects
The strength of influence the current acceleration has on the glow strength
The strength of influence the current velocity has on the glow strength
Additional scale factor, applied before enforcing the maximum
The maximum glow strength that the code can set
Parameters that control movement-dependent rotation animations for engines
The minimum speed that can influence alignment (relative to respective max speed)
The minimum acceleration that can influence alignment (relative to respective max acceleration)
The minimum difference between current speed and target speed that can influence alignment (relative to respective max speed)
Parameters that control vortex trails
Vortex rotation parameters
The minimum rotation speed above which vortex trails are shown at lowest density
The maximum rotation speed above which vortex trails are shown at highest density
Vortex soeed parameters
The minimum forward speed above which vortex trails are shown at lowest density
The maximum forward speed above which vortex trails are shown at highest density
Parameters library document node
Highlight settings
If at least *mintargets* within *maxdistance* meters have been attacked during the last *attackduration* seconds, play fight music for at least *minduration* seconds.
ID
PeopleDB document node
Macro
Mission type
Actor (entity) type
Dock population type
Crate visibility type
Chance percentage of this item being part of the content, if evaluated amount is nonzero (defaults to 100)
Quota definition for mission type
Mission offer quota definition
Quota definition for actor type
Actor quota definition
Overrides the general actor weight for the specified dock population type
Quota definition for crate type
Candidate for crate content
Ware amount definition
Money
Crate connection tag restrictions for this content
Crate quota definition
Crafting crate quota definition
Crafting ware definition
Crate candidate for a crafting resource
Crate connection tag restrictions for this crate
Crafting resource ware (optional - if present, only crate definitions with this ware will be considered for placing the resource)
Chance percentage of crates with crafting items being spawned for a station (defaults to 100)
Zone
Sector
Cluster
Mission quota definitions
Load macros even if they are not used in the universe map? May be useful to detect typos. (default is false)
Active icon id for faction
Inactive icon id for faction
Relationship value
I do not like you
I like you
I am neutral towards you
Faction id for relationship
Relation value for relationship
Relation for one faction to another
Default acceleration (in meters/s^2) for a character of this race
Default slowwalk speed (in meters/s) for a character of this race
Default walk speed (in meters/s) for a character of this race
Default run speed (in meters/s) for a character of this race
Height adjustment for character sitting in event monitor
Depth adjustment for character sitting in event monitor
Character speed definition
Position adjustment when sitting in event monitor
Default height (in meters) for a character of this race
Default width (in meters) for a character of this race
Chair configuration used for members of this race (default: chairconfig_default)
Chair animation used for members of this race (default: chair_default_active)
Chair definitions
Character definitions
Icons for a faction
Relations for a race
Race id
Race name
Race description
Short race name (i.e. abbreviation)
Text page ID for names of members of this race
Construction direction bias (use range 0.1 to 10.0 where less than 1.0 prefers vertical connections, 1.0 is balanced, and greater than 1.0 prefers horizontal connections, default is 1.0)
Definition of a single race
Race DB

Scales the perlin noise so that it forms structures of more appropriate sizes. Defaults to 1000.
Used for the Perlin noise generator. If not supplied, the region's macro name is hashed to get a consistent seed.
Positions in the region where the noise value is below this number are not used for placing objects, and nebula fields are not rendered. Defaults to 0.
Positions in the region where the noise value is above this number are not used for placing objects, and nebula fields are not rendered.Defaults to 1.
The connection tag to use when looking up the LOD rule (see renderparam_library.xml). Leave empty to use the default rules for fields.
Reference to a region object group from libraries/regionobjectgroups.xml
The factor to multiply the region's base density with, which is in objects per 100 km³. Defaults to 1.
The fraction of each object's bounding sphere to be used for obstruction checks during population. Defaults to 1 for fields with physical objects, like asteroids, and 0 for others.
The base angular speed of created objects, multiplied with the region's angular speed. Defaults to 0.
The randomized variation in angular speeds of created objects (in deg/s). Defaults to 0.
Whether to allow the x axis (pitch) for random rotation. Defaults to true.
Whether to allow the y axis (yaw) for random rotation. Defaults to true.
Whether to allow the z axis (roll) for random rotation. Defaults to true.
Whether to use exact bounding boxes instead of much faster spheres for obstruction checks when populating the field with objects. Defaults to false.
The resource ware for this field - recommended to use only when not using an object group
The yield - either per object (for fields that instantiate then, like asteroid fields) or per area (for others, like nebulae). Defaults to 0.
The time (in minutes) it would take the region to replenish from being empty back to full yield. Defaults to 60.
A factor to modify how fast resources can be gathered here. Defaults to 1.
The chance, in percent, for each instantiated object to have any yield at all. Defaults to 100.
The maximum variation in yield from object to object. Defaults to 0.
Radius for sphere, cylinder or spline tube boundaries.
Height for cylinder boundaries.
Side length in x direction for box boundaries.
Side length in y direction for box boundaries.
Side length in z direction for box boundaries.
Spline point. Coordinates are relative to the region. tx/ty/tz are the tangent direction.
Incoming tangent length.
Outgoing tangent length.
The damage value applied to shields first and then hull.
The damage value applied only to shields.
The damage value applied only to hull, bypassing shields.
The damage value applied to hull only if shields are down.
The steps define damage multipliers at certain speeds.
The base density of created objects, in objects per 100 km³. Defaults to 1.
The base angular speed of created objects (in deg/s). Defaults to 0.
If defined, any spawned region objects will stay for as long as the player is in the same cluster, and for the given time when in a different cluster before being removed.
This effect, if defined, will be created inside the valid region volume when long range scanned
The scan result effect definition, see libraries/effects.xml
The effect density, defaults to 1.0
This color, if defined, will be used to change the appearance of region objects
Red color value (0-255, default: 0)
Green color value (0-255, default: 0)
Blue color value (0-255, default: 0)
Alpha value (0-255, default: 255)
Random color variation, all components (including Alpha) will be multiplied with the same random number between 1-v and 1
These effects, if defined, will be created in the player's cockpit when the ship is damaged
The "hull damaged" effect definition, see libraries/effects.xml
The "shield damaged" effect definition, see libraries/effects.xml
The minimum delay between effects
The maximum delay between effects
The effect definition. (See effects.xml)
The base delay between 2 effects being created (in seconds).
The variation applied to the base delay between 2 effects being created (in seconds). Defaults to 0.
The maximum distance to the player at which effects will be created (in m). Defaults to 10000.
The macro name of the local fog component.
The red component of the uniform fog color. Defaults to 0.
The green component of the uniform fog color. Defaults to 0.
The blue component of the uniform fog color. Defaults to 0.
The factor to multiply the region's base density with to get the alpha scale. Defaults to 0.
The red component of the local fog color. Defaults to 0.
The green component of the local fog color. Defaults to 0.
The blue component of the local fog color. Defaults to 0.
The factor to multiply the region's base density with to get the alpha scale. Defaults to 0.
The distance of the background fog in m. Defaults to 5000.
Defaults to true.
The name of the tone map texture, including the path. Example: assets\textures\RegionLUTs\your_tone_map.dds
Defaults to 0.
Defaults to 0.
The sound ID of the sound to be played while in the region
Resource properties for this region
Properties for a specific resource ware. If valid, this will be distributed over all resource fields with an object group that defines the matching resource ware (see libraries/regionobjectgroups.xml). If the actual object density is higher than required for the resource density then only a portion of objects are going to have resources, with the rest being empty.
The resource ware ID
The yield for this resource - see libraries/regionyields.xml for valid values
A factor between 0 and 1 that's multiplied on the base yield density

A region object group, to be referenced in region_definitions.xml
The macro name of the region object
The weight of this macro selection (defaults to 1)
The name of this region object group
The resource ware ID to be assigned when this group is used
The base yield for region objects in this group
The yield variation fraction for region objects in this group

Yield definitions for a specific resource ware
The ID of this yield definition, to be referenced in region_definitions.xml
The resource density, in ware amount per km³
The time it takes to replenish the resources from empty to full (minutes)
The gather speed factor (only relevant for liquid resources)
The scan result effect definition, see libraries/effects.xml
The scan result effect density, defaults to 1.0
The scan result effect intensity (opacity, volume, etc.), defaults to 1.0
The resource ware ID
The default scan result effect definition, see libraries/effects.xml
The default scan result effect density, defaults to 1.0
The default scan result effect intensity (opacity, volume, etc.), defaults to 1.0
Script property
Property name as used in expressions
Documentation of property result
Datatype of the property result
Import script properties from an XML or XSD file using XPath expressions
Define how to import the properties
XPath expression that locates the text node or attribute containing the property name
XPath expression that locates the text node or attribute containing the result description
Datatype of the property result
In case the located name contains dots, should the prefix (until the last dot) be ignored?
Name of the source XML file which contains the property data to be imported
XPath expression of property nodes in the imported file
Definition of a script keyword that is a valid "stand-alone" expression
Keyword name as used in expressions
Keyword documentation
Datatype of the keyword
Type of script that supports this keyword (MD, AI or NPC State Machine script). Default is "any"
Definition of a real script data type, or a specialized/generalized value type for documentation purposes
(e.g. "ship" as specialization of "component", or "numeric" as generalization of "integer" etc.)
Unique name for the datatype, that can be referenced in type attributes
Base datatype of this datatype
The number suffix that denotes the default unit of the type. Only valid for numeric types.
Is this a pseudo-datatype? Values of such types do not exist in the script system, they only exist to access further properties.
Provides a path to the TextDB XML file to support format string conversion of imported text strings
Path to a TextDB XML file
Documentation of keywords and properties in script expressions
Sound sample or selection of samples
Boost charge progress (between 0 and 1)
Relative forward speed (between -1 and 1)
Relative difference between current and target forward speed (can be between -2 and 2)
Total IK translation speed of the sound's position reference (can be between 0 and 1)
IK x translation speed of the sound's position reference (can be between 0 and 1)
IK y translation speed of the sound's position reference (can be between 0 and 1)
IK z translation speed of the sound's position reference (can be between 0 and 1)
Total IK rotation speed of the sound's position reference (can be between 0 and 1)
IK pitch rotation speed of the sound's position reference (can be between 0 and 1)
IK yaw rotation speed of the sound's position reference (can be between 0 and 1)
IK roll rotation speed of the sound's position reference (can be between 0 and 1)
Input value
Output value for this point's input value
Default value, used when input is outside of bounds defined by the curve
The value to be used for curve input (not required in some cases)
Sound Volume Curve
Sound volume
Sound pitch
Sound low pass filter
Average interval between random background noise samples (actual intervals are random with exponential distribution)
Sound definition
Unique sound ID
Sound description
Connection tag where the sound should be played
How often is playback executed?
Play sound once (default)
Infinite loop
This sound needs 3D control
This sound can only be played one at a time
This sound should be preloaded on gamestart
Maximum/simultaneous number of active Sounds
Always active
Active while boost is charging
Active while boosting
Triggered when throttle is increased
Triggered when throttle is reduced
Triggered when boost charge starts (doesn't happen if there is no charge time)
Triggered when boost charge is aborted before it finished
Triggered when actual boost starts
Triggered when boost stops, either manually or due to timeout (doesn't happen if boost was still charging)
Sound reference
Sample (only if not using ref)
Unique sound ID (id and ref cannot be used together)
Reference to unique sound ID (id and ref cannot be used together)
Sound description (only if not using ref)
Connection tag where the sound should be played (only if not using ref)
Group sound tags
How often is playback executed? (only if not using ref)
Play sound once (default)
Infinite loop
This sound needs 3D control (only if not using ref)
This sound can only be played one at a time (only if not using ref)
This sound should be preloaded on gamestart (only if not using ref)
Maximum/simultaneous number of active Sounds (only if not using ref)
Sound group definition
Unique sound group ID
Sound library document node
Comment
Stat units (default is none, i.e. just counting)
Internal data type (optional, derived from units if not supplied)
Number of fractional digits (Optional, only applies to floating point data types. Default is 0. Any other value is not compatible with separators.)
Default stat value (default is 0 if not supplied)
Display format (optional, derived from units if not supplied. Use %s as placeholder for the stat value)
Use (localised) separator for groups of three digits? (Optional, default is true; if used on a floating point type, the fractional digits are discarded)
Hide stat in menu if the value is the default value? (Optional, default is false)
Keep only the highest value? (Optional, default is false)
Is stat stored in Steam account persistently across savegames? (Optional, default is false)
Name of the corresponding Steam leaderboard if this stat should be stored in a leaderboard (optional). The name should be display-friendly but still be a unique identifier.
Name of stat to copy value to.
Optional multiplier for the value applied to the referenced stat.
Optional divisor for the value applied to the referenced stat.
Name of stat to add value change to.
Optional multiplier for the value applied to the referenced stat.
Optional divisor for the value applied to the referenced stat.
Name of stat to set the specified value to when this stat is within the specified range.
Minimum value of this stat (inclusive).
Maximum value of this stat (exclusive).
Value to set the referenced stat to.
Declares the existence of a corresponding achievement that is unlocked when a certain stat value is reached. Multiple achievement definitions with different unlock values are possible.
The achievement requires account="true" either for this stat or for a referenced copyto stat.
Stat value at which achievement progress indication is displayed if the achievement is not unlocked yet. Multiples of this value will also indicate progress. (Optional, default is no indication)
Stat value at which the corresponding achievement is unlocked.
Provides a name for a stat value. The name will be used if the value is greater than or equal to this value but lower than the next higher one.
Value
Name
Stat definition
ID
Localized name (TextDB reference). If not supplied then the stat is treated as hidden (not shown in menu).
Document element of stats.xml
Entry id
Entry name
Entry description
Entry image
Entry video
Voice sequence ID
Date (integer part is year, fractional part is primarily used for ordering within a year)
Group number (controls spacing of entries)
Definition of a single timeline entry
Timeline DB
Flat (linear) distribution, default if no profile specified
Higher numbers are more likely
Lower numbers are more likely
Numbers in the middle of the range are more likely
Higher and lower numbers are more likely than those in the middle
Exact value (takes priority over min/max/profile/scale)
Minimum random number (ignored if exact is set)
Maximum random number (ignored if exact is set)
Random number profile (ignored if exact is set)
Scale of random number profile (ignored if exact is set or if profile is flat)
Allowed classes of object the signal leak is attached to. Specify multiple separated by space. Allows all if omitted
Random amount value.
Random time value.
Maximum distance at which to unlock (default: as defined by globals node)
Maximum angle away from crosshair center (horizontal or vertical), in positive degrees (default: 180, i.e. no restriction)
Minimum/maximum level of the scanner that can unlock this (default: 0 to MAX_SCAN_LEVEL, i.e. no restriction)
Weight value, defaults to 1.
Specify at which locations this unlock may be triggered based on who owns the object.
Space-separated list of factions (e.g. aquarius).
True to allow only owner factions that are NOT listed in the factions attribute, defaults to false.
Specify required relation when unlock may be triggered based on who owns the object.
Minimum relation (defaults to -0.2, which is lower bound of neutral)
Maximum relation (defaults to 1.0)
Secrecy level a component must have for this unlock to trigger.
Minimum secrecy level (defaults to -1)
Maximum secrecy level (defaults to 3)
Specify which wares must be traded at the target location.
Space-separated list of wares (e.g. energycells) that must be bought at the location.
Space-separated list of wares (e.g. energycells) that must be sold at the location.
True if all wares in the list must be sold/bought, defaults to false.
Maximum distance at which to unlock (default: as defined by globals node)
Note: if max is used this will be a random value from min(default: 0!) to max
This can result in very small values, making the unlock extremely hard to trigger!
Whether the player must be on foot to trigger this unlock. (defaults to false)
Whether the player must be in a spacesuit to trigger this unlock. (defaults to false)
Amount of the unlocked bonus effect.
Duration of the unlocked bonus effect.
Maximum distance at which to unlock (default: as defined by globals node)
Note: if max is used this will be a random value from min(default: 0!) to max
This can result in very small values, making the unlock extremely hard to trigger!
Only evaluated if scan="false".
Only evaluated if scan="false".
Only evaluated if scan="false".
Only evaluated if scan="false".
Whether an active scan is required to trigger this unlock. Certain conditions are ignored when this is true.
Whether the player must be in a spacesuit to trigger this unlock. (defaults to false)
Full percent of info locations to be unlocked.
Scan level of the unlocking chain (for active scans the smaller value between the scan being performed and the level defined here is used)
Maximum secrecy level of component information that can be unlocked
Unique unlock ID (unique across discounts and commissions!)
Unlock name
Unlock description
Time after which this unlock may be triggered again at the same entity once it has been unlocked.
Unlock definition
Apply unlock, required for discounts and commissions.
Unlock definition
Unlock definition
Unlock info chain.
Name for offsetting a discount (appears as a "negative commission")
Name for offsetting a commission (appears as a "negative discount")
No unlock checks will be done if the target is more than maxdistance away.
If an unlock condition has been checked, no further checks will be made unless
the player has moved at least a distance of threshold away from the current location
Minimum time that must pass after an unlock has been triggered before *any* new unlock can be triggered
Unlock library document node
Global settings
Discount
Commission
Blueprint unlock
Information (chain unlocking)
Comment for documentation purposes only
Voice sequence entry for speaking a TextDB line
TextDB page (optional if the voice sequence specifies a default page)
Text line on the provided TextDB page
Speak priority (optional, falls back to the default priority specified by the voice sequence - note that a priority less than or equal to -50 suppresses subtitles)
Voice filter override (optional if the voice sequence specifies a default filter override)
Voice sequence entry for a delay between lines
Length of the delay in seconds (fractions allowed)
Voice sequence definition
ID
Default TextDB page for <speak> sub-elements (optional)
Default priority for <speak> sub-elements (optional, default is conversation priority of 100 if omitted).
Default voice filter override for <speak> sub-elements (optional)
Voice sequence library document node