Skip to content

Commit

Permalink
Add doc_items help.
Browse files Browse the repository at this point in the history
  • Loading branch information
linewriter1024 committed Jun 17, 2021
1 parent 65d6773 commit 6d6e696
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
7 changes: 7 additions & 0 deletions components.lua
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ end

minetest.register_node("elevator:shaft", {
description = "Elevator Shaft",
_doc_items_longdesc = "An elevator shaft that connects elevators to other elevators and motors.",
_doc_items_usagehelp = "Building a vertical stack of elevators and shafts with an elevator motor on top allows vertical transportation.",
tiles = { moditems.el_shaft_gfx },
drawtype = "nodebox",
use_texture_alpha = "clip",
Expand Down Expand Up @@ -117,6 +119,8 @@ minetest.register_node("elevator:shaft", {

minetest.register_node("elevator:motor", {
description = "Elevator Motor",
_doc_items_longdesc = "The engine powering an elevator shaft. Placed at the top.",
_doc_items_usagehelp = "Place the motor on the top of a stack of elevators and elevator shafts. The elevators will activate and you can then use them.",
tiles = {
moditems.steel_block_image,
moditems.steel_block_image,
Expand Down Expand Up @@ -235,6 +239,9 @@ for _,mode in ipairs({"on", "off"}) do
on_rotate = moditems.on_rotate_disallow,
climbable = true,

_doc_items_longdesc = on and "An active elevator, ready for transporting." or "An inactive elevator, not connected to a motor.",
_doc_items_usagehelp = on and "Step inside this elevator and use it (right-click) to be transported to any other elevator along the shaft." or "This elevator is inactive; it is disconnected from a motor. It may be extended with shafts and other elevators in a vertical line with an elevator motor on top to power the whole shaft and enable transport.",

selection_box = {
type = "fixed",
fixed = box,
Expand Down
2 changes: 1 addition & 1 deletion mod.conf
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name = elevator
description = An entity-based elevator allowing fast realtime travel in Minetest. Supports Minetest Game, MineClone2, and Aurum
optional_depends = default, technic, homedecor, chains, farming, mcl_core, mcl_sounds, aurum, screwdriver
optional_depends = default, technic, homedecor, chains, farming, mcl_core, mcl_sounds, aurum, screwdriver, doc_items
min_minetest_version = 5.4

0 comments on commit 6d6e696

Please sign in to comment.