LocalScript¶
An object that contains and runs Luau code on the client (player's device) instead of the server.
Description¶
A LocalScript is a Luau source container that runs its contents on the client (player's device) instead of the server. It is used to access client-only objects such as the player's Camera.
For code run through LocalScripts, the LocalPlayer property of the Players service will return the player whose client is running the script.
See here for a table of valid container services from which LocalScripts will execute.
Inheritance¶
Object → Instance → LuaSourceContainer → BaseScript → Script → LocalScript
Nova inheritance: Instance → LuaSourceContainer → BaseScript → Script → LocalScript
Inherited members¶
Inherited from Script: 11 properties, 37 methods, 7 events. They are documented on the base class page.
Roblox reference: LocalScript
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.