os.loadAPI

Globally loads a user created program as a table of functions, using the name of the file as the reference to put the table under.

ExampleLoading a user created API

Loads an API from a file called myAPI.lua in the base directory. All functions in the 'myAPI.lua' API will be accessible through the use of myAPI.<function name>

Code

isLoaded = os.loadAPI("/myAPI.lua")
if isLoaded then
  print("myAPI is ready to use!")
end

Output

myAPI is ready to use!

Functions

Lua

Base globals	assert dofile error getmetatable load loadfile loadstring next package pairs pcall print rawequal rawget rawset select setmetatable tonumber tostring type xpcall
Bit32 API	bit32.arshift bit32.band bit32.bnot bit32.bor bit32.btest bit32.bxor bit32.extract bit32.lrotate bit32.lshift bit32.replace bit32.rrotate bit32.rshift
Coroutine API	coroutine.create coroutine.resume coroutine.running coroutine.status coroutine.wrap coroutine.yield
Debug API	debug.debug debug.getfenv debug.gethook debug.getinfo debug.getlocal debug.getmetatable debug.getregistry debug.getupvalue debug.setfenv debug.sethook debug.setlocal debug.setmetatable debug.setupvalue debug.traceback
Math API	math.abs math.acos math.asin math.atan math.atan2 math.ceil math.cos math.cosh math.deg math.exp math.floor math.frexp math.ldexp math.log math.log10 math.max math.min math.mod math.modf math.pow math.rad math.random math.randomseed math.sin math.sinh math.sqrt math.tan math.tanh
String API	string.byte string.char string.dump string.find string.format string.gmatch string.gsub string.len string.lower string.match string.rep string.reverse string.sub string.upper
Table API	table.concat table.foreach table.getn table.insert table.pack table.remove table.sort

CC:Tweaked

