EDukeWiki - User contributions [en]

Category:Structure access

2026-01-15T18:08:07Z

Oasiz: Add missing shorthands to the table, relocate few existing ones to the dedicated column

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

==Usage==

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

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

===Getters & Setters===

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

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

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

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

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

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

===Quick Access===

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

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

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

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

==Structs==

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

Shorthands above can be seen as aliases, i.e. <code>getav</code> == <code>getactorvar</code>.
[[Category:EDuke32 end-user documentation]]
[[Category:Scripting documentation]]

Updatesectorneighborz

2025-07-05T22:53:17Z

Oasiz: Redirected page to Updatesector

#REDIRECT [[updatesector]]

Updatesectorneighbor

2025-07-05T22:53:11Z

Oasiz: Redirected page to Updatesector

#REDIRECT [[updatesector]]

Updatesector

2025-07-05T22:52:31Z

Oasiz:

'''updatesector''' <in_x> <in_y> <in_out_sectnum> 
'''updatesectorz''' <in_x> <in_y> <in_z> <in_out_sectnum> 
'''updatesectorneighbour''' <in_x> <in_y> <in_out_sectnum> <initial distance> <max distance> 
'''updatesectorneighbourz''' <in_x> <in_y> <in_z> <in_out_sectnum> <initial distance> <max distance>

Returns [[sector id]] of the [[sector]] containing the point (<in_x>,<in_y>) or (<in_x>,<in_y>,<in_z>) into <in_out_[[sectnum]]>. The final parameter must be pre-populated with what is assumed to be the correct sector, such as the sprite's pre-existing sectnum.

If the point is not a valid sector (like outside the map, inside a column, or below the floor), it returns -1. You should verify that the value return is not equal to -1 before manipulating the sector or you could have problems.

The "neighbour" counterparts are more performant for tasks that require determining whether nearby sectors exist at a point as they will not exhaustively search the map and has been added in since r7805

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

Updatesector

2025-07-05T22:52:22Z

Oasiz:

'''updatesector''' <in_x> <in_y> <in_out_sectnum> 
'''updatesectorz''' <in_x> <in_y> <in_z> <in_out_sectnum>
'''updatesectorneighbour''' <in_x> <in_y> <in_out_sectnum> <initial distance> <max distance>
'''updatesectorneighbourz''' <in_x> <in_y> <in_z> <in_out_sectnum> <initial distance> <max distance>

Returns [[sector id]] of the [[sector]] containing the point (<in_x>,<in_y>) or (<in_x>,<in_y>,<in_z>) into <in_out_[[sectnum]]>. The final parameter must be pre-populated with what is assumed to be the correct sector, such as the sprite's pre-existing sectnum.

If the point is not a valid sector (like outside the map, inside a column, or below the floor), it returns -1. You should verify that the value return is not equal to -1 before manipulating the sector or you could have problems.

The "neighbour" counterparts are more performant for tasks that require determining whether nearby sectors exist at a point as they will not exhaustively search the map and has been added in since r7805

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

Ifplaybackon

2025-07-05T19:30:13Z

Oasiz:

'''ifplaybackon'''

This is a dummy conditional check command for World Tour compatibility.

The use is to determine if the replay feature is enabled or not. With EDuke32 this will always return "false"

[[Category:EDuke32_specific_commands]]

Ifplaybackon

2025-07-05T19:29:16Z

Oasiz: Created page with "'''ifplaybackon''' This is a dummy command intended for World Tour compatibility. The use is to determine if the replay feature is enabled or not. With EDuke32 this will always return "false" Category:EDuke32_specific_commands"

'''ifplaybackon'''

This is a dummy command intended for World Tour compatibility.

The use is to determine if the replay feature is enabled or not. With EDuke32 this will always return "false"

[[Category:EDuke32_specific_commands]]

Preloadtrackslotforswap

2025-07-05T19:29:12Z

Oasiz:

'''preloadtrackslotforswap''' <volume?> <level?>

'''! THIS COMMAND DOES NOT FUNCTION !'''

Code for this was added on r6623 and presumably intended to allow pre-caching of data for an eventual [[swaptrackslot]] command.

Currently it has dummy code that processes two arguments and adjusts the script pointer.

[[Category:EDuke32_specific_commands]]

Preloadtrackslotforswap

2025-07-05T19:21:50Z

Oasiz:

Preloadtrackslotforswap

2025-07-05T19:19:48Z

Oasiz: Created page with "'''preloadtrackslotforswap''' <volume> <level> '''! THIS COMMAND DOES NOT FUNCTION !''' Code for this was added on r6623 and presumably intended to allow pre-caching of data for an eventual swaptrackslot command."

'''preloadtrackslotforswap''' <volume> <level>

'''! THIS COMMAND DOES NOT FUNCTION !'''

Code for this was added on r6623 and presumably intended to allow pre-caching of data for an eventual [[swaptrackslot]] command.

Undefinevolume

2025-07-05T19:15:33Z

Oasiz: Created page with "'''undefinevolume''' <volume> This removes all of the level entries under a <volume>, along with par & designer time definitions and the volume name definition itself. Category:EDuke32_specific_commands Category:Game manipulation"

'''undefinevolume''' <volume>

This removes all of the level entries under a <volume>, along with par & designer time definitions and the volume name definition itself.

[[Category:EDuke32_specific_commands]]
[[Category:Game manipulation]]

Undefinelevel

2025-07-05T19:13:57Z

Oasiz: Created page with "'''undefinelevel''' <volume> <level> This removes the <level> entry from <volume>, along with par & designer time definitions. Category:EDuke32_specific_commands Category:Game manipulation"

'''undefinelevel''' <volume> <level>

