Using RoofLib

RoofLib uses three area vars and one global var.

Global Var

COVER_LAYER - This is the graphical layer that area covers (roofs) appear on. The default value is 10.

Area Vars

covericon - The icon used for the area cover.

covericon_state - The icon_state used for the area cover. It defaults to ""

coverimage - The actual image of covericon and covericon_state created at runtime. You don't need to use this unless you want to change the coverimage during runtime.

To use RoofLib, all you have to do is define an area, assign a covericon (and covericon_state, if necessary) to the area, and draw the area on the map. It's that easy!

area redroof covericon = 'redroof.dmi'

Please look at test.dm and test.dmp for examples.

If you do any work with layers in your game, you will want to set COVER_LAYER above anything that should be hidden inside a covered region, but under anything that should not be obscured (like a HUD display).

Thank you for using RoofLib by Shadowdarke!