Garry's Mod Wiki

AddCSLuaFile

AddCSLuaFile

  AddCSLuaFile( string file = "current file" )

Description

Marks a Lua file to be sent to clients when they join the server. Doesn't do anything on the client - this means you can use it in a shared file without problems.

If the file trying to be added is empty, an error will occur, and the file will not be sent to the client

The string cannot have whitespace.

This function is not needed for scripts located in lua/autorun/ and lua/autorun/client/: they are automatically sent to clients.

You can add up to 8192 files. Each file can be up to 64KB compressed (LZMA)

Arguments

1 string file = "current file"
The name/path to the Lua file that should be sent, relative to the garrysmod/lua folder. If no parameter is specified, it sends the current file.

The file path can be relative to the script it's ran from. For example, if your script is in lua/myfolder/stuff.lua, calling AddCSLuaFile("otherstuff.lua") and AddCSLuaFile("myfolder/otherstuff.lua") is the same thing.

Please make sure your file names are unique, the filesystem is shared across all addons, so a file named lua/config.lua in your addon may be overwritten by the same file in another addon.

Example

Adds the cl_init.lua file in the lua folder to be downloaded by connecting clients. This is required, and is normally done in init.lua.

AddCSLuaFile( "cl_init.lua" )

Example

Adds the current file to the list of files to be downloaded by clients. This is usually done at the top of a shared file.

Example

Allows to send a clientside script when a user joins the server. This kind of code can be found in some addons which load scripts to a custom folder to prevent conflicts between others files.

if SERVER then -- The server doesn't need to run this script through include() because it is intended only for the client unless your using it for a shared file. AddCSLuaFile( "client_script.lua" ) end if CLIENT then -- The client must have received the file, let's run it! include( "client_script.lua" ) end

Example

Specify a base folder and recursively include cl, sh and sv files without having to specify them.

local rootDir = "vac-events" local function AddFile(File, dir) local fileSide = string.lower(string.Left(File , 3)) if SERVER and fileSide == "sv_" then include(dir..File) print("[AUTOLOAD] SV INCLUDE: " .. File) elseif fileSide == "sh_" then if SERVER then AddCSLuaFile(dir..File) print("[AUTOLOAD] SH ADDCS: " .. File) end include(dir..File) print("[AUTOLOAD] SH INCLUDE: " .. File) elseif fileSide == "cl_" then if SERVER then AddCSLuaFile(dir..File) print("[AUTOLOAD] CL ADDCS: " .. File) elseif CLIENT then include(dir..File) print("[AUTOLOAD] CL INCLUDE: " .. File) end end end local function IncludeDir(dir) dir = dir .. "/" local File, Directory = file.Find(dir.."*", "LUA") for k, v in ipairs(File) do if string.EndsWith(v, ".lua") then AddFile(v, dir) end end for k, v in ipairs(Directory) do print("[AUTOLOAD] Directory: " .. v) IncludeDir(dir..v) end end IncludeDir(rootDir)

Special Pages


Wikis

?

Render Time: 55ms

DB GetPage 33
Generate Html 8
SaveChanges (1) 5
Render Body 0
Render Sidebar 6