Inspired-Lua Wiki

https://wiki.inspired-lua.org
Admin
A wiki providing comprehensive documentation and examples for Lua scripting on the TI-Nspire...
Tokens:1,988,613
Snippets:18,043
Trust Score:7
Update:11 months ago
Show doc for...
Tokens:
Raw
### TI-Nspire Lua Scripting Setup and Deployment

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=3&title=Overview_of_the_API

This snippet describes the setup for Lua development on TI-Nspire devices, including the need for third-party tools to convert Lua scripts to TI-Nspire documents. It also mentions installing Lua on a computer for syntax checking.

```text
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.
Here's a dump of a lot of functions available in the API : [http://adriweb.free.fr/upload/ti/dump.html Link to the dump].
==Prerequisites==
Lua is only supported starting from OS v3.0.1. Creating Lua scripts is currently not officially supported by TI, you need one of the following third-party tools to convert Lua scripts to TI-Nspire documents:
*[http://www.ticalc.org/archives/files/fileinfo/437/43704.html LUAtoTNS.sh] (bash script, works on Linux, Mac OS and Unix, or Windows + Cygwin or Windows + MSYS).
*[http://www.mirari.fr/KbOD maketns.py] (Python script, cross-platform)
*[http://www.omnimaga.org/index.php?action=downloads;sa=view;down=651 lua2ti] (Windows + .NET Framework v4.0)
*[http://www.omnimaga.org/index.php?action=downloads;sa=view;down=652 lua2ti_linux] (Linux (No longer requires Mono, it is now a native Linux binary!))
You may also want to install Lua [http://www.lua.org/download.html on your computer]: <tt>luac -p</tt> can be used to check the syntax of your script before running it on a TI-Nspire or an emulator.
```

--------------------------------

### TI.Image Pixel Data Conversion Example (Binary to Decimal)

Source: https://wiki.inspired-lua.org/index_diff=204&oldid=72&title=TI

Demonstrates the process of converting a binary pixel representation to its decimal equivalent. It shows how the two bytes are split and interpreted to get the final color and alpha values.

```text
ARRRRRGG - GGGBBBBB
11111110 - 00100000

   ||          ||
   \/          \/
	
   254        032
```

--------------------------------

### Lua Timer Module Example

Source: https://wiki.inspired-lua.org/index_diff=50&oldid=49&title=Overview_of_the_API

Demonstrates using the timer module to control an animation. It starts a timer, invalidates the window for redrawing, and stops the timer when it completes. Requires the 'timer' and 'platform' modules.

```lua
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

```

--------------------------------

### Get pages containing links starting from 'B' (Generator)

Source: https://wiki.inspired-lua.org/api_action=help&modules=query&submodules=1

This example demonstrates using `list=alllinks` as a generator to retrieve pages that contain links, starting from the letter 'B'. The `galfrom` parameter specifies the starting point.

```http
GET /w/api.php?action=query&generator=alllinks&galfrom=B
```

--------------------------------

### Lua Example: Display Message on Key Press and Screen Refresh

Source: https://wiki.inspired-lua.org/index_diff=12&oldid=8&title=Overview_of_the_API

A sample Lua script for TI-Nspire that displays a "Hello World!" message when a key is pressed and clears it otherwise. It utilizes `on.paint`, `on.timer`, and `on.charIn` events for controlled screen updates.

```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
```

--------------------------------

### Get target pages with unique linked titles starting from 'B' (Generator)

Source: https://wiki.inspired-lua.org/api_action=help&modules=query&submodules=1

This example uses `list=alllinks` as a generator to yield target pages instead of source pages, specifically for unique linked titles starting from 'B'. The `galunique` and `galfrom` parameters are used.

```http
GET /w/api.php?action=query&generator=alllinks&galunique=&galfrom=B
```

--------------------------------

### Overview of the API

Source: https://wiki.inspired-lua.org/index_diff=18&oldid=17&title=Overview_of_the_API

Provides an overview of the Lua API available on the TI-Nspire, including details on its setup and limitations.

```APIDOC
## Overview of the API

This page describes how to set up a Lua development environment for the TI-Nspire and documents the currently known Lua functions for the Nspire. It notes that the _io_ and _os_ libraries are not present, suggesting a light version of Lua 5.1.4 is used.

### Prerequisites

- Lua is supported starting from OS v3.0.1.
- Third-party tools are required to convert Lua scripts to TI-Nspire documents:
  - LUAtoTNS.sh (bash script)
  - maketns.py (Python script)
  - lua2ti (Windows)
  - lua2ti_linux (Linux)
- Lua installation on your computer is recommended for syntax checking (`luac -p`).
```

