Take On Helicopters: Java Scripting - Revision history

Lou Montana: Some wiki formatting

2024-04-16T21:26:07Z

Some wiki formatting

← Older revision		Revision as of 23:26, 16 April 2024
Line 1:		Line 1:
	~~== Overview ==~~		{{TOC\|side}}
	[[~~Take_On_Helicopters~~: Patches\|Patch 3 (1.04)]] for ~~[[Take_On_Helicopters~~\|~~Take On Helicopters]]~~ introduces the ability to use Java scripting in the [[~~Real_Virtuality\|~~Real Virtuality]] engine.		[[Take On Helicopters: Patches\|Patch 3 (1.04)]] for {{GameCategory\|tkoh\|link= y}} introduces the ability to use Java scripting in the [[Real Virtuality]] engine.
	This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.		This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.


	== Limitations ==		== Limitations ==

	* Classes can only be loaded from mission, campaign and user profile folders.		* Classes can only be loaded from mission, campaign and user profile folders.


	== Setup - Eclipse ==		== Setup - Eclipse ==

	=== Installation ===		=== Installation ===

	* {{Link\|http://www.oracle.com/technetwork/java/javase/downloads\|Download}} and install '''Java SE 1.7'''		* {{Link\|http://www.oracle.com/technetwork/java/javase/downloads\|Download}} and install '''Java SE 1.7'''
	* {{Link\|http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/indigosr1\|Download}} and install '''Eclipse''' (Indigo)		* {{Link\|http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/indigosr1\|Download}} and install '''Eclipse''' (Indigo)
	** You are free to use other IDEs, but this guide deals with Eclipse only		** You are free to use other IDEs, but this guide deals with Eclipse only
	* {{Link\|http://takeonthegame.com/download/beta-patches\|Download}} and install the ~~TKOH~~ Beta Patch rev. '''89707''' (or later)		* {{Link\|http://takeonthegame.com/download/beta-patches\|Download}} and install the {{Name\|tkoh\|short}} Beta Patch rev. '''89707''' (or later)

	=== Sample mission ===		=== Sample mission ===

	* Create a new mission in the editor on '''Oil Platform'''		* Create a new mission in the editor on '''Oil Platform'''
	* Insert a player pilot character		* Insert a player pilot character
	* Save the mission as ''JavaSample'' (which will create the ''JavaSample.Intro_Island_H'' folder in your user profile ''Missions'' folder)		* Save the mission as ''JavaSample'' (which will create the {{hl\|JavaSample.Intro_Island_H}} folder in your user profile's ''Missions'' folder)

	=== New IDE project ===		=== New IDE project ===

	* In Eclipse, create a new ''Java Project'' (''File'' > ''New'')		* In Eclipse, create a new ''Java Project'' (''File'' > ''New'')
	** Enter a name (e.g. ''JavaSample'')		** Enter a name (e.g. ''JavaSample'')
	** Untick ''Use default location'', and browse to the mission you've just created		** Untick ''Use default location'', and browse to the mission you've just created
	** Select ''Next''		** Select ''Next''
	* We~~'ll~~ want the .java sources and compiled .class files in the root of the mission for now (alternatively you can organize your data using packages)		* We will want the .java sources and compiled .class files in the root of the mission for now (alternatively you can organize your data using packages)
	** Right-click the default ''src'' folder and select ''Remove from Build Path''		** Right-click the default ''src'' folder and select ''Remove from Build Path''
	*** If you want, manually delete the ''src'' folder from your mission folder		*** If you want, manually delete the ''src'' folder from your mission folder
Line 34:		Line 41:

	=== New Java class ===		=== New Java class ===

	* Right-click the JavaSample project and create a new ''Class''		* Right-click the JavaSample project and create a new ''Class''
	** Enter as ''Name'': ''Sample''		** Enter as ''Name'': ''Sample''
	** ''Superclass'': empty (remove the default ''java.lang.Object'')		** ''Superclass'': empty (remove the default ''java.lang.Object'')
	** Select ''Finish''		** Select ''Finish''
	* Change the Sample.java file to:		* Change the Sample.java file to:<syntaxhighlight lang="java">
			import com.bistudio.JNIScripting.RVEngine;

	~~import com.bistudio.JNIScripting.RVEngine;~~		/**
			* Sample Java class
	/**		* @author Bohemia Interactive
	* Sample Java class		*/
	* @author Bohemia Interactive		public class Sample {
	*/		/**
	public class Sample {		* Show a hint passed to jCall.
	/**		* @param args Method parameters
	* Show a hint passed to jCall.		*/
	* @param args Method parameters		public static Object showHint(Object[] args) {
	*/		if (!(args[0] instanceof String))
	public static Object showHint(Object[] args) {		return null;
	if (!(args[0] instanceof String)) ~~return null;~~
	~~RVEngine.hint((String)args[0]);~~
	return null;
	}
	}

			RVEngine.hint((String)args[0]);
			return null;
			}
			}
			</syntaxhighlight>
	* Save the file		* Save the file

			=== Debugging ===

	~~=== Debugging ===~~		* Run {{Name\|tkoh\|short}} with start-up parameter {{hl\|-jDebugPort{{=}}8008}} (or another suitable port number)
	* Run ~~TKOH~~ with start-up parameter ''-jDebugPort=8008'' (or another suitable port number)
	* Open the mission in the editor		* Open the mission in the editor
	** In the player's ~~''Initialization''-~~field add:		** In the player's Initialisation field add:

	BIS_Sample = jLoad "Sample"; BIS_Result = BIS_Sample jCall ["showHint", ["Take On World!"]];		<sqf>BIS_Sample = jLoad "Sample"; BIS_Result = BIS_Sample jCall ["showHint", ["Take On World!"]];</sqf>

	* In Eclipse, go to the ''Run'' menu and select ''Debug Configurations..''		* In Eclipse, go to the ''Run'' menu and select ''Debug Configurations..''
	** Double-click ''Remote Java Application''		** Double-click ''Remote Java Application''
	** Change the port number to the one you launched ~~TKOH~~ with (8008)		** Change the port number to the one you launched {{Name\|tkoh\|short}} with (8008)
	** In the ''Common'' tab, tick to show this configuration in the ''Debug'' favorites menu for ease of use		** In the ''Common'' tab, tick to show this configuration in the ''Debug'' favorites menu for ease of use
	** Select ''Apply'' and ''Close''		** Select ''Apply'' and ''Close''
	* Place a breakpoint on the following line (double-click the grey column on the left):		* Place a breakpoint on the following line (double-click the grey column on the left):

	RVEngine.hint((String)args[0]);		<syntaxhighlight lang="java">
			RVEngine.hint((String)args[0]);
			</syntaxhighlight>

	* Start the debugger from the ''Debug'' favorites menu (by default named ''Sample (1)'')		* Start the debugger from the ''Debug'' favorites menu (by default named ''Sample (1)'')
	* ~~In TKOH, preview~~ the mission		* Preview the mission in {{Name\|tkoh\|short}}
	** It is recommended to run ~~TKOH~~ windowed to make switching between Eclipse and the game easier (-window)		** It is recommended to run {{Name\|tkoh\|short}} windowed to make switching between Eclipse and the game easier (-window)
	** Eclipse's debugger will take focus almost immediately to show the breakpoint		** Eclipse's debugger will take focus almost immediately to show the breakpoint
	*** If Eclipse does not show the source code it is paused at, make sure the project and JNIScripting.jar are listed under the ''Source'' tab in the debug configuration (''Source Lookup Path'')		*** If Eclipse does not show the source code it is paused at, make sure the project and {{hl\|JNIScripting.jar}} are listed under the ''Source'' tab in the debug configuration (''Source Lookup Path'')
	** Press F8 to resume		** Press F8 to resume
	** Return to ~~TKOH~~ to see the hint displayed		** Return to {{Name\|tkoh\|short}} to see the hint displayed
	* Welcome to '''Take On Java'''!		* Welcome to '''Take On Java'''!


	[[Category:Scripting_Topics\|Java Scripting]]		[[Category:Scripting_Topics\|Java Scripting]]
	[[Category:Take_On_Helicopters:_Editing\|Java Scripting]]		[[Category:Take_On_Helicopters:_Editing\|Java Scripting]]

Lou Montana: Text replacement - "\[ (https?:\/\/[^ = ]+) +([^= ]+) \]" to "{{Link|$1|$2}}"

2023-04-28T14:11:52Z

Text replacement - "\[ *(https?:\/\/[^ = ]+) +([^= ]+) *\]" to "{{Link|$1|$2}}"

← Older revision		Revision as of 16:11, 28 April 2023
Line 8:		Line 8:
	== Setup - Eclipse ==		== Setup - Eclipse ==
	=== Installation ===		=== Installation ===
	* [http://www.oracle.com/technetwork/java/javase/downloads Download] and install '''Java SE 1.7'''		* {{Link\|http://www.oracle.com/technetwork/java/javase/downloads\|Download}} and install '''Java SE 1.7'''
	* [http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/indigosr1 Download] and install '''Eclipse''' (Indigo)		* {{Link\|http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/indigosr1\|Download}} and install '''Eclipse''' (Indigo)
	** You are free to use other IDEs, but this guide deals with Eclipse only		** You are free to use other IDEs, but this guide deals with Eclipse only
	* [http://takeonthegame.com/download/beta-patches Download] and install the TKOH Beta Patch rev. '''89707''' (or later)		* {{Link\|http://takeonthegame.com/download/beta-patches\|Download}} and install the TKOH Beta Patch rev. '''89707''' (or later)

	=== Sample mission ===		=== Sample mission ===

Lou Montana: Text replacement - ";[ ]+ " to "; "

2021-08-07T23:55:31Z

Text replacement - ";[ ]+ " to "; "

← Older revision		Revision as of 01:55, 8 August 2021
Line 52:		Line 52:
	*/		*/
	public static Object showHint(Object[] args) {		public static Object showHint(Object[] args) {
	if (!(args[0] instanceof String)) return null;		if (!(args[0] instanceof String)) return null;
	RVEngine.hint((String)args[0]);		RVEngine.hint((String)args[0]);
	return null;		return null;

R3vo: removed link to beta patches

2021-01-07T09:42:39Z

removed link to beta patches

← Older revision		Revision as of 11:42, 7 January 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==
	[[Take_On_Helicopters: Patches\|Patch 3 (1.04)]] for [[Take_On_Helicopters\|Take On Helicopters]] introduces the ability to use Java scripting in the [[Real_Virtuality\|Real Virtuality]] engine. ~~It is currently available for testing in [[Take_On_Helicopters_-_Beta_Patches\|beta patch rev. 89707]].~~		[[Take_On_Helicopters: Patches\|Patch 3 (1.04)]] for [[Take_On_Helicopters\|Take On Helicopters]] introduces the ability to use Java scripting in the [[Real_Virtuality\|Real Virtuality]] engine.

	This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.		This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.

R3vo: fixed link

2021-01-07T09:40:45Z

fixed link

← Older revision		Revision as of 11:40, 7 January 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==
	[[~~Take_On_Helicopters_-_Patches~~\|Patch 3 (1.04)]] for [[Take_On_Helicopters\|Take On Helicopters]] introduces the ability to use Java scripting in the [[Real_Virtuality\|Real Virtuality]] engine. It is currently available for testing in [[Take_On_Helicopters_-_Beta_Patches\|beta patch rev. 89707]].		[[Take_On_Helicopters: Patches\|Patch 3 (1.04)]] for [[Take_On_Helicopters\|Take On Helicopters]] introduces the ability to use Java scripting in the [[Real_Virtuality\|Real Virtuality]] engine. It is currently available for testing in [[Take_On_Helicopters_-_Beta_Patches\|beta patch rev. 89707]].

	This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.		This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.




	== Limitations ==		== Limitations ==
	* Classes can only be loaded from mission, campaign and user profile folders.		* Classes can only be loaded from mission, campaign and user profile folders.




	== Setup - Eclipse ==		== Setup - Eclipse ==
Line 19:		Line 13:
	** You are free to use other IDEs, but this guide deals with Eclipse only		** You are free to use other IDEs, but this guide deals with Eclipse only
	* [http://takeonthegame.com/download/beta-patches Download] and install the TKOH Beta Patch rev. '''89707''' (or later)		* [http://takeonthegame.com/download/beta-patches Download] and install the TKOH Beta Patch rev. '''89707''' (or later)


	=== Sample mission ===		=== Sample mission ===
Line 25:		Line 18:
	* Insert a player pilot character		* Insert a player pilot character
	* Save the mission as ''JavaSample'' (which will create the ''JavaSample.Intro_Island_H'' folder in your user profile ''Missions'' folder)		* Save the mission as ''JavaSample'' (which will create the ''JavaSample.Intro_Island_H'' folder in your user profile ''Missions'' folder)


	=== New IDE project ===		=== New IDE project ===
Line 41:		Line 33:
	** Select from your game installation folder: ''JRE\lib\ext\JNIScripting.jar''		** Select from your game installation folder: ''JRE\lib\ext\JNIScripting.jar''
	* Select ''Finish''		* Select ''Finish''


	=== New Java class ===		=== New Java class ===

Lou Montana: Lou Montana moved page Java Scripting to Take On Helicopters: Java Scripting: name standard

2021-01-01T02:28:24Z

Lou Montana moved page Java Scripting to Take On Helicopters: Java Scripting: name standard

← Older revision	Revision as of 04:28, 1 January 2021
(No difference)

Benargee: No plans for Java in Arma 3.

2015-05-14T07:41:30Z

No plans for Java in Arma 3.

← Older revision		Revision as of 09:41, 14 May 2015
Line 1:		Line 1:
	== Overview ==		== Overview ==
	[[Take_On_Helicopters_-_Patches\|Patch 3 (1.04)]] for [[Take_On_Helicopters\|Take On Helicopters]] introduces the ability to use Java scripting in the [[Real_Virtuality\|Real Virtuality]] engine. It is currently available for testing in [[Take_On_Helicopters_-_Beta_Patches\|beta patch rev. 89707]].		[[Take_On_Helicopters_-_Patches\|Patch 3 (1.04)]] for [[Take_On_Helicopters\|Take On Helicopters]] introduces the ability to use Java scripting in the [[Real_Virtuality\|Real Virtuality]] engine. It is currently available for testing in [[Take_On_Helicopters_-_Beta_Patches\|beta patch rev. 89707]].

	~~[[ArmA_3\|Arma 3]] will also have Java scripting available, so its introduction in TKOH is to ensure the implementation can mature before that game is released.~~

	This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.		This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.

DnA: Note on running the game windowed

2012-02-22T19:40:11Z

Note on running the game windowed

← Older revision		Revision as of 21:40, 22 February 2012
Line 91:		Line 91:
	* Start the debugger from the ''Debug'' favorites menu (by default named ''Sample (1)'')		* Start the debugger from the ''Debug'' favorites menu (by default named ''Sample (1)'')
	* In TKOH, preview the mission		* In TKOH, preview the mission
			** It is recommended to run TKOH windowed to make switching between Eclipse and the game easier (-window)
	** Eclipse's debugger will take focus almost immediately to show the breakpoint		** Eclipse's debugger will take focus almost immediately to show the breakpoint
	*** If Eclipse does not show the source code it is paused at, make sure the project and JNIScripting.jar are listed under the ''Source'' tab in the debug configuration (''Source Lookup Path'')		*** If Eclipse does not show the source code it is paused at, make sure the project and JNIScripting.jar are listed under the ''Source'' tab in the debug configuration (''Source Lookup Path'')

DnA: Initial documentation on Java scripting (in TKOH)

2012-02-22T15:10:07Z

Initial documentation on Java scripting (in TKOH)

New page

== Overview ==
[[Take_On_Helicopters_-_Patches|Patch 3 (1.04)]] for [[Take_On_Helicopters|Take On Helicopters]] introduces the ability to use Java scripting in the [[Real_Virtuality|Real Virtuality]] engine. It is currently available for testing in [[Take_On_Helicopters_-_Beta_Patches|beta patch rev. 89707]].

[[ArmA_3|Arma 3]] will also have Java scripting available, so its introduction in TKOH is to ensure the implementation can mature before that game is released.

This documentation will need to be expanded with more details, guides for other IDEs and comparisons to SQF scripting.

== Limitations ==
* Classes can only be loaded from mission, campaign and user profile folders.

== Setup - Eclipse ==
=== Installation ===
* [http://www.oracle.com/technetwork/java/javase/downloads Download] and install '''Java SE 1.7'''
* [http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/indigosr1 Download] and install '''Eclipse''' (Indigo)
** You are free to use other IDEs, but this guide deals with Eclipse only
* [http://takeonthegame.com/download/beta-patches Download] and install the TKOH Beta Patch rev. '''89707''' (or later)

=== Sample mission ===
* Create a new mission in the editor on '''Oil Platform'''
* Insert a player pilot character
* Save the mission as ''JavaSample'' (which will create the ''JavaSample.Intro_Island_H'' folder in your user profile ''Missions'' folder)

=== New IDE project ===
* In Eclipse, create a new ''Java Project'' (''File'' > ''New'')
** Enter a name (e.g. ''JavaSample'')
** Untick ''Use default location'', and browse to the mission you've just created
** Select ''Next''
* We'll want the .java sources and compiled .class files in the root of the mission for now (alternatively you can organize your data using packages)
** Right-click the default ''src'' folder and select ''Remove from Build Path''
*** If you want, manually delete the ''src'' folder from your mission folder
** Select the root ''JavaSample'' folder, right-click, and select ''Use as Source Folder''
** Set ''Default output folder'' to just ''JavaSample'' (remove ''\bin'')
* Go to the ''Libraries'' tab
** Select ''Add External JARs..''
** Select from your game installation folder: ''JRE\lib\ext\JNIScripting.jar''
* Select ''Finish''

=== New Java class ===
* Right-click the JavaSample project and create a new ''Class''
** Enter as ''Name'': ''Sample''
** ''Superclass'': empty (remove the default ''java.lang.Object'')
** Select ''Finish''
* Change the Sample.java file to:

import com.bistudio.JNIScripting.RVEngine;

/**
* Sample Java class
* @author Bohemia Interactive
*/
public class Sample {
/**
* Show a hint passed to jCall.
* @param args Method parameters
*/
public static Object showHint(Object[] args) {
if (!(args[0] instanceof String)) return null;
RVEngine.hint((String)args[0]);
return null;
}
}

* Save the file

=== Debugging ===
* Run TKOH with start-up parameter ''-jDebugPort=8008'' (or another suitable port number)
* Open the mission in the editor
** In the player's ''Initialization''-field add:

BIS_Sample = jLoad "Sample"; BIS_Result = BIS_Sample jCall ["showHint", ["Take On World!"]];

* In Eclipse, go to the ''Run'' menu and select ''Debug Configurations..''
** Double-click ''Remote Java Application''
** Change the port number to the one you launched TKOH with (8008)
** In the ''Common'' tab, tick to show this configuration in the ''Debug'' favorites menu for ease of use
** Select ''Apply'' and ''Close''
* Place a breakpoint on the following line (double-click the grey column on the left):

RVEngine.hint((String)args[0]);

* Start the debugger from the ''Debug'' favorites menu (by default named ''Sample (1)'')
* In TKOH, preview the mission
** Eclipse's debugger will take focus almost immediately to show the breakpoint
*** If Eclipse does not show the source code it is paused at, make sure the project and JNIScripting.jar are listed under the ''Source'' tab in the debug configuration (''Source Lookup Path'')
** Press F8 to resume
** Return to TKOH to see the hint displayed
* Welcome to '''Take On Java'''!

[[Category:Scripting_Topics|Java Scripting]]
[[Category:Take_On_Helicopters:_Editing|Java Scripting]]