Os.loadAPI - Revision history

Magiczocker at 07:59, 4 August 2020

2020-08-04T07:59:19Z

MKlegoman357: Restored it as it was correct

2015-05-12T19:18:58Z

Restored it as it was correct

Creator: Small inversion removed

2015-05-08T14:10:36Z

Small inversion removed

MKlegoman357: Created the page

2014-06-03T21:04:34Z

Created the page

New page

{{Lowercase}}
{{Function
|name=os.loadAPI
|args={{type|string}} path
|api=OS
|returns={{type|boolean}} did the API load successfully?
|addon=ComputerCraft
|desc=Loads a user created API from a file located at <var>path</var>.
<br/>
This function runs the file, collects all global (non-localized) variables from it and puts them into a [[table_(type)|table]] into the global (<var>_G</var>) environment. The name of the table becomes the name of the file.
|examples={{Example
|desc=Loads an API saved at "''test/myAPI''" and runs the global function "''hello''" from it.
|code='''''--test/myAPI:'''''

local text = "Hello World!" ''-- this won't be seen from outside of the API because it is localized''

function hello () ''-- this will be seen from outside the API because it is '''not''' localized''
[[print]](text)
end

'''''--The program that will use "myAPI"'''''

'''os.loadAPI("test/myAPI")''' ''-- load the API''

myAPI.hello() ''-- runs the function "hello" from the API''
|output=Hello World!
}}
|notes=
* <var>path</var> '''must''' be an absolute path.
* All variables which will be needed to be accessed through ''<apiname>.<variable/function>'' '''must''' be global.
* By default APIs '''cannot''' access [[shell_(API)|shell API]] and [[multishell_(API)|multishell API]].
}}

← Older revision		Revision as of 07:59, 4 August 2020
Line 31:		Line 31:
	* By default APIs '''cannot''' access [[shell_(API)\|shell API]] and [[multishell_(API)\|multishell API]].		* By default APIs '''cannot''' access [[shell_(API)\|shell API]] and [[multishell_(API)\|multishell API]].
	}}		}}
		+	[[Category:API Functions]]

@@ Line 8: / Line 8: @@
 |desc=Loads a user created API from a file located at <var>path</var>.
 <br/>
-This function runs the file, collects all global (non-localized) variables from it and puts them into a [[table_(type)|table]] into the global (<var>_G</var>) environment. The name of the file becomes the name of the table.
+This function runs the file, collects all global (non-localized) variables from it and puts them into a [[table_(type)|table]] into the global (<var>_G</var>) environment. The name of the table in the _G table becomes the name of the file.
 |examples={{Example
   |desc=Loads an API saved at "''test/myAPI''" and runs the global function "''hello''" from it.