1.1 What is XG?

↓bottom↓   ↑Menu↑   ↑top↑

Doom has a number of hard-coded line and sector types, each of which are programmed to do certain effects like lower a lift, open a door or, in the sectors' case, perhaps just to blink randomly. They were designed to be used in the game's own maps and thus do not provide the best possible selection of effects for your ones.

Xg line types separate the activation method, requirements and the effects of the line. It is possible to create 'chains' of line types, which effectively combine many types of line into one. Chains are a very important part of Xg lines and sectors. Often it is easiest to define several line types, each for a certain function, and then chain them up behind a single type, which is then used in the map.

Xg sector types define the physical characteristics of a sector, like light level and color, wind and gravity, and a number of chains that are activated under certain circumstances. Like with lines, sector chains refer to line types. This means all the things that are possible to do by changing the state of lines are also possible to do with sectors.

Xg line and sector types are entirely separate from the original Doom types. Both the extended and the standard types can be used in a map.

 1.2 requirements

↓bottom↓   ↑Menu↑   ↑top↑

You need a version of Doom (Heretic, Hexen) which supports the Xg specification as described in this document. At the moment the only such version is my Doom port, jDoom (http://jdoom.newdoom.com/) version 1.1 or newer.

 1.3 defining xg data

↓bottom↓   ↑Menu↑   ↑top↑

With the Doomsday engine Xg line and sector types are defined with DEd files. Once loaded, the Xg definitions can be dumped into a binary file using the console command "dumpxg". The file can then be merged into a WAd with the lump name of DDXGDATA. This is recommended for people who distribute their maps that contain Xg data. The information in the DDXGDATa lump overrides that in the DEd files.

 2 line types

↓bottom↓   ↑Menu↑   ↑top↑

An Xg line is a normal Doom line whose type is set to an Xg line type. Xg lines can either be active or inactive. It is possible to disable an Xg line, which means the line will be skipped in all event processing and the line’s timer will not be incremented.

Line types are divided into various classes, which define what the line does. The function of a line is executed either when the line is activated or deactivated (or both) or by some other means, which we will go into a bit later on. Some examples of line classes include Plane Move (ltc_plane_move), End Level (ltc_end_level) and Wall Texture Change (ltc_wall_texture). Adding new line classes won’t break backwards compatibility.

An Xg line type definition begins like this:

Line Type {
  ID = 5000;  # A unique ID number.

a unique Id number is required for each line type. It is the actual type number that will be used in a level editor.

 2.1 Activation and deactivation

↓bottom↓   ↑Menu↑   ↑top↑

a line can be activated and deactivated in various ways. They are based on line events, which occur under certain circumstances. In most cases events have an activator, which is the thing (map object; mobj) that triggered the event. These kinds of events include Use, Shoot, Cross and Touch events, which will take place when a thing uses, shoots, crosses or touches the line (collides with it). There are also Ticker and Chain events. The former is sent by the game ticker (up to 35 times per second) and the latter by a line or a sector. Events will activate inactive lines and deactivate active ones.

a line type can specify several requirements that must be met for the activation or deactivation of the line to succeed. These include for instance event type, a counter (as in “line can be activated n times”), activator type (player, missile, etc.) and any combination of keys possessed by the activator.

Many things can happen when a line is activated or deactivated. The most important one is the execution of the line’s function. Other things include showing of messages, playing sounds, changing the texture of the line (handy for switches) and sending chain events.

The activation type of a line specifies how the line behaves. DEd definitions of the five activation types available are listed below.

Flag { ID = “lat_timed_off”; }
Flag { ID = “lat_timed_on”;       Value = 0x1; }
Flag { ID = “lat_flip”;           Value = 0x2; }
Flag { ID = “lat_flip_timed_off”; Value = 0x3; }
Flag { ID = “lat_flip_timed_on”;  Value = 0x4; }

 2.1.1 lat_timed_off

↓bottom↓   ↑Menu↑   ↑top↑

Line can be activated if it’s inactive. Once activated, it will remain in that state for a given period of time, after which it will automatically deactivate itself. Line can’t be deactivated with events.

 2.1.2 lat_timed_on

↓bottom↓   ↑Menu↑   ↑top↑

Line can be deactivated if it’s active. Once deactivated, it will remain in that state for a given period of time, after which it will automatically activate itself. Line can’t be activated with events (i.e. this is the reverse of lat_timed_off ).

 2.1.3 lat_flip

↓bottom↓   ↑Menu↑   ↑top↑

Line can be activated and deactivated with events at any time. There is no automatical time-based activation or deactivation.

 2.1.4 lat_flip_timed_off

↓bottom↓   ↑Menu↑   ↑top↑

Line can be activated and deactivated with events at any time. Once activated, the line will deactivate itself after a given period of time.

 2.1.5 lat_flip_timed_on

↓bottom↓   ↑Menu↑   ↑top↑

Line can be activated and deactivated with events at any time. Once deactivated, the line will activate itself after a given period of time.

 2.2 Chains

↓bottom↓   ↑Menu↑   ↑top↑

Line types can be chained. This means different line types can be combined. This is necessary for some effects that require more than one line class at the same time. A line can have three chains: activation, deactivation and event chain. Chains are always line type IDs. As an example let’s say that a line has the activation chain 5120. When the line is activated, it will send a Chain event to itself before its class’s function gets executed. During the processing of the Chain event the line is treated just like it were of type 5120.

Event chains work a bit differently. If a line has an event chain, any events sent to the line will first be processed treating the line as it were of the type specified by the chain. If the event passes (it meets the requirements of the chained type) further processing won’t be done. In effect this allows having alternate functions and activation methods and requirements for a line.

When Chain events are processed, their activator is the same as the activator of the event that sent the Chain (or in other words, the most recent activator associated with the line).

A door that closes automatically is a good example of where chains are needed. The door line type’s activation chain would move the ceiling of the tagged sector to some reasonable height, like to the lowest adjacent ceiling height with an offset of –4. The deactivation chain could alternatively move the ceiling back to its original height or move it to the same height with the floor of the sector, thus closing the door.

  2.3 References

↓bottom↓   ↑Menu↑   ↑top↑

In order to provide extended functionality, lines, planes (floors and ceilings) and sectors need to refer to each other in some way. With standard Doom line types this is typically done with tag numbers, so that the lines and sectors sharing the same tag will participate in the execution of a line’s function.

All references except sector-plane and light level references are composed of two parts: a type and a data component. Some types of references have no use for the data component. Sector-plane and light level references only include the type.

 2.3.1 line references (lref)

↓bottom↓   ↑Menu↑   ↑top↑

Line references or lrefs are actually line-line references. They are used when a line needs to refer to a line or a group of lines. DED definitions of the lref types are listed below.

Flag { ID = “lref_self”; }
Flag { ID = “lref_tagged”;      Value = 0x1; }
Flag { ID = “lref_line_tagged”; Value = 0x2; }
Flag { ID = “lref_act_tagged”;  Value = 0x3; }
Flag { ID = “lref_index”;       Value = 0x4; }
Flag { ID = “lref_all”;         Value = 0x5; }

Flag { ID = “lpref_none”; }
Flag { ID = “lpref_my_floor”;             Value = 0x1; }
Flag { ID = “lpref_tagged_floors”;        Value = 0x2; }
Flag { ID = “lpref_line_tagged_floors”;   Value = 0x3; }
Flag { ID = “lpref_act_tagged_floors”;    Value = 0x4; }
Flag { ID = “lpref_index_floor”;          Value = 0x5; }
Flag { ID = “lpref_all_floors”;           Value = 0x6; }
Flag { ID = “lpref_my_ceiling”;           Value = 0x7; }
Flag { ID = “lpref_tagged_ceilings”;      Value = 0x8; }
Flag { ID = “lpref_line_tagged_ceilings”; Value = 0x9; }
Flag { ID = “lpref_act_tagged_ceilings”;  Value = 0xA; }
Flag { ID = “lpref_index_ceiling”;        Value = 0xB; }
Flag { ID = “lpref_all_ceilings”;         Value = 0xC; }
Flag { ID = “lpref_special”;              Value = 0xD; }

Flag { ID = “lsref_my”;          Value = 0x1; }
Flag { ID = “lsref_tagged”;      Value = 0x2; }
Flag { ID = “lsref_line_tagged”; Value = 0x3; }
Flag { ID = “lsref_act_tagged”;  Value = 0x4; }
Flag { ID = “lsref_index”;       Value = 0x5; }
Flag { ID = “lsref_all”;         Value = 0x6; }

Flag { ID = “spref_none”; }
Flag { ID = “spref_my_floor”;             Value = 0x1; }
Flag { ID = “spref_my_ceiling”;           Value = 0x2; }
Flag { ID = “spref_original_floor”;       Value = 0x3; }
Flag { ID = “spref_original_ceiling”;     Value = 0x4; }
Flag { ID = “spref_current_floor”;        Value = 0x5; }
Flag { ID = “spref_current_ceiling”;      Value = 0x6; }
Flag { ID = “spref_highest_floor”;        Value = 0x7; }
Flag { ID = “spref_highest_ceiling”;      Value = 0x8; }
Flag { ID = “spref_lowest_floor”;         Value = 0x9; }
Flag { ID = “spref_lowest_ceiling”;       Value = 0xA; }
Flag { ID = “spref_next_highest_floor”;   Value = 0xB; }
Flag { ID = “spref_next_highest_ceiling”; Value = 0xC; }
Flag { ID = “spref_next_lowest_floor”;    Value = 0xD; }
Flag { ID = “spref_next_lowest_ceiling”;  Value = 0xE; }
Flag { ID = “spref_min_bottom_texture”;   Value = 0xF; }
Flag { ID = “spref_min_mid_texture”;      Value = 0x10; }
Flag { ID = “spref_min_top_texture”;      Value = 0x11; }
Flag { ID = “spref_max_bottom_texture”;   Value = 0x12; }
Flag { ID = “spref_max_mid_texture”;      Value = 0x13; }
Flag { ID = “spref_max_top_texture”;      Value = 0x14; }

Flag { ID = “lightref_none”; }
Flag { ID = “lightref_my”;           Value = 0x1; }
Flag { ID = “lightref_original”;     Value = 0x2; }
Flag { ID = “lightref_current”;      Value = 0x3; }
Flag { ID = “lightref_highest”;      Value = 0x4; }
Flag { ID = “lightref_lowest”;       Value = 0x5; }
Flag { ID = “lightref_next_highest”; Value = 0x6; }
Flag { ID = “lightref_next_lowest”;  Value = 0x7; }

 2.4 the line type definition

↓bottom↓   ↑Menu↑   ↑top↑

Below you’ll find the description for each value in a DED Line Type definition. Values of type “flags” are strings that will be evaluated to an integer when the DED file is read.

 2.4.1 id

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer

A unique integer number identifying this line type. The value is used in level editors to refer to this type. Note that XG line types take precedence, so if the ID number is the same as that of a normal Doom line type, the XG version will be used. IDs must be in range from 1 to 65535.

 2.4.2 comment

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

The Comment property was added to make it easier to manage line types. DED Manager will show this comment in the lookup dropdown lists and in the information section of the main index, but Doomsday itself does not use this string for anything. It’s a good idea to make the Comment a short description of what the line type does, for instance:

Comment = “A/Lower LT ceil to next lowest”;

This would suggest that when activated the line will lower the ceiling of the sectors with a matching tag number to their next lowest adjacent ceiling.

 2.4.3 flags

↓bottom↓   ↑Menu↑   ↑top↑

Type: flags

There are several flags that are used to control various aspects about the line type, including activation method and requirements and the time to execute the line’s function. The Flags property uses the flag definitions that begin with ltf_ .

 2.4.5 flags3

↓bottom↓   ↑Menu↑   ↑top↑

Type: flags

Reserved for future extensions.

 2.4.6 class

↓bottom↓   ↑Menu↑   ↑top↑

Type: flags

Sets the class of the line. Each class performs a specific function (see Classes). Only one of the ltc_ flags is allowed. Usage of integer parameters Ip0, Ip1, Ip2…Ip19, floating point parameters Fp0, Fp1, Fp2…Fp19 and string parameters Sp0, Sp1…Sp4 varies depending on the value of this property.

 2.4.7 type

↓bottom↓   ↑Menu↑   ↑top↑

Type: flags

Activation type of the line. One of the following values:

lat_timed_off
lat_timed_on
lat_flip
lat_flip_timed_off
lat_flip_timed_on

See for a description of the types.

 2.4.8 count

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer

Initial value for the line’s counter, which is decremented every time the line successfully processes an event that is not a Chain event. Once the counter reaches zero all events will fail. A negative value for this property means the counter is disabled, and won’t be checked during the line’s event processing.

 2.4.9 time

↓bottom↓   ↑Menu↑   ↑top↑

Type: float

Time to stay active or inactive, in seconds. Used with lat_timed_* and lat_flip_timed_* activation types.

 2.4.10 act tag

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer

Activation tag number of this line type. Several types can have the same activation tag. This number can be used in line references (with for instance lref_act_tagged ). All signed 32-bit integer values are accepted.

 2.4.11 health above

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap0

Type: integer

Activation parameter 0. Activator health must be above this if the ltf2_health_above flag is set.

 2.4.12 health below

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap1

Type: integer

Activation parameter 1. Activator health must be below this if the ltf2_health_below flag is set.

 2.4.13 power above

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap2

Type: integer

Activation parameter 2. Activator power (armor) must be above this if the ltf2_power_above flag is set.

 2.4.14 power below

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap3

Type: integer

Activation parameter 3. Activator power (armor) must be below this if the ltf2_power_below flag is set.

 2.4.15 line act lref

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap4

Type: flags

Reference to the lines that must be active for the activation or deactivation of this line to succeed. This property sets the type of the line reference. (See References) The value must be one of the Flag definitions that begin with lref_ . Only used with the ltf2_line_act flag.

 2.4.16 line act lrefd

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap5

Type: integer

Data component of the reference to the required active lines. (See References) Only used with the ltf2_line_act flag.

 2.4.17 line inact lref

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap6

Type: flags

Reference to the lines that must be inactive for the activation or deactivation of this line to succeed. This property sets the type of the line reference. (See References) The value must be one of the Flag definitions that begin with lref_ . Only used with the ltf2_line_inact flag.

 2.4.18 line inact lrefd

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap7

Type: integer

Data component of the reference to the required inactive lines. (See References) Only used with the ltf2_line_inact flag.

 2.4.19 color

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap8

Type: integer

Activation parameter 8. Used with the ltf2_color flag. Specifies the required player color of the activator.

 2.4.20 thing type

↓bottom↓   ↑Menu↑   ↑top↑

Alternative: Ap9

Type: string

Activation parameter 9. Used with the ltf2_mobj_gone flag. Specifies the type of thing the flag refers to. ID of the thing type (for example POSSESSED). Case sensitive.

 2.4.21 ticker start time

↓bottom↓   ↑Menu↑   ↑top↑

Type: float

Number of seconds measured from the beginning of the level to start processing Ticker events for the line.

 2.4.22 ticker end time

↓bottom↓   ↑Menu↑   ↑top↑

Type: float

Number of seconds measured from the beginning of the level to stop processing Ticker events for the line. If this value is less than or equal to zero, the processing of Ticker events will continue indefinitely.

 2.4.23 ticker tics

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer

Interval between consecutive Ticker events, in 35 Hz game tics. A value of zero means a Ticker event is sent on every tick, i.e. 35 times per second.

 2.4.24 event chain

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer

Event chain for this type of lines (see Chains). ID number of an XG line type.

 2.4.25 act chain

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer

Activation chain for this type of lines (see Chains). ID number of an XG line type.

 2.4.26 deact chain

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer

Deactivation chain for this type of lines (see Chains). ID number of an XG line type.

 2.4.27 wall section

↓bottom↓   ↑Menu↑   ↑top↑

Type: flags

Accepted values:

lws_none
lws_mid
lws_upper
lws_lower

Defines which part of the line is affected by Act texture and Deact texture. Combining the values is not allowed, so Act texture and Deact texture can only be used to change one part of the wall. Note that any textures of the line that begin withSW1 orSW2 (switch textures) are automatically swapped with their counterparts when the line is activated or deactivated, regardless of the Wall section setting.

 2.4.28 act texture

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

Name of the texture to set to the section of the line specified with Wall section when the line is activated. Note that any textures of the line that begin withSW1 orSW2 (switch textures) are automatically swapped with their counterparts when the line is activated or deactivated, regardless of the Act texture property.

 2.4.29 deact texture

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

Name of the texture to set to the section of the line specified with Wall section when the line is deactivated. Note that any textures of the line that begin withSW1 orSW2(switch textures) are automatically swapped with their counterparts when the line is activated or deactivated, regardless of the Deact texture property.

 2.4.30 act sound

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

ID of the sound that will be played when the line is activated. The sound will appear to originate from the center of the sector where the line belongs to.

 2.4.31 deact sound

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

ID of the sound that will be played when the line is deactivated. The sound will appear to originate from the center of the sector where the line belongs to.

 2.4.32 act message

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

Message that will be sent to the activator of the line. If the ltf2_global_a_msg flag is set, the message will be sent to all players in the game. If the activator is a missile, its originator will receive the message.

 2.4.33 deact message

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

Message that will be sent to the deactivator of the line. If the ltf2_global_d_msg flag is set, the message will be sent to all players in the game. If the activator is a missile, its originator will receive the message.

 2.4.34 texmove angle

↓bottom↓   ↑Menu↑   ↑top↑

Type: float

Direction to scroll the texture of the line, given in degrees: 0=right, 90=up, 180=left and 270=down. All floating-point values are accepted, though, even negative ones.

 2.4.35 texmove speed

↓bottom↓   ↑Menu↑   ↑top↑

Type: float

Speed of texture scrolling as pixels per game tic (35 Hz). The speed of 2 would scroll the texture 70 pixels per second.

 2.4.36 ip0 ... ip19

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer or string

Integer or string parameters (which will be translated to various integer values) for the line’s function. Usage depends on the class of the line.

 2.4.37 fp0 ... fp19

↓bottom↓   ↑Menu↑   ↑top↑

Type: float

Floating point parameters for the line’s function. Usage depends on the class of the line.

 2.4.38 sp0 ... sp4

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

String parameters for the line’s function. Usage depends on the class of the line.

  2.5 Classes

↓bottom↓   ↑Menu↑   ↑top↑

The class of a lie type defines its function. Each type belongs to a single class and thus performs only one function, like initiating a plane move or changing the type of a sector. The Class property of the DED Line Type definition selects the class to use. DED definitions of the available line classes are listed below.

Flag { ID = “ltc_none”; }
Flag { ID = “ltc_chain_sequence”;    Value = 0x1; }
Flag { ID = “ltc_plane_move”;        Value = 0x2; }
Flag { ID = “ltc_build_stairs”;      Value = 0x3; }
Flag { ID = “ltc_damage”;            Value = 0x4; }
Flag { ID = “ltc_power”;             Value = 0x5; }
Flag { ID = “ltc_line_type”;         Value = 0x6; }
Flag { ID = “ltc_sector_type”;       Value = 0x7; }
Flag { ID = “ltc_sector_light”;      Value = 0x8; }
Flag { ID = “ltc_activate”;          Value = 0x9; }
Flag { ID = “ltc_key”;               Value = 0xA; }
Flag { ID = “ltc_music”;             Value = 0xB; }
Flag { ID = “ltc_sound”;             Value = 0x14; }
Flag { ID = “ltc_line_count”;        Value = 0xC; }
Flag { ID = “ltc_end_level”;         Value = 0xD; }
Flag { ID = “ltc_disable_if_active”; Value = 0xE; }
Flag { ID = “ltc_enable_if_active”;  Value = 0xF; }
Flag { ID = “ltc_explode”;           Value = 0x10; }
Flag { ID = “ltc_plane_texture”;     Value = 0x11; }
Flag { ID = “ltc_wall_texture”;      Value = 0x12; }
Flag { ID = “ltc_command”;           Value = 0x13; }

Note to people who will modify the source code and add new line classes: start using numbers from 0x10000. Classes 0 to 0xFFFF will be reserved for standardized use as specified in this document.

 2.5.1 ltc_none

↓bottom↓   ↑Menu↑   ↑top↑

The line does nothing.

 3 sector types

↓bottom↓   ↑Menu↑   ↑top↑

An XG sector is a normal Doom sector whose type is an XG sector type. XG sectors have special physics processing for wind, customized gravity and friction. Each sector has a number of chains that are used to define extended functionality. Note that sector chains refer to line types, so anything that can be achieved with line types can also be done with sectors. For instance, if you want a sector to damage all the things touching its floor, you would set the sector type’s floor chain to a line type that deals damage.

 3.1 physics

↓bottom↓   ↑Menu↑   ↑top↑

 3.1.1 Wind

↓bottom↓   ↑Menu↑   ↑top↑

Wind increases the momentum of things inside a sector. Wind speed is defined as the increase in momentum per game tic. There are two kinds of wind: horizontal and vertical. Horizontal wind pushes things on the XY plane to a given direction specified with an angle. Vertical wind affects Z momentum. Standard Doom gravity corresponds a vertical wind of –1. Wind can be configured to only affect certain types of map objects.

If you want to synchronize wind speed with a scrolling texture (for instance to create the illusion that a scrolling floor is moving the player around), use the following equation (fis the sector friction).

 3.1.2 gravity

↓bottom↓   ↑Menu↑   ↑top↑

Gravity pulls things downwards. A sector type can define a custom gravity, which is used for all things inside the sector. Standard gravity is one (1).

 3.1.3 friction

↓bottom↓   ↑Menu↑   ↑top↑

The friction of a sector determines how easy it is to change the momentum of things that touch the floor of the sector. Friction is defined as a floating point number in range 0 to 1. The lower the number, the larger the friction seems. Each game tic (35 times per second) the momentum of the mobjs that touch the floor of the sector is multiplied by the friction value. This means if the friction is set to one, the momentum of the things inside the sector won’t decrease at all.

As friction decreases (the value is nearing one), it becomes harder and harder to change the momentum of things, i.e. to accelerate or decelerate. The graph shows how momentum changes are scaled.

  3.2 Chains

↓bottom↓   ↑Menu↑   ↑top↑

Each XG sector type has four chains: the floor, ceiling, inside and ticker chain. Like with lines, chains are always line type IDs. The floor chain is processed when a map object of a given type is touching the floor: a chain event whose originator is the object in question is sent to a temporary line that appears to belong to the sector. The ceiling chain works similarly, but is processed when an object is touching the ceiling. The inside chain is processed for all objects inside the sector. The ticker chain is processed up to 35 times per second. For the ticker chain there is no event originator.

Each chain can be configured to only affect certain types of things (player, monster, missile, etc.). Also, each chain has a start time and an end time, which define when the chain is operating. The rate at which to send the Chain events can be set as a min/max interval pair. Each chain has a counter that can be used to limit the number of times the chain can be processed. If the counter is greater than zero, it will be decremented every time a Chain event is successfully processed.

The chains can be configured to send activating or deactivating events. Internally, this means the temporary line that receives the events is initially inactive or active, respectively. The temporary line is set up as follows: it is a one-sided line, whose front sector is the sector the chain belongs to. It has no sidedefs, so operations that modify the sides of the line (Act texture, for instance) have no effect. The line’s type is equal to the chain being processed (for example 5210). The line’s tag number is equal to the sector’s tag number.

As an example, a sector type that deals one point of damage to all players inside the sector once per second would be set up in the following way. The floor chain would be a line type that, when activated, deals a point of damage to its activator. Flags for the floor chain would be scef_player_a, which causes an activating Chain event to be sent for player mobjs. The floor chain counter would be set to –1 to allow the chain to work indefinitely. Both the min and max intervals for the chain would be one.

 3.3 Functions

↓bottom↓   ↑Menu↑   ↑top↑

Sector functions (XG functions) are functions in a mathematical sense. They evaluate to a number that might change as time goes by. XG functions are strings. Some characters are interpreted as control characters and others represent values from zero to one. XG sectors can use functions to change their light level, color, the height of the floor and ceiling planes and to send Chain events.

 3.3.2 evaluation of functions

↓bottom↓   ↑Menu↑   ↑top↑

The first actual symbol of a (non-linked) function string must be a value (an uppercase or a lowercase letter or an exact value). It is the initial value of the function.

Each value symbol defines a step. The evaluator advances to the next step when the timer for the current one reaches zero. The type definition specifies the minimum and maximum number of tics for each step. If the step timer isn’t set with the # or ? symbols, it will be set to a random number between the minimum and maximum tics for each step. Interpolation is always done between the current step and the next one. If both are interpolateable (lowercase letter or an exact value defined with a slash / ) the value of the function will gradually blend from the current step’s value to the next one’s.

The current value of a step will be multiplied with a scaling factor and an offset will be added. Acceptable values for the function depend on the context: for example, light and color functions are automatically scaled with 255 and have no offset. The floor and ceiling functions’ scale and offset can be specified in the type definition.

Examples:

 3.4 the sector type definition

↓bottom↓   ↑Menu↑   ↑top↑

 3.4.1 id

↓bottom↓   ↑Menu↑   ↑top↑

Type: integer

A unique integer number identifying this sector type. The value is used in level editors to refer to this type. Note that XG sector types take precedence, so if the ID number is the same as that of a normal Doom sector type, the XG version will be used. IDs must be in range from 1 to 65535.

 3.4.2 comment

↓bottom↓   ↑Menu↑   ↑top↑

Type: string

DED Manager will show this comment in the lookup dropdown lists and in the information section of the main index, but Doomsday itself does not use this string for anything. It’s a good idea to make the Comment a short description of what the sector type does.

 4 examples

↓bottom↓   ↑Menu↑   ↑top↑

 4.1 line types

↓bottom↓   ↑Menu↑   ↑top↑

Line Type
{ ID        = 6101;
  Flags2    = "ltf2_when_deact ltf2_when_act ltf2_any";
  Class     = "ltc_sector_light";
  Type      = "lat_flip";
  Count     = -1;
  Ip0       = "lpref_line_tagged_floors";
  Ip2       = 1;
  Ip3       = 1;
  Ip4       = "lightref_original";
  Ip6       = "lightref_original";
}

Restores the light level and color of the sectors that have the same tag number as the line to their original values, when the line is activated or deactivated. The line can only be activated with Chain events (no activation method is specified). Game mode and skill level have no effect. The line can be activated an infinite number of times (count is –1). Note that a line-plane reference is used to refer to whole sectors. This can be done because lpref_line_tagged_floors is actually the same as lsref_line_tagged.

Line Type
{ ID        = 5070;
  Flags     = "ltf_player_use";
  Flags2    = "ltf2_when_act ltf2_any";
  Class     = "ltc_wall_texture";
  Type      = "lat_timed_off";
  Count     = 1;
  Time      = 1;
  Act sound = "swtchn";
  Ip0       = "lref_all";
  Ip3       = "SP_FACE1";
  Ip4       = "SP_FACE1";
  Ip5       = "SP_FACE1";
}

The line can be activated with player Use events. Game mode and skill level have no effect. The line is initially inactive and once activated it stays active for one second after which it deactivates itself. When activated, the upper, lower and middle textures of the front side of all lines in the map are changed toSP_FACE1. The standard Doom switch soundswtchn is played upon activation. The line can only be activated once.

Line Type
{ ID            = 5006;
  Comment       = "Lower when Poss gone";
  Flags         = "ltf_mobj_gone ltf_ticker";
  Flags2        = "ltf2_when_act ltf2_any";
  Class         = "ltc_plane_move";
  Type          = "lat_timed_off";
  Count         = 1;
  Time          = 1;
  Thing type    = "POSSESSED";
  Ticker tics   = 5;
  Texmove angle = 90;
  Texmove speed = 1;
  Ip0           = "lpref_my_floor";
  Ip2           = "spref_lowest_floor";
  Ip3           = "pmf_follow pmf_crush";
  Ip4           = "bdopn";
  Ip5           = "bdcls";
  Ip6           = "punch";
  Ip10          = "HCSKULL1";
  Fp0           = 3;
  Fp1           = 0.2;
  Fp3           = 0.2;
  Fp4           = 0.4;
}

The line is activated by the game ticker. Activation will only succeed if all the things whose type is POSSESSED have died or been removed from the map. Game mode and skill level have no effect. When activated, the line begins moving the floor plane of its sector. The destination height is the lowest floor height of the adjacent sectors. The ceiling of the sector will follow at a fixed distance from the floor, so the height of the sector won’t change. The sector would crush things if they got in the way. The soundbdopn is played when the move is begun, andbdcls is played when the destination height has been reached. Thepunch sound is played at random intervals while the plane is moving (min: 0.2 seconds, max: 0.4 seconds). The planes will be moved 3 units per game tic, which means they move 105 units per second. In the end of the move the textureHCSKULL1 is applied to the floor.

 4.2 sector types

↓bottom↓   ↑Menu↑   ↑top↑

Sector Type
{ ID      = 5001;
  Comment = "Scroll along tag 9999";
  Flags   = "stf_tagtexmove stf_tagwind stf_windmissile stf_windplayer";
  Act tag = 9999;
  Floor texmove speed = 1.8;
  Wind speed = 0.16875;
}

The sector has a scrolling floor and wind that affects player mobjs and missiles. The wind is blowing in the same direction as the floor scrolls, which is the direction the sector’s line that has the tag 9999 is pointing. Wind speed has been synchronized with the scrolling speed, so it appears that the floor is moving and moves the player with it.

Sector Type
{ ID           = 5002;
  Ticker chain = 6101;
  Ticker chain count = 1;
}

The sector will immediately send the Chain event 6101. It will only be sent once. If the definition of 6101 that was listed in the line type examples is used, this sector type could be used to restore the original light level and color of a sector.

 5 definitions

↓bottom↓   ↑Menu↑   ↑top↑

 5.1 line types

↓bottom↓   ↑Menu↑   ↑top↑

Flag { ID = “ltc_none”; }
Flag { ID = “ltc_chain_sequence”;         Value = 0x1; }
Flag { ID = “ltc_plane_move”;             Value = 0x2; }
Flag { ID = “ltc_build_stairs”;           Value = 0x3; }
Flag { ID = “ltc_damage”;                 Value = 0x4; }
Flag { ID = “ltc_power”;                  Value = 0x5; }
Flag { ID = “ltc_line_type”;              Value = 0x6; }
Flag { ID = “ltc_sector_type”;            Value = 0x7; }
Flag { ID = “ltc_sector_light”;           Value = 0x8; }
Flag { ID = “ltc_activate”;               Value = 0x9; }
Flag { ID = “ltc_key”;                    Value = 0xA; }
Flag { ID = “ltc_music”;                  Value = 0xB; }
Flag { ID = “ltc_sound”;                  Value = 0x14; }
Flag { ID = “ltc_line_count”;             Value = 0xC; }
Flag { ID = “ltc_end_level”;              Value = 0xD; }
Flag { ID = “ltc_disable_if_active”;      Value = 0xE; }
Flag { ID = “ltc_enable_if_active”;       Value = 0xF; }
Flag { ID = “ltc_explode”;                Value = 0x10; }
Flag { ID = “ltc_plane_texture”;          Value = 0x11; }
Flag { ID = “ltc_wall_texture”;           Value = 0x12; }
Flag { ID = “ltc_command”;                Value = 0x13; }
Flag { ID = “ltf_active”;                 Value = 0x1; }
Flag { ID = “ltf_player_use_a”;           Value = 0x2; }
Flag { ID = “ltf_other_use_a”;            Value = 0x4; }
Flag { ID = “ltf_player_shoot_a”;         Value = 0x8; }
Flag { ID = “ltf_other_shoot_a”;          Value = 0x10; }
Flag { ID = “ltf_any_cross_a”;            Value = 0x20; }
Flag { ID = “ltf_monster_cross_a”;        Value = 0x40; }
Flag { ID = “ltf_player_cross_a”;         Value = 0x80; }
Flag { ID = “ltf_missile_cross_a”;        Value = 0x100; }
Flag { ID = “ltf_player_hit_a”;           Value = 0x200; }
Flag { ID = “ltf_other_hit_a”;            Value = 0x400; }
Flag { ID = “ltf_monster_hit_a”;          Value = 0x800; }
Flag { ID = “ltf_missile_hit_a”;          Value = 0x1000; }
Flag { ID = “ltf_any_hit_a”;              Value = 0x2000; }
Flag { ID = “ltf_player_use_d”;           Value = 0x4000; }
Flag { ID = “ltf_other_use_d”;            Value = 0x8000; }
Flag { ID = “ltf_player_shoot_d”;         Value = 0x10000; }
Flag { ID = “ltf_other_shoot_d”;          Value = 0x20000; }
Flag { ID = “ltf_any_cross_d”;            Value = 0x40000; }
Flag { ID = “ltf_monster_cross_d”;        Value = 0x80000; }
Flag { ID = “ltf_player_cross_d”;         Value = 0x100000; }
Flag { ID = “ltf_missile_cross_d”;        Value = 0x200000; }
Flag { ID = “ltf_player_hit_d”;           Value = 0x400000; }
Flag { ID = “ltf_other_hit_d”;            Value = 0x800000; }
Flag { ID = “ltf_monster_hit_d”;          Value = 0x1000000; }
Flag { ID = “ltf_missile_hit_d”;          Value = 0x2000000; }
Flag { ID = “ltf_any_hit_d”;              Value = 0x4000000; }
Flag { ID = “ltf_player_use”;             Value = 0x4002; }
Flag { ID = “ltf_other_use”;              Value = 0x8004; }
Flag { ID = “ltf_player_shoot”;           Value = 0x10008; }
Flag { ID = “ltf_other_shoot”;            Value = 0x20010; }
Flag { ID = “ltf_any_cross”;              Value = 0x40020; }
Flag { ID = “ltf_monster_cross”;          Value = 0x80040; }
Flag { ID = “ltf_player_cross”;           Value = 0x100080; }
Flag { ID = “ltf_missile_cross”;          Value = 0x200100; }
Flag { ID = “ltf_player_hit”;             Value = 0x400200; }
Flag { ID = “ltf_other_hit”;              Value = 0x800400; }
Flag { ID = “ltf_monster_hit”;            Value = 0x1000800; }
Flag { ID = “ltf_missile_hit”;            Value = 0x2001000; }
Flag { ID = “ltf_any_hit”;                Value = 0x4002000; }
Flag { ID = “ltf_ticker_a”;               Value = 0x8000000; }
Flag { ID = “ltf_ticker_d”;               Value = 0x10000000; }
Flag { ID = “ltf_ticker”;                 Value = 0x18000000; }
Flag { ID = “ltf_mobj_gone”;              Value = 0x20000000; }
Flag { ID = “ltf_no_other_use_secret”;    Value = 0x40000000; }
Flag { ID = “ltf_activator_type”;         Value = 0x80000000; }
Flag { ID = “ltf2_when_act”;              Value = 0x1; }
Flag { ID = “ltf2_when_deact”;            Value = 0x2; }
Flag { ID = “ltf2_when_last”;             Value = 0x10; }
Flag { ID = “ltf2_while_act”;             Value = 0x4; }
Flag { ID = “ltf2_while_inact”;           Value = 0x8; }
Flag { ID = “ltf2_key1”;                  Value = 0x20; }
Flag { ID = “ltf2_key2”;                  Value = 0x40; }
Flag { ID = “ltf2_key3”;                  Value = 0x80; }
Flag { ID = “ltf2_key4”;                  Value = 0x100; }
Flag { ID = “ltf2_key5”;                  Value = 0x200; }
Flag { ID = “ltf2_key6”;                  Value = 0x400; }
Flag { ID = “ltf2_line_act”;              Value = 0x800; }
Flag { ID = “ltf2_line_inact”;            Value = 0x1000; }
Flag { ID = “ltf2_color”;                 Value = 0x2000; }
Flag { ID = “ltf2_health_above”;          Value = 0x4000; }
Flag { ID = “ltf2_health_below”;          Value = 0x8000; }
Flag { ID = “ltf2_power_above”;           Value = 0x10000; }
Flag { ID = “ltf2_power_below”;           Value = 0x20000; }
Flag { ID = “ltf2_singleplayer”;          Value = 0x40000; }
Flag { ID = “ltf2_cooperative”;           Value = 0x80000; }
Flag { ID = “ltf2_deathmatch”;            Value = 0x100000; }
Flag { ID = “ltf2_any_mode”;              Value = 0x1C0000; }
Flag { ID = “ltf2_easy”;                  Value = 0x200000; }
Flag { ID = “ltf2_med”;                   Value = 0x400000; }
Flag { ID = “ltf2_hard”;                  Value = 0x800000; }
Flag { ID = “ltf2_any_skill”;             Value = 0xE00000; }
Flag { ID = “ltf2_any”;                   Value = 0xFC0000; }
Flag { ID = “ltf2_multiple”;              Value = 0x1000000; }
Flag { ID = “ltf2_2sided”;                Value = 0x2000000; }
Flag { ID = “ltf2_global_a_msg”;          Value = 0x4000000; }
Flag { ID = “ltf2_global_d_msg”;          Value = 0x8000000; }
Flag { ID = “ltf2_global_msg”;            Value = 0xC000000; }
Flag { ID = “lat_timed_off”; }            
Flag { ID = “lat_timed_on”;               Value = 0x1; }
Flag { ID = “lat_flip”;                   Value = 0x2; }
Flag { ID = “lat_flip_timed_off”;         Value = 0x3; }
Flag { ID = “lat_flip_timed_on”;          Value = 0x4; }
Flag { ID = “lws_none”; }                 
Flag { ID = “lws_mid”;                    Value = 0x1; }
Flag { ID = “lws_upper”;                  Value = 0x2; }
Flag { ID = “lws_lower”;                  Value = 0x3; }
Flag { ID = “lref_self”; }                
Flag { ID = “lref_tagged”;                Value = 0x1; }
Flag { ID = “lref_line_tagged”;           Value = 0x2; }
Flag { ID = “lref_act_tagged”;            Value = 0x3; }
Flag { ID = “lref_index”;                 Value = 0x4; }
Flag { ID = “lref_all”;                   Value = 0x5; }
Flag { ID = “lpref_none”; }               
Flag { ID = “lpref_my_floor”;             Value = 0x1; }
Flag { ID = “lpref_tagged_floors”;        Value = 0x2; }
Flag { ID = “lpref_line_tagged_floors”;   Value = 0x3; }
Flag { ID = “lpref_act_tagged_floors”;    Value = 0x4; }
Flag { ID = “lpref_index_floor”;          Value = 0x5; }
Flag { ID = “lpref_all_floors”;           Value = 0x6; }
Flag { ID = “lpref_my_ceiling”;           Value = 0x7; }
Flag { ID = “lpref_tagged_ceilings”;      Value = 0x8; }
Flag { ID = “lpref_line_tagged_ceilings”; Value = 0x9; }
Flag { ID = “lpref_act_tagged_ceilings”;  Value = 0xA; }
Flag { ID = “lpref_index_ceiling”;        Value = 0xB; }
Flag { ID = “lpref_all_ceilings”;         Value = 0xC; }
Flag { ID = “lpref_special”;              Value = 0xD; }
Flag { ID = “lsref_my”;                   Value = 0x1; }
Flag { ID = “lsref_tagged”;               Value = 0x2; }
Flag { ID = “lsref_line_tagged”;          Value = 0x3; }
Flag { ID = “lsref_act_tagged”;           Value = 0x4; }
Flag { ID = “lsref_index”;                Value = 0x5; }
Flag { ID = “lsref_all”;                  Value = 0x6; }
Flag { ID = “spref_none”; }               
Flag { ID = “spref_my_floor”;             Value = 0x1; }
Flag { ID = “spref_my_ceiling”;           Value = 0x2; }
Flag { ID = “spref_original_floor”;       Value = 0x3; }
Flag { ID = “spref_original_ceiling”;     Value = 0x4; }
Flag { ID = “spref_current_floor”;        Value = 0x5; }
Flag { ID = “spref_current_ceiling”;      Value = 0x6; }
Flag { ID = “spref_highest_floor”;        Value = 0x7; }
Flag { ID = “spref_highest_ceiling”;      Value = 0x8; }
Flag { ID = “spref_lowest_floor”;         Value = 0x9; }
Flag { ID = “spref_lowest_ceiling”;       Value = 0xA; }
Flag { ID = “spref_next_highest_floor”;   Value = 0xB; }
Flag { ID = “spref_next_highest_ceiling”; Value = 0xC; }
Flag { ID = “spref_next_lowest_floor”;    Value = 0xD; }
Flag { ID = “spref_next_lowest_ceiling”;  Value = 0xE; }
Flag { ID = “spref_min_bottom_texture”;   Value = 0xF; }
Flag { ID = “spref_min_mid_texture”;      Value = 0x10; }
Flag { ID = “spref_min_top_texture”;      Value = 0x11; }
Flag { ID = “spref_max_bottom_texture”;   Value = 0x12; }
Flag { ID = “spref_max_mid_texture”;      Value = 0x13; }
Flag { ID = “spref_max_top_texture”;      Value = 0x14; }
Flag { ID = “lightref_none”; }
Flag { ID = “lightref_my”;                Value = 0x1; }
Flag { ID = “lightref_original”;          Value = 0x2; }
Flag { ID = “lightref_current”;           Value = 0x3; }
Flag { ID = “lightref_highest”;           Value = 0x4; }
Flag { ID = “lightref_lowest”;            Value = 0x5; }
Flag { ID = “lightref_next_highest”;      Value = 0x6; }
Flag { ID = “lightref_next_lowest”;       Value = 0x7; }
Flag { ID = “chsf_done_d”;                Value = 0x1; }
Flag { ID = “chsf_loop”;                  Value = 0x2; }
Flag { ID = “pmf_crush”;                  Value = 0x1; }
Flag { ID = “pmf_abort_a”;                Value = 0x2; }
Flag { ID = “pmf_abort_d”;                Value = 0x4; }
Flag { ID = “pmf_done_a”;                 Value = 0x8; }
Flag { ID = “pmf_done_d”;                 Value = 0x10; }
Flag { ID = “pmf_follow”;                 Value = 0x20; }
Flag { ID = “pmf_setorig”;                Value = 0x40; }
Flag { ID = “pmf_1snd”;                   Value = 0x100; }

 5.2 sector types

↓bottom↓   ↑Menu↑   ↑top↑

Flag { ID = “stf_gravity”;                Value = 0x1; }
Flag { ID = “stf_friction”;               Value = 0x2; }
Flag { ID = “stf_crush”;                  Value = 0x4; }
Flag { ID = “stf_windplayer”;             Value = 0x8; }
Flag { ID = “stf_windother”;              Value = 0x10; }
Flag { ID = “stf_windmonster”;            Value = 0x20; }
Flag { ID = “stf_windmissile”;            Value = 0x40; }
Flag { ID = “stf_windany”;                Value = 0x18; }
Flag { ID = “stf_tagtexmove”;             Value = 0x80; }
Flag { ID = “stf_tagwind”;                Value = 0x100; }
Flag { ID = “stf_floorwind”;              Value = 0x200; }
Flag { ID = “stf_ceilingwind”;            Value = 0x400; }
Flag { ID = “scef_player_a”;              Value = 0x1; }
Flag { ID = “scef_other_a”;               Value = 0x2; }
Flag { ID = “scef_monster_a”;             Value = 0x4; }
Flag { ID = “scef_missile_a”;             Value = 0x8; }
Flag { ID = “scef_any_a”;                 Value = 0x10; }
Flag { ID = “scef_ticker_a”;              Value = 0x20; }
Flag { ID = “scef_player_d”;              Value = 0x40; }
Flag { ID = “scef_other_d”;               Value = 0x80; }
Flag { ID = “scef_monster_d”;             Value = 0x100; }
Flag { ID = “scef_missile_d”;             Value = 0x200; }
Flag { ID = “scef_any_d”;                 Value = 0x400; }
Flag { ID = “scef_ticker_d”;              Value = 0x800; }

XG Reference - End | new styled on Nov 2008 by Dieter Heinrich | (original)

xgref.php (lokal im Original-Style)

↑Menu↑   ↑top↑

Doomsday 1.8.6 | Last updated on Jan 18 2005