Decoration Object Related

In addition to train rendering, the use of JavaScript scripting with Decoration Object (Also known as Eye Candy) are also supported.

You can add a model that uses JavaScript to control rendering by writing something like this in your decor_obj.json file (Where decor_obj.json is the json file that contains the NTE decoration object):

decor_obj.json

{
  "nte_lcd": {
      "name": "NTE LCD Test",
      "translation": [ 0, 0, 0 ],
      "rotation": [ 0, 0, 0 ],
      "scale": [ 1, 1, 1 ],
      "scriptFiles": ["mtrsteamloco:eyecandies/js/nte_lcd_test/main.js"],
      "mirror": [ false, false, false ]
  }
}

In general, the parameters are the same as those required for regular decoration object json for NTE, except for the scriptFiles parameter.

If the model parameter is not specified, the JavaScript-driven elements will be overlaid on top of the existing model. Otherwise, the appearance will be controlled solely by JavaScript.

Note that JavaScript train uses script_files (Snake Case) in the MTR Custom Resource json, while NTE Decoration Object uses scriptFiles (Camel Case) in the respective Decoration Object json file.

All blocks of the same type use the same working environment (global variables and etc).

Code written in top-level space outside of functions will run when the resource pack is loaded, and can be used to load resources such as models and textures.

It is recommended to store resources (such as models, fonts and textures) which are the same for each block in the global variables to avoid excessive memory usage caused by loading the same copy of the content for each block.

Your script should include the following functions that the NTE will call as needed:

function create(ctx, state, blockEntity) { ... }
function render(ctx, state, blockEntity) { ... }
function dispose(ctx, state, blockEntity) { ... }

The NTE calls these functions with three parameters, each of which is described below.

The following lists all the rendering control operations that can be performed and all the information that can be obtained about blockEntity.

The following functions are called to control rendering. The functions for rendering models should be called each time render is called.

• EyeCandyScriptContext.drawModel(model: ModelCluster, poseStack: Matrices): void

  • Requests NTE to render a model.
  • poseStack: transformation of model placement. If passed null, the model will be placed in the center of the block without transformation.

• EyeCandyScriptContext.playSound(sound: ResourceLocation, volume: float, pitch: float): void

  • Play a sound in-game with the corresponding volume and pitch.

Same with train, a set of functions exists to aid development and debugging.

• EyeCandyScriptContext.setDebugInfo(key: String, value: Object)

  • Output debugging information in the upper left corner of the screen. You need to enable “Show JS debug info” in NTE Settings to display it. key is the name of the value, value is the content (GraphicsTexture type will be displayed, others will be converted to string).

• blockEntity.getBlockPos(): BlockPos

  • Returns the Minecraft BlockPos of where the block are located in. (Note: This is obfuscated by Minecraft, which is only useful for passing value to MTR ClientData)

• blockEntity.getWorldPosVector3f(): Vector3f

  • Returns NTE's Vector3f of where the block are located (Only in NTE version >= 0.5.0)