--------------------------------

### List unique linked titles starting from 'B'

Source: https://wiki.inspired-lua.org/api_action=help&modules=query&submodules=1

This example shows how to retrieve a list of unique linked titles, starting from the letter 'B'. It uses the `alunique` parameter to ensure distinct titles and `alfrom=B` to set the starting point.

```http
GET /w/api.php?action=query&list=alllinks&alunique=&alfrom=B
```

--------------------------------

### Platform Utilities

Source: https://wiki.inspired-lua.org/index_diff=1202&oldid=1201&title=Overview_of_the_API

Provides information about the Nspire platform and rendering environment.

```APIDOC
## Platform

Module for accessing platform-specific information and features.

### Methods

*   **platform.isColorDisplay**()
    *   Returns `true` if the display is color-capable (e.g., Nspire CX, emulator), `false` otherwise (e.g., grayscale Nspire non-CX).
*   **platform.isDeviceModeRendering**()
    *   Returns `true` if the script is running on the handheld device or in the emulator (calculator view), `false` if running in the normal emulator view.
*   **platform.isTabletModeRendering**()
    *   Returns `true` if the script is running on a tablet device (iPad app), `false` otherwise.
*   **platform.window**
    *   Returns the window object currently owned by the script application. This object contains several other methods for window management.
*   **platform.withGC**(function)
    *   Executes the provided `function` with a dummy graphics context (`gc`) passed as an argument.
*   **platform.registerErrorHandler**(handler_function)
    *   Registers a global error handler function for the Lua script.
*   **platform.hw**()
    *   Returns a number corresponding to the type of device the script is currently running on.
```

--------------------------------

### List pages starting at 'B'

Source: https://wiki.inspired-lua.org/api_action=help&modules=query&submodules=1

This example shows how to retrieve a list of all pages sequentially, starting from the page title 'B'. It utilizes the `list=allpages` module with the `apfrom=B` parameter.

```http
GET /w/api.php?action=query&list=allpages&apfrom=B
```

--------------------------------

### List 4 pages starting at 'T' with info (Generator)

Source: https://wiki.inspired-lua.org/api_action=help&modules=query&submodules=1

This example uses `list=allpages` as a generator to retrieve information about 4 pages starting from the letter 'T'. It includes `gaplimit=4`, `gapfrom=T`, and `prop=info`.

```http
GET /w/api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
```

--------------------------------

### Lua Example: Displaying a Message on Key Press

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=12&title=Overview_of_the_API

A practical Lua example for TI-Nspire that displays 'Hello World !' when a key is pressed and clears the message afterward. It utilizes 'on.paint' for drawing, 'on.charIn' for input handling, and a timer to manage screen updates and redraws.

```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
```

--------------------------------

### Lua Timer Functions

Source: https://wiki.inspired-lua.org/index_diff=51&oldid=50&title=Overview_of_the_API

Provides functions to manage timers, including getting the elapsed milliseconds, starting, and stopping timers. The start function takes an integer representing seconds.

```lua
timer.start(seconds)
timer.stop()
local elapsed = timer.getMilliSecCounter()
```

--------------------------------

### Lua Example: Displaying Message on Key Press

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=398&title=Overview_of_the_API

This Lua code example shows how to display a 'Hello World!' message when a key is pressed and keep the screen blank otherwise. It utilizes the on.paint, on.timer, and on.charIn functions to manage message display, screen invalidation, and timed screen refreshes.

```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
```

--------------------------------

### Lua Timer Start Example

Source: https://wiki.inspired-lua.org/index_diff=618&oldid=489&title=timer

This Lua code snippet demonstrates how to use the timer.start function to set up a recurring timer event. It includes functions for handling timer ticks (on.timer) and repainting the screen (on.paint), illustrating a common pattern for game loops or periodic updates.

```lua
variable = 0

function on.timer()
   timer.stop()
   variable = variable + 1
   platform.window:invalidate()
end

function on.paint(gc)
   timer.start(0.5)
   gc:drawString(variable,0,0,"top")

end
```

--------------------------------

### List all links with page IDs and titles starting from 'B'

Source: https://wiki.inspired-lua.org/api_action=help&modules=query&submodules=1

This example demonstrates how to list all linked titles, including missing ones, along with their page IDs and titles, starting from the letter 'B'. It utilizes the `alprop=ids|title` and `alfrom=B` parameters.

```http
GET /w/api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title
```

--------------------------------

### Platform Information

Source: https://wiki.inspired-lua.org/index_diff=prev&oldid=1230&title=Overview_of_the_API

Provides information about the host platform and rendering environment.

