Global/AddCSLuaFile

From Garry's Mod
(Difference between revisions)
Jump to: navigation, search
(Created page with "{{Function | Name = AddCSLuaFile | Namespace = Global | Realm = Server }} {{Syntax | Name = AddCSLuaFile | Description = Adds a Lua file to the list for clients to down...")
 
m (Removed extra newline)
 
(24 intermediate revisions by 16 users not shown)
Line 1: Line 1:
{{Function
+
{{Func
| Name = AddCSLuaFile
+
|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.
| Namespace = Global
+
| Realm = Server
+
}}
+
  
{{Syntax
+
{{Warning|If the file trying to be added is empty, an error will occur, and the file will not be sent to the client.}}
  
| Name = AddCSLuaFile
+
{{Note|This function is not needed for scripts located in '''lua/autorun/''' and '''lua/autorun/client/''': they are automatically sent to clients.}}
| Description = Adds a Lua file to the list for clients to download when they join the server.
+
{{Note|You can add up to 8192 files.}}
| Returns =
+
|Realm=Shared
| Arg1Name = file
+
|IsClass=No
| Arg1Type = String
+
| Arg1Req = true
+
| Arg1Desc = The name/path (relative from the lua folder) to the Lua file that should be included.
+
 
}}
 
}}
 +
{{Arg
 +
|type=string
 +
|name=file
 +
|desc=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.
  
==Examples==
+
The file path can be relative to the script it is ran from. For example, if your script is in lua/myfolder/stuff.lua, calling {{GlobalFunction|AddCSLuaFile}}("otherstuff.lua") and {{GlobalFunction|AddCSLuaFile}}("myfolder/otherstuff.lua") is the same thing.
 +
|default=current file
 +
}}
 +
{{Example
 +
|Description=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.
 +
|Code=AddCSLuaFile( "cl_init.lua" )
 +
}}
 
{{Example
 
{{Example
| Description = Adds the cl_init.lua file in the "lua" folder to be downloaded by connecting clients.
+
|Description=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.
| Code = AddCSLuaFile( "cl_init.lua" )
+
|Code=AddCSLuaFile()
| Output =
+
 
}}
 
}}

Latest revision as of 23:01, 22 April 2019

 AddCSLuaFile( )

Contents

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.

WARNING

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

NOTE

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

NOTE

You can add up to 8192 files.

Arguments

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 is 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.

Examples

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" )


Examples

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.

AddCSLuaFile()


Personal tools
Navigation