This removes the <level> entry from <volume>, along with par & designer time definitions.

[[Category:EDuke32_specific_commands]]
[[Category:Game manipulation]]

Swaptrackslot

2025-07-05T19:03:04Z

Oasiz:

'''setmusicposition''' <volume> <level>

Swaps current track with another one while attempting to keep the seek position.

This is a helper function achieves the same as [[getmusicposition]] -> [[starttrack]] -> [[setmusicposition]] in one go

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

Swaptrackslot

2025-07-05T19:02:35Z

Oasiz: Created page with "'''setmusicposition''' <volume> <level> Swaps current track with another one while attempting to keep the seek position. This is a helper function that does getmusicposition -> starttrack -> setmusicposition in one go Category:EDuke32 specific commands Category:Sound manipulation"

'''setmusicposition''' <volume> <level>

Swaps current track with another one while attempting to keep the seek position.

This is a helper function that does [[getmusicposition]] -> [[starttrack]] -> [[setmusicposition]] in one go

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

Starttrackslot

2025-07-05T18:58:05Z

Oasiz: Redirected page to Starttrack

#REDIRECT [[starttrack]]

Spawnwallglass

2025-07-05T16:48:04Z

Oasiz:

'''spawnwallglass''' <sprite id> <wall id> <glass count>

Calls the glass spawning function commonly seen when a player shoots a wall light, various props such as bottles or glass windows.

This works by spawning GLASSPIECES randomly for the amount set in glass count for the wall segment. 
The pieces will fall down in relation to where the light was shot from, typically facing the player and roughly from the height the bullet hit it.

Contrary to the name, it can be used with a wall ID set to -1 when paired with destructible sprites.

See also: [[spawnceilingglass]] [[spawnwallstainedglass]]

[[Category:EDuke32_specific_commands]]
[[Category:Sprite manipulation]]

Spawnwallstainedglass

2025-07-05T16:47:44Z

Oasiz: Created page with "'''spawnwallstainedglass''' <sprite id> <wall id> <glass count> Calls the "spawn random glass" function, seen when the player shoots at the stained glass seen in E1L3 or the flashing statue in E3L1 This works by spawning GLASSPIECES randomly for the amount set in glass count for the wall segment. The pieces will fall down in relation to where the light was shot from, typically facing the player and roughly from the height the bullet hit it. Contrary to the name, i..."

'''spawnwallstainedglass''' <sprite id> <wall id> <glass count>

Calls the "spawn random glass" function, seen when the player shoots at the stained glass seen in E1L3 or the flashing statue in E3L1

This works by spawning GLASSPIECES randomly for the amount set in glass count for the wall segment. 
The pieces will fall down in relation to where the light was shot from, typically facing the player and roughly from the height the bullet hit it.

Contrary to the name, it can be used with a wall ID set to -1 when paired with destructible sprites.

See also: [[spawnceilingglass]] [[spawnwallglass]]

[[Category:EDuke32_specific_commands]]
[[Category:Sprite manipulation]]

Spawnwallglass

2025-07-05T16:45:57Z

Oasiz:

'''spawnwallglass''' <sprite id> <wall id> <glass count>

Calls the glass spawning function commonly seen when a player shoots a wall light, various props such as bottles or glass windows.

This works by spawning GLASSPIECES randomly for the amount set in glass count for the wall segment. 
The pieces will fall down in relation to where the light was shot from, typically facing the player and roughly from the height the bullet hit it.

Contrary to the name, many common sprites often call this with the wall ID set to -1 when destroyed.

See also: [[spawnceilingglass]] [[spawnwallstainedglass]]

[[Category:EDuke32_specific_commands]]
[[Category:Sprite manipulation]]

Spawnwallglass

2025-07-05T16:41:27Z

Oasiz: Created page with "'''spawnwallglass''' <sprite id> <wall id> <glass count> Calls the glass spawning function commonly seen when a player shoots a wall light. This works by spawning GLASSPIECES randomly for the amount set in glass count for the wall segment. The pieces will fall down in relation to where the light was shot from, typically facing the player and roughly from the height the bullet hit it. See also: spawnceilingglass spawnwallstainedglass Category:EDuke32_spe..."

'''spawnwallglass''' <sprite id> <wall id> <glass count>

Calls the glass spawning function commonly seen when a player shoots a wall light.

This works by spawning GLASSPIECES randomly for the amount set in glass count for the wall segment. 
The pieces will fall down in relation to where the light was shot from, typically facing the player and roughly from the height the bullet hit it.

See also: [[spawnceilingglass]] [[spawnwallstainedglass]]

[[Category:EDuke32_specific_commands]]
[[Category:Sprite manipulation]]

Spawnceilingglass

2025-07-05T16:29:01Z

Oasiz:

'''spawnceilingglass''' <sprite id> <sector id> <glass count>

Calls the glass spawning function commonly seen when a player shoots a ceiling light.

This works by iterating through the sector's walls and spawning GLASSPIECES for the amount set in glass count (+1) for each of the wall segments at a random location along the line. 
The height for each piece is randomized inside a 5120 Z unit window, starting from the ceiling of the light sector.

Keep in mind that there is no safeguard for spawn counts as it will be <code>walls*(glasscount+1)</code> 
There is a bug in the code where one of the walls will be skipped for glass shards

See also: [[spawnwallglass]] [[spawnwallstainedglass]]

[[Category:EDuke32_specific_commands]]
[[Category:Sprite manipulation]]

Spawnceilingglass

2025-07-05T16:28:07Z

Oasiz:

'''spawnceilingglass''' <sprite id> <sector id> <glass count>

Calls the glass spawning function commonly seen when a player shoots a ceiling light.

