Bay 12 Games Forum

-- Assign creatures to restraints
-- Jailer 1.1
-- Attempts to create job to assign creature to cage/chain
-- Fortress mode script called from DFHack, can use either the command line or a popup gui to select participants
-- LNP: [04410r03-x64]
-- GUI courtesy of scripts from warmist and Putnam
--  http://www.bay12forums.com/smf/index.php?topic=91166.msg4149991#msg4149991
--  http://www.bay12forums.com/smf/index.php?topic=139553.msg5858508#msg5858508
-- Many thanks to the inhabitants of Erithkosh, who suffered much during testing


local utils=require('utils')
local script=require('gui.script')

validArgs = utils.invert({
 'help',
 'nogui',
 'victim',
 'jailer',
 'restraint'
})

local args = utils.processArgs({...}, validArgs)
local cmdVictim = {}
local userVictim = {}
local cmdJailer = {}
local userJailer = {}
local cmdJail = {}
local userJail = {}


local helpme = [===[

jailer.lua
=========

This script should create a job to assign a creature to a cage/restraint. Creature IDs can be found with
cprobe, building IDs can be found with bprobe. The script can operate in two modes. When called without
arguments, it presents a gui allowing selection of the victim, jailer, and restraint. Called with arguments,
allows you directly specify targets. Note that non-citizens can only be targeted by the non-gui approach.
Note1: Restraints must be rooms, set to justice
Note2: Cages must be metal. At this time, it appears chains can be any material.

Caution! Assigning jobs to active military units occasionally causes crashes.

arguments:
    -help
        print this help message
    -nogui
        Do not use the gui for target selection. You must provide victim and aggressors arguments
    -victim
        Unit ID of the target (unit to be restrained)
    -jailer
        Unit ID of the dwarf that you want to chain up the victim.
   -restraint
      Building ID of the restraint/cage where the creature should be jailed

Examples
    jailer
        Launches gui
    jailer -nogui -victim 76 -jailer 79 -restraint 210
        Launches the script. Unit 79 gets a job aimed at restraining unit 76 on building id 210

]===]

-- Handle help requests
if args.help then
    print(helpme)
    return
end


-- Handle user input
if ( args.nogui and args.victim and args.jailer and args.restraint ) then

    table.insert(cmdVictim, args.victim)
    table.insert(cmdJailer, args.jailer)
   table.insert(cmdJail, args.restraint)
else
   print("Launching Cage gui. You might review -help")
end


function getLastJobLink()
   -- v43.03: Preserved for legacy uses
   -- local st=df.global.world.job_list
    -- v44.10
    local st=df.global.world.jobs.list
    while st.next~=nil do
        st=st.next
    end
    return st
end

function addNewJob(job)
    local nn=getLastJobLink()
    local nl=df.job_list_link:new()
    nl.prev=nn
    nn.next=nl
    nl.item=job
    job.list_link=nl
end

function jailUnit(unit1,unit2,restraint,jtype)
    local nj=df.job:new()
    nj.id=df.global.job_next_id
    df.global.job_next_id=df.global.job_next_id+1
    nj.flags.special=true

   -- jtype: 1-cage, 2-chain
    if jtype == 1 then
        nj.job_type=df.job_type.CageLargeCreature
    elseif jtype == 2 then
        nj.job_type=df.job_type.ChainAnimal
   else
      print("Bad jtype. Neither chain nor cage")
        qerror('Error: Bad jail type for job!. Neither chain nor cage?')
   end

    nj.completion_timer=-1
   nj.general_refs:insert("#",{new=df.general_ref_building_holderst,building_id=restraint.id})
    nj.general_refs:insert("#",{new=df.general_ref_unit_cageest,unit_id=unit2.id})                                   
    nj.general_refs:insert("#",{new=df.general_ref_unit_workerst,unit_id=unit1.id})
   
    addNewJob(nj)
    unit1.job.current_job=nj
end

