HATPC Reborn User Level Resources

Events

HATPC Reborn events are lines at the end of the level file (or inserted via a text box in CaveGen) defining various actions that the game will take.

There are 2 main types of events: Events with conditions, and unconditional events.

Events with Conditions

There are currently four conditional events you can define:

• Messages, which display a text box on the screen above (or below) Hannah
• Pausing messages, which pause the game and display a message over the whole screen
• Checkpoints, which save the state of the game (to be loaded on death or restart)
• NOP or "No OPeration" events, which do nothing besides triggering other events

To add these events to a level, add a line to the end of the level code that begins with the $ character, followed by the code for the event:

• Message: $msg(ID, message)
• Pasuing message: $msgp(ID, message)
• Checkpoint: $cp(ID)
• NOP: $nop(ID)

The "ID" parameter is a non-negative integer that identifies this event. It does not need to be unique, and it is ignored unless you make use of the "multi()" or "id()" parameters which I'll explain later.

The "message" parameter for the $msg and $msgp events is the text to be displayed on the screen. Note that any # characters in this message will be replaced with newlines, but the game will also automatically insert line breaks as needed. It can be entered with or without quotes around it.

Conditions

Once you've created your event, you'll want to control when the event goes off. To control that, you have access to a bunch of conditions, defined by adding them onto the line your event is defined on. These conditions must all be true for the event to occur, so you can imagine they are joined by a logical AND gate. An event with no conditions is automatically triggered when the level starts. The game automatically generates a checkpoint event with no conditions at the start of every level, so until any more checkpoints are triggered, dying or restarting restores to that point.

Here are the conditions you can set:

• at(x, y) //True if Hannah is at the specified coordinates
• in(x1, y1, x2, y2) //True if Hannah is in the specified rectangular area
• treasures(n) //True if n treasures have been collected
• tile(x, y, char) //True if the tile at coordinates (x, y) is equal to char
• water(x, y, water_level) //True if the water level at coordinates (x, y) is equal to or greater than water_level
• id(type, value) //Triggered by other events in various ways explained below

In addition to those conditions, there are two special parameters which you can add to modify event behavior:

• multi() //This event can trigger multiple times, but will not trigger if the last event which triggered had the same ID
• quiet() //This event's triggering will be hidden from "multi()" and "id()" parameters of other events

And here are some tips for using conditions:

The x and y coordinates used count up from the top left of the level, and start at one. To find the coordinates of a position in your cave, you can put the cave file minus the header lines in Notepad++ and put your cursor to the left of the spot you want the coords of. The "Col:" number will be the x coord, and the "Ln:" number will be the y coord.

The "in()" condition ignores the order in which you enter the x and y values, so don't worry about sorting them, just enter your two points in whatever order you want.

The char in the "tile()" condition is the character you would use to code for that tile in a level file. The "tile()" condition is also triggered by objects falling past the given location.

The "id()" condition has four types:

• id(skip, value) //If an event of ID greater than or equal to value has been triggered already, skip this event
• id(prereq, value) //Requires an event of ID greater than or equal to value to be true
• id(exact, value) //If an event of ID = value has been triggered, this condition is true
• id(not, value) //If an event of ID = value have been triggered, skip this event

"skip" is the opposite of "prereq" and "exact" is the opposite of "not". Once a "not" or "skip" condition becomes false, it actually deletes the event entirely since there is no way for those conditions to become true again.

Unconditional Events

There are three unconditional events that trigger at the start of the level and ignore all conditions set for them. These act more like flags you can set in the level file than actual events.

Here are their codes:

• $inv() //Enables startup invincibility for the 1.5 seconds of the level
• $deadly_water() //Enables deadly water, which kills Hannah on contact
• $next(URL) //Enqueues the URL to the level series - after this level is complete, the game will automatically load the next level in the series.

The URL parameter in $next is the URL of the level file for the next level encoded with URL encoding. If you need to URL-encode a URL, you can use this encoder.

If the level you want to enqueue is in CaveGen, you can grab the URL-encoded URL by clicking on the play link and then copying everything after the "?cave=" from the address bar.

If the level is on The Interguild, the URL of the level file will be http://www.interguild.org/levels/levels/#####.txt but with the ##### replaced with the numerical level ID (found in its Interguild page URL).