Fix typos in several API documents

This commit is contained in:
Wuzzy 2024-07-19 15:34:39 +02:00
parent c60a38ff7c
commit 4b1a8db0a1
16 changed files with 25 additions and 25 deletions

View File

@ -116,7 +116,7 @@ the achievement.
#### Subcondition achievements
For subconditoin achievements, use this additional field for `def`:
For subcondition achievements, use this additional field for `def`:
* `subconditions`: List of subcondition identifiers (as strings). Put all
the required subconditions here. NOT translatable!
@ -150,7 +150,7 @@ Possible return values:
* `achievements.ACHIEVEMENT_GOTTEN`: Achievement gotten
* `achievements.ACHIEVEMENT_IN_PROGRESS`: Not gotten, but at least one subcondition was met
* `achievements.ACHIEVEMENT_NOT_GOTTEN`: Not gotten, and no subconditions completedkb
* `achievements.ACHIEVEMENT_NOT_GOTTEN`: Not gotten, and no subconditions completed
Parameters:

View File

@ -123,7 +123,7 @@ Hint: Look in `register.lua` to see how this function works in practice.
### `armor.slots`
A list which contains the available armor slot identifiers, starting with the first one.
The first identifier correspons to the first inventory list slot, the second name to the
The first identifier corresponds to the first inventory list slot, the second name to the
second slot, etc.
### `armor.slot_names`

View File

@ -25,7 +25,7 @@ These are the arguments (note that most arguments are required):
* `name`. Plant ID. Must be for the form `<mod_name>:<plant_name>`
* `def`: A definition table with these fields:
* `texture_prefix`: Prefix for all texures used by this plant. Recommended style: `"<mod_name>_<plant_name>"`
* `texture_prefix`: Prefix for all textures used by this plant. Recommended style: `"<mod_name>_<plant_name>"`
* `description_stage_1`: Translatable description for the stage 1 node (this is the seed)
* `tooltip_stage_1`: Translatable tooltip for the stage 1 node (describe here how the seed grows)
* `description_general`: Description for other stage nodes (2-4). This string must have "@1" in it which will be replaced with the stage number.
@ -39,7 +39,7 @@ These are the arguments (note that most arguments are required):
* `stage_extra_groups`: Optional. Table indexed by stage numbers. Each of these keys has a table as a value. This table is a
groups table for nodes. These groups will be added to the corresponding nodes.
If the default node definition already defines this group, it will be overwritten.
* `sounds_plant`: Optional. Node sound definition for the plant (same as `sounds` of node defintion).
* `sounds_plant`: Optional. Node sound definition for the plant (same as `sounds` of node definition).
* `sound_seed_place`: Optional. Seed placement sound. A SimpleSoundSpec.
The nodes will be added to the following groups by default:
@ -56,7 +56,7 @@ The nodes will be added to the following groups by default:
Registers a plant. Before you can call this function, you need to have registered the plant nodes (one for each stage). It is recommended to call `farming.register_plant_nodes` to do this.
But it's also possible to register the 4 plant nodes manually. If you want to do this, register them with a name of the form `<name>_<stage>"`; `stage` must be between 1 to 4. Stage 1 is also the placable seed. This function then will automatically add placement handlers and node timers to your nodes. You **must not** set `on_timer`, `on_construct` or `on_place` in these nodes.
But it's also possible to register the 4 plant nodes manually. If you want to do this, register them with a name of the form `<name>_<stage>"`; `stage` must be between 1 to 4. Stage 1 is also the placeable seed. This function then will automatically add placement handlers and node timers to your nodes. You **must not** set `on_timer`, `on_construct` or `on_place` in these nodes.
Arguments:

View File

