mirror of
https://github.com/moparisthebest/minetest
synced 2024-12-22 15:48:48 -05:00
Clarify radii and distance types in documentation
Because not all circles are round: * circles using an euclidean metric are what we usually call "round" * circles using a maximum metric look like euclidean rectangles with equal adjacent sides (squares) * circles using a manhattan metric look like an euclidean right angled rhombus (squares, but 45° rotated to the former one) [ci skip]
This commit is contained in:
parent
89e8f3a918
commit
776760aba7
@ -393,13 +393,13 @@ Examples of sound parameter tables:
|
|||||||
{
|
{
|
||||||
pos = {x=1,y=2,z=3},
|
pos = {x=1,y=2,z=3},
|
||||||
gain = 1.0, -- default
|
gain = 1.0, -- default
|
||||||
max_hear_distance = 32, -- default
|
max_hear_distance = 32, -- default, uses an euclidean metric
|
||||||
}
|
}
|
||||||
-- Play connected to an object, looped
|
-- Play connected to an object, looped
|
||||||
{
|
{
|
||||||
object = <an ObjectRef>,
|
object = <an ObjectRef>,
|
||||||
gain = 1.0, -- default
|
gain = 1.0, -- default
|
||||||
max_hear_distance = 32, -- default
|
max_hear_distance = 32, -- default, uses an euclidean metric
|
||||||
loop = true, -- only sounds connected to objects can be looped
|
loop = true, -- only sounds connected to objects can be looped
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -1664,7 +1664,7 @@ numerical form, the raw integer value of an ARGB8 quad:
|
|||||||
or string form, a ColorString (defined above):
|
or string form, a ColorString (defined above):
|
||||||
`colorspec = "green"`
|
`colorspec = "green"`
|
||||||
|
|
||||||
Vector helpers
|
Spatial Vectors
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
* `vector.new([x[, y, z]])`: returns a vector.
|
* `vector.new([x[, y, z]])`: returns a vector.
|
||||||
@ -1682,8 +1682,8 @@ For the following functions `x` can be either a vector or a number:
|
|||||||
|
|
||||||
* `vector.add(v, x)`: returns a vector
|
* `vector.add(v, x)`: returns a vector
|
||||||
* `vector.subtract(v, x)`: returns a vector
|
* `vector.subtract(v, x)`: returns a vector
|
||||||
* `vector.multiply(v, x)`: returns a vector
|
* `vector.multiply(v, x)`: returns a scaled vector or Schur product
|
||||||
* `vector.divide(v, x)`: returns a vector
|
* `vector.divide(v, x)`: returns a scaled vector or Schur quotient
|
||||||
|
|
||||||
Helper functions
|
Helper functions
|
||||||
-----------------
|
-----------------
|
||||||
@ -1971,11 +1971,13 @@ and `minetest.auth_reload` call the authetification handler.
|
|||||||
* Returns `ObjectRef`, or `nil` if failed
|
* Returns `ObjectRef`, or `nil` if failed
|
||||||
* `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
|
* `minetest.get_player_by_name(name)`: Get an `ObjectRef` to a player
|
||||||
* `minetest.get_objects_inside_radius(pos, radius)`
|
* `minetest.get_objects_inside_radius(pos, radius)`
|
||||||
|
* `radius`: using an euclidean metric
|
||||||
* `minetest.set_timeofday(val)`
|
* `minetest.set_timeofday(val)`
|
||||||
* `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
|
* `val` is between `0` and `1`; `0` for midnight, `0.5` for midday
|
||||||
* `minetest.get_timeofday()`
|
* `minetest.get_timeofday()`
|
||||||
* `minetest.get_gametime()`: returns the time, in seconds, since the world was created
|
* `minetest.get_gametime()`: returns the time, in seconds, since the world was created
|
||||||
* `minetest.find_node_near(pos, radius, nodenames)`: returns pos or `nil`
|
* `minetest.find_node_near(pos, radius, nodenames)`: returns pos or `nil`
|
||||||
|
* `radius`: using a maximum metric
|
||||||
* `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
|
* `nodenames`: e.g. `{"ignore", "group:tree"}` or `"default:dirt"`
|
||||||
* `minetest.find_nodes_in_area(minp, maxp, nodenames)`: returns a list of positions
|
* `minetest.find_nodes_in_area(minp, maxp, nodenames)`: returns a list of positions
|
||||||
* returns as second value a table with the count of the individual nodes found
|
* returns as second value a table with the count of the individual nodes found
|
||||||
@ -2039,7 +2041,7 @@ and `minetest.auth_reload` call the authetification handler.
|
|||||||
* returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
|
* returns a table of 3D points representing a path from `pos1` to `pos2` or `nil`
|
||||||
* `pos1`: start position
|
* `pos1`: start position
|
||||||
* `pos2`: end position
|
* `pos2`: end position
|
||||||
* `searchdistance`: number of blocks to search in each direction
|
* `searchdistance`: number of blocks to search in each direction using a maximum metric
|
||||||
* `max_jump`: maximum height difference to consider walkable
|
* `max_jump`: maximum height difference to consider walkable
|
||||||
* `max_drop`: maximum height difference to consider droppable
|
* `max_drop`: maximum height difference to consider droppable
|
||||||
* `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
|
* `algorithm`: One of `"A*_noprefetch"` (default), `"A*"`, `"Dijkstra"`
|
||||||
|
Loading…
Reference in New Issue
Block a user