mirror of
https://github.com/minetest-mods/ropes.git
synced 2024-11-24 16:33:48 +01:00
32 lines
3.7 KiB
Lua
32 lines
3.7 KiB
Lua
vines.doc = {}
|
|
|
|
if not minetest.get_modpath("doc") then
|
|
return
|
|
end
|
|
|
|
vines.doc.vines_longdesc = "Sinuous plants that grows on other plants for support."
|
|
vines.doc.roots_longdesc = "Plant structures that provide structural support and draw nutrients from the soil."
|
|
vines.doc.vines_usage = "These grow over time. When harvested with shears they provide useful crafting materials."
|
|
|
|
vines.doc.shears_longdesc = "A tool for harvesting vines."
|
|
vines.doc.shears_usage = "Using shears to dig vines will give vine materials useful for crafting. Other tools lack the necessary finesse. Shears can also sever hanging ropes."
|
|
|
|
vines.doc.ropesegment_longdesc = "Rope segments are bundles of fibre twisted into robust cables."
|
|
vines.doc.ropesegment_usage = "This craft item is useful for creating rope ladders, or for spooling on wooden spindles to hang and climb upon."
|
|
|
|
vines.doc.ropeladder_longdesc = "A hanging rope ladder that automatically extends downward"
|
|
vines.doc.ropeladder_usage = "After a rope ladder is placed on a vertical wall it will begin extending downward until it reaches its maximum length (" .. tostring(vines.ropeLadderLength) .. "m). If the rope ladder is removed all of the ladder below the point of removal will disappear. A rope ladder can be severed partway down using an axe or similar tool, and the ladder below the point where it is cut will collapse. No rope is actually lost in the process, though, and if the uppermost section of the ladder is removed and replaced the ladder will re-extend to the same maximum length as before."
|
|
|
|
vines.doc.ropebox_longdesc = "Ropes are hung by placing rope boxes, which automatically lower a rope of fixed length below them. They can be climbed and cut."
|
|
vines.doc.ropebox_usage = "Rope boxes have a certain amount of rope contained within them specified in the name of the node. They come in five standard lengths " ..
|
|
string.format("(%dm, %dm, %dm, %dm and %dm)", vines.ropeLength, vines.ropeLength*2, vines.ropeLength*3, vines.ropeLength*4, vines.ropeLength*5) ..
|
|
" that can be crafted by combining and splitting up rope boxes in the crafting grid. For example, you can craft a " .. tostring(vines.ropeLength*2) .. "m rope box by combining two " .. tostring(vines.ropeLength) .. "m rope boxes, and the two " .. tostring(vines.ropeLength) .. "m rope boxes can be recovered by splitting it back up in the crafting grid.\n\n" ..
|
|
"When a rope box is placed the rope will immediately begin lowering from it at one meter per second. The rope will only descend when its end is in the vicinity of an active player, suspending its journey when no players are nearby, so a long descent may require a player to climb down the rope as it goes. Take care not to fall off the end! The rope will stop when it encounters and obstruction, but will resume lowering if the obstruction is removed.\n\n" ..
|
|
"A rope can be severed midway using an axe or other similar tools. The section of rope below the cut will collapse and disappear, potentially causing players who were hanging on to it to fall. The remaining rope will not resume descent on its own, but the rope box at the top of the rope \"remembers\" how long the rope was and if it is deconstructed and replaced it will still have the same maximum length of rope as before - no rope is permnanently lost when a rope is severed like this."
|
|
|
|
doc.add_entry_alias("nodes", "vines:ropeladder_top", "nodes", "vines:ropeladder")
|
|
doc.add_entry_alias("nodes", "vines:ropeladder_top", "nodes", "vines:ropeladder_bottom")
|
|
doc.add_entry_alias("nodes", "vines:ropeladder_top", "nodes", "vines:ropeladder_falling")
|
|
|
|
doc.add_entry_alias("nodes", "vines:rope", "nodes", "vines:rope_bottom")
|
|
doc.add_entry_alias("nodes", "vines:rope", "nodes", "vines:rope_top") |