EDukeWiki - User contributions [en]

Lineintersect

2020-08-10T07:03:51Z

Rob Anybody: second triplet is a point, not a vector

'''lineintersect''' <ox> <oy> <oz> <dx> <dy> <dz> <x1> <y1> <x2> <y2> <intx> <inty> <intz> <ret>

Determines where a line defined by origin point <ox> <oy> <oz>
and destination point <dx> <dy> <dz>
intersects the vertical plane defined by the points <x1> <y1> and <x2> <y2>.

The point of intersection, if any, is returned as <intx> <inty> <intz>,
with <ret> holding a value of 1 if an intersection exists and 0 otherwise.

Lineintersect

2020-08-10T06:37:07Z

Rob Anybody: Created page with "'''lineintersect''' <x> <y> <z> <vx> <vy> <vz> <x1> <y1> <x2> <y2> <intx> <inty> <intz> <ret> Projects a line from point <x> <y> <z> along vector <vx> <vy> <vz>, and dete..."

'''lineintersect''' <x> <y> <z> <vx> <vy> <vz> <x1> <y1> <x2> <y2> <intx> <inty> <intz> <ret>

Projects a line from point <x> <y> <z> along vector <vx> <vy> <vz>,
and determines where it intersects the vertical plane
defined by the points <x1> <y1> and <x2> <y2>.

The point of intersection, if any, is returned as <intx> <inty> <intz>,
with <ret> holding a value of 1 if an intersection exists and 0 otherwise.

Rayintersect

2020-08-10T06:36:25Z

Rob Anybody: Created page with "'''rayintersect''' <x> <y> <z> <vx> <vy> <vz> <x1> <y1> <x2> <y2> <intx> <inty> <intz> <ret> Projects a ray from point <x> <y> <z> along vector <vx> <vy> <vz>, and determ..."

'''rayintersect''' <x> <y> <z> <vx> <vy> <vz> <x1> <y1> <x2> <y2> <intx> <inty> <intz> <ret>

Projects a ray from point <x> <y> <z> along vector <vx> <vy> <vz>,
and determines where it intersects the vertical plane
defined by the points <x1> <y1> and <x2> <y2>.

The point of intersection, if any, is returned as <intx> <inty> <intz>,
with <ret> holding a value of 1 if an intersection exists and 0 otherwise.

EVENT MOVESECTOR

2020-08-07T21:17:33Z

Rob Anybody: clarify what "move" means in this context

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

This [[event]] is triggered when a sector is moved.
This applies to motion on the X and Y axes, like doors,
but not motion along Z, like elevators.

[[THISACTOR]] is the actor that is moving the sector.

M32 script commands

2020-08-06T00:38:19Z

Rob Anybody: /* quote commands */ add drawlabel

{{Build Intro}}
{{M32Script Intro}}
----

This is a categorized list of every command in Mapster32-script.

'''Legend''': 
'''I''': acts on current sprite, '''S''': acts on current sprite by pointer (also valid in "for i drawnsprites") 
'''i''': sets current sprite, '''s''': only sets current sprite by pointer 
'''D''': differs from CON, '''X''': deprecated/do not use (yet) 
'''''var/array/special''''': must be writable, [''something'']: optional command field

''A note on the current sprite'': when the current sprite index ''I'' is set (that is, greater or equal zero), all functions that act on sprites by pointer ('''S''') are also available since the sprite pointer is set to point to the ''sprite[]'' array at index ''I'' in this case. The converse is not true, however: the sprite pointer could be set to a sprite structure other than the main ''sprite[]'' array (such as the ''tsprite[]'' array of sprites drawn on the screen), so code in a scope where the sprite pointer has been set ('''s''') cannot use functions accessing the ''sprite[]'' array ('''I''').

====basic commands====
*[[Nullop]]
*[[Define]]
*[[Include]]
*[[Defstate]] | (only for defining)
*[[Ends]]
*[[State]] | '''D''' (only for calling)
*[[Onevent]]
*[[Endevent]]
*[[Gamevar]] | '''D''' (different flags)

====control flow====
*[[Else]]
*[[Return]] | '''D''' (returns from states)
*[[Break]] | '''D''' (also breaks '''for''' and '''while*''' loops)
*[[Switch]]
*[[Case]]
*[[Default]]
*[[Endswitch]]
*[[Getcurraddress]] | '''X'''
*[[Jump]] | '''X'''

====struct access (redundant)====
These are inaccessible in newer versions of Mapster32, use "'''set''' ''xyz'' ''zyx''" instead.

*Setsector
*Getsector
*Setwall
*Getwall
*Setsprite
*Getsprite
*Gettspr | '''X'''
*Settspr | '''X'''


====arrays====
*[[Gamearray]]
*[[Setarray]] | (redundant, use '''set''')
*[[Getarraysize]] ''array'' '''''size'''''
*[[Resizearray]] ''array'' ''newsize''
*[[Copy]] ''srcarray'' ''srcidx'' '''''dstarray''''' ''dstidx'' ''count''

====var commands====
*[[Randvar]]
*[[Displayrandvar]]
*[[Setvar]]
*[[Addvar]]
*[[Subvar]]
*[[Mulvar]]
*[[Divvar]]
*[[Modvar]]
*[[Andvar]]
*[[Orvar]]
*[[Xorvar]]
*[[Shiftvarl]] | (short: '''shiftl''')
*[[Shiftvarr]] | (short: '''shiftr''')

====varvar commands====
*[[Randvarvar]]
*[[Displayrandvarvar]] | (different from '''displayrand''')
*[[Setvarvar]]
*[[Addvarvar]]
*[[Subvarvar]]
*[[Mulvarvar]]
*[[Divvarvar]]
*[[Modvarvar]]
*[[Andvarvar]]
*[[Orvarvar]]
*[[Xorvarvar]]

====math commands====
The trigonometric commands interpret values outside the range [0, 2047] correctly as angles modulo 2048.
*[[Sin]] '''''resvar''''' ''var''
*[[Cos]] '''''resvar''''' ''var''
*[[Displayrand]] '''''resvar'''''
*[[Inv]] '''''var'''''
*[[Clamp]] '''''var''''' ''min'' ''max''
*[[Sqrt]] ''var'' '''''resvar'''''
*[[Mulscale]] '''''resvar''''' ''factor1'' ''factor2'' ''rshiftamount''
*[[Divscale]] '''''resvar''''' ''dividend'' ''divisor'' ''lshiftamount''
*[[Dist]] '''''res''''' ''sprite1'' ''sprite2''
*[[Ldist]] '''''res''''' ''sprite1'' ''sprite2''
*[[Getangle]] '''''res''''' ''x'' ''y''
*[[Getincangle]] '''''res''''' ''ang1'' ''ang2''
*[[A2xy]] ''angle'' '''''x''''' '''''y'''''
*[[Ah2xyz]] ''angle'' ''horiz'' '''''x''''' '''''y''''' '''''z'''''
*[[Calchypotenuse]] '''''hypot''''' ''x'' ''y''

====special commands====
*[[Sort]] '''''array''''' ''count'' [''comparison_state'']
*[[Collectsectors]] '''''array''''' ''count'' '''''numcollectedsectors''''' [''comparison_state'']
*[[For]] '''''itervar''''' ''what'' [''what2'']
valid iteration types (''what''): 
Note: where the current sprite is affected, it is restored at the end of the loop
*allsprites ('''i'''), allsectors, allwalls, selsprites ('''i'''), selsectors, selwalls, drawnsprites ('''s''', indexes tsprite[])
*spritesofsector ''sector'' ('''i'''), loopofwall ''wall'', wallsofsector ''sector'', range ''num''

=====examples=====
Using the '''for''' command you can create batch modifications in a few lines. (note: these examples don't claim to be useful)

*making liztroops really big
for i allsprites, ifactor LIZTROOP, sizeat 128 128

*translating the whole map by (x,y,z)
for i allsectors
{
add sector[i].ceilingz z, add sector[i].floorz z
for j wallsofsector i, { add wall[j].x x, add wall[j].y y }
for j spritesofsector i, { add .x x, add .y y, add .z z }
}

====var if* and while* commands====
*[[Ifvarl]]
*[[Ifvarle]]
*[[Ifvarg]]
*[[Ifvarge]]
*[[Ifvare]]
*[[Ifvarn]]
*[[Ifvarand]]
*[[Ifvaror]]
*[[Ifvarxor]]
*[[Ifvareither]]
*[[Ifvarboth]]
*[[Whilevarn]]
*[[Whilevarl]]

====varvar if* and while* commands====
*[[Ifvarvarl]]
*[[Ifvarvarle]]
*[[Ifvarvarg]]
*[[Ifvarvarge]]
*[[Ifvarvare]]
*[[Ifvarvarn]]
*[[Ifvarvarand]]
*[[Ifvarvaror]]
*[[Ifvarvarxor]]
*[[Ifvarvareither]]
*[[Ifvarvarboth]]
*[[Whilevarvarn]]
*[[Whilevarvarl]]

====other if* commands====
*[[Ifhitkey]] KEY_???
*[[Ifholdkey]] KEY_???
*[[Resetkey]] KEY_???
*[[Ifeitheralt]]
*[[Ifeitherctrl]]
*[[Ifeithershift]]
*[[Ifrnd]] ''number''
*[[Ifinside]] ''x'' ''y'' ''sectnum''
*[[Ifangdiffl]] ''angdiff'' | '''S'''
*[[Ifspritepal]] ''pal'' | '''S'''
*[[Ifactor]] ''picnum'' | '''S'''
*[[Ifpdistl]] ''dist'' | '''S''' (distance is that of "mapper arrow" to current sprite)
*[[Ifpdistg]] ''dist'' | '''S''' (distance is that of "mapper arrow" to current sprite)
*[[Ifawayfromwall]] | '''S'''
*[[Ifcansee]] | '''S''' (whether "mapper arrow" can see current sprite)
*[[Ifonwater]] | '''S'''
*[[Ifinwater]] | '''S'''
*[[Ifoutside]] | '''S'''
*[[Ifaimingsector]]
*[[Ifaimingwall]]
*[[Ifaimingsprite]]
*[[Ifin3dmode]]
*[[Ifinteractive]]

====BUILD functions====
*[[Insertsprite]] | '''X''' '''i''' '''s'''
*[[Dupsprite]] ''oldsprite'' | '''i''' '''s'''
*[[Tdupsprite]] ''sprite'' | '''s''' (copies ''sprite'' to tsprite[''spritesortcnt''] and increments ''spritesortcnt'')
*[[Deletesprite]] ''spritenum''
*[[Lastwall]] ''point'' '''''resultvar'''''
*[[Updatecursectnum]]
*[[Updatesector]] ''x'' ''y'' '''''var''''' | '''I'''
*[[Updatesectorz]] ''x'' ''y'' ''z'' '''''var''''' | '''I'''
*[[Getzrange]] ''sectnum'' '''''ceilzvar''''' '''''ceilhitvar''''' '''''florzvar''''' '''''florhitvar''''' ''walldist'' ''clipmask''
*[[Hitscan]] ''x'' ''y'' ''z'' ''sectnum'' ''vx'' ''vy'' ''vz'' '''''hitsectvar''''' '''''hitwallvar''''' '''''hitspritevar''''' '''''hitxvar''''' '''''hityvar''''' '''''hitzvar''''' ''cliptype''
*[[Cansee]] ''x1'' ''y1'' ''z1'' ''sect1'' ''x2'' ''y2'' ''z2'' ''sect2'' '''''rvar'''''
*[[Canseespr]] ''sprite1'' ''sprite2'' '''''result'''''
*[[Neartag]] ''x'' ''y'' ''z'' ''sectnum'' ''ang'' '''''neartagsectorvar''''' '''''neartagwallvar''''' '''''neartagspritevar''''' '''''neartaghitdistvar''''' ''neartagrange'' ''tagsearch''
*[[Rotatepoint]] ''xpivot'' ''ypivot'' ''x'' ''y'' ''daang'' '''''xres''''' '''''yres'''''
*[[Dragpoint]] ''wallnum'' ''newx'' ''newy''
*[[Getceilzofslope]] ''sectnum'' ''x'' ''y'' '''''resz'''''
*[[Getflorzofslope]] ''sectnum'' ''x'' ''y'' '''''resz'''''
*[[Alignceilslope]] ''sectnum'' ''x'' ''y'' ''z''
*[[Alignflorslope]] ''sectnum'' ''x'' ''y'' ''z''
*'''Bsetsprite''' ''spritenum'' ''x'' ''y'' ''z'' ([[Setsprite]] in CON)
*[[Setfirstwall]] ''sectnum'' ''wallnum''
*[[Changespritestat]] ''spritenum'' ''statnum''
*[[Changespritesect]] ''spritenum'' ''sectnum''
*[[Headspritestat]] | '''X'''
*[[Prevspritestat]] | '''X'''
*[[Nextspritestat]] | '''X'''
*[[Headspritesect]] | '''X'''
*[[Prevspritesect]] | '''X'''
*[[Nextspritesect]] | '''X'''
*[[Sectorofwall]] ''wallnum''
*[[Fixrepeats]] ''wallnum''
The following returns a (positive) game palette index "closest" to the RGB color passed.
*[[Getclosestcol]] ''r'' ''g'' ''b'' '''''var'''''

====debugging commands====
*[[Addlogvar]] ''var/array[]/special[].xxx'' (short form: '''al''')
*[[Addlog]]
*[[Debug]] ''CONSTANT''

====quote commands====
*[[Definequote]] ''quotenum'' [text...] | (initial definition of a quote)
*[[Redefinequote]] ''quotenum'' [text...] | (replacement occurs at runtime)
*[[Print]] ''quotenum'' | (prints to the OSD)
*[[Quote]] ''quotenum''
*[[Error]] ''quotenum''
*[[Printmessage16]] ''quotenum'' | 2D mode only
*[[Printmessage256]] ''quotenum'' ''x'' ''y'' | 3D mode only
*[[Printext256]] ''quotenum'' ''x'' ''y'' ''color'' ''backcolor'' ''fontsize'' | 3D mode only, -''color'' is looked up in ''editorcolors'' if ''color'' is negative
*[[Printext16]] ''quotenum'' ''x'' ''y'' ''color'' ''backcolor'' ''fontsize'' | 2D mode only, color is looked up in ''editorcolors''
*[[Drawlabel]] ''quotenum'' ''x'' ''y'' ''color'' ''backcolor'' ''fontsize'' | Draws a small label. 2D mode only; build units.

The following two commands query the user for a number from 0 to ''max'',
specifying a negative ''max'' argument will make the allowable number range be ''max'' to -''max'': (deprecated)
*[[Getnumber16]] '''''var''''' ''quotenum'' ''max'' | '''X'''
*[[Getnumber256]] '''''var''''' ''quotenum'' ''max'' | '''X'''
*[[Getnumberfromuser]] '''''var''''' ''quotenum'' ''max'' ''flags''
Valid ''flags'' are:

: 1: sign (allow values from -''max'' to ''max'') 
: 2: autocomplete names 
: 4: autocomplete taglabels 
: 8: return -1 if cancelled. Otherwise, the initial value is returned, which is the one passed in '''''var'''''.
*[[Qsprintf]] '''''destquote''''' ''srcquote'' [up to 32 arguments...]
*[[Qstrcat]] '''''destquote''''' ''srcquote''
*[[Qstrcpy]] '''''destquote''''' ''srcquote''
*[[Qstrlen]] '''''resvar''''' ''quotenum''
*[[Qstrncat]] '''''destquote''''' ''srcquote'' ''count'' | '''X'''
*[[Qsubstr]] '''''dstquote''''' ''srcquote'' ''start'' ''length''

====findnear* (not tested)====
*[[Findnearsprite]] ''type'' ''maxdist'' '''''resvar''''' | '''I'''
*[[Findnearspritevar]] ''type'' ''maxdistvar'' '''''resvar''''' | '''I'''
*[[Findnearsprite3d]] ''type'' ''maxdist'' '''''resvar''''' | '''I'''
*[[Findnearsprite3dvar]] ''type'' ''maxdistvar'' '''''resvar''''' | '''I'''
*[[Findnearspritez]] ''type'' ''maxdist'' ''maxzdist'' '''''resvar''''' | '''I'''
*[[Findnearspritezvar]] ''type'' ''maxdist'' ''maxzdist'' '''''resvar''''' | '''I'''

====misc. commands====
*[[Getticks]] '''''var'''''
*[[Gettimedate]] (8 arguments...)
*[[Setaspect]] ''viewingrange'' ''yxaspect''
*[[Sethighlight]] ''what'' ''sprite_or_wall_num'' ''set?''
: If ''what'' has bit 16384 set, the lower 14 bits of ''sprite_or_wall_num'' are taken as sprite index, else wall index
*[[Sethighlightsector]] ''sectnum'' ''set?''

====current sprite commands====
*[[Seti]] ''spritenum'' | '''i''' '''s'''
*[[Sizeat]] ''xrepeat'' ''yrepeat'' | '''S'''
*[[Cstat]] ''cstat'' | '''S'''
*[[Cstator]] ''bitstoset'' | '''S'''
*[[Clipdist]] ''clipdist'' | '''S'''
*[[Spritepal]] ''palnum'' | '''S'''
*[[Cactor]] ''picnum'' | '''S'''
*[[Spgetlotag]] | '''S'''
*[[Spgethitag]] | '''S'''
*[[Sectgetlotag]] | '''S'''
*[[Sectgethitag]] | '''S'''
*[[Gettexturefloor]] | '''S'''
*[[Gettextureceiling]] | '''S'''

====drawing commands====
The suffixes 16 and 256 mean that the commands are to be used in 2D and 3D modes, respectively.
======used in EVENT_DRAW2DSCREEN======
*[[Drawline16]] ''x1'' ''y1'' ''x2'' ''y2'' ''color''
*[[Drawline16b]] ''x1'' ''y1'' ''x2'' ''y2'' ''color'' | (coordinates are in BUILD units)
*[[Drawline16z]] ''x1'' ''y1'' ''z1'' ''x2'' ''y2'' ''z2'' ''color'' | (coordinates are in BUILD units)
*[[Drawcircle16]] ''x'' ''y'' ''radius'' ''color''
*[[Drawcircle16b]] ''x'' ''y'' ''radius'' ''color'' | (coordinates are in BUILD units)
*[[Drawcircle16z]] ''x'' ''y'' ''z'' ''radius'' ''color'' | (coordinates are in BUILD units)
Specifying nonnegative values for the color will use the 16-color editor palette, whereas negative values -1 to -255 will use a palette of all colors available in 2D mode, where the palette is the base game palette.

======used elsewhere======
*[[Rotatesprite16]]
*[[Rotatesprite]]
*[[Setgamepalette]] ''gamepal''

====sound commands====
All sound commands accept vars. Sounds should appear from current sprite if set and globally otherwise (not tested).
*[[Ifsound]] ''sound#'' | '''I'''
*[[Ifnosounds]]
*[[Getsoundflags]] ''sound#'' '''''var'''''
*[[Sound]] ''sound#'' | '''I'''
*[[Soundonce]] ''sound#'' | '''I'''
*[[Stopsound]] ''sound#'' | '''I'''
*[[Globalsound]] ''sound#''
*[[Stopallsounds]]

[[Category:Level editing documentation]]

Quote

2020-08-05T17:32:00Z

Rob Anybody:

'''quote''' <quote number>

Causes the quote <quote number> as defined by [[definequote]] to be displayed on the top of the screen, center aligned. The quote fades out after two seconds. This command requires a context where the player is defined, e.g. it cannot be used in [[EVENT_LOADACTOR]].

Quotes also appear in the console and log file, but when the same quote is displayed multiple times in a row, only the first instance will appear in the console and log. This applies ''even if the quote has been redefined''. To log things for debugging or analysis, consider [[userquote]] instead.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Screen drawing commands]]
[[Category:String manipulation]]

Userquote

2020-08-05T17:27:44Z

Rob Anybody: specify log behavior

'''userquote''' <quote number>

Causes the quote <quote number> as defined by [[definequote]] to be added to the four line long text buffer that multiplayer kill/death messages and player talk is displayed in. The quotes scroll off of the screen at a rate of one every six seconds. Unlike [[quote]], every userquote appears in the console and log file.

[[Category:EDuke32 specific commands]]
[[Category:Screen drawing commands]]
[[Category:String manipulation]]

Actor

2020-08-04T21:37:50Z

Rob Anybody: Fix typo

'''actor''' <picnum> <strength> <action> <move> <moveflag 1> [...] <moveflag N>

'''useractor''' <type> <picnum> <strength> <action> <move> <moveflag 1> [...] <moveflag N>

Defines parameters for in-game sprites, and allows code to be written for sprites of the specific tile number.

The token '''enda''' marks the end of the actor.

'''actor''' MYACTOR
[...]
'''enda'''

'''useractor''' notenemy MYACTOR2
[...]
'''enda'''

Loosely speaking, "actors" are sprites that run code in game, such as enemies, breakable objects, etc.

When defined with '''actor''' or '''useractor''', the sprites will execute their code once every tic, except for dormant enemies. Actors or dormant actors will have a statnum of 1 and 2 respectively.

Prior to v1.4, only tile numbers hard-coded to execute script would work with the '''actor''' command. After v1.4 new actors could be defined, and the '''useractor''' command was added which allowed actors to be defined as specific types for hard-coded behavior.

With '''useractor''', the old '''actor''' command is deprecated.

Example:
define MYACTOR 3585

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

See also [[state]].

== Parameters ==

All parameters after <picnum> are optional.

{| {{prettytable}}
| <type> || is the actor type for special behavior. Only used by '''useractor'''.
|-
| <picnum> || 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.
|-
| <move> || is the initial [[move]] of the actor.
|-
| <moveflag> || is a sequence of parameters that specify certain hard-coded movement behavior.
|}

== Types ==

The type is technically a [[bitfield]], though "3" is invalid. It is generally either "enemy", "enemystayput", or "notenemy".

{| {{prettytable}}
!Value!!DEFS.CON label!![[gameflags]]!!Description
|-
|0||notenemy||(None)||Default. Code begins executing at the start of a level.
|-
|1||enemy||SFLAG_BADGUY||Enables hard-coded behavior. Code only begins executing upon player sight.
|-
|2||enemystayput||SFLAG_BADGUY SFLAG_BADGUYSTAYPUT||Same as "enemy" plus the [[actor]] will not leave the [[sector]] it is placed in.
|-
|4||(None)||SFLAG_ROTFIXED||The actor's position in rotating sectors is calculated without rounding errors.
|}

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

Action

2020-08-04T21:11:37Z

Rob Anybody: fix redundancy, add commented-out notes, fix spelling

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

An action is an animation for an [[actor]]. Actions are defined outside of an [[actor]].

<name> is the name of the action.

<startframe> is the starting frame number (relative to the main sprite of the [[actor]]).

<frames> is the total number of frames in the action. Must be at least 1.

<viewtype> is the number of sides drawn for the actor. Prior to 3D models, this method was used to simulate a 3D appearance for sprites. Valid values are:
:'''1''' - The sprite will appear the same regardless of the angle at which it is viewed.
:'''3''' - The sprite will have 16 angles built from only 4 art tiles. A new frame is drawn every 22.5 degrees in a clockwise pattern beginning with the front of the sprite. The pattern is as follows, with 1, 2, 3, and 4 being the order of the four tiles used, and M denoting that the tile is mirrored: 1M, 2M, 3M, 4M, 4, 3, 2, 1, 1M, 2M, 3M, 4M, 4, 3, 2, 1.
:'''5''' - The sprite will have 8 angles constructed from 5 art tiles, three of which are mirrored. A new frame is drawn every 45 degrees in a clockwise pattern beginning with the front of the sprite using the following pattern: 1, 2, 3, 4, 5, 4M, 3M, 2M.
:'''7''' - The sprite will have 12 angles constructed from 7 art tiles, five of which are mirrored. A new frame is drawn every 30 degrees in a clockwise pattern beginning with the front of the sprite using the following pattern: 1, 2, 3, 4, 5, 6, 7, 6M, 5M, 4M, 3M, 2M.
:'''8''' - The sprite will have 8 angles constructed from 8 art tiles. A new frame is drawn every 45 degrees in a clockwise pattern beginning with the front of the sprite using the simple pattern: 1, 2, 3, 4, 5, 6, 7, 8.