```APIDOC
## Platform Information

### Description
Provides information about the Nspire device and rendering context.

### Methods
- **platform.isColorDisplay()**: Returns `true` if the display is color-capable (e.g., Nspire CX, emulator), `false` otherwise (e.g., grayscale Nspire).
- **platform.isDeviceModeRendering()**: Returns `true` if running on the handheld device or in calculator view emulator, `false` if in normal emulator view.
- **platform.isTabletModeRendering()**: Returns `true` if running on a tablet device (iPad app), `false` otherwise.
- **platform.window**: Returns the window object owned by the script application, which contains additional methods.
- **platform.withGC(function)**: Executes a given function with a dummy graphics context (`gc`) passed as an argument.
- **platform.registerErrorHandler(handler)**: Registers a global error handler function for Lua scripts.
- **platform.hw()**: Returns a number indicating the type of device the script is running on.
```

--------------------------------

### List content of 2 non-redirect pages starting at 'Re' (Generator)

Source: https://wiki.inspired-lua.org/api_action=help&modules=query&submodules=1

This example demonstrates using `list=allpages` as a generator to retrieve the content of the first 2 non-redirect pages starting from 'Re'. It uses `gaplimit=2`, `gapfilterredir=nonredirects`, `gapfrom=Re`, and `prop=revisions&rvprop=content`.

```http
GET /w/api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content
```

--------------------------------

### Lua Display Message on Key Press and Screen Update

Source: https://wiki.inspired-lua.org/index_diff=18&oldid=17&title=Overview_of_the_API

Provides a Lua example for displaying a 'Hello World!' message when a key is pressed and clearing it otherwise. It utilizes `on.paint`, `on.charIn`, and a timer for screen updates, demonstrating asynchronous drawing and event handling.

```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
```

--------------------------------

### Lua Timer and Animation Example

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=47&title=Overview_of_the_API

This snippet shows an example of using timers to create animations in Lua. It includes starting and stopping timers, and invalidating the window to trigger redraws for animation frames. Dependencies: timer, platform.window.invalidate.

```lua
local animating = false

function on.timer()
  if animating then
    -- Update animation state
    platform.window.invalidate()
  end
end

-- Example of starting and stopping the timer
-- timer.start(0.5)
-- timer.stop()
```

--------------------------------

### Getting String Dimensions in Lua (TI-Nspire)

Source: https://wiki.inspired-lua.org/index_diff=1194&oldid=658&title=Changes_in_OS_3

Provides an example of how to get the pixel width and height of a string using the `gc:getStringWidth` and `gc:getStringHeight` functions in TI-Nspire's Lua environment. This is useful for UI layout and text rendering.

```lua
function getHeightWidth(str, gc)
 local width = gc:getStringWidth(str) -- Gets the pixel length of str
 local height = gc:getStringHeight(str) -- Gets the pixel height of str
end
```

--------------------------------

### Platform API

Source: https://wiki.inspired-lua.org/index_diff=1201&oldid=1192&title=Overview_of_the_API

Provides information about the host platform and rendering environment.

```APIDOC
## Platform

Provides information about the Nspire device and its environment.

### Methods

- **platform.isColorDisplay()**: Returns true if the display is color-capable, false otherwise.
- **platform.isDeviceModeRendering()**: Returns true if running on the device or emulator calculator view, false otherwise.
- **platform.isTabletModeRendering()**: Returns true if running on a tablet device (iPad app), false otherwise.
- **platform.window**: Returns the window object for the script application.
- **platform.withGC(function)**: Executes a function with a dummy graphics context.
- **platform.registerErrorHandler(handler)**: Registers a global error handler for the script.
- **platform.hw()**: Returns a number indicating the type of device the script is running on.
```

--------------------------------

### Toolpalette Module

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=16&title=Overview_of_the_API

Documentation for registering menu structures for the tool palette.

```APIDOC
## Toolpalette Module

### Description
The Toolpalette module allows scripts to define and register custom menus accessible via the "Menu" button.

### Functions

- **toolpalette.register(menuStructure)**: Registers the provided `menuStructure` table, making it available in the tool palette.
```

--------------------------------

### GET /api.php?action=query&list=random

Source: https://wiki.inspired-lua.org/api_action=help&modules=query%2Brandom

Retrieves a set of random pages from the MediaWiki API. Pages are listed in a fixed sequence once the starting point is randomized.

