require

The require API allows importing Lua files from the specified asset key.

Codea Project

For Codea project asset keys, all Lua files except Main.lua are imported by default, including the global variables and functions.

require.option.loadMain can be used to import Main.lua. require.option.noImport can be used to prevent importing global variables and functions.

Single Lua File

For single Lua file asset keys, only the specified file is imported, including its global variables and functions by default.

require.option.noImport can be used to prevent importing global variables and functions.

require

require(assetKey, ...)

Import a single file from the specified asset key.

Parameters:

assetKey (assetKey) – The asset key of the file to import

Returns:

Value returned by the imported file, if any

Return type:

any

require(asset.documents.MyLibrary, require.option.noImport, require.option.loadMain)

myFeature = require(asset.documents.MyOtherLibrary.MyFeature, require.option.noImport)

require(asset.documents.MyOtherLibrary.MyOtherFeature)

class require

option: None

• loadMain - When used with a Codea project, load Main.lua

• noImport - Do not import global variables and functions