This works by iterating through the sector's walls and spawning GLASSPIECES for the amount set in glass count (+1) for each of the wall segments at a random location along the line. 
The height for each piece is randomized inside a 5120 Z unit window, starting from the ceiling of the light sector.

Keep in mind that there is no safeguard for spawn counts as it will be <code>walls*(glasscount+1)</code>

See also: [[spawnwallglass]] [[spawnwallstainedglass]]

[[Category:EDuke32_specific_commands]]
[[Category:Sprite manipulation]]

Spawnceilingglass

2025-07-05T16:26:38Z

Oasiz: Created page with "'''spawnceilingglass''' <sprite id> <sector id> <glass count> Calls the glass spawning function commonly seen when a player shoots a ceiling light. This works by iterating through the sector's walls and spawning GLASSPIECES for the amount set in glass count (+1) for each of the wall segments at a random location along the line. The height for each piece is randomized inside a 5120 Z unit window, starting from the ceiling of the light sector. See also: spawnwallg..."

'''spawnceilingglass''' <sprite id> <sector id> <glass count>

Calls the glass spawning function commonly seen when a player shoots a ceiling light.

This works by iterating through the sector's walls and spawning GLASSPIECES for the amount set in glass count (+1) for each of the wall segments at a random location along the line. 
The height for each piece is randomized inside a 5120 Z unit window, starting from the ceiling of the light sector.

See also: [[spawnwallglass]] [[spawnwallstainedglass]]

[[Category:EDuke32_specific_commands]]
[[Category:Sprite manipulation]]

Showviewq16unbiased

2025-07-05T16:10:32Z

Oasiz: Redirected page to Showview

#REDIRECT [[showview]]

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

Showviewq16

2025-07-05T16:10:25Z

Oasiz: Redirected page to Showview

#REDIRECT [[showview]]

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

Showview

2025-07-05T16:08:29Z

Oasiz:

'''''showview''''' <x> <y> <z> <angle> <horiz> <sector> <scrn_x1> <scrn_y1> <scrn_x2> <scrn_y2> 
'''''showviewunbiased''''' <x> <y> <z> <angle> <horiz> <sector> <scrn_x1> <scrn_y1> <scrn_x2> <scrn_y2> 
'''''showviewq16''''' <x> <y> <z> <Q16 angle> <Q16 horiz> <sector> <scrn_x1> <scrn_y1> <scrn_x2> <scrn_y2> 
'''''showviewq16unbiased''''' <x> <y> <z> <Q16 angle> <Q16 horiz> <sector> <scrn_x1> <scrn_y1> <scrn_x2> <scrn_y2>

Displays on-screen the view from in-game coordinates (<x>,<y>,<z>), looking at angle <angle> and with z-angle (up and down) <horiz>, between screen coordinates (<scrn_x1>,<scrn_y1>) and (<scrn_x2>,<scrn_y2>).

<sector> is the sector that contains the in-game coordinates.

The on-screen coordinates can be in any shape; they do not have to be in the same x-y ratio as the screen resolution. However, the aspect ratio at which the scene is drawn in the sub-viewport is unspecified and may differ between renderers and settings of ''r_usenewaspect''. (For example, different ratios may result in warping or graphical glitches in the view.)

Their permissible range is 0 to 319 for the screen x coordinate, and 0 to 199 for the screen y coordinate, both inclusive.

"Q16" variants exist to provide extra 16 bits of floating point precision beyond the usual limitations of player's horiz and angle, any non-Q16 input values must be bit shifted higher by 16 bits when used as-is. 
When tied to the player, you can use <code>cameraq16horiz</code> and <code>cameraq16ang</code> for ready to use high precision input. 
This function is also software renderer compatible and any extra precision will simply be truncated there.

== Coordinates ==

These normalized coordinates are transformed to actual screen coordinates depending on the command used:

For '''''showview''''', the scaling biases them towards zero, so that the whole screen can never be covered in any other resolution than 320x200:
real_scrn_x = round_towards_zero((<scrn_x>*xdim)/320)
real_scrn_y = round_towards_zero((<scrn_y>*ydim)/200)

On the other hand, '''''showviewunbiased''''' transforms them such that the greatest permissible normalized value will be mapped to the greates actual screen coordinate:
real_scrn_x = round_towards_zero((<scrn_x>*(xdim-1))/319)
real_scrn_y = round_towards_zero((<scrn_y>*(ydim-1))/199)

The resulting coordinates are 0-based with the origin being the upper left corner and denote an inclusive range of pixels in the x or y direction in the classic renderer.

For example, the command
'''''showview''''' x y z a h s 0 0 31 0
draws the view in a one-pixel high line covering about one tenth of the screen length from the left, and
'''''showview''''' x y z a h s 0 0 0 19
a one-pixel wide line covering approximately one tenth of the height from above.

The command
'''''showview''''' x y z a h s 0 0 0 0
would use exactly the upper left pixel in the classic renderer. (Polymost currently behaves differently, but this may be subject to change.)

Keep in mind when using this command that the game will have to completely redraw everything from the specified perspective, which can produce a sizeable framerate hit.

==Examples==
The correct way of drawing to the whole screen is
'''showviewunbiased''' x y z a h s '''''0 0 319 199'''''

This will embed a small version of the player's view near the top left corner of the screen:
getplayer[THISACTOR].posx x
getplayer[THISACTOR].posy y
getplayer[THISACTOR].posz z
getplayer[THISACTOR].ang ang
getplayer[THISACTOR].horiz horiz
getplayer[THISACTOR].horizoff temp
addvarvar horiz temp
updatesectorz x y z sect
'''showviewunbiased''' x y z ang horiz sect 16 8 56 39

