JCM:Scripting/Utilities - Revision history

AmberFrost: Fix example using old name (HttpUtil)

2025-04-16T14:24:40Z

Fix example using old name (HttpUtil)

← Older revision		Revision as of 22:24, 16 April 2025
Line 273:		Line 273:

	/* POST request */		/* POST request */
	let dataResponse = ~~HttpUtil~~.fetchString("https://localhost:7171", {		let dataResponse = Networking.fetchString("https://localhost:7171", {
	method: "POST",		method: "POST",
	connectTimeout: 1000, // in millisecond		connectTimeout: 1000, // in millisecond

AmberFrost: Document Files Util

2025-04-09T17:32:27Z

Document Files Util

← Older revision		Revision as of 01:32, 10 April 2025
Line 296:		Line 296:
	==== Further Note ====		==== Further Note ====
	Currently the '''User-Agent''' header is always overriden to <code>Joban Client Mod (<nowiki>https://joban.org/jcm</nowiki>)</code>.		Currently the '''User-Agent''' header is always overriden to <code>Joban Client Mod (<nowiki>https://joban.org/jcm</nowiki>)</code>.

			=== Files ===
			The '''Files''' class allows saving/reading files with scripts to a limited degree. It is intended for scripts to use it as a config file and storing persistent/cache data. This is usually only useful for very advanced scripts.

			==== Scope ====

			* Scripts can perform '''Read/Write/Delete''' operation under the '''.minecraft/data/mtrscripting''' directory. This directory is reserved for scripts to store data.
			* Scripts can perform '''Read''' operation under '''.minecraft'''. This is intended to migrate existing scripts to MTR 4, which previously contains file residing on another directory. (And also to detect and provide mod compatibility for ''really advanced'' scripts)
			* Scripts are not allowed to access anything outside the '''.minecraft''' directory.

			{\| class="wikitable"
			!Functions
			!Description
			\|-
			\|<code>static Files.read(path: string...): string</code>
			\|Read a file based on the specified path and returns the content in string (null if the file don't exist).
			This function always resolves relatively starting from '''.minecraft'''.

			\|-
			\|<code>static Files.readData(path: string...): string</code>
			\|Read a file based on the specified path and returns the content in string (null if the file don't exist).
			'''Note:''' It is recommended to store your file in a sub-directory with a unique name to avoid collision

			This function always resolves relatively starting from '''.minecraft/data/mtrscripting'''.
			\|-
			\|<code>static Files.saveData(content: string, path: string...): void</code>
			\|Create a file with the specified content in the specified path. The filename should be included in the path already.
			All parent directory in the path will be automatically generated if it doesn't exists.

			This function always resolves relatively starting from '''.minecraft/data/mtrscripting'''.
			\|-
			\|<code>static Files.deleteData(path: string...): void</code>
			\|Delete the file from the specified path.
			This function always resolves relatively starting from '''.minecraft/data/mtrscripting'''.
			\|-
			\|<code>static Files.hasData(path: string...): boolean</code>
			\|Returns whether the specified file/directory exists.
			This function always resolves relatively starting from '''.minecraft/data/mtrscripting'''.
			\|}

			==== Example ====
			<pre>
			// Notice that we don't use forward slash (/) or backslash (\) to specify path, but instead pass them onto multiple arguments (e.g. ("config", "mtr.json") instead of ("config/mtr.json")
			let mtrConfigStr = Files.read("config", "mtr.json");
			let mtrConfig = JSON.parse(mtrConfigStr);
			let mtrChatAnnouncementEnabled = mtrConfig.chatAnnouncements;

			let nonExistentFile = Files.read("1234567890");
			print(nonExistentFile); // null

			/* Data reading */
			let haveCompanyName = Files.hasData("tut_script", "company_name.txt");
			let companyName = haveCompanyName ? "Unnamed Company" : Files.readData("tut_script", "company_name.txt"); // Of course this is an extreme example. Since readData returns null if non-existent anyway, you can just check whether it's null instead of calling hasData separately.

			/* Data Saving */
			Files.saveData("grass_has_been_touched", "tut_script", "stage.txt");
			</pre>

AmberFrost: Example for Networking Utilities

2025-04-09T16:51:20Z

Example for Networking Utilities

@@ Line 262: / Line 262: @@
 ==== Example ====
-TODO
+<pre>
 ==== Further Note ====
 Currently the '''User-Agent''' header is always overriden to <code>Joban Client Mod (<nowiki>https://joban.org/jcm</nowiki>)</code>.

AmberFrost: Add Timing.currentTimeMillis() and Timing.nanoTime()

2025-04-09T16:38:26Z

Add Timing.currentTimeMillis() and Timing.nanoTime()

← Older revision		Revision as of 00:38, 10 April 2025
Line 66:		Line 66:
	\|<code>static Timing.delta(): double</code>		\|<code>static Timing.delta(): double</code>
	\|The time difference between the current <code>render</code> call and the previous one. This can be used, for example, to calculate the angle by which the wheel have turned during the elapsed time.		\|The time difference between the current <code>render</code> call and the previous one. This can be used, for example, to calculate the angle by which the wheel have turned during the elapsed time.
			\|-
			\|<code>static Timing.currentTimeMillis(): long</code>
			\|Returns the current time in millisecond (Since 1970/1/1).
			This is the same as Java's [https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#currentTimeMillis-- System.currentTimeMillis()]
			\|-
			\|<code>static Timing.nanoTime(): long</code>
			\|This is the same as Java's [https://docs.oracle.com/javase/8/docs/api/java/lang/System.html#nanoTime-- System.nanoTime()]
	\|}		\|}

AmberFrost: Rename HttpUtil to Networking

2025-04-04T10:43:36Z

Rename HttpUtil to Networking

← Older revision		Revision as of 18:43, 4 April 2025
Line 187:		Line 187:
	\|}		\|}

	=== ~~HttpUtil~~ ===		=== Networking ===
	~~HttpUtil~~ allows scripts to send HTTP requests ~~to the internet, allowing scripts~~ to fetch plain text content/~~image~~ over the internet.		The <code>Networking</code> class allows scripts to send HTTP requests to fetch plain text content/images over the internet.

	Calling any function within this class will return a '''NetworkResponse''', which is described below.		Calling any function within this class will return a '''NetworkResponse''', which is described below.
Line 197:		Line 197:
	!Description		!Description
	\|-		\|-
	\|<code>static ~~HttpUtil~~.fetchString(url: string): NetworkResponse<String></code>		\|<code>static Networking.fetchString(url: string): NetworkResponse<String></code>
	\|Fetch plain text content from the corresponding URL		\|Fetch plain text content from the corresponding URL
	\|-		\|-
	\|<code>static ~~HttpUtil~~.fetchString(url: string, requestOption: RequestOption): NetworkResponse<String></code>		\|<code>static Networking.fetchString(url: string, requestOption: RequestOption): NetworkResponse<String></code>
	\|Fetch plain text content from the corresponding URL, with the request option applied. (See below for RequestOption)		\|Fetch plain text content from the corresponding URL, with the request option applied. (See below for RequestOption)
	\|-		\|-
	\|<code>static ~~HttpUtil~~.fetchImage(url: string): NetworkResponse<BufferedImage></code>		\|<code>static Networking.fetchImage(url: string): NetworkResponse<BufferedImage></code>
	\|Fetch image from the corresponding URL		\|Fetch image from the corresponding URL
	\|-		\|-
	\|<code>static ~~HttpUtil~~.fetchImage(url: string, requestOption: RequestOption): NetworkResponse<BufferedImage></code>		\|<code>static Networking.fetchImage(url: string, requestOption: RequestOption): NetworkResponse<BufferedImage></code>
	\|Fetch image from the corresponding URL, with the request option applied. (See below for RequestOption)		\|Fetch image from the corresponding URL, with the request option applied. (See below for RequestOption)
	\|}		\|}
Line 258:		Line 258:

	==== Further Note ====		==== Further Note ====
	~~HttpUtil currently always overrides~~ the '''User-Agent''' header to <code>Joban Client Mod (<nowiki>https://joban.org/jcm</nowiki>)</code>.		Currently the '''User-Agent''' header is always overriden to <code>Joban Client Mod (<nowiki>https://joban.org/jcm</nowiki>)</code>.

AmberFrost: Add HttpUtil

2025-03-27T14:34:23Z

Add HttpUtil

@@ Line 97: / Line 97: @@
 |}
-== CycleTracker ==
+=== CycleTracker ===
 This is a <code>StateTracker</code> that automatically switches on a cyclic basis by time.
@@ Line 130: / Line 130: @@
 |}
-== RateLimit ==
+=== RateLimit ===
 Some tasks do not require too frequent execution, for example, the display may not be updated every frame, but only 10 times per second. Therefore, you can limit the frequency of their execution to improve performance.
@@ Line 174: / Line 174: @@
 |-
-|<code><s>static MinecraftClient.worldIsRainingAt(pos: Vector3f): boolean</s></code>
+|<code>static MinecraftClient.worldIsRainingAt(pos: Vector3f): boolean</code>
 |Is it raining and getting wet in a given chunk?
 |-
 |<code>static MinecraftClient.worldDayTime(): int</code>
@@ Line 187: / Line 186: @@
 |This displays the message as an in-game chat message. If action bar is true, it will display on the action bar instead. (Above inventory hotbar)
 |}

