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

tidy up docs on events-helper module.

Browse source
This commit is contained in:
walterhiggins 2014-04-26 20:31:52 +01:00
parent 1cfa6ff767
commit a314bf849f
2 changed files with 18 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/API-Reference.md
View file

@ -929,23 +929,26 @@ ScriptCraft uses Java's [String.format()][strfmt] so any string substitution ide
[webcons]: https://developer.mozilla.org/en-US/docs/Web/API/console [webcons]: https://developer.mozilla.org/en-US/docs/Web/API/console
## Events Helper Module ## Events Helper Module
The Events helper module provides a suite of functions one for each possible event. The Events helper module provides a suite of functions - one for each possible event.
For example, the blockBreak function in turn calls events.on(org.bukkit.event.block.BlockBreakEvent, callback, priority) For example, the events.blockBreak() function is just a wrapper function which calls events.on(org.bukkit.event.block.BlockBreakEvent, callback, priority)
This module is a convenience wrapper for easily add new event handlers. This module is a convenience wrapper for easily adding new event handling functions in Javascript.
At the in-game or server-console prompt, players/admins can type `events.` and use TAB completion
to choose from any of the approx. 160 different event types to listen to.
### Usage ### Usage
events.blockBreak(function(evt){ events.blockBreak(function(evt){
evt.player.sendMessage("You broke a block!"); evt.player.sendMessage("You broke a block!");
}); });
... which is just a shorter way of writing ... ... which is just a shorter and less error-prone way of writing ...
events.on("block.BlockBreakEvent",function(evt){ events.on("block.BlockBreakEvent",function(evt){
evt.player.sendMessage("You broke a block!"); evt.player.sendMessage("You broke a block!");
}); });
The crucial difference is that the events module will have functions for each The crucial difference is that the events module now has functions for each
of the built-in events so tab-completion will help of the built-in events. The functions are accessible via tab-completion so will help
beginning programmers to explore the events at the server console window. beginning programmers to explore the events at the server console window.
### events.worldUnload() ### events.worldUnload()

15
src/generateEventsHelper.js
View file

@ -8,23 +8,26 @@ var File = java.io.File,
var content = [ var content = [
'/*********************', '/*********************',
'## Events Helper Module', '## Events Helper Module',
'The Events helper module provides a suite of functions one for each possible event.', 'The Events helper module provides a suite of functions - one for each possible event.',
'For example, the blockBreak function in turn calls events.on(org.bukkit.event.block.BlockBreakEvent, callback, priority)', 'For example, the events.blockBreak() function is just a wrapper function which calls events.on(org.bukkit.event.block.BlockBreakEvent, callback, priority)',
'This module is a convenience wrapper for easily add new event handlers.', 'This module is a convenience wrapper for easily adding new event handling functions in Javascript. ',
'At the in-game or server-console prompt, players/admins can type `events.` and use TAB completion ',
'to choose from any of the approx. 160 different event types to listen to.',
'',
'### Usage', '### Usage',
'', '',
' events.blockBreak(function(evt){ ', ' events.blockBreak(function(evt){ ',
' evt.player.sendMessage("You broke a block!"); ', ' evt.player.sendMessage("You broke a block!"); ',
' });', ' });',
'', '',
'... which is just a shorter way of writing ...', '... which is just a shorter and less error-prone way of writing ...',
'', '',
' events.on("block.BlockBreakEvent",function(evt){ ', ' events.on("block.BlockBreakEvent",function(evt){ ',
' evt.player.sendMessage("You broke a block!");', ' evt.player.sendMessage("You broke a block!");',
' });', ' });',
'', '',
'The crucial difference is that the events module will have functions for each ', 'The crucial difference is that the events module now has functions for each ',
'of the built-in events so tab-completion will help ', 'of the built-in events. The functions are accessible via tab-completion so will help ',
'beginning programmers to explore the events at the server console window.', 'beginning programmers to explore the events at the server console window.',
'', '',
'***/' '***/'