JCM:Scripting - Revision history

AmberFrost: Protected "JCM:Scripting" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading]

2025-05-31T12:26:32Z

Protected "JCM:Scripting" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) [cascading]

← Older revision	Revision as of 20:26, 31 May 2025
(No difference)

AmberFrost: Deprecate page

2025-05-31T12:26:23Z

Deprecate page

Show changes

AmberFrost: Add example script parsing flow

2025-05-10T18:34:01Z

Add example script parsing flow

← Older revision		Revision as of 02:34, 11 May 2025
Line 41:		Line 41:

	=== Script Flow ===		=== Script Flow ===

			==== Initial Parsing ====
			Instead of each train having it's own script instance, your JS scripts are parsed (Or rather, executed) '''once''' during the resource pack loading.

			Your script are expected to have functions with specific name (e.g. '''create()''', '''render()''', '''dispose()''').

			These functions will be invoked by JCM/NTE with the parameter corresponding to a specific train/eyecandy/object, including a parameter ('''state''') where you can store variables to that specific train.

			Consider the following example of scripting applied to a train:<pre>
			let displaySpeed = 1;

			function create(ctx, state, train) {
			state.displaySpeed = 0.75;
			}

			function render(ctx, state, train) {
			state.displaySpeed++;
			console.log("dp: " + state.displaySpeed);
			}

			function dispose(ctx, state, train) {
			}

			console.log(displaySpeed);
			</pre>An example output would be:<pre>
			1 // The console.log at the bottom of the script, as the entire script is executed once during resource reload

			dp: 1.75 // Train A rendering
			dp: 2.75 // Train A rendering

			// Assume Train B now enters the view

			dp: 3.75 // Train A rendering
			dp: 1.75 // Train B rendering

			dp: 4.75 // Train A rendering
			dp: 2.75 // Train B rendering
			</pre>

			==== Execution ====
	An example flow is available below. This chart assumes the player is running Minecraft at 13fps (For simplicity sake), which means 13 frames in 1 second.[[File:JCM Script Execution Example.png\|559x559px]]		An example flow is available below. This chart assumes the player is running Minecraft at 13fps (For simplicity sake), which means 13 frames in 1 second.[[File:JCM Script Execution Example.png\|559x559px]]

AmberFrost: Better wording

2025-04-16T17:03:08Z

Better wording

← Older revision		Revision as of 01:03, 17 April 2025
Line 61:		Line 61:
	[[wikipedia:Delta_timing\|Delta timing]] is used to solve this by obtaining the time since last frame, which can then be used to balance out the value.		[[wikipedia:Delta_timing\|Delta timing]] is used to solve this by obtaining the time since last frame, which can then be used to balance out the value.

	==== ~~Scripts are NOT~~ always executed every frame! ====		==== Except they aren't always executed every frame! ====
	While JCM ''tries'' to call the <code>render()</code> function for every frame, it is only made on a best-effort basis. If your script has not finished executing before the next frame came around, then your function won't be called again until it has finished execution.		While JCM ''tries'' to call the <code>render()</code> function for every frame, it is only made on a best-effort basis. If your script has not finished executing before the next frame came around, then your function won't be called again until it has finished execution.

AmberFrost: Add java.util.* to whitelist

2025-03-28T05:54:57Z

Add java.util.* to whitelist

← Older revision		Revision as of 13:54, 28 March 2025
Line 97:		Line 97:
	* java.lang.*		* java.lang.*
	* sun.java2d.*		* sun.java2d.*
			java.util.

	=== Tips & Notes ===		=== Tips & Notes ===

AmberFrost at 05:57, 23 March 2025

2025-03-23T05:57:21Z

← Older revision		Revision as of 13:57, 23 March 2025
Line 88:		Line 88:
	* <code>radian: float</code> means that the parameter takes a numeric argument. Although JS does not distinguish between integers and fractional numbers, this article will specify a specific type - <code>int</code>, <code>long</code>, <code>float</code> or <code>double</code> - to make it clear whether a parameter can accept decimal parts and to what precision.		* <code>radian: float</code> means that the parameter takes a numeric argument. Although JS does not distinguish between integers and fractional numbers, this article will specify a specific type - <code>int</code>, <code>long</code>, <code>float</code> or <code>double</code> - to make it clear whether a parameter can accept decimal parts and to what precision.
	* <code>: void</code> means that the function has no return value.		* <code>: void</code> means that the function has no return value.

			=== Access of Java class ===
			To prevent misuse of scripts, script may only access java classes from the following packages:

			* com.lx862.jcm.mod.scripting.*
			* org.mtr.*
			* java.awt.*
			* java.lang.*
			* sun.java2d.*

	=== Tips & Notes ===		=== Tips & Notes ===

AmberFrost at 16:38, 23 February 2025

2025-02-23T16:38:28Z

@@ Line 16: / Line 16: @@
 ==Introduction==
-===How To Edit JavaScript Files?===
+=== What is JavaScript? ===
-A JavaScript file (.js) can be edited in a variety of editors. It is recommended to have a text editor that supports JavaScript Syntax Highlighting like Notepad++ or Sublime text. While a full IDE (like Visual Studio Code or IntelliJ) is not recommended, it can also be used as a basic text editor.
+JavaScript is a programming language that... in very simple terms, instructs computer to do stuff :D
-This rest of this article assumes that you have a basic understanding of JavaScript and JavaScript types, so it won't delve into the basic syntax and other aspects of it here. You can learn JavaScript from resources on the web, such as here.
+It can describe logic, an example would be:
-===Type Annotation===
+''<u>If</u> there's pineapple on top of the pizza, <u>then</u> remove the pineapple and eat the pizza, <u>otherwise</u> eat the pizza.''
 As you know, values in JS have different types. When calling a function, you must pass parameters of the appropriate type, and the result it returns will also have a type. In this article, all of the functions have their parameter and return types stated. For example:
@@ Line 38: / Line 88: @@
 * <code>radian: float</code> means that the parameter takes a numeric argument. Although JS does not distinguish between integers and fractional numbers, this article will specify a specific type - <code>int</code>, <code>long</code>, <code>float</code> or <code>double</code> - to make it clear whether a parameter can accept decimal parts and to what precision.
 * <code>: void</code> means that the function has no return value.
 === Tips & Notes ===
 ====Declaring variables using let or var====
-Both NTE and JCM uses JavaScript's '''strict mode''', which does not allow variables to be assigned without first declaring them.
+Both JCM/NTE uses JavaScript's '''strict mode''', which does not allow variables to be assigned without first declaring them.
-To declare a global variable, use syntax like <code>var glb;</code> or outside a function <code>var glb = 1;</code>. To use local variables inside a function, use <code>let local;</code> or <code>let local = 1;</code>.
+Instead, you have use syntax like <code>var glb;</code> or outside a function <code>var glb = 1;</code>. For local variables inside a function, use <code>let local;</code> or <code>let local = 1;</code>.
 [Translator's note: in general, it is better to always try to use <code>let</code> and resort to using <code>var</code> as a last resort].
@@ Line 67: / Line 109: @@
 If blocks or infinite loops did occur, then the entire script execution will stall as scripts are executed one at a time [''in the same thread'']. In such situation, you can reset it with F3+T.
-==== Differences When Using Java Classes/Methods ====
+==== Interoperability between Java Classes/Methods ====
 For common function types such as strings, Java and JavaScript have different class implementations, which causes there to be JavaScript strings as well as Java strings.
@@ Line 79: / Line 121: @@
 </pre>Similarly, there is a <code>List<T></code> type in Java. It does the same thing as arrays in JavaScript, but has a different type. Trying to call JavaScript array functions on it won't work, but Rhino adapts it so that you can take values with <code>list[0]</code> or loop through them with <code>for (a of list)</code>.
-====Supported Parts Of The JavaScript Standard====
+====What JavaScript features are supported?====
-The Rhino engine does not support all of the latest JavaScript features. See [https://mozilla.github.io/rhino/compat/engines.html Mozilla's documentation] for details on what is supported. JCM uses Rhino 1.7.15 with the <code>VERSION_ES6</code> flag enabled.
+The Rhino JavaScript Engine '''does not support''' all of the latest JavaScript features. See [https://mozilla.github.io/rhino/compat/engines.html Mozilla's documentation] for details on what is supported. JCM uses Rhino 1.7.15 with the <code>VERSION_ES6</code> flag enabled.
-=== Running Other Scripts ===
+=== Including Other Scripts ===
 By calling the function below, you can include and execute other JavaScript files.
 {| class="wikitable"

AmberFrost: LX86 moved page JCM Scripting to JCM:Scripting without leaving a redirect

2025-02-23T15:20:58Z

LX86 moved page JCM Scripting to JCM:Scripting without leaving a redirect

← Older revision	Revision as of 23:20, 23 February 2025
(No difference)

AmberFrost: LX86 moved page Joban Client Mod/Scripting to JCM Scripting

2025-02-23T14:43:15Z

LX86 moved page Joban Client Mod/Scripting to JCM Scripting

← Older revision	Revision as of 22:43, 23 February 2025
(No difference)

AmberFrost: LX86 moved page JCM:Scripting:Documentation to Joban Client Mod/Scripting

2025-02-23T14:42:28Z

LX86 moved page JCM:Scripting:Documentation to Joban Client Mod/Scripting

← Older revision	Revision as of 22:42, 23 February 2025
(No difference)