HLD level file format

OVERVIEW
--------

Each line type lists its indentation (usually 0 for section headers and 5 for instances),
the format of values in the line, and an example line of that type.

The 'Format' of a line describes the list of values it contains. Each entry's type is specified with
one of the following characters:
    #   Constant String
    &   String
    !   Number
    >   List

Additionally, any of these may have a key e.g. !(0) for an Integer with key 0.
All keys are of type integer. In a line, each value is followed by a comma.




HEADER
------

The header of a map file contains the following types of lines.

Indent 0
Format:
    #   DATE
    !   The date when the map was last updated
Example:
DATE,42474.87,


Indent 0
Format:
    #   //EDITOR SETTINGS//
Example:
//EDITOR SETTINGS//


Indent 5
Format:
    #   layerName
    !   ID number, starts from 0
    &   Name
Example:
     layerName,0,Doors,
Notes:
This line occurs once for each layer.


Indent 0
Format:
    #   //ROOM SETTINGS//
Example:
//ROOM SETTINGS//


Indent 5
Format:
    #   lb
    !   ?
    #   bg
    &   Background Sprite
    #   floorSpr
    &   Floor Sprite
    #   bri
    !   Brightness (1=bright,2=dim,3=dark,4=very dark)
    #   liteOff
    !   Equivalent to brightness 3, but can be toggled by events (bool)
    #   over
    &   Overlay (custom brightness & palette settings?)
    #   overPit
    !   ?
    #   wallsTop
    !   Shade tops of walls (bool)
    #   shadows
    !   ?
    #   flrOutline
    !   Floor Outline (bool)
    #   flrOC
    !   Floor Outline Color
    #   flrOSpr
    &   Floor Outline Sprite
    #   wallO
    !   Wall outlines (bool)
    #   w
    !   Room width
    #   h
    !   Room Height
    #   sketchalpha
    !   ?
    ?   ?
    ?   ?
Example:
     lb,1,bg,<undefined>,floorSpr,bg_N_Inter_Floor,bri,1,liteOff,0,over,bg_NL_AltarThrone_Overlay,overPit,0,wallsTop,1,shadows,1,flrOutline,1,flrOC,16777215,flrOSpr,<undefined>,wallO,0,w,768,h,480,sketchalpha,0,1,1,
Notes:
???


BODY
----


The body of a map file contains 2 types of lines, object declarations and object instances.


Object Declaration:

Indent 0
Format:
    &   //XXXX// where XXXX is the object type
Example:
//Gearbit//
Notes:
An object type must be declared in a file before any of its instances.


Object Instances:

Indent 5
Format:
    #   obj
    &   Object type
    !   ID number
    !   X position
    !   Y position
    !   Layer ID number
    >   Dependencies
    #   ++
    >   Arguments
Example:
     obj,Spawner,3594,736,112,4,-999999,++,-1=GearbitCrate,-2=-999999,-4=1,-5=0,-6=-1,-7=0,-8=0,
Notes:
Dependencies and Arguments are lists of variable length, and depend on the object type. Some object types cannot have dependencies. In this example, Dependencies = '-999999,' and Arguments = '-1=GearbitCrate,-2=-999999,-4=1,-5=0,-6=-1,-7=0,-8=0,'




DEPENDENCIES
------------


