AmberFrost: LX86 moved page JCM:Scripting:Documentation:Resource Loading to JCM:Scripting/Resource Loading

2025-02-23T15:28:51Z

LX86 moved page JCM:Scripting:Documentation:Resource Loading to JCM:Scripting/Resource Loading

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

AmberFrost at 06:13, 6 February 2025

2025-02-06T06:13:53Z

← Older revision		Revision as of 14:13, 6 February 2025
Line 20:		Line 20:

	== Model Loading ==		== Model Loading ==
	~~'''Model loading~~ is not ~~implemented~~ in ~~JCM for now~~.~~'''~~		Please note that the current API is somewhat simplistic and does not offer fine-grained control like in MTR 3/NTE.
			{\| class="wikitable"
			!Functions
			!Description
			\|-
			\|<code>static ModelManager.loadModel(id: Identifier, flipV: boolean): ScriptedModel</code>
			\|Load an OBJ/bbmodel model from a path and upload to the GPU.
			Set flipV to true if your texture is rendered incorrectly.
			\|}

	== Loading AWT Resources ==		== Loading AWT Resources ==

AmberFrost: Created page with "= Resource Loading = NTE/JCM provides several methods for controlling the loading and retrieval of resources within resource packs in JavaScript scripts. Code written in the top-level space outside of functions will be executed when a resource pack is loaded and can be used to initialize resources such as models, textures, etc. Resources that should not be different for each train (such as models and such) are recommended to be stored in global variables to avoid excess..."

2024-11-05T11:45:29Z

Created page with "= Resource Loading = NTE/JCM provides several methods for controlling the loading and retrieval of resources within resource packs in JavaScript scripts. Code written in the top-level space outside of functions will be executed when a resource pack is loaded and can be used to initialize resources such as models, textures, etc. Resources that should not be different for each train (such as models and such) are recommended to be stored in global variables to avoid excess..."

New page

= Resource Loading =
NTE/JCM provides several methods for controlling the loading and retrieval of resources within resource packs in JavaScript scripts.

Code written in the top-level space outside of functions will be executed when a resource pack is loaded and can be used to initialize resources such as models, textures, etc. Resources that should not be different for each train (such as models and such) are recommended to be stored in global variables to avoid excessive memory usage when loading a copy of the same content for each train.

== Identifier (ResourceLocation) ==
Minecraft uses a Identifier to identify files in a resource pack. Many but not all functions only accept <code>Identifier</code> paths rather than strings. To create a <code>Identifier</code>, you can use the following functions:
{| class="wikitable"
!Functions
!Description
|-
|<code>static Resources.id(idStr: string): Identifier</code>
|Converts the string to the appropriate Identifier
e.g. <code>Resources.id(“mtr:path/absolute.js”)</code>.
|-
|<code>static Resources.idr(relPath: string): Identifier</code>
|Converts the string to Identifier relative to the directory that the currently executed script are located in
e.g. <code>Resources.idr(“relative.js”)</code>.
|}

== Model Loading ==
'''Model loading is not implemented in JCM for now.'''

== Loading AWT Resources ==
These functions load the resources used to draw dynamic textures via the Java AWT.
{| class="wikitable"
!Functions
!Description
|-
|<code>static Resources.getSystemFont(name: string): Font</code>
|Get a system or MTR built-in font.
{| class="wikitable"
|+
!Font Name
!Description
|-
|Noto Serif
|MTR's built-in serif font (similar to Song). Identical on all systems.
|-
|Noto Sans
|NTE Built-in sans serif font (similar to Helvetica). Identical on all systems. '''[Not available in JCM for now]'''
|-
|Serif
|A serif font selected by AWT that is installed on this computer. May be different on different devices.
|-
|SansSerif
|A sans serif font selected by AWT that is installed on this computer. May be different on different devices.
|-
|Monospaced
|A monospaced font selected by AWT that is installed on this computer. May be different on different devices.
|}
|-
|<code>static Resources.readFont(path: Identifier): Font</code>
|
* Load a custom TTF or OTF font file as an AWT Font.
* ''Note: Due to the way Java and Minecraft Resource Pack works, new temporary font files are generated on your disk every time you call this function. If you find yourself running out of disk space during the development, you can free up disk space by deleting files starting with <code>+~JF</code> on your system temp directory, or restart your Minecraft/Computer.''
|-
|<code>static Resources.readBufferedImage(path: Identifier): BufferedImage</code>
|Loads an image file as an AWT BufferedImage.
|-
|<code>static Resources.getFontRenderContext(): FontRenderContext</code>
|Get an AWT FontRenderContext.
|}

== Reading resource files ==
{| class="wikitable"
!Functions
!Description
|-
|<code>static Resources.readString(location: Identifier): string?</code>
|Reads the contents of a resource file as a string. Returns null if reading fails.
|}

JCM:Scripting/Resource Loading - Revision history

AmberFrost: LX86 moved page JCM:Scripting:Documentation:Resource Loading to JCM:Scripting/Resource Loading

AmberFrost at 06:13, 6 February 2025