```APIDOC
## GET /api.php?action=query&list=random

### Description
Retrieves a set of random pages from the MediaWiki API. The sequence of pages is fixed after the initial random starting point.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be `query`.
- **list** (string) - Required - Must be `random`.
- **rnnamespace** (integer|string) - Optional - Limits results to specified namespaces (e.g., `0`, `1`, `*` for all). Values can be separated by `|`.
- **rnfilterredir** (string) - Optional - Filters redirects. Values: `all`, `redirects`, `nonredirects`. Default: `nonredirects`.
- **rnredirect** (boolean) - Deprecated. Use `rnfilterredir=redirects` instead.
- **rnlimit** (integer|string) - Optional - Limits the number of random pages returned. Max 500 (5,000 for bots). Accepts `max`.
- **rncontinue** (string) - Optional - Used to continue pagination when more results are available.

### Request Example
```
api.php?action=query&list=random&rnnamespace=0&rnlimit=2
```

### Response
#### Success Response (200)
- **query** (object) - Contains the list of random pages.
  - **random** (array) - An array of page objects.
    - **title** (string) - The title of the random page.
    - **id** (integer) - The ID of the random page.

#### Response Example
```json
{
  "batchcomplete": "",
  "continue": {
    "rncontinue": "...",
    "continue": "|"
  },
  "query": {
    "random": [
      {
        "id": 12345,
        "title": "Example Page 1"
      },
      {
        "id": 67890,
        "title": "Example Page 2"
      }
    ]
  }
}
```
```

--------------------------------

### Platform Information

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=1223&title=Overview_of_the_API

Utilities for detecting platform capabilities and environment settings.

```APIDOC
## Platform

Provides information about the host platform and rendering environment.

### Methods

*   **platform.isColorDisplay**()
    *   Description: Returns `true` if the display is color-capable (e.g., Nspire CX, emulator), `false` otherwise (e.g., grayscale Nspire non-CX).
    *   Returns: (boolean) `true` for color displays, `false` for grayscale.

*   **platform.isDeviceModeRendering**()
    *   Description: Returns `true` if the script is running on the handheld device or in the emulator's calculator view, `false` if running in the emulator's normal view.
    *   Returns: (boolean) `true` for device/calculator view, `false` for emulator normal view.

*   **platform.isTabletModeRendering**()
    *   Description: Returns `true` if the script is running on a tablet device (e.g., iPad app), `false` otherwise.
    *   Returns: (boolean) `true` for tablet mode, `false` otherwise.

*   **platform.window**
    *   Description: Returns the window object currently owned by the script application. This object contains several other methods for window management.
    *   Returns: (Window Object) The current window object.

*   **platform.withGC**(function)
    *   Description: Executes a given function with a temporary, dummy graphics context (`gc`) passed as an argument.
    *   Parameters:
        *   `function` (function) - The function to execute.

*   **platform.registerErrorHandler**(handler)
    *   Description: Registers a global error handler for the Lua script.
    *   Parameters:
        *   `handler` (function) - The error handling function.

*   **platform.hw**()
    *   Description: Returns a number corresponding to the type of device the script is running on.
    *   Returns: (number) A code representing the hardware device type.
```

--------------------------------

### Animation Example using Timer and Paint Events in Lua

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=412&title=Overview_of_the_API

An example demonstrating how to use the `timer.start` function within the `on.paint` event to create a simple animation. It also shows how `on.charIn` can toggle the animation and `platform.window:invalidate()` redraws the screen.

```lua
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) -- Start timer for next frame
  end
end

function on.charIn(ch) -- Assuming 'ch' is pressed to toggle animation
  animating = not animating -- switch state
  platform.window:invalidate() -- recall graph engine to redraw
end

function on.timer()
  timer.stop() -- Stop the timer after it fires
  platform.window:invalidate() -- recall graph engine to redraw
end
```

--------------------------------

### Get Wiki Page Revisions with Content (PHP)

Source: https://wiki.inspired-lua.org/api_action=help&recursivesubmodules=1

Retrieves revision history, including content, for specified wiki pages. This example demonstrates fetching data for 'API' and 'Main Page' using GET parameters. It requires the 'revisions' property and specific revision properties like timestamp, user, comment, and content.

```php
<?php

$api_url = 'https://your-wiki.com/w/api.php';
$titles = 'API|Main%20Page';

$params = [
    'action' => 'query',
    'prop' => 'revisions',
    'titles' => $titles,
    'rvslots' => '*',
    'rvprop' => 'timestamp|user|comment|content'
];

$url = $api_url . '?' . http_build_query($params);

// You would typically use a library like Guzzle or cURL to fetch this URL
echo "GET: " . $url;

?>
```

--------------------------------

### GET /api.php?action=query&list=allredirects

Source: https://wiki.inspired-lua.org/api_action=help&recursivesubmodules=1

