From 1c05da186251c26c33c5806dc654ce5c735324b4 Mon Sep 17 00:00:00 2001 From: walterhiggins Date: Sat, 28 Dec 2013 23:02:50 +0000 Subject: [PATCH] Documentation tweaks. Changed heading levels for the arrows and commando modules. --- docs/API-Reference.md | 16 ++++++++-------- src/main/javascript/plugins/arrows.js | 6 +++--- src/main/javascript/plugins/commando/commando.js | 10 +++++----- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/API-Reference.md b/docs/API-Reference.md index a2f42ef..9d3dfda 100644 --- a/docs/API-Reference.md +++ b/docs/API-Reference.md @@ -1730,9 +1730,9 @@ To construct a spiral staircase 5 floors high made of oak... spiral_stairs('oak', 5); -# Arrows Module +## Arrows Module -## Description +### Description The arrows mod adds fancy arrows to the game. Arrows which... * Launch fireworks. @@ -1741,7 +1741,7 @@ The arrows mod adds fancy arrows to the game. Arrows which... * Teleport the player to the landing spot. * Spawn Trees at the landing spot. -## Usage: +### Usage: * `/js arrows.firework()` - A firework launches where the 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 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 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 of the ScriptCraft core. -## Example hi-command.js +### Example hi-command.js var commando = require('../commando'); commando('hi', function(){ @@ -1896,7 +1896,7 @@ of the ScriptCraft core. ...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}; 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) -## Caveats +### Caveats Since commands registered using commando are really just appendages to the `/jsp` command and are not actually registered globally (it just diff --git a/src/main/javascript/plugins/arrows.js b/src/main/javascript/plugins/arrows.js index ef2ed6f..5b87fab 100644 --- a/src/main/javascript/plugins/arrows.js +++ b/src/main/javascript/plugins/arrows.js @@ -1,7 +1,7 @@ /************************************************************************* -# Arrows Module +## Arrows Module -## Description +### Description The arrows mod adds fancy arrows to the game. Arrows which... * Launch fireworks. @@ -10,7 +10,7 @@ The arrows mod adds fancy arrows to the game. Arrows which... * Teleport the player to the landing spot. * Spawn Trees at the landing spot. -## Usage: +### Usage: * `/js arrows.firework()` - A firework launches where the the arrow lands. * `/js arrows.lightning()` - lightning strikes where the arrow lands. diff --git a/src/main/javascript/plugins/commando/commando.js b/src/main/javascript/plugins/commando/commando.js index 871e62b..403bee9 100644 --- a/src/main/javascript/plugins/commando/commando.js +++ b/src/main/javascript/plugins/commando/commando.js @@ -1,7 +1,7 @@ /************************************************************************* -# Commando Plugin +## Commando Plugin -## Description +### Description commando is a plugin which can be used to add completely new commands 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 of the ScriptCraft core. -## Example hi-command.js +### Example hi-command.js var commando = require('../commando'); commando('hi', function(){ @@ -51,7 +51,7 @@ of the ScriptCraft core. ...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}; 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) -## Caveats +### Caveats Since commands registered using commando are really just appendages to the `/jsp` command and are not actually registered globally (it just