EDukeWiki - User contributions [en]

Whilevarn

2011-10-01T19:28:52Z

DeeperThought:

'''whilevarn''' <[[gamevar]]> <value> { code to execute }<br>
'''whilevarvarn''' <[[gamevar]]> <[[gamevar]]> { code to execute }

Executes the code in the curly braces as long as <gamevar> does not equal <value>. This is a simple while loop.

Caution: Poor execution or endless loops will cause your game to close without error or simply stall and crash!

This example will set up the palette of the floor from all sectors on the map:
<pre>
gamevar TEMP 0 0
onevent EVENT_LOADACTOR
setvar TEMP 0
whilevarvarn TEMP NUMSECTORS
{
setsector[TEMP].floorpal 1
addvar TEMP 1
}
endevent
</pre>

There's no variable keeping the number of sprites in the map. The sprites may be randomly arranged throughout the array with a maximum of 16384 entries. An example of a correct per-sprite loop:

<pre>
setvar sectnum 0
whilevarvarn sectnum NUMSECTORS
{
headspritesect I sectnum
setvarvar HEAD I
whilevarn I -1 {
// LOOP CODE
nextspritesect I I
ifvarvare I HEAD setvar I -1 // Break the loop
}
addvar sectnum 1
}
</pre>

{{varsuffix}}

[[Category:EDuke32 specific commands]]

Constantly updated gamevars

2011-10-01T19:24:06Z

DeeperThought:

These are [[gamevar]]s which are defined as direct pointers to internal variables in the game. While some will change frequently, others will remain static for the whole game. Please note that the values of most of these variables will be different on each peer, so you must not rely on them for anything that could possibly have an effect on sync. As such, these variables are ''only'' for use within local events such as those which allow you to display tiles on the screen. See also [[Pre-defined gamevars]].

The "Current actor or player" group of variables point to the current actor/player. The other ones point to internal and usually global variables.

<strong>Do not attempt to redefine these unless you know what you are doing or you will have problems.</strong>

{| cellpadding="0" cellspacing="0" border="0" width="100%"
| width="33%" valign="top" style="border-right: none; padding: 0.6em;" |
Map
*[[RESPAWN_MONSTERS]]
*[[RESPAWN_ITEMS]]
*[[RESPAWN_INVENTORY]]
*[[MONSTERS_OFF]]
*[[MARKER]]
*[[FFIRE]]
*[[LEVEL]]
*[[VOLUME]]
*[[NUMWALLS]]
*[[NUMSECTORS]]

Multiplayer
*[[COOP]]
*[[MULTIMODE]]

Current actor or player
*[[WEAPON]]
*[[WORKSLIKE]]
*[[RETURN]]
*[[ZRANGE]]
*[[ANGRANGE]]
*[[AUTOAIMANGLE]]
*[[LOTAG]]
*[[HITAG]]
*[[TEXTURE]]
*[[THISACTOR]]

| width="33%" valign="top" style="border-right: none; border-left: none; padding: 0.6em;" |
Screen drawing
*[[gs]]
*[[gun_pos]]
*[[looking_angSR1]]
*[[looking_arc]]
*[[weapon_xoffset]]
*[[weaponcount]]
*[[windowx1]]
*[[windowx2]]
*[[windowy1]]
*[[windowy2]]
*[[xdim]]
*[[ydim]]
*[[yxaspect]]

Renderer
*[[framerate]]
*[[rendmode]]

Misc
*[[current_menu]]
*[[currentweapon]]
*[[display_mirror]]
*[[gametype_flags]]
*[[gravitationalconstant]]
*[[lastvisinc]]
*[[myconnectindex]]
*[[numplayers]]
*[[NUMSECTORS]]
*[[randomseed]]
*[[screenpeek]]
*[[totalclock]]
*[[viewingrange]]
*[[lastsavepos]]

| width="33%" valign="top" style="border-left: none; padding: 0.6em;" |
Camera
*[[camerax]]
*[[cameray]]
*[[cameraz]]
*[[cameraang]]
*[[camerahoriz]]
*[[camerasect]]
*[[cameradist]]
*[[cameraclock]]

Player position
*[[myx]]
*[[myy]]
*[[myz]]
*[[omyx]]
*[[omyy]]
*[[omyz]]
*[[myxvel]]
*[[myyvel]]
*[[myzvel]]

Player properties
*[[myang]]
*[[mycursectnum]]
*[[myhardlanding]]
*[[myhoriz]]
*[[myhorizoff]]
*[[myjumpingcounter]]
*[[myjumpingtoggle]]
*[[myonground]]
*[[myreturntocenter]]
*[[omyang]]
*[[omyhoriz]]
*[[omyhorizoff]]
|}

[[Category:Gamevar manipulation]]

EDuke32 Modifications

2011-07-30T01:29:14Z

DeeperThought:

<table width ="100%" style="border:1px solid #000">

<tr style="background:#000; color:#fff"><td width="25%">Title</td>
<td width="25%">Type</td>
<td width="25%">Status</td>
<td width="25%">Creator(s) & Developer(s)</td></tr>