@ -6,7 +6,7 @@ and you can also register new pages/tabs.
There are also some functions for adding special
formspec elements, some of them are required.
## Compability note
## Compatibility note
This mod provides a reasonable formspec prepend so that formspecs
from mods that do not know about `rp_formspec` should still
@ -137,7 +137,7 @@ Call this whenever you need to report to `rp_formspec`
the formspec of an invpage had some changes (i.e. new
elements).
For example, on an achievements page, when the list
of achievments has changed.
of achievements has changed.
Note: The invpage is automatically rebuilt when the current
invpage is selected manually.

View File

@ -17,7 +17,7 @@ the goodies are more valuable.
Parameters:
* `pos`: Position of the node
* `ctype`: A identifier for the type of treasuer to use.
* `ctype`: A identifier for the type of treasure to use.
See “Available treasure types” below.
* `pr`: A PseudoRandom object used for pseudo-randomness
* `listname`: Name of the inventory list to put items into

View File

@ -11,7 +11,7 @@ This mod uses binary semaphores.
Multiple mods can specify whether they want to allow or forbid a certain
HUD flag. Semaphores can be in two states: true (allow) or false (forbid).
If *any* semaphoer assigned to a HUD flag forbids it, the HUD flag will
If *any* semaphore assigned to a HUD flag forbids it, the HUD flag will
not be shown. If all semaphores allow the HUD flag, or no semaphores exist
for that HUD flag, the HUD flag will be shown.

View File

@ -28,7 +28,7 @@ to do the following:
* `_rp_hunger_sat`: How many saturation points this item restores
* When calling `minetest.item_eat` or `minetest.do_item_eat`,
always set `hp_change` to `0`. This is required for
compability reasons.
compatibility reasons.
## Functions

View File

@ -49,7 +49,7 @@ Arguments:
You should always set a custom `description` for the jeweled tool.
For the `description`, most jeweled tools in this mod use a description
of the form “[adjective] Jewel [orignal tool name]”, with the adjective
of the form “[adjective] Jewel [original tool name]”, with the adjective
describing what is special about this tool.
Example: “Swift Jewel Bronze Pickaxe” is a jeweled bronze pickaxe
@ -80,7 +80,7 @@ Registered jeweled tools are stored in read-only lookup tables, indexed by items
* `jewels.registered_jewel_defs`: Indexed by original tool itemstrings. The
value is a list of jeweled tool definitions for tools that you could get
when jeweling this tool
* `jewels.registered_jewel_parents`: Indxed by jeweled tool itemstrings, the value
* `jewels.registered_jewel_parents`: Indexed by jeweled tool itemstrings, the value
for each key is a table containing info about the “parent” (i.e. original)
tool that the jeweled tool is based on. Each value is a table with the
fields `name` (=itemstring) and `stats` (same as in `jewels.register_jewel`)

View File

@ -4,7 +4,7 @@ Use this mod if you want to print a number respecting the current locale.
## `loc.num(numbr)`
Takes a number `numbr` and return a formatted string representing the number appropirately for the current locale.
Takes a number `numbr` and return a formatted string representing the number appropriately for the current locale.
For positive integers, the output is the same as for `tostring`.
For convenience, if `numbr` is a string, it will first be attempted to internally convert it to a number.

View File

@ -986,7 +986,7 @@ Parameters:
### `rp_mobs.microtasks.drag = function(drag, drag_axes, time)`
Continously reduces the mob velocity using the specified drag vector at the specified
Continuously reduces the mob velocity using the specified drag vector at the specified
drag axes for a specified time. The drag vector specifies on each axis how much the mob slows down.
This microtask finishes after the `time` runs out.
@ -997,7 +997,7 @@ Parameters:
* `drag`: Drag vector. Higher number = faster slowdown.
* `drag_axes`: List of axes to which apply drag for (`"x"`, `"y"`, `"z"`).
Other axes will be ignored.
* `time`: Time after which microtaks finishes (seconds)
* `time`: Time after which microtasks finishes (seconds)
## Appendix

View File

