Difference between revisions of "Require"
From GiderosMobile
m |
|||
(16 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)]]<br/> | ||
+ | |||
=== Description === | === Description === | ||
− | Loads and runs libraries. Roughly, | + | Loads and runs libraries. |
− | + | <syntaxhighlight lang="lua"> | |
− | + | require(packagename) | |
− | + | </syntaxhighlight> | |
− | '''packagename''': (string) library to load '''''' | + | |
+ | 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<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 === | ||
+ | '''[[Loading Order of Lua Files]]''' | ||
+ | |||
+ | {{(global)}} |
Latest revision as of 00:23, 23 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