Require: Difference between revisions

From GiderosMobile
added see also
mNo edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
'''Available since:''' Gideros 2011.6<br/>
'''Available since:''' Gideros 2011.6<br/>
'''Class:''' [[(global)|(global)]]<br/>
'''Class:''' [[(global)]]<br/>


=== Description ===
=== Description ===
Loads and runs libraries. Roughly, '''require''' does the same job as [[dofile|dofile]], but, '''require''' searches for the file in a path. Because of that, '''require''' is the preferred function in Lua for loading libraries.
Loads and runs libraries.
<source lang="lua">
<syntaxhighlight lang="lua">
require(packagename)
require(packagename)
</source>
</syntaxhighlight>
 
Roughly, '''require''' does the same job as [[dofile]] but '''require''' searches for the file in a path. Because of that, '''require''' is the preferred function in Lua for loading libraries.
 
 
'''Note''': you may need to "''exclude''" the required files from execution


=== Parameters ===
=== Parameters ===
'''packagename''': (string) library to load
'''packagename''': (string) library to load<br/>
 
=== Examples ===
<syntaxhighlight lang="lua">
local relpath = "losc/"
local Types = require(relpath.."types")
local Message = require(relpath.."message")
local Timetag = require(relpath.."timetag")
</syntaxhighlight>


=== See also ===
=== See also ===
[[Loading Order of Lua Files]]
'''[[Loading Order of Lua Files]]'''


{{(global)}}
{{(global)}}

Latest revision as of 23:23, 22 June 2024

Available since: Gideros 2011.6
Class: (global)

Description

Loads and runs libraries.

require(packagename)

Roughly, require does the same job as dofile but require searches for the file in a path. Because of that, require is the preferred function in Lua for loading libraries.


Note: you may need to "exclude" the required files from execution

Parameters

packagename: (string) library to load

Examples

local relpath = "losc/"
local Types = require(relpath.."types")
local Message = require(relpath.."message")
local Timetag = require(relpath.."timetag")

See also

Loading Order of Lua Files