M32 script commands

Mapster32 Scripting

Mapster32 Scripting · M32 script commands · M32 script variables · M32 script examples

---

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

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)

All of these are redundant, 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

• Sin resvar var
• Cos resvar var
• Displayrand resvar
• Inv var
• Clamp var min max
• Sqrt var resvar
• Mulscale resvar factor1 factor2 rshiftamount
• Dist res sprite1 sprite2
• Ldist res sprite1 sprite2
• Getangle res x y
• Getincangle res ang1 ang2

special commands

• Sort array count [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

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

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

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)
• Quote quotenum
• Error quotenum
• Printmessage16 quotenum
• Printmessage256 quotenum x y
• Printext256 quotenum x y col backcol fontsize
• Printext16 quotenum x y col backcol fontsize

Specifying a negative max argument will make the allowable number range be max to -max:

• Getnumber16 var quotenum max
• Getnumber256 var quotenum max
• 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

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

used in EVENT_DRAW2DSCREEN

• Drawline16 x1 y1 x2 y2 col
• Drawline16b x1 y1 x2 y2 col (BUILD units)
• Drawcircle16 x y radius col
• Drawcircle16b x y radius col (BUILD units)

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