From 2502d46e7a1b766ec48d50995cac3533189d4b7b Mon Sep 17 00:00:00 2001 From: Myk Taylor Date: Fri, 7 Mar 2025 16:45:10 -0800 Subject: [PATCH] light cleanup --- colonies.lua | 21 +-------------------- devel/light.lua | 11 ----------- docs/colonies.rst | 2 +- gui/companion-order.lua | 24 ------------------------ launch.lua | 7 ------- teleport.lua | 25 ------------------------- 6 files changed, 2 insertions(+), 88 deletions(-) diff --git a/colonies.lua b/colonies.lua index 48b8094d83..2672b66ab9 100644 --- a/colonies.lua +++ b/colonies.lua @@ -1,25 +1,6 @@ -- List, create, or change wild colonies (eg honey bees) -- By PeridexisErrant and Warmist -local help = [====[ - -colonies -======== -List vermin colonies, place honey bees, or convert all vermin -to honey bees. Usage: - -:colonies: List all vermin colonies on the map. -:colonies place: Place a honey bee colony under the cursor. -:colonies convert: Convert all existing colonies to honey bees. - -The ``place`` and ``convert`` subcommands by default create or -convert to honey bees, as this is the most commonly useful. -However both accept an optional flag to use a different vermin -type, for example ``colonies place ANT`` creates an ant colony -and ``colonies convert TERMITE`` ends your beekeeping industry. - -]====] - local guidm = require('gui.dwarfmode') function findVermin(target_verm) @@ -71,7 +52,7 @@ local args = {...} local target_verm = args[2] or "HONEY_BEE" if args[1] == 'help' or args[1] == '?' then - print(help) + print(dfhack.script_help()) elseif args[1] == 'convert' then convert_vermin_to(target_verm) elseif args[1] == 'place' then diff --git a/devel/light.lua b/devel/light.lua index 3786a26976..ff56e34c30 100644 --- a/devel/light.lua +++ b/devel/light.lua @@ -1,16 +1,5 @@ -- an experimental lighting engine ---[====[ -devel/light -=========== -An experimental lighting engine for DF, using the `rendermax` plugin. - -Call ``devel/light static`` to not recalculate lighting when in game. -Press :kbd:`~` to recalculate lighting. Press :kbd:`\`` to exit. - -]====] - -local gui = require 'gui' local guidm = require 'gui.dwarfmode' local render = require 'plugins.rendermax' diff --git a/docs/colonies.rst b/docs/colonies.rst index e778692162..cebdc69db6 100644 --- a/docs/colonies.rst +++ b/docs/colonies.rst @@ -3,7 +3,7 @@ colonies .. dfhack-tool:: :summary: Manipulate vermin colonies and hives. - :tags: fort armok map + :tags: adventure fort armok map Usage ----- diff --git a/gui/companion-order.lua b/gui/companion-order.lua index 814b4d9d8a..310bf5d194 100644 --- a/gui/companion-order.lua +++ b/gui/companion-order.lua @@ -1,28 +1,4 @@ -- Issue orders to companions in Adventure mode ---[====[ - -gui/companion-order -=================== -A script to issue orders for companions. Select companions with lower case chars (green when selected), issue orders with upper -case. Must be in look or talk mode to issue command on tile (e.g. move/equip/pick-up). - -.. image:: /docs/images/companion-order.png - -* move - orders selected companions to move to location. If companions are following they will move no more than 3 tiles from you. -* equip - try to equip items on the ground. -* pick-up - try to take items into hand (also wield) -* unequip - remove and drop equipment -* unwield - drop held items -* wait - temporarily remove from party -* follow - rejoin the party after "wait" -* leave - remove from party (can be rejoined by talking) - -Can be called with '-c' flag to display "cheating" commands. - -* patch up - fully heals the companion -* get in - rides e.g. minecart at cursor. Bit buggy as unit will teleport to the item when e.g. pushing it. - -]====] local gui = require 'gui' local guidm = require 'gui.dwarfmode' diff --git a/launch.lua b/launch.lua index 40aaf26995..942dde409e 100644 --- a/launch.lua +++ b/launch.lua @@ -1,13 +1,6 @@ -- Launch unit to cursor location -- Based on propel.lua by Roses, molested by Rumrusher and I until this happened, sorry. ---[====[ -launch -====== -Activate with a cursor on screen and you will go there rapidly. Attack -something first to ride them there. - -]====] local guidm = require('gui.dwarfmode') function launch(unitSource,unitRider) diff --git a/teleport.lua b/teleport.lua index 108f7e8673..8c7f052d38 100644 --- a/teleport.lua +++ b/teleport.lua @@ -2,31 +2,6 @@ -- author Putnam -- edited by expwnent --@module = true ---[====[ - -teleport -======== -Teleports a unit to given coordinates. - -.. note:: - - `gui/teleport` is an in-game UI for this script. - -Examples: - -* prints ID of unit beneath cursor:: - - teleport -showunitid - -* prints coordinates beneath cursor:: - - teleport -showpos - -* teleports unit ``1234`` to ``56,115,26`` - - teleport -unit 1234 -x 56 -y 115 -z 26 - -]====] local guidm = require('gui.dwarfmode')