Skip to content

Commit 5f9962e

Browse files
committedJul 5, 2014
Fix typos in doc/lua-api.txt
1 parent 2fee2ba commit 5f9962e

File tree

1 file changed

+82
-83
lines changed

1 file changed

+82
-83
lines changed
 

‎doc/lua_api.txt

+82-83
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ where gameid is unique to each game.
5151

5252
The game directory contains the file game.conf, which contains these fields:
5353
name = <Human-readable full name of the game>
54-
eg.
54+
e.g.
5555
name = Minetest
5656

5757
The game directory can contain the file minetest.conf, which will be used
@@ -66,22 +66,22 @@ Generic:
6666
$path_user/mods/ <-- User-installed mods
6767
$worldpath/worldmods/
6868

69-
In a run-in-place version (eg. the distributed windows version):
69+
In a run-in-place version (e.g. the distributed windows version):
7070
minetest-0.4.x/games/gameid/mods/
71-
minetest-0.4.x/mods/gameid/ <-- User-installed mods
71+
minetest-0.4.x/mods/ <-- User-installed mods
7272
minetest-0.4.x/worlds/worldname/worldmods/
7373

74-
On an installed version on linux:
74+
On an installed version on Linux:
7575
/usr/share/minetest/games/gameid/mods/
76-
~/.minetest/mods/gameid/ <-- User-installed mods
76+
~/.minetest/mods/ <-- User-installed mods
7777
~/.minetest/worlds/worldname/worldmods
7878

7979
Mod load path for world-specific games
8080
--------------------------------------
8181
It is possible to include a game in a world; in this case, no mods or
8282
games are loaded or checked from anywhere else.
8383

84-
This is useful for eg. adventure worlds.
84+
This is useful for e.g. adventure worlds.
8585

8686
This happens if the following directory exists:
8787
$world/game/
@@ -127,7 +127,7 @@ screenshot.png:
127127
A screenshot shown in modmanager within mainmenu.
128128

129129
description.txt:
130-
File containing desctiption to be shown within mainmenu.
130+
File containing description to be shown within mainmenu.
131131

132132
init.lua:
133133
The main Lua script. Running this script should register everything it
@@ -170,30 +170,30 @@ convert_to.
170170

171171
This can be used for maintaining backwards compatibility.
172172

173-
This can be also used for setting quick access names for things, eg. if
173+
This can be also used for setting quick access names for things, e.g. if
174174
you have an item called epiclylongmodname:stuff, you could do
175175
minetest.register_alias("stuff", "epiclylongmodname:stuff")
176176
and be able to use "/giveme stuff".
177177

178178
Textures
179179
--------
180-
Mods should generally prefix their textures with modname_, eg. given
180+
Mods should generally prefix their textures with modname_, e.g. given
181181
the mod name "foomod", a texture could be called
182182
"foomod_foothing.png"
183183

184184
Textures are referred to by their complete name, or alternatively by
185185
stripping out the file extension:
186-
eg. foomod_foothing.png
187-
eg. foomod_foothing
186+
e.g. foomod_foothing.png
187+
e.g. foomod_foothing
188188

189189
Sounds
190190
-------
191-
Only OGG files are supported.
191+
Only OGG Vorbis files are supported.
192192

193193
For positional playing of sounds, only single-channel (mono) files are
194194
supported. Otherwise OpenAL will play them non-positionally.
195195

196-
Mods should generally prefix their sounds with modname_, eg. given
196+
Mods should generally prefix their sounds with modname_, e.g. given
197197
the mod name "foomod", a sound could be called
198198
"foomod_foosound.ogg"
199199

@@ -210,11 +210,11 @@ from the available ones of the following files:
210210
foomod_foosound.9.ogg
211211

212212
Examples of sound parameter tables:
213-
-- Play locationless on all clients
213+
-- Play location-less on all clients
214214
{
215215
gain = 1.0, -- default
216216
}
217-
-- Play locationless to a player
217+
-- Play location-less to a player
218218
{
219219
to_player = name,
220220
gain = 1.0, -- default
@@ -234,11 +234,11 @@ Examples of sound parameter tables:
234234
}
235235

