BRNSystems/minetest
1
0
Fork 0
forked from Mirrorlandia_minetest/minetest
Code Pull Requests 1 Activity

Lua_api.txt: Various improvements

Browse Source 
Improve documentation for formspec 'position' and 'anchor' elements.
Add missing documentation of 'animation' and 'glow' for particle spawners.
This commit is contained in:
paramat 2018-01-15 03:34:03 +00:00 committed by paramat
parent 142474196a
commit 70a90bc83a
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/lua_api.txt
View File

@ -1897,14 +1897,23 @@ examples.
* deprecated: `invsize[<W>,<H>;]` * deprecated: `invsize[<W>,<H>;]`
#### `position[<X>,<Y>]` #### `position[<X>,<Y>]`
* Define the position of the formspec * Must be used after `size` element.
* A value between 0.0 and 1.0 represents a position inside the screen * Defines the position on the game window of the formspec's `anchor` point.
* The default value is the center of the screen (0.5, 0.5) * For X and Y, 0.0 and 1.0 represent opposite edges of the game window, for example:
* [0.0, 0.0] sets the position to the top left corner of the game window.
* [1.0, 1.0] sets the position to the bottom right of the game window.
* Defaults to the center of the game window [0.5, 0.5].
#### `anchor[<X>,<Y>]` #### `anchor[<X>,<Y>]`
* Define the anchor of the formspec * Must be used after both `size` and `position` (if present) elements.
* A value between 0.0 and 1.0 represents an anchor inside the formspec * Defines the location of the anchor point within the formspec.
* The default value is the center of the formspec (0.5, 0.5) * For X and Y, 0.0 and 1.0 represent opposite edges of the formspec, for example:
* [0.0, 1.0] sets the anchor to the bottom left corner of the formspec.
* [1.0, 0.0] sets the anchor to the top right of the formspec.
* Defaults to the center of the formspec [0.5, 0.5].
* `position` and `anchor` elements need suitable values to avoid a formspec
extending off the game window due to particular game window sizes.
#### `container[<X>,<Y>]` #### `container[<X>,<Y>]`
* Start of a container block, moves all physical elements in the container by (X, Y) * Start of a container block, moves all physical elements in the container by (X, Y)
@ -5277,6 +5286,10 @@ Note that in params, use of symbols is as follows:
-- ^ Uses texture (string) -- ^ Uses texture (string)
playername = "singleplayer" playername = "singleplayer"
-- ^ Playername is optional, if specified spawns particle only on the player's client -- ^ Playername is optional, if specified spawns particle only on the player's client
animation = {Tile Animation definition},
-- ^ optional, specifies how to animate the particle texture
glow = 0
-- ^ optional, specify particle self-luminescence in darkness
} }
### `HTTPRequest` definition (`HTTPApiTable.fetch_async`, `HTTPApiTable.fetch_async`) ### `HTTPRequest` definition (`HTTPApiTable.fetch_async`, `HTTPApiTable.fetch_async`)