Script Tags Documentation (Go back)

Please note that this is Work in Progress, information may be incomplete, inaccurate and even invalid. Contributions can be posted in the LMHack Forums, you will be credited appropriately, thanks.


Credits to: nya - Revision & Corrections | luigim1 - Original Documentation.


Last updated: 2019-04-25



Actor Related

Tag Syntax Description Verified
ACTOR <ACTOR>"dm_luigi" Loads in an actor with the corresponding CodeName as one from characterinfo.
ACT <ACT>"L_TDM01" Plays an animation file from the character model' key folder to play.
ACTIVE <ACTIVE> Toggles the selected actor's active attribute.
ALLCONTROL <ALLCONTROL>
ALLNOCONTROL <ALLNOCONTROL>
ALLSTART <ALLSTART> Makes all actors active.
ALLSTOP <ALLSTOP> Makes all actors inactive.
ALPHA <ALPHA>(255) Sets the selected actor's alpha value (Transparency) to the value specified.
ALPHAF <ALPHAF>
BODYON <BODYON> Enables visibility for the selected actor. <- correction needed!
BODYOFF <BODYOFF> Disables visibility for the selected actor. <- correction needed!
COLON <COLON> Enables the selected actor's collision attribute.
COLOFF <COLOFF> Disables the selected actor's collision attribute.
DISPON <DISPON> Enables the selected actor's visibility attribute.
DISPOFF <DISPOFF> Disables the selected actor's visibility attribute.
HPMAX <HPMAX> Sets the selected actor's HP to the actor's maximum HP value.
HP <HP>(100) Sets the selected actor's HP to the value specified.
KILL <KILL> Kill's the selected actor.
LOOK <LOOK> Makes the selected actor look at another actor in current scene. <- correction needed!
MASKON <MASKON> Enables lumination effect for the selected actor.
MASKOFF <MASKOFF> Disables lumination effect for the selected actor.
PATH <PATH>"l_tdm1" Makes the selected actor travel across the path specified.
POS <POS>(x)(y)(z) Moves the selected actor to the absolute position specified.
SETCLEANER <SETCLEANER>"demo_vhead""demo_vbody" Selects and enables the vacuum models for the actor it being used on.
SHADOWON <SHADOWON> Enables shadows for the selected actor.
SHADOWOFF <SHADOWOFF> Disables shadows for the selected actor.
STOP <STOP>"dm_luigi" Stops the selected actor's animation.

Luigi Related

Tag Syntax Description Verified
FORCEMOVE <FORCEMOVE>(X)(Y)(Z) Forces Luigi to walk to the absolute position specified.
GAMEBOYON <GAMEBOYON> Shows the gameboy model in Luigi's hand.
GAMEBOYOFF <GAMEBOYOFF> Hides the gameboy model in Luigi's hand.
LUIGIFREE <LUIGIFREE> Enables Luigi movement.
LUIGIFREE2 <LUIGIFREE2> Enables Luigi's movement.
LUIGIFREE3 <LUIGIFREE3> Enables Luigi's movement. Does a LUIGIFREE3 tag exist?
LUIGISTOP <LUIGISTOP> Disables Luigi's movement.
LUIGISTOP2 <LUIGISTOP2> Disables Luigi's movement.
LUIGISTOP3 <LUIGISTOP3> Disables Luigi's movement.
LUIGELTON <LUIGELTON> Turns Luigi's flashlight on.
LUIGELTOFF <LUIGELTOFF> Turns Luigi's flashlight off.
NECKON <NECKON> Enable Luigi staring at objects.
NECKOFF <NECKOFF> Disables Luigi staring at objects.
SETLUIGI <SETLUIGI>
URALUIGI <URALUIGI> Enables the Hidden Mansion game mode.
OMOTELUIGI <OMOTELUIGI> Disables the Hidden Mansion game mode.
WEAPON <WEAPON> Equips Luigi with the Poltergust
NOWEAPON <NOWEAPON> Unequips Luigi with the Poltergust

HUD Related