236236
SimpleSoundSpec:
237-
eg. ""
238-
eg. "default_place_node"
239-
eg. {}
240-
eg. {name="default_place_node"}
241-
eg. {name="default_place_node", gain=1.0}
237+
e.g. ""
238+
e.g. "default_place_node"
239+
e.g. {}
240+
e.g. {name="default_place_node"}
241+
e.g. {name="default_place_node", gain=1.0}
242242

243243
Registered definitions of stuff
244244
--------------------------------
@@ -259,7 +259,7 @@ minetest.register_craftitem(name, item definition)
259259
-> minetest.registered_items[name]
260260

261261
Note that in some cases you will stumble upon things that are not contained
262-
in these tables (eg. when a mod has been removed). Always check for
262+
in these tables (e.g. when a mod has been removed). Always check for
263263
existence before trying to access the fields.
264264

265265
Example: If you want to check the drawtype of a node, you could do:
@@ -384,7 +384,7 @@ A box is defined as:
384384
A box of a regular node would look like:
385385
{-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},
386386

387-
type = "leveled" is same as "fixed", but y2 will be automaticaly setted to level from param2
387+
type = "leveled" is same as "fixed", but y2 will be automatically set to level from param2
388388

389389
Ore types
390390
---------------
@@ -561,16 +561,16 @@ Craftitem (register_craftitem):
561561
Items and item stacks can exist in three formats:
562562

563563
Serialized; This is called stackstring or itemstring:
564-
eg. 'default:dirt 5'
565-
eg. 'default:pick_wood 21323'
566-
eg. 'default:apple'
564+
e.g. 'default:dirt 5'
565+
e.g. 'default:pick_wood 21323'
566+
e.g. 'default:apple'
567567

568568
Table format:
569-
eg. {name="default:dirt", count=5, wear=0, metadata=""}
569+
e.g. {name="default:dirt", count=5, wear=0, metadata=""}
570570
^ 5 dirt nodes
571-
eg. {name="default:pick_wood", count=1, wear=21323, metadata=""}
572-
^ a wooden pick about 1/3 weared out
573-
eg. {name="default:apple", count=1, wear=0, metadata=""}
571+
e.g. {name="default:pick_wood", count=1, wear=21323, metadata=""}
572+
^ a wooden pick about 1/3 worn out
573+
e.g. {name="default:apple", count=1, wear=0, metadata=""}
574574
^ an apple.
575575

576576
ItemStack:
@@ -604,7 +604,7 @@ You can read the rating of a group for an item or a node by using
604604

605605
Groups of items
606606
----------------
607-
Groups of items can define what kind of an item it is (eg. wool).
607+
Groups of items can define what kind of an item it is (e.g. wool).
608608

609609
Groups of nodes
610610
----------------
@@ -617,7 +617,7 @@ For entities, groups are, as of now, used only for calculating damage.
617617
The rating is the percentage of damage caused by tools with this damage group.
618618
See "Entity damage mechanism".
619619

620-
object.get_armor_groups() -> a group-rating table (eg. {fleshy=100})
620+
object.get_armor_groups() -> a group-rating table (e.g. {fleshy=100})
621621
object.set_armor_groups({fleshy=30, cracky=80})
622622

623623
Groups of tools
@@ -648,8 +648,8 @@ Special groups
648648
---------------
649649
- immortal: Disables the group damage system for an entity
650650
- level: Can be used to give an additional sense of progression in the game.
651-
- A larger level will cause eg. a weapon of a lower level make much less
652-
damage, and get weared out much faster, or not be able to get drops
651+
- A larger level will cause e.g. a weapon of a lower level make much less
652+
damage, and get worn out much faster, or not be able to get drops
653653
from destroyed nodes.
654654
- 0 is something that is directly accessible at the start of gameplay
655655
- There is no upper limit
@@ -672,9 +672,9 @@ Known damage and digging time defining groups
672672
----------------------------------------------
673673
- crumbly: dirt, sand
674674
- cracky: tough but crackable stuff like stone.
675-
- snappy: something that can be cut using fine tools; eg. leaves, small
675+
- snappy: something that can be cut using fine tools; e.g. leaves, small
676676
plants, wire, sheets of metal
677-
- choppy: something that can be cut using force; eg. trees, wooden planks
677+
- choppy: something that can be cut using force; e.g. trees, wooden planks
678678
- fleshy: Living things like animals and the player. This could imply
679679
some blood effects when hitting.
680680
- explody: Especially prone to explosions
@@ -693,7 +693,7 @@ Item groups are often used for defining, well, //groups of items//.
693693
- eatable: anything that can be eaten. Rating might define HP gain in half
694694
hearts.
695695
- flammable: can be set on fire. Rating might define the intensity of the
696-
fire, affecting eg. the speed of the spreading of an open fire.
696+
fire, affecting e.g. the speed of the spreading of an open fire.
697697
- wool: any wool (any origin, any color)
698698
- metal: any metal
699699
- weapon: any weapon
@@ -726,12 +726,12 @@ groups to enable interaction with tools.
726726