AmberFrost: Remove deprecated function

2025-03-23T06:05:03Z

Remove deprecated function

@@ Line 20: / Line 20: @@
 * mtr
 * jcm
 |}

AmberFrost: LX86 moved page JCM:Scripting:Documentation:Utilities to JCM:Scripting/Utilities

2025-02-23T15:28:55Z

LX86 moved page JCM:Scripting:Documentation:Utilities to JCM:Scripting/Utilities

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

AmberFrost: Update

2025-01-31T15:14:45Z

Update

← Older revision		Revision as of 23:14, 31 January 2025
Line 1:		Line 1:
	=Utilities=		=Utilities=
	As the scripting functionality is based on the '''Nemo Transit Expansion''', a number of helper classes are ~~incorporated~~ from NTE to provide informations or to simplify code implementation.		As the scripting functionality is based on the '''Nemo Transit Expansion''', a number of helper classes are inherited from NTE to provide informations or to simplify code implementation.

	===Printing debug information===		===Printing debug information===
Line 26:		Line 26:
	\|-		\|-
	\|<code>static Resources.getNTEVersion(): string</code>		\|<code>static Resources.getNTEVersion(): string</code>
	\|Returns the version of the NTE.		\|Returns the version of the NTE (Nemo Transit Expansion) mod.
	As there ~~are~~ no NTE ~~version~~ for MTR 4, this function is hard-coded to <code>0.5.2+1.20.4</code>.		As there's no NTE for MTR 4, this function is hard-coded to return <code>0.5.2+1.20.4</code>.
	\|-		\|-
	\|<code>static Resources.getNTEVersionInt(): int</code>		\|<code>static Resources.getNTEVersionInt(): int</code>
	\|Returns the NTE version as a number for easy comparison.		\|Returns the NTE (Nemo Transit Expansion mod) version as a number for easy comparison.
	As there ~~are~~ no NTE ~~version~~ for MTR 4, this function is hard-coded to <code>502</code>. (For 0.5.2)		As there's no NTE for MTR 4, this function is hard-coded to return <code>502</code>. (For 0.5.2)
	\|-		\|-
	\|<code>static Resources.getNTEProtoVersion(): int</code>		\|<code>static Resources.getNTEProtoVersion(): int</code>
	\|Returns the NTE protocol version.		\|Returns the NTE (Nemo Transit Expansion mod) protocol version.
	As there ~~are~~ no NTE version for MTR 4, this function is hard-coded to <code>2</code>.		As there's no NTE version for MTR 4, this function is hard-coded to return <code>2</code>.
	\|}		\|}

