Difference between revisions of "require"

(Explains require some more)
(Added some info on the module loaders.)
Line 1: Line 1:
Opens and executes a Lua file.  
+
Opens and executes Lua modules.
 +
 
 +
Use periods to seperate folders. If the module is a lua file, don't use the .lua extension in the string passed to require.
  
 
<source lang="lua">
 
<source lang="lua">
require "foo"
+
require("foo")
 +
require("subfolder.bar")
 
</source>
 
</source>
  
'''Note:'''
 
Do not include the ".lua" on the end of the path.
 
  
This function is included on this wiki because LÖVE changes the way it works: it searches in the [[love.filesystem|save directory]] and then in the game directory or the .love.
+
LÖVE adds two loaders (before the Lua loaders) that search for modules in the [[love.filesystem|game and save directory]]. These loaders are not affected by Lua's package.path.
  
 
== See Also ==
 
== See Also ==
[http://www.lua.org/pil/8.1.html Programming in Lua]
+
* [http://www.lua.org/manual/5.1/manual.html#pdf-require require on the Lua manual.]
 +
* [http://www.lua.org/pil/8.1.html Programming in Lua.]

Revision as of 13:50, 10 May 2012

Opens and executes Lua modules.

Use periods to seperate folders. If the module is a lua file, don't use the .lua extension in the string passed to require.

require("foo")
require("subfolder.bar")


LÖVE adds two loaders (before the Lua loaders) that search for modules in the game and save directory. These loaders are not affected by Lua's package.path.

See Also