Modern features for Blood mappers
[Aug 18 2022]

This is off-line version! Please visit http://cruo.bloodgame.ru/xxsystem to stay updated!

The following features was made by NoOne and it's fully supported by NBlood and Raze source ports. The latest dev builds always available on https://lerppu.net/wannabethesis/nblood/latest/ (for NBlood) or https://devbuilds.drdteam.org/raze (for Raze).

I'm not against to add same features in all other existing ports and maintain it. If authors is interested, they can just mail me to baitd@yandex.ru or search for me in Discord channel dedicated to Blood so we can discuss it. Coders may also visit modern features on GitHub.

Hope this helps to make maps better than ever and generally turn map editing to the next level. Adding even more new features is planning as well. If you have any questions, problems, bug reports or suggestions, you may use contacts above to talk with me. The same you can do if you want to update, for instance, my "perfect" english in this documentation.

IMPORTANT! HOW TO ACTIVATE THE MODERN FEATURES

There is two ways to let the port(s) know that you are aiming for modern level design:

  1. Put an magic sprite in the map.

    1. Put an sprite.
    2. Press [ALT] + [F6] on it in 2d mode to edit it's properties.
    3. Set RX ID and TX ID to 60.
    4. Set Cmd to 100: 36.

  2. Enable save map file with new version in the editor.

    If you are using XMAPEDIT, you must open XMAPEDIT.INI, which usually can be found in XMAPEDIT directory, search for [General] section and change "SaveAsModernMap" value to 1. If you stick with PMAPEDIT, you must apply a patch that makes the edtor save the map with version 7.1. Note that using it is not recommended since is not supported anymore.

Changelog

  1. Aug 18 2022

  2. Mar 25 2022

  3. Aug 03 2021

  4. May 09 2020

  5. Jan 14 2020

    • Support of BloodGDX port is discontinued.
    • New modern type Player Control was added! It designed to change many various player properties right in the game. It can do:
      • Change movement speed and jump height.
      • Set player's look and rotate angles.
      • Play QAV animations instead of weapon or in fullscreen.
      • Play screen effects (delirium, pain, darkening and so on).
      • Copy properties of it's sprite to player sprite, so it's possible to use player RX channels.
      • Operate with inventory: give or erase weapons, items, keys and so on.
    • Player RX channels was added.
    • Update for Properties changer type.
    • Update for Effect Gen type.
    • Update for Resizer type.
    • Update for Damager type.
    • Update for Custom Dude Spawn type.
    • There is some cool features has been added for Custom dude
      • Dynamic dispersion.
      • Dynamic damage resistance.
      • Dynamic attack distance.
      • Much better behavior when attacking the target.

  6. Sep 09 2019

    • There was added physics control for PropertiesChanger type!
    • New features has been added for Path Marker type.
    • 1-way switch type now working for walls.
    • Teleport Target type can now be triggered!
    • New features has been added for Ecto Skull Gen (aka Missile Gen) type.
    • New features has been added for Data changer type.
    • New features has been added for Picture changer type.
    • New features has been added for Damager type.
    • New features has been added for SFX Gen.
    • New features has been added for RandomTX type.
    • New modern type Inc-Dec has been added.
    • New features for SEQ Spawner type.
    • New features for Effect Gen type.
    • Update and new features for Sector wind generator type.
    • New features for SequentialTX type.
    • Custom dude
      • Can have different mass: the bigger sprite and clipdist, the greater mass.
      • Can use custom clipdist (mass multiplier).
      • Can damage target by stomp if heavy enough.
      • Recoil chance now counts by taking in account weapon type and mass. The greater mass, the less chance to recoil dude. If is melee, the chance is even less than usual.
      • Burning state is now optional.
      • Electrocution state is now optional.
      • Underwater states is now optional.
      • Duck states is now optional.
      • Can be Kamikaze.
      • Can summon other enemies.
    • Updates for random item generators.
    • Proximity trigger flag has been updated.
    • Touch trigger flag has been updated.
    • Sight trigger flag is now working.
    • New features for PropertiesChanger type.
    • Item Shrink Shroom is now working.
    • Item Grow Shroom is now working.
    • New features for weapon, ammo and health pickups, also check this one.
    • General update for most of modern types. It now supports to send any command to destination object. Command 5: Link = just perform operations and don't change state or trigger destination object, while other commands will trigger object after generator operations was performed.
    • A lot of minor changes and fixes.

  7. May 05 2019

    • I'm happy to announce that NBLOOD port officially support all of the features! I will now add new features to both GDX and NBLOOD and continue their support.
    • Changes for SequentialTX type

  8. Mar 07 2019

  9. Feb 03 2019

    • Initial release of this document.

Modern features

Aug 18 2022

  1. Event Causer TX Channel (TX ID 50)

    Every action in the game can be treated as an event. For example when you pressing a switch, enter sector, touching walls or even destroying gib objects, the game produces an event, which may send command on given TX ID. Sometimes we may need to send command on object if it does not have an RX ID assigned or it's ID is unknown. For that a special TX ID 50 is created.

    event causer

    In this example the Damager have TX 50 (event causer channel) which leads to interesting result: it does the damage (sends the command) to any sprite in proximity radius even if the destination sprite RX ID is unknown. This allows to create a complex and very flexible trigger sequences, especially in conjunction with conditional triggers (IF).

    There is some limitations, however: objects that using TX 50 must send the command immediately - using waitTime is not safe, because the command may be send to the wrong object.

  2. Move outside sprites with movable sector

    It's possible to make sprites that were attached to outside walls of movable sector to travel with that sector automatically. This means that there is no need to create a second sector which duplicates properties of the first one anymore.

    sprites near z-motion sector

    In this example the sprites placed outside the Z-motion sector, but still close enough to it's walls. Once that sector activates and ceiling moves, the sprites will travel in tact.

    For obvious reason this feature intended for all sectors that is supposed to move, but not for marked sector types. For example it works for "Rotate" type, but not for "Rotate Marked", works for "Slide" and "Z-motion", but doesn't for "Slide marked" and "Z-motion SPRITE".

    To make this feature work, you need to place sprites close to the walls of sector you want to travel sprites with. Each sector can move up to 256 sprites. The distance between walls and the sprite cannot be longer than 16. Also, to avoid conflicts, sector which contains the sprites cannot be movable and always must be next to the walls of the target sector.

    After that you need setup sprites just like you do it for common traveling e.g. blue sprites travels in sector direction and green sprites in opposite. For Z-Motion blue sprites means that it travels with floor and green means that it travels with ceiling.

  3. Command 16: Kill Events (full)

    This command allows to immediately kill all the events in the queue for destination object. For example it can interrupt fuse counter for dropped TNT bundle. Use it only when really sure as it may lead to unexpected results if not enough controlled.

Aug 03 2021

  1. Dude flags and patrolling

    .MAP It's possible to make patrol location by any enemy that can move with using Path Marker (type 15) and dude flags. Basically, this means that AI will follow from one marker to another and go back when is not found. The next marker can be referenced to any of previous markers and can be inserted in underwater sectors, so you can make loops and do many other interesting things which makes your maps more alive.

    You must first actually create at least one marker; just put sprite and set type 15. The first marker enemy selects is always the closest marker it can see and it must have no "Locked" or "DudeLockout" flags enabled. There is two ways to make enemy to follow it:

    • The first one and the easiest way is to just set dude flag "P" (aka "Reserved" in vanilla MAPEDIT) in the enemy sprite properties. This means that dude will follow markers once level started.
    • The second one allows to start (or stop) patrol by sending command "Set Dude Flags" to the destination enemy sprite from any source sprite by RX/TX system. Enemy that receive this command will inherit states of all dude flags.

    What if you want the enemy to follow another marker after first one is reached? Just create second marker same way you did it for the first, but set data1 (id of the marker) value, then get back to the first marker and set data2 (id of the next marker) according to data1 of the second one. This is very same way you setup path for sectors. If you create two or more markers with same ID, the AI will select next marker randomly, which could make path a bit unpredictable for the player.

    image Linear patrolling

    image Marker branches

    Path marker that gets reached (see clipdist) by the enemy will be automatically triggered if have TX ID or Command 15 (Set Dude Flags). If it have no TX ID, but still have "Set Dude Flags" command, all dude flags that marker have will be inherited by the enemy that just reached it. This allows you to change dude flags dynamically, but may also lead to unexpected results such as breaking the patrol when is not supposed to be stopped, so you have to be carefully.

    Sometimes it may be useful make enemy to stay for some period of time before it goes to the next marker. There is two ways to make it possible: by enterring fixed value in the waitTime field of the marker after which it starts the move again (similar to path sector) or set same values in both data1 (marker id) and data2 (next marker id) which makes the enemy stay until target is spotted. The second way is very useful to build dynamic path using Data Changer or Inc-Dec since you can change data values.

    If you want to break the patrol once marker gets reached, you may set value of the data2 (next marker) to -1 or set it to -2 if you want enemy to go back same path.

    ADDITIONAL OPTIONS:

    • clipDist = defines the radius at which the marker treats as reached for the enemy.
    • goingOn = trigger marker when enemy reached it.
    • goingOff = trigger marker when enemy leaves it.
    • 1-shot = enemy can visit this marker only once.
    • busyTime = enemy velocity.
    • hi-tag = flags:
      • 1: enable enemy crouching.
      • 2: disable enemy crouching.
      • 3: toggle enemy crouching.
      • 4: do not turn to the marker's angle at all.
      • 8: do not turn 180deg relative to marker's angle when coming back.
      • 16: enables turning in random direction with random delay while waiting.

    Let's back to the dude flags.
    The rest of it ((D)eaf, (B)lind, (A)larm, (S)tealth) currently are working only when patrol flag is active and brings additional effects to the enemy:

    Deaf The enemy is deaf, so the player can be spotted with a sight or touch only.
    Blind The enemy is blind, so the player can be spotted with a hear or touch only. This flag also known as dudeGuard in vanilla mapedit.
    Alarm The enemy will activate all other enemies in sight radius once player is spotted. If there is other enemies in patrol and have Alarm flag checked, it will activate enemies that they see too. This flag also known as dudeAmbush in vanilla mapedit.
    Stealth A special flag that brings some kind of stealth mechanics. This allows the player to sneak around while enemies patrol the location without being spotted immediately. In case if enemy is not Blind nor Deaf, there is spot progress bar will appear on the top of enemy sprite. Player's velocity, race, some sounds, as well as crouching affects spot radius and speed of spot progress.

    See also IF conditions related to dude flags and Stealth region markers that allows to modify spot chance of the enemy.

  2. Pause or continue sector motion

    You can pause or continue motion of any sector by sending command 13 (pause) or 14 (continue) from any source to the destination sector. The sector that in pause, will continue it's movement with exactly same position and velocity that have before it stopped once gets Continue command. If sector have "Interruptable" flag enabled, you may also send commands such as On, Off, Toggle to force it go the opposite way.

  3. Enable or disable Damage Sectors

    Damage Sector will do the damage only when is enabled (State: 1 On). This allows you to control it via TX/RX system and commands.

Jan 14 2020

  1. .MAP Sometimes it may be useful to send command on player's sprite. For instance, you could make Effect Generator to spawn any of effects directly on player's location. This way you could achieve bleeding, if you select "Red blood Trail" effect. For that special Player RX Channels was created.

    • TX ID: 30 - Player 1
    • TX ID: 31 - Player 2
    • TX ID: 32 - Player 3
    • TX ID: 33 - Player 4
    • TX ID: 34 - Player 5
    • TX ID: 35 - Player 6
    • TX ID: 36 - Player 7
    • TX ID: 37 - Player 8
    • TX ID: 38 - All players

    Player channels supported by all types, include vanilla ones. So, you probably want to experiment with those a lot to get interesting results.