This endpoint lists all redirects within a specified namespace. You can control the starting point, limit the results, and specify which information to include for each redirect.

```APIDOC
## GET /api.php?action=query&list=allredirects

### Description
Lists all redirects within a specified namespace. This can be used as a generator to yield redirect targets or source pages.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Should be set to `query`.
- **list** (string) - Required - Should be set to `allredirects`.
- **arcontinue** (string) - Optional - When more results are available, use this to continue.
- **arfrom** (string) - Optional - The title of the redirect to start enumerating from.
- **arto** (string) - Optional - The title of the redirect to stop enumerating at.
- **arprefix** (string) - Optional - Search for all target pages that begin with this value.
- **arunique** (boolean) - Optional - Only show distinct target pages. Cannot be used with `arprop=ids|fragment|interwiki`. When used as a generator, yields target pages instead of source pages.
- **arprop** (string) - Optional - Which pieces of information to include. Values: `ids`, `title`, `fragment`, `interwiki`. Default: `title`.
- **arnamespace** (integer) - Optional - The namespace to enumerate. Default: `0`.
- **arlimit** (integer or `max`) - Optional - How many total items to return. No more than 500 (5,000 for bots) allowed. Default: 10.
- **ardir** (string) - Optional - The direction in which to list. Values: `ascending`, `descending`. Default: `ascending`.

### Request Example
```json
{
  "request": "GET /api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title&arlimit=50"
}
```

### Response
#### Success Response (200)
- **query.allredirects** (array) - An array of redirect objects.
  - **from** (string) - The title of the redirecting page.
  - **to** (string) - The title of the target page.
  - **missing** (boolean) - Whether the target page is missing.
  - **id** (integer) - The page ID of the redirecting page (if `arprop=ids`).
  - **fragment** (string) - The fragment from the redirect, if any (if `arprop=fragment`).
  - **iwprefix** (string) - The interwiki prefix from the redirect, if any (if `arprop=interwiki`).

#### Response Example
```json
{
  "response": {
    "query": {
      "allredirects": [
        {
          "from": "Redirect A",
          "to": "Target Page 1",
          "missing": false,
          "id": 123
        },
        {
          "from": "Redirect B",
          "to": "Target Page 2",
          "missing": true
        }
      ],
      "_continue": {
        "continue": "",
        "arcontinue": "Redirect B|..."
      }
    }
  }
}
```
```

--------------------------------

### Platform Information

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=411&title=Overview_of_the_API

The 'platform' module provides information about the host device's display capabilities, rendering modes, and hardware.

```APIDOC
## Platform

### Description
This module provides information about the Nspire platform the script is running on.

### Methods

*   **platform.isColorDisplay**()
    *   Returns `true` if the device display is color-capable (e.g., Nspire CX, emulator), `false` otherwise (e.g., grayscale Nspire).
*   **platform.isDeviceModeRendering**()
    *   Returns `true` if the script is running on the hand-held device or in the emulator's calculator view, `false` if running in the emulator's normal view.
*   **platform.isTabletModeRendering**()
    *   Returns `true` if the script is running on a tablet device (iPad app), `false` otherwise.
*   **platform.window**
    *   Returns the window object currently owned by the script application. This object contains additional methods.
*   **platform.withGC**(...)
    *   Executes a given function with a dummy graphics context (`gc`) passed as an argument.
*   **platform.registerErrorHandler**(...)
    *   Registers a global error handler for the Lua script.
*   **platform.hw**()
    *   Returns a number indicating the type of device the script is currently running on.
```

--------------------------------

### Lua TI-Nspire Simple Message Display on Key Press

Source: https://wiki.inspired-lua.org/index_diff=4&oldid=3&title=Overview_of_the_API

This Lua code demonstrates a basic TI-Nspire script that displays 'Hello World !' when a key is pressed and clears the screen otherwise. It utilizes on.paint for drawing, on.charIn for input handling, and a timer for screen updates, managing the graphics context effectively.

```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
```

--------------------------------

### Timer Functions in Lua

Source: https://wiki.inspired-lua.org/index_action=edit&oldid=2&title=Overview_of_the_API

Provides functionality to manage timers, including getting elapsed milliseconds, starting, and stopping timers. Useful for animations and time-based events.

```lua
timer.getMilliSecCounter()
timer.start(int)
timer.stop()
```

--------------------------------

### Lua gc:drawArc Function Syntax and Examples

Source: https://wiki.inspired-lua.org/index_diff=1302&oldid=202&title=gc%3AdrawArc

