Difference between revisions of "Powder Toy Lua API"
(Add bz2 link) |
(Enter a short summary [b]) |
||
| Line 10: | Line 10: | ||
The API is split into several categories | The API is split into several categories | ||
; [[Lua_API:Interface|Interface]] | ; [[Lua_API:Interface|Interface]] | ||
| − | : Includes UI components such as buttons, labels and checkboxes, access to the very primitive window manager and input events | + | : Includes UI components such as buttons, labels, and checkboxes, access to the very primitive window manager, and input events |
; [[Lua_API:Renderer|Renderer]] | ; [[Lua_API:Renderer|Renderer]] | ||
: Methods and constants for interacting with the display mode | : Methods and constants for interacting with the display mode | ||
| Line 18: | Line 18: | ||
: Methods for modifying the state of the simulation | : Methods for modifying the state of the simulation | ||
; [[Lua_API:Graphics|Graphics]] | ; [[Lua_API:Graphics|Graphics]] | ||
| − | : Methods for drawing simple shapes and text on screen. | + | : Methods for drawing simple shapes and text on the screen. |
; [[Lua_API:File_System|File System]] | ; [[Lua_API:File_System|File System]] | ||
| − | : Functions for creating, deleting, modifying and enumerating files and folders. | + | : Functions for creating, deleting, modifying, and enumerating files and folders. |
; [[Lua_API:Platform|Platform]] | ; [[Lua_API:Platform|Platform]] | ||
: Functions for doing OS-level things like opening URLs or interacting with the clipboard. | : Functions for doing OS-level things like opening URLs or interacting with the clipboard. | ||
; [[Lua_API:Event|Event]] | ; [[Lua_API:Event|Event]] | ||
| − | : Listen for events, such as | + | : Listen for events, such as mouse clicks or key presses. |
; [http://w3.impa.br/~diego/software/luasocket/ Socket] | ; [http://w3.impa.br/~diego/software/luasocket/ Socket] | ||
: Built-in LuaSocket library available as the <code>socket</code> global. | : Built-in LuaSocket library available as the <code>socket</code> global. | ||
Revision as of 00:29, 29 June 2023
| Language: | English • 한국어 • 中文 |
|---|
The Powder Toy Lua API is a set of objects and functions that allow control over most aspects of the game, including graphics, element interactions, and interfaces.
If you are new to the Lua programming language, you should familiarize yourself with how to code in Lua. A great beginner's tutorial is available here
boxmein made a massive reference to most parts of the API, including some that are not added to this wiki yet. Regardless, this reference is extremely outdated and hasn't been updated in years. You can find it here.
The API is split into several categories
- Interface
- Includes UI components such as buttons, labels, and checkboxes, access to the very primitive window manager, and input events
- Renderer
- Methods and constants for interacting with the display mode
- Elements
- Methods and constants for modifying and creating elements
- Simulation
- Methods for modifying the state of the simulation
- Graphics
- Methods for drawing simple shapes and text on the screen.
- File System
- Functions for creating, deleting, modifying, and enumerating files and folders.
- Platform
- Functions for doing OS-level things like opening URLs or interacting with the clipboard.
- Event
- Listen for events, such as mouse clicks or key presses.
- Socket
- Built-in LuaSocket library available as the
socketglobal. - HTTP
- Provides access to basic HTTP functionality in the form of request objects.
- Bzip2
- Provides direct access to our bzip2 library, for compressing and decompressing data.
- Bit
- Doesn't actually provide any interaction with the game, but provides some functions for performing bitwise operations on integer numbers.
- Legacy
- Old Lua API with the tpt.* prefix
