How can i use a Module script to make my code more organised and efficient?

ModuleScript objects have default code already pasted, similar to Scripts and LocalScripts how they have print("Hello world") as the default code. This is the default code for modules:

local module = {}

return module

Modules act like a function in a way. It must be called. Modules are basically tables, which will be returned, so we can index objects inside the table. Take this for example:

local module = {} -- You can name them anything, I just used the default name

function module.functionInModule() 
    print("I’m a function inside a module!")
end



return module -- required to work

Functions inside modules MUST be global, cannot be local. You make it local by adding the keyword local before function. local function

From your server/local script:

local module = require(game.Workspace.ModuleScript) -- i put in workspace

module.functionInModule() -- prints code 

A cool thing to note about ModuleScripts is that they take on the behaviour of a Script or a LocalScript, depending on what you use. For example, if you used LocalPlayer in a module, you MUST require it from a LocalScript else the script will error and LocalPlayer will return nil, since LocalPlayer is client-side only.

Hello there! I am excited that you are giving ModuleScripts a chance for the sake of organization.

Although there are good practices and bad practices many people use modules to a different extent, because as is with a normal script, it heavily depends on your coding style and how much code you can handle in your regular scripts before you consider it unorganized.

With that in mind, first I will teach you the basic functionality of a module, and then I will show you how I use modules.

--

A module is like any other script, the code in it runs from top to bottom, and it only runs once.

If you have a loop inside it, that loop will obviously still loop, but a ModuleScript is not a function that you call.

The primary differences are as follows:

• it does not run until the first time it is required
• at the very end of the ModuleScript, you must return exactly one value

Module Script

print("ModuleScript is running")

return true

"Normal" (Server) Script

local testing = require(script.Testing) --> true

if testing then
    print("TEST MODE ACTIVATED!")
else
    print("THIS IS NOT A DRILL!")
end

In this example, all the module does is print that it is running, and then returns true. In this case, I am letting the script that is requiring it know that the game is currently in "test mode", whatever that means.

With that being said, you can require the same module in multiple scripts, and then they will all know that the game is in test mode. If you want to change the test mode, you just have to change it in the module, and not have to worry about each individual script.

Module Script

local quickmaths = {}

quickmaths.Add = function(a, b)
    if a and b then
        local res = a + b
        print(("%d + %d = %d"):format(a, b, res))
        return res
    else
        print("2 + 2 = 4")
        return 2 + 2
    end
end

quickmaths.Subtract = function(a, b)
    if a and b then
        local res = a - b
        print(("%d - %d = %d"):format(a, b, res))
        return res
    else
        print("4 - 1 = 3")
        print("QUICKMATHS")
        return 4 - 1
    end
end

return quickmaths

"Normal" (Server) Script

local quickmaths = require(script.quickmaths)

local seven = quickmaths.Add(5, 2)      
local four = quickmaths.Subtract(seven, 3)

quickmaths.Add()
quickmaths.Subtract()

Here, you should be able to see the difference. I've moved a table of custom math methods into a module, thus organizing my code.

ModuleScripts are extensions of normal scripts. You can throw the clutter in them. Functions, tables, math, libraries. What does that leave your normal script looking like?

If you've done it right, at the end of it all, it is short, readable, and easy to understand the flow of the game.

--

Final notes:

• The return value of a module script is cached.
• Modules run in the environment you require them in. If you put a module in ReplicatedStorage, it is copied to both the Client and the Server, however editing it will be editing their separate copies and is not a means to send messages without remotes.

Contact me on Discord if you have any questions, or would like more information about modules that I have not provided in this answer. My Discord tag is amanda#9999.

local Object = {}

--------------- Function.Waves(BrickColor.new("Cyan"), Torso, 1, 0.5)

local Effects = game:GetService("ServerStorage"):WaitForChild("Skills")
local Meshes = Effects:WaitForChild("Assets")
local Parts = workspace:WaitForChild("PartStorage")
local rep = game:GetService("ReplicatedStorage")
local Assets = rep:WaitForChild("Assets")
local auras = rep:WaitForChild("Aura")
local auras2 = rep:WaitForChild("WideAuras")

----------- DUST 2.0
function Object.Dust(root, duration)
    local dust = Assets.Dust:Clone()
    dust.Parent = root
    wait(duration)
    dust.Rate = 0
    game.Debris:AddItem(dust, 5)
end

return Object

------ script
local object = require(module) ----- define everything in the script you call the module functions

local plr = plr
local char = character
local root = char.HumanoidRootPart

object.Dust(root, 5)