Demonstrates the Lua syntax for the gc:drawArc function, which draws arcs within a specified rectangle. It includes examples for drawing arcs, semicircles, and circles, explaining how start and turn angles affect the output.

```lua
gc:drawArc(x, y, width, height, start angle, turn angle)
```

```lua
gc:drawArc(10, 10, 20, 30, 0, 120)
```

```lua
gc:drawArc(50, 50, 25, 25, 90, 180)
```

```lua
gc:drawArc(50, 50, 25, 25, 90, -180)
```

--------------------------------

### TI-Nspire Lua Display Message on Key Press Example

Source: https://wiki.inspired-lua.org/index_diff=412&oldid=411&title=Overview_of_the_API

A Lua script for TI-Nspire that displays 'Hello World!' when a key is pressed and keeps the screen blank otherwise. It uses on.paint for drawing, on.charIn for input handling, and a timer for managing screen refresh cycles. Dependencies include platform, gc, and timer modules. Outputs are screen messages and redraws.

```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
```

--------------------------------

### TI.Image Example Header (Binary Representation)

Source: https://wiki.inspired-lua.org/index_diff=204&oldid=72&title=TI

An example of a TI.Image header represented in bytes, showing the raw data for width, height, buffer size, depth, and unknown fields.

```binary
.\000\000\000\018\000\000\000\000\000\000\000\092\000\000\000\016\000\001\000
```

--------------------------------

### Lua: Start a Timer for Event Handling with on.timer and timer.start

Source: https://wiki.inspired-lua.org/Special%3ASearch/%241

An example of using timers in Lua to trigger events after a specified duration. This snippet starts a timer that will later trigger an on.paint() event, useful for time-based program logic. Requires a Lua environment with timer capabilities.

```lua
timer.start(1) -- start a timer to exit on.paint() but keep in mind that we have to
```

--------------------------------

### Lua gc:drawArc Function Syntax and Examples

Source: https://wiki.inspired-lua.org/index_diff=1302&oldid=512&title=gc%3AdrawArc

Demonstrates the Lua syntax for the gc:drawArc function, including its parameters for position, dimensions, start angle, and turning angle. Provides examples of drawing arcs and semicircles, illustrating the effect of positive and negative turning angles.

```lua
gc:drawArc(x, y, width, height, start angle, turn angle)
-- Example 1: Draws an arc from the right to 120 degrees counterclockwise.
gc:drawArc(10, 10, 20, 30, 0, 120)
-- Example 2: Draws a semicircle on the left side (counterclockwise).
gc:drawArc(50, 50, 25, 25, 90, 180)
-- Example 3: Draws a semicircle on the right side (clockwise).
gc:drawArc(50, 50, 25, 25, 90, -180)
```

--------------------------------

### Platform Information (platform)

Source: https://wiki.inspired-lua.org/index_diff=1203&oldid=1202&title=Overview_of_the_API

The 'platform' module provides information about the host device and rendering environment, and allows for error handling.

```APIDOC
## Platform Information (platform)

### Description
Provides information about the Nspire device's capabilities and rendering mode, along with utilities for error handling and accessing the window object.

### Functions
* **platform.isColorDisplay**(): Returns true if the device has a color display (e.g., Nspire CX, emulator), false otherwise (e.g., grayscale Nspire).
* **platform.isDeviceModeRendering**(): Returns true if running on the handheld device or in the calculator view of the emulator, false if in the normal emulator view.
* **platform.isTabletModeRendering**(): Returns true if running on a tablet device (iPad app), false otherwise.
* **platform.window**: Accesses the window object owned by the script application, which contains additional methods.
* **platform.withGC**(function): Executes a given function with a temporary graphics context (gc) passed as an argument.
* **platform.registerErrorHandler**(handler): Registers a global error handler function for Lua scripts.
* **platform.hw**(): Returns a numerical code representing the type of device the script is running on.
```

--------------------------------

### MediaWiki API JSON Error Response Example

Source: https://wiki.inspired-lua.org/api_action=managetags&operation=deactivate&reason=No+longer+required&tag=spam&token=123ABC

This JSON object represents an error returned by the MediaWiki API. It indicates that a required parameter ('token') was sent in the query string instead of the POST body. For application use, set 'format=json' to get this structure.

```json
{
    "error": {
        "code": "mustpostparams",
                "info": "The following parameter was found in the query string, but must be in the POST body: token.",
                "*": "See https://wiki.inspired-lua.org/api.php for API usage. Subscribe to the mediawiki-api-announce mailing list at <https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce> for notice of API deprecations and breaking changes."
    }
}
```

--------------------------------

### Tool Palette Integration

Source: https://wiki.inspired-lua.org/index_diff=1230&oldid=411&title=Overview_of_the_API