Line 197:		Line 197:
	\|Returns the in-game world time in ticks.		\|Returns the in-game world time in ticks.
	\|-		\|-
	\|<code~~><s~~>static MinecraftClient.narrate(message: string): void~~</s>~~</code>		\|<code>static MinecraftClient.narrate(message: string): void</code>
	\|This calls the Minecraft narrator to narrate the message.		\|This calls the Minecraft narrator to narrate the message.
	~~'''[Not Implemented]'''~~
	\|-		\|-
	\|<code>static MinecraftClient.displayMessage(message: String, actionBar: boolean): void</code>		\|<code>static MinecraftClient.displayMessage(message: String, actionBar: boolean): void</code>
	\|This displays the message as an in-game chat message. If action bar is true, it will display on the action bar instead. (Above inventory hotbar)		\|This displays the message as an in-game chat message. If action bar is true, it will display on the action bar instead. (Above inventory hotbar)
	\|}		\|}

AmberFrost: Amend

2024-11-18T09:08:08Z

Amend

← Older revision		Revision as of 17:08, 18 November 2024
Line 46:		Line 46:
	\|<code>static TextUtil.cycleString(src: String): String</code>		\|<code>static TextUtil.cycleString(src: String): String</code>
	\|Returns a text that cycles different languages. (Delimited by the pipe <code><nowiki>\|</nowiki></code> character)		\|Returns a text that cycles different languages. (Delimited by the pipe <code><nowiki>\|</nowiki></code> character)
			\|-
			\|<code>static TextUtil.cycleString(src: String, duration: int): String</code>
			\|Returns a text that cycles different languages. (Delimited by the pipe <code><nowiki>\|</nowiki></code> character)
			The cycle frequency is decided by the <code>duration</code> parameter, in Minecraft Tick.
	\|-		\|-
	\|<code>static TextUtil.getCjkParts(src: String): String</code>		\|<code>static TextUtil.getCjkParts(src: String): String</code>