View type 1 is generally used for pickups and often things like fire hydrants. View type 3 is useful only for very symmetrical actors but does give the most angles. View types 5 and 7 are for enemies and similar which have a single axis of symmetry and where you want a front view such that when they face at you they actually look like they are facing at you. View type 8 is for stuff with little in the way of symmetry.

<incvalue> is the direction of the animation. 1 to advance forward, -1 to go back.

<delay> is the delay between frames.

The delay change every time you add a value of 4, in other words, 1-3 has the same result as zero, 5-7 same as 4, etc.

Also the delay is not proportional to the value, setting 16 doesn't mean double of speed than 8, the calculation is done with this: the speed of a delay 0 equal to a [[ifcount|tic]] counter; the speed of a delay 4 is 1/2 of it; 8 is 1/3; 12 is 1/4; 16 is 1/5; 20 is 1/6; etc.

To call an action from within an actor simply put:

action <name>

Note: Every frame advance adds 1 to [[actioncount]]. To reset an animation, either call the action again or use [[resetactioncount]]. Starting a new animation will also reset [[actioncount]] to 0.

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

Randvar

2020-08-02T21:10:57Z

Rob Anybody: clarify rand range

'''randvar''' <gamevar> <value> 
'''randvarvar''' <gamevar> <value>

This function generates a random number (using the shared "game" PRNG) from 0 to <value> (inclusive), and assigns it to <gamevar>.

This command should not be used in unsynchronized code or it will desynchronize multiplayer games. See the list of [[unsynchronized events]] for a full list.

In prior releases of DOS EDuke, randvar contained a flaw that would desynchronize multiplayer regardless of where the command was used. The bug has since been corrected for post-1.0 releases of EDuke32.

{{varsuffix}}

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

Checkavailinven

2020-07-31T01:00:30Z

Rob Anybody:

'''checkavailinven''' <playerID>

Checks for the first available inventory and selects it.
Also removes empty items from inventory.

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

Packaging mods

2020-07-30T16:53:36Z

Rob Anybody: /* DEF entrypoint */

<div class="floatright">__TOC__</div>

==Intro==

This guide outlines a scheme for packaging mods,
including directory structure, essential files, useful CON commands,
instructions on launching packaged and unpacked mods,
and tips for working with version control.

This guide assumes you are modding for EDuke32 on Windows;
you may need to make adjustments for other games
or operating systems.

==Unpackaged mods==

It's possible to test your mod without ever packaging it,
by placing your files in a subdirectory alongside the EDuke32 executable.

===Mod directory===

First, create a new subdirectory alongside the EDuke32 executable,
and name it ''mymod''.

All of your mod's files will live here, including
CON scripts, DEF files, maps, graphical and audio assets, and so on.
You can name and organize these in subdirectories as you please,
with only the following exception.

===CON entrypoint===

Next, create a CON script named ''eduke.con''
directly inside of the ''mymod'' directory
and add the following line:

include game.con

The ''game.con'' here refers to a file in ''duke3d.grp'', not a part of your mod.
EDuke32 will automatically load ''eduke.con'' if present, or ''game.con'' if not.
Since ''eduke.con'' is loaded in this case, we must load ''game.con'' ourselves.

===DEF entrypoint===

Now, create a file called ''mymod.def'' and leave it blank for now.
This will contain any [[DEF_Language]] instructions your mod needs.
In ''eduke.con'', add the following line:

setdefname mymod.def

The [[setdefname]] command tells EDuke32 where to find your DEF file.
Note that you could name it whatever you like or put it in a subdirectory
and adjust the line above as necessary.

===Episodes and levels===

Finally, fire up Mapster32, create a quick map,
and save it in ''mymod'' as ''mymap01.map''.
Add the following to ''eduke.con'':

definevolumename 0 Episode One
definelevelname 0 0 mymap01.map 01:02 02:03 My Map One

The [[definevolumename]] command
registers "Episode One" as the name of your first episode.
The [[definelevelname]] command registers
the path to the first map of the first episode,
as well as target completion times and the name of the map.

Again, you could name the map whatever you like,
or put it in a subdirectory,
and adjust the line above as necessary.

===Testing your mod===

To launch the mod in its unpackaged form,
simply run the following command:

eduke32 -j mymod

If you're not comfortable working from the command line,
create a shortcut to eduke32.exe, right click it, select ''Properties'',
and edit the ''Target'' field to add ''-j'' at the end:

C:\path\to\eduke32.exe -j

You can now drag your ''mymod'' folder onto the shortcut to launch it.
If you want the shortcut to be a dedicated launcher for your mod
instead of having to drag the folder onto it,
add ''mymod'' after the ''-j''.

==Packaging mods==

===The easy way===