{{Mod_table
|[http://fissile.duke4.net/fissile_dukeplus.html Duke Plus]
|Gameplay enhancement
|Released, in development<br>(Latest Release: '''2.21''')
|[[User:DeeperThought|DeeperThought]]
|[[Image:DP1.jpg|200px]][[Image:DP2.jpg|200px]]
|Enhanced Engine Design Capabilities, including: Transparent Water; Giving Monsters Special Flags; Climbable Ladders; Mantling/Grappling on ledges; Bot-Allies; Footstep Sounds; Rain and Snow-based weather effects; Quake3-Style Jump Pads; Slippery Floors; etc. [http://www.picturepush.com/public/652573 Gravity gun footage]
}}

{{Mod_table
|[http://hendricks266.duke4.net/vaca_plus.php Duke Caribbean: Life's A Beach Plus]
|Total Conversion/enhancement
|Released, in development<br> (Latest Version: '''v2.0''')
|[[User:Hendricks 266|Hendricks266]] and the Duke community
|[[Image:2492_vaca.png|200px]][[Image:3281_vaca.png|200px]]
|Duke takes a vacation to the Caribbean and discovers that the aliens are using the tropical climate to breed. The classic Duke 3D add-on gets a modern facelift, and additional enhancements.
}}

{{Mod_table
|[http://hendricks266.duke4.net/nw_plus.php Duke: Nuclear Winter Plus]
|Total Conversion/enhancement
|Released, in development<br> (Latest Version: '''v2.0''')
|[[User:Hendricks 266|Hendricks266]] and the Duke community
|[[Image:2492_nw.png|200px]][[Image:3240_3245.png|200px]]
|Duke receives a telegram that the aliens have brainwashed Santa and are trying to steal Christmas! The HRP of the classic Duke add-on, Nuclear Winter, adds many new EDuke32-based elements to the game, and fixes most, if not all of the original bugs.
}}

{{Mod_table
|[http://www.resurgence.dukenukem.com.br/ Duke Nukem 64: Resurgence]
|Total Conversion
|In Development
|Fox, Nukey, SomeThingEvil, Hellfire
|[[Image:Duke64_1.png|200px]][[Image:Duke64_2.png|200px]]
|Duke Nukem 64: Resurgence intends to bring this Nintendo experience from 1997 to your PC.

There will be customization options, such as removing Nintendo's censoring.
}}

{{Mod_table
|[http://naferia.duke4.net Naferia's Reign: Invasion of the Dark Mistress]
|Total Conversion
|Released, in development<br> (Latest Version: '''5.20.06112010''')
|[[User:LordMisfit|Lord Misfit]], TheSeriousCacodemon, Davidos, Vero-chan
|[[Image:NRIOTDM-1.png|200px]][[Image:NRIOTDM-2.png|200px]]
|What will come to be an alternate-universe Duke Nukem story revolving around a pivotal point in the history of Duke Nukem and the Aliens he has faced since the original Duke Nukem 3D. Duke is no longer working alone in his quest, as his enemies ramp up their power and allegiances substantially, as well as their intelligence to a point. Play as up to 15 different characters, with the ability to use multiple characters in the same party, unlike in Hexen (and more like a real RPG). Monsters are more interactive and to a point more intelligent, able to grab items like health and armor, get damaged by slime and other hazards, and even pick up power-ups to make them deadlier in combat. Find money laying around or get it out of your characters' ATM accounts, and use it to buy new items from shops or other NPCs. Voice Acting is also present.
}}

{{Mod_table
|[http://www.moddb.com/mods/9541/duke-nukem-weapon-of-mass-destruction Duke Nukem: Weapon of Mass Destruction]
|Gameplay enhancement
|Released<br>(Latest Release: '''1.52 [beta]''')
|[[User:DeeperThought|DeeperThought]]
|[[Image:Dnwmd1.jpg|200px]][[Image:Dnwmd2.jpg|200px]]
|Duke Nukem: Weapon of Mass Destruction is a gameplay mod for Duke Nukem 3D. It has tons of new weapon modes, enemies, and player abilities, such as UT style dodge moves, spinning hook kicks, and a Duke bot companion who fights by your side. In some levels you can even get in your skycar and fly it, doing bombing runs on enemies. In DNWMD, Duke collects glowing coins from slain enemies which are used to purchase various upgrades via a mouse controlled menu. In addition, each of Duke's weapons has its own experience level which increases with use.
}}

{{Mod_table
| [{{3DR}}32161 HellDuke TC!]
|Total Conversion
|Released, in development<br>(Latest Release: '''1.3''')
|XTHX2, Quakis (Inactive), Broiler1985, Rolls, Fantinaikos, SuperGoofy
|[[Image:scr1.jpg|200px]][[Image:scr2.jpg|200px]]
|HellDukeTC! will make your doom become alive, as the thread name calls it. My main purpose is to create Doom with a different angle and of course my secret recipe. As well as aiming to have a doom theme, we will also introduce you what hell actually means. It is still under development, however it is playable enough with it's satisfying levels, new enemies, new additions, new WEAPONS!, new HUD, CON scripted EVENTS, and much more. And last but not least, extra information can be found at hellreadme.txt. If you have any questions, you can ask me, XTHX2, and contact me. If you like Doom, and if you like challenges, this TC is just what you are in need of!
}}

{{Mod_table
|[http://files.filefront.com/Nuclear+Showdown+v11zip/;12148372;/fileinfo.html Nuclear Showdown v1.1]
|Gameplay enhancement
|Released
|[[User:Jblade|James Stanfield]]
|[[Image:NS01.jpg|200px]][[Image:NS02.jpg|200px]]
|Nuclear showdown is a gameplay mod for Duke Nukem that adds many features such as new weapons, enemies, effects to the default game as well as usermaps - it is built so you can play your favourite usermaps with, even ones that use custom art. You can also play through Duke It Out In D.C. if you have it. The TC also includes several features for mappers like more keycards, items such as the spacesuit and toolkit, and more textures to work with.
}}

{{Mod_table
|[{{3DR}}25830 The AWOL Project Source]
|Total Conversion
|Released, discontinued
|[[User:Reaper_Man|Reaper_Man]], Hudson, Mblackwell, and the entire AWOL TC Team
|[[Image:AWOL1.jpg|200px]][[Image:AWOL2.jpg|200px]]
|The AWOL Project Source is the release of the source files for the once highly anticipated mod, The AWOL Project. After several years of sitting idly on the hard drives of the creators, Reaper_Man and Hudson decided to release all of the content for the TC to those who might find it useful. The release includes a few demo maps showing off various effects and AI, as well as all 3 of the drivable vehicles. Most of the code is complete but very few of the maps are. There is an Official 1.0 Patch as well as the AWOL Map Pack available for download also.
}}

{{Mod_table
|[http://hosted.filefront.com/kenia43 Duke Nukem Army]
|Total Conversion
|Official final Release
|[[User:Kenia|Kenia]]
|[[Image:Teaser2.jpg|200px]][[Image:Teaser3.jpg|200px]]
|A TC that changes Duke Nukem 3D into an exaggerated army-style shooter with various multiplayer additions (CTF, Hill Defend, Assault). Main focus is multi-player (though 1 playable single-player episode is included) and the massive unrealistic use of gore elements to turn the TC in kind of a "splatter game". [{{YouTube}}xl1E9BtOe9U Gameplay footage]
}}

{{Mod_table
|[{{3DR}}30761 WG Medieval Mod]
|Total Conversion
|Unreleased, in development
|William Gee, [[User:DeeperThought|DeeperThought]], Hellbound
|[[Image:WG1.jpg|200px]][[Image:WG2.jpg|200px]]
|Medieval mod with melee combat, magic bows, skeleton knights, dragons and demons. [http://www.picturepush.com/public/590728 Gameplay footage]
}}

{{Mod_table
|[{{3DR}}25350 Symphony of Orekia (AKA The Mansion)]
|Total Conversion (single level)
|Unreleased, in development
|Quakis
|[[Image:Mansion1.jpg|200px]][[Image:Mansion2.jpg|200px]]
|Resident Evil-style TC with Demons and creepy interiors.
}}

{{Mod_table
|[{{3DR}}9670 Decay]
|Total Conversion
|Unreleased, in development
|Hudson, MBlackWell, Hellbound, Cage, others
|[[Image:Decay1.jpg|200px]][[Image:Decay2.jpg|200px]]
|Survival-horror TC with zombies!
}}

{{Mod_table
|[{{3DR}}30962 Blood TC]
|Total Conversion
|Unreleased, in development
|[[User:M210|M210]]
|[[Image:Blood1.jpg|200px]][[Image:Blood2.jpg|200px]]
|BloodTC is a recreation of Blood (by Monolith Productions) for EDuke32 to bring all the fun and action of Blood to the EDuke32 port. This mod will be more powerful in the future, considering EDuke32 keeps getting better and better.
'''Big thanks:''' The Lezing, DeeperThought, DefaultDan(97), Zykov Eddy, --DarkSoL--, Yura_evil, KLIMaka, XTHX2, Ilovefoxes, Sanek, LipSheZ, Possessed-by-zeal.
'''Some videos'''
<br>[{{YouTube}}3thhSyIGPZQ BloodTC Beta Video E1M1]
<br>[{{YouTube}}rhNNtd0Sp9w Animation of weapon test and some effects]
<br>[{{YouTube}}2r2qj5pTAJs Second weapon-test Video]
}}

{{Mod_table
|[{{AMC}}7591.0 AMC TC]
|Total Conversion
|Unreleased, in development
|James Stanfield and AMC
|[[Image:AMCTC1.jpg|200px]][[Image:AMCTC2.jpg|200px]]
|The AMC TC is a multi-character TC and gameplay modification. There are 8 characters to choose between, each with different weapon sets and items. Fight through the solar system against Duke's old enemies as well as other dark forces that each plan something unpleasant for Earth and Mars. A initial gameplay release with the finished characters, intro map, and Duke user map episode is planned with actual story based releases later.
}}

{{Mod_table
|Duke Nukem: Return of the King
|Total Conversion
|Unreleased, in development
|[[User:Captain Awesome|Captain Awesome]]
|[[Image:DukeROTK.gif|200px]][[Image:DukeROTK2.gif|200px]]
|Duke Nukem: Return of the King plans to centralize Duke's universe. The game will fix numerous bugs, graphical glitches, logical fallacies, and other problems with Duke3D. The mod will boast an impressive amount of new weapons, and a few alt-fire modes. It will also feature quite a few new enemies or variants, with improved coding over the originals. There is a new thought out approach to the traditional episodes, along with new missions for you to play. It plans to bring a completely fresh experience to the old game, while still being familiar and simple. This mod is 8bit exclusive, and completely incompatible with the HRP. Retains compatibility with ''most'' user-maps for replay value.
}}

{{Mod_table
|[http://hendricks266.duke4.net/dmdr.php Duke Meets DOOM Rebirth]
|Total Conversion
|Unreleased as Rebirth, in development
|[[User:Hendricks 266|Hendricks266]]
|[[Image:DMDR_001.gif|200px]][[Image:DMDR_002.jpg|200px]]
|Duke Meets DOOM Rebirth is an upgrade of the original vanilla TC "Duke Meets Doom". The basis for this mod is that the original maps are good, but the coding and artwork were sloppy. There are three different art modes available. The first is Classic, which consists of the artwork converted to the Duke palette. The second is Faithful, which has the original artwork displayed as high-resolution textures, so that it won't be hindered by the differences of the DOOM, Duke, and Shadow Warrior palettes. The third is Updated, which introduces high-resolution content from the jDRP and related packages.
}}

{{Mod_table
|[{{3DR}}31983 Cradle to Grave]
|Total Conversion
|Unreleased, in development
|Daedalus, Dimebog, Daedolon, Tekedon
|[[Image:Screen00.PNG|200px]][[Image:Screen01.png|200px]]
|Cradle to Grave is a hyper-mod aiming to bring the frantic pace and hugely enjoyable gameplay of Blood (by Monolith Productions) into a new medium and with our new granted freedom we'll even be able to implement some of the ideas which didn't quite make it into the original, not limited to new and never released weaponry, enemies, gameplay modes and perhaps even magic. This product exists only as our homage to Blood's spirit and, if successful, it could help bring Blood's glory to new heights.
}}

{{Mod_table
|[[Duke Theft Auto]]
|Total Conversion
|Beta Released, On Hold
|[[User:The Commander|The Commander]]
|[[Image:DTA0000.jpg|200px]][[Image:DTA0001.jpg|200px]]
|Duke Theft Auto is based upon the classic DMA/Rockstar game, "Grand Theft Auto" Run, Shoot, Kill, Car Jack your way through many cities on your way of becoming the number one criminal! <br><br> [http://www.moddb.com/games/duke-theft-auto Beta Released]
}}

{{Mod_table
|[http://totalduke.narod.ru RailSingle TC]
|Total Conversion
|Unreleased, in development
|[[User:LipSheZ|LipSheZ]]
|[[Image:RS1.jpg|200px]][[Image:RS2.jpg|200px]]
|Rail Single is a mod based on early version of Duke Plus and includes some amazing features such as 22 weapon types (each weapon has 2 fire modes), approx 30 different voxel ammo pickups and 20 inventory items. Most of RS levels are king-size, but in the spirit of the original Duke Nukem: Atomic Edition. Some level segments made with LEBuild Map Editor.
}}

</table>

Cstat

2011-04-14T21:14:05Z

DeeperThought:

'''cstat''' <number>

A [[bitfield]] for how to draw an actor, as well as a few flags for interaction. Add all together all wanted flag values, and use that as <number>.

Cstat is available for [[sprite]] structs and for [[Members of the wall structure|wall]] structs. See [[cstat(wall)]].

Flag values for sprite cstat are:

:'''1''' - Make sprite blockable
:'''2''' - Make sprite transparent
:'''4''' - Flip sprite around x-axis
:'''8''' - Flip sprite around y-axis
:'''16''' - Draw sprite as vertically flat (wall aligned)
:'''32''' - Draw sprite as horizontally flat (floor aligned)
:'''64''' - Make sprite one sided
:'''128''' - Half submerged
:'''256''' - Make sprite able to be hit by weapons
:'''512''' - Second transparency level (combine with cstat 2)
:'''2048'''- Sprite will not be forced to take shade of sector
:'''8192''' - Sprite will not cast a Polymer shadow
:'''16384''' - Sprite will be invisible but will still cast a Polymer shadow
:'''32768''' - Invisible

Also see [[cstator]].

[[Category:Bitfields]]
[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Prevspritestat

2011-03-01T01:40:16Z

DeeperThought: Created page with "'''nextspritestat''' <PrevSpriteID> <CurrentSpriteID> Finds the previous sprite in the linked list of sprites having the same statnum. See headspritestat for more informatio..."

'''nextspritestat''' <PrevSpriteID> <CurrentSpriteID>

Finds the previous sprite in the linked list of sprites having the same statnum. See [[headspritestat]] for more information.

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

Nextspritestat

2011-03-01T01:37:23Z

DeeperThought: Created page with "'''nextspritestat''' <NextSpriteID> <CurrentSpriteID> Finds the next sprite in the linked list of sprites having the same statnum. See headspritestat for more information. ..."

'''nextspritestat''' <NextSpriteID> <CurrentSpriteID>

Finds the next sprite in the linked list of sprites having the same statnum. See [[headspritestat]] for more information.

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

Actor

2011-03-01T01:16:58Z

DeeperThought:

'''actor''' <name> <strength> <action> <move> <ai> { actor code } [[enda]]

<name> is the name/tile of the actor. You can either input a [[define]]d name, or the tile number directly.

<strength> is the health of the actor.

<action> is the intial [[action]] an actor uses (optional).

<move> is the initial [[move]] of the actor (optional).

<ai> is the actor's initial [[ai]] routine (optional).

{ actor code } is the code for the actor.

[[enda]] ends an actor.

Loosely speaking, actors are sprites that run code in game, such as enemies and breakable props. More precisely, an actor is a sprite with a statnum of 1. Sprites with that statnum will execute their actor code once every game tic. Prior to version 1.4, only the tile numbers hardcoded to be actors could be actors. In the GAME.CON script file, they were designated by the [[actor]] command.

Version 1.4 introduced the [[useractor]] syntax which allows use of any tile number as an actor.

Example actor:
define SOMEACTOR 3585

'''actor''' SOMEACTOR 0
ifpdistl 1024
{
palfrom 32 0 16 0
}
enda

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Stopactorsound

2010-07-09T05:14:23Z

DeeperThought: Created page with ''''stopactorsound''' <sprite ID> <sound#> Causes the specified actor to stop playing the specified sound. Unlike stopsound, it will only stop a sound coming from one actor....'

'''stopactorsound''' <sprite ID> <sound#>

Causes the specified actor to stop playing the specified sound. Unlike [[stopsound]], it will only stop a sound coming from one actor. This is useful, for example, if one of the player's weapons makes a looping sound, and you want the sound to stop as soon as the player changes weapons, but allow other instances of the sound (e.g. from other players) to continue.

[[Category:EDuke32 specific commands]]
[[Category:Sound manipulation]]

Spritenoshade

2010-06-10T18:47:17Z

DeeperThought:

'''spritenoshade''' <tilenum>

Causes [[sprite]] <tilenum> to be unaffected by the [[shade]] of the [[sector]] it is in. This command should be used outside of actors, states or events (like a definition).

If you want an [[actor]] to glow like some projectiles in the game, use this together with [[setactor]]<nowiki>[</nowiki>[[THISACTOR]]<nowiki>]</nowiki>.[[shade]] -127 and/or the [[flash]] parameter.

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

Canseespr

2009-12-05T17:09:25Z

DeeperThought:

'''canseespr''' <spriteID1> <spriteID2> <returnvar>

The three parameters are [[gamevar]]s.

canseespr sets <returnvar> to 1 if the sprite with ID <spriteID1> has a line of sight with the sprite with ID <spriteID2>, otherwise <returnvar> is set to 0.

Visibility is checked from the bases of the sprites. It is as if there were cameras on the bottoms of the sprites' feet and they were trying to see each other with those cameras. As a result, the visibility check will usually come back negative on uneven ground and in other situations where the sprites should be able to see each other. To remedy this, you can move one or both of the sprites to a higher position right before the canseespr check, then move them back down again before the move has any unwanted effects.

For example:

getactor[THISACTOR].z ZPOSITION // assuming there is already a declared variable ZPOSITION
subvar ZPOSITION 8192
setactor[THISACTOR].z ZPOSITION
canseespr THISACTOR TARGET RETURN
addvar ZPOSITION 8192
setactor[THISACTOR].z ZPOSITION

[[Category:EDuke32 specific commands]]
[[Category:Gamevar manipulation]]

Cstat

2009-11-09T20:01:38Z

DeeperThought:

'''cstat''' <number>

Sets flags for how to draw an actor, as well as a few flags for interaction. Add all together all wanted flag values, and use that as <number>. This is because cstat is a bitfield.

Cstat is available for [[sprite]] structs and for [[Members of the wall structure|wall]] structs. See [[cstat(wall)]].

Flag values for sprite cstat are:

:'''1''' - Make sprite blockable
:'''2''' - Make sprite transparent
:'''4''' - Flip sprite around x-axis
:'''8''' - Flip sprite around y-axis
:'''16''' - Draw sprite as vertically flat (wall aligned)
:'''32''' - Draw sprite as horizontally flat (floor aligned)
:'''64''' - Make sprite one sided
:'''128''' - Half submerged
:'''256''' - Make sprite able to be hit by weapons
:'''512''' - Second transparency level (combine with cstat 2)
:'''8192''' - Sprite will not cast a Polymer shadow
:'''16384''' - Sprite will be invisible but will still cast a Polymer shadow
:'''32768''' - Invisible

Also see [[cstator]].

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Lockplayer

2009-11-08T10:26:46Z

DeeperThought:

'''lockplayer''' <gamevar>

Stops player movement (except the ability to look up/down with the mouse) for the amount of time denoted by the [[gamevar]] <gamevar>. Each unit is 1/26 of a second.

Caution: If this command is used while the player is under water (in a lotag 2 sector), the player will not be able to surface.

[[Category:EDuke commands]]
[[Category:Player manipulation]]

Clearmapstate

2009-11-03T15:48:48Z

DeeperThought: Created page with ''''clearmapstate''' <level> Clears the specified map from the map cache. Used in conjunction with savemapstate.'

'''clearmapstate''' <level>

Clears the specified map from the map cache. Used in conjunction with [[savemapstate]].

Loadmapstate

2009-11-03T15:46:02Z

DeeperThought:

'''loadmapstate''' restores the current map to the state it was in when the [[savemapstate]] command was last used in that map. Thus, all the sprites will be in the positions they were in at that time, any sectors that were activated will still be activated, variables will be restored to the values they had at that time (unless the variables were declared with the flag for preventing this), etc. If there is no cached copy of the map (either because [[savemapstate]] was not used in the map or the state was cleared using [[clearmapstate]]) then '''loadmapstate''' does nothing.

Loadmapstate

2009-11-03T15:45:05Z

DeeperThought: Created page with ''''loadmapstate''' restores the current map to the state it was in when the savemapstate command was last used in that map. Thus, all the sprites will be in the positions th...'

Savemapstate

2009-11-03T15:38:28Z

DeeperThought: Created page with ''''savemapstate''' saves the state of the current map so that it may be restored later using loadmapstate. Typically, '''savemapstate''' would be used immediately before exi...'

'''savemapstate''' saves the state of the current map so that it may be restored later using [[loadmapstate]]. Typically, '''savemapstate''' would be used immediately before exiting a level, so that if the player returns to the map, it can be restored to the state it was in when the player left it. '''savemapstate''' will increase the size of saved game files, depending on the number of different maps that are cached. See also [[clearmapstate]].

Confaq42

2009-09-20T03:32:28Z

DeeperThought:

<strong>NOTE: All of the information on this page is from around 1999. Some of it is outdated, some of it is just plain incorrect -- this page exists merely to get you started with the very basics of CONs and does not cover any of the additional features introduced in EDuke and EDuke32. In the original DOS Duke 3D, the CON scripting language was relatively limited, and was mainly used to code simple AI routines for monsters and manipulate the player's inventory amounts. Most aspects of the game, such as weapon firing rates, camera positioning, and physics, could not be altered. By contrast, in EDuke32 virtually all aspects of the game can be accessed and manipulated via events, structures and variables, none of which are covered in this document. Nevertheless, this document still serves as a useful introduction to CON coding.</strong>

<div class="floatleft">__TOC__</div>
==A GENERAL CON OVERVIEW==
===Con File Editing - An Introduction===

Con file editing is one of the coolest aspects of Duke Nukem 3D, and can be very productive in making Total Conversions and other game add-ons. Although it can look very difficult at first, editing con files is very easy and a fun way to make one of the coolest games in history even cooler.

How does one edit con files you ask? Any text editor will do. I personally use Microsoft Wordpad (not Word) to edit con files (this program comes with Windows 95), but you can use any text editor you wish. The Microsoft Notepad program is not large enough to edit con files (the files are too big for notepad to handle), but the DOS editing program works quite well. Simply open up your favorite text editor and open the con file that you wish to edit.

OK - You've opened a con file, but what do I do now? Well, if you're really serious about con file programming, you need to read through this FAQ. Even if you're not so serious about editing con files, quickly skim through this FAQ to find out how to edit some of the easiest parameters and settings in Duke Nukem 3D. You can do some very cool stuff with con files, so stick with it if you don't get it right away. If you have ever done any programming, you will instantly be able to edit con files.

The most important instruction, however, for editing con files is simply - Have fun! This stuff shouldn't make you frustrated - if you aren't getting something, take a look through this FAQ, or visit the editing and hacking forum at Dukeworld. I personally hope you enjoy your con editing experience.

===DEFS.CON===

This con file is the file where all basic definitions are made. Definitions for sounds, actors (sprites), and some other miscellaneous items can be found in this file. This file is included by the game.con at compile time (when the game is run).

===USER.CON===

This con file is one of the easiest to edit. Parameters such as weapon strengths, health values, ammo values, level names, quotes, names of sounds, names of episodes (version 1.4 and 1.5 only), names of difficulty levels (version 1.4 and 1.5 only), and more exist in this con file. This is a fun con to edit, especially if you never wish to get deeply involved into con editing and hacking. This file is also included by the game.con at compile time (when the game is run).

===GAME.CON===

This con file is the largest and the most complicated con file to edit. This file holds all the code for most actors in the game (some of the actors are hard coded). Most of the primitives available are used in this con file, and things can get quite complicated if you don't know where to start. This file gets compiled first at compile time, and includes (#include) the other two con files provided by 3D Realms. This is the con file to work with if you seriously want to get into con editing and hacking.

==CON BUILDING BLOCKS==

===What is an action?===

An action is used to give a group of sprites, usually which are animated (as in an enemy movement or other such animated examples), a name. The structure for this primitive is:

action <name> <startframe> <frames> <viewtype> <incvalue> <delay>

<name>

This is the name of the action. This is simply a string which can be up to 64 characters in length.

<startframe>

This is the relative starting frame number (relative to the main sprite of the action that is). For example, if you want the Pigcop to look like the atomic health, you need to give the starting frame a number of -1900 since the Pigcop sprite is located at 2000 and the atomic health sprite is located at 100 (100 minus 2000, is -1900).

<frames>

This value is the total number of frames in the action.

<viewtype>

This value determines whether the sprite is one sided (it looks the same no matter what angle you see it from) or 3-Dimensional. Legal values for this parameter are:

* 0: Single image - It always faces the player no matter where they look from.

* 5: Five images - The first image is looking from the front, the second is 45 degrees from the front, the third is from the side, the fourth is 45 degrees from the rear (135 degrees from the front), and the fifth value is looking from the rear. The second, third, and fourth are used for either side of the image.

* 7: Seven images - Same as 5, except there are seven images, with images 2, 3, 4, 5 and 6 are on both sides. Image 4 is the side images, 1 and 7 are the front and rear respectively. These increment every 30 degrees.

* 8: Eight images - The first image is looking from the front, the second is 45 degrees from the front to the left, the third is from the left side, the fourth is 135 degrees from the front to the left, the last/fifth value is looking from the rear, the sixth is 135 degrees from the front to the right, the third is from the right side and the fourth is 45 from the front to the right.

<incvalue>

This parameter specifies the "direction" of the animated frames. A value of 1 causes the animation to go forwards (Example: The animation starts at tile #20, goes to #21, then to #22, etc.). A value of -1 causes the animation to go backwards (Example: The animation starts at tile #20, goes to #19, then to #18, etc.).

<delay>

This determines how long each frame of the animation lasts. Bigger values allow each frame to last longer.

===What is an actor?===

An actor is a sprite that will perform some function (spawn another sprite, give the player ammo, etc.) by performing several lines of code.

The structure for this primitive is:

actor <name> <strength> <action> <speed> <aifunction> {actor code} enda

<name>

This parameter is usually a string (such as PIGCOP) that is used to set the initial sprite of the actor. If you look in DEFS.CON, you will see that PIGCOP is defined to be 2000, meaning that the initial sprite for the PIGCOP actor is sprite #2000.

<strength>

This is the "health" value of the actor. If a value of 0 is used, the actor cannot be destroyed.

<action>

This parameter is the action that the actor is to use initially.

<speed>

This is the rate of movement of the current actor. A value of 0 means that the actor cannot move.

<aifunction>

The actor's initial ai routine. This is really only used with monsters.

{actor code}

Now that we have defined our actor, we have to write its code. Each time the actor being referenced is called (and this happens every frame for most animated actors), the code here is executed. This can be many lines of code, since you are grouping them together with the curly braces.

enda

This parameter signals the end of the actor definition.

Notes:

In version 1.3D of Duke Nukem 3D, new actors cannot be added. The name of an existing actor, its corresponding code, and the artwork itself can be changed to add new actors (if you want to go to all of this trouble).

In versions 1.4 or 1.5, however, you can create your own actors (without having to replace existing ones). See the section on "useractor" for more information on this.

===What is an ai?===

An ai is an "artificial intelligence" routine. This is basically a set of code that an actor follows when said actor is instructed to do so. The structure for this primitive is:

ai <name> <action> <speed> <type>

<name>

This is a name to identify this ai routine later on.

<action>

This value is the name of the action that the actor will cycle through when he uses this ai function (i.e. - the animation it will use).

<speed>

The rate of movement of the character when using this ai function. Negative values are allowed in this parameter.

<type>

Determines the type of ai routine. The ai types are already programmed into the game so you can't change these. Some of the legal types are:

* faceplayer: Actor faces the player's current position.

* geth: Actor travels in a horizontal direction.

* getv: Actor travels in a vertical direction.

* randomangle: Actor will change to a random angle when it touches a wall or when the actor is currently being shot at by the player. Only seems to work when the actor is a monster.

* faceplayerslow: Actor faces the player's current position but slower than the regular faceplayer command.

* spin: Actor spins in circles.

* faceplayersmart: The actor will face slightly ahead of the player's current position, making it possible for monsters to "lead" you a little bit.

* fleeenemy: Actor faces directly away from the player.

* jumptoplayer: Actor attempts to jump.

* seekplayer: Actor tries to find and move to the nearest player.

* furthestdir: Actor faces the furthest distance from the closest player.

* dodgebullet: Actor attempts to avoid all shots directed at him.

You can use more than one ai at the same time by listing them in order in the code that you write. For example: randomangle dodgebullet fleeenemy

===What is a state?===

A state is a set of code that you will use several times (this is very useful in that you don't have to write the same code over and over). The usage for this primitive is as follows:

state <name> {code} ends

<name>

This is the name of your state function. Can be any string.

{code}

This is simply the lines of code that you want to have executed when the state is called. This can be any number of lines you want.

ends

This parameter signals the end of the state definition.

Here is an example of a state:

<pre>
state findgoldenapple // Start and name the state itself.
{
quote 150 // This is the code to execute...
addphealth 10
}
ends // End of state. Now returns to its caller.
</pre>

To call a state from your code, simply type the following:

state <name>

The <name> parameter is simply the state that you want to call.

===What is a useractor?===

[This function only works with versions 1.4 and 1.5]

The useractor command is a new addition to versions 1.4 and 1.5. It allows people to create their own actors without having to replace old ones. It's usage is almost exactly like regular actors.

The structure of the useractor command is as follows:

useractor <type> <name> <strength> {actor code}

<type>

This parameter is the type of actor that you want to create. The legal values are as follows:

* enemy : The actor's code will not be executed until approximately 1 second after the player has spotted the actor.

* notenemy : The actor's code will not be executed until the player has spotted the actor.

* enemystayput : The actor will not leave the current sector when the player goes out of sight (i.e. - the actor can no longer "see" the player). This is most useful in custom enemy creation.

<name>

This parameter is usually a string (such as PIGCOP) that is used to set the initial sprite of the actor. If you look in DEFS.CON, you will see that PIGCOP is defined to be 2000, meaning that the initial sprite for the PIGCOP actor is sprite #2000.

<strength>

This is the "health" value of the actor. If a value of 0 is used, the actor cannot be destroyed.

{actor code}

This is the code that the actor will run. This code includes the following items:

<action>

This parameter is the action that the actor is to use initially.

<speed>

This is the rate of movement of the current actor. A value of 0 means that the actor cannot move.

<aifunction>

The actor's initial ai routine. This is really only used with monsters.

===What is an if construction?===

If statements are perhaps the most powerful aspect of CON file editing. If statements evaluate the specified condition, and run code based on the returned value of the evaluation.

Here is an example:
<pre>
ifphealthl MAXPLAYERHEALTH
addphealth MAXPLAYERHEALTH
else
quote 999
</pre>
This simple example simply says this:

If the player's health is less than MAXPLAYERHEALTH (which by default is 100), add MAXPLAYERHEALTH to the player's current health.
Else, if the player's health is not less than MAXPLAYERHEALTH, print quote number 999

==A COMPLETE PRIMITIVE LISTING==
===The Complete Primitive List===

<strong>Note by TerminX: this list is outdated and obsolete. See [[full_command_list|this page]] for the current list of primitives.</strong>

The following is a complete listing of all the "primitives" that can be placed into Duke Nukem 3D CON files. Primitives are simply commands and syntax in code that can control and test the items in the game.

If you find any errors in this section, e-mail me at: jonahb@3dportal.com

//

This is used (just like in C\C++) to denote comments. Everything after this comment mark is ignored by the compiler. A space must follow this comment mark, or the compiler will generate an error.

/* and */

These two marks are used to create comment blocks (just like in C\C++). Place the /* at the beginning of the area you wish to ignore, and the */ at the end of the area you wish to ignore. This is a handy way to create large comments or to ignore an entire section of code.

{ and }

These symbols are used to group several lines of code into one block of code (also called a function). Used just like C\C++.

[[action]] <name> <startframe> <frames> <viewtype> <incvalue> <delay>

See section 2.1 for an in-depth look at this primitive.

action <name>

Starts the action specified by <name>.

[[actor]] <name> <strength> <action> <speed> <aifunction> {actor code} enda

See section 2.2 for an in-depth look at this primitive.

[[addammo]] <weapon> <amount>

Adds the <amount> of ammunition to the current or closest player's value for the appropriate <weapon>. Legal values for <weapon> can be found in section 4.1.

[[addinventory]] <item> <amount>

Adds <amount> to the current or closest player's value for the appropriate <item>. Legal values for <item> can be found in section 4.2.

[[addkills]] <amount>

Adds <amount> to the current or closest player's kill count.

[[addphealth]] <amount>

Adds the value <amount> to the current or closest player's health. Only the atomic health actor can boost the player's health value over the MAXPLAYERHEALTH value.

[[addstrength]] <value>

Adds <value> to the strength (health) of the current actor.

[[addweapon]] <weapon> <ammo>

Gives the current or closes player the specified <weapon> with an initial amount of ammunition equal to <ammo>. Legal values for <weapon> can be found in section 4.3.

[[ai]] <name> <action> <speed> <type>

See section 2.3 for an in-depth look at this primitive.

ai <name>

Makes the ai function <name>, the current actor's current ai routine.

[[break]]

Immediately leave the current state or actor code.

[[cactor]] <actor>

Change from the code of the current actor to the code of the actor identified by <actor>. All initialization values of the specified <actor> are ignored when this primitive is used.

[[clipdist]] <value>

The <value> parameter can be any value from 0 to 255. When a sprite or actor is blocked (by setting blocking with the [B] key in Build or through the use of the cstat primitive in GAME.CON), a "force field" (for lack of a better term) is set up around the sprite. The clipdist value determines how close an actor can get to the sprite before being blocked by that invisible "force field". The lower the value, the closer the player or an actor can get. A clipdist of 255 equals the distance of the largest grid size in Build which equals 1024 Build units. The default for <value> seems to be 32. The same effect can also be achieved in Build by placing the cursor on the sprite (in 3D mode) and pressing the [ALT]+[D] key combination. Also, it would appear that this only works on a sprite that rotates with the player. If (in Build's 3D mode) you press the [R] key to align the sprite to the grid or to the floor, altering the clipdist primitive has no effect. In addition, this attribute does not work on all sprites. At this time there is no explanation for why this primitive should either work or not work.

[[count]] <number>

Sets the current actor's count to <number>.

[[cstat]] <mask>

This primitive manually sets some various flags for an actor (a sprite). All previous settings are lost when this function is used. The legal values for <mask> can be found in section 4.4.

[[cstator]] <mask> (Used in Versions 1.4 and 1.5 Only)

This primitive manually sets some various flags for an actor (a sprite). All previous settings are not lost when this function is used; they are simply added together. This is a little like the "or" in C\C++. The legal values for <mask> can be found in section 4.4.

[[debris]] <type> <amount>

This primitive causes debris to fly around the actor. The <type> parameter is the sprite group used for the debris. Legal values are: SCRAP1, SCRAP2, SCRAP3, SCRAP4, SCRAP5, and SCRAP6. The higher the <amount> value, the more debris.

[[debug]] <parameter>

Prints the value of <parameter> to the current output buffer. If a standard game is loaded, with the default output buffer being used, it will print the value to the screen. If the output buffer is changed (for example: "duke3d.exe -map test.map /q8 > test.log"), the standard output will be printed to the output buffer "test.log". You then can open this file later to look at the values that were printed out.

[[define]] <string> <value>

This primitive makes <string> equal <value>. This allows you to use the string (which is a lot easier to remember) in your coding. The following example sets the string MAXPLAYERHEALTH to the value of 100.

EXAMPLE: define MAXPLAYERHEALTH 100

[[definelevelname]] <eps> <lvl> <mapname> <par time> <3drealms>

Defines a level name where the episode number is <eps>, the level number is <lvl>, the map name (a string) is <mapname>, the par time is <par time>, and the 3D Realms time is <3drealms>.

[[definequote]] <value> <string>

Sets <string> equal to <value>. This is used when printing quotes at the top of the screen while in the game (it saves you from having to type the quote over and over).

[[defineskillname]] <skill> <string> (Used in Versions 1.4 and 1.5 Only)

Makes <string> equal the desired difficulty level (which is <value>). Legal values for <skill> are: 0, 1, 2, and 3. The higher the number, the harder the skill level. This is only used for setting the text of the skill levels on the skill level selection screen.

[[definesound]] <value> <file> <pitch1> <pitch2> <priority> <type> <volume>

The <value> parameter is the name of the sound (you make this up). The <file> parameter is the .voc or the .wav file that the game will try to find to use for this sound. The <pitch1> and <pitch2> are random pitch variations (these can be both negative and positive). The <priority> is the importance of the sound (telling the game that this sound has priority over other sounds). Values of 0 to 255 inclusive are acceptable for <priority>, with larger numbers being more important. The <type> is the type of sound in the game. Legal values for <type> are: The <volume> is the volume of the sound, ranging from -32,767 to 32,767. Negative values are louder and positive values are softer.

[[definevolumename]] <episode> <name> (Used in Versions 1.4 and 1.5 Only)

Defines title for each episode where <episode> is the episode number and <name> is the name it will get.

[[else]]

This is used in "if-else" statements. This returns true if the last function returned false.

[[enda]]

Closes an actor or useractor function.

[[endofgame]] <number>

Ends the game after <number> counts. For example, a value of 180 would end the game after approximately 6 seconds (30 = 1 second). A value of 52 is used to end each episode. This primitive obviously appears to exist as a "sleep" function of sorts. I believe that this is used to allow the death sequence of the boss to be completely viewed by the player, but this is only one suggestion as to its proper use.

[[ends]]

Closes a state function.

[[fall]]

Let the current actor fall until it hits a surface.

[[gamestartup]]

This is the main function which "starts" the game. It gets all the hard coded values passed as parameters. The values that get passed can not be changed during gameplay. There are too many parameters for this primitive to list here, so take a look at the user.con file.

[[getlastpal]]

Sets the palette of the current actor back to the color before the last change.

[[globalsound]] <sound>

Play sound that can be heard everywhere in the map. The <sound> value is the name of the sound to play (not the filename of the sound).

[[guts]] <type> <amount>

Same as debris but then for body parts. Legal values for <type> can be found in section 4.5. The <amount> value determines the amount of guts to make fly.

[[hitradius]] <radius> <1> <2> <3> <4>

Make an explosion (not the actual animation but just the damage). The <radius> value is the radius, <4> is how much damage is done in first quarter of circle (right near the center of the circle), <3> is how much damage is done in second quarter of circle, etc.

[[ifaction]] <action>

Test if the current actor is executing the giving <action>. The <action> parameter is defined by the action primitive (see section 2.1).

[[ifactioncount]] <number>

Tests if the actor has displayed a set <number> of frames since the last call to resetactioncount.

[[ifactor]] <actorid>

Returns true if the current actor is equal to <actorid>.

[[ifactornotstayput]]

Test if the current actor already <activated>, where <activated> means spotted by a player or he has spotted the player. It seems that an actors code isn't executed at all until one of the above events occur. You can notice this in the game. If you create a map where an actor (i.e. health) is lifted into the sky, he doesn't fall down to the ground until you spot it! (I'm not 100% sure about this one).

[[ifai]] <ainame>

Tests if the current actor is using the ai function <ainame> which was defined with the ai primitive (see section 2.3).

[[ifangdiffl]] <angle> (Used in Versions 1.4 and 1.5 Only)

Returns true if the angle between the current actor and the player is less than <angle>. 360 degrees is a value of 2048.

[[ifawayfromwall]]

Returns true when an actor is away from all walls (including sector divisions (red lines)) in the game.

[[ifbulletnear]]

Returns true if the current actor is being shot at (bullets are coming close to the actor).

[[ifcansee]]

Tests if the current actor can see the player. It also seems to have another function. It seems as if you need to call this function to give an actor a new position to walk to when using the seekenemy and some other ai functions. If you don't call this when using that ai function he will just walk up to your previous position and just stop there!

[[ifcanseetarget]]

Returns true if the current actor can see the player.

[[ifcanshoottarget]]

Returns true if the current actor can shoot the player (which seems to be the only target the actor has).

[[ifceilingdistl]] <number>

Returns true if the distance between the current actor's center and the ceiling is less than <number>.

[[ifcount]] <number>

Returns true if the current actor's local counter has reached <number> counts.

[[ifdead]]

Returns true if the current actor has no strength (health) left. The actor must have had health at some point for this to return true.

[[iffloordistl]] <number>

Returns true if the distance between the current actor's center and the floor is less than <number>.

[[ifgapzl]] <number>

Tests if the distance between the floor and the ceiling at the actor's location is less than <number>.

[[ifgotweaponce]] <number>

If <number> is set to 0, in multiplayer games of either cooperative or dukematch with the no spawn option turned on, the player can only get the weapon if they don't already have it. If <number> is set to 1, in multiplayer games of either cooperative or Dukematch with the no spawn option turned on, the player cannot get the weapon at all.

[[ifhitspace]]

Tests to see if the player is pressing the use key (which is the spacebar by default).

[[ifhitweapon]]

Returns true if the current actor has been hit by a weapon.

[[ifinouterspace]]

Returns true if the following parameters are true: "ifinspace" is true and the ceiling (or floor) palette on the BigSpace texture is 0. This primitive is basically useless, since it is called a split second before the player dies from the vacuum of space.

[[ifinspace]]

Checks if current player is in space. "Space" means when the floor or ceiling is parallaxed and the texture is one of the space textures.

[[ifinwater]]

Tests if the current actor is in a sector with a lotag of 2 (underwater sectors).

[[ifmove]] <name>

Returns true if the current actor is using the movement defined by <name>.

[[ifmultiplayer]]

Returns true if the current game is a cooperative game.

[[ifnosounds]]

Tests if the current actor is not playing any sound effects.

[[ifnotmoving]]

Returns true if the current actor has stopped moving. This is used to test if an actor is "stuck" against a wall (usually a monster stuck near a door) - at which point the "operate" primitive can be used to allow the stuck actor to try and free himself.

[[ifonwater]]

Returns true if the current actor is in a sector with a lotag of 1 (above water sector) and is on or near the surface.

[[ifoutside]]

Tests if player is outside. A player is outside when he is in a room with parallaxing on.

[[ifp]] <type>

Returns true if the current <type> is true. Legal values for the <type> parameter can be found in section 4.6.

[[ifpdistg]] <number>

Tests if the current or closest player's distance is greater than <number>. A value of 1024 is equivalent to the largest grid size in Build.

[[ifpdistl]] <number>

Tests if the current or closest player's distance is less than <number>. A value of 1024 is equivalent to the largest grid size in Build.

[[ifphealthl]] <number>

Tests if the player's health is less than <number>.

[[ifpinventory]] <item> <amount>

The <item> value is the inventory item to be tested. The <amount> value is the amount to test for. This function will return true when the <item> is not equal to the <amount> value. Legal values for <item> can be found in section 4.2.

[[ifrespawn]]

For monsters, tests if monster respawn mode is turned on. For items, tests if item (weapons, ammo, etc.) respawn mode is on.

[[ifrnd]] <number>

Generates a random probability of something happening. The <number> value divided by 256 is the chance that something will happen. So a value of 256 would happen all the time (256/256 = 1 = 100%).

[[ifspawnedby]] <actor>

Checks if the current actor was spawned by <actor>.

[[ifspritepal]] <number>

Tests if the palette of the current actor is equal to <number>.

[[ifsquished]]

Tests if the current actor has been squished. This can be caused by the actor being shrunken and stepped on, or squished by a falling sector (i.e. - the ceiling height of the sector at one point or another is the same height at the floor height of the sector).

[[ifstrength]] <number>

Tests if current actor has <number> strength (health) left.

[[ifwasweapon]] <weapon>

Tests what weapon the actor has been hit by. This primitive appears only to work after the "ifhitweapon" primitive is called. The legal values for <weapon> can be found in section 4.7.

[[include]] <filename>

Includes <filename> in the compiling process.

[[killit]]

Removes the current actor from the map.

[[lotsofglass]] <amount>

Spawns glass shards, much like when a window has broken. The <amount> parameter determines the number of glass shards to spawn.

[[mail]] <number> (Used in Versions 1.4 and 1.5 Only)

This primitive spawns some envelope sprites. The <number> value is the amount of mail to spawn.

[[mikesnd]]

Plays the sound assigned to the microphone sprite in Build (the microphone sprite's hitag is the sound number to be played). This might be available for use on other sprites (other than the microphone that is). I'm not 100% sure.

[[money]] <number>

This primitive is used to spawn a specified <number> of dollar bill sprites.

[[move]] <name> <horizontal> <vertical> <directions>

Assigns <name> to a <horizontal> and <vertical> velocity, with optional <directions>. See section 4.10 for a listing of valid <directions>. Also used to tell an actor to move with the desired velocities and directions.

[[music]] <episode> <m1> <m2> ...

Defines the music used for each level in each episode. The <episode> parameter is the episode number, with the individual music files following the episode number. This is usually defined in user.con.

[[nullop]]

The nullop primitive is another way to signify empty braces - {}.

[[operate]]

This primitive is used to allow the current actor to operate, which simply means that the current actor can open a door if one is nearby. The actor should not constantly operate, because the door will close again if the actor operates immediately after operating the first time.

[[palfrom]] <intensity> <red> <green> <blue>

This primitive is used to flash a specified color (set by mixing the <red>, <green>, and <blue> parameters) on the screen with a specified <intensity> amount. The values for the any of the parameters can be anything between 0 and 64.

[[paper]] <number> (Used in Versions 1.4 and 1.5 Only)

Spawns some paper sprites, which then float down to the ground. The <number> parameter is the amount of paper to spawn.

[[pkick]]

The current or closest player will perform a "quick kick".

[[pstomp]]

The current or closest player will look down and step on the nearest actor (if one is near).

[[quote]] <number>

This primitive prints quote <number> at the top of the screen. All game quotes can be found and are defined in user.con.

[[resetactioncount]]

Sets the action counter to 0. This counter counts the number of frames of animation that the current actor has displayed.

[[resetcount]]

Set the current actor's local counter to 0.

[[resetplayer]]

In a multiplayer game, this primitive spawns the player at one of the multiplayer starting positions, with the default amount of ammo, armor, and health. In a single player game, this primitive simply restarts the current level.

[[respawnhitag]]

This primitive activates up to 9 respawn actors who have the same lotag as the current actor's hitag.

[[shoot]] <weapon>

Allows the current actor to shoot - eject - fire the specified <weapon>. Legal values for <weapon> can be found in section 4.8. The direction that the <weapon> is fired depends on the AI function of the actor.

[[sizeat]] <x> <y> (Used in Versions 1.4 and 1.5 Only)

Immediately resizes the current actor to <x> width and <y> height.

[[sizeto]] <x> <y>

Gradually resizes the current actor to <x> width and <y> height.

[[sleeptime]] <time>

This primitive makes the current actor sleep for <time> counts. The current actor is not "activated" again until it "sees" the player.

[[sound]] <sound>

This primitive plays a specified <sound>. The <sound> parameter is the name of the sound to be played (these can be found in user.con).

[[soundonce]] <sound>

This primitive plays a specified <sound>. The sound cannot be activated again until it has completely finished playing.

[[spawn]] <actor>

Creates a new actor (defined by <actor>) in the map. Some special actors can be spawned to create some neat effects. See section 3.4 for more information on which actors are special to the spawn primitive.

[[spritepal]] <number>

Changes the current actor's palette to <number>. Legal values for <number> can be found in section 4.9.

[[state]] <statename> {code} ends

This is used to construct a state function. See section 2.4 for a more detailed description of what this does.

state <statename>

This primitive calls a state function with <statename> being the name of the state function. The state function must be above where this line is called.

[[stopsound]] <sound>

Stops the currently playing <sound> from playing.

[[strength]] <number>

This primitive changes the strength (health) of the current actor to <number>.

[[tip]]

Starts the current or closest player's "tipping" routine.

[[tossweapon]]

This primitive spawns the player's currently selected weapon when the player dies in the game.

[[wackplayer]]

This primitive tilts the screen to one side when called.

===Predefined State Functions===

The following is a listing of (most) state functions that already exist in the GAME.CON file. You can alter these to your liking, but the default functions are described here. The states are listed in order of appearance (at least in the 1.4/1.5 CON files).

state jib_sounds

Plays one of those nice sounds like "What a mess" or "Let God sort em' out".

state standard_jibs

Spawns some random body parts.

state genericshrunkcode

Shrink an actor and stomp on it if you are within the correct distance.

state genericgrowcode (Versions 1.4/1.5 Only)

Make the current actor grow and then explode.

state blimphitstate

Spawn an explosion and debris, kill the actor, and some other stuff...

state rats

Spawn some rats.

state toughgalspeech (Versions 1.4/1.5 Only)

The sounds to play when the tough girl talks.

state jibfood (Versions 1.4/1.5 Only)

Make food disappear when shot and spawn some gross jibs.

state breakobject (Versions 1.4/1.5 Only)

Code that makes all the breakable objects in versions 1.4 and 1.5 break when shot by the player.

state headhitstate

Gets called when player is hurt badly. The screen tilts when the player gets hit and his health is very low.

state burningstate

Set the current actor on fire.

state steamcode

Update steam sprite, subtract health from player who is near, etc.

state random_ooz (Versions 1.4/1.5 Only)

Spawns some ooze.

state burningbarrelcode

Code for a burning barrel.

state getcode

Gets an item and prepares it for respawn (if necessary).

state randgetweapsnds

Plays a random sound when a weapon is picked up by the player. Examples are "Groovy" or "Come get some!".

state getweaponcode

Gets the current weapon and prepares it for respawn if necessary.

state respawnit

Respawn items in a multiplayer game.

state quikget

Get code for the atomic health or other items. Does not cause the sprite to respawn.

state quikweaponget

Get code for weapons.

state firestate

Updates flames, checks to see if Duke is burning himself, etc.

state drop_ammo

Drops ammo if the odds for dropping it are right.

state drop_battery

Drops chaingun ammo if the odds for dropping it are right.

state drop_sgshells

Drops shotgun ammo if the odds for dropping it are right.

state drop_shotgun

Drops shotgun if the odds for dropping it are right.

state drop_chaingun

Drops chaingun if the odds for dropping it are right.

state random_wall_jibs

Spawns blood on the walls when an enemy is shot and near a wall.

state femcode

Takes care of the female actors in the game.

state killme

Lets some women say "kill me" when the player presses the space bar near her.

state tipme

Lets Duke give some women a dollar bill and say "Wanna dance" or "Shake it baby".

state toughgaltalk (Versions 1.4/1.5 Only)

Make the tough girl talk when the player presses [SPACE].

state troop_body_jibs

Spawns some trooper body parts.

state liz_body_jibs

Spawns some lizard body parts.

state standard_pjibs

Spawns some Duke body parts.

state handle_dead_dukes

The code for making blood pools, etc. when Duke dies. Also handles the disappearing for Duke's body in multiplayer.

state check p_standard

Makes the animations of Duke walking when walking, jumping when jumping, etc.

state rf

Changes the cstat to 4 ifrnd 128, else it makes the cstat 0. This is used in flipping corpse sprites so they don't all look the same.

There are too many enemy states to put here, but they all cover the basic artificial intelligence routines for each enemy.

===Known Bugs and Problems===

* Bug #1: Calling an ai routine (from an actor or state) that is already running, will cancel the ai routine, leaving the actor or state frozen in its code execution. The only known workaround for this bug is to make sure that the ai routine you want to call isn't already running.

* Bug #2: Sometimes con files don't want to compile properly, especially when user code or actors is added. The fix for this is extremely simple: A blank line must appear at the end of every con file that you edit. Some problems can occur with this bug, so it is recommended to check this before compiling your con files.

===Special Notes===

* Note #1: There are several special actors that can be used with the spawn primitive. These special actors are as follows:

* EXPLOSION2 - When this actor is called for the first time, it will create light, which can be used to create some minor lighting effects. '''NOTE: You can do the same thing in EDuke32 with the [[flash]] parameter.'''

* FRAMEEFFECT1 - When this actor is spawned, a blurring effect is caused on the affected actor. This is used to make the blurring effect when monsters in the game are shrunk with the shrink ray weapon. If you are using steroids, then your view of yourself (and other players in multiplayer) will be blurred.

* Note #2: It appears that the "ifhitweapon" primitive must be executed if a weapon is to damage an actor. If it is not, the actor cannot be destroyed.

* Note #3: The "move" primitive seems to cancel any running commands when called. I'm currently not 100% about this fact, but I have heard this rumor several places.

* Note #4: The BLIMP actor uses the "debris" primitive, but it spawns ammunition, inventory items, and weapons instead.

* Note #5: The ATOMICHEALTH actor is the only actor capable of raising the player's health value above MAXPLAYERHEALTH.

* Note #6: Removing an actor's image from the .art files prevents them from being spawned in the game. Tile number 0 (the ugly, brown, brick wall) will be spawned in their place.

==LEGAL VALUES==

===Values for addammo===
<pre>
KNEE_WEAPON
PISTOL_WEAPON
SHOTGUN_WEAPON
CHAINGUN_WEAPON
RPG_WEAPON
HANDBOMB_WEAPON
SHRINKER_WEAPON
TRIPBOMB_WEAPON
DEVISTATOR_WEAPON
FREEZE_WEAPON
HANDREMOTE_WEAPON
GROW_WEAPON [Versions 1.4 and 1.5 Only]
</pre>

===Values for addinventory and ifpinventory===
<pre>
GET_STEROIDS
GET_HEATS
GET_BOOTS
GET_SHIELD
GET_SCUBA
GET_HOLODUKE
GET_JETPACK
GET_FIRSTAID
GET_ACCESS
</pre>

===Values for addweapon===
<pre>
PISTOL_WEAPON
SHOTGUN_WEAPON
CHAINGUN_WEAPON
RPG_WEAPON
HANDBOMB_WEAPON
SHRINKER_WEAPON
TRIPBOMB_WEAPON
DEVISTATOR_WEAPON
FREEZE_WEAPON
GROW_WEAPON [Versions 1.4 and 1.5 Only]
</pre>
===Values for cstat and cstator===
<pre>
1 = Make sprite blockable ("B" in BUILD)
2 = Make sprite 'see-through'
4 = Flip sprite around x-axis
8 = Flip sprite around y-axis
16 = Draw sprite as wall texture (vertically flat)
32 = Draw him as floor texture (horizontally flat)
64 = Make sprite one sided
128 = Half submerged
256 = Make sprite solid ("H" in BUILD)
32768 = Invisible
</pre>
Note: To use more than one setting add the values together (264 = solid (256) + upside-down (8). 256 + 8 = 264).

===Values for guts===
<pre>
JIBS1
JIBS2
JIBS3
JIBS4
JIBS5
JIBS6
HEADJIB/LEGJIB/ARMJIB (trooper parts)
LIZMANHEAD1/LIZMANARM1/LIZMANLEG1 (lizman\newbeast parts) (Note: NEWBEAST spawns these with a spritepal of 6.)
DUKETORSO/DUKELEG/DUKEGUN (duke parts)
</pre>

===Values for ifp===
<pre>
pstanding = Duke is standing
pwalking = Duke is walking
prunning = Duke is running
pducking = Duke is ducking
pfalling = Duke is falling
pjumping = Duke is jumping
phigher = Duke is higher than the current actor (?)
pshrunk = Duke is has been shrunk
pjetpack = Duke is flying with the jetpack
ponsteroids = Duke is using his steroids
ponground = Duke has his both feet on the ground
palive = Duke hasn't died yet
pdead = Duke has been killed
pfacing = Duke is facing the current actor
</pre>

===Values for ifwasweapon===
<pre>
KNEE
SHOTSPARK1 (Pistol, Chaingun, or Shotgun)
RPG
SHRINKSPARK
FREEZEBLAST
FIRELASER
SPIT
RADIUSEXPLOSION (All hitradii)
COOLEXPLOSION1
FIREEXT
GROWSPARK [Versions 1.4 and 1.5 Only]
</pre>

===Values for shoot===
<pre>
KNEE
SHOTSPARK1 (The Pistol)
SHOTGUN
CHAINGUN
RPG
SHRINKER
FREEZEBLAST
FIRELASER
SPIT
BOUNCEMINE
MORTER
COOLEXPLOSION1
BLOODSPLAT1
BLOODSPLAT2
BLOODSPLAT3
BLOODSPLAT4
GROWSPARK [Versions 1.4 and 1.5 Only]
</pre>

===Values for spritepal===

The following is a listing of all the legal values for the spritepal primitive. Palettes can effect 3 different 'layers' of a tile. The easiest way to understand these 3 different 'layers' is by using the stripper sprite. The 3 'layers' are: Background (her skin), Foreground (her clothes), and Minor Foreground (money, accessories, etc).
<pre>
0 = Normal
1 = All colors become blue
2 = All colors become red
3 = Normal, exactly 0. Is used to actor some effects that needs a pallete that is not 0 (like parallex, that shots doesn't dissapers on it if using a pallete)
4 = All colors become a single black (#000)
5 = Red become brown.
6 = All colors become green with inverted brightness (Night Vision green)
7 = All colors become yellow
8 = All colors become green
10 = All blue become dark red
11 = All blue become green (same as 22, 22 is used by Assault Trooper)
12 = All blue become gray (same as 18)
13 = All blue become dark gray
14 = All blue become dark green (used by Nuke Button)
15 = All blue become brown
16 = All blue become dark blue
17 = All brown become blue and all blue becomes green
18 = All blue become gray (same as 12)
19 = All brown become red and all blue becomes gray
20 = All brown become blue and all blue becomes gray
21 = All Blue become red (used by Assault Captain and mini Battlelord)
22 = All blue become green (this is used by Assault Trooper, same as 11)
23 = All blue become yellow
24 = All gray become red and all red become gray
25 = All green become red
</pre>

===Legal Direction Values===

* faceplayer: Actor faces the player's current position.
* geth: Actor travels in a horizontal direction.
* getv: Actor travels in a vertical direction.
* randomangle: Actor will change to a random angle when it touches a wall or when the actor is currently being shot at by the player. This direction value can be used with the move command to change the direction of any actor. To do this, use the following in your actor code: move 0 randomangle
* faceplayerslow: Actor faces the player's current position but slower than the regular faceplayer command.
* spin: The actor's angle changes in a clockwise fashion (i.e. - the actor spins clockwise).
* faceplayersmart: The actor will face slightly ahead of the player's current position, making it possible for monsters to "lead" you a little bit.
* fleeenemy: Actor faces directly away from the player.
* jumptoplayer: Actor attempts to jump.
* seekplayer: Actor tries to find and move to the nearest player.
* furthestdir: Actor faces the furthest distance from the closest player.
* dodgebullet: Actor attempts to avoid all shots directed at him.

==EXAMPLES==

===Example 1: Increase Duke Nukem's Health===

Difficulty Level: Easy

To start out on the CON editing path, let's do something extremely easy. We are going to increase Duke Nukem's maximum health from 100 to 200. We also need to increase his Atomic Health (we'll take it to 400) so that picking up Atomic Health actually does something!

First, open up the user.con file, and scroll down until you see the following line:
<pre>
define MAXPLAYERHEALTH 100
</pre>
Now change that number, so that the line looks like this:
<pre>
define MAXPLAYERHEALTH 200
</pre>
Now look for the line that looks like this:
<pre>
define MAXPLAYERATOMICHEALTH 200
</pre>
And change it to this:
<pre>
define MAXPLAYERATOMICHEALTH 400
</pre>
Now you are finished! Easy huh? Well, we'll now move on to something a little more difficult.

===Example 2: Rubber Trash Cans Spawn Health When Destroyed===

Difficulty Level: Easy

In this example, we will make the rubber trash can spawn health, but only 50% of the time, when it is destroyed by an explosion.

Open the game.con file and scroll down to these lines of code:
<pre>
actor RUBBERCAN WEAK
ifaction RUBCANDENT
{
ifactioncount 16
{
strength 0
action RUBCAN
break
}
}
else ifhitweapon
{
ifwasweapon RADIUSEXPLOSION
{
state rats
ifrnd 48
spawn BURNING
debris SCRAP3 12
killit
}
else action RUBCANDENT
}
enda
</pre>
We need to add the following lines to the code in order to make the health spawn 50% of the time (instead of the rats).
<pre>
ifrnd 128 // 50% of the time...
{
spawn COLA // ... spawn the +10% health ...
killit // ... then delete the trashcan from the map.
}
else

(Here we put the rest of the code)
</pre>
But where do we put this set of code? Well, we first have to find where the code checks to see if the trash can has been hit by an explosion. You see that line that says ifwasweapon? That line of code checks to see if the trashcan was hit by the weapon stated there; the RADIUSEXPLOSION. So we need to place the weapon right in that section of code. The finished product will look like this:
<pre>
actor RUBBERCAN WEAK
ifaction RUBCANDENT
{
ifactioncount 16
{
strength 0
action RUBCAN
break
}
}
else ifhitweapon
{
ifwasweapon RADIUSEXPLOSION
{
ifrnd 128
{
spawn COLA
killit
}
else
{
state rats
ifrnd 128 // See note #1.
spawn BURNING
debris SCRAP3 12
killit
}
}
else action RUBCANDENT
}
enda
</pre>
NOTE #1: Notice that we changed the ifrnd statement from 48 to 128. Why did we do that? Well, when you stack ifrnd statements up like they are, the chances of something happening are very small. For example:
<pre>
ifrnd 128
ifrnd 128
</pre>
This statement tells the sub-code to happen only 25% of the time. How did I get that number? Well, the value of 256 is 100%, so the value of 128 is 50%. Then 50% of 50% is 25%. If it sounds confusing, just work through it again and you should pick it up.

===Example 3: Booby-trapped Ammunition===

Difficulty Level: Intermediate

In this example, we will make chaingun ammo turn deadly - but only for 25% of the time.

Let's take a look at the chaingun ammo code, which can be found in the GAME.CON file:
<pre>
actor BATTERYAMMO
fall
ifmove RESPAWN_ACTOR_FLAG
state respawnit
else ifp pshrunk
{

}
else ifp palive
ifpdistl RETRIEVEDISTANCE
ifcount 6
ifcanseetarget
{
addammo CHAINGUN_WEAPON CHAINGUNAMMOAMOUNT
quote 63
ifspawnedby BATTERYAMMO
state getcode
else
state quikget
}
enda
</pre>
You see all those if statements there under the second else? That is the area that we want to add our code to. We need to add the following lines to the code, so that 25% of the time, the chaingun ammo explodes.
<pre>
ifrnd 64 // 25% of the time, the following code should be executed.
{
hitradius 1024 WEAKEST WEAK MEDIUMSTRENGTH TOUGH // define the damage
spawn EXPLOSION2
debris SCRAP2 2
sound PIPEBOMB_EXPLODE
killit
}
else // in other cases, add the ammo amount to the player.
{
addammo CHAINGUN_WEAPON CHAINGUNAMMOAMOUNT
quote 63
ifspawnedby BATTERYAMMO
state getcode
else
state quikget
}
</pre>
So let's add our code to the ammunition. This is what the final product will look like:
<pre>
actor BATTERYAMMO
fall
ifmove RESPAWN_ACTOR_FLAG
state respawnit
else ifp pshrunk
{
}
else ifp palive
ifpdistl RETRIEVEDISTANCE
ifcount 6
ifcanseetarget
ifrnd 64
{
hitradius 1024 WEAKEST WEAK MEDIUMSTRENGTH TOUGH
spawn EXPLOSION2
debris SCRAP2 2
sound PIPEBOMB_EXPLODE
killit
}
else
{
addammo CHAINGUN_WEAPON CHAINGUNAMMOAMOUNT
quote 63
ifspawnedby BATTERYAMMO
state getcode
else
state quikget
}
enda
</pre>
Now, when you go into the game, every 25% (or roughly) of the time you should get hurt by an explosion. Cool way to make booby-traps, huh?

===Example 4: Break the "Unbreakable" Plate (Versions 1.4/1.5 Only)===

Difficulty Level: Intermediate

If you have ever played through Duke Nukem, you should hopefully have noticed the "unbreakable" plate in the sushi bar (episode 3, level 1). There is one plate the 3D Realms forgot about coding, and so it cannot be broken like the others can. What better a mistake for us to fix!

This coding session will only work with versions 1.4 or 1.5 of Duke Nukem 3D, because we will need to make use of the "useractor" function.

The plate that is in question is in slot #851 (you can take a look at it in Build or Editart). To make this slot an actor, we first need to define it in the defs.con file. Open up the defs.con file, and place the following line somewhere in this file:
<pre>
define SUSHIPLATE99 851
</pre>
I prefer putting these types of lines in order of appearance by tile number, much like 3D Realms did. Scroll down to the lines that say:
<pre>
define MASKWALL13 830
define HURTRAIL 859
</pre>
and put our define statement between the two lines that are there (because 851 is between 830 and 859).

Now save your work and close this file.

Now open the game.con file and place the following lines of code anywhere in the file:
<pre>
useractor notenemy SUSHIPLATE99 WEAK // define it as a useractor
ifhitweapon
{
lotsofglass 7
sound GLASS_BREAKING
killit
}
enda
</pre>
Now, when you enter into the game, you can shoot the plate and it will break! Yay! We just fixed a bug in Duke Nukem 3D!

===Example 5: Make Duke eat some food (Versions 1.4/1.5 only)===

Difficulty Level: Intermediate

In this example, we are going to make use of the food that appears in a few of the levels in Episode 4 (Versions 1.4 and 1.5 only). We will make Duke eat the food when he is near enough to it, and we will add 10 health points to his health when he eats it. We also will make him say "Ooh, I needed that!" when his health is below 20.

First, open up the user.con file, and scroll down to the line that says:
<pre>
definequote 124 MAP HAS A DIFFERENT NUMBER OF PLAYERS
</pre>
This is the last quote defined by 3D Realms, so we will make 2 new quotes to print. Add these lines right below the definequote 124:
<pre>
definequote 125 YOU EAT SOME FOOD: +10 HEALTH!
definequote 126 YOU AREN'T HUNGRY NOW...
</pre>
We will use these quotes when we add code to the game.con file. Save your work and close user.con.

First we need to make a state function. Open the game.con file and put the following lines of code at the top of the file:
<pre>
state eatfood
ifp pfacing
ifpdistl 1280
ifhitspace
{
ifphealthl 20
{
addphealth 10
globalsound DUKE_NEED
quote 125
killit
}
else
{
ifphealthl MAXPLAYERHEALTH
{
addphealth 10
quote 125
globalsound DUKE_GET
killit
}
else
{
quote 126
break
}
}
}
ends
</pre>
Now we need to find where the actors are located. Scroll down to the line that says:

<pre>
useractor notenemy FOODOBJECT11 WEAK state breakobject enda
</pre>
and change it to look like this:
<pre>
useractor notenemy FOODOBJECT11 WEAK
state breakobject
state eatfood
enda
</pre>
This now allows our state function to work on FOODOBJECT11. But we want to change 12 through 20 as well. So just make each useractor that we want to change look just like the useractor above. Example:
<pre>
useractor notenemy FOODOBJECT12 WEAK // We change # 12 now...
state breakobject
state eatfood
enda
</pre>
Save your work, and when you go into the game, you will find that you can now press space near the food and you will gain 10 health points if you are below 100!

==FAQ INFORMATION==

===About the Authors and General Information===

This FAQ was written by Joris Weimar, an avid Duke Nukem 3D FAQ, and a talented con file programmer. Also working on this FAQ is myself, Jonah Bishop. I also run the Map Editing FAQ for Duke Nukem 3D and Shadow Warrior. If you have any questions, tips, corrections or comments about con files or this FAQ, visit the Duke Nukem 3D Editing and Hacking forum at Dukeworld.

Dukeworld --- http://www.dukeworld.com

===Credits and Contributors===

This FAQ would not be what it is today without the following people (who made suggestions and pointed out various errors):

- James Tan (ctan@xtra.co.nz)

Provided most of the new and updated information for version 4.2.

- TerminX (terminx@theoffspring.net)

For providing the updated information on the "endofgame" primitive

- The Reaper (lrdmecha@yahoo.com)

For clearing up all of the version validity problems with the predefined state functions.

- Snowblind (snowblind@brasnet.org)

For letting me know about the missing palette values

- Garry Cobbum (gcobbum@sbinet.com)

For finding several errors and for giving several suggestions

- James Ferry (sweepy@playful.com)

For the tons of information he allowed me to use. Visit his site at http://members.xoom.com/HCAD

- Joe Barta (jbarta@apk.net)

For finding more errors than can be named

- Matthew Hill (gambit@proteus.globalnet.co.uk)

For donating the correct "palfrom" primitive parameters

- Gavin Lambert (uecasm@geocities.com)

For finding an error in the "mikesnd" primitive and for clearing up the usage of the "ifinouterspace" primitive

- Reptile (reptile@worldaccess.nl)

- Linkers (linkers@dds.nl)

[[Category:Duke3D 1.3/1.5 commands|*]]

WEAPONx WORKSLIKE

2009-07-14T16:04:39Z

DeeperThought: Created page with 'This determines which tiles are displayed in the HUD when the weapon is used. It would be more aptly named "LOOKSLIKE" than "WORKSLIKE". Set this to 1 and the weapon will displ...'

This determines which tiles are displayed in the HUD when the weapon is used. It would be more aptly named "LOOKSLIKE" than "WORKSLIKE". Set this to 1 and the weapon will display the pistol art, 2 for shotgun, etc. It is completely useless if you are using your own HUD code.

Weaponswitch

2009-05-17T00:05:59Z

DeeperThought:

Bitfield (add values together)

1 = switch to weapon on pickup

2 = switch away when out of ammo

Weaponswitch

2009-05-17T00:05:32Z

DeeperThought:

Bitfield (add values together)

1 = switch to weapon on pickup
2 = switch away when out of ammo

Starttrackvar

2009-05-05T23:15:47Z

DeeperThought:

'''starttrackvar''' <track#>

starttrackvar sets the background music to <track#>, as defined for the current episode with the [[music]] command. It works like [[starttrack]], but the parameter can be a variable instead of a constant

Example: this code will cause the music to cycle through the first ten tracks defined for the current episode when the player presses the open key. (Replace the line "actor APLAYER..." with the code below)

gamevar TRACK 9 0

actor APLAYER MAXPLAYERHEALTH PSTAND 0 0

ifhitspace ifcount 26
{
resetcount
addvar TRACK 1
ifvarg TRACK 9 setvar TRACK 0
starttrackvar TRACK
}

[[Category:EDuke32 specific commands]]
[[Category:Sound manipulation]]

Htflags

2009-05-05T00:41:35Z

DeeperThought: Created page with 'Controls special flags for sprites. The values are: '''1''' - Generates a shadow. See spriteshadow.<br /> '''2''' - Turns palette 6 whenever night vision gog…'

Controls special flags for sprites. The values are:

'''1''' - Generates a shadow. See [[spriteshadow]].<br />
'''2''' - Turns [[spritepal|palette]] 6 whenever night vision goggles are used. See [[spritenvg]].<br />
'''4''' - The sprite's shade is unaffected by the shade of its sector. See [[spritenoshade]].<br />
'''8''' - Is a [[defineprojectile|projectile]].<br />
'''16''' - Prevents teleporting. The sprite is not entered into the [[decal deletion queue]].<br />
'''32''' - Is an enemy. See [[useractor]].<br />
'''64''' - Sprite will be insusceptible to floor palette of sector containing this sprite. See [[spritenopal]].<br />

It is a bitfield, so add together the values you want and then set htflags to the sum.

Getincangle

2009-04-21T02:51:34Z

DeeperThought:

getincangle <return> <angle1> <angle2>

Gets the difference in degrees between angles <angle1> and <angle2> and stores the result in the <return> variable. Note that <return> can be either positive or negative, depending on whether the shortest turn from <angle1> to <angle2> is clockwise or counter-clockwise.

WEAPONx FLAGS

2009-04-20T16:48:25Z

DeeperThought:

WEAPONx_FLAGS is a [[gamevar]] that has the power to change several different things about weapons (not projectiles).

The flag values for WEAPONx_FLAGS are:

{| {{prettytable}}
!Name!!Number!!Description!!
|-
|WEAPON_FLAG_HOLSTER_CLEARS_CLIP
|align="right"|'''1'''
|Holstering clears clip
|-
|WEAPON_FLAG_GLOWS
|align="right"|'''2'''
|Glows
|-
|WEAPON_FLAG_AUTOMATIC
|align="right"|'''4'''
|Automatic
|-
|WEAPON_FLAG_FIREEVERYOTHER
|align="right"|'''8'''
|Fire every other frame
|-
|WEAPON_FLAG_FIREEVERYTHIRD
|align="right"|'''16'''
|Fire every third frame
|-
|WEAPON_FLAG_RANDOMRESTART
|align="right"|'''32'''
|Random restart on automatic
|-
|WEAPON_FLAG_AMMOPERSHOT
|align="right"|'''64'''
|Use ammo per burst (like the Devastator)
|-
|WEAPON_FLAG_BOMB_TRIGGER
|align="right"|'''128'''
|Is a bomb trigger (Pipebomb Detonator)
|-
|WEAPON_FLAG_NOVISIBLE
|align="right"|'''256'''
|Using does NOT cause player to flash the level (clear visibility)
|-
|WEAPON_FLAG_THROWIT
|align="right"|'''512'''
|Use 'throws' the 'shoots' item
|-
|WEAPON_FLAG_CHECKATRELOAD
|align="right"|'''1024'''
|Check weapon availability at 'reload' time
|-
|WEAPON_FLAG_STANDSTILL
|align="right"|'''2048'''
|player should stop jumping
|-
|WEAPON_FLAG_SPAWNTYPE1
|align="right"|'''0'''
|Spawn Type 1 (Pistol shells)
|-
|WEAPON_FLAG_SPAWNTYPE2
|align="right"|'''4096'''
|Spawn Type 2 (Shotgun shells)
|-
|WEAPON_FLAG_SPAWNTYPE3
|align="right"|'''8192'''
|Spawn Type 3 (Chaingun shells)
|-
|WEAPON_FLAG_SEMIAUTO
|align="right"|'''16384'''
|Semi-automatic (cancel button press after each shot)
|-
|WEAPON_FLAG_RELOAD_TIMING
|align="right"|'''32768'''
|Alternate reload sound timing (hack for pistol reload sound timing)
|-
|WEAPON_FLAG_RESET
|align="right"|'''65536'''
|Alternate weapon timing (hack for chaingun and freezer, see player.c)
|}
WEAPONx_FLAGS is a bitfield, so you can add the individual flags together in the manner of [[cstat]] and [[orientation]].

[[Category:Pre-defined gamevars]]

Setgamepalette

2009-04-11T17:08:45Z

DeeperThought:

'''setgamepalette <pal_ID>'''

Switches between the palettes that Duke Nukem 3D uses. The palettes are located in LOOKUP.DAT. This command can take values between 0 and 6.

It sets the palette that the game uses to 0, the normal game palette. (Remember that these palettes include underwater palette, night vision palette etc. so this can be used to block them)

palette<br/>
0 - normal<br/>
1 - under water<br/>
2 - night vision<br/>
3 - looks horrible with tiles made for standard palette<br/>
4 - similar to normal with some colors changed<br/>
5 - looks horrible with tiles made for standard palette<br/>
6 - looks horrible with tiles made for standard palette<br/>

note: the last palettes are used for the title screen and ending screens

[[Category:EDuke32 specific commands]]
[[Category:Game manipulation]]

Setgamepalette

2009-04-11T07:15:46Z

DeeperThought:

'''setgamepalette <pal_ID>'''

Switches between the palettes that Duke Nukem 3D uses. The palettes are located in LOOKUP.DAT. This command can take values between 0 and 6.

It sets the palette that the game uses to 0, the normal game palette. (Remember that these palettes include underwater palette, night vision palette etc. so this can be used to block them)

palette<br/>
0 - normal<br/>
1 - under water<br/>
2 - night vision<br/>
3 - looks horrible with tiles made for standard palette<br/>
4 - similar to normal with some colors changed<br/>
5 - looks horrible with tiles made for standard palette<br/>
6 - looks horrible with tiles made for standard palette<br/>

[[Category:EDuke32 specific commands]]
[[Category:Game manipulation]]

Setgamepalette

2009-04-11T07:11:03Z

DeeperThought:

'''setgamepalette <pal_ID>'''

Switches between the palettes that Duke Nukem 3D uses. The palettes are located in LOOKUP.DAT. This command can take values between 0 and 6.

It sets the palette that the game uses to 0, the normal game palette. (Remember that these palettes include underwater palette, night vision palette etc. so this can be used to block them)

palette
0 normal
1 under water
2 night vision
3 looks horrible with tiles made for standard palette
4 similar to normal with some colors changed
5 looks horrible with tiles made for standard palette
6 looks horrible with tiles made for standard palette

[[Category:EDuke32 specific commands]]
[[Category:Game manipulation]]

Cstat

2008-11-21T15:53:22Z

DeeperThought:

cstat <number>

Sets flags for how to draw an actor, as well as a few flags for interaction. Add all together all wanted flag values, and use that as <number>. This is because cstat is a bitfield.

Cstat is available for [[sprite]] structs and for [[Members of the wall structure|wall]] structs. See [[cstat(wall)]].

Flag values for sprite cstat are:

:'''1''' - Make sprite blockable
:'''2''' - Make sprite transparent
:'''4''' - Flip sprite around x-axis
:'''8''' - Flip sprite around y-axis
:'''16''' - Draw sprite as vertically flat (wall aligned)
:'''32''' - Draw sprite as horizontally flat (floor aligned)
:'''64''' - Make sprite one sided
:'''128''' - Half submerged
:'''256''' - Make sprite able to be hit by weapons
:'''512''' - Second transparency level (combine with cstat 2)
:'''32768''' - Invisible

Also see [[cstator]].

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]

Htactorstayput

2008-11-10T08:53:37Z

DeeperThought: New page: '''htactorstayput''' is the sector number that a stayput monster is assigned to, or -1 if no sector is assigned. When a sector is assigned, the monster cannot leave that sector. By manip...

'''htactorstayput''' is the sector number that a stayput monster is assigned to, or -1 if no sector is assigned. When a sector is assigned, the monster cannot leave that sector. By manipulating this value, monsters can be changed from stayput to notstayput, or vice versa. This works even on actors that do not have stayput tiles, such as TANK.

Ifvarvareither

2008-10-29T04:56:48Z

DeeperThought: New page: ifvarvareither <gamevar1> <gamevar2> If condition returning true if either gamevar1 or gamevar2 have non-zero values. Category:EDuke commands Category:Gamevar manipulation [[...

ifvarvareither <gamevar1> <gamevar2>

[[If condition]] returning true if either gamevar1 or gamevar2 have non-zero values.

[[Category:EDuke commands]]
[[Category:Gamevar manipulation]]
[[Category:If conditions]]

EVENT ANIMATESPRITES

2008-10-19T01:51:55Z

DeeperThought:

This event can be used to manipulate sprites that are drawn on the screen. It is triggered only by drawn sprites when 16 has been added to the mdflags member of the corresponding sprite in the game world. Drawn sprites are accessed through the tsprite array, which has its own members separate from the regular actor array. Members of the tsprite array are similar to members of the regular sprite array, but they begin with 'tspr' (E.g., xrepeat becomes tsprxrepeat ).

'''Example of how to use this event:'''
gamevar TEMP 0 0
actor APLAYER MAXPLAYERHEALTH PSTAND 0 0
getactor[THISACTOR].mdflags TEMP
orvar TEMP 16
setactor[THISACTOR].mdflags TEMP
// rest of player code

In this first block of code, we add 16 to the mdflags member of the player sprite, so that it will be processed by the ANIMATESPRITES event. Next, is the code for the event:

onevent EVENT_ANIMATESPRITES
gettspr[THISACTOR].tsprcstat TEMP
subvar TEMP 2
settspr[THISACTOR].tsprcstat TEMP
endevent

The second block of code removes transparency from the player's tsprite, so that when the player is in F7 view mode, the player sprite will appear solid. This effect cannot be achieved by setting the cstat of the player sprite directly. Note that the code will only effect the player sprite, because only the player sprite has had 16 added to its mdflags member.

See also [[gettspr]] and [[settspr]]

Mdflags

2008-10-19T01:51:02Z

DeeperThought:

mdflags <number>

Sets flags for how to draw an [[actor]]'s model. These flags never affect the gameplay. To be noted, it is used by the maphacks. Add all together all wanted flag values, and use that as <number>.

Mdflags is available for [[sprite]] structs and for [[Members of the wall structure|wall]] structs.

Flag values for sprite mdflags are:

:'''1''' - Make sprite be dispalyed as sprite(not model)
:'''2''' - No model animation.
:'''16''' - Process in [[EVENT_ANIMATESPRITES]]

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

EVENT ANIMATESPRITES

2008-10-19T01:49:53Z

DeeperThought: New page: This event can be used to manipulate sprites that are drawn on the screen. It is triggered only by drawn sprites when 16 has been added to the mdflags member of the corresponding sprite i...

Gettspr

2008-10-19T01:32:06Z

DeeperThought: New page: gettspr[<tsprite ID>].member <gamevar> The members of the tsprite array are the sprites that are drawn on screen at a given time. ''The tsprite array should not be confused with the game...

gettspr[<tsprite ID>].member <gamevar>

The members of the tsprite array are the sprites that are drawn on screen at a given time. ''The tsprite array should not be confused with the game world sprite array that is accessed with'' [[getactor]] and [[setactor]] ''commands.''

Members of the tsprite array are counterparts of the actor array, and have similar names, except that member names in the tsprite array begin with 'tspr'.

The [[settspr]] and gettspr commands should be used in [[EVENT_ANIMATESPRITES]]. See the entry for that event for more details.

Example of usage:

gettspr[THISACTOR].tsprcstat TEMP

Settspr

2008-10-19T01:30:41Z

DeeperThought: New page: settspr[<tsprite ID>].member <number or gamevar> The members of the tsprite array are the sprites that are drawn on screen at a given time. ''The tsprite array should not be confused wit...

settspr[<tsprite ID>].member <number or gamevar>

The members of the tsprite array are the sprites that are drawn on screen at a given time. ''The tsprite array should not be confused with the game world sprite array that is accessed with'' [[getactor]] and [[setactor]] ''commands.''

Members of the tsprite array are counterparts of the actor array, and have similar names, except that member names in the tsprite array begin with 'tspr'.

The settspr and [[gettspr]] commands should be used in [[EVENT_ANIMATESPRITES]]. See the entry for that event for more details.

Example of usage:

settspr[THISACTOR].tsprcstat 0

Statnum

2008-08-15T08:48:01Z

DeeperThought:

Statnums are used by the game internally to see whether something is an actor, player, projectile, etc, and then process it appropriately.

Some important statnums (there are many more not listed):

0 -- Sprites that are not defined by the CON code as actors, and are not projectiles, etc, have a statnum of 0. (E.g. the floor texture sprites used to make up a sprite bridge).

1 -- Actors. Sprites with a statnum of 1 will execute the actor code that applies to their tile number in the CON scripts.

2 -- Sleepers. Sprites taking a break from code execution (e.g. a Pigcop that has been left alone for long enough will revert to statnum 2, only waking up and going back to statnum 1 upon seeing the player again)

4 -- Projectiles. These includes RPG, FREEZEBLAST, etc., as well as custom projectiles. It does not include hitscan (bullets), since those are not sprites that exist in the game world (SHOTSPARK1, the sprite spawned by bullets, is not itself a projectile)

10 -- The player.

[[Category:Sprite structure members]]

Httempang

2008-08-15T08:18:41Z

DeeperThought:

httempang holds the number of the sprite's previous pal (if the sprite is not a player). The sprite's pal is set to this number when the [[getlastpal]] command is used. Note that the previous pal is stored in httempang only when the [[spritepal]] command is used.

Given the name of this member, it seems likely that it was originally intended to store an angle.

Httempang

2008-08-15T08:16:28Z

DeeperThought: New page: httempang holds the number of the sprite's previous pal (if the sprite is not a player). The sprite's pal is set to this number when the getlastpal command is used. Note that the pre...

Htdispicnum

2008-08-15T08:08:34Z

DeeperThought: New page: htdispicnum is the tile number that the sprite is currently displaying. If the sprite is using an action, then the htdispicnum may differ from the sprite's picnum. For example, if a ...

htdispicnum is the tile number that the sprite is currently displaying. If the sprite is using an [[action]], then the htdispicnum may differ from the sprite's picnum. For example, if a LIZTROOP is lying dead, then it has a htdispicnum of 1734, the lying dead frame.

Htmovflag

2008-08-15T06:19:00Z

DeeperThought: New page: htmovflag has a nonzero value if the sprite is using a move command and it bumps into something (htmovflag is set to the return value of the movesprite function). If the moving sprite is ...

htmovflag has a nonzero value if the sprite is using a move command and it bumps into something (htmovflag is set to the return value of the movesprite function). If the moving sprite is bumping into another sprite, then the ID of that other sprite will be equal to htmovflag + 16384.

Htlastvy

2008-08-15T05:33:05Z

DeeperThought: New page: The last y coordinate at which the player (or the player's holoduke, if that was visible) was seen by the actor when the actor used the ifcansee command.

The last y coordinate at which the player (or the player's holoduke, if that was visible) was seen by the actor when the actor used the ifcansee command.

Htlastvx

2008-08-15T05:32:24Z

DeeperThought: New page: The last x coordinate at which the player (or the player's holoduke, if that was visible) was seen by the actor when the actor used the ifcansee command.

The last x coordinate at which the player (or the player's holoduke, if that was visible) was seen by the actor when the actor used the ifcansee command.

EDuke32 Modifications

2008-06-24T16:47:47Z

DeeperThought:

Users are encouraged to add links to known EDuke32 mods to this page.

===Mods List===

<table style="border:1px solid #000">

<tr style="background:#000; color:#fff"><td width="200px">Name</td><td width="200px">Status</td><td>Creator</td></tr>
<tr><td style="border:1px solid #000; background:#eee">[http://www.zxdware.net/NR/ Naferia's Reign: Invasion of the Dark Mistress]</td>
<td style="border:1px solid #000; background:#eee">Released, in development<br> (Latest Version: '''5.05.05292008''')</td>
<td style="border:1px solid #000; background:#eee">[[User:LordMisfit|Lord Misfit]]</td></tr>
<tr><td colspan="2">[[Image:NRIOTDM-1.png|200px]][[Image:NRIOTDM-2.png|200px]]</td><td colspan="1">What will come to be an alternate-universe Duke Nukem story revolving around a pivotal point in the history of Duke Nukem and the Aliens he has faced since the original Duke Nukem 3D. Duke is no longer working alone in his quest, as his enemies ramp up their power and allegiances substantially, as well as their intelligence to a point. Play as up to 15 different characters, with the ability to use multiple characters in the same party, unlike in Hexen[and more like a real RPG]. Monsters are more interactive and to a point more intelligent, able to grab items like health and armor, get damaged by slime and other hazards, and even pick up powerups to make them deadlier in combat. Find money laying around or get it out of your characters' ATM accounts, and use it to buy new items from shops or other NPCs. Voice Acting is also present.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://www.moddb.com/mods/9541/duke-nukem-weapon-of-mass-destruction Duke Nukem: Weapon of Mass Destruction]</td>
<td style="border:1px solid #000; background:#eee">Released</td>
<td style="border:1px solid #000; background:#eee">[[User:DeeperThought|DeeperThought]]</td></tr>
<tr><td colspan="2">[[Image:Dnwmd1.jpg|200px]][[Image:Dnwmd2.jpg|200px]]</td><td colspan="1">Duke Nukem: Weapon of Mass Destruction is a gameplay mod for Duke Nukem 3D. It has tons of new weapon modes, enemies, and player abilities, such as UT style dodge moves, spinning hook kicks, and a Duke bot companion who fights by your side. In some levels you can even get in your skycar and fly it, doing bombing runs on enemies. In DNWMD, Duke collects glowing coins from slain enemies which are used to purchase various upgrades via a mouse controlled menu. In addition, each of Duke's weapons has its own experience level which increases with use.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://deeperthought.dukertcm.com/dp/ Duke Plus]</td>
<td style="border:1px solid #000; background:#eee">Released, in development</td>
<td style="border:1px solid #000; background:#eee">[[User:DeeperThought|DeeperThought]]</td></tr>
<tr><td colspan="2">[[Image:DP1.jpg|200px]][[Image:DP2.jpg|200px]]</td><td colspan="1">Enhanced Engine Design Capabilities, including: Transparent Water; Giving Monsters Special Flags; Climbable Ladders; Mantling/Grappling on ledges; Bot-Allies; Footstep Sounds; Rain and Snow-based weather effects; Quake3-Style Jump Pads; Slippery Floors; etc. [http://www.picturepush.com/public/652573 Gravity gun footage]</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://files.filefront.com/Nuclear+Showdown+v10zip/;8218523;;/fileinfo.html Nuclear Showdown]</td>
<td style="border:1px solid #000; background:#eee">Released</td>
<td style="border:1px solid #000; background:#eee">[[User:Jblade|James Stanfield]]</td></tr>
<tr><td colspan="2">[[Image:NS01.jpg|200px]][[Image:NS02.jpg|200px]]</td><td colspan="1">Nuclear showdown is a gameplay mod for Duke Nukem that adds many features such as new weapons, enemies, effects to the default game as well as usermaps - it is built so you can play your favourite usermaps with, even ones that use custom art. You can also play through Duke it out in DC if you have it. The TC also includes several features for mappers like more keycards, items such as the spacesuit and toolkit, and more textures to work with.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=25830 The AWOL Project Source]</td>
<td style="border:1px solid #000; background:#eee">Released, Incomplete Source</td>
<td style="border:1px solid #000; background:#eee">[[User:Reaper_Man|Reaper_Man]], Hudson, Mblackwell, and the entire AWOL TC Team</td></tr>
<tr><td colspan="2">[[Image:AWOL1.jpg|200px]][[Image:AWOL2.jpg|200px]]</td><td colspan="1">The AWOL Project Source is the release of the source files for the once highly anticipated mod, The AWOL Project. After several years of sitting idly on the hard drives of the creators, Reaper_Man and Hudson decided to release all of the content for the TC to those who might find it useful. The release includes a few demo maps showing off various effects and AI, as well as all 3 of the drivable vehicles. Most of the code is complete but very few of the maps are. There is an Official 1.0 Patch as well as the AWOL Map Pack available for download also.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://hosted.filefront.com/kenia43 Duke Nukem Army]</td>
<td style="border:1px solid #000; background:#eee">Unfinished release, development ceased</td>
<td style="border:1px solid #000; background:#eee">[[User:Kenia|Kenia]]</td></tr>
<tr><td colspan="2">[[Image:Teaser2.jpg|200px]][[Image:Teaser3.jpg|200px]]</td><td colspan="1">A TC that changes Duke Nukem 3D into an exaggerated army-style shooter. [http://www.youtube.com/watch?v=xl1E9BtOe9U Gameplay footage]</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://www.moddb.com/mods/10844/duke-nukem-3d-stargate-mod Stargate Mod]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">[[User:The Commander|The Commander]]</td></tr>
<tr><td colspan="2">[[Image:SGMOD1.jpg|200px]][[Image:SGMOD2.jpg|200px]]</td><td colspan="1">The Stargate Mod for Duke Nukem 3D uses Duke Plus as a base. Fight against the Replicators and visit off-world deserts, forests, space ships, and even Atlantis—where anything can happen!</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=31395 Madness Guts in the RooM]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">1master1tc</td></tr>
<tr><td colspan="2">[[Image:Madness2.jpg|200px]][[Image:Madness3.jpg|200px]]</td><td colspan="1">Silent-hill themed TC. [http://youtube.com/watch?v=G252CzfkJZE Link to trailer]</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=30761 WG Medieval Mod]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">William Gee, [[User:DeeperThought|DeeperThought]], Hellbound</td></tr>
<tr><td colspan="2">[[Image:WG1.jpg|200px]][[Image:WG2.jpg|200px]]</td><td colspan="1">Medieval mod with melee combat, magic bows, skeleton knights, dragons and demons. [http://www.picturepush.com/public/590728 Gameplay footage]</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=25350 Symphony of Orekia (AKA The Mansion)]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">Quakis</td></tr>
<tr><td colspan="2">[[Image:Mansion1.jpg|200px]][[Image:Mansion2.jpg|200px]]</td><td colspan="1">Resident Evil-style TC with Demons and creepy interiors. </td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=9670 Decay]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">Hudson, Cage, others</td></tr>
<tr><td colspan="2">[[Image:Decay1.jpg|200px]][[Image:Decay2.jpg|200px]]</td><td colspan="1">Survival-horror TC with zombies! </td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=30962 Blood TC]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">M210</td></tr>
<tr><td colspan="2">[[Image:Blood1.jpg|200px]][[Image:Blood2.jpg|200px]]</td><td colspan="1">Recreation of Blood with EDuke32</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://amc.planetduke.gamespy.com/smf/index.php?topic=7591.0 AMC TC]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">James Stanfield and AMC</td></tr>
<tr><td colspan="2">[[Image:AMCTC1.jpg|200px]][[Image:AMCTC2.jpg|200px]]</td><td colspan="1">The AMC TC is a multi-character TC and gameplay modification. There are 8 characters to choose between, each with different weapon sets and items. Fight through the solar system against Duke's old enemies as well as other dark forces that each plan something unpleasent for Earth and Mars. A initial gameplay release with the finished characters, intromap, and Duke usermap episode is planned with actual story based releases later.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://duke3d.bur.st/forum/index.php?topic=42.0 Action Duke]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, In Development</td>
<td style="border:1px solid #000; background:#eee">[[User:Captain Awesome|Captain Awesome]]</td></tr>
<tr><td colspan="2">[[Image:Duke0003.gif|200px]][[Image:Duke0004.gif|200px]]</td><td colspan="1">Action Duke is a mod that plans to take different weapons, characters, and items from the extended Duke universe, and from other BUILD and related games, in addition to new ideas formulated by the author. Will not be a gameplay mod, but rather a full mod. Screenshots are mockups, screens to come will show actual working gameplay.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">Duke Meets DOOM Rebirth</td>
<td style="border:1px solid #000; background:#eee">Unreleased, In Development</td>
<td style="border:1px solid #000; background:#eee">[[User:Captain Awesome|Captain Awesome]] and [[User:Hendricks 266|Hendricks266]]</td></tr>
<tr><td colspan="2">[[Image:DMDR_001.gif|200px]][[Image:DMDR_002.jpg|200px]]</td><td colspan="1">Duke Meets DOOM Rebirth is an upgrade of the original vanilla TC "Duke Meets Doom". The basis for this mod is that the original maps are good, but the coding and artwork were sloppy. There are three different flavors available. The first is Classic, which will work in 8-Bit mode. The second is Faithful (name pending), which has highres versions of the original art so that the differences of the DOOM and Duke palettes will not hinder it. The third is Updated (name pending), which introduces highres content from the jDRP and friends.</td></tr>

</table>

EDuke32 Modifications

2008-06-24T16:46:19Z

DeeperThought:

Users are encouraged to add links to known EDuke32 mods to this page.

===Mods List===

<table style="border:1px solid #000">

<tr style="background:#000; color:#fff"><td width="200px">Name</td><td width="200px">Status</td><td>Creator</td></tr>
<tr><td style="border:1px solid #000; background:#eee">[http://www.zxdware.net/NR/ Naferia's Reign: Invasion of the Dark Mistress]</td>
<td style="border:1px solid #000; background:#eee">Released, in development<br> (Latest Version: '''5.05.05292008''')</td>
<td style="border:1px solid #000; background:#eee">[[User:LordMisfit|Lord Misfit]]</td></tr>
<tr><td colspan="2">[[Image:NRIOTDM-1.png|200px]][[Image:NRIOTDM-2.png|200px]]</td><td colspan="1">What will come to be an alternate-universe Duke Nukem story revolving around a pivotal point in the history of Duke Nukem and the Aliens he has faced since the original Duke Nukem 3D. Duke is no longer working alone in his quest, as his enemies ramp up their power and allegiances substantially, as well as their intelligence to a point. Play as up to 15 different characters, with the ability to use multiple characters in the same party, unlike in Hexen[and more like a real RPG]. Monsters are more interactive and to a point more intelligent, able to grab items like health and armor, get damaged by slime and other hazards, and even pick up powerups to make them deadlier in combat. Find money laying around or get it out of your characters' ATM accounts, and use it to buy new items from shops or other NPCs. Voice Acting is also present.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://www.moddb.com/mods/9541/duke-nukem-weapon-of-mass-destruction Duke Nukem: Weapon of Mass Destruction]</td>
<td style="border:1px solid #000; background:#eee">Released</td>
<td style="border:1px solid #000; background:#eee">[[User:DeeperThought|DeeperThought]]</td></tr>
<tr><td colspan="2">[[Image:Dnwmd1.jpg|200px]][[Image:Dnwmd2.jpg|200px]]</td><td colspan="1">Duke Nukem: Weapon of Mass Destruction is a gameplay mod for Duke Nukem 3D. It has tons of new weapon modes, enemies, and player abilities, such as UT style dodge moves, spinning hook kicks, and a Duke bot companion who fights by your side. In some levels you can even get in your skycar and fly it, doing bombing runs on enemies. In DNWMD, Duke collects glowing coins from slain enemies which are used to purchase various upgrades via a mouse controlled menu. In addition, each of Duke's weapons has its own experience level which increases with use.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://http://deeperthought.dukertcm.com/dp/ Duke Plus]</td>
<td style="border:1px solid #000; background:#eee">Released, in development</td>
<td style="border:1px solid #000; background:#eee">[[User:DeeperThought|DeeperThought]]</td></tr>
<tr><td colspan="2">[[Image:DP1.jpg|200px]][[Image:DP2.jpg|200px]]</td><td colspan="1">Enhanced Engine Design Capabilities, including: Transparent Water; Giving Monsters Special Flags; Climbable Ladders; Mantling/Grappling on ledges; Bot-Allies; Footstep Sounds; Rain and Snow-based weather effects; Quake3-Style Jump Pads; Slippery Floors; etc. [http://www.picturepush.com/public/652573 Gravity gun footage]</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://files.filefront.com/Nuclear+Showdown+v10zip/;8218523;;/fileinfo.html Nuclear Showdown]</td>
<td style="border:1px solid #000; background:#eee">Released</td>
<td style="border:1px solid #000; background:#eee">[[User:Jblade|James Stanfield]]</td></tr>
<tr><td colspan="2">[[Image:NS01.jpg|200px]][[Image:NS02.jpg|200px]]</td><td colspan="1">Nuclear showdown is a gameplay mod for Duke Nukem that adds many features such as new weapons, enemies, effects to the default game as well as usermaps - it is built so you can play your favourite usermaps with, even ones that use custom art. You can also play through Duke it out in DC if you have it. The TC also includes several features for mappers like more keycards, items such as the spacesuit and toolkit, and more textures to work with.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=25830 The AWOL Project Source]</td>
<td style="border:1px solid #000; background:#eee">Released, Incomplete Source</td>
<td style="border:1px solid #000; background:#eee">[[User:Reaper_Man|Reaper_Man]], Hudson, Mblackwell, and the entire AWOL TC Team</td></tr>
<tr><td colspan="2">[[Image:AWOL1.jpg|200px]][[Image:AWOL2.jpg|200px]]</td><td colspan="1">The AWOL Project Source is the release of the source files for the once highly anticipated mod, The AWOL Project. After several years of sitting idly on the hard drives of the creators, Reaper_Man and Hudson decided to release all of the content for the TC to those who might find it useful. The release includes a few demo maps showing off various effects and AI, as well as all 3 of the drivable vehicles. Most of the code is complete but very few of the maps are. There is an Official 1.0 Patch as well as the AWOL Map Pack available for download also.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://hosted.filefront.com/kenia43 Duke Nukem Army]</td>
<td style="border:1px solid #000; background:#eee">Unfinished release, development ceased</td>
<td style="border:1px solid #000; background:#eee">[[User:Kenia|Kenia]]</td></tr>
<tr><td colspan="2">[[Image:Teaser2.jpg|200px]][[Image:Teaser3.jpg|200px]]</td><td colspan="1">A TC that changes Duke Nukem 3D into an exaggerated army-style shooter. [http://www.youtube.com/watch?v=xl1E9BtOe9U Gameplay footage]</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://www.moddb.com/mods/10844/duke-nukem-3d-stargate-mod Stargate Mod]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">[[User:The Commander|The Commander]]</td></tr>
<tr><td colspan="2">[[Image:SGMOD1.jpg|200px]][[Image:SGMOD2.jpg|200px]]</td><td colspan="1">The Stargate Mod for Duke Nukem 3D uses Duke Plus as a base. Fight against the Replicators and visit off-world deserts, forests, space ships, and even Atlantis—where anything can happen!</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=31395 Madness Guts in the RooM]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">1master1tc</td></tr>
<tr><td colspan="2">[[Image:Madness2.jpg|200px]][[Image:Madness3.jpg|200px]]</td><td colspan="1">Silent-hill themed TC. [http://youtube.com/watch?v=G252CzfkJZE Link to trailer]</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=30761 WG Medieval Mod]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">William Gee, [[User:DeeperThought|DeeperThought]], Hellbound</td></tr>
<tr><td colspan="2">[[Image:WG1.jpg|200px]][[Image:WG2.jpg|200px]]</td><td colspan="1">Medieval mod with melee combat, magic bows, skeleton knights, dragons and demons. [http://www.picturepush.com/public/590728 Gameplay footage]</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=25350 Symphony of Orekia (AKA The Mansion)]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">Quakis</td></tr>
<tr><td colspan="2">[[Image:Mansion1.jpg|200px]][[Image:Mansion2.jpg|200px]]</td><td colspan="1">Resident Evil-style TC with Demons and creepy interiors. </td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=9670 Decay]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">Hudson, Cage, others</td></tr>
<tr><td colspan="2">[[Image:Decay1.jpg|200px]][[Image:Decay2.jpg|200px]]</td><td colspan="1">Survival-horror TC with zombies! </td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://forums.3drealms.com/vb/showthread.php?t=30962 Blood TC]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">M210</td></tr>
<tr><td colspan="2">[[Image:Blood1.jpg|200px]][[Image:Blood2.jpg|200px]]</td><td colspan="1">Recreation of Blood with EDuke32</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://amc.planetduke.gamespy.com/smf/index.php?topic=7591.0 AMC TC]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">James Stanfield and AMC</td></tr>
<tr><td colspan="2">[[Image:AMCTC1.jpg|200px]][[Image:AMCTC2.jpg|200px]]</td><td colspan="1">The AMC TC is a multi-character TC and gameplay modification. There are 8 characters to choose between, each with different weapon sets and items. Fight through the solar system against Duke's old enemies as well as other dark forces that each plan something unpleasent for Earth and Mars. A initial gameplay release with the finished characters, intromap, and Duke usermap episode is planned with actual story based releases later.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">[http://duke3d.bur.st/forum/index.php?topic=42.0 Action Duke]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, In Development</td>
<td style="border:1px solid #000; background:#eee">[[User:Captain Awesome|Captain Awesome]]</td></tr>
<tr><td colspan="2">[[Image:Duke0003.gif|200px]][[Image:Duke0004.gif|200px]]</td><td colspan="1">Action Duke is a mod that plans to take different weapons, characters, and items from the extended Duke universe, and from other BUILD and related games, in addition to new ideas formulated by the author. Will not be a gameplay mod, but rather a full mod. Screenshots are mockups, screens to come will show actual working gameplay.</td></tr>

<tr><td style="border:1px solid #000; background:#eee">Duke Meets DOOM Rebirth</td>
<td style="border:1px solid #000; background:#eee">Unreleased, In Development</td>
<td style="border:1px solid #000; background:#eee">[[User:Captain Awesome|Captain Awesome]] and [[User:Hendricks 266|Hendricks266]]</td></tr>
<tr><td colspan="2">[[Image:DMDR_001.gif|200px]][[Image:DMDR_002.jpg|200px]]</td><td colspan="1">Duke Meets DOOM Rebirth is an upgrade of the original vanilla TC "Duke Meets Doom". The basis for this mod is that the original maps are good, but the coding and artwork were sloppy. There are three different flavors available. The first is Classic, which will work in 8-Bit mode. The second is Faithful (name pending), which has highres versions of the original art so that the differences of the DOOM and Duke palettes will not hinder it. The third is Updated (name pending), which introduces highres content from the jDRP and friends.</td></tr>

</table>

EDuke32 Modifications

2008-05-17T04:43:31Z

DeeperThought:

Users are encouraged to add links to known EDuke32 mods to this page.

===Mods List===

<table style="border:1px solid #000">
<tr style="background:#000; color:#fff"><td>Name</td><td>Status</td><td>Creator</td></tr>
<tr><td style="border:1px solid #000; background:#eee">[http://www.zxdware.net/NR/ Naferia's Reign: Invasion of the Dark Mistress]</td>
<td style="border:1px solid #000; background:#eee">Released, in development</td>
<td style="border:1px solid #000; background:#eee">[[User:LordMisfit|Lord Misfit]]</td></tr>
<tr><td colspan="3">RPG-Style(w/ EXP, Levels, etc); Multiple Characters(in one party, not Hexen-style); Improved Monster Interactivity with Environment/Objects; Interactive ATM Usage; Shops & Money System; etc.</td></tr>

<tr style="background:#000; color:#fff"><td>Name</td><td>Status</td><td>Creator</td></tr>
<tr><td style="border:1px solid #000; background:#eee">[http://www.moddb.com/mods/9541/duke-nukem-weapon-of-mass-destruction Duke Nukem: Weapon of Mass Destruction]</td>
<td style="border:1px solid #000; background:#eee">Released</td>
<td style="border:1px solid #000; background:#eee">[[User:DeeperThought|DeeperThought]]</td></tr>
<tr><td colspan="3">Duke Nukem: Weapon of Mass Destruction is a gameplay mod for Duke Nukem 3D. It has tons of new weapon modes, enemies, and player abilities, such as UT style dodge moves, spinning hook kicks, and a Duke bot companion who fights by your side. In some levels you can even get in your skycar and fly it, doing bombing runs on enemies. In DNWMD, Duke collects glowing coins from slain enemies which are used to purchase various upgrades via a mouse controlled menu. In addition, each of Duke's weapons has its own experience level which increases with use.</td></tr>

<tr style="background:#000; color:#fff"><td>Name</td><td>Status</td><td>Creator</td></tr>
<tr><td style="border:1px solid #000; background:#eee">[http://www.csus.edu/indiv/g/gaskilld/DukePlus.rar Duke Plus]</td>
<td style="border:1px solid #000; background:#eee">Released, in development</td>
<td style="border:1px solid #000; background:#eee">[[User:DeeperThought|DeeperThought]]</td></tr>
<tr><td colspan="3">Enhanced Engine Design Capabilities, including: Transparent Water; Giving Monsters Special Flags; Climbable Ladders; Mantling/Grappling on ledges; Bot-Allies; Footstep Sounds; Rain and Snow-based weather effects; Quake3-Style Jump Pads; Slippery Floors; etc. </td></tr>

<tr style="background:#000; color:#fff"><td>Name</td><td>Status</td><td>Creator</td></tr>
<tr><td style="border:1px solid #000; background:#eee">[http://files.filefront.com/Nuclear+Showdown+v10zip/;8218523;;/fileinfo.html Nuclear Showdown]</td>
<td style="border:1px solid #000; background:#eee">Released</td>
<td style="border:1px solid #000; background:#eee">[[User:James Stanfield|James Stanfield]]</td></tr>
<tr><td colspan="3">Nuclear showdown is a gameplay mod for Duke Nukem that adds many features such as new weapons, enemies, effects to the default game as well as usermaps - it is built so you can play your favourite usermaps with, even ones that use custom art. You can also play through Duke it out in DC if you have it.</td></tr>

<tr style="background:#000; color:#fff"><td>Name</td><td>Status</td><td>Creator</td></tr>
<tr><td style="border:1px solid #000; background:#eee">[http://hosted.filefront.com/kenia43 Duke Nukem Army]</td>
<td style="border:1px solid #000; background:#eee">Unfinished release, development ceased</td>
<td style="border:1px solid #000; background:#eee">[[User:Kenia|Kenia]]</td></tr>
<tr><td colspan="3">A TC that changes Duke Nukem 3D into an exaggerated army-style shooter.</td></tr>

<tr style="background:#000; color:#fff"><td>Name</td><td>Status</td><td>Creator</td></tr>
<tr><td style="border:1px solid #000; background:#eee">[http://www.moddb.com/mods/10844/duke-nukem-3d-stargate-mod Stargate Mod]</td>
<td style="border:1px solid #000; background:#eee">Unreleased, in development</td>
<td style="border:1px solid #000; background:#eee">[[User:The Commander|The Commander]]</td></tr>
<tr><td colspan="3">The Stargate Mod for Duke Nukem 3D uses Duke Plus as a base. Fight against the Replicators and visit off-world deserts, forests, space ships, and even Atlantis—where anything can happen!</td></tr>
</table>

EVENT DISPLAYROOMS

2008-02-17T07:08:15Z

DeeperThought:

This event can be used to move the game camera from its normal position at the player's head to a specified location. This is done by changing the value of several [[constantly updated gamevars]] which determine the camera's position. The gamevars are:

camerax, cameray, cameraz, cameraang, camerahoriz, and camerasect

The first three are the map coordinates of the camera, cameraang is the direction the camera is facing, camerahoriz is the up/down angle of the camera, and camerasect is its sector. Unless these variables are changed in this event, they will take the corresponding values of the player structure (e.g. camerahoriz defaults to the horiz member of the player structure).

One use for this event is to have it display from the point of view of a sprite other than the player. In the following example, assume that the gamevar camerasprite is global and is set to the sprite ID of a special sprite when the camera is being used, and otherwise has a value of -1. Also assume that the EXTRA member of the camera sprite is set to the desired horiz. What follows is the code appropriate for the event in that case (additional actor code for the camera sprite would also be required).

onevent EVENT_DISPLAYROOMS
ifvarn camerasprite -1
{
getactor[camerasprite].x camerax
getactor[camerasprite].y cameray
getactor[camerasprite].z cameraz
getactor[camerasprite].ang cameraang
getactor[camerasprite].extra camerahoriz
getactor[camerasprite].sectnum camerasect
}
endevent

EVENT DISPLAYROOMS

2008-02-17T07:00:04Z

DeeperThought: New page: This event can be used to move the game camera from its normal position at the player's head to a specified location. This is done by changing the value of several constantly updated game...

This event can be used to move the game camera from its normal position at the player's head to a specified location. This is done by changing the value of several constantly updated gamevars which determine the camera's position. The gamevars are:

camerax, cameray, cameraz, cameraang, camerahoriz, and camerasect

The first three are the map coordinates of the camera, cameraang is the direction the camera is facing, camerahoriz is the up/down angle of the camera, and camerasect is its sector. Unless these variables are changed in this event, they will take the corresponding values of the player structure (e.g. camerahoriz defaults to the horiz member of the player structure).

One use for this event is to have it display from the point of view of a sprite other than the player. In the following example, assume that the gamevar camerasprite is global and is set to the sprite ID of a special sprite when the camera is being used, and otherwise has a value of -1. Also assume that the EXTRA member of the camera sprite is set to the desired horiz. What follows is the code appropriate for the event in that case (additional actor code for the camera sprite would also be required).

onevent EVENT_DISPLAYROOMS
ifvarn camerasprite -1
{
getactor[camerasprite].x camerax
getactor[camerasprite].y cameray
getactor[camerasprite].z cameraz
getactor[camerasprite].ang cameraang
getactor[camerasprite].extra camerahoriz
getactor[camerasprite].sectnum camerasect
}
endevent

Sound pitch

2007-11-24T05:29:18Z

DeeperThought: New page: Changes the pitch of all sounds for the specified player. Negative values lower pitch, positive values raise pitch. Pitch will remain altered, even if a new game is started, until sound_...

Changes the pitch of all sounds for the specified player. Negative values lower pitch, positive values raise pitch. Pitch will remain altered, even if a new game is started, until sound_pitch is set back to 0. Note that sound_pitch will not affect the pitch of sounds already being played (so a looping sound will not be altered until the next time it starts).

Example:

setplayer[THISACTOR].sound_pitch -1024

...will lower the pitch of sounds as if the player were underwater.

Scripting

2007-11-05T05:35:03Z

DeeperThought: /* Event use */

{{EDuke32 Intro}}
<div class="floatleft">__NOTOC__</div> 
==About This Guide==
===Intro===
This guide will get you started with the basic aspects of EDuke32's commands -- those which set it apart from vanilla DN3D. This guide makes no assumptions regarding the programming experience of the reader, other than that the reader comprehends and understands the basic CON system as was seen in Duke Nukem 3D 1.3D/1.5.

===CON Basics===
As stated, this guide assume that you are familiar with the original CON code from Duke3D. If you are not already familiar with the [[:Category:Duke3D_1.3/1.5_commands|default commands]], the authors of this guide recommend the following guide to the basics, imported into the EDukeWiki for your convenience:
* [[Confaq42|Con FAQ 4.2 by Jonah Bishop (note: some sections have been shuffled around a bit by TX)]]
** [http://rtcm.thecomitatus.com/knowledge-base/downloads-rtcm/duke3d-faqs-con/confaq42.zip Download stand-alone zipped version (original version from 1999 in .txt format)]

Another good source of basic information is the following FAQ:
* [http://rtcm.thecomitatus.com/knowledge-base/downloads-rtcm/duke3d-faqs-con/H_CONFAQ.zip Con Editing Information v1.3 by James Ferry]

==Gamevars==

===Overview===
[[Gamevar|Gamevars]] were introduced in [[WW2GI]] and remain the most important aspect of the new commandset. Gamevars work like variables in programming languages, allowing the user to store, manipulate, and compare data. Prior to gamevars, the only usable alternatives were manipulations of inventory item counters and move commands.

===Types===
There are three basic types of gamevar, each type storing a signed 32-bit fixed-point integer. The three basic types are as follows:
* '''Global variable''': If a variable is declared as global, there is only one copy of it which may be accessed by any actor in the game.

For example:

gamevar shots_fired 0 0 // gamevar declarations must not occur inside states, events, or actor code

This line tells the game that there is a variable named "shots_fired" which is initialized to 0 ( the first 0 ) and is global ( the second 0 ).
You could then find the places in the GAME.CON code where the command "shoot SHOTSPARK1" occurs, and in each instance add the line "addvar shots_fired 1", so that in each case it looks like this:

shoot SHOTSPARK1
addvar shots_fired 1 // increments the global var

This will make the shots_fired var increment each time an enemy fires a SHOTSPARK1 projectile.

* '''Per-player variable''': If a variable is declared as per-player, there is one copy of it for each player in the game, meaning that the variable is set independently for each player. If a player performs an action that triggers a per-player variable change within an event or the APLAYER actor code, it will only change for the player that initiated that action. If an actor changes a per-player variable, it will change for the closest player to the actor what changed it. You can use the [[setplayervar]] command to set a per-player var for a particular player who is not the closest one, but this is only necessary in multiplayer games (and even then it is seldom necessary). In single player games, there is little practical difference between a global gamevar and a per-player variable.

* '''Per-actor variable''': If a variable is declared as per-actor, then there is separate copy of it for each sprite in the game. That means that every monster, projectile, player, decorative sprite -- pretty much anything in the game that isn't a wall or sector -- has its own copy of the variable. This is useful if you want to have actors other than the player store information for more than one tick. For example, suppose you want each monster to keep track of how many bullets it has fired:

gamevar shots_fired 0 2

This line tells the game that there is a variable named "shots_fired" which is initialized to 0 ( the 0 ) and is per-actor( the 2 ).
With the gamevar declared, you could then add code to the monsters to increment the var when firing shots (just like in the example above for global gamevars). Since the gamevar is per-actor, the same code would now increment the variable separately for each monster.

'''There are also some [[pre-defined gamevars]] and special [[constantly updated gamevars]] which should only be used in certain ways.'''

===Use and manipulation===

Custom variables, or "gamevars" are declared with the [[gamevar]] command.

The syntax for defining a gamevar is:
::gamevar <varname> <value> <flags>

You may use upper or lowercase letters for <varname>. EDuke32 is case-sensitive, so a var named "EXAMPLE1" is different from "example1." Variable names should not begin with a digit.

The <value> of the gamevar may be positive or negative and must be a whole number.

The <flags> may be set to either 0 (global), 1 (per-player), or 2 (per-actor).

Manipulation of gamevars is accomplished by using a variety of commands that range in functionality from simple mathematical functions to grabbing internal values for manipulation in the CONs. Here are a few of the more common variable manipulation primitives:

*[[setvar]], [[setvarvar]]
*[[addvar]], [[addvarvar]]
*[[subvar]], [[subvarvar]]
*[[mulvar]], [[mulvarvar]]
*[[divvar]], [[divvarvar]]
*[[randvar]], [[randvarvar]]

And some of the more rarely used ones:

*[[andvar]], [[andvarvar]]
*[[sin]], [[cos]]
*[[orvar]], [[orvarvar]]
*[[shiftvarl]], [[shiftvarr]]
*[[xorvar]], [[xorvarvar]]

To test the values of gamevars, the following commands are used:

*[[ifvarand]]
*[[ifvarvarand]]
*[[ifvare]]
*[[ifvarg]]
*[[ifvarl]]
*[[ifvarn]]
*[[ifvarvare]]
*[[ifvarvarg]]
*[[ifvarvarl]]
*[[ifvarvarn]]

A complete list of primitives is available [[Full_command_list|here]]. The importance of manipulating gamevars will become clear when we get to talking about getting and setting the members of the various structures in the game. All commands which accept read-only gamevars will also accept constants in place of them.

==Members of game structures==

===Overview===
EDuke32, like prior EDuke iterations, gives you access to game structures--basic elements of the game such as the player, sprites, walls, and sectors--and their predefined property variables, or members. There are many different structures which can be accessed, and a list of the common ones can be found [[full list of structure members|here]].

===Player===
The [[members of the player structure]] are controlled using the [[getplayer]] and [[setplayer]] commands. The player structure members deal with properties unique to the player which are not shared with other actors. These include variables associated to the players weapons, inventory items, special animations, jumping counters, etc. See the complete list of [[members of the player structure]] for details. [[Make_Nightvision_light_rooms|This example]] shows how to get a member of the player structure into a variable, check its value, then alter a member of the player structure accordingly.

===Actor / Sprite===
[[Members of the sprite and hittype structures]]

Objects in the game world, such as monsters, missiles, bits of debris, and so on, are referred to as "sprites" (because they are typically rendered as 2D pictures). Sprites that execute code are usually referred to as "actors". Every sprite has its own data structure containing all of the elements in the list linked to above. Various CON commands, such as "cstat", "spritepal", "sizeat", etc. work by changing values in the sprite structure of the actor executing the command. Structure members can also be modified directly using the setactor command. This command enables us to modify every member of the structure, even those that could not be accessed with the pre-Eduke scripting system. See [[getactor]] and [[setactor]] to see how these commands are used.
====Hittype====
====Spriteext====

===Sector===
[[Members of the sector structure]]
===Wall===
[[Members of the wall structure]]
===Game configuration===
[[Members of the userdef structure]]
===Player input===
[[Members of the input structure]]
==Events==

===Overview===
EDuke32 provides both an object-oriented and an event-oriented interface to the game's internal workings. As you already know, the object-oriented part of Duke is the actor system -- in contrast to that, we'll be talking about the event-oriented portion in this section. As the name suggests, an [[events|event]] is a block of code that is triggered when a certain event in the game happens. Events in the game are triggered internally whenever a certain point in the code is reached.

Events are a key component in the manipulation of the game. Using events, we can do a variety of things such as intercept keypresses, draw to the screen (more on this later), redefine what a player does when certain actions are executed, et cetera.

===Event use===
Using an event is very easy — similar to the [[actor]] or [[state]] primitives, [[onevent]] is the primitive used to start the definition of a block of code to be associated with one of the [[EDuke32 event list|events]]. Furthering the similarity, onevent must be terminated by the equivalent of an [[enda]] or an [[ends]], an [[endevent]].

The following example of event code will cause the player to have a full first aid kit every time the inventory is reset (e.g. when the player starts a game):

onevent EVENT_RESETINVENTORY
setplayer[THISACTOR].firstaid_amount 100
endevent

====A note on synchronization====
Events introduce the ability for CON code to be run in a manner that isn't synchronized. For example, display events may run a different number of times on each individual system in multiplayer. If you want your mod to function properly in multiplayer, it is very important to note whether an event is synchronized or not. Typically, you'll just want to avoid doing anything that changes the game state (including [[ifrnd]] and [[randvar]]) in display code.

==Drawing to the screen==
The ability to properly draw to the screen is a huge improvement over the hackish abominations involving quotes and unused characters that we were forced to endure when using 1.3d and 1.5. There are several different drawing commands available, ranging in functionality from drawing graphics to the screen to printing text stored in quotes (see the section on string manipulation for more information).

===Drawing commands===
*[[rotatesprite]]
*[[gametext]]
*[[minitext]]
*[[digitalnumber]]
*[[myos]] (deprecated)
*[[myospal]] (deprecated)
*[[myosx]] (deprecated)
*[[myospalx]] (deprecated)

==Custom projectiles==
===Overview===
Eduke32 adds the ability to create new projectiles in addition to the default types. A few basic types exist (shorthand: melee, bullet, and slow projectile) which can be used to create a nearly infinite variety of weapon types and even new effects (example: additional debris types).

===Defining custom projectiles===
Projectiles are defined via the [[defineprojectile]] command. The syntax for this command is:
defineprojectile <tilenum> <function> <value>

Before using this command list of defines should be created:
define PROJ_WORKSLIKE 1
define PROJ_SPAWNS 2
define PROJ_SXREPEAT 3
define PROJ_SYREPEAT 4
define PROJ_SOUND 5
define PROJ_ISOUND 6
define PROJ_VEL 7
define PROJ_EXTRA 8
define PROJ_DECAL 9
define PROJ_TRAIL 10
define PROJ_TXREPEAT 11
define PROJ_TYREPEAT 12
define PROJ_TOFFSET 13
define PROJ_TNUM 14
define PROJ_DROP 15
define PROJ_CSTAT 16
define PROJ_CLIPDIST 17
define PROJ_SHADE 18
define PROJ_XREPEAT 19
define PROJ_YREPEAT 20
define PROJ_PAL 21
define PROJ_EXTRA_RAND 22
define PROJ_HITRADIUS 23
define PROJ_VEL_MULT 24
define PROJ_OFFSET 25
define PROJ_BOUNCES 26
define PROJ_BSOUND 27
define PROJ_RANGE 28

These defines are used to fill the <function> block of defineprojectile.

===Manipulating custom projectiles mid-game===

==String manipulation==
===Quote redefinition mid-game===
redefinequote <quotenumber> <string> // sets the quote number <quotenumber>'s text to <string>
===Copying and concatenation===
qstrcpy <quotenumber1> <quotenumber2> // sets the text of <quotenumber1> to the text of <quotenumber2>
qstrcat <quotenumber1> <quotenumber2> // adds the text of <quotenumber2> to the text of <quotenumber1>

===Dynamic quotes===

==References==
*[[Full command list]]
*[[EDuke32 event list]]
*[[Full list of structure members]]

*[[:Category:All commands|Categorized documentation]]

Main Page

2007-11-05T05:20:38Z

DeeperThought:

__NOTOC__ __NOEDITSECTION__
Welcome to EDukeWiki! This wiki serves to provide the most accurate and complete source of [[EDuke32]] documentation on the Internet.

{| cellpadding="0" cellspacing="0" border="0" width="100%"
| width="33%" valign="top" style="border-right: none; padding: 0.6em;" |

===Using EDuke32===
* [[Installation and configuration]]
* [[Configuration file options]]
* [[Console commands]]
* [[Frequently Asked Questions]]

===Building EDuke32===
* [[Building EDuke32 on Windows]]
* [[Building EDuke32 on Linux]]

| width="33%" valign="top" style="border-left: none; padding: 0.6em;" |

===EDuke32 Modding===
* [[Scripting]]
* [[Level editing]]
* [[Tutorials]]
* [[Utilities]]
* [[EDuke32 Modifications]]

| width="33%" valign="top" style="border-left: none; padding: 0.6em;" |

[[Image:Title_screen.png|right]]

|}

Please remember that EDukeWiki is a community project. It relies on content contributed by users such as yourself in order to stay alive and useful. As such, it is your responsibility to not only make sure that the documentation here is both accurate and relevant to current version of [[EDuke32]], but to also help reverse any vandalism you see. Thank you for your contributions!