Am i Using ModuleScript correctly for local Ui's?

Help and Feedback Scripting Support
, , ,
#1

I recently decided to better organize my scripts in the game I’m developing. I start with the client, since by comparison, I have more local scripts than server scripts and modules being used within the game.
Well, researching in the community, I found several tips to optimize my local scripts. I saw several developers using modules and only one script to satisfy the entire UI. I tried but I think I’m going the wrong way. I have some questions:

Main Local Script 
local LocalPlayer = game.Players.LocalPlayer or game.Players.PlayerAdded:Wait()

local PlayerGui = LocalPlayer:WaitForChild("PlayerGui")


local PGuiModule = require(script:WaitForChild("GuiVar"))

PGuiModule.HouseGui.CloseHouseFrame.MouseButton1Click:Connect(function()
	
end)
ModuleScript 
local PGuiModule = {}

local LocalPlayer = game.Players.LocalPlayer or game.Players.PlayerAdded:Wait()

local PlayerGui = LocalPlayer:WaitForChild("PlayerGui")

PGuiModule.HouseGui = {
	BuyHouseFrame = PlayerGui:WaitForChild("HouseGui").BuyHouseFrame;
	PaintHouseFrame = PlayerGui.HouseGui.PaintHouseFrame;
	CloseHouseFrame = PlayerGui.HouseGui.BuyHouseFrame.Background.Close
}

return PGuiModule
  • To be able to use less memory with variable what is the best way to store these variables?
  • May i use only one script for all children of StarterGui?
#2

For the LocalScript (and ModuleScript), or game.Players.PlayerAdded:Wait() is not necessary as when the Player joins, the LocalScript will Automatically run for that Player, However with the Players Character, and many other aspects, It may not Load immediately, So that’s why you do this:

local Char = Player.Character or Player.CharacterAdded:Wait()

or this:

repeat wait() until Player.Character

or this:

if Example then

or this:

local EX = Example:WaitForChild("Item")
1 Like
#3

nice point, but the code it’s correct? I mean the composition.

#4

Looks Alright, but I would probably say do this for the ModuleScript:

local PGuiModule = {}

PGuiModule.LocalPlayer = game.Players.LocalPlayer

PGuiModule.PlayerGui = PGuiModule.LocalPlayer:WaitForChild("PlayerGui")

PGuiModule.HouseGui = {
	BuyHouseFrame = PGuiModule.PlayerGui:WaitForChild("HouseGui").BuyHouseFrame;
	PaintHouseFrame = PGuiModule.PlayerGui.HouseGui.PaintHouseFrame;
	CloseHouseFrame = PGuiModule.PlayerGui.HouseGui.BuyHouseFrame.Background.Close
}

return PGuiModule

However thats your choice

1 Like
#5

Referencing LocalPlayer in ModuleScripts is safe only as long as they run in a local context otherwise it will produce an error.

In terms of memory it is better to have variables defined with the local keyword as after they are not used in the code anymore they will be garbage collected, although while tables are garbage collected after they are not referenced in the code anymore, tables’ keys and values don’t so they will be kept in memory until the table is not used anymore except for weak tables.

2 Likes
#6

Nice observation, so what is the best place to save variables? in the local script itself or in the module?

#7

I would save variables in the LocalScript and if you really want to avoid writing them in each script you can make a function in the module script which returns them.

1 Like
#8

This topic was automatically closed 14 days after the last reply. New replies are no longer allowed.