Scripting - Revision history

Mcmonkey at 19:16, 3 September 2021

2021-09-03T19:16:38Z

← Older revision		Revision as of 19:16, 3 September 2021
Line 1:		Line 1:
	== NOTICE ==		== NOTICE ==

	This page refers to Javascript scripting which ~~can be difficult to use and requires some Bukkit API knowledge~~. The main scripting support available in modern Citizens is through [https://denizenscript.com/ Denizen].		<span style="font-family:natalya-alternate-one; font-size:300%; margin-right:-7px; margin-left:-10px;">This page refers to the legacy Javascript scripting which is no longer fully supported. The main scripting support available in modern Citizens is through [https://denizenscript.com/ Denizen].</span>




	== Scripting Support in Citizens2 ==		== Scripting Support in Citizens2 ==

Fullwall: /* Behaviours */

2020-07-11T17:29:38Z

Behaviours

← Older revision		Revision as of 17:29, 11 July 2020
Line 20:		Line 20:

	function onLoad(npc) {		function onLoad(npc) {
	events.on(Java.type('net.citizensnpcs.api.event.NPCLeftClickEvent'), leftClick);		events.on(Java.type('net.citizensnpcs.api.event.NPCLeftClickEvent').class, leftClick);
	}		}

Fullwall at 10:51, 11 July 2020

2020-07-11T10:51:53Z

← Older revision		Revision as of 10:51, 11 July 2020
Line 6:		Line 6:
	Citizens2 includes support for various scripting languages including Lua, Javascript and Python.		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.		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 (https://github.com/krka/kahlua2) and more.

	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'.		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'.

Fullwall: /* Behaviours */

2020-07-11T10:27:15Z

Behaviours

← Older revision		Revision as of 10:27, 11 July 2020
Line 15:		Line 15:
	When the script file is loaded by Citizens, it will call the method 'onLoad(NPC)' - anything can be performed at this time, although the NPC will not necessarily be spawned. If the method 'run(NPC)' exists it will also be called every tick by Citizens.		When the script file is loaded by Citizens, it will call the method 'onLoad(NPC)' - anything can be performed at this time, although the NPC will not necessarily be spawned. If the method 'run(NPC)' exists it will also be called every tick by Citizens.

	function leftClick(event) {		function leftClick(event) {
	event.getClicker().sendMessage("hello from Javascript scripting!");		event.getClicker().sendMessage("hello from Javascript scripting!");
	}		}

	function onLoad(npc) {		function onLoad(npc) {
	events.on(Java.type('net.citizensnpcs.api.event.NPCLeftClickEvent'), leftClick);		events.on(Java.type('net.citizensnpcs.api.event.NPCLeftClickEvent'), leftClick);
	}		}

	== Scripting Gotchas and Tips ==		== Scripting Gotchas and Tips ==

Fullwall: /* Behaviours */

2020-07-11T10:26:58Z

Behaviours

← Older revision		Revision as of 10:26, 11 July 2020
Line 14:		Line 14:

	When the script file is loaded by Citizens, it will call the method 'onLoad(NPC)' - anything can be performed at this time, although the NPC will not necessarily be spawned. If the method 'run(NPC)' exists it will also be called every tick by Citizens.		When the script file is loaded by Citizens, it will call the method 'onLoad(NPC)' - anything can be performed at this time, although the NPC will not necessarily be spawned. If the method 'run(NPC)' exists it will also be called every tick by Citizens.

			function leftClick(event) {
			event.getClicker().sendMessage("hello from Javascript scripting!");
			}

			function onLoad(npc) {
			events.on(Java.type('net.citizensnpcs.api.event.NPCLeftClickEvent'), leftClick);
			}

	== Scripting Gotchas and Tips ==		== Scripting Gotchas and Tips ==

Fullwall at 10:22, 11 July 2020

2020-07-11T10:22:47Z

← Older revision		Revision as of 10:22, 11 July 2020
Line 2:		Line 2:

	This page refers to Javascript scripting which can be difficult to use and requires some Bukkit API knowledge. The main scripting support available in modern Citizens is through [https://denizenscript.com/ Denizen].		This page refers to Javascript scripting which can be difficult to use and requires some Bukkit API knowledge. The main scripting support available in modern Citizens is through [https://denizenscript.com/ Denizen].

	~~== Old Scripting Repository ==~~
	~~http://scripts.citizensnpcs.co - submit user scripts (including Denizen scripts) here. '''Note: no longer in use.'''~~

	== 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.

	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~~.		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.

	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'.		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'.

Fullwall: /* NOTICE */

2020-07-11T10:21:46Z

NOTICE

← Older revision		Revision as of 10:21, 11 July 2020
Line 1:		Line 1:
	== NOTICE ==		== NOTICE ==

	This page ~~mainly~~ refers to ~~outdated / no longer in~~ use ~~systems~~. The main scripting support available in modern Citizens is through [https://denizenscript.com/ Denizen].		This page refers to Javascript scripting which can be difficult to use and requires some Bukkit API knowledge. The main scripting support available in modern Citizens is through [https://denizenscript.com/ Denizen].


	== Old Scripting Repository ==		== Old Scripting Repository ==

Mcmonkey at 01:32, 24 November 2019

2019-11-24T01:32:05Z

← Older revision		Revision as of 01:32, 24 November 2019
Line 4:		Line 4:


	== Scripting Repository ==		== Old Scripting Repository ==
	http://scripts.citizensnpcs.co - submit user scripts (including Denizen scripts) here.		http://scripts.citizensnpcs.co - submit user scripts (including Denizen scripts) here. '''Note: no longer in use.'''

	== Scripting Support in Citizens2 ==		== Scripting Support in Citizens2 ==

Mcmonkey at 01:31, 24 November 2019

2019-11-24T01:31:16Z

← Older revision		Revision as of 01:31, 24 November 2019
Line 1:		Line 1:
			== NOTICE ==

			This page mainly refers to outdated / no longer in use systems. The main scripting support available in modern Citizens is through [https://denizenscript.com/ Denizen].


	== Scripting Repository ==		== Scripting Repository ==
	http://scripts.citizensnpcs.~~com~~ - submit user scripts (including Denizen scripts) here.		http://scripts.citizensnpcs.co - submit user scripts (including Denizen scripts) here.

	== Scripting Support in Citizens2 ==		== Scripting Support in Citizens2 ==

Fullwall at 15:20, 23 January 2016

2016-01-23T15:20:34Z

@@ Line 10: / Line 10: @@
 == 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.
+Let's see an example of how to use scripts. Scripts can be added to an NPC via the /npc script --add [scripts] command, where scripts is a list of files inside the plugins/Citizens/scripts folder to use. Scripts are differentiated by their extension -- make sure it is correct!
-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 'onLoad(NPC)' - anything can be performed at this time, although the NPC will not necessarily be spawned. If the method 'run(NPC)' exists it will also be called every tick by Citizens.
-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.
+== Scripting Gotchas and Tips ==
+=== Javascript (Nashorn) ===
-An example of a behaviour file is given below - this implements a simple thief goal.
+* Nashorn is a much faster Javascript engine only included in Java 7 and above. It is recommended to run this over the older Rhino engine.
+* Read https://docs.oracle.com/javase/8/docs/technotes/guides/scripting/nashorn/api.html for more information on Java-Javascript connection.
-== Scripting Gotchas and Tips ==
+=== Javascript (Rhino) ===
 * Some code will expect the methods equals and hashcode to be implemented - a simple equals function should be used often.
 * for.. in loops do not work with Java collections.
-* The default Javascript-Java implementation cannot use abstract classes.
+* Rhino cannot use abstract classes.
 * You can implement Java interfaces by using new [interfacename](object), where object contains the methods implementing the interface.
 * Use importPackage(Packages.name.space) or importClass(Packages.name.space.YourClass) to import other classes/packages. The Packages. prefix is not required if the class is in the java.util package.