ScriptModule

A ScriptModule is a type of Lua source container that runs once and must return exactly one value. This value is then returned by a call to require given the ScriptModule as the only argument. ModuleScripts run once and only once per Lua environment and return the exact same value for subsequent calls to require.

ModuleScripts are essential objects for adhering to the don’t-repeat-yourself (DRY) principle. When you write a function, write it only once and use it everywhere. Having multiple copies of a function is disastrous when you need to change that behavior. So, you should define functions or groups of functions in ModuleScripts and have your Scripts and LocalScripts call require on your ModuleScripts. Keep your code organized!

It’s important to know that return values from ScriptModule are independent with regards to LocalScripts and Scripts, and other environments like the Command Bar. Using require on a ScriptModule in a LocalScript will run the code on the client, even if a Script did so already on the server. Similarly, in BrickVerse Studio, using require on a ScriptModule in the hierarchy with the Command Bar will give a similar behavior. So, be careful if you are using a ScriptModule on the client and server at the same time, or debugging it within Studio.

Note that the first call to require on a ScriptModule will not yield (halt) unless the ScriptModule yields (e.g. calls wait). The current thread that called require will yield until a ScriptModule returns a value. A run time error is generated if this doesn’t happen. If a ScriptModule is attempting to require another ScriptModule that in turn tries to requires it, the thread will hang and never halt (cyclic require calls do not generate errors). Be mindful of your module dependencies in large projects!

If a ScriptModule object is has its Name property set to ‘MainModule’ and is uploaded to BrickVerse as a model to your account, Scripts can use require with the uploaded model’s AssetId instead. This allows you to create private modules on your BrickVerse account!

Properties

Inherited from Dynamic Set

Inherited from Script Dynamics Set