The 'toolpalette' module enables the registration and management of menu items accessible via the device's "Menu" button, allowing user interaction with script functionalities.

```APIDOC
## Toolpalette

### Description
The tool palette allows you to register custom menus and manage menu item states, making script functionalities accessible via the device's "Menu" button.

### Methods

*   **toolpalette.register**(menuStructure)
    *   Registers a `menuStructure` table, which defines the structure of the menu that will appear when the "Menu" button is pressed.
*   **toolpalette.enable**(toolname, itemname, state)
    *   Enables or disables a specific menu item (`itemname`) within a given tool menu (`toolname`). `state` should be a boolean value (`true` to enable, `false` to disable).
*   **toolpalette.enableCopy**(state)
    *   Enables or disables the "Edit > Copy" menu command. `state` is a boolean.
*   **toolpalette.enableCut**(state)
    *   Enables or disables the "Edit > Cut" menu command. `state` is a boolean.
*   **toolpalette.enablePaste**(state)
    *   Enables or disables the "Edit > Paste" menu command. `state` is a boolean.
```

--------------------------------

### Event Handlers Example: Displaying a Message

Source: https://wiki.inspired-lua.org/index_action=edit&oldid=2&title=Overview_of_the_API

Illustrates a basic Lua script that displays 'Hello World!' when a key is pressed and clears the screen otherwise, using the `on.paint`, `on.charIn`, and `platform.window:invalidate` functions.

```APIDOC
## Example: Displaying a Message on Key Press

### Description
This example demonstrates how to use event handlers (`on.paint`, `on.charIn`, `on.timer`) and screen invalidation to display a message only when a key is pressed. The screen remains blank otherwise.

### Lua Code Example
```lua
local message = nil

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 after drawing
    timer.start(1) -- start a timer to allow screen redraw after paint finishes
  end
end

function on.timer()
  timer.stop()
  platform.window:invalidate() -- force redraw after timer
end

function on.charIn(ch)
  message = "Hello World !" -- store a message to be displayed
  platform.window:invalidate() -- request screen refresh
end
```

### Execution Flow Explanation
1. **Initialization**: When the document is opened, the script runs once. `message` is initialized to `nil`.
2. **Initial `on.paint()`**: Called when the screen needs drawing. Since `message` is `nil`, nothing is drawn.
3. **Key Press**: `on.charIn(ch)` is called. `message` is set to "Hello World !", and `platform.window:invalidate()` is called to request a redraw.
4. **`on.paint()` after Invalidation**: `on.paint(gc)` is called again. This time, `message` is not `nil`, so the message is drawn. `message` is then set back to `nil`, and a timer is started.
5. **Timer Callback**: After the timer duration, `on.timer()` is called, which again calls `platform.window:invalidate()`.
6. **Final `on.paint()`**: The screen is redrawn. `message` is now `nil` again, so the screen is blank, completing the cycle.
```

--------------------------------

### Timer Control in Lua

Source: https://wiki.inspired-lua.org/index_diff=7&oldid=6&title=Overview_of_the_API

Functions for managing timers, including getting elapsed milliseconds, starting a timer with a duration, and stopping a timer. Useful for animations and timed events.

```lua
timer.start(0.5)
-- Stop the timer when the event is finished
timer.stop()
```

--------------------------------

### GET /api.php?action=query&list=random

Source: https://wiki.inspired-lua.org/api_action=help&recursivesubmodules=1

Retrieves a set of random pages. Pages are listed in a fixed sequence, only the starting point is random. Requires read rights and can be used as a generator.

```APIDOC
## GET /api.php?action=query&list=random

### Description
Retrieves a set of random pages. The sequence of pages is fixed, with only the starting point being random. This module requires read rights and can be used as a generator.

### Method
GET

### Endpoint
/api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `query`.
- **list** (string) - Required - Must be set to `random`.
- **rnnamespace** (string) - Optional - Return pages in these namespaces only. Values can be separated by `|` or `*` for all namespaces. Examples: `0`, `0|2`, `*`.
- **rnfilterredir** (string) - Optional - How to filter for redirects. Allowed values: `all`, `redirects`, `nonredirects`. Defaults to `nonredirects`.
- **rnredirect** (boolean) - Deprecated - Use `rnfilterredir=redirects` instead.
- **rnlimit** (integer or `max`) - Optional - Limit how many random pages will be returned. Maximum of 500 (5,000 for bots). Defaults to 1.
- **rncontinue** (string) - Optional - Used for pagination to continue from a previous result set.

### Request Example
```
api.php?action=query&list=random&rnnamespace=0&rnlimit=2
```

### Response
#### Success Response (200)
- **query** (object) - Contains the query results.
  - **random** (array) - An array of page objects.
    - **pageid** (integer) - The ID of the page.
    - **ns** (integer) - The namespace of the page.
    - **title** (string) - The title of the page.

#### Response Example
```json
{
  "batchcomplete": "",
  "query": {
    "random": [
      {
        "pageid": 7,
        "ns": 0,
        "title": "Main Page"
      },
      {
        "pageid": 15,
        "ns": 0,
        "title": "List of fictional monkeys"
      }
    ]
  }
}
```
```

