MTSR/minetest_modding_book
4
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Formspecs: Update for 5.2

Browse Source
This commit is contained in:
rubenwardy 2020-05-04 22:10:23 +01:00
parent a2efa58809
commit d22f99669e
1 changed files with 15 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
_en/players/formspecs.md
View File

@ -1,16 +1,9 @@
--- ---
title: Formspecs title: GUIs (Formspecs)
layout: default layout: default
root: ../.. root: ../..
idx: 4.5 idx: 4.5
redirect_from: /en/chapters/formspecs.html redirect_from: /en/chapters/formspecs.html
minetest510:
level: warning
title: Real coordinates will be in 5.1.0
classes: web-only
message: This chapter describes the use of a feature that hasn't been released yet.
You can still use this chapter and the code in Minetest 5.0, but elements will
be positioned differently to what is shown.
submit_vuln: submit_vuln:
level: warning level: warning
title: Malicious clients can submit anything at anytime title: Malicious clients can submit anything at anytime
@ -62,9 +55,6 @@ called real coordinates which aims to rectify this by introducing a consistent
coordinate system. The use of real coordinates is highly recommended, and so coordinate system. The use of real coordinates is highly recommended, and so
this chapter will use them exclusively. this chapter will use them exclusively.
{% include notice.html notice=page.minetest510 %}
## Anatomy of a Formspec ## Anatomy of a Formspec
### Elements ### Elements
@ -103,14 +93,12 @@ The size is in formspec slots - a unit of measurement which is roughly
around 64 pixels, but varies based on the screen density and scaling around 64 pixels, but varies based on the screen density and scaling
settings of the client. Here's a formspec which is `2,2` in size: settings of the client. Here's a formspec which is `2,2` in size:
formspec_version[3]
size[2,2] size[2,2]
real_coordinates[true]
Notice how we explicitly need to enable the use of the real coordinate system. Notice how we explicitly defined the formspec language version.
Without this, the legacy system will instead be used to size the formspec, which will Without this, the legacy system will instead be used instead - which will
result in a larger size. This element is a special case, as it is the only element prevent the use of consistent element positioning and other new feautures.
which may appear both in the header and the body of a formspec. When in the header,
it must appear immediately after the size.
The position and anchor elements are used to place the formspec on the screen. The position and anchor elements are used to place the formspec on the screen.
The position sets where on the screen the formspec will be, and defaults to The position sets where on the screen the formspec will be, and defaults to
@ -118,6 +106,7 @@ the center (`0.5,0.5`). The anchor sets where on the formspec the position is,
allowing you to line the formspec up with the edge of the screen. The formspec allowing you to line the formspec up with the edge of the screen. The formspec
can be placed to the left of the screen like so: can be placed to the left of the screen like so:
formspec_version[3]
size[2,2] size[2,2]
real_coordinates[true] real_coordinates[true]
position[0,0.5] position[0,0.5]
@ -154,8 +143,8 @@ function guessing.get_formspec(name)
local text = "I'm thinking of a number... Make a guess!" local text = "I'm thinking of a number... Make a guess!"
local formspec = { local formspec = {
"formspec_version[3]",
"size[6,3.476]", "size[6,3.476]",
"real_coordinates[true]",
"label[0.375,0.5;", minetest.formspec_escape(text), "]", "label[0.375,0.5;", minetest.formspec_escape(text), "]",
"field[0.375,1.25;5.25,0.8;number;Number;]", "field[0.375,1.25;5.25,0.8;number;Number;]",
"button[1.5,2.3;3,0.8;guess;Guess]" "button[1.5,2.3;3,0.8;guess;Guess]"
@ -345,12 +334,16 @@ minetest.register_node("mymod:rightclick", {
local meta = minetest.get_meta(pos) local meta = minetest.get_meta(pos)
meta:set_string("formspec", meta:set_string("formspec",
"formspec_version[3]" ..
"size[5,5]" .. "size[5,5]" ..
"label[1,1;This is shown on right click]" .. "label[1,1;This is shown on right click]" ..
"field[1,2;2,1;x;x;]") "field[1,2;2,1;x;x;]")
end, end,
on_receive_fields = function(pos, formname, fields, player) on_receive_fields = function(pos, formname, fields, player)
if(fields.quit) then return end if fields.quit then
return
end
print(fields.x) print(fields.x)
end end
}) })