Wiki

https://powdertoy.co.uk/Wiki/index.php?action=history&feed=atom&title=Powder_Toy_Lua_API_%28preview%29 Powder Toy Lua API (preview) - Revision history 2024-12-22T09:03:29Z Revision history for this page on the wiki MediaWiki 1.30.0 https://powdertoy.co.uk/Wiki/index.php?title=Powder_Toy_Lua_API_(preview)&diff=9131&oldid=prev LBPHacker: Praised be pandoc, I would wither away typing all this out in the mediawiki format 2024-01-27T20:41:00Z

Praised be pandoc, I would wither away typing all this out in the mediawiki format New page<div>== bz2 == The <code>bz2</code> API provides access to the bzip2 library TPT bundles. It can be used for compressing and decompressing blocks of data, such as TPT saves. Only one-shot functionality is exposed because streaming functionality is only useful for tasks that are beyond the scope of this API. Unless stated otherwise, all functions raise errors if supplied with parameters that disagree with their descriptions. === bz2.compress === Compress data with bzip2 at compression level 9. <pre>compressedData, errCode, errStr = bz2.compress(data, [maxSize])</pre> * <code>data</code>: string, the data to be compressed * <code>maxSize</code>: number, upper limit on the length of <code>compressedData</code>; defaults to <code>0</code>, which means no limit * <code>compressedData</code>: string, the compressed data, or <code>nil</code> on error * <code>errCode</code>: <code>nil</code>, or one of the following values on error: ** <code>bz2.COMPRESS_NOMEM</code>: out of memory, TPT will probably crash soon ** <code>bz2.COMPRESS_LIMIT</code>: the length of <code>compressedData</code> would exceed <code>maxSize</code> * <code>errStr</code>: <code>nil</code>, or a human-friendly string that explains the error === bz2.decompress === Decompress bzip2-compressed data. <pre>data, errCode, errStr = bz2.decompress(compressedData, [maxSize])</pre> * <code>compressedData</code>: string, the compressed data * <code>maxSize</code>: number, upper limit on the length of <code>data</code>; defaults to <code>0</code>, which means no limit * <code>data</code>: string, the original data, or <code>nil</code> on error * <code>errCode</code>: <code>nil</code>, or one of the following values on error: ** <code>bz2.DECOMPRESS_NOMEM</code>: out of memory, TPT will probably crash soon ** <code>bz2.DECOMPRESS_LIMIT</code>: the length of <code>data</code> would exceed <code>maxSize</code> ** <code>bz2.DECOMPRESS_TYPE</code>: <code>compressedData</code> is not bzip2-compressed data ** <code>bz2.DECOMPRESS_BAD</code>: <code>compressedData</code> is otherwise corrupt ** <code>bz2.DECOMPRESS_EOF</code>: <code>compressedData</code> contains data beyond the end of the bzip2 stream * <code>errStr</code>: <code>nil</code>, or a human-friendly string that explains the error == elements == The <code>elements</code> API contains methods and constants for creating and modifying elements. '''The shorter alias <code>elem</code> is also available.''' Unless stated otherwise, all functions raise errors if supplied with parameters that disagree with their descriptions. === elements.[group]_PT_[iname] === <pre>watrNumber = elements.DEFAULT_PT_WATR</pre> There are two ways to refer to elements: element numbers and element identifiers, which are strings of the form <code>&quot;[group]_PT_[iname]&quot;</code>. Both <code>[group]</code> and <code>[iname]</code> can be any string without underscores (<code>_</code>). All built-in elements are in group <code>DEFAULT</code>. For example, the identifier of WATR is <code>&quot;DEFAULT_PT_WATR&quot;</code>, because WATR belongs to the group <code>DEFAULT</code> and its internal name is <code>WATR</code>. This is different from [[#elements.property|the <code>Name</code> property]]. These constants map element identifiers to element numbers. The element number of WATR is <code>2</code>, so <code>elements.DEFAULT_PT_WATR</code> is also <code>2</code>. === elements.allocate === Create a new element. <pre>elemNumber = elements.allocate(group, iname)</pre> * <code>group</code>: string without underscores (<code>_</code>), the group the element belongs to; gets uppercased by the function * <code>iname</code>: string without underscores (<code>_</code>), the internal name of the element; gets uppercased by the function * <code>elemNumber</code>: the positive element number allocated for the element created, or <code>-1</code> on error, if there are no free element numbers left <code>group</code> should be something unique to your script, and should be the same across the entire script. It is common to use a simpler version of your username or the script’s name, for example if your script is called ''Ultimate Chemistry Pack v3'', you might use <code>&quot;CHEMPACK3&quot;</code> as the group name. <code>iname</code> should be unique to the element within your script, and should ultimately resemble [[#elements.property|the <code>Name</code> property]] of the element. For example, if your element’s name is ''C-6'' you should use <code>C6</code> as the internal name. The resulting element identifier must be unique across all scripts in use at any point in time. Elements that seem like built-in elements, i.e. ones in the group <code>DEFAULT</code>, cannot be created. Note that, as stated above, both <code>group</code> and <code>iname</code> get uppercased, so <code>elements.allocate(&quot;CheMpaCk3&quot;, &quot;c6&quot;)</code> is equivalent to <code>elements.allocate(&quot;CHEMPACK3&quot;, &quot;C6&quot;)</code>. Make the choice such that it is convenient to refer to your element via [[#elements.group_pt_iname|an <code>elements.[group]_PT_[iname]</code> constant]]. While it is perfectly possible to type <code>elem[&quot;Ultimate Chemistry Pack v3_PT_C-6&quot;]</code>, it is much more convenient to type <code>elem.CHEMPACK3_PT_C6</code>. The new element is created with all the default properties, and will not be visible until you modify it to show up in the menu. === elements.element === Query all or update multiple properties of an element. <pre>elemProps = elements.element(elemNumber) -- query variant elements.element(elemNumber, elemProps) -- update variant</pre> * <code>elemNumber</code>: number of the element whose properties are to be queried or update * <code>elemProps</code>: table that maps property names to property values The keys and values of <code>elemProps</code> are the same as the <code>propName</code> and <code>propValue</code> parameters of [[#elements.property|elements.property]]. The query variant returns all properties of the element in <code>elemProps</code> with the same caveats as [[#elements.property|elements.property]]. The update variant accepts any subset of properties, only updates the ones present in the table, applying the same checks as [[#elements.property|elements.property]]. This function is commonly used to base an element off another element by first copying all properties of the source element and applying them to the new element, and then customizing the new element a bit afterwards: <pre>local purpleGold = elem.allocate(&quot;EXAMPLE&quot;, &quot;PGLD&quot;) assert(purpleGold ~= -1, &quot;ran out of element numbers&quot;) elem.element(purpleGold, elem.element(elem.DEFAULT_PT_GOLD)) elem.property(purpleGold, &quot;Name&quot;, &quot;PGLD&quot;) elem.property(purpleGold, &quot;Color&quot;, 0x8040FF)</pre> === elements.exists === Check whether a number is a real element number and refers to an element. <pre>exists = elements.exists(elemNumber)</pre> * <code>elemNumber</code>: number of the element to be checked * <code>exists</code>: boolean, <code>true</code> if <code>elemNumber</code> refers to an element If an element exists, there exists [[#elements.group_pt_iname|a corresponding <code>elements.[group]_PT_[iname]</code> constant]], and conversely, if there exists such a constant, there exists a corresponding element. === elements.free === Free a previously allocated element. <pre>elements.free(elemNumber)</pre> * <code>elemNumber</code>: number of the element to be freed The element number is freed and can used later by another script. Built-in elements, i.e. elements in the group <code>DEFAULT</code>, cannot be freed. === elements.getByName === Find an element by name, [[#elements.property|the <code>Name</code> property]]. <pre>elementNumber = elements.getByName(name)</pre> * <code>name</code>: string, the name to find the element by * <code>elemNumber</code>: positive number of the element <code>name</code> refers to, or <code>-1</code> on error if no such element exists This function converts a human-friendly element name to an element number, essentially the same way the PROP tool or the console works. === elements.loadDefault === Restore the set of elements to its initial state at startup. <pre>elements.loadDefault()</pre> This frees all elements created and resets all properties of all built-in elements to their defaults. === elements.property === Query or update a property of an element. <pre>propValue = elements.property(elemNumber, propName) -- query variant elements.property(elemNumber, propName, propValue) -- update variant elements.property(elemNumber, &quot;Update&quot;, propValue, [runWhen]) -- special update variant for the Update property</pre> * <code>elemNumber</code>: number of the element whose property is to be queried or updated * <code>propName</code>: string, name of the property to be queried or updated * <code>propValue</code>: various types, value of the property to be queried or updated * <code>runWhen</code>: number, specifies when the update function should be run, one of: ** <code>elements.UPDATE_AFTER</code>: run before the built-in update function, this is the default ** <code>elements.UPDATE_REPLACE</code>: run instead of the built-in update function ** <code>elements.UPDATE_BEFORE</code>: run after the built-in update function The following table lists all element properties accessible via this function: {| class="wikitable" |- ! <code>propName</code> ! <code>propValue</code> type ! description |- | <code>&quot;Advection&quot;</code> | number | |- | <code>&quot;AirDrag&quot;</code> | number | |- | <code>&quot;AirLoss&quot;</code> | number | |- | <code>&quot;CarriesTypeIn&quot;</code> | number | |- | <code>&quot;ChangeType&quot;</code> | function | read-only |- | <code>&quot;Collision&quot;</code> | number | |- | <code>&quot;Color&quot;</code> | number | |- | <code>&quot;Create&quot;</code> | function | read-only |- | <code>&quot;CreateAllowed&quot;</code> | function | read-only |- | <code>&quot;CtypeDraw&quot;</code> | function | read-only |- | <code>&quot;DefaultProperties&quot;</code> | table | |- | <code>&quot;Description&quot;</code> | string | |- | <code>&quot;Diffusion&quot;</code> | number | |- | <code>&quot;Explosive&quot;</code> | number | |- | <code>&quot;Falldown&quot;</code> | number | |- | <code>&quot;Flammable&quot;</code> | number | |- | <code>&quot;Graphics&quot;</code> | function | read-only |- | <code>&quot;Gravity&quot;</code> | number | |- | <code>&quot;Hardness&quot;</code> | number | |- | <code>&quot;HeatConduct&quot;</code> | number | |- | <code>&quot;HighPressure&quot;</code> | number | |- | <code>&quot;HighPressureTransition&quot;</code> | element number | |- | <code>&quot;HighTemperature&quot;</code> | number | |- | <code>&quot;HighTemperatureTransition&quot;</code> | element number | |- | <code>&quot;HotAir&quot;</code> | number | |- | <code>&quot;Identifier&quot;</code> | string | element identifier, read-only |- | <code>&quot;Loss&quot;</code> | number | |- | <code>&quot;LowPressure&quot;</code> | number | |- | <code>&quot;LowPressureTransition&quot;</code> | element number | |- | <code>&quot;LowTemperature&quot;</code> | number | |- | <code>&quot;LowTemperatureTransition&quot;</code> | element number | |- | <code>&quot;Meltable&quot;</code> | <code>0</code> or <code>1</code> | |- | <code>&quot;MenuSection&quot;</code> | menu number | |- | <code>&quot;MenuVisible&quot;</code> | <code>0</code> or <code>1</code> | |- | <code>&quot;Name&quot;</code> | string | text that appears on the element button |- | <code>&quot;NewtonianGravity&quot;</code> | number | |- | <code>&quot;PhotonReflectWavelengths&quot;</code> | number | |- | <code>&quot;Properties&quot;</code> | number | |- | <code>&quot;Temperature&quot;</code> | number | |- | <code>&quot;Update&quot;</code> | function | read-only |- | <code>&quot;Weight&quot;</code> | number | |} <code>runWhen</code> is not possible to specify with [[#elements.element|elements.element]]. == event == === event.getModifiers === === event.register === === event.unregister === == fileSystem == === fileSystem.copy === === fileSystem.exists === === fileSystem.isDirectory === === fileSystem.isFile === === fileSystem.isLink === === fileSystem.list === === fileSystem.makeDirectory === === fileSystem.move === === fileSystem.removeDirectory === === fileSystem.removeFile === == graphics == === graphics.drawCircle === === graphics.drawLine === === graphics.drawPixel === === graphics.drawRect === === graphics.drawText === === graphics.fillCircle === === graphics.fillRect === === graphics.getColors === === graphics.getHexColor === === graphics.setClipRect === === graphics.textSize === === constants === == http == === http.get === === http.getAuthToken === === http.post === == interface == === interface.activeMenu === === interface.activeTool === === interface.addComponent === === interface.beginConfirm === === interface.beginInput === === interface.beginMessageBox === === interface.beginThrowError === === interface.brushID === === interface.brushRadius === === interface.button === === interface.checkbox === === interface.closeWindow === === interface.console === === interface.dropTextInput === === interface.grabTextInput === === interface.label === === interface.menuEnabled === === interface.mousePosition === === interface.numMenus === === interface.perfectCircleBrush === === interface.progressBar === === interface.removeComponent === === interface.showWindow === === interface.slider === === interface.textInputRect === === interface.textbox === === interface.window === === interface.windowSize === === constants === == platform == === platform.clipboardCopy === === platform.clipboardPaste === === platform.exeName === === platform.ident === === platform.openLink === === platform.platform === === platform.releaseType === === platform.restart === == renderer == === renderer.colorMode === === renderer.debugHud === === renderer.decorations === === renderer.depth3d === === renderer.displayModes === === renderer.fireSize === === renderer.grid === === renderer.hud === === renderer.renderModes === === renderer.showBrush === === renderer.useDisplayPreset === === renderer.zoomEnabled === === renderer.zoomScope === === renderer.zoomWindow === == simulation == === simulation.addCustomGol === === simulation.adjustCoords === === simulation.airMode === === simulation.ambientAirTemp === === simulation.ambientHeat === === simulation.ambientHeatSim === === simulation.brush === === simulation.canMove === === simulation.clearRect === === simulation.clearSim === === simulation.createBox === === simulation.createLine === === simulation.createParts === === simulation.createWallBox === === simulation.createWallLine === === simulation.createWalls === === simulation.customGravity === === simulation.decoBox === === simulation.decoBrush === === simulation.decoColor === === simulation.decoLine === === simulation.decoSpace === === simulation.deleteStamp === === simulation.edgeMode === === simulation.elecMap === === simulation.elementCount === === simulation.fanVelocityX === === simulation.fanVelocityY === === simulation.floodDeco === === simulation.floodParts === === simulation.floodWalls === === simulation.frameRender === === simulation.getSaveID === === simulation.golSpeedRatio === === simulation.gravityField === === simulation.gravityGrid === === simulation.gravityMass === === simulation.gravityMode === === simulation.heatSim === === simulation.historyForward === === simulation.historyRestore === === simulation.lastUpdatedID === === simulation.listCustomGol === === simulation.listStamps === === simulation.loadSave === === simulation.loadStamp === === simulation.neighbors === === simulation.newtonianGravity === === simulation.partChangeType === === simulation.partCount === === simulation.partCreate === === simulation.partExists === === simulation.partID === === simulation.partKill === === simulation.partNeighbors === === simulation.partPosition === === simulation.partProperty === === simulation.parts === === simulation.paused === === simulation.photons === === simulation.pmap === === simulation.pressure === === simulation.prettyPowders === === simulation.reloadSave === === simulation.removeCustomGol === === simulation.replaceModeFlags === === simulation.resetGravityField === === simulation.resetPressure === === simulation.resetSpark === === simulation.resetTemp === === simulation.resetVelocity === === simulation.saveStamp === === simulation.signs === === simulation.signs constants === === simulation.signs[n] === === simulation.signs.new === === simulation.signs.delete === === simulation.takeSnapshot === === simulation.temperatureScale === === simulation.toolBox === === simulation.toolBrush === === simulation.toolLine === === simulation.updateUpTo === === simulation.velocityX === === simulation.velocityY === === simulation.wallMap === === simulation.walls === === simulation.walls[id] === === simulation.walls.''''WL'''' === === simulation.waterEqualization === === constants === == socket == === socket.getTime === === socket.sleep === === socket.tcp === == tpt == === tpt.debug === === tpt.drawCap === === tpt.fpsCap === === tpt.getUserName === === tpt.installScriptManager === === tpt.log === === tpt.record === === tpt.screenshot === === tpt.version === == Button == === Button:action === === Button:enabled === === Button:position === === Button:size === === Button:text === === Button:visible === == Checkbox == === Checkbox:action === === Checkbox:checked === === Checkbox:position === === Checkbox:size === === Checkbox:text === === Checkbox:visible === == Label == === Label:position === === Label:size === === Label:text === === Label:visible === == ProgressBar == === ProgressBar:position === === ProgressBar:progress === === ProgressBar:size === === ProgressBar:status === === ProgressBar:visible === == Slider == === Slider:onValueChanged === === Slider:position === === Slider:size === === Slider:steps === === Slider:value === === Slider:visible === == Textbox == === Textbox:onTextChanged === === Textbox:position === === Textbox:readonly === === Textbox:size === === Textbox:text === === Textbox:visible === == Window == === Window:addComponent === === Window:onBlur === === Window:onDraw === === Window:onExit === === Window:onFocus === === Window:onInitialized === === Window:onKeyPress === === Window:onKeyRelease === === Window:onMouseDown === === Window:onMouseMove === === Window:onMouseUp === === Window:onMouseWheel === === Window:onTick === === Window:onTryExit === === Window:onTryOkay === === Window:position === === Window:removeComponent === === Window:size ===</div>

LBPHacker