Module Script Support

Help and Feedback Scripting Support
#1

There are many situations where I need to turn the player first person throughout many scripts, so I decided that this would be most effective with a module script. It does work, but I want to know if this is the most efficient way to compile the module script.

local module = {}

function module.firstPerson()
	local WS = game:GetService("Workspace")
	local Players = game:GetService("Players")
	local ContextActionService = game:GetService("ContextActionService")
	local Lighting = game:GetService("Lighting")

	local player = Players.LocalPlayer
	local char = player.Character or player.CharacterAdded:Wait()
	local hum = char:FindFirstChild("Humanoid") or char:WaitForChild("Humanoid")
	local camera = WS.CurrentCamera
	local head = char:FindFirstChild("Head") or char:WaitForChild("Head")

	camera.CameraSubject = char
	camera.CFrame = head.CFrame
	hum.WalkSpeed = 16
	hum.JumpPower = 50
	camera.FieldOfView = 70
	camera.DiagonalFieldOfView = 126.595
	camera.MaxAxisFieldOfView = 101.495
	Lighting.FogEnd = 75

	ContextActionService:UnbindAction("NoDrag")

	player:WaitForChild("Cam").Value = "f"
end

return module
3 Likes
#2

Create Service variables at the top of the module so you don’t have to type it again for other functions: (and it saves like 0.00001 seconds of runtime)

local WS = game:GetService("Workspace")
local Players = game:GetService("Players")
local ContextActionService = game:GetService("ContextActionService")
local Lighting = game:GetService("Lighting")

local module = {}

function module.FirstPerson()
--(...)-- Rest of the code

Set every local variable to nil at the end of the function to save memory:

This was not neccessary lol (Thanks @HugeCoolboy2007)

--(...)--
	local player = nil
	local char = nil
	local hum = nil
	local camera = nil
	local head = nil
end

return module

And instead of doing :FindFirstChild() or :WaitForChild() just do :WaitForChild()

--(...)--
	local hum = char:WaitForChild("Humanoid")
	local camera = WS.CurrentCamera
	local head = char:WaitForChild("Head")
--(...)--

other than these, I don’t see any issue.

#3

Thanks so much. Hypothetically, if the variables are defined in a script that you are using the module function in, would you be able to use the variables from that script for the module? For example, there is a script that already localizes head, camera, hum, and everything else, and you want to use the module function inside this script that already has these things as variables. Is there any way to do that?

#4

That isn’t really necessary because of Lua/Luau’s automatic garbage collection

#5

That’s good to know. So there’s no use of setting them to nil?

#6

You can if you want to, but unless they have references in other places, you may not see any large gains from it

#7

I see. Thanks for the information.

#8

Anyone have the answer to this??

#9

^^^ This is the part I am wondering about.

#10

I don’t think there is a way to do it using local variables, every script has its own local variables and they can be accessed only in that spesific script.

But you can make the variables global using _G
Example:

--Script 1--
_G.WS = workspace
_G.Variable = "asd"

--Script 2--
print(_G.WS) --Outputs: Workspace
print(_G.Variable) --Outputs: asd
#11

Ahh I understand. I will try to refrain from using global variables because I heard they aren’t very good, so J will continue will the info you gave me. Thanks so much.

#12

pass them as parameters, I would not use globals.

#13

Could you give me an example of that and how I would implement it with the local scripts utilizing the module function?