--------------------------------

### Launch Lua Libraries and User Scripts

Source: https://wiki.inspired-lua.org/api_action=compare&fromrev=1&torev=2

This snippet demonstrates the initialization and launching of essential Lua libraries (string, math) and the execution of user-provided Lua scripts. It also includes functions to manage application variables and interact with the platform's windowing system.

```lua
*Launch string library
*Launch math library
*Open and launch User's Lua script
*Launch var API (store, recall, ...)
*Launch platform API (window, gc, ...)
```

--------------------------------

### Get Information for a Stashed File (PHP)

Source: https://wiki.inspired-lua.org/api_action=help&recursivesubmodules=1

Retrieves information for a stashed file using its unique file key. This example demonstrates the basic usage of the 'stashimageinfo' property with the 'siifilekey' parameter.

```php
<?php

$api_url = 'https://your-wiki.com/w/api.php';
$file_key = '124sd34rsdf567';

$params = [
    'action' => 'query',
    'prop' => 'stashimageinfo',
    'siifilekey' => $file_key
];

$url = $api_url . '?' . http_build_query($params);

// You would typically use a library like Guzzle or cURL to fetch this URL
echo "GET: " . $url;

?>
```

--------------------------------

### Platform Functions API

Source: https://wiki.inspired-lua.org/index_diff=1201&oldid=1192&title=Overview_of_the_API

This section covers functions related to the platform, including API level, window management, and device rendering mode.

```APIDOC
## Platform Functions API

### Description
Functions related to the platform, including API level, window management, and device rendering mode.

### Endpoints

#### `platform.apilevel`

##### Description
Returns the version of the API. Currently returns 1.0.0 for OS 3.0.1.

##### Method
Read-only property

##### Response Example
```json
{
  "apiVersion": "1.0.0"
}
```

#### `platform.window:width()`

##### Description
Returns the width of the window.

##### Method
`platform.window:width`

##### Response Example
```json
{
  "windowWidth": 800
}
```

#### `platform.window:height()`

##### Description
Returns the height of the window.

##### Method
`platform.window:height`

##### Response Example
```json
{
  "windowHeight": 600
}
```

#### `platform.window:invalidate()`

##### Description
Repaints the window by calling `on.paint(gc)`.

##### Method
`platform.window:invalidate`

#### `platform.isDeviceModeRendering()`

##### Description
Returns true if the unit is in "rendering" mode, false otherwise.

##### Method
Read-only property

##### Response Example
```json
{
  "isRenderingMode": true
}
```

#### `platform.gc():setAlpha(int)`

##### Description
Sets the transparency for drawing operations. The argument is an integer between 0 and 255.

##### Method
`platform.gc():setAlpha`

##### Parameters
- **int** (number) - Transparency value (0-255).

#### `platform.gc():setColorRGB(red, green, blue)`

##### Description
Sets the color for drawing operations using RGB values.

##### Method
`platform.gc():setColorRGB`

##### Parameters
- **red** (number) - Red component (0-255).
- **green** (number) - Green component (0-255).
- **blue** (number) - Blue component (0-255).

#### `platform.gc():setFont(font, type, size)`

##### Description
Sets the font for text rendering.

##### Method
`platform.gc():setFont`

##### Parameters
- **font** (string) - Font family (e.g., "sansserif", "serif").
- **type** (string) - Font style (e.g., "b" for bold, "r" for regular, "i" for italic).
- **size** (number) - Font size.

#### `platform.gc():setPen(size, smooth)`

##### Description
Sets the pen properties for drawing lines and shapes.

##### Method
`platform.gc():setPen`

##### Parameters
- **size** (string) - Pen size (e.g., "thin", "medium", "thick").
- **smooth** (string) - Pen smoothing style (e.g., "smooth", "dotted", "dashed").

#### `platform.isColorDisplay()`

##### Description
Returns true if the device has a color display, false otherwise.

##### Method
Read-only property

##### Response Example
```json
{
  "isColorDisplay": true
}
```
```
Tokens:
Raw