arg/scriptcraft
Archived
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Documentation tweaks. Changed heading levels for the arrows and commando

Browse source 
modules.
This commit is contained in:
walterhiggins 2013-12-28 23:02:50 +00:00
parent 7679a1208f
commit 1c05da1862
3 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/API-Reference.md
View file

@ -1730,9 +1730,9 @@ To construct a spiral staircase 5 floors high made of oak...
spiral_stairs('oak', 5); spiral_stairs('oak', 5);
# Arrows Module ## Arrows Module
## Description ### Description
The arrows mod adds fancy arrows to the game. Arrows which... The arrows mod adds fancy arrows to the game. Arrows which...
* Launch fireworks. * Launch fireworks.
@ -1741,7 +1741,7 @@ The arrows mod adds fancy arrows to the game. Arrows which...
* Teleport the player to the landing spot. * Teleport the player to the landing spot.
* Spawn Trees at the landing spot. * Spawn Trees at the landing spot.
## Usage: ### Usage:
* `/js arrows.firework()` - A firework launches where the the arrow lands. * `/js arrows.firework()` - A firework launches where the the arrow lands.
* `/js arrows.lightning()` - lightning strikes where the arrow lands. * `/js arrows.lightning()` - lightning strikes where the arrow lands.
@ -1844,9 +1844,9 @@ To disallow scripting (and prevent players who join the server from using the co
Only ops users can run the classroom.allowScripting() function - this is so that students Only ops users can run the classroom.allowScripting() function - this is so that students
don't try to bar themselves and each other from scripting. don't try to bar themselves and each other from scripting.
# Commando Plugin ## Commando Plugin
## Description ### Description
commando is a plugin which can be used to add completely new commands commando is a plugin which can be used to add completely new commands
to Minecraft. Normally ScriptCraft only allows for provision of new to Minecraft. Normally ScriptCraft only allows for provision of new
@ -1887,7 +1887,7 @@ type `/jsp hi` for the above command example, players simply type
`/hi` . This functionality is provided as a plugin rather than as part `/hi` . This functionality is provided as a plugin rather than as part
of the ScriptCraft core. of the ScriptCraft core.
## Example hi-command.js ### Example hi-command.js
var commando = require('../commando'); var commando = require('../commando');
commando('hi', function(){ commando('hi', function(){
@ -1896,7 +1896,7 @@ of the ScriptCraft core.
...Displays a greeting to any player who issues the `/hi` command. ...Displays a greeting to any player who issues the `/hi` command.
## Example - timeofday-command.js ### Example - timeofday-command.js
var times = {Dawn: 0, Midday: 6000, Dusk: 12000, Midnight:18000}; var times = {Dawn: 0, Midday: 6000, Dusk: 12000, Midnight:18000};
commando('timeofday', function(params){ commando('timeofday', function(params){
@ -1906,7 +1906,7 @@ of the ScriptCraft core.
... changes the time of day using a new `/timeofday` command (options are Dawn, Midday, Dusk, Midnight) ... changes the time of day using a new `/timeofday` command (options are Dawn, Midday, Dusk, Midnight)
## Caveats ### Caveats
Since commands registered using commando are really just appendages to Since commands registered using commando are really just appendages to
the `/jsp` command and are not actually registered globally (it just the `/jsp` command and are not actually registered globally (it just

6
src/main/javascript/plugins/arrows.js
View file

@ -1,7 +1,7 @@
/************************************************************************* /*************************************************************************
# Arrows Module ## Arrows Module
## Description ### Description
The arrows mod adds fancy arrows to the game. Arrows which... The arrows mod adds fancy arrows to the game. Arrows which...
* Launch fireworks. * Launch fireworks.
@ -10,7 +10,7 @@ The arrows mod adds fancy arrows to the game. Arrows which...
* Teleport the player to the landing spot. * Teleport the player to the landing spot.
* Spawn Trees at the landing spot. * Spawn Trees at the landing spot.
## Usage: ### Usage:
* `/js arrows.firework()` - A firework launches where the the arrow lands. * `/js arrows.firework()` - A firework launches where the the arrow lands.
* `/js arrows.lightning()` - lightning strikes where the arrow lands. * `/js arrows.lightning()` - lightning strikes where the arrow lands.

10
src/main/javascript/plugins/commando/commando.js
View file

@ -1,7 +1,7 @@
/************************************************************************* /*************************************************************************
# Commando Plugin ## Commando Plugin
## Description ### Description
commando is a plugin which can be used to add completely new commands commando is a plugin which can be used to add completely new commands
to Minecraft. Normally ScriptCraft only allows for provision of new to Minecraft. Normally ScriptCraft only allows for provision of new
@ -42,7 +42,7 @@ type `/jsp hi` for the above command example, players simply type
`/hi` . This functionality is provided as a plugin rather than as part `/hi` . This functionality is provided as a plugin rather than as part
of the ScriptCraft core. of the ScriptCraft core.
## Example hi-command.js ### Example hi-command.js
var commando = require('../commando'); var commando = require('../commando');
commando('hi', function(){ commando('hi', function(){
@ -51,7 +51,7 @@ of the ScriptCraft core.
...Displays a greeting to any player who issues the `/hi` command. ...Displays a greeting to any player who issues the `/hi` command.
## Example - timeofday-command.js ### Example - timeofday-command.js
var times = {Dawn: 0, Midday: 6000, Dusk: 12000, Midnight:18000}; var times = {Dawn: 0, Midday: 6000, Dusk: 12000, Midnight:18000};
commando('timeofday', function(params){ commando('timeofday', function(params){
@ -61,7 +61,7 @@ of the ScriptCraft core.
... changes the time of day using a new `/timeofday` command (options are Dawn, Midday, Dusk, Midnight) ... changes the time of day using a new `/timeofday` command (options are Dawn, Midday, Dusk, Midnight)
## Caveats ### Caveats
Since commands registered using commando are really just appendages to Since commands registered using commando are really just appendages to
the `/jsp` command and are not actually registered globally (it just the `/jsp` command and are not actually registered globally (it just