Overview of the API - Revision history

Adriweb at 20:28, 8 November 2014

2014-11-08T20:28:31Z

Technolapin: /* Standard Library */

2014-11-08T19:40:37Z

Standard Library

Technolapin: /* Coroutines Library */

2014-11-08T19:40:01Z

Coroutines Library

Technolapin: /* Coroutines Library */

2014-11-08T19:39:11Z

Coroutines Library

Technolapin: /* Standard Library */

2014-11-08T19:38:40Z

Standard Library

Adriweb: /* Events */

2014-05-07T19:41:36Z

Events

Adriweb: /* Graphics Operations */

2014-05-07T19:39:38Z

Graphics Operations

Adriweb: Rewrote

2014-05-07T19:36:01Z

Rewrote

Show changes

Adriweb: /* Concepts and Basics */

2014-05-07T01:08:27Z

Concepts and Basics

Jonius7: /* Events */

2013-06-30T06:02:40Z

Events

@@ Line 28: / Line 28: @@
 === Coroutines Library ===
-The coroutines are usefull tools to control the running of differents parts of a code.
+The coroutines are useful tools to control the running of differents parts of a code ("threads").
 create, wrap, resume, yield, status, running

@@ Line 32: / Line 32: @@
 create, wrap, resume, yield, status, running
-More information can be fouded in the coroutine page.
+More information can be fouded in the [[coroutines]] page.
 === String Library ===

@@ Line 30: / Line 30: @@
 The coroutines are usefull tools to control the running of differents parts of a code.
-create, wrap, resume, yield, status, running
+More information can be fouded in the coroutine page.
 === String Library ===

@@ Line 29: / Line 29: @@
 === Coroutines Library ===
 The coroutines are usefull tools to control the running of differents parts of a code.
 create, wrap, resume, yield, status, running
 === String Library ===
 byte, char, dump, find, format, gmatch, gsub, len, lower, match, rep, reverse, sub, upper

@@ Line 27: / Line 27: @@
 *'''[[xpcall]]'''(func, err) - Returns a boolean indicating successful execution of func and calls err on failure, additionally returning func's or err's results.
 === String Library ===
 byte, char, dump, find, format, gmatch, gsub, len, lower, match, rep, reverse, sub, upper

@@ Line 108: / Line 108: @@
 *'''[[on.save]]''' is called when the script app is saved to the document or copied to the clipboard.
 *'''[[on.restore]]''' is called when the script application is restored from its saved state in a document or when the app is pasted into a document..
 *'''[[on.cut]]'''  is called when the user cuts something.
 *'''[[on.copy]]''' is called when the user copies something.

@@ Line 130: / Line 130: @@
 *'''[[gc:getStringHeight]]'''(string) - Returns the string's height.
 *'''[[gc:getStringWidth]]'''(string) - Returns the string's width
-*'''[[gc:setAlpha]]'''(alpha) - where alpha is an integer between 0 and 255. Sets the transparency. ''Not available anymore''
+*'''[[gc:setAlpha]]'''(alpha) - where alpha is an integer between 0 and 255. Sets the transparency. '''''Not available anymore in 3.2+'''''
 *'''[[gc:setColorRGB]]'''(red, green, blue) RGB values are integers, from 0 to 255.
 *'''[[gc:setFont]]'''(font, type, size), with font : {“sansserif”, "serif", ..}, type {“b”, “r”, “i”}, size(int)

@@ Line 73: / Line 73: @@
 Note : the (N) commented line only indicates the meaning of the routine. Those functions don't really exist.</source>
-Now we can understand how everything is linked, just by a main loop. This helps you to understand that you don't have to code a loop yourself, because the screen wouldn't be refreshed. This also helps to see when the screen gets refreshed. In other words, we cannot use niether '''gc''' nor '''platform.gc()''' (which are the same) in order to draw somthing on the screen if we are outside of '''on.paint()''' (except if your outside function is called within on.paint() ). This also means that we don't need to pass '''gc''' as parameter, because we can rather use '''platform.gc()''' for any functions called within on.paint(). This is exactly what [https://github.com/adriweb/BetterLuaAPI-for-TI-Nspire/blob/master/BetterLuaAPI.lua the BetterLuaAPI library for Nspire] does.
+Now we can understand how everything is linked, just by a main loop. This helps you to understand that you don't have to code a loop yourself, because the screen wouldn't be refreshed. This also helps to see when the screen gets refreshed.
 Here is an example of a simple Lua program that displays a message only when a key is pressed (and let the screen blank otherwise).
@@ Line 94: / Line 94: @@
   	platform.window:invalidate()		-- force display
   end</source>
 When you open the document, the script is read once. It initializes and overwrites all the functions and globals with the ones you defined. Thus, '''message''' is nil. Once the '''on.paint()''' event is called, '''message''' is nil, thus, nothing is done. When you press a key that calls '''on.charIn()''' (see below for more information), '''message''' is now "Hello World" and we tell the '''platform''' that the screen has to be refreshed. Then, '''on.paint()''' is called again, '''message''' is not nil then we display it, erase '''message''' and launch a timer. Why is that&nbsp;? Because if we call '''platform.window:invalidate()''' right there, we won't refresh the screen. Why again&nbsp;? Just look at the pseudo-code above. We set the window as drawn after each call of on.paint(). Thus a timer is necessary to manually recall '''on.paint()''' and exit the '''on.paint()''' function to draw the screen. When the timer is ended, '''on.timer()''' is called and we refresh the screen. The screen is then redrawn but there is nothing to draw because '''message''' is nil. Thus, the graphic context lets the screen blank.
 == gc (as in Graphics Context)  ==

@@ Line 188: / Line 188: @@
 == Events  ==
-*'''[[on.create]]''' function called when script application is created. Removed in OS 3.2 (API v2.0)
+*'''[[on.create]]'''() function called when script application is created. Removed in OS 3.2 (API v2.0)
-*'''[[on.construction]]''' function that is guaranteed to run first before any other function. New in OS 3.2 (API v2.0)
+*'''[[on.construction]]'''() function that is guaranteed to run first before any other function. New in OS 3.2 (API v2.0)
 *'''[[on.paint]]'''(gc) is called when the GUI is painted. 'gc' is the Graphics Context (see above)
 *'''[[on.resize]]'''() is called when the window is rezised