935
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − − − + − + − + − + − + − + − + − + − + − while(Exit)+ − ------- Some OS routines here − − ---- Begin of Event link − buffer:captureDataFromKeyPad() -- (N) some underground routines to catch events − if buffer.charInput ~= "" then -- (N) − on.charIn(buffer.charInput) − buffer.charInput= "" -- (N) − end − if buffer.arrowKey ~= "" then -- (N) − on.arrowKey(buffer.arrowKey) − buffer.arrowKey = "" -- (N) − end − ----- etc ... − if platform.window.isInvalidate then − platform.gc():purge() -- (N) Empty buffer before starting to draw − on.paint(platform.gc()) -- save all the things we have to draw − platform:paint() -- (N) draw all those things − platform.window.isInvalidate = false -- say that the window has been drawn − end − ----- End of Event link − end − − + − 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.+ + + − 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).+ − <syntaxhighlight lang="lua"> − function on.paint(gc) − if message then − gc:setFont("sansserif", "r", 10) -- initialize font drawing − gc:drawString(message, 0, 0, "top") -- display the message at (0, 0) coordinates − message = nil -- erase the message − timer.start(1) -- start a timer to exit on.paint() but keep in mind that we have to redraw the screen − end − end − − function on.timer() − timer.stop() − platform.window:invalidate() − end − − function on.charIn(ch) − message = "Hello World !" -- store a message − platform.window:invalidate() -- force display − end − </syntaxhighlight> − 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 ? Because if we call '''platform.window:invalidate()''' right there, we won't refresh the screen. Why again ? 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)==+ − Note: You need to add “gc:” before each of these commands in order to use them. ex. '''gc:setAlpha(...)'''.+ − You can also call gc like this : '''platform.gc():setAlpha(...)'''. Then you can use the gc library in a function where gc is not passed as an argument. but this function *has* to be called within '''on.paint(gc)''' − The maximum screen resolution available to Lua programs is 318 by 212 pixels.+ + + + + + + + + + + + − *'''[[gc:begin]]''' -+ − *'''[[gc:clipRect]]''' - − *'''[[gc:drawArc]]'''(x, y, width, height, start angle, finish angle) Note, to draw a circle, use drawArc(x - diameter/2, y - diameter/2, diameter,diameter,0,360) where x and y are the coordinates of the middle. − *'''[[gc:drawImage]]'''(image,x,y) First argument in format “[[TI.Image]]”, x and y the coords. − *'''[[gc:drawLine]]'''(xstart, ystart, xend, yend) Draws a line starting at the point (xstart,ystart) and ending at the point (xend, yend) − *'''[[gc:drawPolyLine]]'''(int list1 [,int list2, .., int listN]) Draws a shape from a list contaning successively the x and y coordinates of each point the line have to draw. − For example − <syntaxhighlight lang="lua"> − drawPolyLine({0,0, 0,100, 100,100, 100,0, 0,0}) − </syntaxhighlight> − and − <syntaxhighlight lang="lua"> − drawRect(0,0,100,100) − </syntaxhighlight> − do the same. If there are multiple argument (which can be 4 elements list to represent lines), each list has to contain an even number of element. − − + − + − + − + − + − + − + − + − + − + − + Line 137:
Line 89: − + − + − + − + − + + + + + + + + + + + + + + + − + − *'''[[markChanged]]'''() - Flag the document as "changed" so the user has to save it after using it. − ==clipboard==+ − + − + + − + − *'''[[name]]'''() - Returns the current language the calculator is set in, formatted as ISO-639 (i.e : "fr", "en", "it" ...). − ==image==+ − + − *'''[[copy]]'''(image, width, height) - returns a new Image which has a new scale. Width is the final width, Heigth, the final height of the image.+ − To make a relative scale, use '''image.copy'''(image, scaleX * '''image.width'''(image), scaleY * '''image.height'''(image)) − − *'''[[new]]'''(string) - Creates a new image from the string given in parameter (see TI.Image). Call it with <tt>img = image.new("...")</tt> − − + − *'''[[getMilliSecCounter]]'''() - Returns the amount of milliseconds elapsed since last calculator reboot. (in TI's Computer software, returns an absolute negative time) − *'''[[start]]'''(int) - Starts a timer with 1 second. − *'''[[stop]]'''() - Stops a timer − ==toolpalette==+ − + − + − + − + − − + − *'''[[list]]'''() - returns a list of all the variables in the entire Activity − *'''[[monitor]]'''() - ? − *'''[[recall]]'''(string) - returns the variable value which name is given in parameter − *'''[[recallstr]]'''(string) - returns the variable value converted to string which name is given in parameter − *'''[[store]]'''(string, value) - store in the variable, which name is given in parameter, the value − *'''[[unmonitor]]'''() - ? − ==Events==+ + + + + + − + − + − + − + − x = 1+ − animating = false+ − function on.paint(gc) − gc:setFont("sansserif", "r", 10) − gc:drawString(tostring(x), 0, 0, "top") − if animating then − x = x + 1 − timer.start(0.5) − end − end − − function on.charIn(ch) − animating = not animating -- switch state − platform.window:invalidate() -- recall graph engine − end − − function on.timer() − timer.stop() − platform.window:invalidate() -- recall graph engine − end − − + − + − + − + + + − + + + − + − + − + − + − + − + − + − + − + + − + − + − c = "" − function on.charIn(ch) − c = ch − platform.window:invalidate() -- we force the screen draw − end − function on.paint(gc) − gc:setFont(“sansserif”, "r", 10) − gc:drawString(c, 0, 0, "top") − end − − + + + − + − + + + − + + − + − + − + − + − + − + + − + − + − + − + − + − + + + − + − + − + − + − + − + − + − + − + − + − function createRichTextBox+ − box = D2Editor.newRichText()+ − box:move(50, 50)+ − box:resize(50, 50)+ − box:setText("Hello World !")+ − end − − + − An interesting page about LUA code optimization, that can be really useful, especially for calculators : [http://trac.caspring.org/wiki/LuaPerformance Lua Performance] − ==Online Demo==
no edit summary
Note: Neither the ''io'' nor ''os'' libraries are present for the TI-Nspire, which seems to be running a light version of Lua 5.1.4.
Note: Neither the ''io'' nor ''os'' libraries are present for the TI-Nspire, which seems to be running a light version of Lua 5.1.4.
==Standard Library==
== Standard Library ==
( This has been taken from [http://www.wowwiki.com/Lua_functions a WoWWiki page] - See the full, official documentation [http://www.lua.org/manual/5.1/manual.html here] )
( This has been taken from [http://www.wowwiki.com/Lua_functions a WoWWiki page] - See the full, official documentation [http://www.lua.org/manual/5.1/manual.html here] )
*'''[[_G]]''' - Global Variable - A global variable (not a function) that holds the global environment (that is, _G._G = _G). Lua itself does not use this variable; changing its value does not affect any environment, nor vice-versa. (Use setfenv to change environments.) - taken from Lua docs
*'''[[G]]''' - Global Variable - A global variable (not a function) that holds the global environment (that is, _G._G = _G). Lua itself does not use this variable; changing its value does not affect any environment, nor vice-versa. (Use setfenv to change environments.) - taken from Lua docs
*'''[[assert]]'''(value[, errormsg]) - asserts a value evaluates to true. If it is, returns value, otherwise causes a Lua error to be thrown.
*'''[[assert]]'''(value[, errormsg]) - asserts a value evaluates to true. If it is, returns value, otherwise causes a Lua error to be thrown.
*'''[[getfenv]]'''(function or integer) - Returns the table representing the stack frame of the given function or stack level.
*'''[[getfenv]]'''(function or integer) - Returns the table representing the stack frame of the given function or stack level.
*'''[[getmetatable]]'''(obj, mtable) - Returns the metatable of the given table or userdata object.
*'''[[getmetatable]]'''(obj, mtable) - Returns the metatable of the given table or userdata object.
*'''[[next]]'''(table, index) - Returns the next key, value pair of the table, allowing you to walk over the table.
*'''[[next]]'''(table, index) - Returns the next key, value pair of the table, allowing you to walk over the table.
*'''[[newproxy]]'''(boolean or proxy) - Creates a userdata with a sharable metatable.
*'''[[newproxy]]'''(boolean or proxy) - Creates a userdata with a sharable metatable.
*'''[[print]]''' - print (···) - Receives any number of arguments, and prints their values to stdout, using the tostring function to convert them to strings. print is not intended for formatted output, but only as a quick way to show a value, typically for debugging. For formatted output, use string.format. - taken from Lua Docs
*'''[[print]]''' - print (···) - Receives any number of arguments, and prints their values to stdout, using the tostring function to convert them to strings. print is not intended for formatted output, but only as a quick way to show a value, typically for debugging. For formatted output, use string.format. - taken from Lua Docs
*'''[[select]]'''(index, list) - Returns the number of items in list or the value of the item in list at index.
*'''[[select]]'''(index, list) - Returns the number of items in list or the value of the item in list at index.
*'''[[setfenv]]'''(function or integer, table) - Sets the table representing the stack frame of the given function or stack level.
*'''[[setfenv]]'''(function or integer, table) - Sets the table representing the stack frame of the given function or stack level.
*'''[[setmetatable]]'''(obj, mtable) - Sets the metatable of the given table or userdata object.
*'''[[setmetatable]]'''(obj, mtable) - Sets the metatable of the given table or userdata object.
*'''[[tostring]]''' - tostring (e) - Receives an argument of any type and converts it to a string in a reasonable format. For complete control of how numbers are converted, use string.format. If the metatable of e has a "__tostring" field, then tostring calls the corresponding value with e as argument, and uses the result of the call as its result. - taken from Lua Docs.
*'''[[tostring]]''' - tostring (e) - Receives an argument of any type and converts it to a string in a reasonable format. For complete control of how numbers are converted, use string.format. If the metatable of e has a "__tostring" field, then tostring calls the corresponding value with e as argument, and uses the result of the call as its result. - taken from Lua Docs.
*'''[[type]]'''(var) - Returns the type of variable as a string, "number", "string", "table", "function" or "userdata".
*'''[[type]]'''(var) - Returns the type of variable as a string, "number", "string", "table", "function" or "userdata".
*'''[[unpack]]'''(table[, start][, end]) - Returns the contents of its argument as separate values.
*'''[[unpack]]'''(table[, start][, end]) - Returns the contents of its argument as separate values.
*'''[[xpcall]]'''(func, err) - Returns a boolean indicating successful execution of func and calls err on failure, additionally returning func's or err's results.
*'''[[xpcall]]'''(func, err) - Returns a boolean indicating successful execution of func and calls err on failure, additionally returning func's or err's results.
==Concepts and Basics==
== Concepts and Basics ==
This part will explain you how the Lua actually works inside the OS and help you to figure out what you're doing when you write a script for the TI-Nspire. Before reading this, you have to know all about the Lua basics.
This part will explain you how the Lua actually works inside the OS and help you to figure out what you're doing when you write a script for the TI-Nspire. Before reading this, you have to know all about the Lua basics.
The Lua is an interpreted script language which means that it isn't as fast as ASM/C programs, but is still better than the TI-BASIC.
The Lua is an interpreted script language which means that it isn't as fast as ASM/C programs, but is still better than the TI-BASIC. One good thing is that this language is in a complete harmony with the OS with basic events and a powerfull graphic context. First, we have to understand how this works. Basicly the script is launched before the executive engine. This means that we can neither evaluate expressions nor use some of the standard API (like platform, var) until the engine is launched. Here is a call summary :
One good thing is that this language is in a complete harmony with the OS with basic events and a powerfull graphic context.
First, we have to understand how this works. Basicly the script is launched before the executive engine. This means that we can neither evaluate expressions nor use some of the standard API (like platform, var) until the engine is launched. Here is a call summary :
*Launch string library
*Launch string library
*Launch math library
*Launch math library
* ...
*...
*Open and launch User's Lua script
*Open and launch User's Lua script
*...
*...
*Launch var API (store, recall, ...)
*Launch var API (store, recall, ...)
*Launch platform API (window, gc, ...)
*Launch platform API (window, gc, ...)
*...
*...
*Link events (pseudo code)
*Link events (pseudo code)
<syntaxhighlight lang="lua">
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="lua source-lua"><pre class="de1"> <span class="kw1">while</span><span class="br0">(</span>Exit<span class="br0">)</span> <span class="co1">------- Some OS routines here</span> <span class="co1">---- Begin of Event link</span> buffer:captureDataFromKeyPad<span class="br0">(</span><span class="br0">)</span> <span class="co1">-- (N) some underground routines to catch events</span> <span class="kw1">if</span> buffer.charInput ~<span class="sy0">=</span> <span class="st0">""</span> <span class="kw1">then</span> <span class="co1">-- (N)</span> <span class="kw3">on.charIn</span><span class="br0">(</span>buffer.charInput<span class="br0">)</span> buffer.charInput<span class="sy0">=</span> <span class="st0">""</span> <span class="co1">-- (N)</span> <span class="kw1">end</span> <span class="kw1">if</span> buffer.arrowKey ~<span class="sy0">=</span> <span class="st0">""</span> <span class="kw1">then</span> <span class="co1">-- (N)</span> <span class="kw3">on.arrowKey</span><span class="br0">(</span>buffer.arrowKey<span class="br0">)</span> buffer.arrowKey <span class="sy0">=</span> <span class="st0">""</span> <span class="co1">-- (N)</span> <span class="kw1">end</span> <span class="co1">----- etc ... </span> <span class="kw1">if</span> platform.window.isInvalidate <span class="kw1">then</span> platform.gc<span class="br0">(</span><span class="br0">)</span>:purge<span class="br0">(</span><span class="br0">)</span> <span class="co1">-- (N) Empty buffer before starting to draw</span> <span class="kw3">on.paint</span><span class="br0">(</span>platform.gc<span class="br0">(</span><span class="br0">)</span><span class="br0">)</span> <span class="co1">-- save all the things we have to draw</span> platform:paint<span class="br0">(</span><span class="br0">)</span> <span class="co1">-- (N) draw all those things</span> platform.window.isInvalidate <span class="sy0">=</span> <span class="kw1">false</span> <span class="co1">-- say that the window has been drawn</span> <span class="kw1">end</span> <span class="co1">----- End of Event link</span> <span class="kw1">end</span></pre></div></div>
''Note : the (N) commented line only indicates the meaning of the routine. Those functions don't really exist.''
</syntaxhighlight>
''Note : the (N) commented line only indicates the meaning of the routine. Those functions don't really exist.''
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.
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).
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="lua source-lua"><pre class="de1"> <span class="kw1">function</span> <span class="kw3">on.paint</span><span class="br0">(</span>gc<span class="br0">)</span> <span class="kw1">if</span> message <span class="kw1">then</span> <span class="kw2">gc:setFont</span><span class="br0">(</span><span class="st0">"sansserif"</span>, <span class="st0">"r"</span>, <span class="nu0">10</span><span class="br0">)</span> <span class="co1">-- initialize font drawing</span> <span class="kw2">gc:drawString</span><span class="br0">(</span>message, <span class="nu0">0</span>, <span class="nu0">0</span>, <span class="st0">"top"</span><span class="br0">)</span> <span class="co1">-- display the message at (0, 0) coordinates</span> message <span class="sy0">=</span> <span class="kw1">nil</span> <span class="co1">-- erase the message</span> <span class="kw2">timer.start</span><span class="br0">(</span><span class="nu0">1</span><span class="br0">)</span> <span class="co1">-- start a timer to exit on.paint() but keep in mind that we have to redraw the screen</span> <span class="kw1">end</span> <span class="kw1">end</span> <span class="kw1">function</span> <span class="kw3">on.timer</span><span class="br0">(</span><span class="br0">)</span> <span class="kw2">timer.stop</span><span class="br0">(</span><span class="br0">)</span> <span class="kw2">platform.window:invalidate<span class="br0">(</span><span class="br0">)</span></span> <span class="kw1">end</span> <span class="kw1">function</span> <span class="kw3">on.charIn</span><span class="br0">(</span>ch<span class="br0">)</span> message <span class="sy0">=</span> <span class="st0">"Hello World !"</span> <span class="co1">-- store a message</span> <span class="kw2">platform.window:invalidate<span class="br0">(</span><span class="br0">)</span></span> <span class="co1">-- force display</span> <span class="kw1">end</span></pre></div></div>
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 ? Because if we call '''platform.window:invalidate()''' right there, we won't refresh the screen. Why again ? 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) ==
Note: You need to add “gc:” before each of these commands in order to use them. ex. '''gc:setAlpha(...)'''. You can also call gc like this : '''platform.gc():setAlpha(...)'''. Then you can use the gc library in a function where gc is not passed as an argument. but this function *has* to be called within '''on.paint(gc)'''
The maximum screen resolution available to Lua programs is 318 by 212 pixels.
*'''[[gc:begin]]''' -
*'''[[gc:clipRect]]''' -
*'''[[gc:drawArc]]'''(x, y, width, height, start angle, finish angle) Note, to draw a circle, use drawArc(x - diameter/2, y - diameter/2, diameter,diameter,0,360) where x and y are the coordinates of the middle.
*'''[[gc:drawImage]]'''(image,x,y) First argument in format “[[TI.Image]]”, x and y the coords.
*'''[[gc:drawLine]]'''(xstart, ystart, xend, yend) Draws a line starting at the point (xstart,ystart) and ending at the point (xend, yend)
*'''[[gc:drawPolyLine]]'''(int list1 [,int list2, .., int listN]) Draws a shape from a list contaning successively the x and y coordinates of each point the line have to draw.
For example
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="lua source-lua"><pre class="de1"> drawPolyLine<span class="br0">(</span><span class="br0">{</span><span class="nu0">0</span>,<span class="nu0">0</span>, <span class="nu0">0</span>,<span class="nu0">100</span>, <span class="nu0">100</span>,<span class="nu0">100</span>, <span class="nu0">100</span>,<span class="nu0">0</span>, <span class="nu0">0</span>,<span class="nu0">0</span><span class="br0">}</span><span class="br0">)</span></pre></div></div>
and
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="lua source-lua"><pre class="de1"> drawRect<span class="br0">(</span><span class="nu0">0</span>,<span class="nu0">0</span>,<span class="nu0">100</span>,<span class="nu0">100</span><span class="br0">)</span></pre></div></div>
do the same. If there are multiple argument (which can be 4 elements list to represent lines), each list has to contain an even number of element.
*'''[[gc:drawRect]]'''(x, y, xwidth, yheight) Draws a rectangle at (x,y) with the “x” side being “xwidth” long and the “y” side being “yheight” long
*'''[[gc:drawRect]]'''(x, y, xwidth, yheight) Draws a rectangle at (x,y) with the “x” side being “xwidth” long and the “y” side being “yheight” long
*'''[[gc:drawString]]'''(string, x, y, PositionString) PositionString is the string’s anchor point and can be “bottom”, “middle”, or “top”.
*'''[[gc:drawString]]'''(string, x, y, PositionString) PositionString is the string’s anchor point and can be “bottom”, “middle”, or “top”.
*'''[[gc:fillArc]]'''(x, y, width, height, start angle, finish angle) see drawArc
*'''[[gc:fillArc]]'''(x, y, width, height, start angle, finish angle) see drawArc
*'''[[gc:fillPolygon]]'''(int list1 [,int list2, .., int listN]) see drawPolyLine
*'''[[gc:fillPolygon]]'''(int list1 [,int list2, .., int listN]) see drawPolyLine
*'''[[gc:fillRect]]'''(x, y, width, height) see drawRect
*'''[[gc:fillRect]]'''(x, y, width, height) see drawRect
*'''[[gc:finish]]''' -
*'''[[gc:finish]]''' -
*'''[[gc:getStringHeight]]'''(string)
*'''[[gc:getStringHeight]]'''(string)
*'''[[gc:getStringWidth]]'''(string)
*'''[[gc:getStringWidth]]'''(string)
*'''[[gc:isColorDisplay]]''' Bool (Read-only) Returns 1 if color, 0 if not.
*'''[[gc:isColorDisplay]]''' Bool (Read-only) Returns 1 if color, 0 if not.
*'''[[gc:setAlpha]]'''(int) - where the argument is an int between 0 and 255. Sets the transparency.
*'''[[gc:setAlpha]]'''(int) - where the argument is an int between 0 and 255. Sets the transparency.
*'''[[gc:setColorRGB]]'''(red, green, blue) RGB values are integers, from 0 to 255.
*'''[[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)
*'''[[gc:setFont]]'''(font, type, size), with font : {“sansserif”, "serif", ..}, type {“b”, “r”, “i”}, size(int)
*'''[[gc:setPen]]'''(size, smooth) size {“thin”, “medium”, "thick"}, smooth {“smooth”, "dotted", "dashed"}
*'''[[gc:setPen]]'''(size, smooth) size {“thin”, “medium”, "thick"}, smooth {“smooth”, "dotted", "dashed"}
== platform ==
== platform ==
These are mainly read-only. These work by writing "'''platform.'''" in front of them. Example : "'''platform.window:invalidate()'''"
These are mainly read-only. These work by writing "'''platform.'''" in front of them. Example : "'''platform.window:invalidate()'''"
*'''[[platform.isDeviceModeRendering()]]''' Returns true or false whether the unit is "rendering" or not
*'''[[platform.isDeviceModeRendering()]]''' Returns true or false whether the unit is "rendering" or not
*'''[[platform.gc]]''' - Other way to call '''gc'''. Use it like that : '''platform.gc():setAlpha(...)''' for example. This is useful when you're in a function outside '''on.paint(gc)''' (but this function has to be called within [[on.paint]](gc).)
*'''[[platform.gc]]''' - Other way to call '''gc'''. Use it like that : '''platform.gc():setAlpha(...)''' for example. This is useful when you're in a function outside '''on.paint(gc)''' (but this function has to be called within [[on.paint]](gc).)
*'''[[platform.isColorDisplay()]]''' Returns ''true'' if the unit the code is being run on has a color display (-> Nspire CX), and ''false'' otherwise.
*'''[[platform.isColorDisplay()]]''' Returns ''true'' if the unit the code is being run on has a color display (-> Nspire CX), and ''false'' otherwise.
==cursor==
== cursor ==
*'''[[hide]]'''() - hides the cursor (mouse pointer)
*'''[[set]]'''(string) - string can be one of those : (interrogation, crosshair, text, pointer, link select, diag resize, wait busy, hollow pointer, rotation, pencil, zoom box, arrow, zoom out, dotted arrow, clear, animate, excel plus, mod label, writing, unavailable, resize row, resize column, drag grab, hand open, hand close, hand pointer, zoom in, dilation, translation).
*'''[[cursor.hide]]'''() - hides the cursor (mouse pointer)
*'''[[show]]'''() - Shows the cursor on screen
*'''[[cursor.set]]'''(string) - string can be one of those : (interrogation, crosshair, text, pointer, link select, diag resize, wait busy, hollow pointer, rotation, pencil, zoom box, arrow, zoom out, dotted arrow, clear, animate, excel plus, mod label, writing, unavailable, resize row, resize column, drag grab, hand open, hand close, hand pointer, zoom in, dilation, translation).
*'''[[cursor.show]]'''() - Shows the cursor on screen
== document ==
*'''[[document.markChanged]]'''() - Flag the document as "changed" so the user has to save it after using it.
== clipboard ==
*'''[[clipboard.addText]]'''()
*'''[[clipboard.getText]]'''()
== locale ==
*'''[[locale.name]]'''() - Returns the current language the calculator is set in, formatted as ISO-639 (i.e : "fr", "en", "it" ...).
==document==
== image ==
*'''[[image.copy]]'''(image, width, height) - returns a new Image which has a new scale. Width is the final width, Heigth, the final height of the image.
*'''[[addText]]'''()
*'''[[image.height]]'''(image) - returns the height of the image given in parameter
*'''[[getText]]'''()
*'''[[image.new]]'''(string) - Creates a new image from the string given in parameter (see TI.Image). Call it with <tt>img = image.new("...")</tt>
*'''[[image.width]]'''(image) - returns the width of the image given in parameter
==locale==
== timer ==
*'''[[timer.getMilliSecCounter]]'''() - Returns the amount of milliseconds elapsed since last calculator reboot. (in TI's Computer software, returns an absolute negative time)
*'''[[__gc]]'''() - Do not use ! Causes crash : ''(Invalid memory access of location 0x0 eip=0x465cc7ac / Bus error)'' but thats probably just when calling in TI's emulator.
*'''[[timer.start]]'''(int) - Starts a timer with 1 second.
*'''[[timer.stop]]'''() - Stops a timer
*'''[[height]]'''(image) - returns the height of the image given in parameter
*'''[[width]]'''(image) - returns the width of the image given in parameter
==timer==
== toolpalette ==
*'''[[toolpalette.enable]]'''(string)
*'''[[enable]]'''(string)
*'''[[toolpalette.enableCopy]]'''()
*'''[[enableCopy]]'''()
*'''[[toolpalette.enableCut]]'''()
*'''[[enableCut]]'''()
*'''[[toolpalette.enablePaste]]'''()
*'''[[enablePaste]]'''()
*'''[[toolpalette.register]]'''(table)
*'''[[register]]'''(table)
==var==
== var ==
*'''[[var.list]]'''() - returns a list of all the variables in the entire Activity
*'''[[var.monitor]]'''() - ?
*'''[[var.recall]]'''(string) - returns the variable value which name is given in parameter
*'''[[var.recallstr]]'''(string) - returns the variable value converted to string which name is given in parameter
*'''[[var.store]]'''(string, value) - store in the variable, which name is given in parameter, the value
*'''[[var.unmonitor]]'''() - ?
*'''[[on.paint]]'''(gc) is called when the GUI is painted. 'gc' is the Graphics Context (see above)
== Events ==
*'''[[on.resize]]'''() is called when the window is rezised
*'''[[on.timer]]'''() is called when the timer has been finished. Here an example of using timer to play an animation :
*'''[[on.paint]]'''(gc) is called when the GUI is painted. 'gc' is the Graphics Context (see above)
<syntaxhighlight lang="lua">
*'''[[on.resize]]'''() is called when the window is rezised
*'''[[on.timer]]'''() is called when the timer has been finished. Here an example of using timer to play an animation :
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="lua source-lua"><pre class="de1"> x <span class="sy0">=</span> <span class="nu0">1</span> animating <span class="sy0">=</span> <span class="kw1">false</span> <span class="kw1">function</span> <span class="kw3">on.paint</span><span class="br0">(</span>gc<span class="br0">)</span> <span class="kw2">gc:setFont</span><span class="br0">(</span><span class="st0">"sansserif"</span>, <span class="st0">"r"</span>, <span class="nu0">10</span><span class="br0">)</span> <span class="kw2">gc:drawString</span><span class="br0">(</span><span class="kw1">tostring</span><span class="br0">(</span>x<span class="br0">)</span>, <span class="nu0">0</span>, <span class="nu0">0</span>, <span class="st0">"top"</span><span class="br0">)</span> <span class="kw1">if</span> animating <span class="kw1">then</span> x <span class="sy0">=</span> x + <span class="nu0">1</span> <span class="kw2">timer.start</span><span class="br0">(</span><span class="nu0">0.5</span><span class="br0">)</span> <span class="kw1">end</span> <span class="kw1">end</span> <span class="kw1">function</span> <span class="kw3">on.charIn</span><span class="br0">(</span>ch<span class="br0">)</span> animating <span class="sy0">=</span> <span class="kw1">not</span> animating <span class="co1">-- switch state</span> <span class="kw2">platform.window:invalidate<span class="br0">(</span><span class="br0">)</span></span> <span class="co1">-- recall graph engine</span> <span class="kw1">end</span> <span class="kw1">function</span> <span class="kw3">on.timer</span><span class="br0">(</span><span class="br0">)</span> <span class="kw2">timer.stop</span><span class="br0">(</span><span class="br0">)</span> <span class="kw2">platform.window:invalidate<span class="br0">(</span><span class="br0">)</span></span> <span class="co1">-- recall graph engine</span> <span class="kw1">end</span></pre></div></div>
</syntaxhighlight>
----
----
*'''[[on.arrowKey]]'''(key) is called when an '''arrow key''' from the clickPad/TouchPad is pressed (right, left, up, down)
*'''[[on.arrowLeft]]'''() is called when the '''left''' arrow is pressed
*'''[[on.arrowKey]]'''(key) is called when an '''arrow key''' from the clickPad/TouchPad is pressed (right, left, up, down)
*'''[[on.arrowRight]]'''() is called when the '''right''' arrow is pressed
*'''[[on.arrowLeft]]'''() is called when the '''left''' arrow is pressed
*'''[[on.arrowUp]]'''() is called when the up '''arrow''' is pressed
*'''[[on.arrowRight]]'''() is called when the '''right''' arrow is pressed
*'''[[on.arrowUp]]'''() is called when the up '''arrow''' is pressed
*'''[[on.arrowDown]]'''() is called when the '''down''' arrow is pressed
*'''[[on.arrowDown]]'''() is called when the '''down''' arrow is pressed
----
----
*'''[[on.up]]'''() -- probably for the touchpad up motion
*'''[[on.up]]'''() -- probably for the touchpad up motion
*'''[[on.down]]'''() -- probably for the touchpad down motion
*'''[[on.down]]'''() -- probably for the touchpad down motion
----
----
*'''[[on.enterKey]]'''() is called when the '''enter''' key is pressed.
*'''[[on.escapeKey]]'''() is called when the '''escape''' key is pressed.
*'''[[on.enterKey]]'''() is called when the '''enter''' key is pressed.
*'''[[on.tabKey]]'''() is called when the '''tab''' key is pressed.
*'''[[on.escapeKey]]'''() is called when the '''escape''' key is pressed.
*'''[[on.deleteKey]]'''() is called when the '''delete''' key is pressed.
*'''[[on.tabKey]]'''() is called when the '''tab''' key is pressed.
*'''[[on.backspaceKey]]'''() is called when the '''clear''' key is pressed.
*'''[[on.deleteKey]]'''() is called when the '''delete''' key is pressed.
*'''[[on.returnKey]]'''() is called when the '''return''' key is pressed.
*'''[[on.backspaceKey]]'''() is called when the '''clear''' key is pressed.
*'''[[on.contextMenu]]'''() is called when the combo-key '''Ctrl Menu''' is pressed.
*'''[[on.returnKey]]'''() is called when the '''return''' key is pressed.
*'''[[on.backtabKey]]'''() is called when the combo-key '''Maj Tab''' is pressed.
*'''[[on.contextMenu]]'''() is called when the combo-key '''Ctrl Menu''' is pressed.
*'''[[on.clearKey]]'''() is called when the combo-key '''Ctrl Clear''' is pressed.
*'''[[on.backtabKey]]'''() is called when the combo-key '''Maj Tab''' is pressed.
*'''[[on.clearKey]]'''() is called when the combo-key '''Ctrl Clear''' is pressed.
*'''[[on.help]]'''() is called when the combo-key '''Ctrl H''' is pressed.
*'''[[on.help]]'''() is called when the combo-key '''Ctrl H''' is pressed.
*'''[[on.charIn]]'''(string) is called when the Nspire detects a non arrow key being pressed. ch is the character it detect. If you want to auto start an event in the file linked to key r(like a reset) put on.charIn(“r”) where you want. This Lua program lets you display the value of a valid non arrow key :
*'''[[on.charIn]]'''(string) is called when the Nspire detects a non arrow key being pressed. ch is the character it detect. If you want to auto start an event in the file linked to key r(like a reset) put on.charIn(“r”) where you want. This Lua program lets you display the value of a valid non arrow key :
<syntaxhighlight lang="lua">
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="lua source-lua"><pre class="de1"> c <span class="sy0">=</span> <span class="st0">""</span> <span class="kw1">function</span> <span class="kw3">on.charIn</span><span class="br0">(</span>ch<span class="br0">)</span> c <span class="sy0">=</span> ch <span class="kw2">platform.window:invalidate<span class="br0">(</span><span class="br0">)</span></span> <span class="co1">-- we force the screen draw</span> <span class="kw1">end</span> <span class="kw1">function</span> <span class="kw3">on.paint</span><span class="br0">(</span>gc<span class="br0">)</span> <span class="kw2">gc:setFont</span><span class="br0">(</span>“sansserif”, <span class="st0">"r"</span>, <span class="nu0">10</span><span class="br0">)</span> <span class="kw2">gc:drawString</span><span class="br0">(</span>c, <span class="nu0">0</span>, <span class="nu0">0</span>, <span class="st0">"top"</span><span class="br0">)</span> <span class="kw1">end</span></pre></div></div>
</syntaxhighlight>
----
----
*'''[[on.blink]]'''() ? is called when the focus is lost on the page (like launching the document, changing page etc...)
*'''[[on.blink]]'''() ? is called when the focus is lost on the page (like launching the document, changing page etc...)
----
----
*'''[[on.deactivate]]'''() ? is called when the focus is lost on the page (like launching the document, changing page etc...)
*'''[[on.activate]]'''() ? is called when the focus is on the page (like launching the document, changing page etc...)
*'''[[on.deactivate]]'''() ? is called when the focus is lost on the page (like launching the document, changing page etc...)
*'''[[on.activate]]'''() ? is called when the focus is on the page (like launching the document, changing page etc...)
----
----
*'''[[on.mouseDown]]'''(x, y) is called when we press the left mouse button. X and Y are the pressed point coordinates.
*'''[[on.mouseDown]]'''(x, y) is called when we press the left mouse button. X and Y are the pressed point coordinates.
*'''[[on.mouseUp]]'''() is called when we release the left mouse button.
*'''[[on.mouseUp]]'''() is called when we release the left mouse button.
*'''[[on.mouseMove]]'''() is called when the mouse moves
*'''[[on.mouseMove]]'''() is called when the mouse moves
*'''[[on.grabDown]]'''() ? (software only ?)
*'''[[on.grabDown]]'''() ? (software only ?)
*'''[[on.grabMove]]'''() ? (software only ?)
*'''[[on.grabMove]]'''() ? (software only ?)
*'''[[on.grabUp]]'''() ? (software only ?)
*'''[[on.grabUp]]'''() ? (software only ?)
*'''[[on.rightMouseDown]]'''() ? (software only ?)
*'''[[on.rightMouseDown]]'''() ? (software only ?)
*'''[[on.rightMouseUp]]'''() ? (software only ?)
*'''[[on.rightMouseUp]]'''() ? (software only ?)
----
----
*'''[[on.cutEnabled]]'''() ? (software only ?)
*'''[[on.copyEnabled]]'''() ? (software only ?)
*'''[[on.cutEnabled]]'''() ? (software only ?)
*'''[[on.pasteEnabled]]'''() ? (software only ?)
*'''[[on.copyEnabled]]'''() ? (software only ?)
*'''[[on.cut]]'''() ? (software only ?)
*'''[[on.pasteEnabled]]'''() ? (software only ?)
*'''[[on.copy]]'''() ? (software only ?)
*'''[[on.cut]]'''() ? (software only ?)
*'''[[on.paste]]'''() ? (software only ?)
*'''[[on.copy]]'''() ? (software only ?)
*'''[[on.paste]]'''() ? (software only ?)
----
----
==D2Editor==
== D2Editor ==
*'''[[newRichText]]'''() creates a new RichText object (default values : x, y, width, height = 0)
*'''[[resize]]'''(width, height)
*'''[[D2Editor.newRichText]]'''() creates a new RichText object (default values : x, y, width, height = 0)
*'''[[move]]'''(x, y)
*'''[[D2Editor.resize]]'''(width, height)
*'''[[setText]]'''(string)
*'''[[D2Editor.move]]'''(x, y)
*'''[[getText]]'''() returns the RichText value
*'''[[D2Editor.setText]]'''(string)
*'''[[setReadOnly]]'''(bool) bool : true/false : If true, the content becomes read-only, i.e. non-editable.
*'''[[D2Editor.getText]]'''() returns the RichText value
*'''[[setFormattedText]]'''() - ?
*'''[[D2Editor.setReadOnly]]'''(bool) bool : true/false : If true, the content becomes read-only, i.e. non-editable.
Example of a valid function using the D2Editor
*'''[[D2Editor.setFormattedText]]'''() - ?
<syntaxhighlight lang="lua">
Example of a valid function using the D2Editor
<div dir="ltr" class="mw-geshi" style="text-align: left;"><div class="lua source-lua"><pre class="de1"> <span class="kw1">function</span> createRichTextBox box <span class="sy0">=</span> <span class="kw2">D2Editor.newRichText</span><span class="br0">(</span><span class="br0">)</span> box:move<span class="br0">(</span><span class="nu0">50</span>, <span class="nu0">50</span><span class="br0">)</span> box:resize<span class="br0">(</span><span class="nu0">50</span>, <span class="nu0">50</span><span class="br0">)</span> box:setText<span class="br0">(</span><span class="st0">"Hello World !"</span><span class="br0">)</span> <span class="kw1">end</span></pre></div></div>
== External Links ==
An interesting page about LUA code optimization, that can be really useful, especially for calculators : [http://trac.caspring.org/wiki/LuaPerformance Lua Performance]
</syntaxhighlight>
==External Links==
== Online Demo ==
[[Document Player]]
[[Document Player]]
