Added bodyswap.lua

[AtomicChicken]

A revived version of the long defunct "adv-bodyswap" with some added functionality.

This script allows the player to swap their control over to any unit present on the map in adventure mode. Targets are specified either via their unit id or through UI selection prior to running the script (as detailed in the script usage documentation). Unlike previous iterations, units lacking nemesis or historical figure data (such as wild animals) are valid and safe targets, as the script creates this data when it is missing using functions from modtools/create-unit.

[lethosor]

Are the functions taken from modtools/create-unit directly or modified slightly? If it's the former, you should probably use reqscript('modtools/create-unit') instead of copying them. Otherwise, maybe adding library functions would be good to avoid large chunks of repeated code.

[lethosor]

losing

[lethosor]

I don't think two versions of the documentation is ideal. Sphinx should pick up anything between [====[ and ]====], even if it's a string instead of a comment (see repeat, spawnunit, and lots of modtools scripts for examples).

[AtomicChicken]

I don't recall carrying out any major alterations on the create-unit functions, so using reqscript and supplementing where necessary is indeed a better idea.

I was not aware of the documentation issue; thank you for clarifying it. Is either of the two versions preferred? If not, I'll remove the first one.

Edit: submitted PR #56 to allow calling of reqscript('modtools/create-unit').createNemesis() .

[lethosor]

I think you could probably use utils.binsearch_in_vector(activeUnits, oldUnitIndex, field) here and elsewhere (but haven't tried). It would be better than repeating this, anyway.

[AtomicChicken]

The API mentions a utils.binsearch(vector,key,field,cmpfun,min,max) which I'm assuming is what you're referring to. I'm not sure I understand how to use it in this context.

[lethosor]

Yeah, binsearch_in_vector is the C++ name. utils.binsearch(activeUnits, oldUnit.id, 'id') (yeah, I screwed up my earlier example) returns unit, true, index if it was found. select(3, utils.binsearch...) would give you the index if the unit was found, but the index of another unit otherwise, so something like this might be better:

_, found, oldUnitIndex = utils.binsearch(activeUnits, oldUnit.id, 'id')
if not found then qerror('old unit not found') end
-- find newUnitIndex, swap, etc.

[AtomicChicken]

Thanks for the example!
Unless I'm messing something up, it seems that utils.binsearch isn't working reliably; it sometimes returns failure values (found == false, etc) consistently for certain cases and I have no idea why.

I'm running this in-game (in a well-populated town in adventure mode) for testing purposes. It should help illustrate my point:

utils = require 'utils'
local activeUnits = df.global.world.units.active
for _,unit in ipairs(activeUnits) do
  print(utils.binsearch(activeUnits,unit.id,'id'))
end

[lethosor]

Hm, is it not sorted by id? I thought that was how df.unit.find() worked... can you try also checking df.unit.find(unit.id)==unit? Not sure if I have an adventure save handy.

[lethosor]

I haven't been able to reproduce this in adventure mode with ~100 active units

[AtomicChicken]

utils = require 'utils'
local activeUnits = df.global.world.units.active
for _,unit in ipairs(activeUnits) do
  print(utils.binsearch(activeUnits,unit.id,'id'))
  print(df.unit.find(unit.id) == unit)
  print('---')
end

Indicates that df.unit.find(unit.id) is working fine where utils.binsearch is not.

Just creating a new adventure save and running this at the spawn town would probably be sufficient, as it's what I'm doing.

[lethosor]

That's what I did too

[AtomicChicken]

Oh, I missed the previous reply. That's really quite strange. Mind you, failed cases have been a minority thus far; did you look through the entire output?

Edit: modified for better clarity:

utils = require 'utils'
local activeUnits = df.global.world.units.active
for i,unit in ipairs(activeUnits) do
  local _,found,unitIndex = utils.binsearch(activeUnits,unit.id,'id')
  if not found then print('Not found! '..i) end
end

[lethosor]

The second column was all trues. I'll see if I can find a bigger city or something.

[AtomicChicken]

I don't understand Travis. Any indications as to what the issue is?

[lethosor]

$ python $HOME/dfhack/travis/lint.py
./bodyswap.lua: Contains DOS-style newlines: entire file
The command "python $HOME/dfhack/travis/lint.py" exited with 1.

\r\n needs to be replaced with \n. Done on my end.