Merge branch 'sci-gym-script' into SquidHack

Author: realSquidCoder

autotraining.lua

@@ -94,10 +94,6 @@ dfhack.onStateChange[GLOBAL_KEY] = function(sc)
     else
         stop()
     end
-    -- start can change the enabled state if the squad cant be found
-    if state.enabled then
-        dfhack.print(GLOBAL_KEY .." was persisted with the following data:\nThreshold: ".. state.threshold .. '\n')
-    end
     persist_state()
 end
 
@@ -207,11 +203,7 @@ function addTraining(unit)
     for _, squad in ipairs(getTrainingSquads()) do
         for i=1,9,1   do
             if ( squad.positions[i].occupant  == -1 ) then
-                dfhack.military.addToSquad(unit.id,squad.id,i)
-                -- squad.positions[i].occupant = unit.hist_figure_id
-                -- unit.military.squad_id = squad.id
-                -- unit.military.squad_position = i
-                return true
+                return dfhack.military.addToSquad(unit.id,squad.id,i)
             end
         end
     end
@@ -223,11 +215,7 @@ function removeTraining(unit)
     for _, squad in ipairs(getTrainingSquads()) do
         for i=1,9,1   do
             if ( unit.hist_figure_id  == squad.positions[i].occupant ) then
-                dfhack.military.removeFromSquad(unit.id)
-                -- unit.military.squad_id = -1
-                -- unit.military.squad_position = -1
-                -- squad.positions[i].occupant = -1
-                return true
+                return dfhack.military.removeFromSquad(unit.id)
             end
         end
     end
@@ -277,7 +265,7 @@ function start()
     if (args.t) then
         state.threshold = 0-tonumber(args.t)
     end
-    repeatUtil.scheduleEvery(GLOBAL_KEY, 1, 'days', check) -- 997 is the closest prime to 1000
+    repeatUtil.scheduleEvery(GLOBAL_KEY, 1, 'days', check)
 end
 
 function stop()

docs/autotraining.rst

@@ -5,11 +5,11 @@ autotraining
     :summary: Assigns citizens to a military squad until they have fulfilled their need for Martial Training
     :tags: fort auto bugfix units
 
-Automation script for citizens to hit the gym when they yearn for the gains. Also passively builds military skills and physical stats.
+This script automatically assigns citizens with the need for military training to designated training squads.
 
-You need to have at least one squad that is set up for training. This should be a new non-military-use squad. The uniform should be
-set to "No Uniform" and the squad should be set to "Constant Training" in the military screen. Edit the squad's schedule to full time training with around 8 units training.
-The squad doesn't need months off. The members leave the squad once they have gotten their gains.
+You need to have at least one squad that is set up for training. The squad should be set to "Constant Training" in the military screen. The squad doesn't need months off. The members leave the squad once they have satisfied their need for military training.
+
+The configured uniform determines the skills that are acquired by the training dwarves. Providing "No Uniform" is a perfectly valid choice and will make your militarily inclined civilians become wrestlers over time. However, you can also provide weapons and armor to pre-train civilians for future drafts.
 
 Once you have made squads for training use `gui/autotraining` to select the squads and ignored units, as well as the needs threshhold.
 
@@ -25,10 +25,10 @@ Examples
     Current status of script
 
 ``enable autotraining``
-    Checks to see if you have fullfilled the creation of a training gym.
+    Checks to see if you have fullfilled the creation of a training squad.
     If there is no squad marked for training use, a clickable notification will appear letting you know to set one up/
-    Searches your fort for dwarves with a need to go to the gym, and begins assigning them to said gym.
-    Once they have fulfilled their need they will be removed from the gym squad to be replaced by the next dwarf in the list.
+    Searches your fort for dwarves with a need for military training, and begins assigning them to a training squad.
+    Once they have fulfilled their need they will be removed from their squad to be replaced by the next dwarf in the list.
 
 ``disable autotraining``
     Stops adding new units to the squad.

internal/control-panel/registry.lua

@@ -35,7 +35,7 @@ COMMANDS_BY_IDX = {
         params={'--time', '14', '--timeUnits', 'days', '--command', '[', 'workorder', 'ShearCreature', ']'}},
     {command='autoslab', group='automation', mode='enable'},
     {command='autotraining', group='automation', mode='enable',
-        desc='Automation script for citizens to hit the gym when they yearn for the gains.'},
+        desc='Automatically assign units with training needs to training squads. '},
     {command='ban-cooking all', group='automation', mode='run'},
     {command='buildingplan set boulders false', group='automation', mode='run',
         desc='Enable if you usually don\'t want to use boulders for construction.'},