function assignJail(unit2,jail,jtype)
   -- jtype: 1-cage, 2-chain
    if jtype == 1 then
       jail.assigned_units:insert("#",unit2.id)
    elseif jtype == 2 then
       jail.assigned = unit2
   else
      print("Bad jtype. Neither chain nor cage")
        qerror('Error: Bad jail for assignment!. Neither chain nor cage?')
   end
end

local function getCitizenList()
    local citizenTable={}
        for k,u in ipairs(df.global.world.units.active) do
            if dfhack.units.isCitizen(u) then
                table.insert(citizenTable,{dfhack.TranslateName(dfhack.units.getVisibleName(u)),nil,u})
            end
        end
    return citizenTable
end

local function getJailerList()
    local citizenTable={}
        for k,u in ipairs(df.global.world.units.active) do
            if dfhack.units.isCitizen(u) and u.military.squad_id < 0 then
                table.insert(citizenTable,{dfhack.TranslateName(dfhack.units.getVisibleName(u)),nil,u})
            end
        end
    return citizenTable
end

local function getJailList()
    local jailTable={}
        for k,u in ipairs(df.global.world.buildings.all) do
            if u.flags.justice == true then
            -- print("Jailer:Jail: ",k,utils.getBuildingName(u))
             if string.match(utils.getBuildingName(u), "Chain") and u.assigned == nil then
                table.insert(jailTable,{utils.getBuildingName(u),nil,u})
            elseif string.match(utils.getBuildingName(u), "Rope") and u.assigned == nil then
                table.insert(jailTable,{utils.getBuildingName(u),nil,u})
            elseif string.match(utils.getBuildingName(u), "Cage") then
                table.insert(jailTable,{utils.getBuildingName(u),nil,u})
            end
            end
        end
    return jailTable
end


local function jail(userVictim, userJailer, userJail)
    local unit1,unit2,jail = {}
   local jtype = 0

    for k, v in pairs(userVictim) do
        --print("Jailer:Victim: ",dfhack.units.getVisibleName(v))
        unit2 = v
    end

    for k, v in pairs(userJailer) do
        --print("Jailer:Jailer: ",dfhack.units.getVisibleName(v))
        unit1 = v
    end

   for k, v in pairs(userJail) do
      --print("Jailer:Jail: ",utils.getBuildingName(v))
      jail = v
      local jtest = utils.getBuildingName(v)

      if string.match(jtest, "Cage") then
         jtype = 1
      elseif string.match(jtest, "Rope") then
          jtype = 2
      elseif string.match(jtest, "Chain") then
         jtype = 2
      end
    end
   
   assignJail(unit2,jail,jtype)
   jailUnit(unit1,unit2,jail,jtype)

end

