                                                Ŀ
                           LEVEL EDITOR REFERENCE
                         


Note, this document is largely unfinished.

Contents:

1. INTRODUCTION
2. GADGETS


1. INTRODUCTION

The editor for Black Shrapnel is intended for development use only, as
it would take intense hard work to tidy it up and cater for the most
/simple/ of computer users. For this reason, it will not appear in the
final version.

To use the editor, use the command-line option -edit.

Another option is -nogads. This suppresses the loading of gadgets from level
files. Usefull for when a change to the code causes only the gadgets to
become incompatible, so you can still load in the scenario map.

The most usefull help of all is to press F1 in the editor.

Whilst Black Shrapnel is under development many changes could result in
old versions of the level files becoming incompatible. For this reson,
level design will be one of the very last development processes.


2. GADGETS

Gadgets are anything placeable on the map that isn't a tile. Stuff like
enemy formations, powerups, global events, special effects, etc... All
gadgets are activated when their hot-spot is equal or less than 30 pixels
to the right of the screen (this is subject to change).

i. Powerup Gadgets

Quite simple. These have no special attributes.

ii. Enemy Gadgets

An enemy is anything which is vulnerable to the players fire-power.

Events can be added to Enemy Gadgets. These events are normally triggered
when the enemy is destroyed in any way other than being deleted from the
game by exiting off the left of the screen. Some enemies may have exeption
to this case, such as a switch. This feature can be used to blow-up scenary
surrounding a static emplacement, like gun-turrets, buildings, ect..., or
can be used to open secrets/bonuses by triggering switches. The
possibilities are endless!

One powerup type can also be assigned to an Enemy Gadget. The powerup is
usually created in the position of the enemy when it's destroyed.

Animation can be reveresed.

Enemies can be marked hostile. Which means they will shoot at the player.

More complex enemy specific attributes are planned.

The clone option doesn't clone any special attributes of an enemy.

iii. Global Event Gadgets

Global Event Gadgets can only be placed along the X axis.

Events can be assigned. They are triggered when the Gadget is activated.
This feature is used to set the scroll speed at the start of the level,
stop the scrolling at the end of the level for the `end guardian' battle,
or end the lavel. Cave explosions can also be triggered at certain stages
in the level, etc.. Again, the possibilities are potentially endless.

iiii. Effects

Effects are things like flames spurting out of pipes and stuff. They have
many unique attributes.