When using Q16 variants, you can also use:
camerax
cameray
cameraz
camerasect
cameraq16horiz
cameraq16ang

Note that "camera" coordinates also change when viewing 3rd person mode

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

Showview

2025-07-05T16:07:45Z

Oasiz:

'''''showview''''' <x> <y> <z> <angle> <horiz> <sector> <scrn_x1> <scrn_y1> <scrn_x2> <scrn_y2> 
'''''showviewunbiased''''' <x> <y> <z> <angle> <horiz> <sector> <scrn_x1> <scrn_y1> <scrn_x2> <scrn_y2> 
'''''showviewq16''''' <x> <y> <z> <Q16 angle> <Q16 horiz> <sector> <scrn_x1> <scrn_y1> <scrn_x2> <scrn_y2> 
'''''showviewq16unbiased''''' <x> <y> <z> <Q16 angle> <Q16 horiz> <sector> <scrn_x1> <scrn_y1> <scrn_x2> <scrn_y2>

Displays on-screen the view from in-game coordinates (<x>,<y>,<z>), looking at angle <angle> and with z-angle (up and down) <horiz>, between screen coordinates (<scrn_x1>,<scrn_y1>) and (<scrn_x2>,<scrn_y2>).

<sector> is the sector that contains the in-game coordinates.

The on-screen coordinates can be in any shape; they do not have to be in the same x-y ratio as the screen resolution. However, the aspect ratio at which the scene is drawn in the sub-viewport is unspecified and may differ between renderers and settings of ''r_usenewaspect''. (For example, different ratios may result in warping or graphical glitches in the view.)

Their permissible range is 0 to 319 for the screen x coordinate, and 0 to 199 for the screen y coordinate, both inclusive.

"Q16" variants exist to provide extra 16 bits of floating point precision beyond the usual limitations of player's horiz and angle, any non-Q16 input values must be bit shifted higher by 16 bits when used as-is. 
When tied to the player, you can use <code>cameraq16horiz</code> and <code>cameraq16ang</code> for ready to use high precision input. 
This function is also software renderer compatible and any extra precision will simply be truncated there.

== Coordinates ==

These normalized coordinates are transformed to actual screen coordinates depending on the command used:

For '''''showview''''', the scaling biases them towards zero, so that the whole screen can never be covered in any other resolution than 320x200:
real_scrn_x = round_towards_zero((<scrn_x>*xdim)/320)
real_scrn_y = round_towards_zero((<scrn_y>*ydim)/200)

On the other hand, '''''showviewunbiased''''' transforms them such that the greatest permissible normalized value will be mapped to the greates actual screen coordinate:
real_scrn_x = round_towards_zero((<scrn_x>*(xdim-1))/319)
real_scrn_y = round_towards_zero((<scrn_y>*(ydim-1))/199)

The resulting coordinates are 0-based with the origin being the upper left corner and denote an inclusive range of pixels in the x or y direction in the classic renderer.

For example, the command
'''''showview''''' x y z a h s 0 0 31 0
draws the view in a one-pixel high line covering about one tenth of the screen length from the left, and
'''''showview''''' x y z a h s 0 0 0 19
a one-pixel wide line covering approximately one tenth of the height from above.

The command
'''''showview''''' x y z a h s 0 0 0 0
would use exactly the upper left pixel in the classic renderer. (Polymost currently behaves differently, but this may be subject to change.)

Keep in mind when using this command that the game will have to completely redraw everything from the specified perspective, which can produce a sizeable framerate hit.

==Examples==
The correct way of drawing to the whole screen is
'''showviewunbiased''' x y z a h s '''''0 0 319 199'''''

This will embed a small version of the player's view near the top left corner of the screen:
getplayer[THISACTOR].posx x
getplayer[THISACTOR].posy y
getplayer[THISACTOR].posz z
getplayer[THISACTOR].ang ang
getplayer[THISACTOR].horiz horiz
getplayer[THISACTOR].horizoff temp
addvarvar horiz temp
updatesectorz x y z sect
'''showviewunbiased''' x y z ang horiz sect 16 8 56 39

When using q16 variants, you can also use:
camerax
cameray
cameraz
camerasect
cameraq16horiz
cameraq16ang

Note that "camera" coordinates also change when viewing 3rd person mode

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

Setngcflags

2025-07-05T15:39:24Z

Oasiz:

'''setngcflags''' <const/var> <idx1> [<idx2>...]

Sets the flags for the newgamechoices entries at the specified indices.
The index list is variable-sized, up to a maximum of 3.

This can be used to enable/disable the MEF_Hidden and MEF_Locked state.
Supersedes the userdef struct members:

`m_newgamecustomopen` and `m_newgamecustomsubopen`.

See also: [[getngcflags]]

[[Category:EDuke32_specific_commands]]
[[Category:Userdef structure manipulation]]

Getngcflags

2025-07-05T15:39:15Z

Oasiz: Created page with "'''getngcflags''' <const/var> <idx1> [<idx2>...] Gets the flags for the newgamechoices entries at the specified indices. The index list is variable-sized, up to a maximum of 3. This can be used to enable/disable the MEF_Hidden and MEF_Locked state. Supersedes the userdef struct members: `m_newgamecustomopen` and `m_newgamecustomsubopen`. See also: setngcflags Category:EDuke32_specific_commands Category:Userdef structure manipulation"

'''getngcflags''' <const/var> <idx1> [<idx2>...]

Gets the flags for the newgamechoices entries at the specified indices.
The index list is variable-sized, up to a maximum of 3.

This can be used to enable/disable the MEF_Hidden and MEF_Locked state.
Supersedes the userdef struct members:

