clean up force and modtools/force

myk002 · myk002 · commit 5317e71592ec · 2023-02-12T23:53:17.000-08:00
and prevent crashy FeatureAttack events
diff --git a/docs/force.rst b/docs/force.rst
@@ -37,7 +37,6 @@ The recognized event types are:
 - ``Caravan``
 - ``Migrants``
 - ``Diplomat``
-- ``FeatureAttack`` (Underworld incursion)
 - ``Megabeast``
 - ``WildlifeCurious``
 - ``WildlifeMischievous``
diff --git a/force.lua b/force.lua
@@ -1,25 +1,11 @@
 -- Forces an event (wrapper for modtools/force)
---[====[
-
-force
-=====
-A simpler wrapper around the `modtools/force` script.
-
-Usage:
-
-- ``force event_type``
-- ``force event_type civ_id`` - civ ID required for ``Diplomat`` and ``Caravan``
-  events
-
-See `modtools/force` for a complete list of event types.
-
-]====]
 
 local utils = require 'utils'
 local args = {...}
 if #args < 1 then qerror('missing event type') end
 if args[1]:find('help') then
-    return print(dfhack.script_help())
+    print(dfhack.script_help())
+    return
 end
 local eventType = nil
 for _, type in ipairs(df.timed_event_type) do
diff --git a/modtools/force.lua b/modtools/force.lua
@@ -1,34 +1,6 @@
 -- Forces an event (caravan, migrants, etc)
 -- author Putnam
 -- edited by expwnent
-local help = [====[
-
-modtools/force
-==============
-This tool triggers events like megabeasts, caravans, and migrants.
-
-Usage::
-
-    -eventType event
-        specify the type of the event to trigger
-        examples:
-            Megabeast
-            Migrants
-            Caravan
-            Diplomat
-            WildlifeCurious
-            WildlifeMischievous
-            WildlifeFlier
-            NightCreature
-    -civ entity
-        specify the civ of the event, if applicable
-        examples:
-            player
-            MOUNTAIN
-            EVIL
-            28
-
-]====]
 local utils = require 'utils'
 
 local function findCiv(arg)
@@ -50,15 +22,16 @@ local validArgs = utils.invert({
 
 local args = utils.processArgs({...}, validArgs)
 if args.help then
- print(help)
- print('force: -eventType [Megabeast, Migrants, Caravan, Diplomat, WildlifeCurious, WildlifeMischievous, WildlifeFlier, NightCreature] -civ [player,ENTITY_ID]')
+ print(dfhack.script_help())
  return
 end
 
 if not args.eventType then
  error 'Specify an eventType.'
 elseif not df.timed_event_type[args.eventType] then
  error('Invalid eventType: ' .. args.eventType)
+elseif args.eventType == 'FeatureAttack' then
+ qerror('Event type: FeatureAttack is not currently supported')
 end
 
 local civ = nil --as:df.historical_entity
