This repository has been archived on 2021-07-14. You can view files and clone it, but cannot push or open issues or pull requests.
scriptcraft/src/main/js/modules/utils/utils.js

838 lines
24 KiB
JavaScript

'use strict';
var File = java.io.File;
if (__plugin.bukkit){
var bkBukkit = org.bukkit.Bukkit,
bkLocation = org.bukkit.Location,
bkBlockCommandSender = org.bukkit.command.BlockCommandSender;
}
if (__plugin.canary){
var Canary = Packages.net.canarymod.Canary;
}
/************************************************************************
## Utilities Module
The `utils` module is a storehouse for various useful utility
functions which can be used by plugin and module authors. It contains
miscellaneous utility functions and classes to help with programming.
### utils.player() function
The utils.player() function will return a [bukkit Player][bkpl] object
with the given name. This function takes a single parameter
`playerName` which can be either a String or a [Player][bkpl] object -
if it's a Player object, then the same object is returned. If it's a
String, then it tries to find the player with that name.
#### Parameters
* playerName : A String or Player object. If no parameter is provided
then player() will try to return the `self` variable . It is
strongly recommended to provide a parameter.
#### Example
```javascript
var utils = require('utils');
var name = 'walterh';
var player = utils.player(name);
if ( player ) {
echo(player, 'Got ' + name);
} else {
console.log('No player named ' + name);
}
```
[bkpl]: http://jd.bukkit.org/dev/apidocs/org/bukkit/entity/Player.html
[bkloc]: http://jd.bukkit.org/dev/apidocs/org/bukkit/Location.html
***/
var _player = function ( playerName ) {
if ( typeof playerName == 'undefined' ) {
if ( typeof self == 'undefined' ) {
return null;
} else {
return self;
}
} else {
if ( typeof playerName == 'string' )
if (__plugin.canary) {
return Canary.server.getPlayer( playerName );
} else {
return bkBukkit.getPlayer( playerName );
}
else
return playerName; // assumes it's a player object
}
};
/*************************************************************************
### utils.locationToJSON() function
utils.locationToJSON() returns a [org.bukkit.Location][bkloc] object in JSON form...
{ world: 'world5',
x: 56.9324,
y: 103.9954,
z: 43.1323,
yaw: 0.0,
pitch: 0.0
}
This can be useful if you write a plugin that needs to store location data since bukkit's Location object is a Java object which cannot be serialized to JSON by default.
#### Parameters
* location: An object of type [org.bukkit.Location][bkloc]
#### Returns
A JSON object in the above form.
***/
var _locationToJSON = function( location ) {
return {
world: ''+location.world.name,
x: location.x,
y: location.y,
z: location.z,
yaw: location.yaw,
pitch: location.pitch
};
};
/*************************************************************************
### utils.locationToString() function
The utils.locationToString() function returns a
[org.bukkit.Location][bkloc] object in string form...
'{"world":"world5",x:56.9324,y:103.9954,z:43.1323,yaw:0.0,pitch:0.0}'
... which can be useful if you write a plugin which uses Locations as
keys in a lookup table.
#### Example
```javascript
var utils = require('utils');
...
var key = utils.locationToString(player.location);
lookupTable[key] = player.name;
```
***/
exports.locationToString = function( location ) {
return JSON.stringify( _locationToJSON( location ) );
};
exports.locationToJSON = _locationToJSON;
/*************************************************************************
### utils.locationFromJSON() function
This function reconstructs an [org.bukkit.Location][bkloc] object from
a JSON representation. This is the counterpart to the
`locationToJSON()` function. It takes a JSON object of the form
returned by locationToJSON() and reconstructs and returns a bukkit
Location object.
***/
exports.locationFromJSON = function( json ) {
var world;
if ( json.constuctor == Array ) {
// for support of legacy format
world = bkBukkit.getWorld( json[0] );
return new bkLocation( world, json[1], json[2] , json[3] );
} else {
if (__plugin.canary){
world = Canary.server.getWorld( json.world );
var cmLocation = Packages.net.canarymod.api.world.position.Location;
return new cmLocation(world, json.x, json.y, json.z, json.pitch, json.yaw);
} else {
world = bkBukkit.getWorld( json.world );
return new bkLocation( world, json.x, json.y , json.z, json.yaw, json.pitch );
}
}
};
exports.player = _player;
exports.getPlayerObject = function( player ) {
console.warn( 'utils.getPlayerObject() is deprecated. Use utils.player() instead.' );
return _player(player);
};
/*************************************************************************
### utils.getPlayerPos() function
This function returns the player's [Location][bkloc] (x, y, z, pitch
and yaw) for a named player. If the "player" is in fact a
[org.bukkit.command.BlockCommandSender][bkbcs] then the attached
Block's location is returned.
#### Parameters
* player : A [org.bukkit.command.CommandSender][bkbcs] (Player or BlockCommandSender) or player name (String).
#### Returns
An [org.bukkit.Location][bkloc] object.
[bkbcs]: http://jd.bukkit.org/dev/apidocs/org/bukkit/command/BlockCommandSender.html
[bksndr]: http://jd.bukkit.org/dev/apidocs/index.html?org/bukkit/command/CommandSender.html
***/
exports.getPlayerPos = function( player ) {
player = _player( player );
if ( player ) {
if ( player instanceof bkBlockCommandSender )
return player.block.location;
else
return player.location;
}
return null;
};
/************************************************************************
### utils.getMousePos() function
This function returns a [org.bukkit.Location][bkloc] object (the
x,y,z) of the current block being targeted by the named player. This
is the location of the block the player is looking at (targeting).
#### Parameters
* player : The player whose targeted location you wish to get.
#### Example
The following code will strike lightning at the location the player is looking at...
```javascript
var utils = require('utils');
var playerName = 'walterh';
var targetPos = utils.getMousePos(playerName);
if (targetPos){
targetPos.world.strikeLightning(targetPos);
}
```
***/
exports.getMousePos = function( player ) {
player = _player(player);
if ( !player ) {
return null;
}
var targetedBlock ;
if ( __plugin.canary ) {
var cmLineTracer = Packages.net.canarymod.LineTracer;
var lineTracer = new cmLineTracer(player);
targetedBlock = lineTracer.getTargetBlock();
if (targetedBlock == null){
return null;
}
} else {
// player might be CONSOLE or a CommandBlock
if ( !player.getTargetBlock ) {
return null;
}
targetedBlock = player.getTargetBlock( null, 5 );
if ( targetedBlock == null || targetedBlock.isEmpty() ) {
return null;
}
}
return targetedBlock.location;
};
/************************************************************************
### utils.foreach() function
The utils.foreach() function is a utility function for iterating over
an array of objects (or a java.util.Collection of objects) and processing each object in turn. Where
utils.foreach() differs from other similar functions found in
javascript libraries, is that utils.foreach can process the array
immediately or can process it *nicely* by processing one item at a
time then delaying processing of the next item for a given number of
server ticks (there are 20 ticks per second on the minecraft main
thread). This method relies on Bukkit's [org.bukkit.scheduler][sched]
package for scheduling processing of arrays.
[sched]: http://jd.bukkit.org/beta/apidocs/org/bukkit/scheduler/package-summary.html
#### Parameters
* array : The array to be processed - It can be a javascript array, a java array or java.util.Collection
* callback : The function to be called to process each item in the
array. The callback function should have the following signature
`callback(item, index, object, array)`. That is the callback will
be called with the following parameters....
- item : The item in the array
- index : The index at which the item can be found in the array.
- object : Additional (optional) information passed into the foreach method.
- array : The entire array.
* context (optional) : An object which may be used by the callback.
* delay (optional, numeric) : If a delay is specified (in ticks - 20
ticks = 1 second), then the processing will be scheduled so that
each item will be processed in turn with a delay between the completion of each
item and the start of the next. This is recommended for big builds (say 200 x 200 x 200
blocks) or any CPU-intensive process.
* onDone (optional, function) : A function to be executed when all processing
is complete. This parameter is only used when the processing is delayed. (It's optional even if a
delay parameter is supplied).
If called with a delay parameter then foreach() will return
immediately after processing just the first item in the array (all
subsequent items are processed later). If your code relies on the
completion of the array processing, then provide an `onDone` parameter
and put the code there.
#### Example
The following example illustrates how to use foreach for immediate processing of an array...
```javascript
var utils = require('utils');
var players = ['moe', 'larry', 'curly'];
utils.foreach (players, function(item){
echo( server.getPlayer(item), 'Hi ' + item);
});
```
... The `utils.foreach()` function can work with Arrays or any Java-style collection. This is important
because many objects in the Bukkit API use Java-style collections...
```javascript
utils.foreach( server.onlinePlayers, function(player){
player.chat('Hello!');
});
```
... the above code sends a 'Hello!' to every online player.
The following example is a more complex use case - The need to build an enormous structure
without hogging CPU usage...
```javascript
// build a structure 200 wide x 200 tall x 200 long
// (That's 8 Million Blocks - enough to tax any machine!)
var utils = require('utils');
var a = [];
a.length = 200;
var drone = new Drone();
var processItem = function(item, index, object, array){
// build a box 200 wide by 200 long then move up
drone.box(blocks.wood, 200, 1, 200).up();
};
// by the time the job's done 'self' might be someone else
// assume this code is within a function/closure
var player = self;
var onDone = function(){
echo( player, 'Job Done!');
};
utils.foreach (a, processItem, null, 10, onDone);
```
***/
var _foreach = function( array, callback, context, delay, onCompletion ) {
if ( array instanceof java.util.Collection ) {
array = array.toArray();
}
var i = 0;
var len = array.length;
if ( delay ) {
var next = function( ) {
callback(array[i], i, context, array);
i++;
};
var hasNext = function( ) {
return i < len;
};
_nicely( next, hasNext, onCompletion, delay );
} else {
for ( ;i < len; i++ ) {
callback( array[i], i, context, array );
}
}
};
exports.foreach = _foreach;
/************************************************************************
### utils.nicely() function
The utils.nicely() function is for performing processing using the
[org.bukkit.scheduler][sched] package/API. utils.nicely() lets you
process with a specified delay between the completion of each `next()`
function and the start of the next `next()` function.
`utils.nicely()` is a recursive function - that is - it calls itself
(schedules itself actually) repeatedly until `hasNext` returns false.
#### Parameters
* next : A function which will be called if processing is to be done.
* hasNext : A function which is called to determine if the `next`
callback should be invoked. This should return a boolean value -
true if the `next` function should be called (processing is not
complete), false otherwise.
* onDone : A function which is to be called when all processing is complete (hasNext returned false).
* delay : The delay (in server ticks - 20 per second) between each call.
#### Example
See the source code to utils.foreach for an example of how utils.nicely is used.
***/
var _nicely = function( next, hasNext, onDone, delay ) {
if ( hasNext() ){
next();
server.scheduler.runTaskLater( __plugin, function() {
_nicely( next, hasNext, onDone, delay );
}, delay );
}else{
if ( onDone ) {
onDone();
}
}
};
exports.nicely = _nicely;
/************************************************************************
### utils.at() function
The utils.at() function will perform a given task at a given time every
(minecraft) day.
#### Parameters
* time24hr : The time in 24hr form - e.g. 9:30 in the morning is '09:30' while
9:30 pm is '21:30', midnight is '00:00' and midday is '12:00'
* callback : A javascript function which will be invoked at the given time.
* worlds : (optional) An array of worlds. Each world has its own clock. If no array of worlds is specified, all the server's worlds are used.
#### Example
To warn players when night is approaching...
```javascript
var utils = require('utils');
utils.at( '19:00', function() {
utils.foreach( server.onlinePlayers, function( player ) {
player.chat( 'The night is dark and full of terrors!' );
});
});
```
***/
exports.at = function( time24hr, callback, worlds ) {
var forever = function(){ return true; };
var timeParts = time24hr.split( ':' );
var hrs = ( (timeParts[0] * 1000) + 18000 ) % 24000;
var mins;
if ( timeParts.length > 1 ) {
mins = ( timeParts[1] / 60 ) * 1000;
}
var timeMc = hrs + mins;
if ( typeof worlds == 'undefined' ) {
worlds = server.worlds;
}
_nicely( function() {
_foreach( worlds, function ( world ) {
var time = world.getTime();
var diff = timeMc - time;
if ( diff > 0 && diff < 100 ) {
callback();
}
});
}, forever, null, 100 );
};
/************************************************************************
### utils.find() function
The utils.find() function will return a list of all files starting at
a given directory and recursiving trawling all sub-directories.
#### Parameters
* dir : The starting path. Must be a string.
* filter : (optional) A [FilenameFilter][fnfltr] object to return only files matching a given pattern.
[fnfltr]: http://docs.oracle.com/javase/6/docs/api/java/io/FilenameFilter.html
#### Example
```javascript
var utils = require('utils');
var jsFiles = utils.find('./', function(dir,name){
return name.match(/\.js$/);
});
```
***/
exports.find = function( dir , filter ) {
var result = [];
var recurse = function( dir, store ) {
var files, dirfile = new File( dir );
if ( typeof filter == 'undefined' ) {
files = dirfile.list();
} else {
files = dirfile.list(filter);
}
_foreach( files, function( file ) {
file = new java.io.File( dir + '/' + file );
if ( file.isDirectory() ) {
recurse( file.canonicalPath, store );
} else {
store.push( file.canonicalPath );
}
});
};
recurse( dir, result );
return result;
};
/************************************************************************
### utils.serverAddress() function
The utils.serverAddress() function returns the IP(v4) address of the server.
```javascript
var utils = require('utils');
var serverAddress = utils.serverAddress();
console.log(serverAddress);
```
***/
exports.serverAddress = function() {
var interfaces = java.net.NetworkInterface.getNetworkInterfaces();
var current,
addresses,
current_addr;
while ( interfaces.hasMoreElements() ) {
current = interfaces.nextElement();
if ( ! current.isUp() || current.isLoopback() || current.isVirtual() ) {
continue;
}
addresses = current.getInetAddresses();
while (addresses.hasMoreElements()) {
current_addr = addresses.nextElement();
if ( current_addr.isLoopbackAddress() )
continue;
if ( current_addr instanceof java.net.Inet4Address)
return current_addr.getHostAddress();
}
}
return null;
};
/************************************************************************
### utils.watchFile() function
Watches for changes to the given file or directory and calls the function provided
when the file changes.
#### Parameters
* File - the file to watch (can be a file or directory)
* Callback - The callback to invoke when the file has changed. The callback takes the
changed file as a parameter.
#### Example
```javascript
var utils = require('utils');
utils.watchFile( 'test.txt', function( file ) {
console.log( file + ' has changed');
});
```
***/
var filesWatched = {};
var dirsWatched = {};
exports.watchFile = function( file, callback ) {
if ( typeof file == 'string' ) {
file = new File(file);
}
//console.log("Watching file " + file);
filesWatched[file.canonicalPath] = {
callback: callback,
lastModified: file.lastModified()
};
};
/************************************************************************
### utils.watchDir() function
Watches for changes to the given directory and calls the function provided
when the directory changes. It works by calling watchFile/watchDir for each
file/subdirectory.
#### Parameters
* Dir - the file to watch (can be a file or directory)
* Callback - The callback to invoke when the directory has changed.
The callback takes the changed file as a parameter.
For each change inside the directory the callback will also
be called.
#### Example
```javascript
var utils = require('utils');
utils.watchDir( 'players/_ial', function( dir ) {
console.log( dir + ' has changed');
});
```
***/
exports.watchDir = function( dir, callback ) {
if ( typeof dir == 'string' ) {
dir = new File(dir);
}
//console.log("Watching dir " + dir);
dirsWatched[dir.canonicalPath] = {
callback: callback,
lastModified: dir.lastModified()
};
var files = dir.listFiles(),file;
if ( !files ) {
return;
}
for ( var i = 0; i < files.length; i++ ) {
file = files[i];
if (file.isDirectory( )) {
exports.watchDir(file,callback);
}else{
exports.watchFile(file,callback);
}
}
};
/************************************************************************
### utils.unwatchFile() function
Removes a file from the watch list.
#### Example
```javascript
var utils = require('utils');
utils.unwatchFile( 'test.txt');
```
***/
exports.unwatchFile = function( file, callback ) {
if ( typeof file == 'string' ) {
file = new File(file);
}
//console.log("Unwatching file " + file);
delete filesWatched[file.canonicalPath];
};
/************************************************************************
### utils.unwatchDir() function
Removes a directory from the watch list and all files inside the directory
are also "unwatched"
#### Example
```javascript
var utils = require('utils');
utils.unwatchDir ('players/_ial');
```
Would cause also
```javascript
utils.unwatchFile (file);
```
for each file inside directory (and unwatchDir for each directory inside it)
***/
exports.unwatchDir = function( dir, callback ) {
if ( typeof dir == 'string' ) {
dir = new File(dir);
}
//console.log("Unwatching dir " + dir);
delete dirsWatched[dir.canonicalPath];
var files = dir.listFiles(),file;
if ( !files ) {
return;
}
for ( var i = 0; i < files.length; i++ ) {
file = files[i];
if (file.isDirectory( )) {
exports.unwatchDir(file,callback);
}else{
exports.unwatchFile(file,callback);
}
}
};
function fileWatcher(calledCallbacks) {
for (var file in filesWatched) {
var fileObject = new File(file);
var lm = fileObject.lastModified();
if ( lm != filesWatched[file].lastModified ) {
//console.log("Change found in " + file);
filesWatched[file].lastModified = lm;
filesWatched[file].callback(fileObject);
if (!fileObject.exists()) {
//console.log("File " + file + " was removed.");
exports.unwatchFile(file,filesWatched[file].callback);
}
}
}
};
//monitors directories for time change
//when a change is detected watchFiles are invoked for each of the files in directory
//and callback is called
function dirWatcher(calledCallbacks) {
for (var dir in dirsWatched) {
var dirObject = new File(dir);
var lm = dirObject.lastModified();
var dw = dirsWatched[dir];
if ( lm != dirsWatched[dir].lastModified ) {
//console.log("Change found in " + dir);
dirsWatched[dir].lastModified = lm;
dirsWatched[dir].callback(dirObject);
exports.unwatchDir(dir, dw.callback);
//causes all files to be rewatched
if (dirObject.exists()) {
exports.watchDir(dir, dw.callback);
} else {
//console.log("Directory " + dir + " was removed.");
}
}
}
};
//guarantees that a callback is only called once for each change
function monitorDirAndFiles() {
fileWatcher ();
dirWatcher ();
setTimeout( monitorDirAndFiles, 3000 );
};
setTimeout( monitorDirAndFiles, 3000 );
/**************************************************************************
### utils.array() function
Converts Java collection objects to type Javascript array so they can avail of
all of Javascript's Array goodness.
#### Example
var utils = require('utils');
var worlds = utils.array(server.worlds);
***/
exports.array = function( ){
var result = [],
javaArray = null,
i = 0;
if (arguments[0] instanceof java.util.Collection){
// it's a java collection
javaArray = arguments[0].toArray();
for ( ;i < javaArray.length; i++) {
result.push(javaArray[i]);
}
} else if (arguments[0].constructor === Array){
// it's a javascript array
return arguments[0];
} else if (arguments[0].length) {
// it's a java array
javaArray = arguments[0];
for ( ;i < javaArray.length; i++) {
result.push(javaArray[i]);
}
}
return result;
};
/*************************************************************************
### utils.players() function
This function returns a javascript array of all online players on the server.
### utils.playerNames() function
This function returns a javascript array of player names (as javascript strings)
***/
function getPlayersBukkit(){
var result = [];
for (var i = 0; i < server.onlinePlayers.length; i++){
result.push(server.onlinePlayers[i]);
}
return result;
}
function getPlayersCanary(){
var result = [];
var players = server.playerList;
for (var i = 0; i < players.size(); i++){
result.push(players.get(i));
}
return result;
}
var getPlayers = null;
if (__plugin.canary) {
getPlayers = getPlayersCanary;
} else {
getPlayers = getPlayersBukkit;
}
function getStatBukkit(player, stat){
return player.getStatistic(org.bukkit.Statistic[stat.toUpperCase()]);
}
function getStatCanary(player, stat){
var cmStatistics = Packages.net.canarymod.api.statistics.Statistics;
return player.getStat(cmStatistics[stat.toUpperCase()].instance);
}
function getPlayerNames(){
return getPlayers().map(function(p){ return p.name; });
}
exports.players = getPlayers;
exports.playerNames = getPlayerNames;
/*************************************************************************
### utils.stat() function
This function returns a numeric value for a given player statistic.
#### Parameters
* Player - The player object
* Statistic - A string whose value should be one of the following (CanaryMod)
* ANIMALSBRED
* BOATONECM
* CLIMBONECM
* CROUCHONECM
* DAMAGEDEALT
* DAMAGETAKEN
* DEATHS
* DRIVEONECM
* DROP
* FALLONECM
* FISHCAUGHT
* FLYONECM
* HORSEONECM
* JUMP
* JUNKFISHED
* LEAVEGAME
* MINECARTONECM
* MOBKILLS
* PIGONECM
* PLAYERKILLS
* PLAYONEMINUTE
* SPRINTONECM
* SWIMONECM
* TALKEDTOVILLAGER
* TIMESINCEDEATH
* TRADEDWITHVILLAGER
* TREASUREFISHED
* WALKONECM
See [CanaryMod's Statistic][cmstat] class for a list of possible stat values
[cmstat]: https://ci.visualillusionsent.net/job/CanaryLib/javadoc/net/canarymod/api/statistics/Statistics.html
***/
exports.stat = __plugin.canary ? getStatCanary: getStatBukkit;