@ -176,7 +176,7 @@ Parameters:
Returns `<stop>, <success>`. If `stop` is `true`, microtask will finish.
with the given success (`success` = `true`/`false`; `true` is default).
* `valid_node_func`: Optional function that checks if the next node is still “valid” (i.e. can
be safely moved towadrds). It's called right before the mob is starting to go towards
be safely moved towards). It's called right before the mob is starting to go towards
a new position of the path with arguments `pos, node`.
Returns `true` or `false`. If it returns `true`, the microtask will finish and fail.

View File

@ -2,7 +2,7 @@
## How moon phases work
Internally, the moon phase is directly derivied from
Internally, the moon phase is directly derived from
the current game day (`minetest.get_day_count()`) plus
a random offset that is specific to the world seed.
@ -27,4 +27,4 @@ Updates the moon for all players.
You should call this function after the the time of day
has been changed in order for the moon phase to be updated
instantly.
It is not neccessary to call this function for any other reason.
It is not necessary to call this function for any other reason.

View File

@ -62,7 +62,7 @@ but then you must also do this:
2. Add the field `_rp_painted_node_name` to the unpainted node. The value is the name of the painted node
3. Add the field `_rp_unpainted_node_name` to the painted node. The value is the name of the unpainted node
It is recommended to stick with the default naming convention unless a custom name is neccessary
It is recommended to stick with the default naming convention unless a custom name is necessary
for technical reasons (e.g. if you must obey the naming convention of a different mod).
### Palettes

View File

@ -42,7 +42,7 @@ restrictions and does not cut corners.
true if the node shall block the path
(default: same as `handler_walkable`)
* `handler_climbable`: A function that takes a node table and returns
true if the node is considered climable
true if the node is considered climbable
(default: if `climbing` field of node is true)
* `get_floor_cost`: Function that takes a node table and returns
the cost (a number) of walking _on_ the given node. The villager searches
@ -54,7 +54,7 @@ restrictions and does not cut corners.
* `use_vmanip`: If true, nodes will be queried using a LuaVoxelManip;
otherwise, `minetest.get_node` will be used. Required for async
usage.
* `vmanip`: Only neccessary for asyn usage. Optionally pass a
* `vmanip`: Only necessary for async usage. Optionally pass a
pre-generated LuaVoxelManip object for the corresponding `pos1`,
`pos2` and `searchdistance` arguments. Use the return value of
`rp_pathfinder.get_voxelmanip_for_path` here.

View File

@ -54,7 +54,7 @@ These are the available functions:
* `rp_sounds.node_sound_straw_defaults(table)`: Straw
* `rp_sounds.node_sound_glass_defaults(table)`: Glass
* `rp_sounds.node_sound_crystal_defaults(table)`: Crystal
* `rp_sounds.node_sound_fuzzy_defaults(table)`: Fuzzy, soft surface (like wool, cotton, bedsheet)
* `rp_sounds.node_sound_fuzzy_defaults(table)`: Fuzzy, soft surface (like wool, cotton, bed sheet)
* `rp_sounds.node_sound_water_defaults(table)`: Water
* `rp_sounds.node_sound_snow_defaults(table)`: Snow (incomplete, not recommended)

View File

@ -24,7 +24,7 @@ Parameters:
* `pos1`: First corner of area
* `pos2`: Second corner of area
* `nodes`: List of node names (supports `group:<groupname>` syntax)
* `func` Function to be called. Will be called for every positon
* `func` Function to be called. Will be called for every position
between `pos1` and `pos2` with the argument `pos`
* `nomanip`: If true, will not use VoxelManip (default: false)
@ -51,7 +51,7 @@ Parameters:
* `pos1`: First corner of area
* `pos2`: Second corner of area
* `func` Function to be called. Will be called for every positon
* `func` Function to be called. Will be called for every position
between `pos1` and `pos2` with the argument `pos`
* `nomanip`: If true, will not use VoxelManip (default: false)