summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZughy <63455151+Zughy@users.noreply.github.com>2021-01-21 17:37:38 +0000
committerGitHub <noreply@github.com>2021-01-21 18:37:38 +0100
commitea5d6312c1ab6ff3e859fcd7a429a384f0f0ff91 (patch)
tree457238c0883bc873810ed7365f1c5b65f8d3d601 /doc
parentd92da47697a2520f50c1324fcff11617770deb32 (diff)
downloadminetest-ea5d6312c1ab6ff3e859fcd7a429a384f0f0ff91.tar.gz
minetest-ea5d6312c1ab6ff3e859fcd7a429a384f0f0ff91.tar.bz2
minetest-ea5d6312c1ab6ff3e859fcd7a429a384f0f0ff91.zip
ObjectRef: fix some v3f checks (#10602)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt23
1 files changed, 12 insertions, 11 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 4ef67261a..317bbe577 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -6239,21 +6239,22 @@ object you are working with still exists.
`frame_loop`.
* `set_animation_frame_speed(frame_speed)`
* `frame_speed`: number, default: `15.0`
-* `set_attach(parent, bone, position, rotation, forced_visible)`
- * `bone`: string
- * `position`: `{x=num, y=num, z=num}` (relative)
- * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees
+* `set_attach(parent[, bone, position, rotation, forced_visible])`
+ * `bone`: string. Default is `""`, the root bone
+ * `position`: `{x=num, y=num, z=num}`, relative, default `{x=0, y=0, z=0}`
+ * `rotation`: `{x=num, y=num, z=num}` = Rotation on each axis, in degrees.
+ Default `{x=0, y=0, z=0}`
* `forced_visible`: Boolean to control whether the attached entity
- should appear in first person.
+ should appear in first person. Default `false`.
* `get_attach()`: returns parent, bone, position, rotation, forced_visible,
or nil if it isn't attached.
* `get_children()`: returns a list of ObjectRefs that are attached to the
object.
* `set_detach()`
-* `set_bone_position(bone, position, rotation)`
- * `bone`: string
- * `position`: `{x=num, y=num, z=num}` (relative)
- * `rotation`: `{x=num, y=num, z=num}`
+* `set_bone_position([bone, position, rotation])`
+ * `bone`: string. Default is `""`, the root bone
+ * `position`: `{x=num, y=num, z=num}`, relative, `default {x=0, y=0, z=0}`
+ * `rotation`: `{x=num, y=num, z=num}`, default `{x=0, y=0, z=0}`
* `get_bone_position(bone)`: returns position and rotation of the bone
* `set_properties(object property table)`
* `get_properties()`: returns object property table
@@ -6581,8 +6582,8 @@ object you are working with still exists.
* `frame_speed` sets the animations frame speed. Default is 30.
* `get_local_animation()`: returns idle, walk, dig, walk_while_dig tables and
`frame_speed`.
-* `set_eye_offset(firstperson, thirdperson)`: defines offset vectors for camera
- per player.
+* `set_eye_offset([firstperson, thirdperson])`: defines offset vectors for
+ camera per player. An argument defaults to `{x=0, y=0, z=0}` if unspecified.
* in first person view
* in third person view (max. values `{x=-10/10,y=-10,15,z=-5/5}`)
* `get_eye_offset()`: returns first and third person offsets.