Tag Syntax Description Verified
CHOICE <CHOICE>
CLOSEWINDOW <CLOSEWINDOW> Closes a dialogue box.
COLOR <COLOR>(1) Defines the color of text from the dialogue file.
NORMALSCREEN <NORMALSCREEN> Enables the in-game HUD elements.
FULLSCREEN <FULLSCREEN> Disables the in-game HUD elements.
MENUON <MENUON> Enables the in-game menus.
MENUOFF <MENUOFF> Disables the in-game menus.
SAY <SAY>(#) Displays the rest of the text on the line.
SPEAK <SPEAK>(#) Displays the specified line from the dialogue file.
WINDOW <WINDOW>(#) Displays a dialogue box.

Script Related

Tag Syntax Description Verified
ANYKEY <ANYKEY> Press any button to continue script execution.
CANCEL <CANCEL>
CASE <CASE>(#)
CHECKFLAG <CHECKFLAG>(#)"CASE1""CASE" Checks the state of the flag with the ID specified.
CHECKTELESA <CHECKTELESA>
CLEARCOUNT <CLEARCOUNT> Resets the current value of the count to 0.
COUNTJMP <COUNTJMP>"case0""case1" Jumps to the specified case's list position based on the current value of the count.
COUNTJMP2 <COUNTJMP2>
COUNTUP <COUNTUP> Increases the current value of the count by 1.
END <END> Stops a script from executing any further.
ENDLESS <ENDLESS> The event never ends. UNVERIFIED
EVENTWAIT <EVENTWAIT>(255)
FLAGON <FLAGON>(#) Enables the flag with the ID specified.
FLAGOFF <FLAGOFF>(#) Disables the flag with the ID specified.
GHOSTRESET <GHOSTRESET> Reset <GHOSTTOTAL> to zero.
GHOSTTOTAL <GHOSTTOTAL>(#) Compares the amount of ghost's caught with the value specified.
RANDOMJMP <RANDOMJMP>"case0""case1" Jumps randomly to one of the specified case's.
REPLACE <REPLACE>
TIMEACTIVE <TIMEACTIVE>
TIMESTOP <TIMESTOP>
TIMERSTOP <TIMERSTOP>
WAIT <WAIT>(#) Delays script execution for a specified amount of frames. (NTSC: 30 = 1 second, PAL: 25 = 1 second)

Camera Related

Tag Syntax Description Verified
CAMERA <CAMERA>(.cmn) Play's the camera sequence specified. (Script proceeds execution)
CAMERAWAIT <CAMERAWAIT>(#)
CAMERAEND <CAMERAEND> End's the camera.
CAMENDFAST <CAMENDFAST> Camera ends quickly.
CAMMODEON <CAMMODEON>
COMMODEOFF <CAMMODEOFF>
CAMSHAKE <CAMSHAKE> Camera shaking. (A SFX is also played)
CAMTARGET <CAMTARGET>"dm_luigi" The camera targets/looks a specific actor.
CAMTARGET2 <CAMTARGET2>
GCAMERA <GCAMERA>"cam_tdm1.cmn" Load/Specify specific camera

Sound Related

Tag Syntax Description Verified
SE <SE>(#) Plays the sound effect with the ID specified.
LEVSE <LEVSE>
LEVSTOP <LEVSTOP>
BGM <BGM>(#) Plays the BGM with the ID specified.
BGMSTOP <BGMSTOP> Stops the currently playing BGM.

Warp / Transition Related

Tag Syntax Description Verified
ACCOUNT <ACCOUNT> Opens the Portrait Ghost Results screen
CONTEXP <CONTEXP> Opens the Training Room Controls screen.
ENDING <ENDING> Opens the End Credits screen.
GALLERY <GALLERY> Opens the View Painting screen.
HSAVE <HSAVE> Opens the E-Gadd's Save Game screen.
OPENING <OPENING> Plays the opening sequence, then warps you to the mansion.
SAVE <SAVE> Opens the Toad's Save Game screen.
TITLE <TITLE> Opens the title screen.
WARP <WARP>(#) Warps Luigi to the map with the ID specified.
WARPMOVE <WARPMOVE>(#) Teleports Luigi to the warp point with the specified ID in the current Map.
WIPEKIND <WIPEKIND>(#) Which transition effect to use when warping.
WIPETIME <WIPETIME> How long the transition should last for when warping.

Light Related

Tag Syntax Description Verified
GPATHLIGHT <GPATHLIGHT>"cam_tdm2.lig"
HLIGHTON <HLIGHTON>
HLIGHTOFF <HLIGHTOFF>
LIGHT <LIGHT> Makes Mansion bright.
LLIGHTON <LLIGHTON>
LLIGHTOFF <LLIGHTOFF>
MANLIGHT <MANLIGHT>
PATHLIGHT <PATHLIGHT>"cam_tdm2.lig"
PATHLIGHTEND <PATHLIGHTEND>
PLIGHT <PLIGHT>(0) Enables / disables the current room's lighting. (0 for dark, 1 for lit.)

In-game Related

Tag Syntax Description Verified
EFFECT <EFFECT>"CodeName""Animation?" Enables an effect. UNVERIFIED
GENON <GENON>"CodeName" Enables the generator with the specified CodeName in generatorinfo.
GENOFF <GENOFF>"CodeName" Disables the generator with the specified CodeName in generatorinfo.
KEYLOCK <KEYLOCK>(#) Locks the door with the door ID specified.
KEYUNLOCK <KEYUNLOCK>(#) Unlocks the door with the door ID specified.
THUNDERN <THUNDERN>(x)(y)(z)(1) A lightning bolt will strike at the absolute position specified.
THUNDERN2 <THUNDERN2>(x)(y)(z)(1) A lightning bolt will strike at the absolute position specified.
TURNON <TURNON> Disables the actual blackout. (Power ON)
TURNOFF <TURNOFF> Enables the actual blackout. (Power OFF)



Unsorted

Tag Syntax Description Verified
BEAM <BEAM> VACUUM BEAM RELATED
BEAMCUT <BEAMCUT> VACUUM BEAM RELATED
BEAMON <BEAMON> Turns the flashlight on VACUUM BEAM RELATED
BEAMOFF <BEAMOFF> Turns the flashlight off VACUUM BEAM RELATED
FRAMESTART <FRAMESTART>
FRAMEEND <FRAMEEND>
FREE <FREE>"dm_luigi"
OVERLAP <OVERLAP>
PDEMO <PDEMO>"gb_endcall" Load an ADemo file or sequence. (E. Gadd on GBH.) UNVERIFIED