`m_newgamecustomopen` and `m_newgamecustomsubopen`.

See also: [[setngcflags]]

[[Category:EDuke32_specific_commands]]
[[Category:Userdef structure manipulation]]

Setngcflags

2025-07-05T15:38:56Z

Oasiz: Created page with "'''setngcflags''' <const/var> <idx1> [<idx2>...] Gets/sets the flags for the newgamechoices entries at the specified indices. The index list is variable-sized, up to a maximum of 3. This can be used to enable/disable the MEF_Hidden and MEF_Locked state. Supersedes the userdef struct members: `m_newgamecustomopen` and `m_newgamecustomsubopen`. See also: getngcflags Category:EDuke32_specific_commands Category:Userdef structure manipulation"

'''setngcflags''' <const/var> <idx1> [<idx2>...]

Gets/sets the flags for the newgamechoices entries at the specified indices.
The index list is variable-sized, up to a maximum of 3.

This can be used to enable/disable the MEF_Hidden and MEF_Locked state.
Supersedes the userdef struct members:

`m_newgamecustomopen` and `m_newgamecustomsubopen`.

See also: [[getngcflags]]

[[Category:EDuke32_specific_commands]]
[[Category:Userdef structure manipulation]]

Movesector

2025-07-05T15:31:43Z

Oasiz:

'''movesector''' <sprite ID>

A function commonly called by the game code for moving sectors in X and Y axes (but not Z) during events such as earthquakes, rotating sectors, swinging doors and escalators.

The sprite ID and it's xvel and yvel will determine the new x-y and the rotation angle can be accessed through [[EVENT_MOVESECTOR]].

Source code says that sprite's T1, T2 and T3 are used.
T2 is originIdx, T3 for rotateAngle however nothing seems evident for T1.

[[Category:EDuke32_specific_commands]]
[[Category:Sector manipulation]]

Category:All commands

2025-07-05T15:30:19Z

Oasiz: /* Manipulation */

{{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]]
*[[prependstate]]
*[[appendstate]]

==Flow Control==
===If Components===
*[[nullop]]
*[[else]]
===Switch===
*[[switch]]
*[[endswitch]]
*[[case]]
*[[default]]
===Termination===
*[[break]]
*[[continue]]
*[[exit]]
*[[return]]
*[[terminate]]