-- Let's do this
script.start(function()

    -- Get list of valid targets(citizens)
    local citizens=getCitizenList()
    -- Get list of valid aggressors(the mob)
    local jailers=getJailerList()
    local jails=getJailList()
   
    if #citizens==0 then
        script.showMessage('Jailer',"No citizens! Something is broken.",COLOR_WHITE)
        qerror('Error: No citizens! Something is broken.')
        return
    end
   
    if #jailers==0 then
        script.showMessage('Jailer',"No one can be the jailer!",COLOR_WHITE)
        qerror('Error: No jailer! Something is broken.')
        return
    end
 
    if #jails==0 then
        script.showMessage('Jailer',"No empty rooms for justice!",COLOR_WHITE)
        qerror('Error: No jails! No empty rooms for justice?')
        return
    end

    -- Gui in use
    if not args.nogui then
        -- Gui is in use, overwrite command line options specified
        userVictim = {}
        userJailer = {}
      userJail = {}
   
        -- Prompt for victim
        local ok2,name2,victim = script.showListPrompt("Jailer","Choose the victim",COLOR_WHITE,citizens)
        local isVictim = victim[3]
        table.insert(userVictim, victim[3])
   
        -- Prompt for jailer
        userAggressors = {}
        local ok2,name2,jailer = script.showListPrompt("Jailer","Choose the jailer",COLOR_WHITE,citizens)
        table.insert(userJailer, jailer[3])

        -- Prompt for jail
        local ok2,name2,jail = script.showListPrompt("Jailer","Choose the jail",COLOR_WHITE,jails)
        table.insert(userJail, jail[3])

   -- Gui not in use
    else
        for k, v in pairs(cmdVictim) do
            table.insert(userVictim, df.unit.find(v))
        end

        for k, v in pairs(cmdJailer) do
            table.insert(userJailer, df.unit.find(v))
        end

        for k, v in pairs(cmdJail) do
            table.insert(userJail, df.building.find(v))
        end

    end
   
    print("Victim: " .. #userVictim .. " Jailer: " .. #userJailer .. " Jail: " .. #userJail)

    -- Restrain some folks!
    jail(userVictim, userJailer, userJail)

end)

-- Start fights and hands out beatings
-- Aggressor 1.3
-- Attempts to start a fistfight or beatcriminal job
-- Fortress mode script called from DFHack, can use either the command line or a popup gui to select participants
-- LNP: [04410r3-x64]
-- GUI Courtesy of scripts from warmist, and Putnam
--  http://www.bay12forums.com/smf/index.php?topic=91166.msg4149991#msg4149991
--  http://www.bay12forums.com/smf/index.php?topic=139553.msg5858508#msg5858508
-- Many thanks to the inhabitants of Erithkosh, who suffered much during testing


local utils=require('utils')
local script=require('gui.script')

validArgs = utils.invert({
 'help',
 'verbose',
 'nogui',
 'victim',
 'aggressors',
 'death'
})

local args = utils.processArgs({...}, validArgs)
local verbose = false
local userVictim = {}
local cmdVictim = {}
local userAggressors = {}
local cmdAggressors = {}
local userFType = {}
local cmdFType = {}

local helpme = [===[

aggressor.lua
=========

This script creates a StartFistFighting or BeatCriminal job for one or more dwarves aimed at
a single target. The script can operate in two modes. When called without arguments, it
presents a gui allowing selection of the victim and the aggressor(s). Called with arguments,
allows you directly specify victim and aggressor targets. Unit IDs can be discovered with cprobe.

Caution! Some aggressors may crash DF. Crashes appear related to active military as aggressors.

arguments:
    -help
        print this help message
    -nogui
        Do not use the gui for target selection. You must provide victim and aggressors arguments
    -victim
        The fistfight target's unit id.
    -aggressors
        Unit id of the dwarf that you want to beat up the target. Also takes everyone, butme, or a
        comma separated list of unit id's. See examples.
   -death
       Integer. 0 is a less lethal fistfight, 1 is to the death
   -verbose
      Flag. Prints out a lot of stuff

Examples
    aggressor
        Launches gui
    aggressor -nogui -victim 76 -aggressors 79 -death 0
        Launches the script. Unit 79 gets a StartFistFighting job aimed at unit 76
    aggressor -nogui -victim 76 -aggressors 79,80 -death 0
        Launches the script. Units 79,80 get a StartFistFighting job aimed at unit 76
    aggressor -nogui -victim 76 -aggressors 79 -death 1
        Launches the script. Unit 79 gets a BeatCriminal job aimed at unit 76
   aggressor -nogui -victim 76 -aggressors everyone -death 0
        Launches the script. Citizens (including 76) get a StartFistFighting job aimed at unit 76
    aggressor -nogui -victim 76 -aggressors butme -death 0
        Launches the script. Citizens (not including 76) get a StartFistFighting job aimed at unit 76

]===]

-- Handle help requests
if args.help then
    print(helpme)
    return
end

-- Handle user input
if ( args.verbose ) then
    verbose = true
end

-- Handle user input
if ( args.nogui and args.victim and args.aggressors and args.death) then

    -- Set CommandLine Victim
    table.insert(cmdVictim, args.victim)

   -- Set CommandLine Attackers
    for i in (args.aggressors .. ","):gmatch("([^,]*),") do
        -- print(i)
        table.insert(cmdAggressors, i)
    end
   
   -- Set CommandLine Fight Type
   cmdFType = args.death
   
else
   print("Launching Aggressor gui. You might want to review -help.")
end


function getLastJobLink()
   -- v43.03: Preserved for legacy uses
   -- local st=df.global.world.job_list
    -- v44.10r3
    local st=df.global.world.jobs.list
    while st.next~=nil do
        st=st.next
    end
    return st
end

function addNewJob(job)
    local nn=getLastJobLink()
    local nl=df.job_list_link:new()
    nl.prev=nn
    nn.next=nl
    nl.item=job
    job.list_link=nl
end

function startFight(unit1,unit2,ftype)
    local nj=df.job:new()
    nj.id=df.global.job_next_id
    df.global.job_next_id=df.global.job_next_id+1
    nj.flags.special=true
   ftype = tonumber(ftype)
   
   -- ftype: 0-fistfight, 1-beatcriminal
    if ftype == 0 then
        nj.job_type=df.job_type.StartingFistFight
    elseif ftype == 1 then
        nj.job_type=df.job_type.BeatCriminal
   else
        qerror('Error: Bad fight type for job!. Neither fist nor beat?')
   end
    nj.completion_timer=-1
    nj.general_refs:insert("#",{new=df.general_ref_unit_beateest,unit_id=unit2.id})                                   
    nj.general_refs:insert("#",{new=df.general_ref_unit_workerst,unit_id=unit1.id})
   
    addNewJob(nj)
    unit1.job.current_job=nj
end

local function makeFightGroup()
    -- Add Fight Types for prompt
   
    local FightGroup={}
    table.insert(FightGroup,{'Fist Fight (Less Lethal)',nil,0})
    table.insert(FightGroup,{'Beating (Lethal)',nil,1})

    return FightGroup
end

local function getCitizenList()
    local citizenTable={}
        for k,u in ipairs(df.global.world.units.active) do
            if dfhack.units.isCitizen(u) then
                table.insert(citizenTable,{dfhack.TranslateName(dfhack.units.getVisibleName(u)),nil,u})
            end
        end
    return citizenTable
end

local function getMobList()
    local citizenTable={}
        for k,u in ipairs(df.global.world.units.active) do
            if dfhack.units.isCitizen(u) and u.military.squad_id < 0 then
                table.insert(citizenTable,{dfhack.TranslateName(dfhack.units.getVisibleName(u)),nil,u})
            end
        end
    return citizenTable
end


local function makeAggressorGroup()
    -- Add multiple aggressor options
   
    local AggGroup={}
    table.insert(AggGroup,{'Everyone',nil,'Everyone'})
    table.insert(AggGroup,{'Everyone But Self',nil,'ButMe'})
    table.insert(AggGroup,{'From List',nil,'FromList'})

    return AggGroup
end

local function setAggressors(crowd, userVictim, check)
    for k, v in pairs(userVictim) do
        if verbose then print("SetAgg:Victim: ",k,v) end
        isVictim = v
    end

    local passAggressors = {}

    if string.lower(check) == string.lower('Everyone') then
        for k, v in pairs(crowd) do
            if verbose then print("SetAgg:EV1:Aggressor: " .. v[1]) end
            table.insert(passAggressors, v[3])
        end
    elseif string.lower(check) == string.lower('ButMe') then
        for k, v in pairs(crowd) do
            if v[3] ~= isVictim then
                if verbose then print("SetAgg:BMe:Aggressor: " .. v[1]) end
                table.insert(passAggressors, v[3])
            end
        end
    end

    return passAggressors
end

local function aggressor(userVictim, userAggressors, ftype)
    local unit1,unit2 = {}
    for k, v in pairs(userVictim) do
        if verbose then print("Aggro:Victim: ",k,v) end
        unit2 = v
    end

    for k, v in pairs(userAggressors) do
        if verbose then print("Aggro:Aggressor: ",k,v,ftype) end
        local unit1 = v
        startFight(unit1, unit2, ftype)
    end
end

-- Let's do this
script.start(function()

    -- Get list of valid targets(citizens)
    local citizens=getCitizenList()
    -- Get list of valid aggressors(the mob)
    local mob=getMobList()
    local AggressorGroup=makeAggressorGroup()
   local fightstyle=makeFightGroup()
   local ftype = 0
   
    if #citizens==0 then
        script.showMessage('Aggressor',"No citizens! Something is broken.",COLOR_WHITE)
        qerror('Error: No citizens! Something is broken.')
        return
    end
   
    if #mob==0 then
        script.showMessage('Aggressor',"No one in the mob! Maybe everyone is in the military?.",COLOR_WHITE)
        qerror('Error: No mob! Something is broken.')
        return
    end

    if #fightstyle==0 then
        script.showMessage('Aggressor',"No kinds of fights!",COLOR_WHITE)
        qerror('Error: No kinds of fights! Something is broken.')
        return
    end
   
    -- Gui in use
    if not args.nogui then
        -- Gui is in use, overwrite command line options specified
      if verbose then print("GUI in use, overwriting any command line options...") end
        userVictim = {}
        userAggressors = {}

      -- Prompt for fight type
        local ok2,name2,fstyle = script.showListPrompt("Aggressor","Choose the fight type",COLOR_WHITE,fightstyle)
        ftype = fstyle[3]
      if verbose then print("Lst:Type: ", ftype) end
      
        -- Prompt for victim
        local ok2,name2,victim = script.showListPrompt("Aggressor","Choose the victim",COLOR_WHITE,citizens)
        local isVictim = victim[3]
        table.insert(userVictim, victim[3])
   
        -- Prompt for aggressor_group
        userAggressors = {}
        local ok2,name,ag = script.showListPrompt("Aggressor","Choose the aggressors",COLOR_WHITE,AggressorGroup)
        local check = ag[3]
   
        if string.lower(check) == string.lower('Everyone') then
            userAggressors = setAggressors(mob, userVictim, check)       
        elseif string.lower(check) == string.lower('ButMe') then
            userAggressors = setAggressors(mob, userVictim, check)       
        elseif string.lower(check) == string.lower('FromList') then
            table.insert(mob,{'Done',nil,'Done'})
            local endwatch = ''
            local target = ''
            while endwatch ~= 'Done' do
                for k, v in pairs(mob) do
                    if v[3] == target then
                        if verbose then print("Lst:Aggressor: " .. v[1]) end
                        table.insert(userAggressors, v[3])
                        table.remove(mob,k)
                    end
                end
                local ok2,name2,aggressor=script.showListPrompt("Aggressor","Choose aggressors. Done to Finish",COLOR_WHITE,mob)
                if verbose then print("User choice: ", aggressor[1], aggressor[3]) end
                endwatch = aggressor[1]
                target = aggressor[3]
            end
        else
            -- How?!
            qerror('Error: Bad selection in Aggressor Group.')
        end
   


    else
        -- Gui not in use

        for k, v in pairs(cmdVictim) do
            table.insert(userVictim, df.unit.find(v))
        end

        for k, v in pairs(cmdAggressors) do
            local check = cmdAggressors[k]
            -- print("NoGUI:Aggro",check)
            if string.lower(check) == string.lower('Everyone') then
                userAggressors = setAggressors(mob, userVictim, check)       
            elseif string.lower(check) == string.lower('ButMe') then
                userAggressors = setAggressors(mob, userVictim, check)       
            elseif tonumber(check) ~= nil then
                table.insert(userAggressors, df.unit.find(check))
            else
                qerror('Error: Unhandled nogui aggressor type.')
            end
        end
      
      ftype = cmdFType
    end
   
    print("Victims: " .. #userVictim .. " Aggressors: " .. #userAggressors .. " Type:" .. ftype)

    -- Start some fights
    aggressor(userVictim, userAggressors, ftype)

end)