727727
**Full punch interval**:
728728
When used as a weapon, the tool will do full damage if this time is spent
729-
between punches. If eg. half the time is spent, the tool will do half
729+
between punches. If e.g. half the time is spent, the tool will do half
730730
damage.
731731

732732
**Maximum drop level**
733733
Suggests the maximum level of node, when dug with the tool, that will drop
734-
it's useful item. (eg. iron ore to drop a lump of iron).
734+
it's useful item. (e.g. iron ore to drop a lump of iron).
735735
- This is not automated; it is the responsibility of the node definition
736736
to implement this
737737

@@ -750,7 +750,7 @@ be able to dig.
750750
**Digging times**
751751
List of digging times for different ratings of the group, for nodes of the
752752
maximum level.
753-
* For example, as a lua table, ''times={2=2.00, 3=0.70}''. This would
753+
* For example, as a Lua table, ''times={2=2.00, 3=0.70}''. This would
754754
result in the tool to be able to dig nodes that have a rating of 2 or 3
755755
for this group, and unable to dig the rating 1, which is the toughest.
756756
Unless there is a matching group that enables digging otherwise.
@@ -769,7 +769,7 @@ tool_capabilities = {
769769
damage_groups = {fleshy=2},
770770
}
771771

772-
This makes the tool be able to dig nodes that fullfill both of these:
772+
This makes the tool be able to dig nodes that fulfill both of these:
773773
- Have the **crumbly** group
774774
- Have a **level** group less or equal to 2
775775

@@ -801,12 +801,12 @@ damage = 0
801801
foreach group in cap.damage_groups:
802802
damage += cap.damage_groups[group] * limit(actual_interval / cap.full_punch_interval, 0.0, 1.0)
803803
* (object.armor_groups[group] / 100.0)
804-
-- Where object.armor_groups[group] is 0 for inexisting values
804+
-- Where object.armor_groups[group] is 0 for inexistent values
805805
return damage
806806