===Jump===
:''Note: Jumping commands are deprecated and will not be supported by Lunatic. Use [[#Loops|loops]] instead.''
*[[getcurraddress]]
*[[jump]]

===Loops===
*[[whilevarl]]
*[[whilevarvarl]]
*[[whilevare]]
*[[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]]
*[[movesector]]
*[[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]]

Movesector

2025-07-05T15:29:05Z

Oasiz:

'''movesector''' <sprite ID>

A function commonly called by the game code for moving sectors in X and Y axes (but not Z) during events such as earthquakes, rotating sectors, swinging doors and escalators.

The sprite ID and it's xvel and yvel will determine the new x-y and the rotation angle can be accessed through [[EVENT_MOVESECTOR]].

Source code says that sprite's T1, T2 and T3 are used.
T2 is originIdx, T3 for rotateAngle however nothing seems evident for T1.
[[Category:EDuke32_specific_commands]] [[Category:Sector manipulation]]

Movesector

2025-07-05T15:28:14Z

Oasiz:

'''movesector''' <sprite ID>

A function commonly called by the game code for moving sectors in X and Y axes (but not Z) during events such as earthquakes, rotating sectors, swinging doors and escalators.

The sprite ID and it's xvel and yvel will determine the new x-y and the rotation angle can be accessed through [[EVENT_MOVESECTOR]].

Source code says that sprite's T1, T2 and T3 are used.
T2 is originIdx, T3 for rotateAngle however nothing seems evident for T1.
[[Category:EDuke32_specific_commands]] [[Category:All_commands]] [[Category:Sector manipulation]]

Movesector

2025-07-05T15:26:36Z

Oasiz:

'''movesector''' <sprite ID>

A function commonly called by the game code for moving sectors in X and Y axes (but not Z) during events such as earthquakes, rotating sectors, swinging doors and escalators.

The sprite ID and it's xvel and yvel will determine the new x-y and the rotation angle can be accessed through [[EVENT_MOVESECTOR]].

Source code says that sprite's T1, T2 and T3 are used.
T2 is originIdx, T3 for rotateAngle however nothing seems evident for T1.
[[Category:EDuke32_specific_commands]] [[Category:All_commands]]

Movesector

2025-07-05T15:24:11Z

Oasiz:

Movesector

2025-07-05T15:23:35Z

Oasiz: Created page with "'''movesector''' <sprite ID> A function commonly called by the game code for moving sectors in X and Y axes (but not Z) during events such as earthquakes, rotating sectors, swinging doors and escalators. The sprite ID and it's xvel and yvel will determine the new x-y and the rotation angle can be accessed through EVENT_MOVESECTOR. Source code says that sprite's T1, T2 and T3 are used, where T2 is originIdx, T3 for rotateAngle but nothing for T1."

'''movesector''' <sprite ID>

A function commonly called by the game code for moving sectors in X and Y axes (but not Z) during events such as earthquakes, rotating sectors, swinging doors and escalators.

The sprite ID and it's xvel and yvel will determine the new x-y and the rotation angle can be accessed through [[EVENT_MOVESECTOR]].

Source code says that sprite's T1, T2 and T3 are used, where T2 is originIdx, T3 for rotateAngle but nothing for T1.

Sectclearinterpolation

2025-07-05T15:08:29Z

Oasiz: Created page with "'''sectclearinterpolation''' <sectnum> This will remove interpolation from the sector's movement, reverting the updates to the native 30Hz rate. Useful for few edge cases where removing hardcoded or otherwise CON enabled interpolation is desirable, such as instant snap movements from explosions A good example would be creating the illusion of continuous motion like with escalator effect, which currently looks broken as the released version incorrectly applies interpol..."

'''sectclearinterpolation''' <sectnum>

This will remove interpolation from the sector's movement, reverting the updates to the native 30Hz rate.

Useful for few edge cases where removing hardcoded or otherwise CON enabled interpolation is desirable, such as instant snap movements from explosions

A good example would be creating the illusion of continuous motion like with escalator effect, which currently looks broken as the released version incorrectly applies interpolation to those.

== Parameters ==

{| {{prettytable}}
| <sectnum> || Number of the sector.
|-
|}

See also: [[sectsetinterpolation]]

Sectsetinterpolation

2025-07-05T14:58:25Z

Oasiz:

'''sectsetinterpolation''' <sectnum>

Applies interpolation on the movement of a specific sector.
Useful for smoothing sector movement executed via CON, typically by moving its wallpoints using [[dragpoint]].

Sector coordinates update every 30 tics, which will look jittery by default. This command as the name suggests will enable interpolation of these updates.

== Parameters ==

{| {{prettytable}}
| <sectnum> || Number of the sector.
|-
|}

See also: [[sectclearinterpolation]]

Gettiledata

2025-07-05T14:55:40Z

Oasiz:

'''gettiledata'''[<id>].[[Members of the tiledata structure|<tiledata member>]] <variable>

Allows quick access to tiledata[] struct members.

Example:

gettiledata[THISACTOR].gameflags temp
or temp SFLAG_BADGUYSTAYPUT
settiledata[THISACTOR].gameflags temp

See also: [[settiledata]]

[[Category:EDuke32 specific commands]]
[[Category:Structure_access]]

Settiledata

2025-07-05T14:55:26Z

Oasiz:

'''settiledata'''[<id>].[[Members of the tiledata structure|<tiledata member>]] <variable>

Allows quick access to tiledata[] struct members.

Example:

gettiledata[THISACTOR].gameflags temp
or temp SFLAG_BADGUYSTAYPUT
settiledata[THISACTOR].gameflags temp

See also: [[gettiledata]]

[[Category:EDuke32 specific commands]]
[[Category:Structure_access]]

Settiledata

2025-07-05T14:55:10Z

Oasiz: Created page with "'''settiledata'''[<id>].<tiledata member> Allows quick access to tiledata[] struct members. Example: gettiledata[THISACTOR].gameflags temp or temp SFLAG_BADGUYSTAYPUT settiledata[THISACTOR].gameflags temp See also: gettiledata Category:EDuke32 specific commands Category:Structure_access"

'''settiledata'''[<id>].[[Members of the tiledata structure|<tiledata member>]]

Allows quick access to tiledata[] struct members.

Example:

gettiledata[THISACTOR].gameflags temp
or temp SFLAG_BADGUYSTAYPUT
settiledata[THISACTOR].gameflags temp

See also: [[gettiledata]]

[[Category:EDuke32 specific commands]]
[[Category:Structure_access]]

Gettiledata

2025-07-05T14:54:55Z

Oasiz: Created page with "'''gettiledata'''[<id>].<tiledata member> Allows quick access to tiledata[] struct members. Example: gettiledata[THISACTOR].gameflags temp or temp SFLAG_BADGUYSTAYPUT settiledata[THISACTOR].gameflags temp See also: settiledata Category:EDuke32 specific commands Category:Structure_access"

'''gettiledata'''[<id>].[[Members of the tiledata structure|<tiledata member>]]

Allows quick access to tiledata[] struct members.

Example:

gettiledata[THISACTOR].gameflags temp
or temp SFLAG_BADGUYSTAYPUT
settiledata[THISACTOR].gameflags temp

See also: [[settiledata]]

[[Category:EDuke32 specific commands]]
[[Category:Structure_access]]

Swaparrays

2025-07-05T14:40:50Z

Oasiz: Created page with "'''swaparrays''' <array name #1> <array name #2> Swaps the contents and sizing of two existing gamearray entries. Category:EDuke32 specific commands Category:Gamearray manipulation"

'''swaparrays''' <array name #1> <array name #2>

Swaps the contents and sizing of two existing [[gamearray]] entries.

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

EVENT OPERATEACTIVATORS

2025-07-03T21:07:12Z

Oasiz: Created page with "{{EventTable|1=EVENT_OPERATEACTIVATORS|2=player who operated|3=current sprite|4=1 value}} '''EVENT_OPERATEACTIVATORS''' is a Game Event. This event is triggered for each STAT_ACTIVATOR sprite with a matching lotag when OperateActivators() is called. In practice, this applies to Buttons, Touchplates, two-way trains and the CON command Operateactivators THISACTOR will be set to the current matching [[statnum|STAT_ACTIVATOR]..."

{{EventTable|1=EVENT_OPERATEACTIVATORS|2=player who operated|3=current sprite|4=1 value}}
'''EVENT_OPERATEACTIVATORS''' is a [[EDuke32_event_list|Game Event]].

This [[event]] is triggered for each [[statnum|STAT_ACTIVATOR]] sprite with a matching lotag when OperateActivators() is called.

In practice, this applies to Buttons, Touchplates, two-way trains and the CON command [[Operateactivators]]

[[THISACTOR]] will be set to the current matching [[statnum|STAT_ACTIVATOR]] spriteNum and from there it's possible to do further matching.

This code runs just before the actual Activator & Activatorlocked sprites get checked so it's possible to write your additional logic that modifies their normal behavior

Setting [[RETURN]] as -1 to cancel the remaining hardcoded behavior for Activator, Activatorlocked, underwater SE18/31/32/36 special cases and OperateSectors() call. Respawns will still be triggered regardless.

Note: This does not handle masterswitches as they are [[statnum|STAT_STANDABLE]]

[[Category:Events]]

Event list

2025-07-03T20:39:45Z

Oasiz:

{{EDuke32 Intro}}
{| cellpadding="0" cellspacing="0" border="0" width="100%"
| valign="top" style="border-right: none; padding: 0.6em;" |
This is a list of every event in the current release of EDuke32.

All [[events]] are accessed using the [[onevent]] and [[appendevent]] commands.

See also: [[:Category:Event manipulation|Event Manipulation]].

| width="1%" nowrap="nowrap" valign="top" style="border-right: none; border-left: none; padding: 0.6em;" |
[1] [[unsynchronized events|Unsynchronized events]] 
[2] may recurse 
[3] no current player number set 
[4] no THISACTOR set 
[5] eduke32 standalone build only 
[6] executes at framerate
|}
{| cellpadding="0" cellspacing="0" border="0" width="100%"
| width="25%" valign="top" style="border-right: none; padding: 0.6em;" |
Misc events
*[[EVENT_ACTIVATECHEAT]][1][2]
*[[EVENT_CAPIR]][1][3][5]
*[[EVENT_CHEATGETBOOT]][1]
*[[EVENT_CHEATGETFIRSTAID]][1]
*[[EVENT_CHEATGETHEAT]][1]
*[[EVENT_CHEATGETHOLODUKE]][1]
*[[EVENT_CHEATGETJETPACK]][1]
*[[EVENT_CHEATGETSCUBA]][1]
*[[EVENT_CHEATGETSHIELD]][1]
*[[EVENT_CHEATGETSTEROIDS]][1]
*[[EVENT_ENDLEVELSCREEN]]
*[[EVENT_EXITGAMESCREEN]]
*[[EVENT_EXITPROGRAMSCREEN]]
*[[EVENT_INIT]][1][3]
*[[EVENT_INITCOMPLETE]][1][3]
*[[EVENT_LOADGAME]][1]
*[[EVENT_MAINMENUSCREEN]]
*[[EVENT_NEWGAME]][1]
*[[EVENT_NEWGAMESCREEN]]
*[[EVENT_POSTSAVEGAME]]
*[[EVENT_PRELOADGAME]][1]
*[[EVENT_SAVEGAME]][1]
*[[EVENT_SETDEFAULTS]][1][3]
*[[EVENT_VALIDATESTART]]

Screen drawing events (in-game)
*[[EVENT_DISPLAYROOMS]][1][6]
*[[EVENT_DISPLAYROOMSCAMERA]][1][6]
*[[EVENT_DISPLAYROOMSCAMERATILE]][1]
*[[EVENT_DISPLAYROOMSEND]][1][6]
*[[EVENT_RESETGOTPICS]][1][3][6]

Screen drawing events (misc)
*[[EVENT_DISPLAYEND]][1][6]
*[[EVENT_DISPLAYREST]][1][6]
*[[EVENT_DISPLAYSTART]][1][6]
*[[EVENT_UPDATESCREENAREA]][6]

Unused/Removed
*[[EVENT_FAKEDOMOVETHINGS]][1]
*[[EVENT_ANIMATEALLSPRITES]][1]

| width="25%" valign="top" style="border-right: none; border-left: none; padding: 0.6em;" |
Screen drawing events (menus)
*[[EVENT_CHANGEMENU]][1][2]
*[[EVENT_DISPLAYCURSOR]][1][6]
*[[EVENT_DISPLAYINACTIVEMENU]][1][6]
*[[EVENT_DISPLAYINACTIVEMENUREST]][1][6]
*[[EVENT_DISPLAYMENU]][1][6]
*[[EVENT_DISPLAYMENUREST]][1][6]
*[[EVENT_GETBONUSTILE]][1][6]
*[[EVENT_GETMENUTILE]][1][6]
*[[EVENT_MENUCURSORLEFT]][1][4][6]
*[[EVENT_MENUCURSORRIGHT]][1][4][6]
*[[EVENT_MENUCURSORSHADE]][1][4][6]
*[[EVENT_MENUSHADESELECTED]][1][4][6]
*[[EVENT_NEWGAMECUSTOM]][1][4]

Screen drawing events (special screens and cutscenes)
*[[EVENT_CUTSCENE]][1]
*[[EVENT_DISPLAYBONUSSCREEN]][1][6]
*[[EVENT_DISPLAYLOADINGSCREEN]][1]
*[[EVENT_GETLOADTILE]][1]
*[[EVENT_LOGO]][1][6]
*[[EVENT_PRECUTSCENE]][1]
*[[EVENT_SCREEN]][1][2][6]
*[[EVENT_SKIPCUTSCENE]][2]

Screen drawing events (HUD)
*[[EVENT_DISPLAYBORDER]][1][6]
*[[EVENT_DISPLAYCROSSHAIR]][1][6]
*[[EVENT_DISPLAYLEVELSTATS]][1][6]
*[[EVENT_DISPLAYOVERHEADMAPPLAYER]][1][6]
*[[EVENT_DISPLAYOVERHEADMAPTEXT]][1][6]
*[[EVENT_DISPLAYPOINTER]][1][6]
*[[EVENT_DISPLAYSBAR]][1][6]

Screen drawing events (player body)
*[[EVENT_DISPLAYACCESS]][1][6]
*[[EVENT_DISPLAYCAMERAOSD]][1][6]
*[[EVENT_DISPLAYFIST]][1][6]
*[[EVENT_DISPLAYKNEE]][1][6]
*[[EVENT_DISPLAYKNUCKLES]][1][6]
*[[EVENT_DISPLAYSCUBA]][1][6]
*[[EVENT_DISPLAYSPIT]][1][6]
*[[EVENT_DISPLAYTIP]][1][6]
*[[EVENT_DISPLAYWEAPON]][1][6]
*[[EVENT_DRAWWEAPON]][1][6]

| width="25%" valign="top" style="border-right: none; border-left: none; padding: 0.6em;" |
Actor controlling events
*[[EVENT_ANIMATESPRITES]][1][6]
*[[EVENT_EGS]][2]
*[[EVENT_GAME]]
*[[EVENT_KILLIT]][2]
*[[EVENT_LOADACTOR]][3]
*[[EVENT_PREACTORDAMAGE]]
*[[EVENT_PREGAME]]
*[[EVENT_RECOGSOUND]]
*[[EVENT_SPAWN]][2]

Sound-based events
*[[EVENT_CONTINUELEVELMUSICSLOT]]
*[[EVENT_PLAYLEVELMUSICSLOT]]
*[[EVENT_OPENMENUSOUND]]
*[[EVENT_SOUND]][1][2]

Global events
*[[EVENT_DAMAGECEILING]]
*[[EVENT_DAMAGEFLOOR]]
*[[EVENT_DAMAGEHPLANE]]
*[[EVENT_DAMAGESPRITE]]
*[[EVENT_DAMAGEWALL]]
*[[EVENT_ENTERLEVEL]]
*[[EVENT_MOVEEFFECTORS]]
*[[EVENT_MOVESECTOR]]
*[[EVENT_OPERATEACTIVATORS]]
*[[EVENT_POSTDAMAGESPRITE]]
*[[EVENT_PRELEVEL]]
*[[EVENT_PREWORLD]]
*[[EVENT_WORLD]]

Player controlling events
*[[EVENT_CHANGEWEAPON]]
*[[EVENT_CHECKFLOORDAMAGE]]
*[[EVENT_CHECKTOUCHDAMAGE]]
*[[EVENT_DOFIRE]]
*[[EVENT_GETAUTOAIMANGLE]]
*[[EVENT_GETSHOTRANGE]]
*[[EVENT_INCURDAMAGE]]
*[[EVENT_POSTUPDATEANGLES]][6]
*[[EVENT_PREUPDATEANGLES]][6]
*[[EVENT_RESETINVENTORY]]
*[[EVENT_RESETPLAYER]]
*[[EVENT_RESETWEAPONS]]

| width="25%" valign="top" style="border-left: none; padding: 0.6em;" |
Player input-based events
*[[EVENT_AIMDOWN]]
*[[EVENT_AIMUP]]
*[[EVENT_ALTFIRE]]
*[[EVENT_ALTWEAPON]]
*[[EVENT_CROUCH]]
*[[EVENT_FIRE]]
*[[EVENT_FIREWEAPON]]
*[[EVENT_HOLODUKEOFF]]
*[[EVENT_HOLODUKEON]]
*[[EVENT_HOLSTER]]
*[[EVENT_INVENTORY]]
*[[EVENT_INVENTORYLEFT]]
*[[EVENT_INVENTORYRIGHT]]
*[[EVENT_JUMP]]
*[[EVENT_LASTWEAPON]]
*[[EVENT_LOOKDOWN]]
*[[EVENT_LOOKLEFT]]
*[[EVENT_LOOKRIGHT]]
*[[EVENT_LOOKUP]]
*[[EVENT_MOVEBACKWARD]]
*[[EVENT_MOVEFORWARD]]
*[[EVENT_NEXTWEAPON]]
*[[EVENT_POSTWEAPONSHOOT]]
*[[EVENT_PRESSEDFIRE]]
*[[EVENT_PREVIOUSWEAPON]]
*[[EVENT_PREWEAPONSHOOT]]
*[[EVENT_PROCESSINPUT]]
*[[EVENT_QUICKKICK]]
*[[EVENT_RETURNTOCENTER]]
*[[EVENT_SELECTWEAPON]]
*[[EVENT_SOARDOWN]]
*[[EVENT_SOARUP]]
*[[EVENT_STRAFELEFT]]
*[[EVENT_STRAFERIGHT]]
*[[EVENT_SWIMDOWN]]
*[[EVENT_SWIMUP]]
*[[EVENT_TURNAROUND]]
*[[EVENT_TURNLEFT]]
*[[EVENT_TURNRIGHT]]
*[[EVENT_USE]]
*[[EVENT_USEJETPACK]]
*[[EVENT_USEMEDKIT]]
*[[EVENT_USENIGHTVISION]]
*[[EVENT_USESTEROIDS]]
*[[EVENT_WEAPKEY1]]
*[[EVENT_WEAPKEY10]]
*[[EVENT_WEAPKEY2]]
*[[EVENT_WEAPKEY3]]
*[[EVENT_WEAPKEY4]]
*[[EVENT_WEAPKEY5]]
*[[EVENT_WEAPKEY6]]
*[[EVENT_WEAPKEY7]]
*[[EVENT_WEAPKEY8]]
*[[EVENT_WEAPKEY9]]
|}

[[Category:Event manipulation]]
[[Category:Scripting documentation]]

M32 script variables

2025-07-02T17:02:04Z

Oasiz:

{{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
called when any of the getnumber dialog boxes is open, used to allow drawing. RETURN contains the value being typed.

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]]

M32 script variables

2025-07-02T17:00:50Z

Oasiz: /* 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
called when any of the getnumber dialog boxes is open, used to allow drawing. RETURN is the value being typed.

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]]