EDukeWiki - User contributions [en]

Cstat (wall)

2021-04-05T12:43:30Z

Jblade:

A [[bitfield]] for how to draw a wall, as well as a few flags for interaction. Add all together all wanted flag values.

Unused bits are '''NOT''' free for user programming, but are rather reserved for potential future EDuke32 features.

Not to be confused with sprite [[cstat (sprite)|cstat]].

If the wall has cstat 2 applied to it (CSTAT_WALL_BOTTOM_SWAP) than the bottom half's attributes are applied to the current wall's [[nextwall]]

== Flags ==

{{Wall cstat}}

[[Category:Bitfields]]
[[Category:Wall structure members]]

Startcutscene

2020-08-02T10:04:23Z

Jblade: Created page with "'''startcutscene''' <cutscene id> Used to start a [https://wiki.eduke32.com/wiki/Cutscene_(DEF)[cutscene]] defined in the def file. Category:EDuke32 specific commands"

'''startcutscene''' <cutscene id>

Used to start a [https://wiki.eduke32.com/wiki/Cutscene_(DEF)[cutscene]] defined in the def file.

[[Category:EDuke32 specific commands]]

Category:Structure access

2020-08-02T10:01:43Z

Jblade:

One of the hallmarks of EDuke32's CON scripting advancements is the ability to access many of the game's internal data structures.

==Usage==

Struct access was designed with the syntax of an array of a struct type in the C programming language.

The index in <nowiki>[</nowiki>square brackets<nowiki>]</nowiki> is an ID number that has different meanings for different structs. Most simple uses of struct access will suffice to use the gamevar [[THISACTOR]] as an index, which usually means the current sprite but is also usable as a ''magic token'' for different meanings with non-sprite structures. Other times, you may know an ID from a command like [[findnearactor]] or [[espawn]] (from gamevar [[RETURN]]). On occasion you may also [[whilevarn|loop]] through all or a selection of ID numbers.

===Getters & Setters===

Get/set commands are the original methods of CON struct access that date back to DOS EDuke.

get<struct>[<id>].<[[Full list of structure members|member]]> <[[gamevar]]> 
set<struct>[<id>].<[[Full list of structure members|member]]> <value> 

The '''get''' commands fetch one of the [[Full list of structure members|members of a structure]] into a [[gamevar]].

The '''set''' commands assign the value provided to the member.

<id> can be omitted entirely, which implies an id of [[THISACTOR]].

The commands with the "var" suffix are used to access custom members for a struct, which are really just that ID's gamevars which have the per-<struct> flag set. So <code>setactorvar[THISACTOR].temp 0</code> is the same as <code>setvar temp 0</code>.

===Quick Access===

More recently added, structs can be used in place of gamevars, in the form <code><struct>[<id>].<[[Full list of structure members|member]]></code>. For example:

[[ifvarg]] userdef[].[[executions]] 10000
{
[[redefinequote]] 117 You have way too much time on your hands.
echo 117
}

With quick access, structures are always read-only. Attempting to use a gamevar-writing command on a quick access structure will result in a compiler error.

Quick struct access cannot be used as an index to other quick struct accesses.

==Structs==

{| {{prettytablebordered}}
!Get/Set Name!!Quick Name!!ID type!![[THISACTOR]] meaning!!Description!!Notes
|-
|[[Members of the sprite, hittype, and spriteext structures|actor]]
|[[Members of the sprite, hittype, and spriteext structures|sprite]]
|[[sprite id]]
|current sprite
|sprites and hittypes
|
|-
|colspan="2"|actorvar
|[[sprite id]]
|current sprite
|per-actor gamevars
|
|-
|colspan="2"|[[Members of the tsprite structure|tspr]]
|[[sprite id]]
|current sprite
|sprites' display properties
|Can only be used within [[EVENT_ANIMATESPRITES]] on sprites with [[mdflags]] containing flag 16.
|-
|colspan="2"|[[Members of the projectile structure|projectile]]
|[[tile number]]
|(none)
|projectile types
|
|-
|colspan="2"|[[Members of the projectile structure|thisprojectile]]
|[[sprite id]]
|current sprite
|individual projectiles
|
|-
|colspan="2"|[[Members of the sector structure|sector]]
|[[sector id]]
|current sprite's sector
|sectors, floors, and ceilings
|
|-
|colspan="2"|[[Members of the wall structure|wall]]
|[[wall id]]
|(none)
|walls
|
|-
|colspan="2"|[[Members of the player structure|player]]
|[[player id]]
|current player
|players
| getp can be used as a shorthand.
|-
|colspan="2"|playervar
|[[player id]]
|current player
|per-player gamevars
| getpv can be used as a shorthand.
|-
|colspan="2"|[[Members of the input structure|input]]
|[[player id]]
|current player
|input
|Generally used within [[EVENT_PROCESSINPUT]]; geti can be used as a shorthand.
|-
|colspan="2"|[[Members of the userdef structure|userdef]]
|(none)
|(none)
|user preferences, game state
|Use nothing within the brackets; getu can be used as a shorthand.
|-
|colspan="2"|[[Members of the tiledata structure|tiledata]]
|[[tile number]]
|current sprite's picnum
|art tiles
|
|-
|(none)
|[[Members of the paldata structure|paldata]]
|[[palookup number]]
|(none)
|palette lookups (palswaps)
|
|}

[[Category:EDuke32 end-user documentation]]
[[Category:Scripting documentation]]

Category:Structure access

2020-08-02T10:00:26Z

Jblade:

One of the hallmarks of EDuke32's CON scripting advancements is the ability to access many of the game's internal data structures.

==Usage==

Struct access was designed with the syntax of an array of a struct type in the C programming language.

The index in <nowiki>[</nowiki>square brackets<nowiki>]</nowiki> is an ID number that has different meanings for different structs. Most simple uses of struct access will suffice to use the gamevar [[THISACTOR]] as an index, which usually means the current sprite but is also usable as a ''magic token'' for different meanings with non-sprite structures. Other times, you may know an ID from a command like [[findnearactor]] or [[espawn]] (from gamevar [[RETURN]]). On occasion you may also [[whilevarn|loop]] through all or a selection of ID numbers.

===Getters & Setters===

Get/set commands are the original methods of CON struct access that date back to DOS EDuke.

get<struct>[<id>].<[[Full list of structure members|member]]> <[[gamevar]]> 
set<struct>[<id>].<[[Full list of structure members|member]]> <value> 

The '''get''' commands fetch one of the [[Full list of structure members|members of a structure]] into a [[gamevar]].

The '''set''' commands assign the value provided to the member.

<id> can be omitted entirely, which implies an id of [[THISACTOR]].

The commands with the "var" suffix are used to access custom members for a struct, which are really just that ID's gamevars which have the per-<struct> flag set. So <code>setactorvar[THISACTOR].temp 0</code> is the same as <code>setvar temp 0</code>.

===Quick Access===

More recently added, structs can be used in place of gamevars, in the form <code><struct>[<id>].<[[Full list of structure members|member]]></code>. For example:

[[ifvarg]] userdef[].[[executions]] 10000
{
[[redefinequote]] 117 You have way too much time on your hands.
echo 117
}

With quick access, structures are always read-only. Attempting to use a gamevar-writing command on a quick access structure will result in a compiler error.

Quick struct access cannot be used as an index to other quick struct accesses.

==Structs==

{| {{prettytablebordered}}
!Get/Set Name!!Quick Name!!ID type!![[THISACTOR]] meaning!!Description!!Notes
|-
|[[Members of the sprite, hittype, and spriteext structures|actor]]
|[[Members of the sprite, hittype, and spriteext structures|sprite]]
|[[sprite id]]
|current sprite
|sprites and hittypes
|
|-
|colspan="2"|actorvar
|[[sprite id]]
|current sprite
|per-actor gamevars
|
|-
|colspan="2"|[[Members of the tsprite structure|tspr]]
|[[sprite id]]
|current sprite
|sprites' display properties
|Can only be used within [[EVENT_ANIMATESPRITES]] on sprites with [[mdflags]] containing flag 16.
|-
|colspan="2"|[[Members of the projectile structure|projectile]]
|[[tile number]]
|(none)
|projectile types
|
|-
|colspan="2"|[[Members of the projectile structure|thisprojectile]]
|[[sprite id]]
|current sprite
|individual projectiles
|
|-
|colspan="2"|[[Members of the sector structure|sector]]
|[[sector id]]
|current sprite's sector
|sectors, floors, and ceilings
|
|-
|colspan="2"|[[Members of the wall structure|wall]]
|[[wall id]]
|(none)
|walls
|
|-
|colspan="2"|[[Members of the player structure|player]]
|[[player id]]
|current player
|players
| getp can be used as a shorthand.
|-
|colspan="2"|playervar
|[[player id]]
|current player
|per-player gamevars
| getpv can be used as a shorthand.
|-
|colspan="2"|[[Members of the input structure|input]]
|[[player id]]
|current player
|input
|Generally used within [[EVENT_PROCESSINPUT]]; geti can be used as a shorthand.
|-
|colspan="2"|[[Members of the userdef structure|userdef]]
|(none)
|(none)
|user preferences, game state
|Use nothing within the brackets.
|-
|colspan="2"|[[Members of the tiledata structure|tiledata]]
|[[tile number]]
|current sprite's picnum
|art tiles
|
|-
|(none)
|[[Members of the paldata structure|paldata]]
|[[palookup number]]
|(none)
|palette lookups (palswaps)
|
|}

[[Category:EDuke32 end-user documentation]]
[[Category:Scripting documentation]]

Category:Structure access

2020-08-02T09:58:00Z

Jblade:

One of the hallmarks of EDuke32's CON scripting advancements is the ability to access many of the game's internal data structures.

==Usage==

Struct access was designed with the syntax of an array of a struct type in the C programming language.

The index in <nowiki>[</nowiki>square brackets<nowiki>]</nowiki> is an ID number that has different meanings for different structs. Most simple uses of struct access will suffice to use the gamevar [[THISACTOR]] as an index, which usually means the current sprite but is also usable as a ''magic token'' for different meanings with non-sprite structures. Other times, you may know an ID from a command like [[findnearactor]] or [[espawn]] (from gamevar [[RETURN]]). On occasion you may also [[whilevarn|loop]] through all or a selection of ID numbers.

===Getters & Setters===

Get/set commands are the original methods of CON struct access that date back to DOS EDuke.

get<struct>[<id>].<[[Full list of structure members|member]]> <[[gamevar]]> 
set<struct>[<id>].<[[Full list of structure members|member]]> <value> 

The '''get''' commands fetch one of the [[Full list of structure members|members of a structure]] into a [[gamevar]].

The '''set''' commands assign the value provided to the member.

<id> can be omitted entirely, which implies an id of [[THISACTOR]].

The commands with the "var" suffix are used to access custom members for a struct, which are really just that ID's gamevars which have the per-<struct> flag set. So <code>setactorvar[THISACTOR].temp 0</code> is the same as <code>setvar temp 0</code>.

===Quick Access===

More recently added, structs can be used in place of gamevars, in the form <code><struct>[<id>].<[[Full list of structure members|member]]></code>. For example:

[[ifvarg]] userdef[].[[executions]] 10000
{
[[redefinequote]] 117 You have way too much time on your hands.
echo 117
}

With quick access, structures are always read-only. Attempting to use a gamevar-writing command on a quick access structure will result in a compiler error.

Quick struct access cannot be used as an index to other quick struct accesses.

==Structs==

{| {{prettytablebordered}}
!Get/Set Name!!Quick Name!!ID type!![[THISACTOR]] meaning!!Description!!Notes
|-
|[[Members of the sprite, hittype, and spriteext structures|actor]]
|[[Members of the sprite, hittype, and spriteext structures|sprite]]
|[[sprite id]]
|current sprite
|sprites and hittypes
|
|-
|colspan="2"|actorvar
|[[sprite id]]
|current sprite
|per-actor gamevars
|
|-
|colspan="2"|[[Members of the tsprite structure|tspr]]
|[[sprite id]]
|current sprite
|sprites' display properties
|Can only be used within [[EVENT_ANIMATESPRITES]] on sprites with [[mdflags]] containing flag 16.
|-
|colspan="2"|[[Members of the projectile structure|projectile]]
|[[tile number]]
|(none)
|projectile types
|
|-
|colspan="2"|[[Members of the projectile structure|thisprojectile]]
|[[sprite id]]
|current sprite
|individual projectiles
|
|-
|colspan="2"|[[Members of the sector structure|sector]]
|[[sector id]]
|current sprite's sector
|sectors, floors, and ceilings
|
|-
|colspan="2"|[[Members of the wall structure|wall]]
|[[wall id]]
|(none)
|walls
|
|-
|colspan="2"|[[Members of the player structure|player]]
|[[player id]]
|current player
|players
| getp can be used as a shorthand
|-
|colspan="2"|playervar
|[[player id]]
|current player
|per-player gamevars
| getpv can be used as a shorthand
|-
|colspan="2"|[[Members of the input structure|input]]
|[[player id]]
|current player
|input
|Generally used within [[EVENT_PROCESSINPUT]].
|-
|colspan="2"|[[Members of the userdef structure|userdef]]
|(none)
|(none)
|user preferences, game state
|Use nothing within the brackets.
|-
|colspan="2"|[[Members of the tiledata structure|tiledata]]
|[[tile number]]
|current sprite's picnum
|art tiles
|
|-
|(none)
|[[Members of the paldata structure|paldata]]
|[[palookup number]]
|(none)
|palette lookups (palswaps)
|
|}

[[Category:EDuke32 end-user documentation]]
[[Category:Scripting documentation]]

Undefinecheat

2020-08-02T09:49:19Z

Jblade:

'''undefinecheat''' <cheat number>

Can be used to disable a cheat code. udc can be used as a shorthand version.

See [[definecheat]] for a list of cheats and their codes.

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

Definecheat

2020-08-02T09:48:31Z

Jblade:

'''definecheat''' <cheat number> <text to activate cheat>

Similar to [[definequote]]. This command does not allow the user to create new cheats with new functionality, but simply allows the user to change the text which activates the hard coded cheats. There are a total of 27 cheats, the first 26 of which can be redefined with [[definecheat]].

To change the two letter combination that's entered before the cheat, see [[cheatkeys]].

Trivia: The Duke Nukem 3D source code indicates that cheat 15 was "bonus" and cheat 25 was "ending" during development.

You can use dc as a shorthand for this command.

== Values ==

{{Cheats}}

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

Actorsound

2020-08-02T09:45:22Z

Jblade:

'''actorsound''' <sprite ID> <sound#>

Will make the specified sprite play a sound effect.

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

Ifactorsound

2020-08-02T09:45:09Z

Jblade:

'''ifactorsound''' <sprite ID> <sound#>

Detects if the specified sprite is playing this sound number.

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

Actorsound

2020-08-02T09:44:22Z

Jblade: Created page with "'''actorsound''' <sprite ID> <sound#> Will make the specified sprite play a sound effect."

'''actorsound''' <sprite ID> <sound#>

Will make the specified sprite play a sound effect.

Ifactorsound

2020-08-02T09:43:26Z

Jblade:

'''ifactorsound''' <sprite ID> <sound#>

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

EVENT DISPLAYCAMERAOSD

2020-08-02T09:34:36Z

Jblade: Created page with "EVENT_DISPLAYCAMERAOSD is a Game Event. This event is run whenever the on screen display for security cameras is active (Triggered by using security mo..."

EVENT_DISPLAYCAMERAOSD is a [[EDuke32_event_list|Game Event]].

This event is run whenever the on screen display for security cameras is active (Triggered by using security monitors ingame) set RETURN to 1 to disable the onscreen display.

[[Category:Events]]

EVENT DISPLAYKNUCKLES

2020-08-02T09:33:18Z

Jblade: Created page with "EVENT_DISPLAYKNUCKLES is a Game Event. This event is run whenever the knuckle crack animation is displayed (Triggered in-game by idling for a set amoun..."

EVENT_DISPLAYKNUCKLES is a [[EDuke32_event_list|Game Event]].

This event is run whenever the knuckle crack animation is displayed (Triggered in-game by idling for a set amount of time) set RETURN to 1 to disable.

[[Category:Events]]

EVENT DISPLAYSPIT

2020-08-02T09:32:04Z

Jblade: Created page with "EVENT_DISPLAYSPIT is a Game Event. This event is run whenever the onscreen 'loogie' animation is played (Triggered when the player is hit by the Lizman..."

EVENT_DISPLAYSPIT is a [[EDuke32_event_list|Game Event]].

This event is run whenever the onscreen 'loogie' animation is played (Triggered when the player is hit by the Lizman's spit attack)

[[Category:Events]]

EVENT DISPLAYTIP

2020-08-02T09:31:15Z

Jblade: Created page with "EVENT_DISPLAYTIP is a Game Event. This event is run whenever the tipping animation is displayed (triggered in-game by using the strippers) Set RETURN t..."

EVENT_DISPLAYTIP is a [[EDuke32_event_list|Game Event]].

This event is run whenever the tipping animation is displayed (triggered in-game by using the strippers) Set RETURN to 1 to disable.

[[Category:Events]]

EVENT DISPLAYSCUBA

2020-08-02T09:29:59Z

Jblade: Created page with "EVENT_DISPLAYSCUBA is a Game Event. This event is run whenever the Scuba gear sprite is displayed on screen (when the player has Scuba gear in Duke3D)..."

EVENT_DISPLAYSCUBA is a [[EDuke32_event_list|Game Event]].

This event is run whenever the Scuba gear sprite is displayed on screen (when the player has Scuba gear in Duke3D) set RETURN to 1 to disable.

[[Category:Events]]

EVENT DISPLAYFIST

2020-08-02T09:28:50Z

Jblade: Created page with "EVENT_DISPLAYFIST is a Game Event. This event is run whenever the Fist animation is played (triggered when using a Nuke Button) set RETURN to 1 to disa..."

EVENT_DISPLAYFIST is a [[EDuke32_event_list|Game Event]].

This event is run whenever the Fist animation is played (triggered when using a Nuke Button) set RETURN to 1 to disable.

[[Category:Events]]

EVENT DISPLAYACCESS

2020-08-02T09:25:59Z

Jblade: Created page with "EVENT_DISPLAYACCESS is a Game Event. This event is run whenever the keycard animation is played onscreen (by default triggered when using an access car..."

EVENT_DISPLAYACCESS is a [[EDuke32_event_list|Game Event]].

This event is run whenever the keycard animation is played onscreen (by default triggered when using an access card on a keycard slot) Set RETURN to 1 to disable.

[[Category:Events]]

Autosave

2020-08-02T08:44:04Z

Jblade: Created page with "If true if player checkpoints are enabled in the menu; only utilised for Ion Fury/Standalone Eduke32 exes. Category:Userdef structure members"

If true if player checkpoints are enabled in the menu; only utilised for Ion Fury/Standalone Eduke32 exes.

[[Category:Userdef structure members]]

Ifvar conditions

2020-08-02T05:36:34Z

Jblade: didn't see the ife stuff was already there

'''ifvar'''<'''conditional'''> <[[gamevar]]> <constant> 
'''ifvarvar'''<'''conditional'''> <[[gamevar]]> <[[gamevar]]>

Ifvar conditions are special [[if condition]]s that apply to [[gamevar]]s. These statements work by comparing the two inputs using the conditional provided as part of the command. If the resulting comparison or operation is true, the game will then execute the code specified. If only one CON command is to be performed, simply put it after the condition. For best reading, put it on the same line or on the following line, indented. For longer chains, enclose the code in curly braces ("{" and "}"). For performance reasons, do not use curly braces for single commands. [[Else]] statements can also be used. If you want to do nothing, followed by an else, in place of a command you can write <code>[[nullop]]</code> or <code>{ }</code>.

{| {{prettytable}}
!Conditional!!C/C++!!Math!!Description!!
|-
|e
|==
|=
|equal to
|-
|l
|<
|<
|less than
|-
|g
|>
|>
|greater than
|-
|n
|!=
|≠
|not equal to
|-
|and
|&
|
|bitwise AND
|-
|or
|<nowiki>|</nowiki>
|
|bitwise OR
|-
|xor
|^
|
|bitwise XOR
|-
|either
|<nowiki>||</nowiki>
|
|logical OR: either are non-zero
|}

Since CON variables are integer-only, "less-than or equal to" (le, <=, ≤) and "greater-than or equal to" (ge, >=, ≥) conditionals are unnecessary.

{{varsuffix}}

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

Ifvar conditions

2020-08-02T05:35:37Z

Jblade:

'''ifvar'''<'''conditional'''> <[[gamevar]]> <constant> 
'''ifvarvar'''<'''conditional'''> <[[gamevar]]> <[[gamevar]]>

Ifvar conditions are special [[if condition]]s that apply to [[gamevar]]s. These statements work by comparing the two inputs using the conditional provided as part of the command. If the resulting comparison or operation is true, the game will then execute the code specified. If only one CON command is to be performed, simply put it after the condition. For best reading, put it on the same line or on the following line, indented. For longer chains, enclose the code in curly braces ("{" and "}"). For performance reasons, do not use curly braces for single commands. [[Else]] statements can also be used. If you want to do nothing, followed by an else, in place of a command you can write <code>[[nullop]]</code> or <code>{ }</code>.

{| {{prettytable}}
!Conditional!!C/C++!!Math!!Description!!
|-
|e
|==
|=
|equal to
|-
|l
|<
|<
|less than
|-
|g
|>
|>
|greater than
|-
|n
|!=
|≠
|not equal to
|-
|and
|&
|
|bitwise AND
|-
|or
|<nowiki>|</nowiki>
|
|bitwise OR
|-
|xor
|^
|
|bitwise XOR
|-
|either
|<nowiki>||</nowiki>
|
|logical OR: either are non-zero
|}

Since CON variables are integer-only, "less-than or equal to" (le, <=, ≤) and "greater-than or equal to" (ge, >=, ≥) conditionals are unnecessary. As a shorthand you can drop the 'var' from the command and just use ife for ifvare, ifn for ifvarn, .etc

{{varsuffix}}

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

PROJ WORKSLIKE

2020-01-06T13:17:28Z

Jblade:

PROJ_WORKSLIKE is a [[defineprojectile]] property used to set flags for projectile function. It is a [[bitfield]]. The flags (defined) are:

define [[PROJECTILE_HITSCAN]] 1
define [[PROJECTILE_RPG]] 2
define [[PROJECTILE_BOUNCESOFFWALLS]] 4
define [[PROJECTILE_BOUNCESOFFMIRRORS]] 8
define [[PROJECTILE_KNEE]] 16
define [[PROJECTILE_WATERBUBBLES]] 32
define [[PROJECTILE_TIMED]] 64
define [[PROJECTILE_BOUNCESOFFSPRITES]] 128
define [[PROJECTILE_SPIT]] 256
define [[PROJECTILE_COOLEXPLOSION1]] 512
define [[PROJECTILE_BLOOD]] 1024
define [[PROJECTILE_LOSESVELOCITY]] 2048
define [[PROJECTILE_NOAIM]] 4096
define [[PROJECTILE_RANDDECALSIZE]] 8192
define [[PROJECTILE_EXPLODEONTIMER]] 16384
define [[PROJECTILE_RPG_IMPACT]] 32768
define [[PROJECTILE_RADIUS_PICNUM]] 65536
define [[PROJECTILE_ACCURATE_AUTOAIM]] 131072
define [[PROJECTILE_FORCEIMPACT]] 262144
define [[PROJECTILE_REALCLIPDIST]] 524288
define [[PROJECTILE_ACCURATE]] 1048576
define [[PROJECTILE_NOSETOWNERSHADE]] 2097152
define [[PROJECTILE_RPG_IMPACT_DAMAGE]] 4194304

Note that the damage on impact bit (32768) must be set on the WORKSLIKE of any RPG type projectile (i.e. nonhitscan) for which the projectile itself does damage, as opposed to the damage being caused only by the hitradius.

Syntax is:

[[defineprojectile]] <tile number> '''PROJ_WORKSLIKE''' <flag value>

Add all the desired flags together, and use that value for <flag value>. This works similar to [[cstat]].

[[Category:Bitfields]]
[[Category:Projectile_structure_members]]

Clearmapstate

2019-09-19T07:17:44Z

Jblade:

'''clearmapstate''' <level>

Clears the specified map from the map cache. Formula is VOLUMExMAXLEVELS+LEVEL, where MAXLEVELS is 64. Used in conjunction with [[savemapstate]].

Shoot

2019-08-08T07:36:50Z

Jblade:

'''shoot''' <[[tile number]]> 
'''shootvar''' <[[tile number]]> 
'''eshoot''' <[[tile number]]> 
'''eshootvar''' <[[tile number]]> 
'''zshoot''' <[[zvel]]> <[[tile number]]> 
'''zshootvar''' <[[zvel]]> <[[tile number]]> 
'''ezshoot''' <[[zvel]]> <[[tile number]]> 
'''ezshootvar''' <[[zvel]]> <[[tile number]]>

Causes the current [[actor]] to fire the projectile <[[tile number]]>.

Commands with an "e" prefix set the [[gamevar]] [[RETURN]] to the spawned projectile's [[sprite id]].

Commands with a "z" prefix shoot the projectile with a z-velocity of <[[zvel]]>. Values for <[[zvel]]> can be calculated using the [[ldist]] command. These functions are useful for causing an [[actor]] to aim vertically at objects other than the player. They are also important to control the vertical aim of hitscan projectiles. In hitscan projectiles, the value works similar to sloped [[sector]]s (4096 [[build units]] = 45�).

{{varsuffix}}

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

DEF Language

2019-08-02T14:15:03Z

Jblade: added in volume setting added in r7117

DEF files are parsed scripts which allow definition of textures, 3D models, miscellaneous settings, higher-quality sounds and music, and more.

Comments can be used by prefixing the text with a double forward-slash <code>//</code>, or surrounding the text with <code>/* (comment here) */</code>.

__TOC__

==Setup==

=====include=====
{{Def table1}}

include <filename> 
#include <filename>

Processes the script commands in <filename> at the point of the include call.

{{Def table2}}

=====includedefault=====
{{Def table1}}

includedefault 
#includedefault

Processes the script commands in the default .def file at the point of the include call. Only useful for command-line overrides.

For Duke Nukem 3D, the file is duke3d.def. For NAM, it is nam.def. For WWII GI, it is ww2gi.def.

{{Def table2}}

=====define=====
{{Def table1}}

define <label> <integer-value> 
#define <label> <integer-value>

Declares <label> to represent the numeric value <integer-value>. <integer-value> can be a label, in which case the value of the label given is used.

NOTE: You may find it convenient to include DEFS.CON or NAMES.H to predefine many of the tile (and sound) names in the art file.

{{Def table2}}

=====loadgrp=====
{{Def table1}}

loadgrp <.grp\.zip file>

The DEF equivalent of the /g command line switch.

{{Def table2}}

=====noautoload=====
{{Def table1}}

noautoload

Disables the autoload dir feature.

{{Def table2}}

=====cachesize=====
{{Def table1}}

cachesize <size>

Specifies the size of the cache in Kb. Don't use this unless you know what you are doing.

{{Def table2}}

=====globalflags=====
{{Def table1}}

globalflags <flags>

Specifies a set of global flags. Multiple flags can be set by adding their numbers together.

0 = None 
1 = No palette emulation in OpenGL. 
2 = No fullbrights in OpenGL. 
4 = No fog shading in OpenGL. 

{{Def table2}}

==Color Palettes==

=====tint=====
{{Def table1}}
tint { ... }

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles.

Example:

tint { pal 1 red 127 green 127 blue 255 flags 0 }
tint { pal 2 green 127 blue 127 }

The brace-enclosed block may contain these instructions:

: pal <palnum>

: The palette number the tint applies to.

: red <value> (or r <value>) 
: green <value> (or g <value>) 
: blue <value> (or b <value>)

: Specifies a color component value, in the range of 0 to 255. Unspecified components are assumed to be 255 and any out of range values are clamped to the maximum or minimum as appropriate.

: flags <flags>

: Specifies any special processing effects to use for the tint. The value of flags may be the sum of any of these values:

: 0 = no effects 
: 1 = convert to greyscale 
: 2 = invert colors

{{Def table2}}

=====fogpal=====
{{Def table1}}

fogpal <palette number> <red intensity> <green intensity> <blue intensity>

fogpal defines a palette a sector-based fog effect. To use it, change the pal of your sector to the pal defined with fogpal.

Intensities range from 0-63. Palettes 26, 27, 28 and 29 are pre-defined for you as white, red, green and blue respectively. Sector visibility controls fog density.

{{Def table2}}

=====makepalookup=====

{{Def table1}}
makepalookup { ... }

Interface to creating palette lookups containing both color index remapping (only in effect for non-hightile textures) and fog. This is in contrast to '''fogpal''', which always resets the remapping to the identity mapping ("pal 0").

The brace-enclosed block may contain these instructions:

: pal <palnum>

: The palette number, must be from 1 to 250.

: red <value> (or r <value>) 
: green <value> (or g <value>) 
: blue <value> (or b <value>)

: Specifies a color component value, in the range of 0 to 63. Unspecified components are assumed to be 0 and any out of range values are clamped to the maximum or minimum as appropriate.

: remappal <palnum>

: The palette number to take the index remapping from, i.e. 21 for blue -> red. When absent, defaults to 0.

: remapself

: The same as '''remappal''' ''<palnum>'', where ''<palnum>'' is the number provided for the '''pal''' token.

'''Examples''' 

This creates palookup 200 with a fog of (30,0,0) and a blue-to-yellow remapping (assuming it has not been changed before):
makepalookup { pal 200 red 30 remappal 23 }

This 'fogifies' palookup 21 with a red fog:
makepalookup { pal 21 red 30 remapself }

This overwrites palookup 21 with a red fog, but clears the blue-to-red remapping:
makepalookup { pal 21 red 30 }

{{Def table2}}

== Definitions ==

===8-Bit .ART File Replacements===

=====tilefromtexture=====
{{Def table1}}

tilefromtexture <tilenum> { ... }

Used to generate an 8-bit tile from an image file. Use the alpha channel for transparency instead of the pink color.

: file <filename> 
: name <filename>

: alphacut <value>

In addition to working when you are adding an image file as an art tile, the following parameters can also be used without specifying a file to ''modify'' the attributes of an existing ART tile.

: xoffset <value> 
: xoff <value>

: yoffset <value> 
: yoff <value>

: texhitscan 
: nofullbright

{{Def table2}}

=====animtilerange=====
{{Def table1}}

animtilerange <tilenum1> <tilenum2> <speed value> <animation value>

Sets an animation range identical to the ones embedded in the .ART files.

Speed value ranges from 0 to 15, 0 being the fastest.

Values are:

0 = none 
1 = oscillating 
2 = forward 
3 = backward

{{Def table2}}

=====voxel=====
{{Def table1}}

voxel <filename> { ... }

Defines a voxel to replace sprites. filename is the name of the .KVX file containing the voxel. The brace-enclosed block may contain these instructions:

: tile <tilenum> 
: tile0 <tilenum> 
: tile1 <tilenum>

: Use these instructions to map tiles that should be rendered as a voxels. Use tile to map a single tile to be rendered as voxels and tile0, tile1 together define a range of tiles to be rendered as voxels. The tile0 instruction should appear before the tile1 instruction to define a correct range.

: scale <value>

: <value> is a (possibly fractional) value specifying a scaling factor for the voxelmodel when it is rendered, eg. 1.5 for one-and-a-half times as big.

{{Def table2}}

===High Resolution Art===

=====texture=====
{{Def table1}}
texture <tilenum> { ... }

Defines a Hightile texture to replace an ART-file tile. <tilenum> may be a number, or a defined label.

Example:

texture 3586 {
pal 0 { file "mymod/tree.png" }
pal 21 { file "mymod/tree_red.png" xscale 2.0 yscale 2.0 alphacut 0 nodownsize nocompress }
glow { file "mymod/tree_light.png" }
detail { file "mymod/plant_texture.png" scale 0.5 }
}

The brace-enclosed block may contain these instructions:

: pal <palnum> { ... }

: Replaces the palette <palnum>. If a palette has no pal definition palette 0 definition will be used. Tint will not be used on palettes defined with this instruction.

: The brace-enclosed block may contain these instructions:

:: file <filename> (or name <filename>)

:: Defines which texture file to use. File may be any PNG, JPG, DDS, TGA, BMP, GIF or PCX file. This instruction must be supplied.

:: alphacut <cutoff-value>

:: Sets the level of transparency at which a pixel in the texture is considered opaque. Pixels with more transparency than the cut-off are not drawn to the screen when rendered. The default setting is 0.32, which is just below the 33% transparency level of Build. If your texture has areas that are more transparent than the default, you can lower the cut-off level to preserve that detail.

:: nocompress

:: Prevents the texture from being compressed using S3TC if texture compression is enabled.

:: nodownsize

:: Prevents the texture from being downsized.

:: xscale <value> 
:: yscale <value>

:: Sets the scale of the hightile texture in relation to the original texture. A <value> of 1.0 makes it the same size, higher makes it cover more then the original tile and smaller makes it cover a smaller area. xscale (aka scale, detailscale, intensity) sets the horizontal scale and yscale sets the vertical scale.

: detail { ... }

: Defines a [[Detail_mapping|detail texture]] for the texture. The brace-enclosed block may contain these instructions:

:: file <filename>

:: Specifies which detail texture file to use. File may be any PNG, JPG, DDS, TGA, BMP, GIF or PCX file. This instruction must be supplied.

:: scale <value>

:: <value> is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

: glow { ... }

: Defines a [[Glow_mapping|glow map]] for the texture. The brace-enclosed block may contain these instructions:

:: file <filename>

:: Specifies which glow map file to use. This instruction must be supplied.

{{Def table2}}

=====skybox=====
{{Def table1}}

skybox { ... }

Defines a skybox that overrides a parallaxing floor or ceiling in OpenGL rendering modes.

Example:
skybox {
tile 3586 pal 0
front "mymod/sky_1.png" nocompress
right "mymod/sky_2.png" nocompress
back "mymod/sky_3.png" nocompress
left "mymod/sky_4.png" nocompress
top "mymod/sky_5.png" nocompress
down "mymod/sky_6.png" nocompress
}

The brace-enclosed block may contain these instructions:

: tile <tilenum>

: Specifies the ART file tile to override.

: pal <palnum>

: Specifies the palette number the skybox should happen for.

: front <filename> (or Front / ft / forward) 
: right <filename> (or rt / right) 
: back <filename> (or bk / back) 
: left <filename> (or lf / left) / lt) 
: top <filename> (or up / top / ceiling / ceil) 
: down <filename> (or dn / bottom / floor / down)

: Defines a single face of the skybox where facename may be any of these keywords appropriate for the face in question:

: NOTE: All six faces are required to be specified.

{{Def table2}}

=====model=====
{{Def table1}}

model <filename> { ... }

Defines a model to replace certain sprites in the game when running in 32-bit OpenGL mode. <filename> is the model file in md2 or md3 format.

Note: md2 is considered deprecated.

The brace-enclosed block may contain these instructions:

: scale <value>

: <value> is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big.

: shade <shade-offset>

: <shade-offset> is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

: zadd <offset>

: <offset> is a (possibly fractional) value specifying a height offset for the model. Quake models are aligned in the center while Build models are aligned at the floor. Using this command will allow Build to use Quake models without modification to the MD2/3 file itself.

: flags <flags>

: Specifies any special properties the model should have, the values of which should be added together to combine multiple options.
: 0: default value 
: 1: Prevents the the model from being affected by the tints. 

: skin { ... }

: Defines a skin to be used on the model for all frames declared after this command. The brace-enclosed block may contain these instructions:

:: pal <palnum>

:: Specifies which palette this skin maps to.

:: surface <surfnum>

:: Specifies which MD3 surface this skin should be applied to. This has no significance for MD2 models.

:: file <filename>

:: Specifies the texture file to use for the skin. File may be any PNG, JPG, DDS, TGA, BMP, GIF or PCX file

:: IMPORTANT: If your model exists in a subdirectory (ie. the model filename includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

: anim { ... }

: Defines an animation from a group of frames in the model. The brace-enclosed block may contain these instructions:

:: frame0 <framename> 
:: frame1 <framename>

:: Specifies the names of the start (frame0) and end (frame1) frames of the animation.

:: fps <fps>

:: Specifies the frame rate at which the animation should play. This value may be fractional.

:: flags <flags>

:: Specifies any special properties the animation should have, the values of which should be added together to combine multiple options.

:: Valid options are:
:: 0 none (looping animation) 
:: 1 one-shot (plays beginning to end once and stops on the last frame).

: frame { ... }

: Defines a range of ART-file tiles to correspond with the given frame/animation of the model. The brace-enclosed block may contain these instructions:

:: name <framename> 
:: frame <framename>

:: If <framename> is identical to the starting frame of an animation, the engine will play that animation, otherwise the replacement will be static. You can choose to use the frame or name versions of this instruction as both are identical.

:: tile <tilenum> 
:: tile0 <tilenum> 
:: tile1 <tilenum>

:: Use the tile instruction to specify an ART-file tile which this model should replace. Use the tile0 and tile1 instructions together to specify a range of ART-file tiles. If you use tile0, you must also have a tile1. You may not use the same instruction twice to specify multiple ranges.

:: smoothduration <value>

:: If smoothduration is non-zero switching from another animation to the one defined by that frame block will trigger an intermediary animation smoothing state of duration <value> seconds.

:: pal <value>

:: Makes the model definition exclusive for the this pal. This allow to assign different models for different pal.

: hud { ... }

: Defines a range of ART-file tiles to use with a heads-up-display. The brace-enclosed block may contain these instructions:

:: tile <tilenum> 
:: tile0 <tilenum> 
:: tile1 <tilenum>

:: tile0 and tile1 together specify a range of ART-file tiles which this model frame should replace when rendered as part of the HUD. You can specify individual tiles using a single tile command.

:: xadd <offset> 
:: yadd <offset> 
:: zadd <offset> 
:: angadd <offset>

:: Use these offsets to fine-tune the location of the model placement. xadd, yadd, and zadd are position offsets relative to the viewer's orienation. You can use floating point values with them. angadd is a Build angle offset. (512 90 degrees, 1024 180 degrees, etc...).

:: hide

:: Some weapons use multiple ART tiles for constructing the gun or animation. Use this option to hide parts that you don't need in your replacement.

:: nobob

:: By default, the HUD model offset is affected by the player bobbing offset when the player is walking. Use this option to disable that.

:: flipped

:: Use this option to apply the settings inside the hud block only if the object is normally rendered x-flipped (mirror image). Some weapons, such as the devastator, are rendered in 2 pieces, the left devastator is actually a mirror image of the right.

:: nodepth

:: Use this to render a HUD model without the use of the depth buffer. Normally, you should avoid this. The one exception where this is useful is for the spinning nuke menu icon because it should always be in front -- and it just happens to be convex, which is the one case that is safe with the depth buffer disabled.

: detail { ... }

: Defines a [[Detail_mapping|detail texture]] for the model. The brace-enclosed block may contain these instructions:

:: file <filename>

:: Specifies which detail texture file to use. File may be any PNG, JPG, DDS, TGA, BMP, GIF or PCX file. This instruction must be supplied.

:: scale <value>

:: <value> is a positive floating-point value that'll determine how much your detail map should repeat on your diffuse map (if you want your detail map to repeat five times, use a 1/5 scale : 0.2).

:: surface <surfnum>

:: Specifies which MD3 surface this detail texture should be applied to. This has no significance for MD2 models.

: glow { ... }

: Defines a [[Glow_mapping|glow map]] for the model. The brace-enclosed block may contain these instructions:

:: file <filename>

:: Specifies which glow map file to use. This instruction must be supplied.

:: surface <surfnum>

:: Specifies which MD3 surface this glow map should be applied to. This has no significance for MD2 models.

{{Def table2}}

===Audio===

=====music=====
{{Def table1}}
music { ... }

Example:
music { id "E1L1" file "stalker1.ogg" }
music { id "intro" file "grabbag.ogg" }
music { id "briefing" file "briefing.ogg" }
music { id "loading" file "menusng2.flac" }

: id <value>

: <value> is "intro", "briefing", "loading" or "E'''x'''L'''y'''" (where x is the episode and y is the level). 

: file <filename>

: Specifies which audio file to use. File types: MIDI, Ogg Vorbis, FLAC

{{Def table2}}

=====sound=====
{{Def table1}}
sound { ... }

Example:
sound { id "249" file "bonus.ogg" }

: id <value>

: Specifies the ID of sound. The ID can be found in DEFS.CON. '''NOTE:''' This should only be used for HRP-like replacement of existing sounds. New sounds should use [[definesound]].

: file <filename>

: Specifies which audio file to use. File types: WAV, VOC, Ogg Vorbis, FLAC

: volume <volume>

: adjusts the volume of the sound, default is 1.0

{{Def table2}}

=====animsounds=====
{{Def table1}}
animsounds <anim> { frame1 sound1 frame2 sound2 ... }

'''<anim>''' has to be one of the following tokens corresponding to hard-coded Duke3D anims:
* cineov2: Episode 2 ending
* cineov3: Episode 3 ending
* RADLOGO: "Come back to bed, Duke..."
* DUKETEAM: Duke3D team still
* logo: Intro nuke logo
* vol41a: Episode 4 intro 1
* vol42a: Episode 4 intro 2
* vol43a: Episode 4 intro 3
* vol4e1: Episode 4 ending 1
* vol4e2: Episode 4 ending 2
* vol4e3: Episode 4 ending 3

The '''frame'''''N'''s (1-based frame numbers) have to be in ascending order. They do not need to be strictly ascending, so that a frame may have more than one sound.

Example: for Duke3D's XBLA nuke logo animation (IVF extracted from nuke.webm),
the following definition overlays the video with a sound sequence similar
(identical save for timing) to the original nuke animation:
// frame 1: FLY_BY, frame 64: PIPEBOMB_EXPLODE
animsounds logo { 1 244 64 14 }
{{Def table2}}

== Un-Definitions ==

The main use for these is for cases in which the .ART files are somewhat different, and you want to ensure compatibility for the new art without new textures or models. A good example of this is [http://hendricks266.duke4.net/nw_plus.php Duke: Nuclear Winter Plus] by [[Hendricks266]]. (see [http://svn.eduke32.com/nw_plus/nwinter/undef.def undef.def])

=====undeftexture=====
{{Def table1}}
undeftexture <tile> 
undeftexturerange <tile0> <tile1>

This is for undefining Hightile textures.

{{Def table2}}

=====undefmodel=====
{{Def table1}}
undefmodel <tile> 
undefmodelrange <tile0> <tile1> 
undefmodelof <tile>1

This is for undefining 3D models.

With undefmodelof all the tiles grouped together within the same .def code block are un-defined.

1Support of undefmodelof is disabled indefinitely due to problems with its implementation.

{{Def table2}}

== Misc ==

=====dummytile=====
{{Def table1}}

dummytile <tilenum> <x-dimension> <y-dimension> 
dummytilerange <tilenum1> <tilenum2> <x-dimension> <y-dimension>

Used in DEF files to create a blank tile at location <''tilenum''> of the dimensions <''x-dimension''> and <''y-dimension''>. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.

'''NOTE:''' In most circumstances '''setuptile''' is a better command to use, unless you specifically want black boxes.

{{Def table2}}

=====setuptile=====
{{Def table1}}

setuptile <tilenum> <x-dimension> <y-dimension> <x-offset> <y-offset> 
setuptilerange <tilenum1> <tilenum2> <x-dimension> <y-dimension> <x-offset> <y-offset>

Used in DEF files to setup the properties which are applied to the highres replacement of the tile. This allows the creation of placeholder tiles for use with definetexture\texture without having to edit .ART files.

Unlike dummytile this command won't draw black squares and accepts offsets.

It doesn't affect 8-bit tiles or HUD images.

{{Def table2}}

=====dummytilefrompic=====
{{Def table1}}

dummytilefrompic <tileID> <file>

{{Def table2}}

== Mapster32 ==

=====2dcol=====
{{Def table1}}

2dcol <colornum> <red> <green> <blue>

2dcol is a definition of a color to be used in the 2D mode of [[Mapster32]], in conjunction with spritecol that works similarly to tint and definetint. <colornum> is a unique identifier, similar to [[define|defines]] and [[gamevar|gamevars]]. <red>, <green>, and <blue> are the RGB color values that are mixed together to get your custom color.

Certain low values are already hard-coded, and redefining them will change colors of the default layout. If you know the correct value, you can replace the default colors used for all the sprites. You truly have the power to customize Mapster32. Lime green 2D mode background, anyone?

{{Def table2}}

=====spritecol=====
{{Def table1}}

spritecol <tilenum> <normalcolornum> <blockingcolornum>

spritecol is a definition of the color a sprite will appear in 2D mode, instead of the standard sky blue and hot pink, or another special color (like yellow for hard-coded enemies or white for the [[Special_Sprite_Reference_Guide|special sprites]]). <''normalcolornum''> is the <''colornum''> of the 2dcol definition of your color for the standard sprite color as defined by <''tilenum''>. The same goes for <''blockingcolornum''>, except that this value is for when the sprite has the first bit of [[cstat]] set (1) (<code>[']+[B]</code> keys in [[Mapster32]]), which is the blocking flag.

{{Def table2}}

=====spritehotkey=====
{{Def table1}}

spritehotkey <key> <spriteID>

Pressing a key from 1 to 0 on the upper row before pressing S will make the inserted sprite's picnum change according to this definition.

{{Def table2}}

=====tilegroup=====
{{Def table1}}

tilegroup <groupname> { ... }

Defines group for the tile selector (press 'T'). Mapster32 loads TILES.CFG on startup.

: tile <tilenum> 
: tilerange <tilenum1> <tilenum2> 
: tiles { <tile1> <tile2> ... <tileN> }

: Adds tiles to the group. Names can be found in DEFS.CON.

: hotkey <value>

: Specifies the hotkey for the group.

: colors <value1> <value2>

: Colors are the colors for Blocking OFF and Blocking ON.

{{Def table2}}

=====alphabet=====
{{Def table1}}

alphabet { ... }

Defines alphabet for the input text feature (Ctrl+T). Mapster32 loads TILES.CFG on startup.

: map <value> <tile>

: mapa <string> <tile>

: maprange <value1> <value2> <tile>

: maprangea <char1> <char2> <tile>

: offset <value> <offset>

: offseta <string> <offset>

{{Def table2}}

== Deprecated Commands ==

=====definetexture=====
{{Def table1}}

definetexture <tile-number> <palette-number> <x-center> <y-center> <x-size> <y-size> <filename>

Defines a Hightile texture to replace an ART-file picture. <tile-number> may be an number, or a defined label. Use a value of 0 for <x-center> and <y-center> and a value of -1 for <x-size> and <y-size> for now until these values are actually used. <filename> may be any PNG, JPG, DDS, TGA, BMP, GIF, or PCX file.

{{Def table2}}

=====definetint=====
{{Def table1}}

definetint <palette-number> <red> <green> <blue> <flags>

Defines a Hightile texture tint to simulate palette effects normally used on ART-file tiles. <red>, <green>, and <blue> are numbers in the range 0 to 255 which specify the color the tint should look like. <flags> specifies any processing effects to use. Valid values are:

0 no effects 
1 convert to greyscale 
2 invert colours 

These values can be added together to produce a combination of effects.

{{Def table2}}

=====defineskybox=====
{{Def table1}}

defineskybox <tile-number> <palette-number> <reserved> <front-face-filename> <right-face-filename> <back-face-filename> <left-face-filename> <top-face-filename> <bottom-face-filename>

Defines a sky-box composed of six images mapped onto the faces
of a cube to be used when <tile-number> is set as parallaxing in 32-bit OpenGL mode. <reserved> should be 0 for now until its meaning is fully conceived.

{{Def table2}}

=====definemodel=====
{{Def table1}}

definemodel <filename> <scale> <shade-offset>

Defines an MD2/3-format model file to replace certain sprites in the game. See definemodelframe and definemodelanim for details on how to specify the ART-file tiles to replace. <filename> is the name of the MD2/3 model. <scale> is a (possibly fractional) value specifying a scaling factor for the model when it is rendered, eg. 1.5 for one-and-a-half times as big. <shade-offset> is an integer value specifying how much to bias the sprite's shade value by. A negative value for this makes the model brighter. Conversely, a positive value makes it darker.

: definemodelskin <palette-number> <filename>

: Defines a skin to be used on the model for all frames declared after this command, when the sprite palette is equal to <palette-number>. (This makes more sense when given a demonstration.) IMPORTANT: If your model exists in a subdirectory (ie. definemodel includes a path to the .md2/3) you will need to give the same path to filename if the skin is in the same directory.

: selectmodelskin <skin ID>

: Selects a model skin.

: definemodelanim <start-frame> <end-frame> <frame-rate> <flags>

: Defines an animation from a group of frames in the model given by the last preceding definemodel instruction. <start-frame> and <end-frame> specify the names of the starting and ending frames of the animation. <frame-rate> is the frame rate at which the animation should play. This value can be fractional. <flags> specifies any special properties the animation should have. Valid options are:

: 0 none (looping animation) 
: 1 one-shot (plays beginning to end once and stops on the last frame)

: definemodelframe <frame-name> <first-tile> <last-tile>

: Defines a range of ART-file tiles to correspond with the given frame of the model specified in the last preceding definemodel instruction. <frame-name> is the name of the frame, which if identical to the starting frame of a definemodelanim animation will play that animation. If <frame-name> is not corresponding with an animation, the replacement will be static. <first-tile> and <last-tile> specify a range of ART-file tiles which this model frame should replace.

{{Def table2}}

=====definevoxel=====
{{Def table1}}

definevoxel <filename> 
definevoxeltiles <first-tile> <last-tile>

Defines a voxel to replace sprites in the game. <filename> is the name of the .KVX file containing the voxel.

definevoxeltiles defines the range of ART-file tiles to replace with the voxel.

{{Def table2}}

=====alphahack=====
{{Def table1}}

alphahack <tilenum> <value> 
alphahackrange <tilenum1> <tilenum2> <value> 

alphahack is a deprecated command previously used to improve alpha filtering of highres art of <tilenum>. <value> is always -1.

{{Def table2}}

Htflags

2019-08-02T12:15:01Z

Jblade: Saw this added in r7489 by Fox but not sure what the value is, or more detailed information

A per-actor property, this controls special flags for sprites.
{| {{prettytable}}
!Internal Name!!Provided CON Label!!Value!!Description
|-
|SFLAG_SHADOW||SFLAG_SHADOW||1||Generates a shadow. See [[spriteshadow]].
|-
|SFLAG_NVG||SFLAG_NVG||2||Turns [[spritepal|palette]] 6 whenever night vision goggles are used. See [[spritenvg]].
|-
|SFLAG_NOSHADE||SFLAG_NOSHADE||4||The sprite's shade is unaffected by the shade of its sector. See [[spritenoshade]].
|-
|SFLAG_PROJECTILE||||8||Has been defined with [[defineprojectile]].
|-
|SFLAG_DECAL||||16||Prevents teleporting. The sprite is not entered into the [[decal deletion queue]].
|-
|SFLAG_BADGUY||SFLAG_BADGUY||32||Is an enemy. See [[useractor]].
|-
|SFLAG_NOPAL||SFLAG_NOPAL||64||Sprite will be insusceptible to floor palette of sector containing this sprite. See [[spritenopal]].
|-
|SFLAG_NOEVENTCODE||SFLAG_NOEVENTS||128||Sprite will not be run through [[EVENT_GAME]] or [[EVENT_PREGAME]].
|-
|SFLAG_NOLIGHT||SFLAG_NOLIGHT||256||Sprite will not emit hardcoded Polymer-based lights.
|-
|SFLAG_USEACTIVATOR||SFLAG_USEACTIVATOR||512||
|-
|SFLAG_NULL||||1024||null sprite in multiplayer [internal, do not use]
|-
|SFLAG_NOCLIP||SFLAG_NOCLIP||2048||Sprite will call "[[clipmove]]()" with a [[clipmask]] of 0, skipping collision detection with other sprites to increase performance. (Specifically, to prevent runtime behavior that is quadratic with the number of sprites.) Useful for particle effects.
|-
|SFLAG_NOFLOORSHADOW||||4096||
|-
|SFLAG_SMOOTHMOVE||SFLAG_SMOOTHMOVE||8192||
|-
|SFLAG_NOTELEPORT||SFLAG_NOTELEPORT||16384||
|-
|SFLAG_BADGUYSTAYPUT||||32768||Actor will stay inside its original sector.
|-
|SFLAG_CACHE||||65536||
|-
|SFLAG_ROTFIXED||||131072||rotation-fixed with respect to a pivot point to prevent position diverging due to roundoff error accumulation
|-
|SFLAG_HARDCODED_BADGUY||||262144
|-
|SFLAG_DIDNOSE7WATER||||524288||used temporarily
|-
|SFLAG_NODAMAGEPUSH||SFLAG_NODAMAGEPUSH||1048576||Actor should not be pushed back when damaged (by default TANK, RECON, ROTATEGUN, and the bosses)
|-
|SFLAG_NOWATERDIP||SFLAG_NOWATERDIP||2097152||Actor will not appear to sink into the floor in sectors tagged Above Water (lotag 1)
|-
|SFLAG_HURTSPAWNBLOOD||||4194304||Actor will spawn blood as hardcoded enemies do when hurt
|-
|SFLAG_GREENSLIMEFOOD||||8388608||Actor can be eaten by GREENSLIME actor (Protozoid Slimer). Can only be set outside of actor and event code whereupon it is applied to all sprites of the same picnum e.g. "spriteflags NEWBEASTHANG 8388608" will make all NEWBEASTHANG in the entire game into greenslime fodder.
|-
|SFLAG_REALCLIPDIST||SFLAG_REALCLIPDIST||16777216||Actor will always use its set clipdist instead of one potentially overridden in hardcoded circumstances based on its xrepeat and picnum
|-
|SFLAG_WAKEUPBADGUYS||||33554432||When awoken (changed to an active actor), any sprite with this flag set will wake up any enemy with which it has a line of sight
|-
|SFLAG_DAMAGEEVENT||||67108864||Actor fires EVENT_(POST)DAMAGESPRITE when damaged.
|-
|SFLAG_NOWATERSECTOR||SFLAG_NOWATERSECTOR||?||Will prevent a sprite from moving into water
|}

'''htflags''' is a [[bitfield]], so add together the values you want and then set htflags to the sum. 
This member can also be set using the per-sprite form of the [[spriteflags]] command.

[[Category:Bitfields]]
[[Category:Sprite manipulation]]

Extbits

2019-08-01T09:28:54Z

Jblade: not sure what the internal name is, but I've tested and found that 64 is set when the new alt fire key is pressed

The extbits member of the input structure is a [[bitfield]], like [[bits]]. The following defines show what these bits indicate:

// extbits
define INPUT_MOVE_FORWARD 1
define INPUT_MOVE_BACKWARD 2
define INPUT_STRAFE_LEFT 4
define INPUT_STRAFE_RIGHT 8
define INPUT_TURN_LEFT 16
define INPUT_TURN_RIGHT 32
define INPUT_ALT_FIRE 64

[[Category:Bitfields]]
[[Category:Input structure members]]

EDuke32 Modifications

2019-06-12T19:19:54Z

Jblade:

Disclaimer: This list of mods and TCs is by no means exhaustive. There are many more great user made addons to try out on the internet, what is shown in this list comprises solely of content that the respective mod makers themselves have put up.
What is shown here isn't necessarily the best (although some of it is, and all of it is high quality), it's just that the people who made them actually bothered to make an entry here.

==Large Projects==

{{Mod_header}}

{{Mod_table
|[http://www.moddb.com/games/the-amc-tc AMC TC]
|Total Conversion
|Released, in development (Latest Release: '''3.00''')
|James Stanfield, Micky C and AMC
|[[Image:AMCTC3.jpg|200px]][[Image:AMCTC2.jpg|200px]]
|The AMC TC is a multi-character TC and gameplay modification. There are 10 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. Episode 1, 2 and 3 have been released.
}}

{{Mod_table
| [http://www.moddb.com/games/wgrealms-2 WGRealms 2: Siege Breaker]
|Total Conversion
|Released, in development (Latest Release: '''1.201''')
|William Gee, [[User:DeeperThought|DeeperThought]], Cage, Hellbound
|[[Image:WG1.jpg|200px]][[Image:WG2.jpg|200px]]
|Medieval mod with melee combat, magic bows, skeleton knights, dragons and demons. [http://www.moddb.com/games/wgrealms-2/images Gameplay footage]
}}

{{Mod_table
|[http://naferia.duke4.net Naferia's Reign: Invasion of the Dark Mistress]
|Total Conversion
|Released, in development (Latest Version: '''5.22.12242012''')
|[[User:LordMisfit|Lord Misfit]], TheSeriousCacodemon, Ryan Cordell, Davidos, Vero-chan, Kyle873
|[[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://m210.duke4.net/index.php/files/viewdownload/3-eduke32/38-blood-crossmatching Blood Crossmatching (BloodCM)]
|Total Conversion
|Released, in development (Latest Release: 06.2013)
|[[User:M210|M210]], fgsfds
|[[Image:Blood1.jpg|200px]][[Image:Blood2.jpg|200px]]
|BloodCM 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, Fox, Sanek, LipSheZ, Possessed-by-zeal. 
'''Official site:''' http://m210.duke4.net
}}

{{Mod_footer}}

==Medium Projects==

{{Mod_header}}

{{Mod_table
| [{{3DR}}32161 HellDuke TC!]
|Total Conversion
|Released, in development (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://www.moddb.com/games/duke-theft-auto Duke Theft Auto]
|Total Conversion
|Released 1.0
|[[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!
 [http://www.moddb.com/games/duke-theft-auto Duke Theft Auto on ModDB]
}}

{{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_footer}}

==Small Projects==

{{Mod_header}}

{{Mod_table
| [http://forums.duke4.net/topic/4857-top-shooter/ Top Shooter]
|Total Conversion
|Released, in development (Latest Release: '''1.1''')
|[[User:Mblackwell|Mblackwell]]
|[[Image:Duke0009.jpg|200px]][[Image:Duke0021.jpg|200px]]
|Top Shooter is an old school top-down scrolling shooter! A fully stand-alone modification, players dodge falling Space Mines and compete for high scores. Will ''you'' be the top shooter?
}}

{{Mod_table
|[http://www.moddb.com/mods/9541/duke-nukem-weapon-of-mass-destruction Duke Nukem: Weapon of Mass Destruction]
|Gameplay enhancement
|Released (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
|[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_footer}}

Definegamefuncname

2019-06-05T08:36:54Z

Jblade:

'''definegamefuncname''' <function> <name>

This command, similar to [[definequote]], allows the CON coder to rename the various game input functions. Note that the name of the function should contain underscores _ instead of spaces. Functions are in the same order as they appear in the key configuration menu. Thus, function 0 is Move Forward, and function 52 is Show Console.

Defaults:
<funct> <name>
0 Move Forward
1 Move Backward
2 Turn Left
3 Turn Right
4 Strafe
5 Fire
6 Open
7 Run
8 AutoRun
9 Jump
10 Crouch
11 Look Up
12 Look Down
13 Look Left
14 Look Right
15 Strafe Left
16 Strafe Right
17 Aim Up
18 Aim Down
19 Weapon 1
20 Weapon 2
21 Weapon 3
22 Weapon 4
23 Weapon 5
24 Weapon 6
25 Weapon 7
26 Weapon 8
27 Weapon 9
28 Weapon 10
29 Inventory
30 Inventory Left
31 Inventory Right
32 Holo Duke
33 Jetpack
34 NightVision
35 MedKit
36 TurnAround
37 SendMessage
38 Map
39 Shrink Screen
40 Enlarge Screen
41 Center View
42 Holster Weapon
43 Show Opponents Weapon
44 Map Follow Mode
45 See Coop View
46 Mouse Aiming
47 Toggle Crosshair
48 Steroids
49 Quick Kick
50 Next Weapon
51 Previous Weapon
52 Show Console
53 Show Dukematch Scores
54 DPAD Select
55 DPAD Aiming
56 Alternate Weapon
57 Last Used Weapon

Example:

definegamefuncname 11 Alt_Fire // changes the name of function 11 from "Look Up" to "Alt Fire"

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

EVENT SKIPCUTSCENE

2019-01-29T15:21:10Z

Jblade: Created page with "EVENT_SKIPCUTSCENE is a Misc Event. Used with startcutscene. RETURN is set to 1 when any key is pressed, and is used to control when a cutscene end..."

EVENT_SKIPCUTSCENE is a [[EDuke32 event list|Misc Event]].

Used with [[startcutscene]]. RETURN is set to 1 when any key is pressed, and is used to control when a cutscene ends.

[[Category:Events]]

EVENT CONTINUELEVELMUSICSLOT

2019-01-29T15:18:32Z

Jblade: Created page with "EVENT_CONTINUELEVELMUSICSLOT is a Misc Event. Called when the current track is continued after loading a save The requested track is passed into PLAYL..."

EVENT_CONTINUELEVELMUSICSLOT is a [[EDuke32 event list|Misc Event]].

Called when the current track is continued after loading a save

The requested track is passed into PLAYLEVELMUSICSLOT via ud.m_volume_number and ud.m_level_number.

[[Category:Events]]

EVENT PLAYLEVELMUSICSLOT

2019-01-29T15:17:45Z

Jblade: Created page with "EVENT_PLAYLEVELMUSICSLOT is a Misc Event. Called when a music track will be started from the beginning. The requested track is passed into PLAYLEVELMU..."

EVENT_PLAYLEVELMUSICSLOT is a [[EDuke32 event list|Misc Event]].

Called when a music track will be started from the beginning.

The requested track is passed into PLAYLEVELMUSICSLOT via ud.m_volume_number and ud.m_level_number.

[[Category:Events]]

EVENT NEWGAMESCREEN

2019-01-29T15:16:16Z

Jblade:

EVENT_NEWGAMESCREEN is a [[EDuke32 event list|Misc Event]].

Triggered when a new game is started. Set RETURN to -1 to disable The Birth intro animation.

[[Category:Events]]

EVENT MAINMENUSCREEN

2019-01-29T15:16:06Z

Jblade:

EVENT_MAINMENUSCREEN is a [[EDuke32 event list|Misc Event]].

Triggered before the main menu is displayed. Set RETURN to -1 to disable the screens that appear before the main menu.

[[Category:Events]]

EVENT EXITPROGRAMSCREEN

2019-01-29T15:15:54Z

Jblade:

EVENT_EXITPROGRAMSCREEN is a [[EDuke32 event list|Misc Event]].

Triggered when the program is closed. Set RETURN to -1 to disable the shareware or TEN screens, if they were enabled in LOGO_FLAGS.

[[Category:Events]]

EVENT EXITGAMESCREEN

2019-01-29T15:15:41Z

Jblade:

EVENT_EXITGAMESCREEN is a [[EDuke32 event list|Misc Event]].

Triggered when a running game is ended. Set RETURN to -1 to disable the deathmatch score screen when you quit mid-game.

[[Category:Events]]

EVENT ENDLEVELSCREEN

2019-01-29T15:15:29Z

Jblade:

EVENT_ENDLEVELSCREEN is a [[EDuke32 event list|Misc Event]].

Triggered when a level ends. Set RETURN to -1 to disable the bonus and deathmatch score screens after a level ends.

[[Category:Events]]

EVENT EXITPROGRAMSCREEN

2019-01-29T15:14:18Z

Jblade: Created page with "EVENT_EXITPROGRAMSCREEN is a Game Event. Triggered when the program is closed. Set RETURN to -1 to disable the shareware or TEN screens, if they were e..."

EVENT_EXITPROGRAMSCREEN is a [[EDuke32 event list|Game Event]].

Triggered when the program is closed. Set RETURN to -1 to disable the shareware or TEN screens, if they were enabled in LOGO_FLAGS.

[[Category:Events]]

EVENT EXITGAMESCREEN

2019-01-29T15:13:36Z

Jblade: Created page with "EVENT_EXITGAMESCREEN is a Game Event. Triggered when a running game is ended. Set RETURN to -1 to disable the deathmatch score screen when you quit mid..."

EVENT_EXITGAMESCREEN is a [[EDuke32 event list|Game Event]].

Triggered when a running game is ended. Set RETURN to -1 to disable the deathmatch score screen when you quit mid-game.

[[Category:Events]]

EVENT ENDLEVELSCREEN

2019-01-29T15:12:37Z

Jblade: Created page with "EVENT_ENDLEVELSCREEN is a Game Event. Triggered when a level ends. Set RETURN to -1 to disable the bonus and deathmatch score screens after a level end..."

EVENT_ENDLEVELSCREEN is a [[EDuke32 event list|Game Event]].

Triggered when a level ends. Set RETURN to -1 to disable the bonus and deathmatch score screens after a level ends.

[[Category:Events]]

EVENT MAINMENUSCREEN

2019-01-29T15:12:02Z

Jblade: Created page with "EVENT_MAINMENUSCREEN is a Game Event. Triggered before the main menu is displayed. Set RETURN to -1 to disable the screens that appear before the main..."

EVENT_MAINMENUSCREEN is a [[EDuke32 event list|Game Event]].

Triggered before the main menu is displayed. Set RETURN to -1 to disable the screens that appear before the main menu.

[[Category:Events]]

EVENT NEWGAMESCREEN

2019-01-29T15:11:16Z

Jblade: Created page with "EVENT_NEWGAMESCREEN is a Game Event. Triggered when a new game is started. Set RETURN to -1 to disable The Birth intro animation. Category:Events"

EVENT_NEWGAMESCREEN is a [[EDuke32 event list|Game Event]].

Triggered when a new game is started. Set RETURN to -1 to disable The Birth intro animation.

[[Category:Events]]

Members of the sector structure

2019-01-20T07:05:54Z

Jblade:

*[[wallptr]]
*[[wallnum]]
*[[ceilingz]]
*[[floorz]]
*[[ceilingstat]]
*[[floorstat]]
*[[ceilingpicnum]]
*[[ceilingslope]]
*[[ceilingshade]]
*[[ceilingpal]]
*[[ceilingxpanning]]
*[[ceilingypanning]]
*[[ceilingzgoal]]
*[[floorpicnum]]
*[[floorslope]]
*[[floorshade]]
*[[floorpal]]
*[[floorxpanning]]
*[[floorypanning]]
*[[floorzgoal]]
*[[visibility]]
*[[fogpal]]
*[[lotag]]
*[[hitag]]
*[[extra]]
*[[ceilingbunch]]
*[[floorbunch]]

[[Category:Structure access]]
[[Category:Sector manipulation]]
__NOTOC__

Definesound

2019-01-19T08:11:18Z

Jblade:

'''definesound''' <value> <filename> <pitch1> <pitch2> <priority> <type> <volume>

The definesound command defines a sound and assigns various properties to it. The maximum number of sounds that can be defined is 4096 for EDuke32, and 450 for Duke v1.5. Sound defines over 1000 won't work with the MUSICANDSOUNDFX sprite, so bear that in mind if you're working on a mod with many custom sound files.
*<value>: This can be either the sound's number or the name that has been [[define]]d for that number.
*<filename>: The name of the sound file. Sound files are assumed to be in the same directory as the program unless a folder path is specified. Assume that the user's OS is case sensitive, and directory delimiters are forward slashes (<code>/</code>) rather than backslashes (<code>\</code>).
*<pitch1> and <pitch2>: These are a random pitch variation range. Values may be positive or negative. For example, if you want you sound to have a chance of both moderate increase and decrease in pitch, you would use values such as <code>-512 512</code>.
*<priority>: A value of 0 to 255 indicates the priority the sound has over other sounds that are playing simultaneously. The higher the value, the greater its priority. This is due to the limit on the number of sounds that can play at once. Take a look at the original USER.CON to see what kinds of sounds get what kinds of priority. For example, most Duke remarks are maxed out at 255.
*<type>: This flag is a [[bitfield]] which indicates what type of sound you are defining.
:Bit #0 ('''1'''): The sound repeats if continually played.
:Bit #1 ('''2'''): The sound is an ambient effect. Disabling ambience in the menu will mute this sound.
::Bit #0 + Bit #1 ('''3'''): The sound will loop until instructed to stop.
:Bit #2 ('''4'''): The sound is a player voice. Disabling "Duke Talk" in the menu will mute this sound.
:Bit #3 ('''8'''): The sound contains offensive content. Disabling "Adult Mode" or enabling the parental lock in the menu will mute this sound.
:Bit #4 ('''16'''): The sound will always be heard from anywhere in the level. (See [[globalsound]].) (sndist = 0)
:Bit #7 ('''128'''): The sound is used in Duke-Tag.
*<volume>: Negative values increase volume; positive ones soften it. Can range from -32768 to 32767. Note that this value does not actually affect the sound's volume, but rather it modifies the distance registered between it and any listening players. As such, this has no effect on global sounds or sounds made by the player.

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

EVENT SOUND

2018-07-26T04:53:11Z

Jblade:

EVENT_SOUND is a [[EDuke32 event list|Game Event]].

This [[event]] is triggered upon playback of any sound, and allows hard coded sounds to be altered in a context-aware fashion. The [[RETURN]] variable is set to the sound effect number of the sound that is being played. Set [[RETURN]] to the sound you want to be played instead, or set it to -1 to cancel playback. THISACTOR is set to the id of the actor playing the sound ('globalsound' and 'screensound' sounds will default to the player)

[[Category:Events]]

Undefinecheat

2018-03-05T20:16:10Z

Jblade: Created page with "'''undefinecheat''' <cheat number> Can be used to disable a cheat code. See definecheat for a list of cheats and their codes. Category:EDuke32 specific commands ..."

'''undefinecheat''' <cheat number>

Can be used to disable a cheat code.

See [[definecheat]] for a list of cheats and their codes.

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

Menubackground

2018-03-05T08:25:01Z

Jblade: Created page with "Set to 0 to disable the black transparent mask behind the in-game menu. Category:Userdef structure members"

Set to 0 to disable the black transparent mask behind the in-game menu.

[[Category:Userdef structure members]]

LOGO FLAGS

2018-03-05T07:26:55Z

Jblade:

LOGO_FLAGS is a [[gamevar]] that controls the appearance of the introduction and menu.

It is a [[bitfield]]. The default value is 255. That is, all the bits below 256 are set. The values are:

'''1''' - LOGO_ENABLED 
'''2''' - LOGO_PLAYANIM 
'''4''' - LOGO_PLAYMUSIC 
'''8''' - LOGO_3DRSCREEN 
'''16''' - LOGO_TITLESCREEN 
'''32''' - LOGO_DUKENUKEM 
'''64''' - LOGO_THREEDEE 
'''128''' - LOGO_PLUTOPAKSPRITE 
'''256''' - LOGO_SHAREWARESCREENS 
'''512''' - LOGO_TENSCREEN 
'''1024''' - LOGO_STOPANIMSOUNDS 
'''2048''' - LOGO_NOE4CUTSCENE 
'''4096''' - LOGO_NOE1BONUSSCENE 
'''8192''' - LOGO_NOE2BONUSSCENE 
'''16384''' - LOGO_NOE3BONUSSCENE 
'''32768''' - LOGO_NOE4BONUSSCENE 
'''65536''' - LOGO_NOE1ENDSCREEN 
'''131072''' - LOGO_NOE2ENDSCREEN 
'''262144''' - LOGO_NOE3RADLOGO 
'''524288''' - LOGO_NODUKETEAMTEXT 
'''1048576''' - LOGO_NODUKETEAMPIC 
'''2097152''' - LOGO_STOPMISCSOUNDS 
'''4194304''' - LOGO_NOGAMETITLE 
'''8388608''' - LOGO_NOTITLEBAR 
'''33554432''' - LOGO_NOHELP 
'''67108864''' - LOGO_NOCREDITS

(The names following the numeric values are merely informational, they do not denote labels predefined from CON.)

[[Category:Bitfields]]
[[Category:Pre-defined gamevars]]

Clamp

2018-03-05T06:57:28Z

Jblade: Created page with "'''clamp''' <gamevar> <min> <max> Will lock <gamevar> to the minimum/maximum values set if it tries to exceed them. Category:EDuke commands Category:Gamevar ma..."

'''clamp''' <[[gamevar]]> <min> <max>

Will lock <[[gamevar]]> to the minimum/maximum values set if it tries to exceed them.

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

Startscreen

2018-01-30T10:35:56Z

Jblade:

Use '''startscreen''' to take control away from the game and display content with rotatesprite. Paired with [[EVENT_SCREEN]].

RETURN is set to 1 when any key is pressed, and if it is nonzero when the event ends, the screen ends and the game resumes.

[[Category:EDuke32 specific commands]]