Sep 09 2019

  1. .MAP Teleport target (Type 8) can be triggered via RX ID channel and teleport any TX ID sprite or player from any to it's sprite location! It may be useful to teleport path markers to change path sector's way or player without need to enter the sector. It can also teleport other teleport targets, so it's possible to create complex combinations! There is also few options to control how exactly sprite should be teleported available:

    • data1 = number of player to teleport (if TX ID is not specified)
      • 0: [ player that caused the event ]
      • 1: player #1
      • 2: player #2
      • 3: player #3
      • 4: player #4
      • 5: player #5
      • 6: player #6
      • 7: player #7
      • 8: player #8
    • data2 = set destination object angle according to teleport target angle
      • 0: destination object stay with same angle after teleportation
      • 1: destination object take angle of teleport target after teleportation
    • data3 = destination object velocity control
      • 0: does nothing
      • value 1: set velocity to zero (blood-like)
      • flag  2: change X and Y velocity according to source sprite angle (quake-like)
      • flag  4: set Z velocity to zero
    • data4 = sound id to play
      • 0: do not play any sound
    • hi-tag = enable telefrag
      • 0: do not enable (default)
      • 1: enable

  2. .MAP There is few cool updates for trigger flags available. Previously, "DudeLockout" has no effect when used in conjunction with "Proximity" or "Touch" flags, but now it does. If sprite is not a dude, you can define proximity radius through sprite's clipdist property. Aside from this, "Touch" flag is working for almost every type of sprite and for walls. The name explains itself: sprite or wall with this flag checked triggers something when player or enemy (in case if no DudeLockout checked) touching it.

    "Sight" flag was renamed to "Sees Player". Sprite with this flag checked, will be triggered once it can see one of players from it's location.

    "Screen" flag means that sprite will trigger when it drawn on the screen of one of players and "Aim" triggers sprite when one of players aims in it.

    If sprite have "Impact" flag enabled, this means that it will be triggered once get hit with projectile, affected by explosion or touch another object (like wall, sprite or sector). Note that not all projectiles can make sprite to trigger.

    There is 512 of additional sprites with these flags available for you to use. If you want Toggle Switch to send command when player fire a flare in it, or Blood Drip Gen spawn drips only when player can see or at close distance, these flags will help you a lot and save much of time.

    If you plan to use any of additional sprites, you probably want to set it properly, because sprites from this arrays triggers a little bit different and more safely than in vanilla.

    • Example 1: [x]going on, [x]going off, waitTime = 0 - will send cmd only once, because waiTime is zero.

    • Example 2: [x]going on, [x]going off, waitTime = N - will send cmd always, with period specifid in waitTime.

    • Example 3: [x]going on, []going off, waitTime = N - will send cmd when going to Off state, skip sending when coming from Off, with period specifid in waitTime.

    • Example 4: []going on, [x]going off, waitTime = N - will skip sending cmd when going to On state, send cmd when coming from Off, with period specifid in waitTime.

    Make sure the restState is equals to state of the sprite, however in case of thing types (400 - 432), there is required to set restState to On in the level editor. If you want to ignore these rules, just set "Interruptable" trigger flag.

  3. .MAP Grow (Type 129) and Shrink (Type 130) shroom items is working! When player is grown, it receives less damage, jumps higher and become heavier, which means it can easily damage by stomp and push back enemies that have less mass than player. Be carefully when pickup this powerup as you may lose your invisibility or can even die if place is too tight to grow ;)

    When player is shrink, the enemies can do same thing to player as it becomes very small and receives way more damage than it usually does. However, player can go to really tight place.

  4. .MAP You can set custom value for the following types of items using it's data1 field:

    • Health (life essence, red potion etc.)
    • Weapons (sawed-off, tesla gun etc.)
    • Ammo(box of shotgun shells, casoline can etc.)

    The value should be greater than 0. If value is greater than max value of the pickup, max value will be used.

    • Example #1: data1: 1 - will give 1 ammo for sawed-off instead of 8.

    • Example #2: data1: 0 - will give 8 ammo for sawed-off.

    • Example #3: data1: 200 - will give 100 ammo for sawed-off.

  5. .MAP You can specify number of INI message that will be displayed instead of "Picked Up ..." message when item was actually picked up. Just specify it in Lock msg field.

Mar 07 2019

  1. .MAP You can specify team in data2 of BloodBath player start marker which is actually used for all multiplayer modes. When playing Teams you probably want if team 1 players get spawned on team 1 base and team 2 on team 2 base, however in vanilla players in any mode spawning at random locations.

    • data2 = specify team
      • 0: use old vanilla way to spawn player
      • 1: team 1
      • 2: team 2

    There should be 4 spawn positions for each team, otherwise default player spawn location will be used if not enough start positions for players. If no team specified in all spawn markers, the vanilla way to spawn player will be used.

  2. .MAP SFX Gen (Type 708) now can play sounds with custom pitch specified in data4 and volume in data3. The value of pitch can be between 2000 and 65535. Normal value is ~35000. If value is zero or below minimum, the default pitch will be used. The value of volume should be between 1 and 255. If value is 0, default volume will be used. Negative value will leads to zero volume. It can be useful if you want smoothly increase volume with DataChanger of IncDec types.