To package your mod, simply zip up the contents of ''mymod''
using a tool like [https://www.7-zip.org/ 7-Zip].
Be sure to zip up the contents rather than the directory itself;
the zip file should not include a directory called ''mymod''.

To test the packaged mod, simply drag the zip file onto the EDuke32 executable.

===The Git way===

Explaining version control is outside the scope of this tutorial,
but if you're already using [https://git-scm.com/ Git], you can use
[https://git-scm.com/docs/git-archive git-archive] to package your mod:

# after committing everything...
git archive HEAD -o ../mymod.zip

This will keep Git's dotfiles from getting packaged,
as well as anything listed in ''.gitignore''
or having the ''export-ignore'' attribute.

Packaging mods

2020-07-30T03:38:58Z

Rob Anybody: /* DEF entrypoint */

<div class="floatright">__TOC__</div>

==Intro==

This guide outlines a scheme for packaging mods,
including directory structure, essential files, useful CON commands,
instructions on launching packaged and unpacked mods,
and tips for working with version control.

This guide assumes you are modding for EDuke32 on Windows;
you may need to make adjustments for other games
or operating systems.

==Unpackaged mods==

It's possible to test your mod without ever packaging it,
by placing your files in a subdirectory alongside the EDuke32 executable.

===Mod directory===

First, create a new subdirectory alongside the EDuke32 executable,
and name it ''mymod''.

All of your mod's files will live here, including
CON scripts, DEF files, maps, graphical and audio assets, and so on.
You can name and organize these in subdirectories as you please,
with only the following exception.

===CON entrypoint===

Next, create a CON script named ''eduke.con''
directly inside of the ''mymod'' directory
and add the following line:

include game.con

The ''game.con'' here refers to a file in ''duke3d.grp'', not a part of your mod.
EDuke32 will automatically load ''eduke.con'' if present, or ''game.con'' if not.
Since ''eduke.con'' is loaded in this case, we must load ''game.con'' ourselves.

===DEF entrypoint===

Now, create a file called ''mymod.def'' and leave it blank for now.
This will contain any [[DEF_Language]] instructions your mod needs.
In ''eduke.con'', add the following line:

setdefname mymod.def

The [[setdefname]] command tells Eduke32 where to find your DEF file.
Note that you could name it whatever you like or put it in a subdirectory
and adjust the line above as necessary.

===Episodes and levels===

Finally, fire up Mapster32, create a quick map,
and save it in ''mymod'' as ''mymap01.map''.
Add the following to ''eduke.con'':

definevolumename 0 Episode One
definelevelname 0 0 mymap01.map 01:02 02:03 My Map One

The [[definevolumename]] command
registers "Episode One" as the name of your first episode.
The [[definelevelname]] command registers
the path to the first map of the first episode,
as well as target completion times and the name of the map.

Again, you could name the map whatever you like,
or put it in a subdirectory,
and adjust the line above as necessary.

===Testing your mod===

To launch the mod in its unpackaged form,
simply run the following command:

eduke32 -j mymod

If you're not comfortable working from the command line,
create a shortcut to eduke32.exe, right click it, select ''Properties'',
and edit the ''Target'' field to add ''-j'' at the end:

C:\path\to\eduke32.exe -j

You can now drag your ''mymod'' folder onto the shortcut to launch it.
If you want the shortcut to be a dedicated launcher for your mod
instead of having to drag the folder onto it,
add ''mymod'' after the ''-j''.

==Packaging mods==

===The easy way===

To package your mod, simply zip up the contents of ''mymod''
using a tool like [https://www.7-zip.org/ 7-Zip].
Be sure to zip up the contents rather than the directory itself;
the zip file should not include a directory called ''mymod''.

To test the packaged mod, simply drag the zip file onto the EDuke32 executable.

===The Git way===

Explaining version control is outside the scope of this tutorial,
but if you're already using [https://git-scm.com/ Git], you can use
[https://git-scm.com/docs/git-archive git-archive] to package your mod:

# after committing everything...
git archive HEAD -o ../mymod.zip

This will keep Git's dotfiles from getting packaged,
as well as anything listed in ''.gitignore''
or having the ''export-ignore'' attribute.

Packaging mods

2020-07-30T03:38:35Z

Rob Anybody: /* CON entrypoint */

<div class="floatright">__TOC__</div>

==Intro==

This guide outlines a scheme for packaging mods,
including directory structure, essential files, useful CON commands,
instructions on launching packaged and unpacked mods,
and tips for working with version control.

This guide assumes you are modding for EDuke32 on Windows;
you may need to make adjustments for other games
or operating systems.

==Unpackaged mods==

It's possible to test your mod without ever packaging it,
by placing your files in a subdirectory alongside the EDuke32 executable.

===Mod directory===

First, create a new subdirectory alongside the EDuke32 executable,
and name it ''mymod''.

All of your mod's files will live here, including
CON scripts, DEF files, maps, graphical and audio assets, and so on.
You can name and organize these in subdirectories as you please,
with only the following exception.

===CON entrypoint===

Next, create a CON script named ''eduke.con''
directly inside of the ''mymod'' directory
and add the following line:

include game.con

The ''game.con'' here refers to a file in ''duke3d.grp'', not a part of your mod.
EDuke32 will automatically load ''eduke.con'' if present, or ''game.con'' if not.
Since ''eduke.con'' is loaded in this case, we must load ''game.con'' ourselves.

===DEF entrypoint===

Now, create a file called ''mymod.def'' and leave it blank for now.
This will contain any [[DEF_Language]] instructions your mod needs.
In ''eduke.con'', add the following line:

setdefname mymod.def

The [setdefname] command tells Eduke32 where to find your DEF file.
Note that you could name it whatever you like or put it in a subdirectory
and adjust the line above as necessary.

===Episodes and levels===

Finally, fire up Mapster32, create a quick map,
and save it in ''mymod'' as ''mymap01.map''.
Add the following to ''eduke.con'':

definevolumename 0 Episode One
definelevelname 0 0 mymap01.map 01:02 02:03 My Map One

The [[definevolumename]] command
registers "Episode One" as the name of your first episode.
The [[definelevelname]] command registers
the path to the first map of the first episode,
as well as target completion times and the name of the map.

Again, you could name the map whatever you like,
or put it in a subdirectory,
and adjust the line above as necessary.

===Testing your mod===

To launch the mod in its unpackaged form,
simply run the following command:

eduke32 -j mymod

If you're not comfortable working from the command line,
create a shortcut to eduke32.exe, right click it, select ''Properties'',
and edit the ''Target'' field to add ''-j'' at the end:

C:\path\to\eduke32.exe -j

You can now drag your ''mymod'' folder onto the shortcut to launch it.
If you want the shortcut to be a dedicated launcher for your mod
instead of having to drag the folder onto it,
add ''mymod'' after the ''-j''.

==Packaging mods==

===The easy way===

To package your mod, simply zip up the contents of ''mymod''
using a tool like [https://www.7-zip.org/ 7-Zip].
Be sure to zip up the contents rather than the directory itself;
the zip file should not include a directory called ''mymod''.

To test the packaged mod, simply drag the zip file onto the EDuke32 executable.

===The Git way===

Explaining version control is outside the scope of this tutorial,
but if you're already using [https://git-scm.com/ Git], you can use
[https://git-scm.com/docs/git-archive git-archive] to package your mod:

# after committing everything...
git archive HEAD -o ../mymod.zip

This will keep Git's dotfiles from getting packaged,
as well as anything listed in ''.gitignore''
or having the ''export-ignore'' attribute.

Packaging mods

2020-07-30T03:03:23Z

Rob Anybody: Create tutorial on packaging mods

<div class="floatright">__TOC__</div>

==Intro==

This guide outlines a scheme for packaging mods,
including directory structure, essential files, useful CON commands,
instructions on launching packaged and unpacked mods,
and tips for working with version control.

This guide assumes you are modding for EDuke32 on Windows;
you may need to make adjustments for other games
or operating systems.

==Unpackaged mods==

It's possible to test your mod without ever packaging it,
by placing your files in a subdirectory alongside the EDuke32 executable.

===Mod directory===

First, create a new subdirectory alongside the EDuke32 executable,
and name it ''mymod''.

All of your mod's files will live here, including
CON scripts, DEF files, maps, graphical and audio assets, and so on.
You can name and organize these in subdirectories as you please,
with only the following exception.

===CON entrypoint===

Next, create a CON script named ''eduke.con''
directly inside of the ''mymod'' directory
and add the following line:

include game.con

The ''game.con'' here refers to a file in ''duke3d.grp'', not a part of your mod.
Eduke32 will automatically load ''eduke.con'' if present, or ''game.con'' if not.
Since ''eduke.con'' is loaded in this case, we must load ''game.con'' ourselves.

===DEF entrypoint===

Now, create a file called ''mymod.def'' and leave it blank for now.
This will contain any [[DEF_Language]] instructions your mod needs.
In ''eduke.con'', add the following line:

setdefname mymod.def

The [setdefname] command tells Eduke32 where to find your DEF file.
Note that you could name it whatever you like or put it in a subdirectory
and adjust the line above as necessary.

===Episodes and levels===

Finally, fire up Mapster32, create a quick map,
and save it in ''mymod'' as ''mymap01.map''.
Add the following to ''eduke.con'':

definevolumename 0 Episode One
definelevelname 0 0 mymap01.map 01:02 02:03 My Map One

The [[definevolumename]] command
registers "Episode One" as the name of your first episode.
The [[definelevelname]] command registers
the path to the first map of the first episode,
as well as target completion times and the name of the map.

Again, you could name the map whatever you like,
or put it in a subdirectory,
and adjust the line above as necessary.

===Testing your mod===

To launch the mod in its unpackaged form,
simply run the following command:

eduke32 -j mymod

If you're not comfortable working from the command line,
create a shortcut to eduke32.exe, right click it, select ''Properties'',
and edit the ''Target'' field to add ''-j'' at the end:

C:\path\to\eduke32.exe -j

You can now drag your ''mymod'' folder onto the shortcut to launch it.
If you want the shortcut to be a dedicated launcher for your mod
instead of having to drag the folder onto it,
add ''mymod'' after the ''-j''.

==Packaging mods==

===The easy way===

To package your mod, simply zip up the contents of ''mymod''
using a tool like [https://www.7-zip.org/ 7-Zip].
Be sure to zip up the contents rather than the directory itself;
the zip file should not include a directory called ''mymod''.

To test the packaged mod, simply drag the zip file onto the EDuke32 executable.

===The Git way===

Explaining version control is outside the scope of this tutorial,
but if you're already using [https://git-scm.com/ Git], you can use
[https://git-scm.com/docs/git-archive git-archive] to package your mod:

# after committing everything...
git archive HEAD -o ../mymod.zip

This will keep Git's dotfiles from getting packaged,
as well as anything listed in ''.gitignore''
or having the ''export-ignore'' attribute.

Swinging Doors

2020-07-26T03:25:46Z

Rob Anybody: /* Swinging Doors */ Edit on behalf of corpusc on Duke4 discord

{{Build Intro}}
NOTE: Much of information on this page is from around 1999. Some may be outdated, and some may be incorrect -- this page exists to get you started with the Level Editing and may not currently cover some of the additional features available in Mapster32.
__NOTOC__
==Swinging Doors==

''Map Name: [[Media:Tutorial.map|TUTORIAL.MAP]] (ROOM 1-D)''

Swinging doors are possibly the coolest and most useful doors in Duke Nukem 3D, but they can be a pain to construct. Follow these steps, however, and you should be able to make a working swinging door.

:STEP 1: Create the room and the hallway that the door will separate. The ceiling height of the hallway should be the height of the door. The hallway and the room should be two separate sectors (there should be a red line between these two sectors in 2D mode).

:STEP 2: Create the door sector on the side of the red line that the door will swing in to. This sector should be valid player space. In 3D mode, raise the floor of this sector to the height that you want the door to be (or you can lower the ceiling; whichever you prefer).

::NOTE 1: The door sector should be made within another, valid sector.

:STEP 3: Now move the door sector to where it should be. One side of the door should be in the exact position as the red line separating the hallway from the room (i.e. - two of the vertices of the door should sit exactly on top of the two vertices of the hallway and room junction).

::NOTE 2: The door should be in the sector in which it will swing into. If it is not, some big problems can occur.

:STEP 4: Give the door sector a sector lotag value of 23.

:STEP 5: Place one sector effector sprite in the door. Give this sprite a lotag value of 11, and a unique hitag value. Now you need to move the sector effector at the pivot point for the door. Turn off the grid lock feature by pressing the [L] key in 2D mode. Move the sector effector sprite as close to the pivoting corner of the door as you can, but *do not* place this sprite on the corner itself. Zoom in as far as you can possibly go in 2D mode to see just where you are putting it.

:STEP 6: Now you need to set the angle for the door. If you want the door to swing in a clockwise direction, point the sector effector south. If you want the door to swing in a counter-clockwise direction, point the sector effector north.

:STEP 7: Place one Music&SFX sprite in the door. Give this sprite a lotag value of 165. You are now finished! Take a look at the tutorial map if you don't quite understand.

::NOTE 3: Swinging doors will not work correctly in any of the following situations:

::* If the floor or ceiling is sloped.
::* If the door swings into another sector.
::* If the door is not a valid player space sector.

:STEP 8 (optional): Put a GPSPEED sprite in the door to control its speed.

::* Supports only values 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024 ...

==Swinging Glass Doors==

''Map Name: [[Media:Tutorial.map|TUTORIAL.MAP]] (ROOM 1-E)''

Swinging glass doors look great and add a nice touch to virtually any level. They aren't easy, however, so follow these instructions very carefully.

:STEP 1: Create a swinging door (see the swinging door how-to) but do not raise the door sector up from the floor.

:STEP 2: At the end of the door farthest from the pivot point (or farthest from the sector effector with lotag 11 - same thing) create a small square sector inside of the door. This sector should *NOT* be valid player space (i.e. - the walls of this sector should be white).

:STEP 3: Mask the outermost red line of the door itself, changing the mask texture to the glass texture. The [M] key in 3D mode creates a masked wall. Press the [B] and [H] keys on this mask. A point can be inserted on this line (before masking it) if desired, in order to prevent the glass texture from being as long as the door.

:STEP 4: Lower the ceiling of the door sector a few [PGDN] units (2 works nicely) and raise the floor of the door sector a few [PGUP] units (again, 2 works nicely). You're done! Take a look at the tutorial map if you don't quite understand.

==Problems and Fixes with Swinging Doors==

The following is a list of common problems and their solutions for working with swinging doors.

*'''PROBLEM''': My door disappears when it opens! What do I do?
:'''SOLUTION''': The problem here is that a corner of your door is actually going *outside* of your map (into nothingness) and is causing your door to disappear. Either move the sector effector sprite with the lotag of 11 closer to the vertex of the door, or angle the corner that travels outside the map. Also make sure that you are not building a door that swings in sectors of different height or sloped sectors.

*'''PROBLEM''': My door swings in the wrong direction! How do I fix this?
:'''SOLUTION''': You need to fix the direction that the sector-effector is pointing. To make the door swing clockwise, the sector effector needs to point upwards. To make it swing counter clockwise, you need to point the SE down.

*'''PROBLEM''': When I make my door, I try to move it and it loses it's unique sector lotag/hitag.
:'''SOLUTION''': The 'door' sector has to be created inside the sector where it will swing into. Do not create it and then move it into another sector or the it will lose it's unique lotag/hitag.

*'''PROBLEM''': When I open my door, the walls move with it! How do I fix this?
:'''SOLUTION''': When you create the 'door' sector, it should be a free standing sector. In other words the vertices should NOT be connected to any other vertices. AFTER the door sector has been made, you may move it (to the door hole) and now the vertices may overlap because they will not connect now. Be sure of this or the walls will be pulled along with the door!

*'''PROBLEM''': When I open my swinging door, the door kills me! How can I stop this from happening?
:'''SOLUTION''': Make sure that the sector effector sprite is actually INSIDE of the sector, and NOT on a line of the sector.

*'''PROBLEM''': When I open one swinging door, a completely different door opens up. What's the deal?
:'''SOLUTION''': The hitags for your sector effector sprites are the same. You must use UNIQUE hitags for doors that you want to open separately.

[[Category:Editing Doors]]

User talk:Micky C

2020-07-22T03:04:50Z

Rob Anybody: message

Hey, made some edits to your TROR guide to remove some outdated bits specific to rendering backends. Hendricks266 suggested I give you a heads up in case you feel like editing in more current info some time. -- Rob

True Room Over Room Mapping Guide

2020-07-22T02:19:15Z

Rob Anybody: /* Polymost renderer */

{{Build Intro}}

True Room Over Room is a feature new to EDuke32 that allows for the construction of [[sector]]s in a vertical arrangement. Other build games (Shadow Warrior, Blood, Redneck Rampage) are able to fake ROR by having sectors in different parts of the map and rendering them on top of each other, and EDuke32 has a similar feature using Sector Effectors. The difference between game ROR and TROR is that the sectors are physically on top of each other, making editing a lot easier and more automatic, while also making it easier to visualize what you're building. For the more technically minded, TROR is part of the engine and map format themselves, instead of an effect bolted on in the game code.

==TROR Editing Modes==
There are two modes you should be aware of before starting to build with TROR.

===Side view (orthographic view) mode===
This mode allows you see a 3D representation of your map while in 2D mode. This is toggled with '''[F3]'''. It can be rotated with the '''[Q]''' and '''[W]''' buttons, and the angle of viewing can be changed by pressing '''[A]''' and '''[Z]'''.
This mode is absolutely essential not only because it allows you to actually see what you're doing, but because in order to properly use TROR, you need to designate which is the 'active' layer that new sectors will connect to.

This can be done in 2 ways.

The first way is to press '''[Ctrl-A]''' which will grey out all other layers except the one the viewpoint (the arrow in 2D/side view mode)is in, which is the active layer. You can move the view point up and down, allowing you to edit above and below layers, by either pressing '''[page up]''' and '''[page down]''' respectively, or more accurately by pressing down the '''[middle mouse button]''' and moving the mouse forward or backwards. This method is usually prefered as it gives you much more control over the vertical position of the viewpoint. If you find the greyed-out walls distracting, you can remove them altogether by pressing '''[Ctrl-Alt-A]'''

The second way allows for more precision as you can narrow the active editing range to the height of a single (or set of) sectors. Firstly, select the sector(s) that you want to be able to edit with '''[Right-Alt]''', and press '''[Ctrl-R]'''. It's as easy as that. Press '''[Ctrl-R]''' without having any sectors highlighted to unlock the range again and be able to edit them normally.

===Invisible surfaces viewing mode===
This is for 3D mode when you want to toggle seeing invisible objects.
All you have to do to toggle this mode is press '''[I]''', which primarily allows you to see objects you've made invisible with '''['-I]'''. However, the reason why it's so useful here, is that it also shows you the boundaries between TROR layers (which are invisible in-game). This is a huge benefit when you want to visualize/figure out what's actually going on. It also allows you to edit the TROR surfaces and apply transparent or masked floors, and edit characteristics like the blocking and hitscan bits.

==Properties and Terminology==
TROR is created by selecting a sector and extending it (this will be covered later in method). This means that it creates a new sector directly on top of or below the selected sector, which is exactly the same size and shape as the original. The ceiling of the bottom sector is linked with the floor of the top sector. It then makes sense that the extended sector is called an '''extension'''.

You can have more than one extension on a sector. You can extend it above and below, then take the bottom and extend that down again and again, and the same with the top. You are effectively stacking sectors on top of each other, so these sectors are part of a '''stack'''. The great thing about stacks (even with only one extension) is that if you move the vertex of a wall of one layer, it will automatically move the vertices of all the other layers, so that they're easy to change the shape of without worrying about breaking the connection.

You can highlight a group of sectors and extend them all at the same time so that there can be a single extension covering them all. This is useful because it saves walls, and you can still edit all the child sectors with ease. Now, as soon as you extend these sectors so that they share an extension, they all become a part of the same '''bunch'''.

If you take a room with a child sector in the middle, and extend everything upwards except the child layer, there will now be void space in the top layer where the child sector is. If you press '''[Ctrl-S]''' there to make it into a child sector in the top layer, you'll then find that you have a floating normal (non-TROR) sector between the two TROR layers that you can do with as you please. This is called an '''island'''. I suppose it's still an island even if you don't make it a child sector in the top layer but hey, now you can create floating sectors. These can potentially be glitchy if you're not using the polymer renderer, but we'll get onto that later.

==TROR related keys==
The following are a list of keys which are related to editing TROR. They can also be found in the [http://wiki.eduke32.com/wiki/Build/Mapster32_Keyboard_Commands mapster32 keyboard commands page]

===2D mode===
'''[Ctrl-E]''' sector extension prompt (sectors to extend must be highlighted) 
'''[Ctrl-E]''' make sandwich [''if extending a sector in a direction that has already been extended, see below''] 
'''[Ctrl-E]''' punch loop through extension (loop points must be highlighted, e.g. with '''[Right Shift]'''+'''[Left Ctrl]''') 
 
'''[Ctrl-A]''' toggle auto-grayout of non-extended sectors 
'''[Ctrl-J]''' TROR-join sectors. The selection must consist of the two sets of sectors you wish to join. 
'''[Ctrl-U]''' Clear extension: delete the bunch (i.e. ceiling-floor connection) of the aimed-at sector's floor 
'''[PGUP]'''/'''[PGDN]''' Change 'player' height in discrete steps in order to go through the different levels 
'''[Ctrl-tab]''' Display one currently aimed at sector (of potentially many that lie under the mouse crosshair) 
'''[HOME]''' and '''[END]''' as modifiers to AltGr: select all sectors whose floor's/ceiling's bunchnum equal the bunchnum of the aimed at sector (useful for further operations on whole bunches)

===3D mode===
'''I''' invisibility preview: toggle fake ROR texture on non-masked portals 
'''LENTER+CTRL''' When aiming at an extended floor/ceiling, paste to all floors/ceilings of the bunch of the aimed at one 
'''T''', '''B''' and '''H''' work as with walls, though they set/toggle the bits only on '''one''' side 

===Advanced Highlighting===
Not really specific to TROR, but having greater control over which or how many sectors you can highlight makes doing extensions in TROR much easier. Make sure you're familiar with [http://wiki.eduke32.com/wiki/Level_editing#Copying_and_Pasting_Sectors advanced sector highlighting].

The information on the advanced features is outlined below:

You can highlight a second, third, and multiple sectors by holding down '''[']''' as you drag the selection box over them. This way you can highlight sectors in different parts of the map. Likewise, use the '''[;]''' key to deselect sectors. A small plus or minus will appear next to the cursor depending on which button you're holding.

You can select individual sectors with the mouse by moving the cursor inside the sector you want, holding '''[RIGHT ALT]''', and holding '''[RIGHT CTRL]''' as you release '''[RIGHT ALT]'''. The sector is now highlighted. This method of selection also works with '''[']''' and '''[;]''' to select/deselect additional sectors by mouse. Simply hold '''[RIGHT ALT]''' and the appropriate button depending on what you want to do, then hold '''[RIGHT CTRL]''' while releasing the other buttons. This becomes very quick and easy to do after doing it a few times.

==TROR Mapping Examples==

===Manhole Sewer Example===

In this straightforward example, you're going to make a manhole that goes below a street, and some area around the end of the hole at the bottom.

1. Create the child sector where you want the manhole to be.

2. Highlight the sector with '''[Right-Alt]'''.

3. Press '''[Ctrl-E]'''. Mapster will prompt you whether you want to extend up or down.

4. We want to extend down so press '''[Z]''' ('''[A]''' if you're extending up).

5. Go into side view mode with '''[F3]''', and move the viewpoint down until you're editing the bottom layer.

6. The child sector you created should now have a white boundary, with the street sectors above either greyed out or gone depending on your settings.

7. Now you can treat the manhole sector (the extension) as the very first room you've made on a new map. You can draw sectors on the side of it to attach some rooms there. If you go into 3D mode, you should be able to see that if you go down that manhole, there should now be some area at the bottom which overlaps the street. This was not previously possible without using some kind of cheap trick. Congratulations, you've just made TROR.

===Two Story Building Example===

I'm sure that a big reason that people want to use TROR is to build multiple story buildings, and this is how you do it.

1. Design the first floor of your building, both inside and out. This is going to be the first layer, which means the ceiling of every sector, especially the outdoor sectors should not be any higher than the roof of the first floor. Pretend that the second floor doesn't even exist.

2. Make your windows, doors, and anything you want.

Highlight with '''[Right-Alt]''' all of the ''outdoor'' sectors (the outdoor sectors should all have the same ceiling height, and should not be parallaxed). Knowing your advanced highlighting will come in useful here to select all the sectors.

3. Extend the highlighted area up, and make the top layer the active editing layer.

4. You should notice that the outline of your house has become completely white, and the area inside the house is empty. This is because this area is the second floor of your house.

5. Make a sector inside the house outline, this will be the room on the second floor of your house. Draw small sectors between that room and the house outline to create second floor windows. Alternatively you could just press '''[Ctrl-S]''' inside the house sector to make it a regular child sector, and if you go into 3D mode, you'll see your house has a roof you can stand on top of.

6. If you're learning TROR for the first time, it is very helpful at this point to go into 3D mode and press '''[i]''' to reveal the boundaries between layers so that you can understand what you've done.

7. You can connect the ground floor to the second floor the same way you'd connect two sector-over-sector sectors; by having a staircase or lift that connects to a different area on the top floor than it does on the bottom (because a lift for example cannot directly cross TROR layers, therefore it must be connected to sectors which do not overlap; i.e have the entrance on one side and the exit on the other.)
Or you can connect the ground floor and second floor via TROR and have some sprite stairs or something.

At this stage you should have a perfect two story house where you can look into and enter both stories. Cool stuff eh? ;)

There's nothing stopping you from going on to build a third.. forth.. fifth.. floor in the same manner either.

===TROR water example===

This is how you create transparent water using TROR. It works just like regular water, but there are a few things you need to be aware of.

1. Create a main sector, then a child sector in that and extend it downwards.

2. Make both the top and bottom of the TROR surface masked or transparent, and give it the water texture.

3. Give the floor of the top sector a lotag of 1 for water. Give the floor of the bottom sector a lotag of 2 for underwater.

4. Place an SE 7 with the same hitag in the same position in both the top and bottom sector.

5. This is the one that people normally forget. Set the TROR surface in both the top and bottom layer to BLOCKING otherwise it will not work as intended.

See, it's not too bad, just remember the lotags and the blocking. Note if you split up the water sector or add more sectors, make sure those sectors are in both the top and bottom layers, and have new SE 7s, just like normal water. In the future TROR water will be more automatic in that you won't need the SE 7, however this is incomplete as of this writing.

Something that might make life a bit easier is that if you extend the floor of the below-water sector downwards, you can then edit the floor of the new bottom layer and make as complex as you want without having to worry about placing lots of SE 7s.

===Retro-fitting via Joining Example===

If you're absolutely clueless with the whole idea of extending, or you want to go back and retrofit some TROR into maps you've done in the past, there's a very easy way of joining them to form TROR.
If you have two sectors that have the same shape, area, and external vertices have the same relative positions (essentially they're the same sector, at least as far as their edges are concerned), then all you have to do is highlight both sectors with '''[Right-Alt]''', and press '''[Ctrl-J]''' to join, the same as joining two sectors normally. It will then prompt you with a few questions such as which sector you want to have on top of the other, which sector(s) you want to move (doesn't matter most of the time), and whether you'd like to move all the connected non-TROR sectors as well (definitely yes).

The good thing about this method is that besides the questions you have to answer, mapster does everything automatically, it even moves the heights for you. Now there'll be a quick example of this method below.

1. Make a child sector in a larger sector and copy-paste it into void space.

2. Give the floor of the original child sector and the ceiling of the new sector the water texture.

3. Highlight both the child sector and new sector with '''[Right-Alt]'''.

4. Press '''[Ctrl-J]''' and answer the simple questions.

5. You should end up with a TROR water sector just as you would via the extension method. You can now alter the transparency of the water to your preference.

===Sandwiching and Sector Punching===
It's possible and easy to create a new TROR layer between two TROR layers. All you have to do is highlight one of them, and extend it as you would normally, and it automatically adds a new layer in the middle.

It's also possible to easily create an island sector in the middle of a TROR sector. This is called ''sector punching'', and mainly involves stamping a child sector into the sector below or above. Follow the example below.

1. Extend a sector downwards.

2. Create a child sector in the original sector.

3. Select the vertices of the child sector with '''[Right-Shift]''' or '''[R-Ctrl + R-Shift]''' and press '''[Ctrl-E]''' as though you're extending a sector.

4. It will prompt you whether to punch up or down, in this case, choose down and hit '''[Enter]'''. A sector identical in size, shape and position should now be in the bottom layer.

5. Point the mouse cursor at the child sector in the top layer and press '''[Ctrl-U]'''. It will prompt you whether you want to break the connection, and unless you press [Ctrl-U] accidentally, you usually do.

6. The child sector should now be a floating sector island. Have fun.

Note that '''[Ctrl-U]''' only breaks the connection of a single sector if that sector has been punched. Otherwise it'll break the connection of the entire bunch, which is usually bad.

===List of TROR maps===

This (hopefully up to date) list contains maps which make heavy use of the TROR feature in order to make a huge variety of constructions. They each contain a wealth of examples for you to look at to see what's possible and how it works/how to make it. This is not a complete list, as other maps make minor or simple use of the effect and hence are not listed here.

1. The trueror.map in the Samples folder included with eduke32 contains a large amount of random examples of TROR.

2. Retaliation is a small hi-tech map by Loke that was the first proper TROR map and makes some great use of the feature. [http://www.scent-88.com/reviews/R/retaliation/retaliation.php Download here]

3. Parkade is a large city themed map containing large multiple story buildings, along with a large amount of unique, pioneering uses of the feature, made by myself (Micky C) and Paul B. It is the largest, most extensive TROR map and perhaps the best example of what TROR is capable of so far, if I do say so myself. [http://www.scent-88.com/reviews/P/parkade/parkade.php Download here]

4. Brooklyn Bridge is another city themed map which also makes extensive and interesting use of TROR, such as an alien ship that flies over water, shooting rockets, and in vents. [http://www.scent-88.com/reviews/B/brooklyn/brooklyn.php Download here]

==Tricks and Effects with TROR==

===SE 13 destructible floor/ceiling===

If you have a TROR extension in the floor, you can place an SE 13 on it (facing downwards in 2D mode, and it will become a solid floor in-game (blocked and masked). When the hitag is activated, the TROR surface will become invisible as though a hole has just formed in the floor. You can place the SE 13 on the surface, or above, in which case the floor will initially have the height of the SE 13 just like with the original effect. You can also place it near the ceiling to make the SE 13 control the ceiling instead, or have one near the ceiling and one near the floor to control both.

When placed in a TROR extension with many sectors, it will not just control the sector, but rather the entire extension. So you can add sectors and give them different textures and don't have to worry about adding extra SE 13's. If you want to have TROR surfaces have different heights with different SE 13 sprites, they need to be different extensions; i.e they need to have a sector in both the top and bottom layer, and be extended individually.

The SE 13 also works with TROR slopes, allowing you to create relatively complex destructible objects compared to sprites. But remember that TROR is pretty wall hungry, so keep an eye on complexity.
Note that regardless of whether a TROR surface is set to masked or transparent in mapster, it will always become invisible after SE 13 activation.

===TROR water height manipulation===

TROR water can also be made to move up and down using the SE 31/32, much like the raising/lowering submergible water in e1l4 Toxic Dump. The effect is the same, however it's easier with TROR, because you only have to set up the effect on one side, either in the top layer or bottom layer, because this effect is set up so that if the ceiling of the bottom sector is moved, it moves the floor of the top sector as well, and vice versa.

==Visual Glitches and Workarounds==

===Software renderer===
Even though TROR sectors are already physically overlapping, the 8-bit software renderer still needs to render them separately, having to do an extra rendering pass for each additional TROR extension in view. Theoretically if you create a huge amount of extensions in the same area the framerate could potentially drop to unplayable levels, however this is far fetched and I wouldn't worry about it.

The real problem with the software renderer is HOM glitching. In each rendering pass, there can only be one area along the x-interval drawn. For example, if you have an island on the ground, the area between you and the island will be fine, but everything on the other side of the island will show HOM. Try it out yourself to see what I mean. Technically this means that TROR extensions cannot contain islands (although it's been kind of hacked in to do exta-extra passes to overcome this problem, I wouldn't rely on them for perfect drawing.)

However, this can be overcome by breaking up the sector surrounding the child sector, and extending each sector individually. This means there will be multiple drawing portals around the island instead of one big one, and none of the individual extensions would contain the island, hence it should draw fine.

This HOM doesn't just occur due to islands, it can also happen when part of a normal sector is jutting out into a TROR sector, this can be thought of here as a mini-island even though it's connected to something. Don't call it a mini-island, I only called it that to explain why it would cause that glitching. This means that TROR extensions should be ''convex'', i.e if you draw a straight line through a TROR portal so that it leaves the sector, and then comes back, it is not convex (and is most likely due to something jutting out.) However if you draw a line through it and this does not happen, as is the case for a circle, square etc.. then it is convex, and should draw fine.

Also note that currently the software renderer doesn't allow the player to see through more than 8 layers of TROR (it draws the texture on the surface instead). This normally isn't a problem in small sectors of TROR because the player typically won't be able to look up high enough to see the 8 layers due to vertical distortion. The limit could potentially be increased if someone desperately needed it (talk to the devs for that.)

Having void sectors (white-walled sectors with null space inside them) inside a TROR sector, or inside a sector adjacent to/bounding a TROR sector, it will cause visual glitches when viewed from some angles. Consider turning potential void sectors into child sectors, and raise the floor to the ceiling to fix this, as the result would look identical to having a void sector, but without the glitching.

===Polymer renderer===

'''Polymer is not actively developed at this time and should only be used as a last resort.'''

Masked floors and ceilings in polymer are always the last thing drawn on the screen. That means if you have a transparent surface such as a masked wall or sprite, it would cause everything all the TROR masked surfaces behind the transparent surface to stop being drawn and become invisible. There's no real work around for this, just try not to use masked walls or sprites with big transparent surfaces around TROR masked surfaces.

Other than that, polymer is by far the most stable renderer for TROR, and apart from what's written above, is 100% glitch free, though it may be slow sometimes. It works by drawing the entire scene, TROR and all in a single rendering pass. This means that it doesn't require any additional computer power to draw TROR, hence TROR will not affect the framerate in polymer.

===Polymost renderer===
[needs description]

==Random Trivia==
Extended sectors can be sloped, but the bunch has to be 1:1 in that case. I.e you can't have any child sectors within a sloped TROR sector. If you want different TROR sectors with different slopes, you must use completely different extensions for that, as opposed to breaking up a single extension.

Maps containing one or more TROR bunches are saved in a new map format (v9) since some fields had to be taken over: xrepeat is unavailable on TROR'ed floors and ceilings, and on walls it's lotag if the ceiling, and extra if the floor of the wall's sector is extended. When in-game, these get transferred to internal arrays though.

The system is supposed to be used for 'large-scale' RoR, as a rule of thumb each affected sector should be at least a Duke high [that's too strict though].

[[Category:Level editing documentation]]

True Room Over Room Mapping Guide

2020-07-22T02:18:51Z

Rob Anybody: /* Polymer renderer */ not renderer of choice

{{Build Intro}}

True Room Over Room is a feature new to EDuke32 that allows for the construction of [[sector]]s in a vertical arrangement. Other build games (Shadow Warrior, Blood, Redneck Rampage) are able to fake ROR by having sectors in different parts of the map and rendering them on top of each other, and EDuke32 has a similar feature using Sector Effectors. The difference between game ROR and TROR is that the sectors are physically on top of each other, making editing a lot easier and more automatic, while also making it easier to visualize what you're building. For the more technically minded, TROR is part of the engine and map format themselves, instead of an effect bolted on in the game code.

==TROR Editing Modes==
There are two modes you should be aware of before starting to build with TROR.

===Side view (orthographic view) mode===
This mode allows you see a 3D representation of your map while in 2D mode. This is toggled with '''[F3]'''. It can be rotated with the '''[Q]''' and '''[W]''' buttons, and the angle of viewing can be changed by pressing '''[A]''' and '''[Z]'''.
This mode is absolutely essential not only because it allows you to actually see what you're doing, but because in order to properly use TROR, you need to designate which is the 'active' layer that new sectors will connect to.

This can be done in 2 ways.

The first way is to press '''[Ctrl-A]''' which will grey out all other layers except the one the viewpoint (the arrow in 2D/side view mode)is in, which is the active layer. You can move the view point up and down, allowing you to edit above and below layers, by either pressing '''[page up]''' and '''[page down]''' respectively, or more accurately by pressing down the '''[middle mouse button]''' and moving the mouse forward or backwards. This method is usually prefered as it gives you much more control over the vertical position of the viewpoint. If you find the greyed-out walls distracting, you can remove them altogether by pressing '''[Ctrl-Alt-A]'''

The second way allows for more precision as you can narrow the active editing range to the height of a single (or set of) sectors. Firstly, select the sector(s) that you want to be able to edit with '''[Right-Alt]''', and press '''[Ctrl-R]'''. It's as easy as that. Press '''[Ctrl-R]''' without having any sectors highlighted to unlock the range again and be able to edit them normally.

===Invisible surfaces viewing mode===
This is for 3D mode when you want to toggle seeing invisible objects.
All you have to do to toggle this mode is press '''[I]''', which primarily allows you to see objects you've made invisible with '''['-I]'''. However, the reason why it's so useful here, is that it also shows you the boundaries between TROR layers (which are invisible in-game). This is a huge benefit when you want to visualize/figure out what's actually going on. It also allows you to edit the TROR surfaces and apply transparent or masked floors, and edit characteristics like the blocking and hitscan bits.

==Properties and Terminology==
TROR is created by selecting a sector and extending it (this will be covered later in method). This means that it creates a new sector directly on top of or below the selected sector, which is exactly the same size and shape as the original. The ceiling of the bottom sector is linked with the floor of the top sector. It then makes sense that the extended sector is called an '''extension'''.

You can have more than one extension on a sector. You can extend it above and below, then take the bottom and extend that down again and again, and the same with the top. You are effectively stacking sectors on top of each other, so these sectors are part of a '''stack'''. The great thing about stacks (even with only one extension) is that if you move the vertex of a wall of one layer, it will automatically move the vertices of all the other layers, so that they're easy to change the shape of without worrying about breaking the connection.

You can highlight a group of sectors and extend them all at the same time so that there can be a single extension covering them all. This is useful because it saves walls, and you can still edit all the child sectors with ease. Now, as soon as you extend these sectors so that they share an extension, they all become a part of the same '''bunch'''.

If you take a room with a child sector in the middle, and extend everything upwards except the child layer, there will now be void space in the top layer where the child sector is. If you press '''[Ctrl-S]''' there to make it into a child sector in the top layer, you'll then find that you have a floating normal (non-TROR) sector between the two TROR layers that you can do with as you please. This is called an '''island'''. I suppose it's still an island even if you don't make it a child sector in the top layer but hey, now you can create floating sectors. These can potentially be glitchy if you're not using the polymer renderer, but we'll get onto that later.

==TROR related keys==
The following are a list of keys which are related to editing TROR. They can also be found in the [http://wiki.eduke32.com/wiki/Build/Mapster32_Keyboard_Commands mapster32 keyboard commands page]

===2D mode===
'''[Ctrl-E]''' sector extension prompt (sectors to extend must be highlighted) 
'''[Ctrl-E]''' make sandwich [''if extending a sector in a direction that has already been extended, see below''] 
'''[Ctrl-E]''' punch loop through extension (loop points must be highlighted, e.g. with '''[Right Shift]'''+'''[Left Ctrl]''') 
 
'''[Ctrl-A]''' toggle auto-grayout of non-extended sectors 
'''[Ctrl-J]''' TROR-join sectors. The selection must consist of the two sets of sectors you wish to join. 
'''[Ctrl-U]''' Clear extension: delete the bunch (i.e. ceiling-floor connection) of the aimed-at sector's floor 
'''[PGUP]'''/'''[PGDN]''' Change 'player' height in discrete steps in order to go through the different levels 
'''[Ctrl-tab]''' Display one currently aimed at sector (of potentially many that lie under the mouse crosshair) 
'''[HOME]''' and '''[END]''' as modifiers to AltGr: select all sectors whose floor's/ceiling's bunchnum equal the bunchnum of the aimed at sector (useful for further operations on whole bunches)

===3D mode===
'''I''' invisibility preview: toggle fake ROR texture on non-masked portals 
'''LENTER+CTRL''' When aiming at an extended floor/ceiling, paste to all floors/ceilings of the bunch of the aimed at one 
'''T''', '''B''' and '''H''' work as with walls, though they set/toggle the bits only on '''one''' side 

===Advanced Highlighting===
Not really specific to TROR, but having greater control over which or how many sectors you can highlight makes doing extensions in TROR much easier. Make sure you're familiar with [http://wiki.eduke32.com/wiki/Level_editing#Copying_and_Pasting_Sectors advanced sector highlighting].

The information on the advanced features is outlined below:

You can highlight a second, third, and multiple sectors by holding down '''[']''' as you drag the selection box over them. This way you can highlight sectors in different parts of the map. Likewise, use the '''[;]''' key to deselect sectors. A small plus or minus will appear next to the cursor depending on which button you're holding.

You can select individual sectors with the mouse by moving the cursor inside the sector you want, holding '''[RIGHT ALT]''', and holding '''[RIGHT CTRL]''' as you release '''[RIGHT ALT]'''. The sector is now highlighted. This method of selection also works with '''[']''' and '''[;]''' to select/deselect additional sectors by mouse. Simply hold '''[RIGHT ALT]''' and the appropriate button depending on what you want to do, then hold '''[RIGHT CTRL]''' while releasing the other buttons. This becomes very quick and easy to do after doing it a few times.

==TROR Mapping Examples==

===Manhole Sewer Example===

In this straightforward example, you're going to make a manhole that goes below a street, and some area around the end of the hole at the bottom.

1. Create the child sector where you want the manhole to be.

2. Highlight the sector with '''[Right-Alt]'''.

3. Press '''[Ctrl-E]'''. Mapster will prompt you whether you want to extend up or down.

4. We want to extend down so press '''[Z]''' ('''[A]''' if you're extending up).

5. Go into side view mode with '''[F3]''', and move the viewpoint down until you're editing the bottom layer.

6. The child sector you created should now have a white boundary, with the street sectors above either greyed out or gone depending on your settings.

7. Now you can treat the manhole sector (the extension) as the very first room you've made on a new map. You can draw sectors on the side of it to attach some rooms there. If you go into 3D mode, you should be able to see that if you go down that manhole, there should now be some area at the bottom which overlaps the street. This was not previously possible without using some kind of cheap trick. Congratulations, you've just made TROR.

===Two Story Building Example===

I'm sure that a big reason that people want to use TROR is to build multiple story buildings, and this is how you do it.

1. Design the first floor of your building, both inside and out. This is going to be the first layer, which means the ceiling of every sector, especially the outdoor sectors should not be any higher than the roof of the first floor. Pretend that the second floor doesn't even exist.

2. Make your windows, doors, and anything you want.

Highlight with '''[Right-Alt]''' all of the ''outdoor'' sectors (the outdoor sectors should all have the same ceiling height, and should not be parallaxed). Knowing your advanced highlighting will come in useful here to select all the sectors.

3. Extend the highlighted area up, and make the top layer the active editing layer.

4. You should notice that the outline of your house has become completely white, and the area inside the house is empty. This is because this area is the second floor of your house.

5. Make a sector inside the house outline, this will be the room on the second floor of your house. Draw small sectors between that room and the house outline to create second floor windows. Alternatively you could just press '''[Ctrl-S]''' inside the house sector to make it a regular child sector, and if you go into 3D mode, you'll see your house has a roof you can stand on top of.

6. If you're learning TROR for the first time, it is very helpful at this point to go into 3D mode and press '''[i]''' to reveal the boundaries between layers so that you can understand what you've done.

7. You can connect the ground floor to the second floor the same way you'd connect two sector-over-sector sectors; by having a staircase or lift that connects to a different area on the top floor than it does on the bottom (because a lift for example cannot directly cross TROR layers, therefore it must be connected to sectors which do not overlap; i.e have the entrance on one side and the exit on the other.)
Or you can connect the ground floor and second floor via TROR and have some sprite stairs or something.

At this stage you should have a perfect two story house where you can look into and enter both stories. Cool stuff eh? ;)

There's nothing stopping you from going on to build a third.. forth.. fifth.. floor in the same manner either.

===TROR water example===

This is how you create transparent water using TROR. It works just like regular water, but there are a few things you need to be aware of.

1. Create a main sector, then a child sector in that and extend it downwards.

2. Make both the top and bottom of the TROR surface masked or transparent, and give it the water texture.

3. Give the floor of the top sector a lotag of 1 for water. Give the floor of the bottom sector a lotag of 2 for underwater.

4. Place an SE 7 with the same hitag in the same position in both the top and bottom sector.

5. This is the one that people normally forget. Set the TROR surface in both the top and bottom layer to BLOCKING otherwise it will not work as intended.

See, it's not too bad, just remember the lotags and the blocking. Note if you split up the water sector or add more sectors, make sure those sectors are in both the top and bottom layers, and have new SE 7s, just like normal water. In the future TROR water will be more automatic in that you won't need the SE 7, however this is incomplete as of this writing.

Something that might make life a bit easier is that if you extend the floor of the below-water sector downwards, you can then edit the floor of the new bottom layer and make as complex as you want without having to worry about placing lots of SE 7s.

===Retro-fitting via Joining Example===

If you're absolutely clueless with the whole idea of extending, or you want to go back and retrofit some TROR into maps you've done in the past, there's a very easy way of joining them to form TROR.
If you have two sectors that have the same shape, area, and external vertices have the same relative positions (essentially they're the same sector, at least as far as their edges are concerned), then all you have to do is highlight both sectors with '''[Right-Alt]''', and press '''[Ctrl-J]''' to join, the same as joining two sectors normally. It will then prompt you with a few questions such as which sector you want to have on top of the other, which sector(s) you want to move (doesn't matter most of the time), and whether you'd like to move all the connected non-TROR sectors as well (definitely yes).

The good thing about this method is that besides the questions you have to answer, mapster does everything automatically, it even moves the heights for you. Now there'll be a quick example of this method below.

1. Make a child sector in a larger sector and copy-paste it into void space.

2. Give the floor of the original child sector and the ceiling of the new sector the water texture.

3. Highlight both the child sector and new sector with '''[Right-Alt]'''.

4. Press '''[Ctrl-J]''' and answer the simple questions.

5. You should end up with a TROR water sector just as you would via the extension method. You can now alter the transparency of the water to your preference.

===Sandwiching and Sector Punching===
It's possible and easy to create a new TROR layer between two TROR layers. All you have to do is highlight one of them, and extend it as you would normally, and it automatically adds a new layer in the middle.

It's also possible to easily create an island sector in the middle of a TROR sector. This is called ''sector punching'', and mainly involves stamping a child sector into the sector below or above. Follow the example below.

1. Extend a sector downwards.

2. Create a child sector in the original sector.

3. Select the vertices of the child sector with '''[Right-Shift]''' or '''[R-Ctrl + R-Shift]''' and press '''[Ctrl-E]''' as though you're extending a sector.

4. It will prompt you whether to punch up or down, in this case, choose down and hit '''[Enter]'''. A sector identical in size, shape and position should now be in the bottom layer.

5. Point the mouse cursor at the child sector in the top layer and press '''[Ctrl-U]'''. It will prompt you whether you want to break the connection, and unless you press [Ctrl-U] accidentally, you usually do.

6. The child sector should now be a floating sector island. Have fun.

Note that '''[Ctrl-U]''' only breaks the connection of a single sector if that sector has been punched. Otherwise it'll break the connection of the entire bunch, which is usually bad.

===List of TROR maps===

This (hopefully up to date) list contains maps which make heavy use of the TROR feature in order to make a huge variety of constructions. They each contain a wealth of examples for you to look at to see what's possible and how it works/how to make it. This is not a complete list, as other maps make minor or simple use of the effect and hence are not listed here.

1. The trueror.map in the Samples folder included with eduke32 contains a large amount of random examples of TROR.

2. Retaliation is a small hi-tech map by Loke that was the first proper TROR map and makes some great use of the feature. [http://www.scent-88.com/reviews/R/retaliation/retaliation.php Download here]

3. Parkade is a large city themed map containing large multiple story buildings, along with a large amount of unique, pioneering uses of the feature, made by myself (Micky C) and Paul B. It is the largest, most extensive TROR map and perhaps the best example of what TROR is capable of so far, if I do say so myself. [http://www.scent-88.com/reviews/P/parkade/parkade.php Download here]

4. Brooklyn Bridge is another city themed map which also makes extensive and interesting use of TROR, such as an alien ship that flies over water, shooting rockets, and in vents. [http://www.scent-88.com/reviews/B/brooklyn/brooklyn.php Download here]

==Tricks and Effects with TROR==

===SE 13 destructible floor/ceiling===

If you have a TROR extension in the floor, you can place an SE 13 on it (facing downwards in 2D mode, and it will become a solid floor in-game (blocked and masked). When the hitag is activated, the TROR surface will become invisible as though a hole has just formed in the floor. You can place the SE 13 on the surface, or above, in which case the floor will initially have the height of the SE 13 just like with the original effect. You can also place it near the ceiling to make the SE 13 control the ceiling instead, or have one near the ceiling and one near the floor to control both.

When placed in a TROR extension with many sectors, it will not just control the sector, but rather the entire extension. So you can add sectors and give them different textures and don't have to worry about adding extra SE 13's. If you want to have TROR surfaces have different heights with different SE 13 sprites, they need to be different extensions; i.e they need to have a sector in both the top and bottom layer, and be extended individually.

The SE 13 also works with TROR slopes, allowing you to create relatively complex destructible objects compared to sprites. But remember that TROR is pretty wall hungry, so keep an eye on complexity.
Note that regardless of whether a TROR surface is set to masked or transparent in mapster, it will always become invisible after SE 13 activation.

===TROR water height manipulation===

TROR water can also be made to move up and down using the SE 31/32, much like the raising/lowering submergible water in e1l4 Toxic Dump. The effect is the same, however it's easier with TROR, because you only have to set up the effect on one side, either in the top layer or bottom layer, because this effect is set up so that if the ceiling of the bottom sector is moved, it moves the floor of the top sector as well, and vice versa.

==Visual Glitches and Workarounds==

===Software renderer===
Even though TROR sectors are already physically overlapping, the 8-bit software renderer still needs to render them separately, having to do an extra rendering pass for each additional TROR extension in view. Theoretically if you create a huge amount of extensions in the same area the framerate could potentially drop to unplayable levels, however this is far fetched and I wouldn't worry about it.

The real problem with the software renderer is HOM glitching. In each rendering pass, there can only be one area along the x-interval drawn. For example, if you have an island on the ground, the area between you and the island will be fine, but everything on the other side of the island will show HOM. Try it out yourself to see what I mean. Technically this means that TROR extensions cannot contain islands (although it's been kind of hacked in to do exta-extra passes to overcome this problem, I wouldn't rely on them for perfect drawing.)

However, this can be overcome by breaking up the sector surrounding the child sector, and extending each sector individually. This means there will be multiple drawing portals around the island instead of one big one, and none of the individual extensions would contain the island, hence it should draw fine.

This HOM doesn't just occur due to islands, it can also happen when part of a normal sector is jutting out into a TROR sector, this can be thought of here as a mini-island even though it's connected to something. Don't call it a mini-island, I only called it that to explain why it would cause that glitching. This means that TROR extensions should be ''convex'', i.e if you draw a straight line through a TROR portal so that it leaves the sector, and then comes back, it is not convex (and is most likely due to something jutting out.) However if you draw a line through it and this does not happen, as is the case for a circle, square etc.. then it is convex, and should draw fine.

Also note that currently the software renderer doesn't allow the player to see through more than 8 layers of TROR (it draws the texture on the surface instead). This normally isn't a problem in small sectors of TROR because the player typically won't be able to look up high enough to see the 8 layers due to vertical distortion. The limit could potentially be increased if someone desperately needed it (talk to the devs for that.)

Having void sectors (white-walled sectors with null space inside them) inside a TROR sector, or inside a sector adjacent to/bounding a TROR sector, it will cause visual glitches when viewed from some angles. Consider turning potential void sectors into child sectors, and raise the floor to the ceiling to fix this, as the result would look identical to having a void sector, but without the glitching.

===Polymer renderer===

'''Polymer is not actively developed at this time and should only be used as a last resort.'''

Masked floors and ceilings in polymer are always the last thing drawn on the screen. That means if you have a transparent surface such as a masked wall or sprite, it would cause everything all the TROR masked surfaces behind the transparent surface to stop being drawn and become invisible. There's no real work around for this, just try not to use masked walls or sprites with big transparent surfaces around TROR masked surfaces.

Other than that, polymer is by far the most stable renderer for TROR, and apart from what's written above, is 100% glitch free, though it may be slow sometimes. It works by drawing the entire scene, TROR and all in a single rendering pass. This means that it doesn't require any additional computer power to draw TROR, hence TROR will not affect the framerate in polymer.

===Polymost renderer===
The polymost renderer is bad, M'kay? It's like a comic relief in bad Hollywood films who can't do anything right. Don't use it. It has also been observed that some TROR constructions work perfectly on some computers, however are incredibly glitchy on others, so if you do decide to use this renderer, and TROR works for you, make sure you have two or three other people check it on their setups before you release your map. There are no plans to add complete polymost TROR compatibility as polymost will be obsolete once polymer is finished and optimised.

==Random Trivia==
Extended sectors can be sloped, but the bunch has to be 1:1 in that case. I.e you can't have any child sectors within a sloped TROR sector. If you want different TROR sectors with different slopes, you must use completely different extensions for that, as opposed to breaking up a single extension.

Maps containing one or more TROR bunches are saved in a new map format (v9) since some fields had to be taken over: xrepeat is unavailable on TROR'ed floors and ceilings, and on walls it's lotag if the ceiling, and extra if the floor of the wall's sector is extended. When in-game, these get transferred to internal arrays though.

The system is supposed to be used for 'large-scale' RoR, as a rule of thumb each affected sector should be at least a Duke high [that's too strict though].

[[Category:Level editing documentation]]

Setdefname

2020-07-20T01:45:05Z

Rob Anybody: Created page with "'''setdefname''' <name> Sets the name of the DEF file to load. Use this to override the default (for example duke3d.def)."

'''setdefname''' <name>

Sets the name of the DEF file to load. Use this to override the default (for example duke3d.def).

Setgamename

2020-07-20T01:43:24Z

Rob Anybody: Created page with "'''setgamename''' <name> Sets the name of the game as seen by the operating system. This name will appear in the title bar of the game window in windowed mode."

'''setgamename''' <name>

Sets the name of the game as seen by the operating system. This name will appear in the title bar of the game window in windowed mode.

EVENT SETDEFAULTS

2020-07-19T03:50:27Z

Rob Anybody: Fix typo

EVENT_SETDEFAULTS is [[EDuke32 event list|Game Event]].

This event is used when the game is initializing. It's the ideal place to change the value of [[Members_of_the_userdef_structure|userdefs]] if its only required to change them once.

It takes place after the game set the default settings, but before the .cfg files save / load them, meaning you can change the defaults settings of the game (as the name suggests). For example, if you change the value of [[screen_size]], that will be the status bar size that will be displayed in a clean installation.

[[Category:Events]]

Getticks

2020-07-18T16:49:15Z

Rob Anybody: This appears to be ticks since eduke32 started, not the OS.

'''getticks''' <gamevar>

Writes the amount of milliseconds(1 second = 1000 millisecond) since the game started to <gamevar>. This clock isn't synced with the game which means that it must not be used for the gameplay if the mod is supposed to work in multiplayer. This command is useful for visual animating(especially in [[EVENT_DISPLAYMENU]]) and for performance profiling.

Example code(animation)
<pre>
gamevar prevtick -1 0
gamevar curtick 0 0
gamevar tmp 0 0 // =curtick-prevtick

gamevar y 0 0

onevent EVENT_DISPLAYMENU
getticks curtick
ifvare prevtick -1 setvar tmp 0 else
{
setvarvar tmp curtick
subvarvar tmp prevtick
}

mulvar tmp 8800
addvarvar y tmp
ifvarg y 13107200 setvar y 0 // 200*65536=13107200
rotatesprite16 0 y 65536 0 0 0 0 26 0 0 xdim ydim

setvarvar prevtick curtick
endevent
</pre>

Example code(performance profiling)
<pre>
gamevar i 0 0
gamevar j 0 0

// Loop from 0 to NUMWALLS-1
state process_normal
setvar j 0
whilevarn j 1000
{
setvar i 0
whilevarvarn i NUMWALLS
{
addvar i 1
}
addvar j 1
}
ends

// Loop from NUMWALLS-1 to 0
state process_backward
setvar j 0
whilevarn j 1000
{
setvarvar i NUMWALLS
subvar i 1
whilevarn i -1
{
subvar i 1
}
addvar j 1
}
ends

onevent EVENT_ENTERLEVEL
gamevar val1 0 0
gamevar val2 0 0

addlogvar NUMWALLS

getticks val1
state process_normal
getticks val2
subvarvar val2 val1
addlogvar val2

getticks val1
state process_backward
getticks val2
subvarvar val2 val1
addlogvar val2
endevent
/*
output
CONLOGVAR: L=1266 NUMWALLS (read-only) (Global) =14793
CONLOGVAR: L=1272 val2 (Global) =1628 // normal
CONLOGVAR: L=1278 val2 (Global) =1285 // reverse

It shows how that processing in reverse order is faster.
*/
</pre>

[[Category:EDuke32 specific commands]]

Build/Mapster32 Keyboard Commands

2020-07-16T20:51:48Z

Rob Anybody: Add an example of ('C) command; remove message asking for explanation

== 3D Mode: Mouse ==

The purpose of mouse in 3D mode is pointing at some objects in a map and looking around ('''F3''' toggles mouse look).

Mouse pointer always points (see info about it at the bottom of the screen) at one of these objects:

# wall
# ceiling of sector
# floor of sector
# sprite
# masked wall (non-transparent or semi-transparent wall between sectors)

It's important to understand this concept:

* Some commands work differently depending on the current object (the object the mouse points at).
* Some commands manipulate only the current object
* Some commands manipulate the selected (also called "highlighted") sprites/sectors in 2D mode
* Some commands work globally.

===Mouse buttons===

{| class="wikitable"
| '''LEFT''' || lock the current object. The current object won't be changing as long as the button is pressed.
|-
| '''WHEEL''' || change shade ('''+CTRL''': in increments of 4)
|-
| '''WHEEL+ALT''' || change visibility
|-
| '''LEFT+WHEEL''' || change tile
|-
| '''RIGHT+WHEEL''' || move object up/down
|-
| '''MIDDLE''' || temporary mouse look (when not in UnrealEd-style mouse mode)
|}

Additionally, there is UnrealEd-style mouse navigation in 3D mode (toggle it with '''F5'''), with the following bindings:

{| class="wikitable"
| '''RIGHT''' || mouse look
|-
| '''LEFT''' || x: turning y: move forward/back
|-
| '''LEFT+RIGHT''' || x: strafe left/right y: move up/down
|-
| '''MIDDLE''' || y: move in viewing direction
|}

The console variable ''pk_uedaccel'' changes the speed of navigation exponentially (valid values are 0-5).

It is possible to move around objects using the mouse and holding down specific modifier keys:

{| class="wikitable"
| '''LEFT+ALT''' || move object up/down ('''+CTRL''': in larger increments)
|-
| '''LEFT+SHIFT''' || move sprite in horizontal plane ('''+CTRL''': grid-aligned)
|}

The two preceding controls also work on a set of sprites highlighted in 2D mode.

{| class="wikitable"
| '''LEFT+SHIFT''' || pan ceiling/floor/wall texture
|-
| '''LEFT+CTRL''' || scale wall texture or size of sprite
|-
| '''LEFT+CTRL''' || change slope of floor/ceiling
|}

== 3D Mode: Selecting Tile Mode ==

After pressing the '''V''' key in 3D mode, Mapster32 switches to "select tile" mode.

====Keys====

{| class="wikitable"
| '''UP/DOWN, LEFT/RIGHT, PGUP/PGDN, HOME/END''' || movements ('''CTRL''' modifies some commands)
|-
| '''KP /''' || zoom in
|-
| '''KP *''' || zoom out
|-
| '''Z''' || toggle tile zoom
|}

{| class="wikitable"
| '''G''' || goto specified tile
|-
| '''U''' || goto start of user defined art (3584)
|-
| '''A''' || goto start of Atomic edition's art (4096)
|-
| '''E''' || goto start of extended art (6144,9216)
|}

{| class="wikitable"
| '''S''' || Search for a named tile. When ^ is entered as the first character, anchor string at the beginning.
|}

{| class="wikitable"
| '''V''' || select from all tiles
|-
| '''T''' || select from pre-defined tile group which can be edited in tiles.cfg or added from within the tile selector. For this, press '''SPACE''' on the tiles to be grouped ('''CTRL-SPACE''' to select a range from starting from the last selection with '''SPACE'''). When you're ready, press '''Ctrl-G''' and you'll be queried for a group hotkey and name. The new tile group should now be saved persistently in tiles.cfg.
|}

{| class="wikitable"
| '''ESC''' || cancel
|-
| '''ENTER''' || accept
|}

====Mouse====

{| class="wikitable"
| '''LEFT''' || select
|-
| '''CTRL+WHEEL''' || zoom
|-
| '''WHEEL''' || scroll
|-
| '''RIGHT''' || smooth scrolling
|}

== 3D Mode: Keys ==

{| class="wikitable"
| '''UP''' || move forward
|-
| '''DOWN''' || move backward
|-
| '''LEFT+RCTRL''' || move left
|-
| '''RIGHT+RCTRL''' || move right
|-
| '''A''' || move up
|-
| '''Z''' || move down
|-
| '''+LSHIFT''' || speed up movements
|}

{| class="wikitable"
| '''LEFT''' || turn left
|-
| '''RIGHT''' || turn right
|-
| '''A+LALT''' || look down
|-
| '''Z+LALT''' || look up
|}

{| class="wikitable"
| '''F1''' || toggle help
|-
| '''F3''' || toggle mouselook
|-
| '''F4''' || toggle ambience sounds
|-
| '''F5''' || toggle UnrealEd-style mouse navigation
|-
| '''F6''' || toggle automatic SECTOREFFECTOR help
|-
| '''F7''' || toggle automatic sector tag help
|-
| '''F9''' || load and activate/deactivate maphacks
|-
| '''F11''' || brightness
|-
| '''F12''' || screenshot
|-
| '''F12+SHIFT''' || inverted screenshot
|}

{| class="wikitable"
| '''' V''' || set sector visibility
|-
| '''; V''' || set sector visibility on all selected sectors
|-
| '''V''' || choose tile
|-
| '''3''' || toggle Sector over Sector. See documentation here: http://www.users.on.net/~triforce/cduke3d/
|-
| '''' BACKSPACE''' || clear all flags for wall/sprite
|-
| '''BACKSPACE''' || clear nextwall ("red wall") link for aimed at wall
|-
| '''' P''' || paste palette to all selected sectors
|-
| '''; P''' || paste palette to all selected sectors & sprites
|}

{| class="wikitable"
| '''S''' || insert sprite
|-
| '''DEL''' || delete sprite
|-
| ''',''' || rotate sprite
|-
| '''.''' || rotate sprite
|-
| '''<''' || slowly rotate sprite
|-
| '''>''' || slowly rotate sprite
|}

'''.''' (period): search & fix panning of the wall to the right (''',''' (comma): to the left), has 3 modifiers:

* '''+SHIFT''': auto-align at most one wall
* '''+ALT''': (since r4361: don't) copy over texel width in world units (i.e. "how much the wall is stretched")
* '''+'''' (quote): align immediate upper and lower TROR neighbors

{| class="wikitable"
| '''SPACE''' || lock to object (same as left mouse button)
|-
| '''PGUP/PGDN+ALT''' || when aiming at red wall, select the floor or ceiling of the nextsector (useful for e.g. raising a lowered door when standing near it), depending on whether the aim is at the top or bottom of the wall
|}

{| class="wikitable"
| '''CAPS LOCK''' || cycle zmode
|-
| '''' Z''' || cycle zmode
|-
| '''' L''' || change the coordinates of the current object
|-
| '''' M''' || set the extra of the current object
|-
| '''1''' || toggle one sided sprite/wall
|-
| '''2''' || toggle bottom wall swapping
|-
| '''O''' || set top or bottom orientation of wall
|-
| '''O''' || ornament sprite onto wall
|-
| '''M''' || toggle masking wall
|-
| '''H''' || toggle hitscan sensitivity
|-
| '''H+SHIFT''' || toggle one side hitscan sensitivity for the wall
|-
| '''' H''' || set hitag of the current object
|}

{| class="wikitable"
| '''KP_MINUS''' || shades down individual sector/wall/sprite or selected sectors
|-
| '''KP_MINUS+ALT''' || decreases visibility of sector or selected sectors
|-
| '''KP_MINUS+ALT+SHIFT''' || slowly decreases visibility of sector or selected sectors
|-
| '''KP_MINUS+ALT+CTRL''' || decreases global visibility
|-
| '''KP_PLUS''' || shades up individual sector/wall/sprite or selected sectors
|-
| '''KP_PLUS+ALT''' || increases visibility of sector or selected sectors
|-
| '''KP_PLUS+ALT+SHIFT''' || slowly increases visibility of sector or selected sectors
|-
| '''KP_PLUS+ALT+CTRL''' || increases global visibility
|}

Note: '''ALT, CTRL, SHIFT''' are modifiers so they work with mouse too.

{| class="wikitable"
| '''PLUS/MINUS''' || cycle tile
|-
| '''E''' || toggle sector texture expansion
|-
| '''R''' || toggle sector texture relativity alignment
|-
| '''R''' || cycle sprite aligment between: wall aligned, floor aligned, view aligned
|-
| '''' R''' || toggle framerate
|-
| '''F''' || flip the current object ('''+SHIFT''': reverse direction)
|-
| '''F+ALT''' || set the first wall of sector
|}

{| class="wikitable"
| '''PAGE UP''' || move up selected sprites or sectors
|-
| '''PAGE DN''' || move down selected sprites or sectors
|-
| '''PAGE UP+CTRL''' || put selected sprites on ceiling
|-
| '''PAGE DN+CTRL''' || put selected sprites on ground
|-
| '''+CTRL''' || speed up movement
|-
| '''+END''' || slow down movement
|-
| '''+HOME''' || slow down movement even more
|}

Note: '''CTRL, HOME, END''' are modifiers so they work with mouse too.

{| class="wikitable"
| '''N''' || toggle 'no-autoshade'-bit of sprite
|-
| '''' I''' || toggle sprite invisibility
|-
| '''' D''' || cycle skill level
|-
| '''' X''' || toggle sprite shade and SE light effect preview
|-
| '''' W''' || toggle sprite display by class (no effectors/actors)
|-
| '''' Y''' || toggle purple background
|-
| '''' C''' || copy shade from the clipboard to all objects in the map which are the same tile as the tile of the object that in the clipboard. It works separately for sectors/walls/sprites depending on the current object. For example, if several walls use tile 123, and you darken one of them, copy with '''tab''', and hit '''' C''', all walls with tile 123 will take on the darker shade (but non-walls with tile 123 will remain unchanged).
|-
| '''' T''' || set lotag
|-
| '''' H''' || set hitag
|-
| '''' S''' || set shade
|-
| '''G''' || set picnum
|-
| '''B''' || toggle blocking
|-
| '''B+SHIFT''' || toggle one side blocking for the wall
|-
| '''T''' || cycles translucence for sprites/masked walls (and ceilings/floors for ROR)
|}

{| class="wikitable"
| '''F2''' || toggle clipboard preview
|-
| '''F2+SHIFT''' || toggle current sprite preview
|-
| '''TAB''' || copy to the clipboard
|-
| '''LENTER+CTRL+SHIFT''' || autoshade wall
|-
| '''' LENTER''' || paste picnum only
|-
| '''; LENTER''' || on ceilings/floors, auto-align with reference in '''TAB'''bed clipboard (incomplete for relative-aligned references)
|-
| '''LENTER+SHIFT''' || paste some visual (shading+pal) properties of the clipboard on sector/wall/sprite
|-
| '''LENTER+CTRL''' || paste some visual (picnum+shading+pal) properties of the clipboard on sector/wall/sprite
|-
| '''LENTER''' || paste all (picnum+shading+pal+flags+tags+extra) properties of the clipboard on sector/wall/sprite
|}

Note: some fields are only pasted if the type of 'thing' in the clipboard (wall/sprite/sector) equals that of the aimed at object

{| class="wikitable"
| '''C''' || toggle center sprite
|-
| '''ALT+C''' || replace all tiles in the map with one from the clipboard
|}

{| class="wikitable"
| '''' A''' || toggle autosave. The interval is configurable (default: every 3 minutes)
|}

{| class="wikitable"
| '''' N''' || toggle noclip for the camera
|-
| '''N+CTRL''' || toggle noclip for sprites
|}

{| class="wikitable"
| '''[''' || slopes up fast
|-
| '''[+RSHIFT''' || slope up with medium speed
|-
| '''[+LSHIFT''' || slope up slowly
|-
| '''[+ALT''' || align slope to the floor of adjoining sector
|-
| ''']''' || slope down fast
|-
| ''']+RSHIFT''' || slope down with medium speed
|-
| ''']+LSHIFT''' || slope down slowly
|-
| ''']+ALT''' || align slope to the ceiling of adjoining sector
|}

{| class="wikitable"
| '''KP_4''' || panning floor/ceiling horizontally
|-
| '''KP_6''' || panning floor/ceiling horizontally
|-
| '''KP_2''' || panning floor/ceiling vertically
|-
| '''KP_8''' || panning floor/ceiling vertically
|-
| '''KP_4''' || scaling wall/sprite horizontally
|-
| '''KP_6''' || scaling wall/sprite horizontally
|-
| '''KP_2''' || scaling wall/sprite vertically
|-
| '''KP_8''' || scaling wall/sprite vertically
|-
| '''+SHIFT''' or '''+ALT''' || force panning (for walls); the latter is an alternative if Shift-KP5-KP*-combinations are dead.
|-
| '''+KP_5''' || speed up
|}

{| class="wikitable"
| '''/''' || Reset panning, repeat and flags to defaults
|-
| '''/+SHIFT''' || set xrepeat to yrepeat (makes square)
|}

{| class="wikitable"
| '''P''' || enable/disable parallax
|-
| '''P+CTRL''' || change parallax type (works only in classic render, not saved into maps)
|-
| '''P+CTRL''' || Playtest map from current position
|-
| '''P+ALT+CTRL''' || Playtest map from start position
|-
| '''P+ALT''' || change pal of sector/wall/sprite
|-
| '''D+ALT''' || adjust clip distance of the sprite
|-
| '''RENTER''' || switch to 2D mode
|}

{| class="wikitable"
| '''S+CTRL''' || save map
|-
| '''L+CTRL''' || load last saved map
|}

{| class="wikitable"
| '''ESC''' || quit
|}

== 2D Mode: Mouse ==

The purpose of mouse in 2D mode is pointing, selecting, moving object in a map.

Every time mouse is pointing at one of these:

# Nothing
# Sector
# Sector and wall
# Sector and sprite
# Wall (wall without sector - map is corrupt)
# Sprite (sprite without sector - map is corrupt)

Some commands work differently depending on the current object (the object the mouse points at).

To solve the ambiguity between sectors and walls/sprites, one usually must press ALT to work with walls/sprites instead of sectors.

==='''RSHIFT''' (select vertices/sprites) modifiers===

* ''';''': set difference
* ''' ' ''' (quote character): set union

(note that they have to be depressed when '''RSHIFT''' is ''released'')

* '''RCTRL''' select only sprites (not walls)
* '''END''' select from all sectors, even grayed out ones

==='''RALT''' (select sectors) modifiers===

* ''';''': set difference
* ''' ' ''' (quote character): set union

(note that they have to be depressed when '''RALT''' is ''released'')

* when '''RCTRL''' is pressed at '''RALT''' release time, then for a sector to be selected, it must be "inside" the mouse pointer instead of being surrounded by the rectangle
* when holding '''RSHIFT''', will select all sectors, even grayed out ones

See the [[#TROR related keys|TROR section]] for '''HOME''' and '''END''' modifiers.

* '''WHEEL''' zoom
* '''WHEEL+ALT''' move camera and zoom
* '''LEFT BUTTON''' drag sectors/vertices/sprites
* '''RIGHT BUTTON''' move camera
* '''RIGHT MIDDLE''' move camera

* '''LSHIFT'''+'''LMB''' (with RSHIFT-highlighted points) interactively scale highlighted points (+'''CTRL''' forces square aspect)
* '''LSHIFT'''+'''RMB''' (with RSHIFT-highlighted points) interactively rotate highlighted points

If '''LSHIFT''' is released before the mouse button, the interactive scaling/rotation is canceled.

== 2D Mode: Keys ==
'''F1''' show help 
'''F2''' show sound index 
'''F3''' enter/quit side-view mode 
'''in side-view mode:''' 
* '''Q''', '''W''': orbit around center
* '''A''', '''Z''': change azimuth
* '''MMB''': change "player" z
* '''RMB''': change "player" x/y
'''F4''' toggle first wall preview 
'''F5''' show item count 
'''F6''' show actor count when pointed at wall 
'''F6''' show Sector Effector help when pointed at sprite 
'''F7''' edit sector data 
'''F8''' edit wall/sprite data 
'''F9''' show the Sector Tags help 
'''F10''' toggle 2D3D mode (3D preview window in 2D mode) 
'''F10+SHIFT''' resize 2D3D window 
'''CTRL+ARROWS''' move 2D3D window 
'''F12''' screenshot 
'''F12+SHIFT''' inverted screenshot 

'''SCROLL LOCK''' set starting position 

'''LSHIFT''' show coordinates/linking sprites 
'''LSHIFT+[''', '''LSHIFT+]''' cycle linking sprites 
 
'''M''' set extra of sector 
'''M+ALT''' set extra of wall/sprite 
'''/''' Reset panning, repeat and flags to defaults 
'''/+SHIFT''' set xrepeat to yrepeat (makes square) 

'''KP_4''' scaling sprite horizontally 
'''KP_6''' scaling sprite horizontally 
'''KP_2''' scaling sprite vertically 
'''KP_8''' scaling sprite vertically 
'''+KP_5''' speed up 
 
'''R''' cycle sprite alignment 
'''' S''' set sprite size 
'''' F''' function menu 
'''F7+ALT''' search sector lotag 
'''F8+ALT''' on wall: search wall lotag 
'''F8+ALT''' on sprite: generic sprite search 
'''[''' search backward 
''']''' search forward 
'''G''' cycle grid size 
'''G+SHIFT''' cycle grid size backward 
'''' L''' set sprite/wall coordinates 
'''' 3''' cycle modes of showing object's name 
'''' 7''' swap lotag and hitag of wall/sprite 
'''' J''' jump to position of object (asks for sector/wall/sprite, or x,y) 

'''[+ALT''' goto previous corruption 
''']+ALT''' goto next corruption 

'''X''' flip selected sectors in x 
'''Y''' flip selected sectors in y 
'''X+ALT''' mirror selected sectors in x 
'''Y+ALT''' mirror selected sectors in y 

'''B''' toggle blocking 
'''B+SHIFT''' toggle one side blocking for wall 
'''F+ALT''' set the first wall of sector 
'''O''' ornament sprite onto wall 

''',''' rotate sprite/selected sectors 
'''.''' rotate sprite/selected sectors 
'''<''' [i.e. ''',+SHIFT'''] slowly rotate sprite/selected sectors 
'''>''' [i.e. '''.+SHIFT'''] slowly rotate sprite/selected sectors 
''',+ALT''', '''.+ALT''' rotate highlighted sectors by a manually entered angle 
 
'''T''' set sector lotag 
'''T+ALT''' set wall/sprite lotag 
'''T+CTRL''' toggle show tags 

'''H''' set sector hitag 
'''H+ALT''' set wall/sprite hitag 
'''H+CTRL''' toggle hitscan sensitivity 
'''H+CTRL+SHIFT''' toggle hitscan sensitivity 

'''P''' set sector pal 
'''E''' set sprite status list 
'''TAB''' show sector data 
'''TAB+SHIFT''' show wall/sprite data 
'''TAB+CTRL''' enable/disable filling of aimed-at sector 

'''LCTRL+RSHIFT''' select all walls of the current sector (point at a wall and holding '''LCTRL''', press and release '''RSHIFT'''). Set ops (see RSHIFT above) work too. 
'''A''' zoom in 
'''Z''' zoom out 
'''L''' toggle grid lock 
'''J''' join sectors 
'''S''' insert sprite, pressing a key from '''1''' to '''0''' on the upper row before pressing '''S''' will make the inserted sprite's picnum be 1 to 10, respectively 
'''S+ALT''' make inner sector 
'''C''' duplicate sectors/sprites 
'''C''' start circle attached to a wall 
'''KP +''' increase amount of walls in circle 
'''KP -''' decrease amount of walls in circle 
 
'''SPACE''' start/end drawing of sector, end drawing of circle 
'''LENTER''' when having some walls drawn, insert points at intersections with existing walls; clear drawn walls then 
'''LENTER''' check nextwall pointer for the highlighted line 
'''LENTER''' when having drawn some walls, batch-insert points where the drawn lines intersect with non-grayed-out walls 
'''LSHIFT+LCTRL+LENTER''' check ALL pointers (manual attempt to recover map) 
'''BACKSPACE''' remove the last wall during drawing sector 
'''DEL''' delete sprite 
'''DEL+CTRL''' delete sector 
'''DEL+CTRL+LShift''' delete highlighted sectors 
'''INS''' duplicate sectors/sprites 
'''INS''' start circle attached to a wall 
'''INS''' add vertex to wall 
'''RENTER''' switch to 3D mode 
'''ESC''' menu 
 
'''' A''' toggle autosave(every 3 minutes) 
'''' N''' toggle noclip 
'''S+CTRL''' save map 
'''L+CTRL''' load map 

'''P+CTRL''' Playtest map from current position 
'''P+CTRL+ALT''' Playtest map from start position 

'''R+CTRL''' manual grayout: if some sectors are highlighted, make the editable z range [min ceiling z, max floor z] of those; else reset z limits

==TROR related keys==
===2D mode===
'''E+CTRL''' sector extension prompt (sectors to extend must be highlighted) 
'''E+CTRL''' make sandwich [''needs better explanation''] 
'''E+CTRL''' punch loop through extension (loop points must be highlighted, e.g. with '''RSHIFT'''+'''LCTRL''') 
 
'''A+CTRL''' toggle auto-grayout of non-extended sectors 
'''J+CTRL''' TROR-join sectors. The selection must consist of the two sets of sectors you wish to join. 
'''U+CTRL''' Clear extension: delete the bunch (i.e. ceiling-floor connection) of the aimed-at sector's floor 
'''PGUP'''/'''PGDN''' Change 'player' height in discrete steps in order to go through the different levels 
'''TAB+CTRL''' Display one currently aimed at sector (of potentially many that lie under the mouse crosshair) 
'''HOME''' and '''END''' (as modifiers to '''RALT'''): select all sectors whose floor's/ceiling's bunchnum equal the bunchnum of the aimed at sector (useful for further operations on whole bunches)

===3D mode===
'''I''' invisibility preview: toggle fake ROR texture on non-masked portals 
'''LENTER+CTRL''' When aiming at an extended floor/ceiling, paste to all floors/ceilings of the bunch of the aimed at one 
'''T''', '''B''' and '''H''' work as with walls, though they set/toggle the bits only on '''one''' side 

==Some console commands/variables==

See "help <console-command/var>" for help on a particular command/variable.

pk_quickmapcycling 
pk_uedaccel 
osd_tryscript 
sideview_reversehorizrot 
fixmaponsave_sprites 
show_heightindicators 
show_ambiencesounds 
corruptcheck_noalreadyrefd 
corruptcheck 

==Mapster32 keys as tables (unmaintained and obsolete)==

Below are the Mapster32 keys as three sortable tables. They are sorted such that the more 'basic' keys are at the top. 
 
The column headers have the following meaning: 

'''key/keys''': self-explanatory. Where a key starts with a '+' on a line of its own,     it means that it should be pressed simultaneously with the first one in the
same table row. 
'''type''': type of command: info=informational, edit=editing, navi=navigation,
disp=display, misc=miscellany 
'''sec''', '''spr''','''wal''': in case of an editing command, whether it
potentially acts on '''sec'''tors, '''spr'''ites, and/or '''wal'''ls. 
'''adv''': whether the command is 'advanced'. This is set somewhat arbitrarily. 
'''new''': whether the functionality of the command is new to Mapster32. An '''e''' means that it's enhanced from BUILD. 
'''N''': a running number. To restore the original order, sort by it.

{| class="wikitable sortable" border="1" cellpadding="2" cellspacing="0"
|+ '''Mapster 32 keys — shared keys for 2D and 3D mode'''
|- bgcolor="#f0f0f0"
! key/keys!!description!!type!!sec !!spr !!wal !!adv !!new !!N
|-
! F1
|help||info||||||||<center>n</center>||<center>'''y'''</center>||0
|-
! UP/DOWN LEFT/RIGHT   +LShift
|move forward/back turn left/right ('''+RCtrl''': strafe) speed up movements||navi||||||||<center>n</center>||<center>n</center>||1
|-
! RENTER
|toggle between 2D and 3D modes||misc||||||||<center>n</center>||<center>n</center>||2
|-
! B
|toggle blocking of wall/sprite ('''+Shift''': one-sided)||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||3
|-
! R
|cycle sprite aligment||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||4
|-
! ,/.
|rotate sprite ('''+Shift''': slowly)||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||5
|-
! DEL
|delete sprite||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||6
|-
! /
|reset panning, repeat and flags||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||7
|-
! Alt+F
|set first wall of sector||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||8
|-
! /+Shift
|set xrepeat to yrepeat (make square)||edit||||<center>'''x'''</center>||||<center>'''y'''</center>||<center>'''y'''</center>||9
|-
! \'N
|toggle camera clipping||navi||||||||<center>'''y'''</center>||<center>'''y'''</center>||10
|-
! Ctrl+N
|toggle sprite clipping through floors/ceilings||edit||||||||<center>'''y'''</center>||<center>'''y'''</center>||11
|-
! \'A
|toggle autosave (interval configurable in mapster32.cfg)||misc||||||||<center>'''y'''</center>||<center>'''y'''</center>||12
|-
! (Shift+)F12
|capture (inverted) screenshot||misc||||||||<center>n</center>||<center>n</center>||13
|-
! Ctrl+L
|load map||misc||||||||<center>n</center>||<center>n</center>||14
|-
! Ctrl+S
|save map||misc||||||||<center>n</center>||<center>n</center>||15
|-
! Ctrl+P
|playtest map from current position||misc||||||||<center>n</center>||<center>'''y'''</center>||16
|-
! Ctrl+Alt+P
|playtest map from starting position||misc||||||||<center>n</center>||<center>'''y'''</center>||17
|}

{| class="wikitable sortable" border="1" cellpadding="2" cellspacing="0"
|+ '''Mapster 32 keys — 2D mode'''
|- bgcolor="#f0f0f0"
! key/keys!!description!!type!!sec !!spr !!wal !!adv !!new !!N
|-
! A/Z
|zoom in/out||disp||||||||<center>n</center>||<center>n</center>||0
|-
! L
|toggle grid lock||edit||||||||<center>n</center>||<center>n</center>||1
|-
! G (+Shift)
|cycle grid size (backwards), set auto grid||edit||||||||<center>n</center>||<center>'''e'''</center>||2
|-
! S
|insert sprite (prefix 1-0 on upper row: set picnum to 1-10, resp.)||edit||||||||<center>n</center>||<center>'''e'''</center>||3
|-
! O
|ornament sprite onto wall||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||4
|-
! J
|join sectors||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||5
|-
! P
|set sector pal||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||6
|-
! Ctrl+H
|toggle hitscan sensitivity||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||7
|-
! T (+Alt)
|set lotag of sector (wall/sprite)||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||8
|-
! H (+Alt)
|set hitag of sector (wall/sprite)||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||9
|-
! KP4/6/2/8
|scale sprite (+'''KP5''': speed up)||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||10
|-
! SPACE
|draw sector; end circle drawing||edit||||||||<center>n</center>||<center>n</center>||11
|-
! BACKSPACE
|remove last wall when drawing sector||edit||||||||<center>n</center>||<center>n</center>||12
|-
! BACKSPACE
|cycle 2D display mode (textured/non-textured)||disp||||||||<center>'''y'''</center>||<center>'''y'''</center>||13
|-
! INS
|add vertex to wall||edit||||||<center>'''x'''</center>||<center>n</center>||<center>n</center>||14
|-
! DEL+Ctrl
|delete sector||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||15
|-
! C KP+/KP-
|start circle drawing from wall increase/decrease amount of walls in circle||edit||||||<center>'''x'''</center>||<center>n</center>||<center>n</center>||16
|-
! Alt+S
|make sector from inner loop||edit||||||||<center>n</center>||<center>n</center>||17
|-
! RShift    +;/'
|select group of walls and sprites set difference/union||edit||||||||<center>n</center>||<center>n</center>||18
|-
! RAlt    +;/'   +RCtrl
|select group of sectors set difference/union point sector selection||edit||||||||<center>n</center>||<center>n</center>||19
|-
! INS or C
|duplicate selected sectors/sprites||edit||||||||<center>n</center>||<center>n</center>||20
|-
! SCROLLLOCK
|set starting position||edit||||||||<center>n</center>||<center>n</center>||21
|-
! TAB
|show sector data||info||||||||<center>n</center>||<center>n</center>||22
|-
! TAB+Ctrl (or TAB+Shift)
|show wall/sprite data||info||||||||<center>n</center>||<center>'''y'''</center>||23
|-
! LShift
|show coords||info||||||||<center>n</center>||<center>'''y'''</center>||24
|-
! M (+Alt)
|set extra of sector (wall/sprite)||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>'''y'''</center>||25
|-
! E
|set sprite status list||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||26
|-
! Ctrl+T
|toggle show tags||disp||||||||<center>'''y'''</center>||<center>n</center>||27
|-
! '3
|cycle modes of showing object's name||disp||||||||<center>'''y'''</center>||<center>n</center>||28
|-
! '7
|swap lotag and hitag of wall/sprite||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>'''y'''</center>||29
|-
! 'J
|jump to position (X,Y)||misc||||||||<center>'''y'''</center>||<center>'''y'''</center>||30
|-
! 'S
|set sprite size||edit||||<center>'''x'''</center>||||<center>'''y'''</center>||<center>'''y'''</center>||31
|-
! 'L
|set wall/sprite coordinates||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>'''y'''</center>||32
|-
! 'F
|Special functions menu<blockquote>''Replace invalid tiles'' ''Delete all spr of tile #'' ''Set map sky shade'' ''Set map sky height'' ''Global Z coord shift'' ''Resize selection'' ''Global shade divide'' ''Global visibility divide''</blockquote>||edit||||||||<center>'''y'''</center>||<center>'''y'''</center>||33
|-
! X/Y (+Alt)
|flip (mirror) selected sectors in x/y||edit||<center>'''x'''</center>||||||<center>'''y'''</center>||<center>'''y'''</center>||34
|-
! F2
|show sound index (root CON file to fetch sound definitions from can be specified at startup; default is GAME.CON)||info||||||||<center>'''y'''</center>||<center>'''y'''</center>||35
|-
! F4
|toggle first wall highlighting||disp||||||||<center>'''y'''</center>||<center>'''y'''</center>||36
|-
! F5
|show item count||info||||||||<center>'''y'''</center>||<center>n</center>||37
|-
! F6
|show actor count (when pointed at sprite: SE help)||info||||||||<center>'''y'''</center>||<center>n</center>||38
|-
! F7
|edit sector data||edit||<center>'''x'''</center>||||||<center>'''y'''</center>||<center>'''y'''</center>||39
|-
! F8
|edit wall/sprite data||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>'''y'''</center>||40
|-
! F9
|show ST help||info||||||||<center>'''y'''</center>||<center>n</center>||41
|-
! F10
|show 3D preview window in 2D mode||disp||||||||<center>'''y'''</center>||<center>n</center>||41
|-
! Alt+F7
|search sector by tag||info||||||||<center>'''y'''</center>||<center>n</center>||42
|-
! Alt+F8
|search wall by tag/search sprite||info||||||||<center>'''y'''</center>||<center>'''e'''</center>||43
|-
! ]/[
|search forward/backward||info||||||||<center>'''y'''</center>||<center>n</center>||44
|-
! LCtrl+RShift
|select all walls of current sector (point at a wall and holding '''LCtrl''', press '''RShift''')||edit||||||||<center>'''y'''</center>||<center>'''y'''</center>||45
|-
! LENTER
|check pointers for current sector ('''+LCtrl+LShift''': check ALL pointers)||edit||||||||<center>'''y'''</center>||<center>n</center>||46
|}

{| class="wikitable sortable" border="1" cellpadding="2" cellspacing="0"
|+ '''Mapster 32 keys — 3D mode'''
|- bgcolor="#f0f0f0"
! key/keys!!description!!type!!sec !!spr !!wal !!adv !!new !!N
|-
! A/Z   +Ctrl   +LShift
|move up/down look down/up speed up movements||navi||||||||<center>n</center>||<center>n</center>||0
|-
! CAPSLOCK or 'Z
|cycle zmode||navi||||||||<center>n</center>||<center>n</center>||1
|-
! KP+/KP-
|change shade||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||2
|-
! KP+/KP-+Alt   +Alt+Shift   +Ctrl+Alt
|change visibility change visibility in smaller increments change global visibility||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||3
|-
! ]/[   +RShift   +LShift
|slope down/up smaller increments smallest increments ||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||4
|-
! [+Alt
|align slope to floor of adjoining sector||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||5
|-
! ]+Alt
|align slope to ceiling of adjoining sector||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||6
|-
! PGUP/PGDN   +END   +HOME
|move object up/down ('''+Ctrl''' on sectors: 4x) 1/2 of normal increments 1/4 of normal increments||edit||<center>'''x'''</center>||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||7
|-
! PGUP+Ctrl
|put sprite on ceiling||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||8
|-
! PGDN+Ctrl
|put sprite on ground||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||9
|-
! KP4/6/2/8   +Shift or +Alt   +KP5
|pan floor/ceiling or scale wall/sprite force panning speed up||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||10
|-
! V
|choose tile||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||11
|-
! S
|insert sprite||edit||||||||<center>n</center>||<center>n</center>||12
|-
! G
|set picnum||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>'''y'''</center>||13
|-
! E
|toggle sector texture expansion||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||14
|-
! F
|flip texture||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||15
|-
! R
|toggle sector texture relativity||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||16
|-
! 'T
|set lotag||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||17
|-
! 'H
|set hitag||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||18
|-
! 'S
|set shade||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||19
|-
! Alt+P
|set pal||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||20
|-
! 1
|toggle one sided sprite/wall||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||21
|-
! 2
|toggle bottom wall swapping||edit||||||<center>'''x'''</center>||<center>n</center>||<center>n</center>||22
|-
! M
|toggle masking wall||edit||||||<center>'''x'''</center>||<center>n</center>||<center>n</center>||23
|-
! O
|toggle wall orientation||edit||||||<center>'''x'''</center>||<center>n</center>||<center>n</center>||24
|-
! O
|ornament sprite onto wall||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||25
|-
! C
|toggle sprite centering||edit||||<center>'''x'''</center>||||<center>n</center>||<center>n</center>||26
|-
! H
|toggle hitscan sensitivity ('''+Shift''': one-sided)||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||27
|-
! T
|cycle translucence||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||28
|-
! P
|toggle parallax||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||29
|-
! 'V
|set sector visibility||edit||<center>'''x'''</center>||||||<center>n</center>||<center>n</center>||30
|-
! Ctrl+P (obsolete)
|change parallax type (classic renderer only)||edit||||||||<center>n</center>||<center>n</center>||31
|-
! .
|search & fix panning of the wall to the right||edit||||||<center>'''x'''</center>||<center>n</center>||<center>n</center>||32
|-
! 'L
|set coordinates||edit||<center>'''x'''</center>||<center>'''x'''</center>||||<center>n</center>||<center>'''y'''</center>||33
|-
! 'M
|set extra||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>'''y'''</center>||34
|-
! +/-
|cycle tile||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>'''y'''</center>||35
|-
! TAB
|copy to clipboard||edit||||||||<center>n</center>||<center>n</center>||36
|-
! LENTER
|paste all (pic+shade+pal+flags+tags+extra)||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>n</center>||<center>n</center>||37
|-
! 'LENTER
|paste picnum only||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>n</center>||38
|-
! LENTER+Shift
|paste shading+pal||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>n</center>||39
|-
! LENTER+Ctrl
|paste picnum+shading+pal||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>n</center>||40
|-
! Alt+C
|replace all "same" tiles with clipboard tile||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>n</center>||41
|-
! Alt+D
|adjust clipping distance of sprite||edit||||<center>'''x'''</center>||||<center>'''y'''</center>||<center>n</center>||42
|-
! ;V
|set sector visibility on all selected sectors||edit||<center>'''x'''</center>||||||<center>'''y'''</center>||<center>'''y'''</center>||43
|-
! 3
|toggle Sector over Sector (see http://www.users.on.net/~triforce/cduke3d/)||disp||||||||<center>'''y'''</center>||<center>'''y'''</center>||44
|-
! 'BACKSPACE
|clear all flags for wall/sprite||edit||||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>'''y'''</center>||45
|-
! 'P
|set palette of all sprites/walls/floors/ceilings (respectively) in all selected sectors||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>'''y'''</center>||46
|-
! ;P
|set palette of all sprites/walls/floors/ceilings in all selected sectors||edit||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''x'''</center>||<center>'''y'''</center>||<center>'''y'''</center>||47
|-
! Ctrl+Shift +LENTER
|autoshade wall||edit||||||<center>'''x'''</center>||<center>'''y'''</center>||<center>n</center>||48
|-
! F2
|toggle clipboard preview||info||||||||<center>'''y'''</center>||<center>'''y'''</center>||49
|-
! F2+Shift
|toggle current tile display||info||||||||<center>'''y'''</center>||<center>'''y'''</center>||50
|-
! F3
|toggle mouselook||misc||||||||<center>'''y'''</center>||<center>'''y'''</center>||51
|-
! F4
|toggle ambient sounds||misc||||||||<center>'''y'''</center>||<center>'''y'''</center>||52
|-
! F5
|toggle mouse navigation||navi||||||||<center>'''y'''</center>||<center>'''y'''</center>||53
|-
! F6
|toggle automatic SE help||info||||||||<center>'''y'''</center>||<center>'''y'''</center>||54
|-
! F7
|toggle automatic ST help||info||||||||<center>'''y'''</center>||<center>'''y'''</center>||55
|-
! F9
|reload and activate maphacks||disp||||||||<center>'''y'''</center>||<center>'''y'''</center>||56
|-
! F10
|disable maphacks||disp||||||||<center>'''y'''</center>||<center>'''y'''</center>||57
|-
! F11
|cycle brightness||misc||||||||<center>n</center>||<center>n</center>||58
|-
! 'D
|cycle skill level||disp||||||||<center>'''y'''</center>||<center>n</center>||59
|-
! 'X
|toggle sprite shade preview||disp||||||||<center>'''y'''</center>||<center>'''y'''</center>||60
|-
! 'W
|toggle sprite display||disp||||||||<center>'''y'''</center>||<center>n</center>||61
|-
! 'Y
|toggle purple background||disp||||||||<center>'''y'''</center>||<center>n</center>||62
|-
! 'C
|copy shade from clipboard to all "same" objects||edit||||||||<center>'''y'''</center>||<center>n</center>||63
|-
! 'R
|toggle framerate display||info||||||||<center>'''y'''</center>||<center>n</center>||64
|-
! Ctrl+T
|when pointing on a letter sprite: text entry tool (alphabets are configurable in tiles.cfg)||edit||||||||<center>'''y'''</center>||<center>'''y'''</center>||65
|}

For

2020-07-15T15:12:45Z

Rob Anybody: Add note about conditional evaluation

'''for''' <gamevar> <function> { [...] } 
'''for''' <gamevar> <function> <value> { [...] }

Executes the code in the curly braces for every instance of the function specified, and <[[gamevar]]> stores the sprite/sector/wall/etc found in the current function.

For example, setting <function> to '''allsprites''' will execute the code for every sprite in-game, and the var specified in <[[gamevar]]> will be set to the sprite number of the current sprite it's on.

== Functions ==

{| {{prettytable}}
| '''allsprites''' || All actors/sprites in-game.
|-
| '''allsectors''' || All sectors in the map.
|-
| '''allwalls''' || All walls in the map.
|-
| '''activelights''' '''lights''' || All active polymer lights.
|-
| '''drawnsprites''' || Only the sprites currently being drawn.
|-
| '''spritesofsector'''<sectnum> '''sprofsec'''<sectnum> || All sprites in the given sector.
|-
| '''spritesofstatus''' <statnum> '''sprofstat''' <statnum> || All sprites with the given [[statnum]].
|-
| '''wallsofsector''' <sectnum> '''walofsec''' <sectnum> || The walls of the given sector.
|-
| '''loopofwall''' <wall num> || All walls in the same loop of the given wall.
|-
| '''range''' <num> || A range from 0 to the number specified.
|}

Unlike other loop forms, the conditional statement is ''not'' re-evaluated each iteration. For example, the following loop will log 1 through 10:

var i
var j 10
for i range j {
add i 1 // only affects current iteration; log 1..10 instead of 0..9
sub j 1 // same as above; effectively does nothing in this example
al i
}

[[Category:EDuke32 specific commands]]

Extra

2020-07-12T16:13:34Z

Rob Anybody: Add a note about wall[].extra from https://voidpoint.io/terminx/eduke32/-/issues/92#note_1695

Extra is available for [[sector]], [[hittype]], [[sprite]], and [[Members of the wall structure|wall]] structs.

For [[sprite|sprites]], '''extra''' typically the actor-in-question's health value. It's also used to store the damage of hard-coded projectiles. See also [[htextra]].

For a [[sector|sector]], '''extra''' contains the value of any GSPEED sprites that were in the sector (Gspeed sprites are deleted when the level loads up)

For a [[wall|wall]], '''extra''' is reset to -1 at map load time in-game because the game uses the field for internal purposes. You can access the values before they're wiped in [[EVENT_PRELEVEL]], however.

[[Category:Sector structure members]]
[[Category:Sprite structure members]]
[[Category:Wall structure members]]

Randomseed

2020-07-12T15:11:22Z

Rob Anybody: Document randomseed

The value used to seed the shared "game" PRNG.

It is initially set to 1996. It can be set to an arbitrary value with [[getticks]]:

getticks randomseed

Note that the value of '''randomseed''' will ''change'' when invoking the PRNG through functions like [[randvar]]. If you want to record the seed for future play sessions, do it before invoking the generator.

[[Category:Constantly updated gamevars]]

Category:Gamevar manipulation

2020-07-09T23:32:24Z

Rob Anybody: Mention global var hoisting

== Definition ==
'''gamevar''' <varname> <value> <flags>

'''var''' <varname> <value> <flags>

A gamevar is a variable that can be used to store numerical data which can then be referenced between [[actor]]s, [[state]]s and [[event]]s. '''var''' is hereby semantically equivalent to '''gamevar'''.

The gamevar's flags define a bitmap that determines how the variable is treated by the game. For instance, a gamevar with flags of 0 is known as a global variable. A global variable exists once in the code, and any time a global variable is set, the new value is seen by all [[actor]]s and [[event]]s. A gamevar with flag bit 1 set is a per-player variable, which exists once for each player in the game. A gamevar with flag bit 2 set is a per-[[actor]] variable, which exists as many times in the code as there are [[sprite]]s in the map. This means that each [[sprite]] has its own copy of a per-[[actor]] variable stored in memory. '''Note that a gamevar can only be defined as either global, per-player, or per-actor, but not as a combination thereof.'''

Gamevars are stored as '''signed 32-bit integers''' and therefore have a value range of ''-2,147,483,648 (-231)'' to ''2,147,483,647 (231-1)''. Going above and below this range causes the value to overflow and underflow respectively.

Note that it is possible to omit the <value> and <flags> parameters entirely to define a global variable with an initial value of 0, with no other flags set. Example:
var TEMP1

It is also possible to chain flags separately at the end of the gamevar definition, instead of compiling them into a single value, as follows:
var TEMP2 10 1 4096 // This defines a per-player (1), read-only (4096) variable with initial value 10.

Keep in mind that global variables are still global, even when defined within a state block. The variable definition is effectively "hoisted," so the variable will not be reset to the initial value each time its definition is encountered.

The following pages contain information on basic gamevar operations as well as conditional statements:
*[[gamevar operators]]
*[[ifvar conditions]]

== Flags ==

The following table shows all currently defined gamevar flags. The first 2 are the only ones needed under normal circumstances, but one can also assign higher flags to user-defined gamevars (given that you know what you are doing).

{{gamevar flags}}

[[Category:All commands]]

Category:Gamearray manipulation

2020-07-08T17:50:12Z

Rob Anybody: Fix grammar, mention initial state

'''gamearray''' <name> <size> <flags>

A gamearray is a [[Scripting|CON]] version of the [[Wikipedia:Array|array data type]] common in programming languages. In a practical sense, a gamearray works like a global [[gamevar]] in which a different value can be set for each index. Similarly, gamearrays are not reset when a map is loaded.

The size parameter specifies how many values the array holds. Values in the array are accessed as <name>[<index>] with any command that reads from [[gamevar]]s. Values can be set with [[setarray]] or [[setarraysequence]]. All values are initialized to 0.

WARNING: As of the May 16, 2008 snapshot, some commands may crash when used with a gamearray, so to be safe, use [[setvarvar]] to copy the value to a [[gamevar]].

== Flags ==

{{Gamearray flags}}

[[Category:Gamevar manipulation]]

M32 script variables

2020-07-07T20:45:22Z

Rob Anybody: Add undocumented mapster events

{{Build Intro}}
{{M32Script Intro}}
----

This is a list of events, variables, arrays, constants and keys accessible in Mapster32-script.

==Events==
*EVENT_ENTER3DMODE
triggered upon entering 3D mode.
*EVENT_ANALYZESPRITES
continuously triggered event in 3D mode, used to modify the properties of drawn sprites for the current frame.
*EVENT_INSERTSPRITE2D
triggered after a sprite is inserted in 2D mode, sets the current sprite.
*EVENT_INSERTSPRITE3D
triggered after a sprite is inserted in 3D mode, sets the current sprite.
*EVENT_DRAW2DSCREEN
triggered after the screen has been drawn in 2D mode, can be used to implement additional drawing.
*EVENT_DRAW3DSCREEN
triggered after the scene, but before the overlays have been drawn in 3D mode.
*EVENT_KEYS2D
continuously triggered event in 2D mode after most key checks have been made.
*EVENT_KEYS3D
continuously triggered event in 3D mode after most key checks have been made.
*EVENT_PREKEYS2D
continuously triggered event in 2D mode before most key checks have been made.
*EVENT_PREKEYS3D
continuously triggered event in 3D mode before most key checks have been made.
*EVENT_LINKTAGS
triggered by the link-tagging system to query whether the tag of a particular sprite (which is the [[Mapster32 Scripting|current sprite]] in this event) has a linking meaning. It is supposed to return in RETURN a bit-field of ORed values: 
1: lotag has linking semantics 
2: hitag 
4: extra 
8: xvel 
16: yvel 
32: zvel 
64: owner 
*EVENT_KEYPRESS
called when a key is pressed or released.
*EVENT_PREDRAW3DSCREEN
triggered before the scene has been drawn in 3D mode.
*EVENT_LOADMAP
called after a map is loaded, including blank map on startup.
*EVENT_SAVEMAP
called after a map is saved.
*EVENT_PRELOADMAP
called before a map is loaded, including blank map on startup.
*EVENT_PRESAVEMAP
called before a map is saved.
*EVENT_PREDRAW2DSCREEN
triggered before the screen has been drawn in 2D mode, can be used to implement additional drawing.
*EVENT_GETNUMBER
(needs description)

The PRE*-versions of the key handling events are recommended when you want to override default keys. However, careless use may lead to a binding of a key to multiple functions. Therefore the _KEYS(2|3)D events will activate after most hardcoded key checks, making overriding keys impossible.

==Variables==
Legend:
'''''write-enabled variable'''''

=====variables used or set by various commands=====
*'''''RETURN''''' (also used in [[Sort]])
*'''''LOTAG'''''
*'''''HITAG'''''
*'''''TEXTURE'''''
*''I'' (capital i; current sprite)
*'''''DOSCRSHOT''''', if set to non-zero, schedules saving a screenshot between the next scene drawing and EVENT_DRAW3DSCREEN

=====video variables=====
*''xdim''
*''ydim''
*''windowx1''
*''windowx2''
*''windowy1''
*''windowy2''
*''rendmode''

=====misc. variables=====
*''totalclock'' (incremented by 120 per second)
See [[Setaspect]] for the following two variables
*''viewingrange''
*''yxaspect''
*'''''randomseed'''''
*''numwalls''
*''numsectors''
*''numsprites''
*''numtiles''
variables used in '''sort'''
*''SV1''
*''SV2''

number of drawn sprites (valid in EVENT_ANALYZESPRITES)
*''spritesortcnt''

=====position and orientation of "mapper arrow"=====
*'''''posx'''''
*'''''posy'''''
*'''''posz'''''
*'''''ang'''''
*'''''horiz'''''
*''cursectnum'' (use '''updatecursectnum''' after changing position)

====="aiming" and selection variables=====
mouse pointer screen coordinates
*''searchx''
*''searchy''
Mouse "aiming" variables in 3D mode.
searchstat describes what is being aimed at:
0:wall 1:ceiling 2:floor 3:sprite 4:masked wall
*''searchstat''
''searchwall'' is the index of the aimed at sprite if ''searchstat'' equals 3, the index of the aimed at wall if ''searchstat'' equals 0 or 4, and the index of the wall that intersects the ray from the current position to the aimed at point (as seen from above) otherwise.
*''searchwall''
*''searchsector''
''searchbottomwall'' is only valid if ''searchstat'' equals 0 and differs from ''searchwall'' only if the "swap bottom wall" (key '2') is set.
*''searchbottomwall''
''pointhighlight'' holds the current highlighted (blinking) point
or sprite in 2D mode.
If ''pointhighlight'' is less than 16384, then its value
is the wall index of the highlighted point (A wall in BUILD
actually only holds coordinates for one point; the wall[].point2
is the other end point of the wall). Otherwise, ''pointhighlight''-16384
is a sprite index of the currently highlighted sprite.
*''pointhighlight''
*''linehighlight''
''highlightcnt'' is the number of currently highlighted (semi-permanently, with RSHIFT) points and sprites.
*''highlightcnt''
''highlightsectorcnt'' is the number of currently highlighted (permanently, with RALT) sectors.
*''highlightsectorcnt''
In 2D mode, ''mousxplc'' and ''mousyplc'' are the BUILD coordinates under the current mouse crosshair position.
*''mousxplc''
*''mousyplc''

=====clipboard contents=====
*''temppicnum''
*''tempcstat''
*''templotag''
*''temphitag''
*''tempextra''
*''tempshade''
*''temppal''
*''tempvis''
*''tempxrepeat''
*''tempyrepeat''

=====start position=====
*''startposx''
*''startposy''
*''startposz''
*''startang''
*''startsectnum''

=====variables useful for 2D drawing=====
A ''zoom'' of 16384 corresponds to a scale of one pixel per BUILD unit.
*''zoom''
''drawlinepat'' is the stroke pattern for the 2D drawing function, e.g. 0xffffffff (-1) is a continuous line, 0x0000ffff is a broken line (long intervals) and 0x55555555 is a dotted line.
*'''''drawlinepat'''''
*''halfxdim16''
*''midydim16''
*''ydim16''

==Arrays==
'''Legend''': 
'''X''': deprecated/do not use (yet)

The following is a listing of all accessible arrays along with their size in brackets. Where the size is variable, it indicates the maximum allowable index plus 1. 
All of the builtin arrays are read-only.
 
''highlight'' is an array of highlighted points/sprites. Its elements follow the same convention as the `pointhighlight' variable (see above).
*highlight[''highlightcnt'']
''highlightsector'' is an array of highlighted sectors.
*highlightsector[''highlightsectorcnt'']

These are the (head|next|prev)sprite(stat|sect) arrays.
*hsect[MAXSECTORS+1]
*nsect[MAXSPRITES]
*psect[MAXSPRITES]
*hstat[MAXSTATUS+1]
*nstat[MAXSPRITES]
*pstat[MAXSPRITES]

The ''tilesiz''(''x''/''y'') arrays are indexed by tile numbers and hold the x/y dimensions
of the loaded tiles. If a tile doesn't exist, they will be 0.
*tilesizx[MAXTILES]
*tilesizy[MAXTILES]

*show2dsector[(MAXSECTORS+7)>>3] '''X''' (doesn't appear to contain highlighted sectors)
*show2dwall[(MAXWALLS+7)>>3]
''show2dsprite'' is a bitmap of which sprites are highlighted with '''RSHIFT'''.
*show2dsprite[(MAXSPRITES+7)>>3]

*keystatus[256] Indexed by scancodes (= KEY_?? constants)
*alphakeys[27] Contains scancodes of SPACE ([0]) and A through Z ([1] - [26]) keys.
*numberkeys[10] Contains scancodes of '''0''' to '''9''' keys.

==Constants==
*CLIPMASK0
*CLIPMASK1

*MAXSPRITES
*MAXSECTORS
*MAXWALLS
*MAXTILES
MAXSTATUS is useful for checking whether a sprite number is valid (i.e, whether
a sprite with the given sprite number is in the map). This is the case if
sprite[spritenum].statnum is lower than MAXSTATUS. It is needed because sprite
numbers need not be contiguous during a session.
*MAXSTATUS
*MAXSOUNDS
*NO
*COLOR_WHITE (used with 3D text commands)

==Keys==
*KEY_SPACE, KEY_A through KEY_Z (in alphakeys[])
*KEY_0 through KEY_9 (in numberkeys[])
*KEY_ENTER, KEY_BS, KEY_TAB
*KEY_DASH, KEY_EQUAL, KEY_LBRACK, KEY_RBRACK, KEY_SEMI, KEY_QUOTE, KEY_BQUOTE, KEY_BSLASH, KEY_COMMA, KEY_PERIOD, KEY_SLASH
*KEY_LALT, KEY_LCTRL, KEY_LSHIFT, KEY_RALT, KEY_RCTRL, KEY_RSHIFT
Keypad keys:
*KEY_gDEL, KEY_gDOWN, KEY_gEND, KEY_gHOME, KEY_gINS, KEY_gKP5, KEY_gLEFT, KEY_gMINUS, KEY_gPGDN, KEY_gPGUP, KEY_gPLUS, KEY_gRIGHT, KEY_gSLASH, KEY_gSTAR, KEY_gUP
*KEY_HOME, KEY_UP, KEY_PGUP, KEY_LEFT, KEY_RIGHT, KEY_END , KEY_DOWN, KEY_PGDN, KEY_INSERT, KEY_DELETE
Some aliases for keypad keys:
*KEY_KP0 through KEY_KP9, KEY_KPCOMMA

[[Category:Level editing documentation]]

Mapster32 Scripting

2020-07-07T19:51:33Z

Rob Anybody: Mention m32_autoexec.cfg

{{Build Intro}}
{{M32Script Intro}}
----

Mapster32 can be scripted by using a language derived from CON. You can either issue commands directly to the editor with the "'''do'''" OSD command or load a script file (extension: .m32) by using "'''include''' <filename>" on the console or in '''m32_autoexec.cfg'''. ''Events'', ''states'' and ''quotes'' can be redifined, while multiple definitions of ''defines'', ''gamevars'' and ''gamearrays'' are ignored.

== Events ==

Events are defined in the same way as in CON (with '''onevent''' and '''endevent'''), but must be enabled at the console (with "'''enableevent''' <event name or number>" or "'''enableevent all'''") to take effect. Simply using "'''enableevent'''" shows a list of defined events and their activation state.

== States ==

States (subroutines) are defined between '''defstate''' and '''ends''' and are called by using '''state'''. Specifying "1" for a '''gamevar''' flag will make that variable block-local, that is, every event and state, as well as the top level (in interactive execution) will have its own value of the variable.

== Syntax changes from CON ==

*Structures and arrays can be written anywhere a gamevar is expected, even where they are written to.
*Some commands have short forms. In particular, all commands that contain ''varvar'' can be written without it, e.g. '''ifvarvarl''' becomes '''ifl'''.
*Some commands are of variable length, depending on preceding parameters. See '''sort''' and '''for''' in [[M32 script commands]].
*"sprite[''I'']" can be omitted. (See below: current sprite). In other words, the current sprite's members can be accessed by simply prepending their name with a period, like ".picnum".
*Some commands accept variables in place of constants.

== The current sprite ==

Some commands, like '''ifactor''', act on an implicit ''current sprite''. The current sprite is set by various commands (implicitly by '''for''', '''insertsprite''' and '''dupsprite''', and explicitly with '''seti''') as well as some events (EVENT_INSERTSPRITE2D, EVENT_INSERTSPRITE3D). The current sprite index is held in the gamevar ''I'' (capital i). The command '''for''' is a special case because whether and how the current sprite is set depends on the iteration type.

== Key access ==

To define custom shortcuts, you need to place appropriate checks for pressed keys in the desired event. This is accomplished by using '''ifholdkey''' and '''ifhitkey'''. The difference between the two is that the latter will reset the key status while the former will continue to act until the user releases the key. See [[M32 script variables]] for events that are fired every interation of the main loop.

== Drawn sprite access ==

Sprites that are drawn to the screen are accessed in the EVENT_ANALYZESPRITES event using the ''tsprite[].xxx'' sprite array, which can be indexed from 0 to ''spritesortcnt''-1. To loop over all of them, use "'''for i drawnsprites'''". The index of the actual sprite that was drawn is held in ''tsprite[i].owner''.

[[Category:Level editing documentation]]

Category:All commands

2020-07-07T02:44:24Z

Rob Anybody: Whoops, looks like range is only for mapster32

{{EDuke32 Intro}}

==Preprocessor==
*[[include]]
*[[includedefault]]
*[[define]]
*// single-line comment
*/* block comment */
*whitespace characters: <code>( ) ; ,</code>
==Meta-Settings==

*[[dynamicremap]]
*[[dynamicsoundremap]]
*[[setcfgname]]
*[[setdefname]]
*[[setgamename]]
*[[precache]]
*[[scriptsize]]
*[[cheatkeys]]
*[[definecheat]]
*[[definegamefuncname]]
*[[definegametype]]
*[[definevolumename]]
*[[definevolumeflags]]
*[[definelevelname]]
*[[defineskillname]]
*[[undefinevolume]]
*[[undefinelevel]]
*[[undefineskill]]
===If===
*[[ifrespawn]]
*[[ifmultiplayer]]
*[[ifclient]]
*[[ifserver]]
==Global Settings==

*[[gamestartup]]
*[[spritenopal]]
*[[spritenoshade]]
*[[spritenvg]]
*[[spriteshadow]]
==Block Delimiting==
===Object-Oriented===
*[[actor]]
*[[useractor]]
*[[enda]]
===Procedural===
*[[onevent]]
*[[appendevent]]
*[[endevent]]

===Subroutines===
*[[state]]
*[[defstate]]
*[[ends]]

==Flow Control==
===If Components===
*[[nullop]]
*[[else]]
===Switch===
*[[switch]]
*[[endswitch]]
*[[case]]
*[[default]]
===Termination===
*[[break]]
*[[return]]
===Jump===
:''Note: Jumping commands are deprecated and will not be supported by Lunatic. Use [[#Loops|loops]] instead.''
*[[getcurraddress]]
*[[jump]]

===Loops===
*[[whilevarl]]
*[[whilevarvarl]]
*[[whilevarn]]
*[[whilevarvarn]]
:''It is also possible to loop by calling a state from within itself.''

==Game Variables==
*[[gamevar]]
*[[gamearray]]
===Gamevar Operators===
*[[setvar]]
*[[setvarvar]]
*[[setarray]]
*[[addvar]]
*[[addvarvar]]
*[[subvar]]
*[[subvarvar]]
*[[mulvar]]
*[[mulvarvar]]
*[[divvar]]
*[[divvarvar]]
*[[modvar]]
*[[modvarvar]]
*[[andvar]]
*[[andvarvar]]
*[[orvar]]
*[[orvarvar]]
*[[xorvar]]
*[[xorvarvar]]
*[[randvar]]
*[[randvarvar]]
===Gamevar Conditions===
*[[ifvare]]
*[[ifvarn]]
*[[ifvarg]]
*[[ifvarl]]
*[[ifvarand]]
*[[ifvaror]]
*[[ifvarxor]]
*[[ifvareither]]
*[[ifvarvare]]
*[[ifvarvarn]]
*[[ifvarvarg]]
*[[ifvarvarl]]
*[[ifvarvarand]]
*[[ifvarvaror]]
*[[ifvarvarxor]]
*[[ifvarvareither]]
===Math Operations===
*[[sqrt]]
*[[calchypotenuse]]
*[[sin]]
*[[cos]]
*[[shiftvarl]]
*[[shiftvarr]]
*[[mulscale]]
*[[getangle]]
*[[getincangle]]
===Array Operations===
*[[getarraysize]]
*[[getarraysequence]]
*[[resizearray]]
*[[copy]]
*[[setarray]]
*[[setarraysequence]]

===Data Saving===
*[[readgamevar]]
*[[savegamevar]]
*[[readarrayfromfile]]
*[[writearraytofile]]
==Structure Access==
*[[getactor]]
*[[getactorvar]]
*[[getinput]]
*[[getplayer]]
*[[getplayervar]]
*[[getprojectile]]
*[[getsector]]
*[[getthisprojectile]]
*[[gettspr]]
*[[getuserdef]]
*[[getwall]]
*[[setactor]]
*[[setactorvar]]
*[[setinput]]
*[[setplayer]]
*[[setplayervar]]
*[[setprojectile]]
*[[setsector]]
*[[setthisprojectile]]
*[[settspr]]
*[[setuserdef]]
*[[setwall]]
==Actors==
===Structures===
*[[cactor]] 
*[[action]] 
*[[ai]] 
*[[move]] 
*[[count]] 
*[[resetactioncount]] 
*[[resetcount]] 
*[[cstat]] 
*[[cstator]] 
*[[clipdist]] 
*[[sizeat]] 
*[[sizeto]] 
*[[strength]] 
*[[addstrength]] 
*[[spritepal]] 
*[[getlastpal]] 
*[[sleeptime]] 
*[[spriteflags]] 
*[[angoff]] 
*[[angoffvar]] 
*[[changespritesect]] 
*[[changespritestat]] 
*[[setsprite]] 
====If====
*[[ifactor]]
*[[ifaction]]
*[[ifactioncount]]
*[[ifai]]
*[[ifcount]]
*[[ifmove]]
*[[ifspawnedby]]
*[[ifspritepal]]
*[[ifstrength]]
*[[ifhitweapon]]
*[[ifwasweapon]]
*[[ifdead]]
*[[ifactornotstayput]]
===Commands===
*[[fall]]
*[[insertspriteq]]
*[[killit]]
*[[movesprite]]
*[[ssp]]
*[[clipmove]]
*[[clipmovenoslide]]
===Measurements===
*[[dist]]
*[[ldist]]
*[[cansee]]
*[[canseespr]]
===Surroundings===
====Commands====
*[[hitradius]]
*[[hitradiusvar]]
*[[flash]]
====If====
*[[ifawayfromwall]]
*[[ifbulletnear]]
*[[ifceilingdistl]]
*[[iffloordistl]]
*[[ifgapzl]]
*[[ifsquished]]
*[[ifnotmoving]]
*[[ifinwater]]
*[[ifonwater]]
*[[ifoutside]]
*[[ifinspace]]
*[[ifinouterspace]]
*[[ifrnd]] 
===Mapping Features===
*[[mikesnd]]
*[[respawnhitag]]
===Player Interaction===
*[[ifangdiffl]]
*[[ifcansee]]
*[[ifcanseetarget]]
*[[ifcanshoottarget]]
*[[ifhitspace]]
*[[getangletotarget]]
===Spawning===
*[[spawn]]
*[[espawn]]
*[[espawnvar]]
*[[qspawn]]
*[[qspawnvar]]
*[[eqspawn]]
*[[eqspawnvar]]
===Materials===
*[[debris]]
*[[guts]]
*[[lotsofglass]]
*[[mail]]
*[[money]]
*[[paper]]
==Projectiles==
*[[defineprojectile]]
*[[shoot]]
*[[shootvar]]
*[[eshoot]]
*[[eshootvar]]
*[[zshoot]]
*[[zshootvar]]
*[[ezshoot]]
*[[ezshootvar]]
==Player==
===Commands===
*[[addammo]]
*[[addinventory]]
*[[addweapon]]
*[[addweaponvar]]
*[[addphealth]]
*[[tossweapon]]
*[[gmaxammo]]
*[[smaxammo]]
*[[checkavailinven]]
*[[checkavailweapon]]
*[[addkills]]
*[[lockplayer]]
*[[resetplayer]]
*[[resetplayerflags]]
===If===
*[[ifgotweaponce]]
*[[ifp]]
*[[ifpdistg]]
*[[ifpdistl]]
*[[ifphealthl]]
*[[ifpinventory]]
*[[ifplayersl]]
==Sectors==
===Operating===
*[[operate]]
*[[operateactivators]]
*[[operatemasterswitches]]
*[[operaterespawns]]
*[[operatesectors]]
*[[activatebysector]]
*[[activate]]
===Manipulation===
*[[dragpoint]]
*[[sectsetinterpolation]]
*[[sectclearinterpolation]]
===Analysis===
*[[getceilzofslope]]
*[[getflorzofslope]]
*[[getzrange]]
*[[updatesector]]
*[[updatesectorz]]
*[[checkactivatormotion]]
*[[rotatepoint]]
*[[lineintersect]]
*[[rayintersect]]
*[[sectorofwall]]
==Discovery==
===Searching===
*[[findnearactor]]
*[[findnearactor3d]]
*[[findnearactor3dvar]]
*[[findnearactorvar]]
*[[findnearactorz]]
*[[findnearactorzvar]]
*[[findnearsprite]]
*[[findnearsprite3d]]
*[[findnearsprite3dvar]]
*[[findnearspritevar]]
*[[findnearspritez]]
*[[findnearspritezvar]]
*[[findotherplayer]]
*[[findplayer]]
*[[neartag]]
*[[hitscan]]
===Sorting===
*[[headspritesect]]
*[[headspritestat]]
*[[nextspritesect]]
*[[nextspritestat]]
*[[prevspritesect]]
*[[prevspritestat]]
==Audio==
===Sounds===
*[[definesound]]
*[[sound]]
*[[soundvar]]
*[[soundonce]]
*[[soundoncevar]]
*[[globalsound]]
*[[globalsoundvar]]
*[[screensound]]
*[[stopsound]]
*[[stopsoundvar]]
*[[stopactorsound]]
*[[stopallsounds]]
*[[ifsound]]
*[[ifactorsound]]
*[[ifnosounds]]
*[[setactorsoundpitch]]
===Music===
*[[music]]
*[[starttrack]]
*[[starttrackvar]]
*[[getmusicposition]]
*[[setmusicposition]]
==Quotes==
*[[definequote]]
*[[redefinequote]]
*[[quote]]
*[[userquote]]
*[[qsprintf]]
*[[qstrcpy]]
*[[qstrcat]]
*[[qstrncat]]
*[[qstrlen]]
*[[qsubstr]]
*[[qstrdim]]
*[[qgetsysstr]]
*[[getpname]]
*[[getkeyname]]
==Cutscenes==
*[[startcutscene]]
*[[ifcutscene]]
==Screen==
===Screen Manipulation===
*[[palfrom]]
*[[guniqhudid]]
*[[setgamepalette]]
*[[setaspect]]
===Player Actions===
*[[wackplayer]]
*[[quake]]
*[[pkick]]
*[[pstomp]]
*[[tip]]
===Screen Drawing===
*[[rotatesprite]]
*[[rotatesprite16]]
*[[rotatespritea]]
*[[screentext]]
*[[gametext]]
*[[gametextz]]
*[[minitext]]
*[[digitalnumber]]
*[[digitalnumberz]]
*[[showview]]
*[[showviewunbiased]]
===Math===
*[[displayrand]]
*[[displayrandvar]]
*[[displayrandvarvar]]
==Time Access==
*[[getticks]]
*[[gettimedate]]
==Game-Changing==
*[[activatecheat]]
*[[startlevel]]
*[[inittimer]]
*[[endofgame]]
*[[endoflevel]]
*[[cmenu]]
==Game Saving==
*[[save]]
*[[savenn]]
===Hub Maps===
*[[loadmapstate]]
*[[savemapstate]]
*[[clearmapstate]]
==Debug==
*[[debug]]
*[[addlog]]
*[[addlogvar]]
*[[echo]]
==Deprecated==
*[[betaname]]
*[[enhanced]]
*[[eventloadactor]]
*[[time]]
*[[shadeto]]
===Screen Drawing===
*[[myos]]
*[[myosx]]
*[[myospal]]
*[[myospalx]]
===Single-Use Structure Access===
*[[getactorangle]]
*[[getplayerangle]]
*[[gettextureceiling]]
*[[gettexturefloor]]
*[[sectgethitag]]
*[[sectgetlotag]]
*[[spgethitag]]
*[[spgetlotag]]
*[[setactorangle]]
*[[setplayerangle]]

[[Category:Scripting documentation]]

Full command list

2020-07-07T02:42:59Z

Rob Anybody: Undo revision 13911 by Rob Anybody (talk)

{{EDuke32 Intro}}

This is a list of every CON primitive in EDuke32.

<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
*[[abs]]
*[[action]]
*[[activate]]
*[[activatebysector]]
*[[activatecheat]]
*[[actor]]
*[[actorsound]]
*[[add]]
*[[addammo]]
*[[addinventory]]
*[[addkills]]
*[[addlog]]
*[[addlogvar]]
*[[addphealth]]
*[[addstrength]]
*[[addvar]]
*[[addvarvar]]
*[[addweapon]]
*[[addweaponvar]]
*[[ai]]
*[[al]]
*[[and]]
*[[andvar]]
*[[andvarvar]]
*[[angoff]]
*[[angoffvar]]
*[[appendevent]]
*[[array]]
*[[betaname]]
*[[break]]
*[[cactor]]
*[[calchypotenuse]]
*[[cansee]]
*[[canseespr]]
*[[capia]]
*[[capis]]
*[[case]]
*[[changespritesect]]
*[[changespritestat]]
*[[cheatkeys]]
*[[checkactivatormotion]]
*[[checkavailinven]]
*[[checkavailweapon]]
*[[ck]]
*[[clamp]]
*[[clearmapstate]]
*[[clipdist]]
*[[clipmove]]
*[[clipmovenoslide]]
*[[cmenu]]
*[[copy]]
*[[cos]]
*[[count]]
*[[cstat]]
*[[cstator]]
*[[damageeventtile]]
*[[damageeventtilerange]]
*[[dc]]
*[[dcd]]
*[[debris]]
*[[debug]]
*[[default]]
*[[define]]
*[[definecheat]]
*[[definecheatdescription]]
*[[definegamefuncname]]
*[[definegametype]]
*[[definelevelname]]
*[[defineprojectile]]
*[[definequote]]
*[[defineskillname]]
*[[definesound]]
*[[definevolumeflags]]
*[[definevolumename]]
*[[defstate]]
*[[digitalnumber]]
*[[digitalnumberz]]
*[[displayrand]]
*[[displayrandvar]]
*[[displayrandvarvar]]
*[[dist]]
*[[div]]
*[[divr]]
*[[divrd]]
*[[divru]]
*[[divscale]]
*[[divvar]]
*[[divvarvar]]
*[[dragpoint]]
*[[drawline256]]
*[[drawlinergb]]
*[[dynamicremap]]
*[[dynamicsoundremap]]
*[[echo]]
*[[else]]
*[[enda]]
*[[endevent]]
*[[endofgame]]
*[[endoflevel]]
*[[ends]]
*[[endswitch]]
*[[enhanced]]
*[[eqspawn]]
*[[eqspawnvar]]
*[[eshoot]]
*[[eshootvar]]
*[[espawn]]
*[[espawnvar]]
*[[eventloadactor]]
*[[ezshoot]]
*[[ezshootvar]]
*[[fall]]
*[[findnearactor3d]]
*[[findnearactor3dvar]]
*[[findnearactor]]
*[[findnearactorvar]]
*[[findnearactorz]]
*[[findnearactorzvar]]
*[[findnearsprite3d]]
*[[findnearsprite3dvar]]
*[[findnearsprite]]
*[[findnearspritevar]]
*[[findnearspritez]]
*[[findnearspritezvar]]
*[[findotherplayer]]
*[[findplayer]]
*[[flash]]
*[[for]]
*[[gamearray]]
*[[gamestartup]]
*[[gametext]]
*[[gametextz]]
*[[gamevar]]
*[[geta]]
*[[getactor]]
*[[getactorangle]]
*[[getactorvar]]
*[[getangle]]
*[[getangletotarget]]
*[[getarrayseq]]
*[[getarraysequence]]
*[[getarraysize]]
*[[getav]]
*[[getceilzofslope]]
*[[getclosestcol]]
*[[getcurraddress]]
*[[getflorzofslope]]
*[[getgamefuncbind]]
*[[geti]]
*[[getincangle]]
*[[getinput]]
*[[getkeyname]]
*[[getlastpal]]
*[[getmusicposition]]
*[[getp]]
*[[getplayer]]
*[[getplayerangle]]
*[[getplayervar]]
*[[getpname]]
*[[getprojectile]]
*[[getpv]]
*[[gets]]
*[[getsector]]
*[[gettextureceiling]]
*[[gettexturefloor]]
*[[getthisprojectile]]
*[[getticks]]
*[[gettiledata]]
*[[gettimedate]]
*[[gettspr]]
*[[getu]]
*[[getuserdef]]
*[[getw]]
*[[getwall]]
*[[getzrange]]
*[[globalsound]]
*[[globalsoundvar]]
*[[gmaxammo]]
*[[guniqhudid]]
*[[guts]]
*[[headspritesect]]
*[[headspritestat]]
*[[hitradius]]
*[[hitradiusvar]]
*[[hitscan]]
*[[ifa]]
*[[ifaction]]
*[[ifactioncount]]
*[[ifactor]]
*[[ifactornotstayput]]
*[[ifactorsound]]
*[[ifae]]
*[[ifai]]
*[[ifand]]
*[[ifangdiffl]]
*[[ifawayfromwall]]
*[[ifb]]
*[[ifbe]]
*[[ifboth]]
*[[ifbulletnear]]
*[[ifcansee]]
*[[ifcanseetarget]]
*[[ifcanshoottarget]]
*[[ifceilingdistl]]
*[[ifclient]]
*[[ifcount]]
*[[ifcutscene]]
*[[ifdead]]
*[[ife]]
*[[ifeither]]
*[[iffloordistl]]
*[[ifg]]
*[[ifgapzl]]
*[[ifge]]
*[[ifgotweaponce]]
*[[ifhitspace]]
*[[ifhitweapon]]
*[[ifinouterspace]]
*[[ifinspace]]
*[[ifinwater]]
*[[ifl]]
*[[ifle]]
*[[ifmove]]
*[[ifmultiplayer]]
*[[ifn]]
*[[ifnosounds]]
*[[ifnotmoving]]
*[[ifonwater]]
*[[ifor]]
*[[ifoutside]]
*[[ifp]]
*[[ifpdistg]]
*[[ifpdistl]]
*[[ifphealthl]]
*[[ifpinventory]]
*[[ifplaybackon]]
*[[ifplayersl]]
*[[ifrespawn]]
*[[ifrnd]]
*[[ifserver]]
*[[ifsound]]
*[[ifspawnedby]]
*[[ifspritepal]]
*[[ifsquished]]
*[[ifstrength]]
*[[ifvara]]
*[[ifvarae]]
*[[ifvarand]]
*[[ifvarb]]
*[[ifvarbe]]
*[[ifvarboth]]
*[[ifvare]]
*[[ifvareither]]
*[[ifvarg]]
*[[ifvarge]]
*[[ifvarl]]
*[[ifvarle]]
*[[ifvarn]]
*[[ifvaror]]
*[[ifvarvara]]
*[[ifvarvarae]]
*[[ifvarvarand]]
*[[ifvarvarb]]
*[[ifvarvarbe]]
*[[ifvarvarboth]]
*[[ifvarvare]]
*[[ifvarvareither]]
*[[ifvarvarg]]
*[[ifvarvarge]]
*[[ifvarvarl]]
*[[ifvarvarle]]
*[[ifvarvarn]]
*[[ifvarvaror]]
*[[ifvarvarxor]]
*[[ifvarxor]]
*[[ifwasweapon]]
*[[ifxor]]
*[[include]]
*[[includedefault]]
*[[inittimer]]
*[[insertspriteq]]
*[[inv]]
*[[jump]]
*[[killit]]
*[[klabs]]
*[[ldist]]
*[[lineintersect]]
*[[loadmapstate]]
*[[lockplayer]]
*[[lotsofglass]]
*[[mail]]
*[[mikesnd]]
*[[minitext]]
*[[mod]]
*[[modvar]]
*[[modvarvar]]
*[[money]]
*[[move]]
*[[movesector]]
*[[movesprite]]
*[[mul]]
*[[mulscale]]
*[[mulvar]]
*[[mulvarvar]]
*[[music]]
*[[myos]]
*[[myospal]]
*[[myospalx]]
*[[myosx]]
*[[neartag]]
*[[nextsectorneighborz]]
*[[nextspritesect]]
*[[nextspritestat]]
*[[nullop]]
*[[onevent]]
*[[operate]]
*[[operateactivators]]
*[[operatemasterswitches]]
*[[operaterespawns]]
*[[operatesectors]]
*[[or]]
*[[orvar]]
*[[orvarvar]]
*[[palfrom]]
*[[paper]]
*[[pkick]]
*[[precache]]
*[[preloadtrackslotforswap]]
*[[prevspritesect]]
*[[prevspritestat]]
*[[print]]
*[[pstomp]]
*[[qgetsysstr]]
*[[qputs]]
*[[qspawn]]
*[[qspawnvar]]
*[[qsprintf]]
*[[qstrcat]]
*[[qstrcmp]]
*[[qstrcpy]]
*[[qstrdim]]
*[[qstrlen]]
*[[qstrncat]]
*[[qsubstr]]
*[[quake]]
*[[quote]]
*[[rand]]
*[[randvar]]
*[[randvarvar]]
*[[rayintersect]]
*[[readarrayfromfile]]
*[[readgamevar]]
*[[redefinequote]]
*[[resetactioncount]]
*[[resetcount]]
*[[resetplayer]]
*[[resetplayerflags]]
*[[resizearray]]
*[[respawnhitag]]
*[[return]]
*[[rotatepoint]]
*[[rotatesprite16]]
*[[rotatesprite]]
*[[rotatespritea]]
*[[save]]
*[[savegamevar]]
*[[savemapstate]]
*[[savenn]]
*[[scalevar]]
*[[screenpal]]
*[[screensound]]
*[[screentext]]
*[[scriptsize]]
*[[sectclearinterpolation]]
*[[sectgethitag]]
*[[sectgetlotag]]
*[[sectorofwall]]
*[[sectsetinterpolation]]
*[[set]]
*[[seta]]
*[[setactor]]
*[[setactorangle]]
*[[setactorsoundpitch]]
*[[setactorvar]]
*[[setarray]]
*[[setarrayseq]]
*[[setarraysequence]]
*[[setaspect]]
*[[setav]]
*[[setcfgname]]
*[[setdefname]]
*[[setgamename]]
*[[setgamepalette]]
*[[seti]]
*[[setinput]]
*[[setmusicposition]]
*[[setp]]
*[[setplayer]]
*[[setplayerangle]]
*[[setplayervar]]
*[[setprojectile]]
*[[setpv]]
*[[sets]]
*[[setsector]]
*[[setsprite]]
*[[setthisprojectile]]
*[[settiledata]]
*[[settspr]]
*[[setu]]
*[[setuserdef]]
*[[setvar]]
*[[setvarvar]]
*[[setw]]
*[[setwall]]
*[[shadeto]]
*[[shiftl]]
*[[shiftr]]
*[[shiftvarl]]
*[[shiftvarr]]
*[[shiftvarvarl]]
*[[shiftvarvarr]]
*[[shoot]]
*[[shootvar]]
*[[showview]]
*[[showviewq16]]
*[[showviewq16unbiased]]
*[[showviewunbiased]]
*[[sin]]
*[[sizeat]]
*[[sizeto]]
*[[sleeptime]]
*[[smaxammo]]
*[[sound]]
*[[soundonce]]
*[[soundoncevar]]
*[[soundvar]]
*[[spawn]]
*[[spawnceilingglass]]
*[[spawnwallglass]]
*[[spawnwallstainedglass]]
*[[spgethitag]]
*[[spgetlotag]]
*[[spriteflags]]
*[[spritenopal]]
*[[spritenoshade]]
*[[spritenvg]]
*[[spritepal]]
*[[spriteshadow]]
*[[sqrt]]
*[[ssp]]
*[[startcutscene]]
*[[startlevel]]
*[[startscreen]]
*[[starttrack]]
*[[starttrackslot]]
*[[starttrackvar]]
*[[state]]
*[[stopactorsound]]
*[[stopallmusic]]
*[[stopallsounds]]
*[[stopsound]]
*[[stopsoundvar]]
*[[strength]]
*[[string]]
*[[sub]]
*[[subvar]]
*[[subvarvar]]
*[[swaparrays]]
*[[swaptrackslot]]
*[[switch]]
*[[time]]
*[[tip]]
*[[tossweapon]]
*[[udc]]
*[[undefinecheat]]
*[[undefinegamefunc]]
*[[undefinelevel]]
*[[undefineskill]]
*[[undefinevolume]]
*[[updatesector]]
*[[updatesectorneighbor]]
*[[updatesectorneighborz]]
*[[updatesectorz]]
*[[useractor]]
*[[userquote]]
*[[var]]
*[[wackplayer]]
*[[whilel]]
*[[whilen]]
*[[whilevarl]]
*[[whilevarn]]
*[[whilevarvarl]]
*[[whilevarvarn]]
*[[writearraytofile]]
*[[xor]]
*[[xorvar]]
*[[xorvarvar]]
*[[zshoot]]
*[[zshootvar]]
</div>

[[Category:Scripting documentation]]

Addlogvar

2020-07-07T01:42:36Z

Rob Anybody: Mention "al" synonym on addlogvar page.

'''addlogvar''' <[[gamevar]]>

Prints the value of <[[gamevar]]> to the console, resulting in it being logged to eduke32.log.

The '''addlogvar''' command can be abbreviated as '''addlog''' or '''al'''.

[[Category:EDuke commands]]

Addlogvar

2020-07-07T01:39:25Z

Rob Anybody: Mention addlog synonym on addlogvar page.

Addlog

2020-07-07T01:37:07Z

Rob Anybody: Have addlog redirect to addlogvar; they do the same thing.

#REDIRECT [[Addlogvar]]

Full command list

2020-07-06T20:32:08Z

Rob Anybody: Link to undocumented "range" command

{{EDuke32 Intro}}

This is a list of every CON primitive in EDuke32.

<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
*[[abs]]
*[[action]]
*[[activate]]
*[[activatebysector]]
*[[activatecheat]]
*[[actor]]
*[[actorsound]]
*[[add]]
*[[addammo]]
*[[addinventory]]
*[[addkills]]
*[[addlog]]
*[[addlogvar]]
*[[addphealth]]
*[[addstrength]]
*[[addvar]]
*[[addvarvar]]
*[[addweapon]]
*[[addweaponvar]]
*[[ai]]
*[[al]]
*[[and]]
*[[andvar]]
*[[andvarvar]]
*[[angoff]]
*[[angoffvar]]
*[[appendevent]]
*[[array]]
*[[betaname]]
*[[break]]
*[[cactor]]
*[[calchypotenuse]]
*[[cansee]]
*[[canseespr]]
*[[capia]]
*[[capis]]
*[[case]]
*[[changespritesect]]
*[[changespritestat]]
*[[cheatkeys]]
*[[checkactivatormotion]]
*[[checkavailinven]]
*[[checkavailweapon]]
*[[ck]]
*[[clamp]]
*[[clearmapstate]]
*[[clipdist]]
*[[clipmove]]
*[[clipmovenoslide]]
*[[cmenu]]
*[[copy]]
*[[cos]]
*[[count]]
*[[cstat]]
*[[cstator]]
*[[damageeventtile]]
*[[damageeventtilerange]]
*[[dc]]
*[[dcd]]
*[[debris]]
*[[debug]]
*[[default]]
*[[define]]
*[[definecheat]]
*[[definecheatdescription]]
*[[definegamefuncname]]
*[[definegametype]]
*[[definelevelname]]
*[[defineprojectile]]
*[[definequote]]
*[[defineskillname]]
*[[definesound]]
*[[definevolumeflags]]
*[[definevolumename]]
*[[defstate]]
*[[digitalnumber]]
*[[digitalnumberz]]
*[[displayrand]]
*[[displayrandvar]]
*[[displayrandvarvar]]
*[[dist]]
*[[div]]
*[[divr]]
*[[divrd]]
*[[divru]]
*[[divscale]]
*[[divvar]]
*[[divvarvar]]
*[[dragpoint]]
*[[drawline256]]
*[[drawlinergb]]
*[[dynamicremap]]
*[[dynamicsoundremap]]
*[[echo]]
*[[else]]
*[[enda]]
*[[endevent]]
*[[endofgame]]
*[[endoflevel]]
*[[ends]]
*[[endswitch]]
*[[enhanced]]
*[[eqspawn]]
*[[eqspawnvar]]
*[[eshoot]]
*[[eshootvar]]
*[[espawn]]
*[[espawnvar]]
*[[eventloadactor]]
*[[ezshoot]]
*[[ezshootvar]]
*[[fall]]
*[[findnearactor3d]]
*[[findnearactor3dvar]]
*[[findnearactor]]
*[[findnearactorvar]]
*[[findnearactorz]]
*[[findnearactorzvar]]
*[[findnearsprite3d]]
*[[findnearsprite3dvar]]
*[[findnearsprite]]
*[[findnearspritevar]]
*[[findnearspritez]]
*[[findnearspritezvar]]
*[[findotherplayer]]
*[[findplayer]]
*[[flash]]
*[[for]]
*[[gamearray]]
*[[gamestartup]]
*[[gametext]]
*[[gametextz]]
*[[gamevar]]
*[[geta]]
*[[getactor]]
*[[getactorangle]]
*[[getactorvar]]
*[[getangle]]
*[[getangletotarget]]
*[[getarrayseq]]
*[[getarraysequence]]
*[[getarraysize]]
*[[getav]]
*[[getceilzofslope]]
*[[getclosestcol]]
*[[getcurraddress]]
*[[getflorzofslope]]
*[[getgamefuncbind]]
*[[geti]]
*[[getincangle]]
*[[getinput]]
*[[getkeyname]]
*[[getlastpal]]
*[[getmusicposition]]
*[[getp]]
*[[getplayer]]
*[[getplayerangle]]
*[[getplayervar]]
*[[getpname]]
*[[getprojectile]]
*[[getpv]]
*[[gets]]
*[[getsector]]
*[[gettextureceiling]]
*[[gettexturefloor]]
*[[getthisprojectile]]
*[[getticks]]
*[[gettiledata]]
*[[gettimedate]]
*[[gettspr]]
*[[getu]]
*[[getuserdef]]
*[[getw]]
*[[getwall]]
*[[getzrange]]
*[[globalsound]]
*[[globalsoundvar]]
*[[gmaxammo]]
*[[guniqhudid]]
*[[guts]]
*[[headspritesect]]
*[[headspritestat]]
*[[hitradius]]
*[[hitradiusvar]]
*[[hitscan]]
*[[ifa]]
*[[ifaction]]
*[[ifactioncount]]
*[[ifactor]]
*[[ifactornotstayput]]
*[[ifactorsound]]
*[[ifae]]
*[[ifai]]
*[[ifand]]
*[[ifangdiffl]]
*[[ifawayfromwall]]
*[[ifb]]
*[[ifbe]]
*[[ifboth]]
*[[ifbulletnear]]
*[[ifcansee]]
*[[ifcanseetarget]]
*[[ifcanshoottarget]]
*[[ifceilingdistl]]
*[[ifclient]]
*[[ifcount]]
*[[ifcutscene]]
*[[ifdead]]
*[[ife]]
*[[ifeither]]
*[[iffloordistl]]
*[[ifg]]
*[[ifgapzl]]
*[[ifge]]
*[[ifgotweaponce]]
*[[ifhitspace]]
*[[ifhitweapon]]
*[[ifinouterspace]]
*[[ifinspace]]
*[[ifinwater]]
*[[ifl]]
*[[ifle]]
*[[ifmove]]
*[[ifmultiplayer]]
*[[ifn]]
*[[ifnosounds]]
*[[ifnotmoving]]
*[[ifonwater]]
*[[ifor]]
*[[ifoutside]]
*[[ifp]]
*[[ifpdistg]]
*[[ifpdistl]]
*[[ifphealthl]]
*[[ifpinventory]]
*[[ifplaybackon]]
*[[ifplayersl]]
*[[ifrespawn]]
*[[ifrnd]]
*[[ifserver]]
*[[ifsound]]
*[[ifspawnedby]]
*[[ifspritepal]]
*[[ifsquished]]
*[[ifstrength]]
*[[ifvara]]
*[[ifvarae]]
*[[ifvarand]]
*[[ifvarb]]
*[[ifvarbe]]
*[[ifvarboth]]
*[[ifvare]]
*[[ifvareither]]
*[[ifvarg]]
*[[ifvarge]]
*[[ifvarl]]
*[[ifvarle]]
*[[ifvarn]]
*[[ifvaror]]
*[[ifvarvara]]
*[[ifvarvarae]]
*[[ifvarvarand]]
*[[ifvarvarb]]
*[[ifvarvarbe]]
*[[ifvarvarboth]]
*[[ifvarvare]]
*[[ifvarvareither]]
*[[ifvarvarg]]
*[[ifvarvarge]]
*[[ifvarvarl]]
*[[ifvarvarle]]
*[[ifvarvarn]]
*[[ifvarvaror]]
*[[ifvarvarxor]]
*[[ifvarxor]]
*[[ifwasweapon]]
*[[ifxor]]
*[[include]]
*[[includedefault]]
*[[inittimer]]
*[[insertspriteq]]
*[[inv]]
*[[jump]]
*[[killit]]
*[[klabs]]
*[[ldist]]
*[[lineintersect]]
*[[loadmapstate]]
*[[lockplayer]]
*[[lotsofglass]]
*[[mail]]
*[[mikesnd]]
*[[minitext]]
*[[mod]]
*[[modvar]]
*[[modvarvar]]
*[[money]]
*[[move]]
*[[movesector]]
*[[movesprite]]
*[[mul]]
*[[mulscale]]
*[[mulvar]]
*[[mulvarvar]]
*[[music]]
*[[myos]]
*[[myospal]]
*[[myospalx]]
*[[myosx]]
*[[neartag]]
*[[nextsectorneighborz]]
*[[nextspritesect]]
*[[nextspritestat]]
*[[nullop]]
*[[onevent]]
*[[operate]]
*[[operateactivators]]
*[[operatemasterswitches]]
*[[operaterespawns]]
*[[operatesectors]]
*[[or]]
*[[orvar]]
*[[orvarvar]]
*[[palfrom]]
*[[paper]]
*[[pkick]]
*[[precache]]
*[[preloadtrackslotforswap]]
*[[prevspritesect]]
*[[prevspritestat]]
*[[print]]
*[[pstomp]]
*[[qgetsysstr]]
*[[qputs]]
*[[qspawn]]
*[[qspawnvar]]
*[[qsprintf]]
*[[qstrcat]]
*[[qstrcmp]]
*[[qstrcpy]]
*[[qstrdim]]
*[[qstrlen]]
*[[qstrncat]]
*[[qsubstr]]
*[[quake]]
*[[quote]]
*[[rand]]
*[[randvar]]
*[[randvarvar]]
*[[range]]
*[[rayintersect]]
*[[readarrayfromfile]]
*[[readgamevar]]
*[[redefinequote]]
*[[resetactioncount]]
*[[resetcount]]
*[[resetplayer]]
*[[resetplayerflags]]
*[[resizearray]]
*[[respawnhitag]]
*[[return]]
*[[rotatepoint]]
*[[rotatesprite16]]
*[[rotatesprite]]
*[[rotatespritea]]
*[[save]]
*[[savegamevar]]
*[[savemapstate]]
*[[savenn]]
*[[scalevar]]
*[[screenpal]]
*[[screensound]]
*[[screentext]]
*[[scriptsize]]
*[[sectclearinterpolation]]
*[[sectgethitag]]
*[[sectgetlotag]]
*[[sectorofwall]]
*[[sectsetinterpolation]]
*[[set]]
*[[seta]]
*[[setactor]]
*[[setactorangle]]
*[[setactorsoundpitch]]
*[[setactorvar]]
*[[setarray]]
*[[setarrayseq]]
*[[setarraysequence]]
*[[setaspect]]
*[[setav]]
*[[setcfgname]]
*[[setdefname]]
*[[setgamename]]
*[[setgamepalette]]
*[[seti]]
*[[setinput]]
*[[setmusicposition]]
*[[setp]]
*[[setplayer]]
*[[setplayerangle]]
*[[setplayervar]]
*[[setprojectile]]
*[[setpv]]
*[[sets]]
*[[setsector]]
*[[setsprite]]
*[[setthisprojectile]]
*[[settiledata]]
*[[settspr]]
*[[setu]]
*[[setuserdef]]
*[[setvar]]
*[[setvarvar]]
*[[setw]]
*[[setwall]]
*[[shadeto]]
*[[shiftl]]
*[[shiftr]]
*[[shiftvarl]]
*[[shiftvarr]]
*[[shiftvarvarl]]
*[[shiftvarvarr]]
*[[shoot]]
*[[shootvar]]
*[[showview]]
*[[showviewq16]]
*[[showviewq16unbiased]]
*[[showviewunbiased]]
*[[sin]]
*[[sizeat]]
*[[sizeto]]
*[[sleeptime]]
*[[smaxammo]]
*[[sound]]
*[[soundonce]]
*[[soundoncevar]]
*[[soundvar]]
*[[spawn]]
*[[spawnceilingglass]]
*[[spawnwallglass]]
*[[spawnwallstainedglass]]
*[[spgethitag]]
*[[spgetlotag]]
*[[spriteflags]]
*[[spritenopal]]
*[[spritenoshade]]
*[[spritenvg]]
*[[spritepal]]
*[[spriteshadow]]
*[[sqrt]]
*[[ssp]]
*[[startcutscene]]
*[[startlevel]]
*[[startscreen]]
*[[starttrack]]
*[[starttrackslot]]
*[[starttrackvar]]
*[[state]]
*[[stopactorsound]]
*[[stopallmusic]]
*[[stopallsounds]]
*[[stopsound]]
*[[stopsoundvar]]
*[[strength]]
*[[string]]
*[[sub]]
*[[subvar]]
*[[subvarvar]]
*[[swaparrays]]
*[[swaptrackslot]]
*[[switch]]
*[[time]]
*[[tip]]
*[[tossweapon]]
*[[udc]]
*[[undefinecheat]]
*[[undefinegamefunc]]
*[[undefinelevel]]
*[[undefineskill]]
*[[undefinevolume]]
*[[updatesector]]
*[[updatesectorneighbor]]
*[[updatesectorneighborz]]
*[[updatesectorz]]
*[[useractor]]
*[[userquote]]
*[[var]]
*[[wackplayer]]
*[[whilel]]
*[[whilen]]
*[[whilevarl]]
*[[whilevarn]]
*[[whilevarvarl]]
*[[whilevarvarn]]
*[[writearraytofile]]
*[[xor]]
*[[xorvar]]
*[[xorvarvar]]
*[[zshoot]]
*[[zshootvar]]
</div>

[[Category:Scripting documentation]]

Category:All commands

2020-07-06T20:30:02Z

Rob Anybody: Link to undocumented loop forms

{{EDuke32 Intro}}

==Preprocessor==
*[[include]]
*[[includedefault]]
*[[define]]
*// single-line comment
*/* block comment */
*whitespace characters: <code>( ) ; ,</code>
==Meta-Settings==

*[[dynamicremap]]
*[[dynamicsoundremap]]
*[[setcfgname]]
*[[setdefname]]
*[[setgamename]]
*[[precache]]
*[[scriptsize]]
*[[cheatkeys]]
*[[definecheat]]
*[[definegamefuncname]]
*[[definegametype]]
*[[definevolumename]]
*[[definevolumeflags]]
*[[definelevelname]]
*[[defineskillname]]
*[[undefinevolume]]
*[[undefinelevel]]
*[[undefineskill]]
===If===
*[[ifrespawn]]
*[[ifmultiplayer]]
*[[ifclient]]
*[[ifserver]]
==Global Settings==

*[[gamestartup]]
*[[spritenopal]]
*[[spritenoshade]]
*[[spritenvg]]
*[[spriteshadow]]
==Block Delimiting==
===Object-Oriented===
*[[actor]]
*[[useractor]]
*[[enda]]
===Procedural===
*[[onevent]]
*[[appendevent]]
*[[endevent]]

===Subroutines===
*[[state]]
*[[defstate]]
*[[ends]]

==Flow Control==
===If Components===
*[[nullop]]
*[[else]]
===Switch===
*[[switch]]
*[[endswitch]]
*[[case]]
*[[default]]
===Termination===
*[[break]]
*[[return]]
===Jump===
:''Note: Jumping commands are deprecated and will not be supported by Lunatic. Use [[#Loops|loops]] instead.''
*[[getcurraddress]]
*[[jump]]

===Loops===
*[[range]]
*[[whilevarl]]
*[[whilevarvarl]]
*[[whilevarn]]
*[[whilevarvarn]]
:''It is also possible to loop by calling a state from within itself.''

==Game Variables==
*[[gamevar]]
*[[gamearray]]
===Gamevar Operators===
*[[setvar]]
*[[setvarvar]]
*[[setarray]]
*[[addvar]]
*[[addvarvar]]
*[[subvar]]
*[[subvarvar]]
*[[mulvar]]
*[[mulvarvar]]
*[[divvar]]
*[[divvarvar]]
*[[modvar]]
*[[modvarvar]]
*[[andvar]]
*[[andvarvar]]
*[[orvar]]
*[[orvarvar]]
*[[xorvar]]
*[[xorvarvar]]
*[[randvar]]
*[[randvarvar]]
===Gamevar Conditions===
*[[ifvare]]
*[[ifvarn]]
*[[ifvarg]]
*[[ifvarl]]
*[[ifvarand]]
*[[ifvaror]]
*[[ifvarxor]]
*[[ifvareither]]
*[[ifvarvare]]
*[[ifvarvarn]]
*[[ifvarvarg]]
*[[ifvarvarl]]
*[[ifvarvarand]]
*[[ifvarvaror]]
*[[ifvarvarxor]]
*[[ifvarvareither]]
===Math Operations===
*[[sqrt]]
*[[calchypotenuse]]
*[[sin]]
*[[cos]]
*[[shiftvarl]]
*[[shiftvarr]]
*[[mulscale]]
*[[getangle]]
*[[getincangle]]
===Array Operations===
*[[getarraysize]]
*[[getarraysequence]]
*[[resizearray]]
*[[copy]]
*[[setarray]]
*[[setarraysequence]]

===Data Saving===
*[[readgamevar]]
*[[savegamevar]]
*[[readarrayfromfile]]
*[[writearraytofile]]
==Structure Access==
*[[getactor]]
*[[getactorvar]]
*[[getinput]]
*[[getplayer]]
*[[getplayervar]]
*[[getprojectile]]
*[[getsector]]
*[[getthisprojectile]]
*[[gettspr]]
*[[getuserdef]]
*[[getwall]]
*[[setactor]]
*[[setactorvar]]
*[[setinput]]
*[[setplayer]]
*[[setplayervar]]
*[[setprojectile]]
*[[setsector]]
*[[setthisprojectile]]
*[[settspr]]
*[[setuserdef]]
*[[setwall]]
==Actors==
===Structures===
*[[cactor]] 
*[[action]] 
*[[ai]] 
*[[move]] 
*[[count]] 
*[[resetactioncount]] 
*[[resetcount]] 
*[[cstat]] 
*[[cstator]] 
*[[clipdist]] 
*[[sizeat]] 
*[[sizeto]] 
*[[strength]] 
*[[addstrength]] 
*[[spritepal]] 
*[[getlastpal]] 
*[[sleeptime]] 
*[[spriteflags]] 
*[[angoff]] 
*[[angoffvar]] 
*[[changespritesect]] 
*[[changespritestat]] 
*[[setsprite]] 
====If====
*[[ifactor]]
*[[ifaction]]
*[[ifactioncount]]
*[[ifai]]
*[[ifcount]]
*[[ifmove]]
*[[ifspawnedby]]
*[[ifspritepal]]
*[[ifstrength]]
*[[ifhitweapon]]
*[[ifwasweapon]]
*[[ifdead]]
*[[ifactornotstayput]]
===Commands===
*[[fall]]
*[[insertspriteq]]
*[[killit]]
*[[movesprite]]
*[[ssp]]
*[[clipmove]]
*[[clipmovenoslide]]
===Measurements===
*[[dist]]
*[[ldist]]
*[[cansee]]
*[[canseespr]]
===Surroundings===
====Commands====
*[[hitradius]]
*[[hitradiusvar]]
*[[flash]]
====If====
*[[ifawayfromwall]]
*[[ifbulletnear]]
*[[ifceilingdistl]]
*[[iffloordistl]]
*[[ifgapzl]]
*[[ifsquished]]
*[[ifnotmoving]]
*[[ifinwater]]
*[[ifonwater]]
*[[ifoutside]]
*[[ifinspace]]
*[[ifinouterspace]]
*[[ifrnd]] 
===Mapping Features===
*[[mikesnd]]
*[[respawnhitag]]
===Player Interaction===
*[[ifangdiffl]]
*[[ifcansee]]
*[[ifcanseetarget]]
*[[ifcanshoottarget]]
*[[ifhitspace]]
*[[getangletotarget]]
===Spawning===
*[[spawn]]
*[[espawn]]
*[[espawnvar]]
*[[qspawn]]
*[[qspawnvar]]
*[[eqspawn]]
*[[eqspawnvar]]
===Materials===
*[[debris]]
*[[guts]]
*[[lotsofglass]]
*[[mail]]
*[[money]]
*[[paper]]
==Projectiles==
*[[defineprojectile]]
*[[shoot]]
*[[shootvar]]
*[[eshoot]]
*[[eshootvar]]
*[[zshoot]]
*[[zshootvar]]
*[[ezshoot]]
*[[ezshootvar]]
==Player==
===Commands===
*[[addammo]]
*[[addinventory]]
*[[addweapon]]
*[[addweaponvar]]
*[[addphealth]]
*[[tossweapon]]
*[[gmaxammo]]
*[[smaxammo]]
*[[checkavailinven]]
*[[checkavailweapon]]
*[[addkills]]
*[[lockplayer]]
*[[resetplayer]]
*[[resetplayerflags]]
===If===
*[[ifgotweaponce]]
*[[ifp]]
*[[ifpdistg]]
*[[ifpdistl]]
*[[ifphealthl]]
*[[ifpinventory]]
*[[ifplayersl]]
==Sectors==
===Operating===
*[[operate]]
*[[operateactivators]]
*[[operatemasterswitches]]
*[[operaterespawns]]
*[[operatesectors]]
*[[activatebysector]]
*[[activate]]
===Manipulation===
*[[dragpoint]]
*[[sectsetinterpolation]]
*[[sectclearinterpolation]]
===Analysis===
*[[getceilzofslope]]
*[[getflorzofslope]]
*[[getzrange]]
*[[updatesector]]
*[[updatesectorz]]
*[[checkactivatormotion]]
*[[rotatepoint]]
*[[lineintersect]]
*[[rayintersect]]
*[[sectorofwall]]
==Discovery==
===Searching===
*[[findnearactor]]
*[[findnearactor3d]]
*[[findnearactor3dvar]]
*[[findnearactorvar]]
*[[findnearactorz]]
*[[findnearactorzvar]]
*[[findnearsprite]]
*[[findnearsprite3d]]
*[[findnearsprite3dvar]]
*[[findnearspritevar]]
*[[findnearspritez]]
*[[findnearspritezvar]]
*[[findotherplayer]]
*[[findplayer]]
*[[neartag]]
*[[hitscan]]
===Sorting===
*[[headspritesect]]
*[[headspritestat]]
*[[nextspritesect]]
*[[nextspritestat]]
*[[prevspritesect]]
*[[prevspritestat]]
==Audio==
===Sounds===
*[[definesound]]
*[[sound]]
*[[soundvar]]
*[[soundonce]]
*[[soundoncevar]]
*[[globalsound]]
*[[globalsoundvar]]
*[[screensound]]
*[[stopsound]]
*[[stopsoundvar]]
*[[stopactorsound]]
*[[stopallsounds]]
*[[ifsound]]
*[[ifactorsound]]
*[[ifnosounds]]
*[[setactorsoundpitch]]
===Music===
*[[music]]
*[[starttrack]]
*[[starttrackvar]]
*[[getmusicposition]]
*[[setmusicposition]]
==Quotes==
*[[definequote]]
*[[redefinequote]]
*[[quote]]
*[[userquote]]
*[[qsprintf]]
*[[qstrcpy]]
*[[qstrcat]]
*[[qstrncat]]
*[[qstrlen]]
*[[qsubstr]]
*[[qstrdim]]
*[[qgetsysstr]]
*[[getpname]]
*[[getkeyname]]
==Cutscenes==
*[[startcutscene]]
*[[ifcutscene]]
==Screen==
===Screen Manipulation===
*[[palfrom]]
*[[guniqhudid]]
*[[setgamepalette]]
*[[setaspect]]
===Player Actions===
*[[wackplayer]]
*[[quake]]
*[[pkick]]
*[[pstomp]]
*[[tip]]
===Screen Drawing===
*[[rotatesprite]]
*[[rotatesprite16]]
*[[rotatespritea]]
*[[screentext]]
*[[gametext]]
*[[gametextz]]
*[[minitext]]
*[[digitalnumber]]
*[[digitalnumberz]]
*[[showview]]
*[[showviewunbiased]]
===Math===
*[[displayrand]]
*[[displayrandvar]]
*[[displayrandvarvar]]
==Time Access==
*[[getticks]]
*[[gettimedate]]
==Game-Changing==
*[[activatecheat]]
*[[startlevel]]
*[[inittimer]]
*[[endofgame]]
*[[endoflevel]]
*[[cmenu]]
==Game Saving==
*[[save]]
*[[savenn]]
===Hub Maps===
*[[loadmapstate]]
*[[savemapstate]]
*[[clearmapstate]]
==Debug==
*[[debug]]
*[[addlog]]
*[[addlogvar]]
*[[echo]]
==Deprecated==
*[[betaname]]
*[[enhanced]]
*[[eventloadactor]]
*[[time]]
*[[shadeto]]
===Screen Drawing===
*[[myos]]
*[[myosx]]
*[[myospal]]
*[[myospalx]]
===Single-Use Structure Access===
*[[getactorangle]]
*[[getplayerangle]]
*[[gettextureceiling]]
*[[gettexturefloor]]
*[[sectgethitag]]
*[[sectgetlotag]]
*[[spgethitag]]
*[[spgetlotag]]
*[[setactorangle]]
*[[setplayerangle]]

[[Category:Scripting documentation]]

Template:Varsuffix

2020-07-06T20:26:26Z

Rob Anybody: Document short form of "varvar" commands

Commands with an additional "var" suffix take [[gamevar]]s rather than constants or [[define]]d labels for their inputs.
As an alternate short form, "varvar" can be dropped from these commands; for example '''ife''' serves an an alias for '''ifvarvare'''.

User:Rob Anybody

2020-07-06T20:17:44Z

Rob Anybody: Blanked the page