Skip to content

Commit

Permalink
further syntax-highlighting and ignore netbeans folder.
Browse files Browse the repository at this point in the history
  • Loading branch information
@walterhiggins
walterhiggins committed Feb 4, 2014
1 parent f1925ef commit 39b459a
Show file tree
Hide file tree
Showing 6 changed files with 119 additions and 97 deletions.
2 changes: 2 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ target
build.local.properties
/src/main/javascript/lib/.#tabcomplete.js
/src/main/javascript/plugins/.#example-1.js
/nbproject/private/private.xml
/nbproject/project.xml
98 changes: 54 additions & 44 deletions docs/API-Reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -693,29 +693,36 @@ function each time the event is fired.

The following code will print a message on screen every time a block is broken in the game

events.on('block.BlockBreakEvent', function(listener, evt){
evt.player.sendMessage( evt.player.name + ' broke a block!');
});
```javascript
events.on( 'block.BlockBreakEvent', function( listener, evt ) {
evt.player.sendMessage( evt.player.name + ' broke a block!');
} );
```

To handle an event only once and unregister from further events...

events.on('block.BlockBreakEvent', function(listener, evt){
evt.player.sendMessage( evt.player.name + ' broke a block!');
evt.handlers.unregister(listener);
});

```javascript
events.on( 'block.BlockBreakEvent', function( listener, evt ) {
evt.player.sendMessage( evt.player.name + ' broke a block!');
evt.handlers.unregister( listener );
} );

To unregister a listener *outside* of the listener function...

var myBlockBreakListener = events.on('block.BlockBreakEvent',function(l,e){ ... });
...
var handlers = org.bukkit.event.block.BlockBreakEvent.getHandlerList();
handlers.unregister(myBlockBreakListener);
```javascript
var myBlockBreakListener = events.on( 'block.BlockBreakEvent', function( l, e ) { ... } );
...
var handlers = org.bukkit.event.block.BlockBreakEvent.getHandlerList();
handlers.unregister(myBlockBreakListener);
```

To listen for events using a full class name as the `eventName` parameter...

events.on(org.bukkit.event.block.BlockBreakEvent, function(listener, evt){
evt.player.sendMessage( evt.player.name + ' broke a block!');
});
```javascript
events.on( org.bukkit.event.block.BlockBreakEvent, function( listener, evt ) {
evt.player.sendMessage( evt.player.name + ' broke a block!');
} );
```

[buk2]: http://wiki.bukkit.org/Event_API_Reference
[buk]: http://jd.bukkit.org/dev/apidocs/index.html?org/bukkit/event/Event.html
Expand Down Expand Up @@ -949,30 +956,31 @@ an interactive sign.
#### Example: Create a sign which changes the time of day.
##### plugins/signs/time-of-day.js
var utils = require('utils'),
signs = require('signs');
var onTimeChoice = function(event){
var selectedIndex = event.number;
// convert to Minecraft time 0 = Dawn, 6000 = midday, 12000 = dusk, 18000 = midnight
var time = selectedIndex * 6000;
event.player.location.world.setTime(time);
};
```javascript
var utils = require('utils'),
signs = require('signs');
var onTimeChoice = function(event){
var selectedIndex = event.number;
// convert to Minecraft time 0 = Dawn, 6000 = midday, 12000 = dusk, 18000 = midnight
var time = selectedIndex * 6000;
event.player.location.world.setTime(time);
};
// signs.menu returns a function which can be called for one or more signs in the game.
var convertToTimeMenu = signs.menu('Time of Day',
['Dawn', 'Midday', 'Dusk', 'Midnight'],
onTimeChoice);
// signs.menu returns a function which can be called for one or more signs in the game.
var convertToTimeMenu = signs.menu('Time of Day',
['Dawn', 'Midday', 'Dusk', 'Midnight'],
onTimeChoice);
exports.time_sign = function( player ){
var sign = signs.getTargetedBy(player);
if (!sign){
throw new Error('You must look at a sign');
}
convertToTimeMenu(sign);
};
exports.time_sign = function( player ){
var sign = signs.getTargetedBy(player);
if ( !sign ) {
throw new Error('You must look at a sign');
}
convertToTimeMenu(sign);
};
```
To use the above function at the in-game prompt, look at an existing
sign and type...
Expand All @@ -990,13 +998,15 @@ the entity has targeted. It is a utility function for use by plugin authors.

#### Example

var signs = require('signs'),
utils = require('utils');
var player = utils.player('tom1234');
var sign = signs.getTargetedBy( player );
if (!sign){
player.sendMessage('Not looking at a sign');
}
```javascript
var signs = require('signs'),
utils = require('utils');
var player = utils.player('tom1234');
var sign = signs.getTargetedBy( player );
if ( !sign ) {
player.sendMessage('Not looking at a sign');
}
```
[buksign]: http://jd.bukkit.org/dev/apidocs/org/bukkit/block/Sign.html
Expand Down
8 changes: 4 additions & 4 deletions docs/YoungPersonsGuideToProgrammingMinecraft.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,7 @@ loop. The following `while` loop counts to 100...

```javascript
var i = 1;
while (i <= 100){
while ( i <= 100 ) {
console.log( i );
i = i + 1;
}
Expand Down Expand Up @@ -892,12 +892,12 @@ type the following...

```javascript
var myskyscraper = function(floors) {
if (typeof floors == 'undefined'){
var i ;
if ( typeof floors == 'undefined' ) {
floors = 10;
}
this.chkpt('myskyscraper'); // saves the drone position so it can return there later
for (var i = 0; i < floors; i++)
{
for ( i = 0; i < floors; i++ ) {
this.box(blocks.iron,20,1,20)
.up()
.box0(blocks.glass_pane,20,3,20)
Expand Down
8 changes: 4 additions & 4 deletions src/docs/templates/ypgpm.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@ loop. The following `while` loop counts to 100...

```javascript
var i = 1;
while (i <= 100){
while ( i <= 100 ) {
console.log( i );
i = i + 1;
}
Expand Down Expand Up @@ -857,12 +857,12 @@ type the following...

```javascript
var myskyscraper = function(floors) {
if (typeof floors == 'undefined'){
var i ;
if ( typeof floors == 'undefined' ) {
floors = 10;
}
this.chkpt('myskyscraper'); // saves the drone position so it can return there later
for (var i = 0; i < floors; i++)
{
for ( i = 0; i < floors; i++ ) {
this.box(blocks.iron,20,1,20)
.up()
.box0(blocks.glass_pane,20,3,20)
Expand Down
37 changes: 22 additions & 15 deletions src/main/js/lib/events.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,29 +46,36 @@ function each time the event is fired.
The following code will print a message on screen every time a block is broken in the game
events.on('block.BlockBreakEvent', function(listener, evt){
evt.player.sendMessage( evt.player.name + ' broke a block!');
});
```javascript
events.on( 'block.BlockBreakEvent', function( listener, evt ) {
evt.player.sendMessage( evt.player.name + ' broke a block!');
} );
```
To handle an event only once and unregister from further events...
events.on('block.BlockBreakEvent', function(listener, evt){
evt.player.sendMessage( evt.player.name + ' broke a block!');
evt.handlers.unregister(listener);
});
```javascript
events.on( 'block.BlockBreakEvent', function( listener, evt ) {
evt.player.sendMessage( evt.player.name + ' broke a block!');
evt.handlers.unregister( listener );
} );
To unregister a listener *outside* of the listener function...
var myBlockBreakListener = events.on('block.BlockBreakEvent',function(l,e){ ... });
...
var handlers = org.bukkit.event.block.BlockBreakEvent.getHandlerList();
handlers.unregister(myBlockBreakListener);
```javascript
var myBlockBreakListener = events.on( 'block.BlockBreakEvent', function( l, e ) { ... } );
...
var handlers = org.bukkit.event.block.BlockBreakEvent.getHandlerList();
handlers.unregister(myBlockBreakListener);
```
To listen for events using a full class name as the `eventName` parameter...
events.on(org.bukkit.event.block.BlockBreakEvent, function(listener, evt){
evt.player.sendMessage( evt.player.name + ' broke a block!');
});
```javascript
events.on( org.bukkit.event.block.BlockBreakEvent, function( listener, evt ) {
evt.player.sendMessage( evt.player.name + ' broke a block!');
} );
```
[buk2]: http://wiki.bukkit.org/Event_API_Reference
[buk]: http://jd.bukkit.org/dev/apidocs/index.html?org/bukkit/event/Event.html
Expand Down
63 changes: 33 additions & 30 deletions src/main/js/modules/signs/signs.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,30 +37,31 @@ an interactive sign.
#### Example: Create a sign which changes the time of day.
##### plugins/signs/time-of-day.js
var utils = require('utils'),
signs = require('signs');
var onTimeChoice = function(event){
var selectedIndex = event.number;
// convert to Minecraft time 0 = Dawn, 6000 = midday, 12000 = dusk, 18000 = midnight
var time = selectedIndex * 6000;
event.player.location.world.setTime(time);
};
// signs.menu returns a function which can be called for one or more signs in the game.
var convertToTimeMenu = signs.menu('Time of Day',
['Dawn', 'Midday', 'Dusk', 'Midnight'],
onTimeChoice);
exports.time_sign = function( player ){
```javascript
var utils = require('utils'),
signs = require('signs');
var onTimeChoice = function(event){
var selectedIndex = event.number;
// convert to Minecraft time 0 = Dawn, 6000 = midday, 12000 = dusk, 18000 = midnight
var time = selectedIndex * 6000;
event.player.location.world.setTime(time);
};
var sign = signs.getTargetedBy(player);
if (!sign){
throw new Error('You must look at a sign');
}
convertToTimeMenu(sign);
};
// signs.menu returns a function which can be called for one or more signs in the game.
var convertToTimeMenu = signs.menu('Time of Day',
['Dawn', 'Midday', 'Dusk', 'Midnight'],
onTimeChoice);
exports.time_sign = function( player ){
var sign = signs.getTargetedBy(player);
if ( !sign ) {
throw new Error('You must look at a sign');
}
convertToTimeMenu(sign);
};
```
To use the above function at the in-game prompt, look at an existing
sign and type...
Expand All @@ -78,13 +79,15 @@ the entity has targeted. It is a utility function for use by plugin authors.
#### Example
var signs = require('signs'),
utils = require('utils');
var player = utils.player('tom1234');
var sign = signs.getTargetedBy( player );
if (!sign){
player.sendMessage('Not looking at a sign');
}
```javascript
var signs = require('signs'),
utils = require('utils');
var player = utils.player('tom1234');
var sign = signs.getTargetedBy( player );
if ( !sign ) {
player.sendMessage('Not looking at a sign');
}
```
[buksign]: http://jd.bukkit.org/dev/apidocs/org/bukkit/block/Sign.html
Expand Down

0 comments on commit 39b459a

Please sign in to comment.