Feb 03 2019

  1. .MAP Path Marker (Type 15) gets an update. When Path Sector reach required marker, the marker will be triggered, so it can send the command. It may be very useful to indicate the process of moving and there is no more need to create side switches which have timer to track sector movement.

  2. .MAP Hidden Exploder (Type 459) can now be customized in different ways by using it's data fields.
    • data1 = explosion type (max. 8)
      • 0: [ default explosion ]
      • 1: TNT Bundle explosion.
      • 2: TNT barrel explosion.
      • 3: Flare Pistol's alt fire explosion.
      • 4: Spray Can explosion.
      • 5: Burning explosion.
      • 6: Similar to default one, burns a little.
      • 7: Napalm Launcher's regular explosion.
      • 8: TNT Stick explosion (ground).

      The value above max will selects default explosion.

    • data2 = SEQ id (optional)
      Type a SEQ animation ID if you want override default one. The SEQ ID should actually exist to be played.
    • data3 = sound ID (optional)
      Type a sound file ID if you want override default one. The sound should actually exist to be played.
    • data4 = explosion radius (optional)
      The value should be greater than 0 and less than 65535. In a perfect way, greater radius should be used if there is no sector crossing the sector where explosion placed in, otherwise it won't work or will work only with sectors near. The normal value for radius is ~2000.

  3. .MAP The liveTime of sprite statnum 2 (explosions) is no longer count down if their hi-tag value is 1. As result they can stay forever in game and do not disappear after liveTime ends.

    • data1 = liveTime (must be non-zero)
    • data2 = player's quake strength (optional)
    • data3 = flash effect that enlighten player's screen (optional)
    • data4 = explosion radius settings

      The values greater than 0 used for custom explosion radius. Normal radius value is ~2000, the greater may work not in way you expect, so you have to experiment there.

    • hi-tag = liveTime settings
      • 0: remove explosion sprite once liveTime ends
      • 1: do not remove explosion after liveTime ends (optional)

  4. .MAP It's possible now to set "global" (player's screen) palette of underwater by setting data2 of Upper Water (Type 9) or Upper Goo (Type 13) to one of following values:

    • data2 = screen palette
      • 0: [ default palette ]
      • 1: water palette (used by water stacks)
      • 2: red palette (for instance, can be used when you swim in bloody water)
      • 3: sewer palette (used by goo stacks)
      • 4: invulnerability palette (same as normal, but you always can edit it)

      Custom palettes support is planned.

  5. .MAP Random Ammo (Type 80) and RANDOM (Type 40) are now working in single player and multiplayer modes! These sprites takes values from data fields to select item that should be generated. To make it work in the game, at least 2 data fields must be non-zero.

    • Example #1: data1: 43, data2: 41, data3: 42, data4: 46 - will generate Flare Pistol, or Sawed-Off, or Tommy Gun, or Napalm Launcher.

    • Example #2: data1: 140, data2: 0, data3: 144, data4: 0 - will generate Basic Armor, or Super Armor.

    • Example #3: data1: 0, data2: 100, data3: 0, data4: 0 - will generate nothing, because only one data field is not empty.

    Since these sprites is actually creates new item sprite instead of transforming in it, they re-triggerable. This means that you can send "Toggle" command on it and they will drop new item.

    Also, items will be generated and dropped at level start automatically if sprite state is set to 1 (On). You should not care about different sprite names as both of them acts identically and can drop any existing item type (not just ammo or weapon).

    It possible to make generated item inherit some values of the spawner such as TX ID to make it able to send commands after being picked up.

    • hi-tag = inherit spawner values
      if set to 1, the following properties of spawner will be inherited by item: TX ID, Command, going on and going off. The Pickup flag will be selected automatically.

    If items generated previously was not picked up, they will be removed before new items is generated. New item will never be the same as previous, unless data fields have same values.

  6. .MAP It's possible to spawn a random dude with Dude Spawn (Type 18) sprite. There should be at least 2 data fields are not empty, otherwise data1 value will be used. Example: data1 = 203, data2 = 201 will spawn Axe Zombie or Tommy Cultist.

    • hi-tag = additional options:
      • 1: inherit the following properties of the spawner: TX ID, Command, going on, going off, drop item, palette and all dude flags.
      • 3: activate dude.
      • 4: spawn dude on TX ID sprite instead of dude spawn sprite.

  7. .MAP Now you can put Pods (Types 221, 223) and Tentacles (222, 224) on ceilings. Just flipY it's sprites. This makes them not to fall back on floor when game starts.

  8. .MAP Counter Sector (Type 619) can work more than just 1 time. Once sector triggered, it will send commands and then become Locked. So, you need just unlock it by "Unlock" command. When unlocked, the sector is ready to work again.

    In some cases (let's say you need the same objects and their amount again) you may need first remove previous objects from sector. This can be done with sector panning (with "drag" function enabled) or via wind.

  9. .MAP New "End Level" TX ID: 6 channel added. It designed rather for episodes than just maps as it allows to set custom number of next map in episode via numbered command. Let's say you want to jump directly from E1M1 to E1M3. Then send command field to Cmd 66: 2. You can place sprites with this channel on your maps as many as you want. Say "Hello!" to non-linearity.

    • More examples: E1M1 -> E1M4 = Cmd 67: 3

    • More examples: E1M4 -> E1M1 = Cmd 64: 0

    • More examples: E1M6 -> E1M5 = Cmd 68: 4

    Counting is always absolute. This means first level is 0, second one is 1 and so on. It does not matter what level is now; you should count always from first level i.e from 0.

  10. .MAP Now it's possible to set custom start HP for monsters by enterring value in data4 field. The value can be between 1 and 65 535!

MODERN OBJECTS

  1. How to use modern objects

    To see modern types in the object type list, you have to add it first. It's recommended to use XMAPEDIT since PMAPEDIT is no longer supported. Open XMAPEDIT.INI, which is usually can be found in "XMAPEDIT" directory and search for "ShowAdvancedTypes" parameter in the [General] section. Then just change it's value to 2.

    Modern objects and "Link" command

    It used in all modern types as "dummy" command. This just means when sending it, you basically only change properties of the destination object, but not trigger it. Typical example: you want to change destination sector's lighting effects with Sector Lighting Changer, but that sector also have TX ID. So, if you send any of common commands (On, Off, Toggle etc.) - that sector will be triggered and send it's command to all it's TX ID destination objects, which is probably not what you meant to do. But if you send "Link" command - only lighting effects will be changed.

    Modern objects and negative values

    While building the level, it's often you will be in situation, when it's required to set negative value in data field. In XMAPEDIT you able to set it using [PAGE DOWN] or [NUM -]. Arrow keys won't set value below than 0!

Aug 18 2022

  1. .MAP Velocity Changer (Type 506) allows to change X, Y or Z velocity of any TX ID sprite. If sprites are static, the physics attributes will be propagated automatically according to current source physics attributes. This means that you must add physics to source first (for example, using Properties Changer).

    If destination object is a sector, the velocity will be changed for all sprites in that sector.

    • busyTime = frequency of the generator in ticks.
    • data1 = X-velocity value.
      data2 = Y-velocity value (ignored if force angle flags are set).
      data3 = Z-velocity value.

    Value -32767 or 32767 treated as ignore value for all 3 data fields, which means that current destination velocity value won't be affected.

    hi-tag = additional options:
    • flag 1: treat data fields as velocity relative to current.
    • flag 2: force X and Y velocity to destination sprite angle.
    • flag 4: force X and Y velocity to source sprite angle.
    • flag 8: force X and Y velocity to random angle.
    • flag 16: change destination sprite angle according to it's X and Y velocity.

    • combine flags to get some extra effects:
      • flag 2 and 4: force X and Y velocity to event causer sprite angle.
      • flag 8 and (flag 2 or 4 or 16):force X and Y velocity to angle 180.

Jun 20 2021

  1. Stealth region (Type 16) intended to change sensitivity of the enemies in patrol mode with Stealth flag enabled. In other words: it allows to modify current chance to spot target via sight or hear when dude or target (default) is in the radius of stealth region.

    image Stealth region
    data1 = radius at which it treats as active.
    • 0: active only in stealth region's sector.
    data2 = value of hearing chance modifier (does not affect deaf enemies).
    data3 = value of seeing chance modifier (does not affect blind enemies).

    The values of data2 and data3 is a percent of hearing and seeing chance relative to current by default. Positive value leads to greater chances, while negative leads to less. Example: data2 = -100 leads to almost deaf enemy and 100 leads to the enemy that hears twice better than with no modifier.

    If region have TX ID and spot progress get reached max value while target or enemy in this region, it will be triggered. Note that Locked regions are ignored.

    hi-tag = additional options:
    • 1: treat data2 and data3 values as fixed percent value.
    • 2: enemy must be in stealth region area instead of target.
    • 4: target and enemy must be in stealth region area.
    • 8: target must have crouch posture.

  2. Slope Changer (Type 504) allows to change slope of the destination floor, ceiling or sprite via sending command on TX ID.

    data2 = slope value.

    By default it counts in percents, where 0 means no slope, -100 means -32767 (the max negative value of the slope), and 100 means 32767 (the max positive value of the slope). However, this behavior can be changed if you set flag 1 in hi-tag field (just in case when you need to use fixed values).

    There is variety of options available depending on destination object type:

    • FOR SECTORS:

      • data1 = select which slope intended to be changed.
        • 0: floor slope only.
        • 1: ceiling slope only.
        • 2: both.

        If destination sector contains floor oriented sprites which Z is really close to floor or ceiling, their slope will be changed automatically according current slope of the floor or ceiling of the sector. You can change this behavior by setting flag 2 in hi-tag field.

    • FOR SPRITES:

      • data4 = sprite slope options.
        • 0: none: just change the slope to the data2 value.
        • 1: set slope according floor slope of the sector.
        • 2: set slope according ceiling slope of the sector.

        Note that any sprite affected by Slope Changer will become floor oriented automatically. If flag 2 is set in hi-tag field, Z of the sprite will be changed to Z of floor or ceiling of the sector accordingly.

May 09 2020

  1. .MAP You already know that each source can send command to destination objects with same TX ID only. Yes, RandomTX and SequentialTX allows to send command on many TX ID objects, but imagine the next situation: we want spawn same effect on different TX IDs using just one Effect generator. By default it's impossible and we have to create the following trigger sequence:

    image Spawning effect on different TX IDs objects normally

    Looks pretty complicated! Especially if we need to spawn exactly same effect! However, using RandomTX or SequentialTX in event redirection mode allows you to make things like that a lot easier. To make it work in this mode, just set it's command to 5 (Link).

    image Spawning effect on different TX IDs objects using event redirection

    Event redirection mode almost fully inherits normal behavior of these types, so RandomTX redirects to random TX ID, while SequentialTX redirects it to TX ID which selected sequentially. To learn more about normal behavior please click here. Note that redirector sends command of the source object (in this example command of the Effect Generator will be send instead command of SequentialTX).

    Each object can have as many redirectors as required - there is no limits for that. Further more - there is nested redirects allowed, so redirectors can redirect events from another redirectors! The following types fully supports event redirection:

    704 - Missile Generator
    24 - Custom Dude Spawn
    18 - Dude Spawn
    504 - Slope Changer
    8  - Teleport Target
    27 - SEQ Spawner
    28 - Properties Changer
    29 - Picture Changer
    31 - Resizer
    34 - Sector Lighting Changer
    35 - Data Changer
    36 - Damager
    37 - Inc-Dec
    38 - Effect Generator
    39 - Sector Wind Generator

  2. .MAP IF and !IF (Type 501 and 502) is a very special conditional trigger types. In simple terms: it sends command on TX ID (or object that pass check) only when selected condition returns true when type is IF or false in case of !IF.

    Imagine an situation when you need trigger something only if health of player or enemy is in range of specified values, touch walls or another sprites, close to something or visible from specified distance? There is pretty wide range of different conditions which makes it possible and available for you to use.

    image Basic condition

    All conditions except game ones should have RX and TX IDs. It always must be triggered via command sent from object that must be checked or from another condition. To simplify creation, some traditional parameters such as going on and going off has been ommited and currently is not required. Data1 selects condition ID while data2, data3 and data4 fields serves as condition arguments.

    CONDITIONS TYPES

    There is two types of conditions available:

    1. .MAP Triggerable - a condition that requires to be triggered via command. This works pretty same as triggering the switch. Take a look on picture with basic example. Gargoyle have "Vector" flag checked, so every time it gets hit with hitscan weapon, it sends command on condition with TX ID: 180 that checks if gargoyle currently touching the floor.

      You can use as many conditions of such type as you want, however, is not really suitable if we need to damage gargoyle when it touch the floor any time. In this situation tracking condition could help.

    2. .MAP Tracking condition is an advanced type which checks all assigned TX ID objects with every N of ticks specified in busyTime field independently from events. By default it starts working once you start playing the map and ends when level end gets reached.

      image Basic tracking condition

      Almost all commands from assigned objects in this mode are ignored, however some global such as Lock, Unlock and Toggle Lock is still working. It can be used to specify when exactly tracking process should operate.

      When condition is locked, it does not track objects. If you don't need it start working once game started, just check "Locked" flag and unlock it later via sending "Unlock" command. This automatically launch object tracking process.

      You can create up to 64 conditions of such type and assign up to 32 objects for each of it. Any object type is fine: walls, sprites, sectors, enemies or even players, however some exceptions is presented: Toggle Switch (Type 20) and 1-Way Switch (Type 21) cannot be assigned and used to control the condition.

      Object assignation is pretty simple: any object that have it's TX ID pointing at RX ID of tracking condition will be automatically assigned to that condition.

    SEQUENCE OF CONDITIONS

    .MAP These types are flexible enough to create a complex scenes and scripts. It's possible to create sequence of conditions, such as: IF sprite in required sector -> AND IF sprite is burning -> AND IF is a player -> [do something]. It's allowed to mix the triggerable and tracking conditions (see examples below). It could be as long as you want, however you should keep in mind that tracking condition must be always first!

    image Sequence of conditions

    FOCUS CHANGE

    .MAP Another thing that is possible with conditions is passing and changing validated objects from one condition to another. By default condition that was checking assigned object, automatically passing it to the next. Sometimes it may require to check objects that was affected by current as well. Let's say we want to know if gargoyle touching the floor of sector that have lava on it, and then we want to kill it immediately. COMMAND 64 allows override current object by object that was affected, so next condition will be adressed to that one.

    image Setting focus to affected object

    FOCUS RESET

    .MAP Ouch! Now gargoyle will die always once it lands on any floors that have lava on it! But what if we want it die only if it's HP in a range of specified percents? If we add HP checking in condition sequence, we will get and error, because currently focus changed from assigned object (gargoyle) to affected (sector), and thus we need change focus back to assigned. COMMAND 100 allows to reset current object to the first one.

    image Reset focus to the first object

    BRANCHES

    .MAP Let's imagine an situation: the map have lava sectors, but also have acid ones. Landing on lava sectors currently causes gargoyle to die immediately if it have low health points, but landing on anything else does nothing, however we want damage gargoyle a little once it lands on acid sector. This is where condition branches could help:

    image Condition branches

    STANDARD ARGUMENTS AND COMPARISON OPERATORS

    Many conditions are designed to compare numberic value (i.e. check if health in a range of value1 and value2, check if floor picture equals to value1 and so on). It's just means that you have to specify value1 in data2 and, if required - value2 in data3 field. That's it! When comparsion type is BOOL all operators are ignored.

    In addition to arguments, conditions currently supports the following comparison operators that could be selected through changing cstat of it's sprite. Use keys [K] and [B] in 2D Mode to choice.

    Operatorcstat
    == data2normal sprite
    >= data2 AND <= data3normal blocking sprite
    >= data2blue painted sprite
    >  data2blue painted and blocking sprite
    <= data2green pained sprite
    <  data2green painted and blocking sprite

    ADDITIONAL OPTIONS

    hi-tag allows to specify where exactly command should be send. Note that if condition have TX ID, the command will be send to all TX ID objects in addition to hi-tag specified.

    • 1: send it to object that currently in the focus.
    • 2: send it to initial object.
    • 3: both.

    1-shot indicates that condition should work only once.

    waitTime allows to specify a delay before sending command when condition is successful. If using it with tracking conditions, it's busyTime ticks summing with waitTime. Note that delay is not available when trying to send commands which intended to change focus (e.g 64 or 100).

    GAME CONDITIONS

    The following conditions does not require to have any objects assigned since it checks global game properties.

    Data1 Condition Arguments On focus change Bool
    0 This is a dummy condition. It always true and could serve as splitter or switch.
    1 Compare level time in minutes [standard]
    		no
    2 Compare level time in seconds [standard]
    		no
    3 Compare level time in micro seconds [standard]
    		no
    5 Compare global kills (current) [standard]
    		no
    6 Compare global kills (total) [standard]
    		no
    7 Compare secrets found [standard]
    		no
    8 Compare total secrets [standard]
    		no
    20 Compare global visibility (depth cueing) [standard]
    		no
    30 Check chance in percents
    data4 = percent value, where 100% is 65536 (always true)
    		yes
    31 Compare value of random in a range of data2 and data3 [standard]
    		no
    47 Compare how many sprites with given statnum is created [standard],
    data4 = statnum from 0 to 1024
    		no
    48 Compare how many sprites created in total [standard]
    		no

    ANY OBJECT CONDITIONS

    The following conditions works for any object type that currently in the focus.

    Data1 Condition Arguments On focus change Bool
    100 Check if object is a sector
    		yes
    105 Check if object is a wall
    		yes
    110 Check if object is a sprite
    		yes
    115 Check if object is an x-object
    		yes
    120 Compare object type [standard]
    		no
    124 Compare object picnum's surface type [standard], valid types:
    • 0:  none
    • 1:  stone
    • 2:  metal
    • 3:  wood
    • 4:  flesh
    • 5:  water
    • 6:  dirt
    • 7:  clay
    • 8:  snow
    • 9:  ice
    • 10: leaves
    • 11: cloth
    • 12: plant
    • 13: goo
    • 14: lava
    • for sectors: data4
      • 0: floor or ceiling picnum's surface
      • 1: floor picnum's surface
      • 2: ceiling picnum's surface
    		no
    125 Compare object picnum [standard],
    • for sectors: data4
      • 0: floor or ceiling picnum
      • 1: floor picnum
      • 2: ceiling picnum
    		no
    126 Compare object palnum [standard],
    • for sectors: data4
      • 0: floor or ceiling palnun
      • 1: floor palnum
      • 2: ceiling palnum
    		no
    127 Compare object shade [standard],
    • for sectors: data4
      • 0: floor or ceiling shade
      • 1: floor shade
      • 2: ceiling shade
    		no
    128 Check object cstat
    • data2 = required value
      See all cstat values in Properties changer list.
    • for sectors: data4
      • 0: floor or ceiling cstat
      • 1: floor cstat
      • 2: ceiling cstat
    		yes
    129 Check or compare object hi-tag If value of data4 is zero: If value of data4 is not zero, the condition becomes non-bool. This means that you have to use comparison operator to compare the value between standard arguments:
    • [standard]
    • data4 = bit mask
    		mixed
    130 Compare sprite xrepeat, wall xrepeat or sector floor xpanning [standard]
    		no
    131 Compare sprite xoffset, wall xpanning or sector ceiling xpanning [standard]
    		no
    132 Compare sprite yrepeat, wall yrepeat or sector floor ypanning [standard]
    		no
    133 Compare sprite yoffset, wall ypanning or sector ceiling ypanning [standard]
    		no
    141 Compare sprite data1, wall data or sector data [standard]
    		no
    142 Compare sprite data2, wall data or sector data [standard]
    		no
    143 Compare sprite data3, wall data or sector data [standard]
    		no
    144 Compare sprite data4, wall data or sector data [standard]
    		no
    150 Compare object RX ID [standard]
    		no
    151 Compare object TX ID [standard]
    		no
    152 Check if object is Locked
    		yes
    153 Check if "going On" is selected
    		yes
    154 Check if "going Off" is selected
    		yes
    155 Check if object can be triggered only once
    		yes
    156 Check if object already triggered
    		yes
    157 Check if object disabled (State: 0)
    		yes
    158 Compare busy of object in %, where 100% = 65536. [standard]
    		no
    159 Check if "dudeLockout" is selected
    		yes
    170 Compare ID of SEQ animation spawned on an object [standard]
    		no
    171 Compare SEQ animation frame number spawned on an object [standard]
    		no
    199 Check if condition received specified command [standard]
    		no

    SPRITE CONDITIONS

    The following conditions works for any sprite that currently in the focus.

    Data1 Condition Arguments On focus change Bool
    500 Compare angle [standard]
    		no
    505 Compare statnum [standard]
    		no
    506 Check if sprite is in respawn list
    		yes
    510 Compare clipdist [standard]
    		no
    515 Check is sprite have owner sprite
    		If true - changes focus to owner's sprite. yes
    520 Check if sprite is in sector
    		If true - changes focus to that sector yes
    525 Check if physics affected sprite is in movement
    data2 = velocity type
    • 0: any (default)
    • 1: x
    • 2: y
    • 3: z
    		yes
    530 Check if sprite is in underwater sector
    		If true - changes focus to that sector yes
    531 Check if sprite is immune to damage type
    data2 = damage type
    • -1: all
    • 0: fall
    • 1: burn
    • 2: bullet
    • 3: explode
    • 4: choke
    • 5: spirit
    • 6: electric
    		yes
    • 535
    • 536
    • 537
    • 538
    		 Check at which object sprite aims now using hitscan
    • data2 = clipmask
      • 0: block and hitscan
      • 1: just block
      • 2: just hitscan
    • data4 = max distance
      • 0: any (default)
    • 535: If scans ceiling of sector - changes focus to the sector
    • 536: If scans floor of sector - changes focus to the sector
    • 537: If scans wall - changes focus to that wall
    • 538: If scans another sprite - changes focus to that sprite
    		 yes
    545 Check if this sprite is the target of some enemy
    		If true - changes focus to that enemy yes
    550 Compare health in % where 100% = default health [standard]
    		no
    • 555
    • 556
    • 557
    • 558
    		 Check if sprite currently touching an object
    • for 558: data4 allows to specify how exactly sprite should touch an object:
      • 0: any way (default)
      • 1: with bottom
      • 2: with direct hit
      • 3: with top
    • 555: If touching ceiling of the sector - changes focus to sector
    • 556: If touching floor of the sector - changes focus to the sector
    • 557: If touching wall - changes focus to that wall
    • 558: If touching another sprite - changes focus to that sprite
    		 yes
    565 Compare burn timer of sprite in % [standard] If true - changes focus to the burn source sprite no
    566 Check if any burning flare stuck in this sprite
    		If true - changes focus to that flare yes
    570 Check sprite mass in KG with getSpriteMassBySize function [standard]
    		no

    PLAYER CONDITIONS

    The following conditions works player sprite that currently in the focus. Players range: 231 - 238. To detect if sprite is a player, you can use comparison by type (120) in mixed conditions. To assign player as object for tracking condition, refer to Player Control examples.

    Data1 Condition Arguments On focus change Bool
    400 Check if player # is in the game [STANDARD], player range:
    • 1: player 1
    • 2: player 2
    • 3: player 3
    • 4: player 4
    • 5: player 5
    • 6: player 6
    • 7: player 7
    • 8: player 8
    		 If true, changes focus on that player no
    401 Compare player team [STANDARD], team range:
    • 0: no team
    • 1: team 1
    • 2: team 2
    		no
    402 Check if have an key item
    • data2 = specify a key item
      • 1: skull
      • 2: eye
      • 3: fire
      • 4: dagger
      • 5: spider
      • 6: moon
      • 7: key 7
    		yes
    • 403
    • 404
    • Check if have an weapon
    • Check current weapon
    • data2 = specify weapon
      • 0:  no weapon
      • 1:  pitchfork
      • 2:  flare gun
      • 3:  sawed-off
      • 4:  tommy gun
      • 5:  napalm launcher
      • 6:  bundle of tnt
      • 7:  spray can
      • 8:  tesla cannon
      • 9:  life leech
      • 10: voodoo doll
      • 11: remote bomb
      • 12: proximity bomb
    		yes
    • 405
    • 406
    • 407
    • Compare item amount in %
    • Check if item active
    • Check if item selected
    		 [STANDARD], valid pack items:
    • 1: doctor's bag
    • 2: diving suit
    • 3: crystal ball
    • 4: beast vision
    • 5: jump bots
    		 405 only
    408 Compare N powerup amount in seconds [standard],
    • data4 = select powerup
      • 1:  feather fall
      • 2:  invisibility
      • 3:  invulnerability
      • 4:  jump boots
      • 5:  raven flight
      • 6:  guns akimbo
      • 7:  diving suit
      • 8:  gas mask
      • 9:  clone
      • 10:  crystall ball
      • 11:  decoy
      • 12: doppleganger
      • 13: reflective shots
      • 14: beast vision
      • 15: cloak of shadow (useless)
      • 16: rage shroom
      • 17: delirium shroom
      • 18: grow shroom
      • 19: shrink shroom
      • 20: death mask (useless)
      • 21: wine goblet
      • 22: wine bottle
      • 23: skull grail
      • 24: silver grail
      • 25: tome
      • 26: black chest
      • 27: wooden chest
      • 28: asbestos armor
    		no
    410 Check keys pressed
    • data2 = specify a key
      • 1: move forward
      • 2: move backward
      • 3: strafe left
      • 4: strafe right
      • 5: jump
      • 6: crouch
      • 7: normal attack
      • 8: alternative attack
      • 9: action
    		yes
    412 Is falling in abyss?
    		yes
    413 Compare current race [STANDARD], valid races:
    • 1: normal human
    • 2: beast
    • 3: grown human
    • 4: shrink human
    		no
    414 Compare current posture [STANDARD], valid postures:
    • 1: standing
    • 2: swimming
    • 3: crouching
    		no
    446 Check if QAV scene is playing [standard]
    		yes
    447 Is in god mode?
    		yes

    ENEMY CONDITIONS

    The following conditions works for enemy sprites that currently in the focus.

    Data1 Condition Arguments On focus change Bool
    450 Check if have any targets
    		If true - changes focus to the target sprite yes
    451 Check if enemy affected by Enemy Target Changer
    		yes
    452 Compare distance to the target in meters [STANDARD] If true - changes focus to the target sprite no
    453 Check if target is visible
    		If true - changes focus to the target sprite yes
    454 Check if target visible with periphery
    data2: periphery angle in BUILD units (2048 = 360deg). If value is zero, the default periphery value of the enemy will be used.
    		If true - changes focus to the target sprite yes
    455 Check if Patrol dude flag is enabled
    		yes
    456 Check if Deaf dude flag is enabled
    		yes
    457 Check if Blind dude flag is enabled
    		yes
    458 Check if Alarm dude flag is enabled
    		yes
    459 Check if Stealth dude flag is enabled
    		yes
    460 Check if other patrol dudes follow the marker
    		If true - changes focus to that enemy sprite yes
    461 Check if this patrol dude reached the marker
    		If true - changes focus to the marker yes
    462 Compare target spot progress in % for dudes with Stealth flag [STANDARD]
    		no
    465 Check if dude can interact with objects
    		yes
    466 Compare AI state type [STANDARD], valid states:
    • 0: idle
    • 1: generic idle
    • 2: moving
    • 3: search
    • 4: chasing
    • 5: recoil
    • 6: attack
    • 7: patrol wait (land)
    • 8: patrol wait (crouch)
    • 9: patrol wait (water)
    • 10: patrol move (land)
    • 11: patrol move (crouch)
    • 12: patrol move (water)
    		no
    467 Compare AI state timer [STANDARD]
    		no

    The following are valid only for Custom Dude sprites

    Data1 Condition Arguments On focus change Bool
    470 Check if Life Leech is thrown
    		If true - changes focus to the Life Leech sprite yes
    471 Check if Life Leech is destroyed
    		If false - changes focus to the Life Leech sprite yes
    472 Compare amount of summoned dudes [STANDARD]
    		no
    473 Check if custom dude able to...
    • data4 = item to check
      • 1: can attack
      • 2: can turn in burning dude
      • 3: can ducking
      • 4: can electrocute
      • 6: can recoil
      • 7: can swim
      • 8: can walk
    		yes

    SECTOR CONDITIONS

    The following conditions works for any sectors that currently in the focus.

    Data1 Condition Arguments On focus change Bool
    300 Compare visibility [standard]
    		no
    • 305
    • 306
    • Compare floor slope
    • Compare ceiling slope
    		 [standard]
    		no
    310 Are required sprite type is in this sector? [standard] If true - changes focus to that sprite no
    350 It's an underwater sector?
    		yes
    351 Compare depth level of the sector [standard]
    		no
    • 355
    • 356
    		 Compare height of floor / ceiling in % where 0% = Off state, and 100% = On state [standard]
    		no
    357 Check if sector is in movement
    		yes

    WALL CONDITIONS

    The following conditions works for any walls that currently in the focus.

    Data1 Condition Arguments On focus change Bool
    200 Compare mask picnum [STANDARD]
    		no
    205 Check wall's sector
    		If true - changes focus to the sector yes
    210 Check if it's a mirror
    		yes
    215 Check next sector it's connected
    		If true - changes focus to the next sector yes
    220 Check if have next wall
    		If true - changes focus to the next wall yes
    225 Check sector of 2-nd side of the wall
    		If true - changes focus to the sector of 2-nd side yes

Jan 14 2020

  1. Player Control (Type 500) created to give access for level designer to controlling properties related to player. It allows to change movement speed, jump height, play screen effects or QAV animations and do many other stuff with players just by triggering the sprite.

    Unlike other types, this one performs operation type that should be selected with a numberic command. It's important to remember that it should be set in current sprite and not received from the object which sends it. Thought, Player Control supports conversion of commands from sender to receiver, it's recommended to always set it manually, just because it's very handy in case when your map have a lot of triggers.

    • data1 = select player number for which you want to perform the operations
      • 0: [ reserved ]
      • 1: player #1
      • 2: player #2
      • 3: player #3
      • 4: player #4
      • 5: player #5
      • 6: player #6
      • 7: player #7
      • 8: player #8

    .MAP COMMAND 5 (LINK): COPY PROPERTIES TO PLAYER'S SPRITE

    This command allows to make player's sprite triggerable. This means that player sprite could send commands to TX ID objects or receive it from player rx channels. There is only one linker sprite for each player. Setting custom RX ID have no effect here, because it triggeres automatically once game starts. The following properties of linker sprite will be inherited by player:

    1. TX ID
    2. going on
    3. going off
    4. busyTime
    5. waitTime
    6. [all trigger flags]
    7. Interruptable
    8. DudeLockout
    9. [all data values]

    Player sprite will be automatically added to objects list of tracking conditions, if any presented, so conditions will be adressed to player directly, but not to player control sprite.

    .MAP COMMAND 64: CHANGE PLAYER RACE

    • data2 = select race
      • 0: normal human (default)
      • 2: shrink human
      • 3: grown human

      Read more about grown and shrink human races here.

    .MAP COMMAND 65: CHANGE PLAYER MOVEMENT SPEED AND JUMP HEIGHT

    • data2 = set movement speed (in percents)
      • -1 or 32767: do not change
      • 0: obviously, this makes player non-movable
      • 100: reset to default movement speed

      Any other value will also adjust the speed. The max is 65535.

    • data3 = set jump height (in percents)
      • -1 or 32767: do not change
      • 0: this makes player not able to jump at all
      • 100: reset to default jump height

      Any other value will also adjust the height.

    .MAP COMMAND 66: SET PLAYER SCREEN EFFECT

    • data2 = select screen effect
      • 0: clear all the following effects
      • 1: tilting
      • 2: pain
      • 3: blind (darkening the screen)
      • 4: pickup
      • 5: quake (the more is time, the more is strength)
      • 6: visibility (bright the screen)
      • 7: delirium (the more is time, the stronger is effect)
    • data3 = set time of the effects

      The greater value, the more is time. The max is 432000.
      It's about of 10 minutes in real time.

    .MAP COMMAND 67: START PLAYING QAV ANIMATION

    • data2 = QAV ID of animation to play.
      data4 = if value is set to 1: force interrupt of previous animation.
    • waitTime = how many times animation should be played.
      • 0: loop the animation

    By default animation is playing as weapon. This means that weapon will be lowered, the animation is played and after that weapon will be raised again.

    If animation is not set up to play forever, after it played required amount of times, the sprite will send the command to next TX ID. This allows you to create sequences of animations if command will be sent to another Player Control type which intended to play the animation.

    COMMAND 68: STOP PLAYING QAV ANIMATION

    Use this command to stop animation play. It's useful if you need to interrupt amimation immediately via trigger. See an example map for command 67.

    • data2 = select which exactly QAV animation ID should be stopped.
      • 0: stop any animation immediately.

    .MAP COMMAND 69: CHANGE PLAYER LOOK ANGLE

    • data2 = specify look angle

    The value must be between -128 and 128. Positive values forcing player to look up, while negative treated as look down. If you don't want change look angle, just set the value out of a range.

    .MAP COMMAND 70: CLEAR PLAYER ITEMS OR WEAPONS

    • data2 = select what exactly should be cleared.
      • 0: clear everything
      • 1: clear weapons and ammo (except pitchfork)
      • 2: clear armor
      • 3: clear inventory items
      • 4: clear keys

    .MAP COMMAND 71: GIVE PLAYER ITEMS OR WEAPONS

    • data2 = select what exactly should be given.
      • 1: give player a weapon N
      • 2: give player ammo for weapon N
    • data3:
      • in case of giving the weapon: sets weapon number that should be given
      • in case of giving the ammo: sets weapon number for which ammo should be given
    • data4:
      • in case of giving the weapon: if set to 1 - disables auto-switch on given weapon
      • in case of giving the ammo: sets amount of ammo that should be be given

    .MAP COMMAND 72: ACTIVATE / DEACTIVATE INVENTORY ITEM

    When receiving command from a sender: 1: On - activate item, 0: Off - deactivate item, any other - toggle.

    • data2 = specify inventory item number.
      • 1: Doctor's Bag
      • 3: Crystal Ball (useless in single player)
      • 4: Beast vision
      • 5: Jump Boots
    • data4 = additional options.
      • 0: switch on it
      • 1: remove item from inventory
      • 2: both

    COMMAND 73: CHANGE PLAYER SPRITE ANGLE

    • data2 = specify player angle

      Max angle is 2048 build units. It basically equals to 360deg, so 1024 = 180 and so on. If you don't want to change player angle, just set the value out of a range.

    • hi-tag = force change angle according control sprite angle
      • 1: force

    For map example, please refer to command 69.

    COMMAND 74: ACTIVATE / DEACTIVATE POWERUP

    • data2 = select powerup ID
      1 - feather fall 2 - invisibility
      3 - invulnerability 4 - jump boots
      5 - raven flight 6 - guns akimbo
      7 - diving suit 8 - gas mask
      9 - clone 10 - crystall ball
      11 - decoy 12 - doppleganger
      13 - reflective shots 14 - beast vision
      15 - cloak of shadow 16 - rage shroom
      17 - delirium shroomw 18 - grow shroom
      19 - shrink shroom 20 - death mask
      21 - wine goblet 22 - wine bottle
      23 - skull grail 24 - silver grail
      25 - tome 26 - black chest
      27 - wooden chest 28 - asbestos armor

      Many powerups in this list are obsolete and have no effect in the game, still you can activate it to probably simulate it's behaviour with other modern types. Just be creative. ;)

    • data3 = powerup duration in seconds
      • 0: deactivate powerup (if time treated as fixed value).

        Max value is 500 seconds.

    • hi-tag = additional options
      • 1: force data3 to be treated as relative time.

        This means that time can be added to current time or substracted from it (if value is negative). Example: data3 = -50 substracts 50 seconds from current time of powerup. Data3 = 50 adds 50 seconds to current time.

Sep 09 2019

  1. Inc-Dec (Type 37) can perform increment and decrement operations with data fields of destination objects in real-time. It's similar to Data Changer type, except this one allows you to set step value and iterate it every N time. It can be used for many things where having dynamic data is preferable. For instance, using it in conjunction with Ambient Sound allows you to smoothly change volume or radius. You will often see it in example maps attached to articles.

    • busyTime = frequency of the generator in ticks.
    • data1 = destination object data field
      • 1: data1 of sprite / data of sector / data of wall.
      • 2: data2 of sprite.
      • 3: data3 of sprite.
      • 4: data4 of sprite.

      You can type multiple values to iterate selected data fields at the same time. For instance value "12" means that data1 and data2 should be iterated, value "134" - data1, data3, data4 and so on.

    • data2 = minimum value

      The minimum value of destination data object where start from. This will first set value to this minimum and then start iterate.

    • data3 = maximal value

      The maximum value after iteration process is stops.

    • data4 = iteration value

      Data field of destination object will be iterated by this value. Must be greater than 0.

    If minimal value less than maximal value, it will cause increment operation, else if maximal value is less than minimal value - decrement operation will be performed.

    By default, when goal value is reached in all destination objects, the iteration process stops and generator goes to OFF state. This means, when you need perform any operations again, you have to enable it by sending ON command on it. However, this behavior can be altered by setting it's hi-tag value to one of following:

    • hi-tag = change post operation behavior.
      • 0: force OFF state of generator when goal value reached for all destination objects.
      • 1: just stop iteration process, but don't disable the generator.
      • 2: force swap min and max value when goal value was reached for all destination objects. This causes count down from goal value to min and vice versa automatically without stopping the process.
      • 3: force set destination object value to min and start count again.

Mar 02 2019

  1. Custom dude (Type 254) allows to create enemy and customize it in many ways such as selecting weapon, seq animation base, sounds base and even movement speed using it's data fields. This type is perfectly fits for ground and underwater enemies with various distances and weapon types! It can fire vector (hitscan), missile projectiles, summon other enemies or became kamikaze as well as throw things such as proxy detonators or spray cans.

    • data1 = select weapon type
      • 0: no weapon.

        This leads to "scared" dude with no weapon. It will try escape target with low chance to melee attack it.

      At the moment of writing this text, there is 21 vector, 17 missile and 15 thrown weapons available. Add to this abilities to summon enemies and you get more than enough to make enemies in your maps unique plus on that you can combine weapons by using Trigger Gen and DataChanger to change type of the weapon on the fly. ;)

      .MAP VECTOR WEAPONS:

      Melee enemies receive a bit less damage and have less chance to hinder, so they have higher chance to come closer to target and attack it, while enemies on longer distance will act similar to cultist AI.

      DataDistanceDamage
      1 - Shotgun ShellAny4
      2 - Tommy Cultist bulletAny7
      3 - Tommy Gun AP bulletAny20
      4 - Shotgun shell APAny6
      5 - Tommy Gun regular bulletAny12
      6 - Bat biteMelee4
      7 - Bone Eel biteMelee12
      8 - Gill Beast biteMelee9
      9 - Beast claw slashMelee50
      10 - Axe of zombieMelee18
      11 - Cleaver of fat zombieMelee9
      12 - Phantasm's scytheMelee20
      13 - Gargoyle's slashMelee16
      14 - Cerberus biteMelee19
      15 - Hound biteMelee16
      16 - Rat biteMelee4
      17 - Spider biteMelee8
      18 - [ Unknown ]Melee9
      20 - Burning damageAny2
      21 - Spirit damageAny25
      22 - Melee attack of custom dudeMelee37

      .MAP PROJECTILE WEAPONS:

      Monsters with flame missiles (304,308) is treated like melee ones, they also can't use it while underwater, so they will try to get closer to target as much as possible and attack it with melee vector (22).

      Enemies with explosive missiles such as various fireballs will fire it on longer distance. Once target is in explosion radius, they will try melee attack.

      If enemy have regular life leech missile (315) and life leech was thrown by enemy previously (see thrown weapons below), the enemy will pickup that life leech before attack.

      300 - ButcherKnife 301 - Flare (Regular)
      302 - Tesla (Alt) 303 - Flare (Alt)
      304 - Aerosol flame 305 - Fireball (used in maps)
      306 - Tesla (Regular) 307 - EctoSkull (Phantasm projectile)
      308 - HellHound / Cerberus Flame 309 - ButcherPuke
      310 - [ Reserved ] 311 - Stone Gargoyle projectile
      312 - Napalm (Regular) 313 - Cerberus Fireball
      314 - Tchernobog Blue Fireball 315 - Life Leech (Regular)
      316 - Life Leech (Alt - when dropped and enough ammo) 317 - Life Leech (Alt - when dropped and zero ammo)

      Weapon dispersal modifiers depends on game difficulty and attack animation. The faster animation and more fire triggers in it, the greater dispersion. Ducking reduce it twice, so if too high and distance to target too long, AI may select this position (see animation states below). Dispersion range is: 200 - 3500.

      The attack distance depends on sprite size, so greater the sprite, the longer is distance.

      .MAP THROWN WEAPONS:

      Monsters with thrown weapons on longer distance will act similar to Dynamite Cultist. Once target get closer, they will try to dodge or melee attack.

      400 - TNT Barrel 401 - Proximity Detonator
      402 - Remote Detonator 415 - Kickable pail
      418 - Dynamite Stick 419 - Dynamite Bundle
      420 - Spray Can 421 - Bone
      428 - Napalm ball Used by alt fire for Napalm Launcher. The quantity depends on difficulty level.
      429 - Fire Pod projectile Similar to spray explosion, just less radius
      430 - Green Pod projectile The target can have bad day with those ;)
      433 - Proximity Detonator 2 This is an modern thing. Works same as 401, except it detects only players.
      434 - Debris Modern thing. Acts similar to 421 and does small damage. It have random gib picture when thrown. I just had idea to use it with some aggressive innocents maybe.
      435 - Enemy's Life leech

      Once dropped, start work similar to player's life leech, except it aims only in target that was set by dude. Enemy with this type of weapon can throw only one unit, but can re-throw it (causes remove of previous) in case if distance is too long or previous unit can't see the target.

      When life leech is dropped, the enemy will try to stay in longer distance, behind the life leech actually, but once target is close, will try to melee attack. If life leech destroyed, the enemy will always attack the target with melee attack only.

      If enemy is killed, the life leech will be destroyed too. Players can't pickup this weapon.

      SUMMONING ENEMIES:

      Quantity of spawned enemies depends on game difficulty, i.e 1-st difficulty = 1 summoned enemy, 3-rd = 3 summoned enemies and so on. If summoner is killed, all summoned enemies will be killed too. The following types of enemies allowed to be spawned by Custom Dude:

      201 - Cultist with Tommy Gun 202 - Cultist with Shotgun
      203 - Axe zombie 204 - Fat zombie
      205 - Axe zombie (earth) 206 - Flesh gargoyle
      207 - Stone gargoyle 210 - Phantasm
      211 - Hound 212 - Hand
      213 - Brown spider 214 - Red spider
      215 - Black spider 216 - Mother spider
      217 - Gill beast 218 - Eel
      219 - Bat 220 - Rat
      221 - Green pod 222 - Green tentacle
      223 - Fire pod 224 - Fire tentacle
      227 - Cerberus 228 - Cerberus (1 dead head)
      229 - Tchernobog itself 230 - Cultist with tommy gun (prone)
      244 - Axe zombie (sleeping) 245 - Innocent
      246 - Cultist with shotgun (prone) 247 - Cultist with tesla gun
      248 - Cultist with dynamite 249 - Beast cultist
      250 - Tiny Caleb 251 - The Beast

      Once max quantity of spawned enemies reached, custom dude will try melee attack the target, but if some of summoned units will die, custom dude will summon new ones until max quantity is reached again.

      .MAP KAMIKAZE EXPLOSION TYPES:

      It's possible to make Custom Dude act like kamikaze by selecting one of following values as weapon type:

      459 - Bundle of TNT explosion 1 460 - Bundle of TNT explosion 2
      461 - TNT Barrel explosion 1 462 - Fire pod explosion
      463 - Spray explosion 464 - TNT Barrel explosion 2
      463 - Napalm explosion 1 466 - Napalm explosion 2

      In this mode, enemy tries to get close to target as much as possible and create explosion which damages it. Does not matter how many HP kamikaze enemy have - it will be killed after explosion is generated. Note that enemies of this type treated as melee units, so they have less chance to hinder after getting damage.

    • .MAP data2 = custom seq start animation Id
      • 0: use default start id animation (11520).

        There is shotgun cultist animations used by default which can use custom palette number.

      For using custom seq animations, you should prepare full set which contains various states of enemy. Currently, there is 17 states available and 8 is reserved in total. When map with custom dude is started, it checking for each seq file id starting from data2 and ending with data2 + 24. If no seq file for enemy state found, the game will inform you about it and will switch to default animation.

      Proper order of enemy states:

      data2 - Idle (land) Required
      + 1 - Default death Required.
      This animation will used in cases when there is no death animation for specified damage type exist.
      + 2 - Explosive death Optional
      + 3 - Burning dude Optional.
      If not exist, it will first look for burning death animations.
      + 4 - Electrocuted Optional.
      If not exist, it will first look for pain animation to play.
      + 5 - Pain Optional.
      If not exist, the enemy will just dodge in sides. Melee units have less chance to dodge, which makes them greater threat.
      + 6 - Normal attack (land) Required
      + 7 - Throw attack Required
      + 8 - Normal attack (duck or underwater) Optional.
      If not exist, this means enemy cannot duck and swim at all. Enemies wich cannot swim trying to escape underwater sectors, but once in it - will die!
      + 9 - Movement (land) Optional.
      If not exist, this means that dude cannot walk. So, it will act like Pod enemy.
      + 10 - Melee attack Required.
      This animation used by enemies that have Thrown and some other weapons to protect itselfs on close distance, when it's impossible to use primary weapon.
      + 13 - Movement (underwater) Optional.
      If not exist, this means enemy cannot swim and will die once underwater.
      + 14 - Movement (duck) Optional.
      If not exist, this means enemy cannot duck.
      + 15 - Burning death 1 Optional
      + 16 - Burning death 2 Optional
      + 17 - Idle (underwater) Optional.
      If not exist, this means enemy cannot swim and will die once underwater.
      + 18 - Dude morphing in another Optional.
      If not exist, there is FX effect will be spawned and new dude appear immediately.

      The following state id's is currently reserved and strongly not recommended to be added: 11, 12, 19, 20, 21, 22, 23 and 24.

      You are free to not add seq files for states which is optional or reserved, but still must keep state offset correctly according their order. You should also know that same filename can use more than just one id. This means you can use same file for different enemy states.

    • data3 = custom sound start Id
      • 0: use default cultist sound set.

      It's possible set up to 2 custom sounds for each state of enemy. The sound will selected randomly, but if file does not exist, the first existing sound which found will be used, so you don't have to add 2 sounds, but still must keep state offset correctly. Please, refer to data2 chapter for map example.

      Proper order of state sounds:

      data3 - Spot target 1 + 1 - Spot target 2
      + 2 - Pain 1 + 3 - Pain 2
      + 4 - Normal death 1 + 5 - Normal death 2
      + 6 - Burning state 1 + 7 - Burning state 2
      + 8 - Explosive or burning death 1 + 9 - Explosive or burning death 2
      + 10 - Target is dead 1 + 11 - Target is dead 2
      + 12 - Chasing the target 1 + 13 - Chasing the target 2
      + 14 - Normal weapon attack (optional) + 15 - Thrown weapon attack (optional)
      + 16 - Melee attack (optional) + 17 - Dude transformation (optional)

      The sound id's from +17 to +29 are reserved and strongly not recommended to be added. If no sounds for attack (normal, thrown, melee) and morphing states exist - there will be predefined sounds played. If there is no sounds for other states, then no sound will played at all.

    • data4 = set custom health points
      • 0: use default healh points.

      This is global setting which work for any dude, click here to read more.

    • busyTime = set custom movement speed
      • 0: use default movement speed.

      The greater value, the greater movement speed. Using greater values can be probably useful for melee units. Max speed is 146603 (twice faster than Beast movement speed).

    .MAP TRANSFORMING IN ANOTHER DUDE

    Just like Beast Cultist transforms in Beast after death, custom dude can be transformed in any selected by you enemy after death too. To make it possible, you just need go through following steps:

    1. Place custom dude in the map and give it any free TX ID.
    2. Place any second dude, then go in 2D Mode.
    3. Give it RX ID according custom dude's TX ID.

    After custom dude first incarnation is killed, it will be transformed in second dude you select. The following properties of the incarnation will be inherited by dude: type, all data fields, all dude flags, TX ID, command, goingOn, goingOff, key, dropItem, and busyTime. You are free to create as many incarnations as you want using next incarnation as custom dude again. Keep in mind that if you want to trigger something after dude's final death, you should use TX ID of last incarnation as RX ID of destination object.

    THE MASS

    The mass of the enemy counts automatically from it's sprite size and clipdist property, where clipdist is actually mass multiplier. X-repeat and Y-repeat values takes in account too: each repeat treats as 2 KG, base value is 64 (default BUILD value, when sprite displays at it's original size). If value of repeat below than 64, it will substract from mass, while greater values will add to. So, the greater sprite size, repeats, and clipdist - the greater mass of the enemy. The minimal mass is 10 KG, and maximal is 65 535.

    Heavy enemies can stomp their targets (include players), just like Tchernobog does. It also harder to get critically damaged (recoil). To control the mass, simply press [Alt] + [D] on it's sprite and set value from 16 to 255.

    DAMAGE RESISTANCE

    It mainly depends on the following factors:

    1. Difficulty level
    2. Sprite size (the greater, the more resistance)
    3. Weapon enemy currently have:
      4. Weapon typeResistance
      [All kamikaze types] -1024 burn, explosive
      [All Summoners] Have same damage resistance as summoned one
      300 - ButcherKnife 100 bullet
      307 - EctoSkull 32  spirit
      311 - Stone Gargoyle projectile
      316 - Life Leech (Alt 1)
      317 - Life Leech (Alt 2)
      +32  spirit
      52  electric
      301 - Flare (Regular)
      303 - Flare (Alt)
      304 - Aerosol flame
      308 - HellHound / Cerberus Flame
      420 - Spray Can
      428 - Napalm ball
      429 - Fire Pod projectile
      32  burn
      +20 explosive
      315 - Life Leech (Regular)
      435 - Enemy's Life leech
      60 + Random(4)  burn
      32 + Random(18) spirit
      305 - Fireball (used in maps)
      312 - Napalm (Regular)
      313 - Cerberus Fireball
      314 - Tchernobog Blue Fireball
      65 + Random(15) fall
      50 burn
      32 explosive
      400 - TNT Barrel
      401 - Proximity Detonator
      402 - Remote Detonator
      418 - Dynamite Stick
      419 - Dynamite Bundle
      65 + Random(15) fall
      32 explosive
      306 - Tesla (Regular)
      302 - Tesla (Alt)
      		 32 + Random(8) electric


    4. Armor item to drop (dropItem field):
      Armor typeResistance
      139 - Asbestos Armor [full] burn, + 30 explosive
      140 - Basic Armor + 15 burn, explosive, bullet, spirit
      141 - Body Armor + 30 bullet
      142 - Fire Armor + 30 burn, explosive
      143 - Spirit Armor + 30 spirit
      144 - Super Armor + 60 burn, explosive, bullet, spirit


    5. Sprite surface type (tile in first frame of idle animation)
      6. Surface typeResistance
      Stone
      [full] fall
      + 128  bullet
      + 50   burn
      + 40   explosive
      - 30   choke, electric
      Metal
      16     fall
      + 64   bullet
      + 45   burn
      + 35   explosive
      - 30   choke
      - 20   electric
      Wood
      + 5    bullet
      - 50   burn
      - 40   explosive
      - 10   choke
      + 30   electric
      Water
      Dirt
      Clay
      Goo
      8      fall
      + 10   bullet
      + 128  burn
      + 30   explosive
      [full] choke
      - 40   electric
      Snow
      Ice
      8      fall
      + 10   bullet
      + 60   burn
      + 40   explosive
      [full] choke
      - 40   electric
      Leaves
      Plant
      [full]  fall
      + 5     bullet
      - 70    burn
      - 50    explosive
      Cloth
      8      fall
      + 5    bullet
      - 30   burn
      - 20   explosive
      Lava
      [full]  burn
      [full]  explosive
      - 30    choke

  2. Custom dude spawn (Type 24) - works similar to regular dude spawn, except it designed for type 254 only. It allows to define all properties which supported by custom dude plus some others.

    • data1 = select weapon type for spawned dude
    • data2 = set custom seq start animation Id for spawned dude
    • data3 = set custom sound start Id for spawned dude
    • data4 = set custom health points for spawned dude
    • busyTime = set custom movement speed for spawned dude

    It possible to make spawned dude inherit some other values such as RX or TX id to being it able to send commands. This way you can control, for instance, quantity of spawned enemies.

    • hi-tag = additional options:
      • 1: inherit TX ID, Command, going on, going off, key, drop item, palette and all dude flags.
      • 2: inherit just xrepeat and yrepeat.
      • 3: inherit both.
      • 4: spawn dude on TX ID sprite instead of custom dude spawn sprite.

