42 lines
1.1 KiB
JavaScript
42 lines
1.1 KiB
JavaScript
/************************************************************************
|
|
## Fireworks Module
|
|
|
|
The fireworks module makes it easy to create fireworks using
|
|
ScriptCraft. The module has a single function `firework` which takes
|
|
a `org.bukkit.Location` as its 1 and only parameter.
|
|
|
|
### Examples
|
|
|
|
The module also extends the `Drone` object adding a `firework` method
|
|
so that fireworks can be created as a part of a Drone chain. For
|
|
Example....
|
|
|
|
/js firework()
|
|
|
|
... creates a single firework, while ....
|
|
|
|
/js firework().fwd(3).times(5)
|
|
|
|
... creates 5 fireworks in a row. Fireworks have also been added as a
|
|
possible option for the `arrow` module. To have a firework launch
|
|
where an arrow strikes...
|
|
|
|
/js arrows.firework()
|
|
|
|
To call the fireworks.firework() function directly, you must provide a
|
|
location. For example...
|
|
|
|
/js var fireworks = require('fireworks');
|
|
/js fireworks.firework( self.location );
|
|
|
|
![firework example](img/firework.png)
|
|
|
|
***/
|
|
|
|
if ( __plugin.canary ) {
|
|
exports.firework = require('./canary/fireworks');
|
|
} else {
|
|
exports.firework = require('./bukkit/fireworks');
|
|
}
|
|
|
|
|