Scripting: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
== Scripting Repository == | |||
http://scripts.citizensnpcs.com - submit user scripts (including Denizen scripts) here. | |||
== Scripting Support in Citizens2 == | == Scripting Support in Citizens2 == | ||
Citizens2 includes support for various scripting languages including Lua, Javascript and Python. | Citizens2 includes support for various scripting languages including Lua, Javascript and Python. | ||
| Line 25: | Line 28: | ||
reset : function() { | reset : function() { | ||
this.player = null; | this.player = null; | ||
}, | }, | ||
run : function() { | run : function(selector) { | ||
if (!this.player || !this.player.isOnline()) { | if (!this.player || !this.player.isOnline()) { | ||
selector.finish(); | |||
return; | return; | ||
} | } | ||
| Line 50: | Line 52: | ||
this.player.sendMessage(npc.getName() + " Ha! Stole an item!"); | this.player.sendMessage(npc.getName() + " Ha! Stole an item!"); | ||
this.npc.getNavigator().setTarget(this.home); | this.npc.getNavigator().setTarget(this.home); | ||
selector.finish(); | |||
} | } | ||
}, | }, | ||
| Line 62: | Line 64: | ||
this.home = npc.getBukkitEntity().getLocation(); | this.home = npc.getBukkitEntity().getLocation(); | ||
this.npc.getNavigator().setTarget(entity, false); | this.npc.getNavigator().setTarget(entity, false); | ||
return true; | return true; | ||
} | } | ||
Revision as of 04:01, 16 September 2012
Scripting Repository
http://scripts.citizensnpcs.com - submit user scripts (including Denizen scripts) here.
Scripting Support in Citizens2
Citizens2 includes support for various scripting languages including Lua, Javascript and Python.
Javascript support is built into Java; additional languages can be added in through installing things such as JRuby (http://jruby.org/), Jython (http://www.jython.org/), Kahlua (http://www.ohloh.net/p/kahlua) and more. These use the Java Scripting API to give common scripting support to Citizens.
The scripting API contains a few built in objects in the global namespace which aid in some tasks. Currently, the 'events' object allows registering event listeners for Bukkit events and a reference to the Citizens plugin object is available under 'plugin'.
Behaviours
Let's see an example of how to use scripts. Citizens builds in by default the 'Behaviour' trait - this lets you specify AI tasks via scripts. Behaviours can be added to the NPC via the /npc behaviour [behaviours] command, where behaviours is a list of files to use.
Scripts for behaviours should be placed in the plugins/Citizens/scripts/behaviours folder. Scripts are differentiated by their extension -- make sure it is correct!
When the script file is loaded by Citizens, it will call the method 'addGoals(Goals, NPC)'. Goals can be added via calling goals.addGoal(priority, goal), where goal implements the interface specified here -http://jd.citizensnpcs.com/net/citizensnpcs/api/ai/Goal.html.
An example of a behaviour file is given below - this implements a simple thief goal.
Code: Example done in Javascript |