Format:
    !   Number of dependencies
    >   Dependency IDs (defaults to -999999 if above is 0
    #   caseScript
    !   Object type of dependencies (3 = Flag, 4 = Enemy)
    !   Inversion (1 means true when dependent flag is true or enemy is dead, 0 is the opposite)
    ?   ???
    !   Delay (frames @30fps)



ARGUMENTS
---------


Each object type has its own set of arguments, listed below.


Type:
    Spawner
Format:
    &(-1)   Object to spawn
    !(-2)   ?
    !(-4)   Number of instances to spawn
    !(-5)   Delay on spawn (frames @30fps)
    !(-6)   ?
    !(-7)   ?
    !(-8)   ?
    >       Arguments for the spawned object
Example:
     obj,Spawner,5055,400,144,2,-999999,++,-1=CultBird,-2=-999999,-4=1,-5=0,-6=-1,-7=0,-8=0,
Notes:
Arguments -2 through -8 are the dependencies for the spawned object?


Type:
    Scenery
    RecessingScenery
    SnowPile
Format:
    &(0)    Sprite
    !(1)    ?
    !(2)    ?
    !(3)    ?
    !(k)    ?
    !(p)    ?
    !(fp)   ?
    !(4)    ?
    !(5)    ?
    !(f)    ?
    !(l)    ?
Example:
     obj,Scenery,4030,656,-37,7,-999999,++,0=spr_N_FG_OverG_B,1=0,2=0,3=0,k=0,p=-4,fp=0,4=0,5=1,f=0,l=0,


Type:
    door
Format:
    &(rm)   Destination Room
    !(dr)   ID of door in destination room
    !(ed)   Exit direction
    !(wo)   Walk out (bool)
    !(tl)   Something televator related? (optional)
Example:
     obj,door,5618,176,112,0,1,1507,caseScript,3,1,-999999,0,++,rm=rm_NC_CrushArena,dr=7260,ed=270,wo=1,


Type:
    Region
    RegionWall
Format:
    !(0)    Width
    !(1)    Height
    !(p2)   Player 2 spawnable? (bool, optional)
Example:
     obj,Region,1034,312,64,11,-999999,caseScript,2,1,char,0,++,0=344,1=160,


Type:
    EmptyObject
Format:
    &(mn)   Comment
    !(a)    ?
Example:
     obj,EmptyObject,2283,704,-32,11,1,1414,caseScript,3,0,-999999,30,++,mn=--,a=-1,


Type:
    BoomBox
Format:
    &(s)    Sound
    !(v)    Volume (out of 100)
    !(2)    ?
    !(3)    ?
    !(4)    ?
    !(5)    ?
    !(6)    ?
Example:
     obj,BoomBox,6749,79,133,12,-999999,caseScript,0,1,-999999,0,++,s=MUS_N_GAP_1,v=100,2=8,3=8,4=8,5=0,6=0,


Type:
    ParallaxObj
Format:
    &(spr)  Sprite
    !(scl)  ?
    !(lv)   ?
    !(0)    ?
    !(1)    ?
    !(2)    ?
    !(3)    ?
    !(4)    ?
    !(5)    ?
    !(6)    ?
    !(fg)   ?
Example:
     obj,ParallaxObj,3370,496,104,9,-999999,++,spr=bg_N_Prlx_library,spd=0,scl=1,lv=0,0=0,1=0,2=0.18,3=1,4=1,5=0,6=0,fg=0,


Type:
    CameraLock
Format:
    !(x)    X Position
    !(y)    Y Position
    !(xL)   Scroll left (bool)
    !(xR)   Scroll right (bool)
    !(yU)   Scroll up (bool)
    !(YD)   Scroll down (bool)
    !(0)    ?
    !(1)    ?
Example:
     obj,CameraLock,1949,304,-96,5,-999999,caseScript,3,1,-999999,0,++,x=330,y=145,xL=1,xR=1,yU=0,yD=0,0=-1,1=-1,


Type:
    JumpPad
Format:
    !(7)    ?
    !(9)    2 way (bool)
Example:
     obj,JumpPad,141,304,264,1,-999999,++,7=56,9=1,


Type:
    Ambience
Format:
    !(g)    ?
    !(r)    ?
    !(ra)   ?
    !(rs)   ?
    &(s)    Sound
    !(v)    Volume (out of 100)
    !(min)  ?
    !(max)  ?
Example:
     obj,Ambience,6890,302,282,7,-999999,++,g=1,r=0,ra=0,rs=150,s=MUS_AMB_WIND_EERIE_0,v=75,min=100,max=350,


Type:
    ColorRegion
Format:
    !(w)    Width
    !(h)    Height
    !(c)    Color
Example:
     obj,ColorRegion,3243,48,0,10,-999999,++,w=1184,h=1024,c=4004413,


Type:
    WellCheck
Format:
    !(r)    Area
    !(n)    ?
Example:
     obj,WellCheck,5504,464,840,0,-999999,++,r=1,n=0,


Type:
    SnowMaker
    SlowSnow
    rainmaker
    RainbowGlitter
Format:
    !(00)   Particle Amount (~560 and above makes the screen entirely white)
    !(01)   Horizontal Particle Speed
Example:
     obj,SnowMaker,4657,480,928,0,-999999,++,00=5,01=1,
     obj,rainmaker,6161,208,144,7,-999999,++,00=5


Type:
    ModuleDoor
    DrifterVaultDoor
Format:
    !(c)    Count Required
Example:
     obj,DrifterVaultDoor,4171,1096,1216,6,-999999,caseScript,3,1,-999999,0,++,c=12,


Type:
    Televator
Format:
    &(rm)   Destination Room
    !(dr)   ID of door in destination room
    !(ed)   Ascending (bool)
    !(m)    Module? (bool)
    !(v)    Vertical? (bool)
    !(a)    Abyss sprite (bool)
    !(trn)  Skip shaft room? (bool)
Example:
     obj,Televator,1557,1040,1312,0,-999999,++,rm=rm_PAX_Staging,dr=4155,ed=0,m=0,v=1,a=0,trn=0,


Type:
    Teleporter
Format:
    &(r)    Destination Room
    !(d)    ID of door in destination room
    !(t)    Interactable (bool)
    !(i)    Invisible (bool)
Example:
     obj,Teleporter,2696,1176,168,0,-999999,++,r=rm_IN_BackerTablet,d=1476,t=1,i=0,


Type:
    CameraCue
Format:
    !(0)    Camera X position
    !(1)    Camera Y position
    !(2)    Zoom out factor
    !(3)    Camera movement duration (seconds)
    !(4)    Delay after camera pause (seconds)
    !(5)    Camera pause duration (seconds)
Example:
     obj,CameraCue,6325,664,520,11,1,5365,caseScript,3,1,-999999,0,++,0=746,1=733,2=1,3=3,4=3,5=2,


Type:
    BossRush
Format:
    !(01)   Timer paused (bool)
Example:
     obj,BossRush,4846,144,384,0,-999999,++,01=0,


Type:
    RisingPlatform
    InvisiblePlatform
Format:
    !(s)    Size (values other than 48 don't work correctly)
Example:
     obj,RisingPlatform,3763,288,128,2,1,7279,caseScript,3,0,-999999,0,++,s=48,


Type:
    DropPlatform
Format:
    !(b)    ?
    !(32)   ?
Example:
     obj,DropPlatform,5228,288,224,3,-999999,++,b=0,32=0,


Type:
    PhaseCrystalMaker
Format:
    &(s)    Sprite
    !(i)    Alternate sprite (bool)
    !(xs)   Horizontal stretch factor
Example:
     obj,PhaseCrystalMaker,879,320,104,3,-999999,++,s=spr_WCrystalClean,i=1,xs=1,


Type:
    destructable
    HealthPlant
Format:
    &(0)    Sprite
    !(1)    ?
    !(2)    Class (see table below)
    &(3)    Particle sprite
    !(5)    Modify sprites somehow? (bool)
Example:
     obj,destructable,1899,656,832,9,-999999,++,0=<undefined>,1=0,2=3,3=spr_GrassDebris,5=1,
Notes:
Class| Solid | Sound | Debris
0    | Yes   | Box   |
1    | Yes   | Glass
2    | Yes   | Shrub
3    | No    | Shrub
4    | Yes   | ?
5    | Yes   | ?
6    | Yes   | ?     | None

Type:
    NPCGeneric
Format:
    !(wlb)  ?
    !(wl)   ?
    &(32)   Sprite 1?
    &(300)  Sprite 2?
    &(301)  Sprite 3?
    &(302)  Sprite 4?
    &(310)  Sprite 4?
    !(xs)   ?
    !(bi)   ?
    !(tr)   ?
    !(tg)   ?
Example:
     obj,NPCGeneric,1730,1072,120,2,-999999,++,wlb=1,wl=-999999,32=spr_none,300=spr_NPC_northgrannybird_idleLook,301=spr_NPC_northgrannybird_idleStroke,302=spr_NPC_northgrannybird_idleLook,310=spr_NPCBirdman_Idle,xs=1,bi=0,tr=0,tg=0,


Type:
    Hoarde
Format:
    !(01)   Hoarde type (0=south,1=north,2=east,3=west,4=all)
Example:
     obj,Hoarde,6331,32,112,0,-999999,++,01=2,


Type:
    EditorCutscene
Format:
    &(v)    Video filename
Example:
     obj,EditorCutscene,4801,240,-29,10,-999999,caseScript,3,1,-999999,0,++,v=toweranimatic_1.mov,


Type:
    TrueAtInterval
Format:
    !(i)    Interval length (frames @30fps)
Example:
     obj,TrueAtInterval,7638,320,80,0,-999999,++,i=120,


Type:
    MovingPlatform
Format:
    &(s)    Sprite
    *(wp)   Destination (x&y&)
    !(e)    Class
Example:
     obj,MovingPlatform,7638,320,80,0,-999999,++,s=spr_TelevatorPlatform,wp=225&528&,e=1,
Notes:
Class | Speed | Remove Control
0     | Slow  | No
1     | Fast  | Yes
2     | Fast  | No


Type:
    ToggleSwitch
Format:
    !(a)    ?
    !(1)    ?
Example:
     a=-999999,1=0,