Feb 03 2019

  1. .MAP It's possible to set any missile for Missile generator (Type 704). The missile will spawn on generator's sprite or TX ID sprite in case if TX ID is non-zero. You also able to control it's velocity, slope and make it split up. To make it fire vertically, the sprite must be floor oriented. One-sided flag controls the missile direction.

    • busyTime = frequency in 120th of a second.
    • data1 = select missile type
      • 300: ButcherKnife
      • 301: Flare (Regular)
      • 302: Tesla (Alt)
      • 303: Flare (Alt)
      • 304: Aerosol flame
      • 305: Fireball (used by Fireball Gen in MAPEDIT)
      • 306: Tesla (Regular)
      • 307: EctoSkull (Phantasm projectile)
      • 308: HellHound / Cerberus Flame
      • 309: ButcherPuke
      • 310: [ Reserved ]
      • 311: Stone Gargoyle projectile
      • 312: Napalm (Regular)
      • 313: Cerberus Fireball
      • 314: Tchernobog Blue Fireball
      • 315: Life Leech (Regular)
      • 316: Life Leech (Alt - when dropped and enough ammo)
      • 317: Life Leech (Alt - when dropped and zero ammo)
    • data2 = set missile velocity
      • 0: predefined velocity.

        • The greater value, the greater speed. Max value is 1000.

    • data3 = set missile slope
      • 0: no slope.

        • Positive values - bottom slope, while negative - top.
        The value should be between -500 and 500.

    • data4 = set delay before missile splits up
      • 0: no split up.

        • After a delay, the missile will split up in another 8 smaller missiles,
        just like alt fire of flare gun. Max delay is 500.

    • hi-tag = additional options
      • 1: inherit shade, xrepeat, yrepeat and palette from current sprite.
      • 2: inherit shade, xrepeat, yrepeat and palette from TX ID sprite.

  2. .MAP RandomTX (Type 25) - takes value from random data field and uses it as TX ID and sends command on it. This type allows to not just generate random item or spawn dude, but also create completely random event. Just like in examples above, it will work only if at least 2 data fields are not empty.

    But what if you want to use more than 4 TX ID? There is support of ranged TX ID has been added. Just type in data1 value of first TX ID, then in data4 value of last TX ID and leave both data2 and data3 fields empty.

    • Example (ranged TX ID):

      • data1: 100
      • data2: 0
      • data3: 0
      • data4: 120

      This will send command to random TX ID in range of 100 and 120.

    The random is pretty nice, so you can be 95% sure that next TX ID will not be the same as previous. Also this type can work as event redirector.

  3. .MAP SequentialTX (Type 26) - sequentially takes value from data fields starting from data1 or first non-empty data field and uses it as TX ID to send command on it.

    • Example:

      • data1: 100
      • data2: 101
      • data3: 102
      • data4: 103

      Command 0: Off - The first trigger will send command to TX ID 103, the second trigger will send command to TX ID 102, the third trigger will send command to TX ID 101, and fourth trigger will send command to TX ID 100.

      After data1 field will be used, it will start from data4 again.

      Command 1: On / Command 3: Toggle - The first trigger will send command to TX ID 100, the second trigger will send command to TX ID 101, the third trigger will send command to TX ID 102, and fourth trigger will send command to TX ID 103.

      After data4 field will be used, it will start from data1 again. Note that in this mode empty data fields are ignored.

    • Example (range of TX IDs):

      • data1: 100
      • data2: 0
      • data3: 0
      • data4: 150

      Command 0: Off - sequentially take value starting from 149 and send command on it. After last value will be used, it will start from 150.

      Command 1: On / Command 3: Toggle - sequentially take value from 100 and send command on it. After last value will be used, it will start from 100 again.

    You can force sending command to all TX IDs in the same time by setting hi-tag value of the sprite. All objects that able to receive the command, will receive it and current index of TX ID will reset.

    • hi-tag = force set command to all destination objects
      • 0: do not force
      • 1: force

    Also this type can work as event redirector.

  4. DataChanger (Type 35) - a very powerful type that allows change data fields of any sprite, sector or wall on the fly. For instance, it allows change required object for Counter Sector or enemy type that will spawned by Dude Spawn or even Combination Switch settings!

    • FOR SECTORS:

      • data1 = data field of destination sector
        • -1 or 32767: keep current value

    • FOR SPRITES:

      • data1 = data1 field of destination sprite
        • -1 or 32767: keep current value
      • data2 = data2 field of destination sprite
        • -1 or 32767: keep current value
      • data3 = data3 field of destination sprite
        • -1 or 32767: keep current value
      • data4 = data4 field of destination sprite
        • -1 or 65535: keep current value

    • FOR WALLS:

      • data1 = data field of destination wall
        • -1 or 32767: keep current value
    Sometimes it may require to set "ignore values" (-1, 32767 or 65535) in some destination objects to make them ignore some params dynamically, and so you can do it with setting hi-tag value.

    • hi-tag = treat "ignore values" as actual ones.
      • 0: disable
      • 1: enable

  5. .MAP Sector Lighting changer (Type 34) - can change sector lighting effects on the fly. You may also change amplitude, frequency, phase and even color lighting with this type!

    • data1 = destination sector FX wave.
      • -1 or 32767: keep current wave
    • data2 = destination sector wave amplitude.
      • -129 or 129: keep current amplitude

      Negative values = less shade, while positive = more shade.

    • data3 = destination sector wave frequency.
      • -1 or 32767: keep current frequency
    • data4 = destination sector wave phase.
      • -1 or 65535: keep current phase

    • If sprite is floor oriented, it's allowed to change sector color effects as well. In this case the sprite palette value will be used as floor or ceiling color palette. Note that sector fx cannot store palette ID higher than 15 at the moment. So you are limited by standard paloookups.

      • visible bottom only: sector fx inherits palette for floor only.
      • visible top only: sector fx inherits palette for ceiling only.
      • visible from top AND bottom: sector fx inherits palette for floor and ceiling.
    • hi-tag = additional options.
      • 0: use sector settings.
      • flag 1: force shade always.
      • flag 2: force shade floor.
      • flag 4: force shade ceiling.
      • flag 8: force shade walls.
      • flag 16: treat data values as relative to current.

      You may combine options to select what exactly should be affected by lighting. Example: 1 + 2 = 3 (shadeAlways and shadeFloor), 4 + 8 = 12 (shadeWalls and shadeCeiling, but NOT shadeAlways). If just shadeAlways required, set value 1.

  6. .MAP Damager (Type 36) - damages players or enemies if it can be damaged with given amount and type. Note that some enemies could be immune to specified damage type. For instance, Hound cannot be damaged with burn damage. However, when you killing the sprite, this rule is ignored.

    • busyTime = frequency of the damage generation in ticks.
    • data2 = damage type
      • -1: force reduce hp by data3 value.
      •  0: fall damage.
      •  1: burn damage.
      •  2: bullet damage.
      •  3: explode damage.
      •  4: drown damage.
      •  5: spirit damage.
      •  6: tesla damage.
    • data3 = damage amount
      • 0: kill the sprite.
    • hi-tag = additional options
      • 0: none.
      • 1: treat data3 as fixed value (default is percent).
      • 2: do not show damage effects such as flames or tesla recoil.
      • 4: force recoil for any damage type.

    TX ID POINTS ON A SPRITE:

    This means that destination sprite will receive the damage. It must be an enemy or player (see Player RX channels).

    TX ID POINTS ON A SECTOR:

    This means that any enemy or player in that sector will receive the damage. In this case, however, there is additional options available that defines when exactly it's true:

    • If damager placed on the ceiling of sector: damage only when objects touching the ceiling.
    • If damager placed on the floor of sector: damage only when objects touching the floor.
    • If damager is a wall sprite: damage only when objects touching the walls of the sector.
    • If none of variants above: damage when objects enters destination sector.

    You can combine options: place the damager on the ceiling or floor and make it wall sprite. This will lead to result when objects receive the damage if touching the ceiling or floor and walls.

    TX ID IS ZERO:

    • data1 = specify target that receive the damage.
      • 0: any enemy or player in damager's sector.
      • 1: player 1.
      • 2: player 2.
      • 3: player 3.
      • 4: player 4.
      • 5: player 5.
      • 6: player 6.
      • 7: player 7.
      • 8: player 8.
      • 666: everyone on the map.
      • 667: just all enemies on the map.
      • 668: just all players on the map.

  7. Enemy Target Changer (Type 33) - allows to change target for enemies and force them fight each other, act like team to fight only specified targets (or everyone), ignore or follow to player and many other options.

    Since it's a generator, it sends command every N it's busyTime to destination object, just like Trigger Gen and basically all generators does. The less busyTime, the better result is, so i suggest to use busyTime in range from 1 to 10. The default value is 5. Once target changer is Off or Locked, every enemy affected by it will return back to normal and will try to kill you.

    • busyTime = frequency of the generator in ticks.
    • data1 = forces AI to fight only targets that have in their data1 the same value.

      • 0: AI will attack all monsters that have empty data1 field.

      • 666: fight every enemy, even if it's data1 field have different value or empty.

    • data2 = specify current battle mode for AI. By default "DeathMatch" is selected.

      • 0: DeathMatch

        Enemies with same RX ID in this mode will fight each other and search for targets that have data1 id. Fine example: Axe Zombies attack each other for food :>.

        It's worth to note that not all monsters of the same type can attack each other. For instance, Tommy Cultist can't attack Tommy Cultist.

      • 1: Team DeathMatch

        Enemies in this mode with same RX ID will act like team and search for targets that have data1 id. If data1 of target changer is 666, they will fight everyone except team mates (same RX ID monsters). Fine example: Few cultists lose control on Cerberus and his Hound helpers and trying to kill them.

    • data3 = specify if target of AI should be forced to fight. By default target is not forced.

      • 0: no force, target will react on AI fire only when it hits the target.

      • 1: once AI selected this target to fight, aim of the target will be changed to AI.

      • 2: same as 1, but target can also disturb some monsters which in idle state. Disturbed monsters will not fight and just walk around in map, until AI will not select them to fight.

    • data4 = specify how AI should react when note player(s). By default player(s) is not ignored.

      • 0: do not ignore player(s) even if enough other targets in sight.

      • 1: AI may or may not attack player(s) when enough targets in sight.

      • 2: AI will attack player(s) only when no targets in sight at all. Once there is new targets appear, AI will attack on targets instead of player(s).

      • 3: AI will go to Idle state when no targets in sight, and will ignore player(s) always, even when player(s) fire in AI.

      • 4: AI will follow player(s) in sight, when no targets. Once new targets appear, AI will attack on targets. Note that not all monsters can follow player thought, for instance, Zombies, Gillbeasts or Beasts can't.

  8. .MAP SEQ Spawner (Type 27) - spawns and plays any existing SEQ animation from data2 field. Since it's a generator, you can make it play animation in a loop by setting it's busyTime. Animation can be spawned on it's sprite if there is no TX ID specified or on all TX ID objects include walls, masked walls, floors or ceilings of the sector.

    • busyTime = frequency of the generator in 120th of a second.
    • data1 = randomize busyTime (optionally).
      • 0: do not randomize
    • data2 = SEQ animation ID.
      • 0: stop playing seq animation (if any presented).
    • data3 = specify where exactly animation should be spawned.

      • FOR WALLS:

        • 1: spawn animation only on a wall. Don't spawn on masked area.
        • 2: spawn animation only on masked area of wall.

          In case if the wall is not masked, it will become masked automatically.

        • 3: spawn animation on both masked and wall area.

      • FOR SECTORS:

        • 1: spawn animation only on floor.
        • 2: spawn animation only on ceiling.
        • 3: spawn animation on floor and ceiling.

      • FOR SPRITES:

        • 0: spawn SEQ animation directly on TX ID sprite (default).
        • 1: create new sprite: use current destination sprite's Z coordinate.
        • 2: create new sprite: spawn it in the bottom of destination sprite.
        • 3: create new sprite: spawn it in the top of destination sprite.
        • 4: create new sprite: spawn it in the middle of destination sprite.
        • 5: create new sprite: spawn it on the floor of destination sprite's sector.
        • 6: create new sprite: spawn it on the ceiling of destination sprite's sector.

        Sprites that was additionally created, gonna be removed from the game later automatically after some time or if it have remove flag in it's seq animation set. These sprites can inherit some appearance properties of the SEQ Spawner as well, if you set the following values in hi-tag field:

        hi-tag = force inherit SEQ spawner appearance
        • 0: do not inherit (default)
        • flag 1: inherit following properties: palette, xrepeat, yrepeat, xoffset, yoffset and shade
        • flag 2: inherit sprite cstat
        • flag 4: inherit sprite angle
    • data4 = sound ID to play (for sprites and walls only).

  9. Sector Wind Generator (Type 39) - creates wind effect on TX ID sector or in a sector it's currently placed on, even if is not an x-object. Unlike wind options in sector FX dialog, the generator can use higher values for wind velocity and can change direction of wind randomly or according generator's sprite angle.

    The higher values can be useful to wind away player or dudes, while randomness settings can be useful for FX effects such as dynamic flame, rain or snow. This type is generator, so you can use it same as other generators by setting it's busy and wait times according your needs. Also note this generator does not changes state of the sector, it just deal with it's effects.

    • busyTime = frequency of the generator in ticks.
    • sprite angle = destination sector's wind direction

      It's possible to use additional wind direction control. If sprite angle is not randomized, you could set sprite step rotation value in data4 field and then paint sprite in blue or green using key [K] in 2D Mode. Blue sprite rotates to right side, green one - to left.

    • data1 = randomness settings (optionally)
      • 0: no randomness
      • 1: randomize wind velocity in range of data2
      • 2: randomize generator sprite angle. (will cause change of wind direction).
      • 3: randomize both
    • data2 = wind velocity from 0 to 32 767.
    • data3 = enable panning texture according generator wind settings
      • 0: use sector pan settings
      • 1: pan just floor
      • 2: pan just ceiling
      • 3: pan both
    • hi-tag = panAlways and windAlways options
      • 0: use sector settings.
      • 1: force "pan always" and "wind always" even if not selected in sector.

  10. .MAP Effect Generator (Type 38) spawns FX Effect (smoke, flames, bullet holes, water splashes, etc.) specified in data2 field. There is pretty wide range of effects in game and you probably want to try them all. Some effects can inherit appearance such as palette and size of the generator.

    • busyTime = frequency of the generator in 120th of a second.
    • data1 = randomize busyTime
      • 0: do not randomize
    • data2 = FX Effect ID
      1:  Bullet hit (flesh 1) 2:  Bullet hit (flesh 2)
      3:  Bullet hit (flesh 3) 4:  Bullet hit (water)
      5:  Bullet hit (metal) 6:  Bullet hit (wood)
      7:  Bullet hit (snow) 8:  Water splash 1
      9:  Water splash 2 10: Lava splash
      11: Smoke (big) 12: Smoke (small)
      13: Blood chunks 14: Burn spark
      15: Blue spark 16: Burning broken wood
      17: Broken wood 18: Broken glass (white 1)
      19: Broken glass (blue) 20: Broken glass (red)
      21: Broken glass (green) 22: Broken glass (orange)
      23: Single bubble (big) 24: Single bubble (small)
      25: Single bubble (smaller) 26: Multi bubble
      27: Red blood trail 28: Flare spark
      29: Respawn effect 30: Metal shard
      31: Broken glass (white 2) 32: Flame lick 1
      33: Flame lick (blue, bigger) 34: Blood wall splash (big)
      35: Blood wall splash (small) 36: Blood on floor
      37: Tommy bullet casing 1 38: Tommy bullet casing 2
      39: Tommy bullet casing 3 40: Sawed-off shell casing 1
      41: Sawed-off shell casing 2 42: Sawed-off shell casing 3
      43: Bullet hole 44: Leaf (yellow)
      45: Leaf (green) 46: Broken stone
      47: Burning paper 48: Blood drip splash
      49: Electric spark 1 50: Electric spark 2
      52: Tesla circle 53: Green blood trail
      54: Fire blood trail 55: Green blood on floor
      56: Flame lick 2 (long)

      There is few predefined effects available to use (data4 and hi-tag options are ignored here)

      200: Bunch Flame licks 201: Bunch of flare sparks
      202: Bunch of flare sparks (lower velocity) 203: Bunch of blood sprays 1
      204: Bunch of blood sprays 2 205: Bunch of arc sparks
      206: Bunch of electric sparks
    • data3 = random range of effects
      • 0: no random range
    • data4 = specify where exactly effect should be spawned
      • 0: at the top of the sprite (default)
      • 1: at the bottom of the sprite
      • 2: at the middle of the sprite
      • 3: at the floor of sprite's sector
      • 4: at the ceiling of sprite's sector
    • hi-tag = force inherit effect generator appearance by effect
      • 0: do not inherit (default)
      • flag 1: inherit following properties: palette, xrepeat, yrepeat, xoffset, yoffset and shade
      • flag 2: inherit sprite cstat
      • flag 4: inherit sprite angle

    Effects can be spawned on all TX ID sprites if TX ID of Effect Generator is not empty. This means you can use single generator for a few sprites where effect should be appear.

  11. .MAP PropertiesChanger (Type 28) - can change various properties for sectors, walls or sprites on the fly. For instance, changing cstat of the sector makes it parallaxed or non-parallaxed, or if you change cstat of the sprite, you can make it face, wall or floor oriented, visible or invisible etc.

    • hi-tag = additional options.
      • flag 0: none.
      • flag 1: relative attribute adding / removing.

        Sometimes it's handy to set new attributes or remove it relative to current. First you need to set this flag to tell the game you want to do it. Then, if you want to remove attribute, you must add flag 4, otherwise new attribute will be added to current.

      • flag 2: do not check for exceptional attributes.

        Some attributes cannot be normally altered because of security reasons. Often changing such attributes may lead to unexpected results, so you must set this flag to get attributes marked as exception changed as well. Do it if you really sure.

      • flag 4: remove attribute (in conjunction with flag1).

    • TX ID IS ZERO:

      • data2 = set global visibility (from 0 to 4096).

    • FOR SECTORS:

      • data1 = sector underwater and depth options.
        • -1 or 32767: don't change anything.
        • 0:     mark sector as non-underwater.
        • 1:     mark sector as underwater.
        • 2 - 9: set depth level in range from 0 to 7.

        If enemies or players are in current sector, their underwater status will be changed dynamically as well.

      • data2 = set sector visibility.
        • -1 or 32767: keep current sector visibility

        The value can be between 0 and 255. The greater value, the less sector visibility.

      • data3 = sector ceiling cstat flags.
        • -1 or 32767: keep current ceiling cstat flags

        Available sector cstat list:

        • 1:  Sector parallaxed.
        • 2:  Sector sloped.
        • 8:  Expanded texture.
        • 16: FlipX sector texture.
        • 32: FlipY sector texture.
        • 64: Relative texture alignment.
      • data4 = sector floor cstat flags.
        • -1 or 65535: keep current floor cstat flags

    • FOR SPRITES:

      • There was added a better physics! Currently it's possible to add physics for any sprite. Objects affected with physics can be moved via wind, panning, touching, explosions or vector weapons. You may also control how exactly physics will work.

        Unlike vanilla, where physics for sprites acts always the same, new one takes in account mass (automatically counted with given sprite size, it's surface type and clipdist property) and underwater status. So, heavy objects will drown faster and moving slower etc.

        data2 = enter sprite physics attributes.
        • -1 or 32767: keep current attributes
        • 0: deactivate physics for destination object

        • FIRST DIGIT (MAIN PHYSICS ATTRIBUTES):

          • 1: destination object is affected by movement physics only.
          • 2: destination object is affected by gravity only.
          • 3: all attributes are available for destinaton object.

        • SECOND DIGIT (TOUCH PHYSICS ATTRIBUTES):

          • 0: destination object cannot be impulsed with touching.
          • 1: destination object can be impulsed with touching.

        • THIRD DIGIT (WEAPON PHYSICS ATTRIBUTES):

          • 0: all attributes are disabled for destination object.
          • 1: destination object can be impulsed with vector weapons only.
          • 2: destination object can be impulsed with explosions only.
          • 3: all attributes are available for destinaton object.

        • FOURTH DIGIT (FLOATING, SWIMMING AND FLYING ATTRIBUTES):

          • 0: all attributes are disabled for destination object.
          • 1: destination object can only swim underwater.
          • 2: destination object can only swim and float underwater.
          • 3: destination object can only fly while on the ground.
          • 4: destination object can fly while on the ground and float underwater.
          • 5: destination object can fly while on the ground and swim underwater.
          • 6: all attributes are available for destinaton object.
      • data3 = enter sprite hi-tag.
        • -1 or 32767: keep current hi-tag

        Changing hi-tag of sprite is mainly useful if you want change some options in modern types which support it dynamically.

      • data4 = enter sprite cstat flags
        • -1 or 32767: keep current sprite cstat flags

        Available sprite cstat list:

        • 1:     Blocking sprite.
        • 2:     Double translucent sprite.
        • 4:     Sprite is X-flipped.
        • 8:     Sprite is Y-flipped.
        • 16:    Wall sprite.
        • 32:    Floor sprite.
        • 64:    One sided sprite.
        • 128:   [exception] Sprite origin aligned (bottom aligned otherwise).
        • 256:   Hit-scan sensitivity.
        • 514:   Normal translucent sprite.
        • 4096:  [exception] Sprite is pushable (Push flag).
        • 8192:  [exception] Sprite can be moved with movable sectors in sector direction.
        • 16384: [exception] Sprite can be moved with movable sectors in reverse direction.
        • 32768: Sprite is invisible.

    • FOR WALLS:

      • data1 = set this wall as first wall of the sector or auto-align wall.
        • -1 or 32767: don't change anything.
        • 1: set this wall as first.
        • 2: set this wall as auto-align wall for sector.
        data4 = wall cstat flags.
        • -1 or 65535: keep current wall cstat flags

        Available wall cstat list:

        • 1:     Wall is blocking.
        • 2:     [exception] Wall is bottom-swapped.
        • 4:     [exception] Wall is bottom / outside oriented.
        • 8:     Wall texture X-flipped.
        • 16:    Wall is masked.
        • 32:    [exception] Wall is one-sided.
        • 64:    Wall is hit-scan sensitive.
        • 128:   Double translucent wall.
        • 256:   Wall texture is Y-flipped.
        • 640:   Normal translucency.
        • 16384: [exception] Wall will move by movable sector in sector direction.
        • 32768: [exception] Wall will move by movable sector in reverse direction.

    It's possible to actually mix cstat or hi-tag values to get various results. For instance, you want make sprite floor and blocking - then you need mix values SpriteFloor (32) and SpriteBlocking (1), and so you got 33. So, data4: 33 will cause sprite to be blocking and floor oriented.

    What if you want create wall oriented, blocking and hit-scan sensitive sprite? Same here: take SpriteWall value (16), then SpriteBlocking value (1), and SpriteHitscan (256). 16 + 1 + 256 = 273. So, data4: 273 will cause wall oriented, blocking and hit-scan sensitive sprite. Easy enough?

    Next example: you want make sprite to be movement physics and gravity affected. Take PhysicsMovement value (1) and PhysicsGravity value (2). 1 + 2 = 3, So, data3: 3 will make sprite gravity and movement affected.

  12. Picture changer (Type 29) can change picture of sector, sprite or wall according to it's data values. It also can change sprite palette.

    • FOR SECTORS:

      • data1 = picture number of sector's floor.
        • -1 or 32767: keep current picture
      • data2 = picture number of sector's ceiling.
        • -1 or 32767: keep current picture
      • data3 = palette number of the sector's floor.
        • -1 or 32767: keep current palette
      • data4 = palette number of the sector's ceiling.
        • -1 or 65535: keep current palette

    • FOR SPRITES:

      • data1 = picture number of the sprite.
        • -1 or 32767: keep current picture
      • data2 = shade level of the sprite.
        • -1 or 32767: keep current shade

          • Values can be between -127 and 127. -1 is reserved.

      • data3 = palette number of the sprite.
        • -1 or 32767: keep current palette

    • FOR WALLS:

      • data1 = picture number of the wall.
        • -1 or 32767: keep current picture
      • data2 = picture number of mask for masked walls.
        • -1 or 32767: keep current picture
      • data3 = palette number of the wall.
        • -1 or 32767: keep current palette

  13. .MAP Resizer (Type 31) can change sprite picture size, panning of sector's floor or ceiling and wall texture settings on the fly. The values should be greater than 0 and less than 255.

    • FOR SECTORS:

      • data1 = panning of sector's floor by X.
        • -1 or 32767: keep current panning
      • data2 = panning of sector's floor by Y.
        • -1 or 32767: keep current panning
      • data3 = panning of sector's ceiling by X.
        • -1 or 32767: keep current panning
      • data4 = panning of sector's ceiling by Y.
        • -1 or 65535: keep current panning

    • FOR SPRITES:

      It's possible to resize sprite with two methods: by changng it's xrepeat and yrepeat values directly or by scaling SEQ animation. The last method is mainly useful when you have sprite with SEQ animation spawned on it and there is non-zero XR and YR values in that animation. For instance, it makes resizing of any dude in game way easier.

      1-st method:

      • data1 = size of sprite picture by X.
        • -1 or 32767: keep current size
      • data2 = size of sprite picture by Y.
        • -1 or 32767: keep current size

      2-nd method:

      • hi-tag = enable SEQ scaling method.
        • 0: do not enable (default)
        • 1: enable
      • data1 = scale value

        The value should be in a range of -25 and +25. Negative values leads to smaller size, while positive makes sprite larger. Value 0 will reset sprite size back to normal. -255 treated as "ignore value" which means current scale will not be changed.

      • data3 = offset of sprite by X.
        • -1 or 32767: keep current offset
      • data4 = offset of sprite by Y.
        • -1 or 65535: keep current offset

    • FOR WALLS:

      • data1 = texture size of wall by X.
        • -1 or 32767: keep current size
      • data2 = texture size of wall by Y.
        • -1 or 32767: keep current size
      • data3 = texture offset of wall by X.
        • -1 or 32767: keep current offset
      • data4 = texture offset of wall by Y.
        • -1 or 65535: keep current offset