BIOS globals	print printError read sleep write
Shell globals	require
Term objects	term.blit term.clear term.clearLine term.getBackgroundColour term.getCursorBlink term.getCursorPos term.getPaletteColour term.getSize term.getTextColour term.isColour term.scroll term.setBackgroundColour term.setCursorBlink term.setCursorPos term.setPaletteColour term.setTextColour term.write
Input handles	handle.close handle.read handle.readAll handle.readLine
Output handles	handle.close handle.flush handle.write handle.writeLine
HTTP handles	handle.getResponseCode handle.getResponseHeaders
Websocket handles	websocket.close websocket.receive websocket.send
Colours API	colours.subtract colours.combine colours.test colours.rgb8
Commands API	commands.exec commands.execAsync commands.getBlockInfo commands.getBlockInfos commands.getBlockPosition commands.list
Disk API	disk.eject disk.getAudioTitle disk.getID disk.getLabel disk.getMountPath disk.hasAudio disk.hasData disk.isPresent disk.playAudio disk.setLabel disk.stopAudio
FS API	fs.attributes fs.combine fs.complete fs.copy fs.delete fs.exists fs.find fs.getCapacity fs.getDir fs.getDrive fs.getFreeSpace fs.getName fs.getSize fs.isDir fs.isReadOnly fs.list fs.makeDir fs.move fs.open
GPS API	gps.locate
Help API	help.completeTopic help.lookup help.path help.setPath help.topics
HTTP API	http.checkURL http.checkURLAsync http.get http.post http.request http.websocket http.websocketAsync
IO API	io.close io.flush io.input io.lines io.open io.output io.read io.type io.write
Monitor API	monitor.getTextScale monitor.setTextScale
OS API	os.cancelAlarm os.cancelTimer os.clock os.date os.day os.epoch os.getComputerID os.getComputerLabel os.loadAPI os.pullEvent os.pullEventRaw os.queueEvent os.reboot os.run os.setAlarm os.setComputerLabel os.shutdown os.sleep os.startTimer os.time os.unloadAPI os.version
Paintutils API	paintutils.drawBox paintutils.drawFilledBox paintutils.drawImage paintutils.drawLine paintutils.drawPixel paintutils.loadImage paintutils.parseImage
Parallel API	parallel.waitForAll parallel.waitForAny
Peripheral API	peripheral.call peripheral.find peripheral.getMethods peripheral.getNames peripheral.getType peripheral.isPresent peripheral.wrap
Rednet API	rednet.broadcast rednet.close rednet.host rednet.isOpen rednet.lookup rednet.open rednet.receive rednet.send rednet.unhost
Redstone API	redstone.getAnalogInput redstone.getAnalogOutput redstone.getAnalogueInput redstone.getAnalogueOutput redstone.getBundledInput redstone.getBundledOutput redstone.getInput redstone.getOutput redstone.getSides redstone.setAnalogOutput redstone.setAnalogueOutput redstone.setBundledOutput redstone.setOutput redstone.testBundledInput
Keys API	keys.getName
Settings API	settings.clear settings.copy settings.get settings.getNames settings.load settings.save settings.set settings.unset
Shell API	shell.aliases shell.clearAlias shell.complete shell.completeProgram shell.dir shell.exit shell.getCompletionInfo shell.getRunningProgram shell.openTab shell.path shell.programs shell.resolve shell.resolveProgram shell.run shell.setAlias shell.setCompletionFunction shell.setDir shell.setPath shell.switchTab
Multishell API	multishell.getCurrent multishell.getCount multishell.getFocus multishell.getTitle multishell.launch multishell.setFocus multishell.setTitle
Term API	term.current term.native term.redirect
Textutils API	textutils.complete textutils.formatTime textutils.pagedPrint textutils.pagedTabulate textutils.serialise textutils.serialiseJSON textutils.slowPrint textutils.slowWrite textutils.tabulate textutils.unserialise textutils.urlEncode
Turtle API	turtle.attack turtle.attackDown turtle.attackUp turtle.back turtle.compare turtle.compareDown turtle.compareTo turtle.compareUp turtle.craft turtle.detect turtle.detectDown turtle.detectUp turtle.dig turtle.digDown turtle.digUp turtle.down turtle.drop turtle.dropDown turtle.dropUp turtle.equipLeft turtle.equipRight turtle.forward turtle.getFuelLevel turtle.getFuelLimit turtle.getItemCount turtle.getItemDetail turtle.getItemSpace turtle.getSelectedSlot turtle.inspect turtle.inspectDown turtle.inspectUp turtle.place turtle.placeDown turtle.placeUp turtle.refuel turtle.select turtle.suck turtle.suckDown turtle.suckUp turtle.transferTo turtle.turnLeft turtle.turnRight turtle.up
Pocket API	pocket.equipBack pocket.unequipBack
Vector API	vector.add vector.cross vector.div vector.dot vector.length vector.mul vector.new vector.normalize vector.round vector.sub vector.tostring vector.unm
Window API	window.create window.getPosition window.redraw window.reposition window.restoreCursor window.setVisible
Printer API	printer.endPage printer.getCursorPos printer.getInkLevel printer.getPageSize printer.getPaperLevel printer.newPage printer.setCursorPos printer.setPageTitle printer.write
Modem API	modem.close modem.closeAll modem.isOpen modem.isWireless modem.open modem.transmit
Diskdrive API	diskdrive.ejectDisk diskdrive.getAudioTitle diskdrive.getDiskID diskdrive.getDiskLabel diskdrive.getMountPath diskdrive.hasAudio diskdrive.hasData diskdrive.isDiskPresent diskdrive.playAudio diskdrive.setDiskLabel diskdrive.stopAudio
Commandblock API	commandblock.getCommand commandblock.runCommand commandblock.setCommand
Computer API	computer.getID computer.getLabel computer.isOn computer.reboot computer.shutdown computer.turnOn
Speaker API	speaker.playNote speaker.playSound

os.loadAPI Function
Syntax os.loadAPI( path : string )
Returns	boolean
API	os
Source	CC:Tweaked

This function is deprecated. Use of this function will pollute the global table, use require instead.

This article is issued from Computercraft. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.