807807
Client predicts damage based on damage groups. Because of this, it is able to
808808
give an immediate response when an entity is damaged or dies; the response is
809-
pre-defined somehow (eg. by defining a sprite animation) (not implemented;
809+
pre-defined somehow (e.g. by defining a sprite animation) (not implemented;
810810
TODO).
811811
- Currently a smoke puff will appear when an entity dies.
812812

@@ -987,7 +987,7 @@ label[<X>,<Y>;<label>]
987987
^ Position and size units are inventory slots
988988

989989
vertlabel[<X>,<Y>;<label>]
990-
^ Textual label drawn verticaly
990+
^ Textual label drawn vertically
991991
^ x and y work as per field
992992
^ label is the text on the label
993993
^ Position and size units are inventory slots
@@ -1008,8 +1008,8 @@ image_button[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>;<noclip>;<drawborder>
10081008
^ x, y, w, h, and name work as per button
10091009
^ texture name is the filename of an image
10101010
^ Position and size units are inventory slots
1011-
^ noclip true meand imagebutton doesn't need to be within specified formsize
1012-
^ drawborder draw button bodrer or not
1011+
^ noclip=true means imagebutton doesn't need to be within specified formsize
1012+
^ drawborder draw button border or not
10131013
^ pressed texture name is the filename of an image on pressed state
10141014

10151015
item_image_button[<X>,<Y>;<W>,<H>;<item name>;<name>;<label>]
@@ -1026,15 +1026,15 @@ image_button_exit[<X>,<Y>;<W>,<H>;<texture name>;<name>;<label>]
10261026
^ When clicked, fields will be sent and the form will quit.
10271027

10281028
textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>]
1029-
^Scrollabel itemlist showing arbitrary text elements
1029+
^ Scrollable item list showing arbitrary text elements
10301030
^ x and y position the itemlist relative to the top left of the menu
10311031
^ w and h are the size of the itemlist
10321032
^ name fieldname sent to server on doubleclick value is current selected element
10331033
^ listelements can be prepended by #color in hexadecimal format RRGGBB (only),
10341034
^ if you want a listelement to start with # write ##
10351035

10361036
textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<selected idx>;<transparent>]
1037-
^Scrollabel itemlist showing arbitrary text elements
1037+
^ Scrollable itemlist showing arbitrary text elements
10381038
^ x and y position the itemlist relative to the top left of the menu
10391039
^ w and h are the size of the itemlist
10401040
^ name fieldname sent to server on doubleclick value is current selected element
@@ -1047,7 +1047,7 @@ textlist[<X>,<Y>;<W>,<H>;<name>;<listelem 1>,<listelem 2>,...,<listelem n>;<sele
10471047
tabheader[<X>,<Y>;<name>;<caption 1>,<caption 2>,...,<caption n>;<current_tab>;<transparent>;<draw_border>]
10481048
^ show a tabHEADER at specific position (ignores formsize)
10491049
^ x and y position the itemlist relative to the top left of the menu
1050-
^ name fieldname data is transfered to lua
1050+
^ name fieldname data is transfered to Lua
10511051
^ caption 1... name shown on top of tab
10521052
^ current_tab index of selected tab 1...
10531053
^ transparent (optional) show transparent
@@ -1063,15 +1063,14 @@ dropdown[<X>,<Y>;<W>;<name>;<item 1>,<item 2>, ...,<item n>;<selected idx>]
10631063
^ show a dropdown field
10641064
^ x and y position of dropdown
10651065
^ width of dropdown
1066-
^ fieldname data is transfered to lua
1066+
^ fieldname data is transfered to Lua
10671067
^ items to be shown in dropdown
10681068
^ index of currently selected dropdown item
1069-
^ color in hexadecimal format RRGGBB (only)
10701069

10711070
checkbox[<X>,<Y>;<name>;<label>;<selected>;<tooltip>]
10721071
^ show a checkbox
10731072
^ x and y position of checkbox
1074-
^ name fieldname data is transfered to lua
1073+
^ name fieldname data is transfered to Lua
10751074
^ label to be shown left of checkbox
10761075
^ selected (optional) true/false
10771076
^ tooltip (optional)
@@ -1159,7 +1158,7 @@ vector.length(v) -> number
11591158
vector.normalize(v) -> vector
11601159
vector.round(v) -> vector
11611160
vector.equals(v1, v2) -> bool
1162-
For the folowing x can be either a vector or a number.
1161+
For the following functions x can be either a vector or a number.
11631162
vector.add(v, x) -> vector
11641163
vector.subtract(v, x) -> vector
11651164
vector.multiply(v, x) -> vector
@@ -1173,11 +1172,11 @@ dump(obj, dumped={})
11731172
^ Return object serialized as a string
11741173
math.hypot(x, y)
11751174
^ Get the hypotenuse of a triangle with legs x and y.
1176-
Usefull for distance calculation.
1175+
Useful for distance calculation.
11771176
string:split(separator)
1178-
^ eg. string:split("a,b", ",") == {"a","b"}
1177+
^ e.g. string:split("a,b", ",") == {"a","b"}
11791178
string:trim()
1180-
^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
1179+
^ e.g. string.trim("\n \t\tfoo bar\t ") == "foo bar"
11811180
minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
11821181
^ Convert position to a printable string
11831182
minetest.string_to_pos(string) -> position
@@ -1191,11 +1190,11 @@ minetest namespace reference
11911190
-----------------------------
11921191
Utilities:
11931192
minetest.get_current_modname() -> string
1194-
minetest.get_modpath(modname) -> eg. "/home/user/.minetest/usermods/modname"
1193+
minetest.get_modpath(modname) -> e.g. "/home/user/.minetest/usermods/modname"
11951194
^ Useful for loading additional .lua modules or static data from mod
11961195
minetest.get_modnames() -> list of installed mods
11971196
^ Return a list of installed mods, sorted alphabetically
1198-
minetest.get_worldpath() -> eg. "/home/user/.minetest/world"
1197+
minetest.get_worldpath() -> e.g. "/home/user/.minetest/world"
11991198
^ Useful for storing custom data
12001199
minetest.is_singleplayer()
12011200
minetest.features
@@ -1206,7 +1205,7 @@ minetest.has_feature(arg) -> bool, missing_features
12061205
minetest.get_player_information(playername)
12071206
^ table containing information about player peer:
12081207
{
1209-
address = "127.0.0.1", -- ip address of client
1208+
address = "127.0.0.1", -- IP address of client
12101209
ip_version = 4, -- IPv4 / IPv6
12111210
min_rtt = 0.01, -- minimum round trip time
12121211
max_rtt = 0.2, -- maximum round trip time
@@ -1395,9 +1394,9 @@ minetest.set_timeofday(val): val: 0...1; 0 = midnight, 0.5 = midday
13951394
minetest.get_timeofday()
13961395
minetest.get_gametime(): returns the time, in seconds, since the world was created
13971396
minetest.find_node_near(pos, radius, nodenames) -> pos or nil
1398-
^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1397+
^ nodenames: e.g. {"ignore", "group:tree"} or "default:dirt"
13991398
minetest.find_nodes_in_area(minp, maxp, nodenames) -> list of positions
1400-
^ nodenames: eg. {"ignore", "group:tree"} or "default:dirt"
1399+
^ nodenames: e.g. {"ignore", "group:tree"} or "default:dirt"
14011400
minetest.get_perlin(seeddiff, octaves, persistence, scale)
14021401
^ Return world-specific perlin noise (int(worldseed)+seeddiff)
14031402
minetest.get_voxel_manip()
@@ -1452,7 +1451,7 @@ minetest.add_node_level(pos, level)
14521451

14531452
Inventory:
14541453
minetest.get_inventory(location) -> InvRef
1455-
^ location = eg. {type="player", name="celeron55"}
1454+
^ location = e.g. {type="player", name="celeron55"}
14561455
{type="node", pos={x=, y=, z=}}
14571456
{type="detached", name="creative"}
14581457
minetest.create_detached_inventory(name, callbacks) -> InvRef
@@ -1525,7 +1524,7 @@ minetest.handle_node_drops(pos, drops, digger)
15251524
^ drops: list of itemstrings
15261525
^ Handles drops from nodes after digging: Default action is to put them into
15271526
digger's inventory
1528-
^ Can be overridden to get different functionality (eg. dropping items on
1527+
^ Can be overridden to get different functionality (e.g. dropping items on
15291528
ground)
15301529

15311530
Rollback:
@@ -1612,7 +1611,7 @@ minetest.create_schematic(p1, p2, probability_list, filename, slice_prob_list)
16121611
^ probability_list is an array of tables containing two fields, pos and prob.
16131612
^ pos is the 3d vector specifying the absolute coordinates of the node being modified,
16141613
^ and prob is the integer value from 0 to 255 of the probability (see: Schematic specifier).
1615-
^ If there are two or more entries with the same pos value, the last occuring in the array is used.
1614+
^ If there are two or more entries with the same pos value, the last entry is used.
16161615
^ If pos is not inside the box formed by p1 and p2, it is ignored.
16171616
^ If probability_list is nil, no probabilities are applied.
16181617
^ Slice probability works in the same manner, except takes a field called ypos instead which indicates
@@ -1628,12 +1627,12 @@ minetest.place_schematic(pos, schematic, rotation, replacements, force_placement
16281627
^ force_placement is a boolean indicating whether nodes other than air and
16291628
^ ignore are replaced by the schematic
16301629

1631-
Random:
1630+
Misc.:
16321631
minetest.get_connected_players() -> list of ObjectRefs
16331632
minetest.hash_node_position({x=,y=,z=}) -> 48-bit integer
16341633
^ Gives a unique hash number for a node position (16+16+16=48bit)
1635-
minetest.get_position_from_hash(hash) -> postion
1636-
^ Inverse transform of minetest.hash_node_postion
1634+
minetest.get_position_from_hash(hash) -> position
1635+
^ Inverse transform of minetest.hash_node_position
16371636
minetest.get_item_group(name, group) -> rating
16381637
^ Get rating of a group of an item. (0 = not in group)
16391638
minetest.get_node_group(name, group) -> rating
@@ -1655,7 +1654,7 @@ minetest.write_json(data[, styled]) -> string or nil and error message
16551654
^ Warning: JSON is more strict than the Lua table format.
16561655
1. You can only use strings and positive integers of at least one as keys.
16571656
2. You can not mix string and integer keys.
1658-
This is due to the fact that Javascript has two distinct array and object values.
1657+
This is due to the fact that JSON has two distinct array and object values.
16591658
^ Example: write_json({10, {a = false}}) -> "[10, {\"a\": false}]"
16601659
minetest.serialize(table) -> string
16611660
^ Convert a table containing tables, strings, numbers, booleans and nils
@@ -1669,7 +1668,7 @@ minetest.deserialize(string) -> table
16691668
^ Example: deserialize('print("foo")') -> nil (function call fails)
16701669
^ error:[string "print("foo")"]:1: attempt to call global 'print' (a nil value)
16711670
minetest.is_protected(pos, name) -> bool
1672-
^ This function should be overriden by protection mods and should be used to
1671+
^ This function should be overridden by protection mods and should be used to
16731672
check if a player can interact at a position.
16741673
^ This function should call the old version of itself if the position is not
16751674
protected by the mod.
@@ -1699,7 +1698,7 @@ minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orie
16991698
The above four options are mutually-exclusive; the last in the list takes
17001699
precedence over the first.
17011700

1702-
force_facedir: if true, forcably reset the facedir to north when placing on
1701+
force_facedir: if true, forcefully reset the facedir to north when placing on
17031702
the floor or ceiling
17041703

17051704
minetest.rotate_node(itemstack, placer, pointed_thing)
@@ -1738,7 +1737,7 @@ minetest.registered_entities
17381737
minetest.object_refs
17391738
^ List of object references, indexed by active object id
17401739
minetest.luaentities
1741-
^ List of lua entities, indexed by active object id
1740+
^ List of Lua entities, indexed by active object id
17421741

17431742
Class reference
17441743
----------------
@@ -1767,7 +1766,7 @@ methods:
17671766
^ will trigger the node's on_timer function after timeout-elapsed seconds
17681767
- start(timeout)
17691768
^ start a timer
1770-
^ equivelent to set(timeout,0)
1769+
^ equivalent to set(timeout,0)
17711770
- stop()
17721771
^ stops the timer
17731772
- get_timeout() -> current timeout in seconds
@@ -2215,7 +2214,7 @@ Item definition (register_node, register_craftitem, register_tool)
22152214
description = "Steel Axe",
22162215
groups = {}, -- key=name, value=rating; rating=1..3.
22172216
if rating not applicable, use 1.
2218-
eg. {wool=1, fluffy=3}
2217+
e.g. {wool=1, fluffy=3}
22192218
{soil=2, outerspace=1, crumbly=1}
22202219
{bendy=2, snappy=1},
22212220
{hard=1, metal=1, spikes=1}
@@ -2256,7 +2255,7 @@ Item definition (register_node, register_craftitem, register_tool)
22562255
^ default: nil
22572256
^ Function must return either nil if no item shall be removed from
22582257
inventory, or an itemstack to replace the original itemstack.
2259-
eg. itemstack:take_item(); return itemstack
2258+
e.g. itemstack:take_item(); return itemstack
22602259
^ Otherwise, the function is free to do what it wants.
22612260
^ The default functions handle regular use cases.
22622261
after_use = func(itemstack, user, node, digparams),
@@ -2302,7 +2301,7 @@ Node definition (register_node)
23022301
post_effect_color = {a=0, r=0, g=0, b=0}, -- If player is inside node
23032302
paramtype = "none", -- See "Nodes"
23042303
paramtype2 = "none", -- See "Nodes"
2305-
is_ground_content = true, -- If false, cavegen will not carve through this
2304+
is_ground_content = true, -- If false, the cave generator will not carve through this
23062305
sunlight_propagates = false, -- If true, sunlight will go infinitely through this
23072306
walkable = true, -- If true, objects collide with node
23082307
pointable = true, -- If true, can be pointed at
@@ -2316,8 +2315,8 @@ Node definition (register_node)
23162315
liquid_viscosity = 0, -- Higher viscosity = slower flow (max. 7)
23172316
liquid_renewable = true, -- Can new liquid source be created by placing two or more sources nearby?
23182317
freezemelt = "", -- water for snow/ice, ice/snow for water
2319-
leveled = 0, -- Block contain level in param2. value - default level, used for snow. Dont forget use "leveled" type nodebox
2320-
liquid_range = 8, -- number of flowing nodes arround source (max. 8)
2318+
leveled = 0, -- Block contain level in param2. value - default level, used for snow. Don't forget use "leveled" type nodebox
2319+
liquid_range = 8, -- number of flowing nodes around source (max. 8)
23212320
drowning = 0, -- Player will take this amount of damage if no bubbles are left
23222321
light_source = 0, -- Amount of light emitted by node
23232322
damage_per_second = 0, -- If player is inside node, this damage is caused
@@ -2379,7 +2378,7 @@ Node definition (register_node)
23792378

23802379
on_receive_fields = func(pos, formname, fields, sender),
23812380
^ fields = {name1 = value1, name2 = value2, ...}
2382-
^ Called when an UI form (eg. sign text input) returns data
2381+
^ Called when an UI form (e.g. sign text input) returns data
23832382
^ default: nil
23842383

23852384
allow_metadata_inventory_move = func(pos, from_list, from_index,
@@ -2416,7 +2415,7 @@ Recipe for register_craft: (shaped)
24162415
recipe = {
24172416
{'default:cobble', 'default:cobble', 'default:cobble'},
24182417
{'', 'default:stick', ''},
2419-
{'', 'default:stick', ''}, -- Also groups; eg. 'group:crumbly'
2418+
{'', 'default:stick', ''}, -- Also groups; e.g. 'group:crumbly'
24202419
},
24212420
replacements = <optional list of item pairs,
24222421
replace one input item with another item on crafting>
@@ -2538,7 +2537,7 @@ Decoration definition (register_decoration)
25382537
replacements = {{"oldname", "convert_to"}, ...},
25392538
flags = "place_center_x, place_center_z",
25402539
^ Flags for schematic decorations. See 'Schematic attributes'.
2541-
rotation = "90" --rotate schematic 90 degrees on placement
2540+
rotation = "90" -- rotate schematic 90 degrees on placement
25422541
^ Rotation can be "0", "90", "180", "270", or "random".
25432542
}
25442543

@@ -2612,10 +2611,10 @@ Particle definition (add_particle)
26122611
texture = "image.png",
26132612
^ Uses texture (string)
26142613
playername = "singleplayer"
2615-
^ Playername is optional, if specified spawns particle only on the player's client
2614+
^ optional, if specified spawns particle only on the player's client
26162615
}
26172616

2618-
Particlespawner definition (add_particlespawner)
2617+
ParticleSpawner definition (add_particlespawner)
26192618
{
26202619
amount = 1,
26212620
time = 1,
@@ -2630,11 +2629,11 @@ Particlespawner definition (add_particlespawner)
26302629
maxexptime = 1,
26312630
minsize = 1,
26322631
maxsize = 1,
2633-
^ The particle's properties are random values in between the boundings:
2632+
^ The particle's properties are random values in between the bounds:
26342633
^ minpos/maxpos, minvel/maxvel (velocity), minacc/maxacc (acceleration),
26352634
^ minsize/maxsize, minexptime/maxexptime (expirationtime)
26362635
collisiondetection = false,
2637-
^ collisiondetection: if true uses collisiondetection
2636+
^ collisiondetection: if true uses collision detection
26382637
vertical = false,
26392638
^ vertical: if true faces player using y axis only
26402639
texture = "image.png",

0 commit comments

Comments
 (0)
Please sign in to comment.