module

A module serves as a namespace for your scripts and is the barebone for most scripts you will create in your mod. The game’s namespace is Base, and while you can insert in it, it is recommended to use your own module for your mod’s scripts to avoid conflicts with the game and other mods.

To define a module, you need to create a block as follows, by changing the ID to a unique name for your mods:

module yourID
{
  ...
}

Most scripts that are defined in a module will need to be refered to by their ‘full type’, that is module.id, but this is a bit inconsistent as some places where a script block needs to be refered to require no module reference. For example, for an item, you can refer to it by its full type yourModule.yourItemID.

Hierarchy

Valid Parent Blocks:

• ROOT-Scripts

Possible Child Blocks:

• animation

• animationsMesh

• character_profession_definition

• character_trait_definition

• clock

• craftRecipe

• energy

• entity

• evolvedrecipe

• fixing

• fluid

• imports

• item

• mannequin

• model

• physicsHitReaction

• physicsShape

• ragdoll

• sound

• soundTimeline

• template

• timedAction

• vehicle

• vehicleEngineRPM

• xuiSkin

ID Properties

This block should have an ID.