Print

Please login or register.
1 Hour 1 Day 1 Week 1 Month Forever
Login with username, password and session length

[Oafsalot]

I used this a few versions ago and it was fine. It would spawn a new Dwarf at the cursor.

Code: [Select]

modtools/create-unit -name MOUNTAIN -nick CLONE -race DWARF -caste MALE -civId \\LOCAL -groupId \\LOCAL
Now for some reason, you must specify a location for the dwarf. Which is odd because this makes every example on the internet invalid. But OK.

Code: [Select]

modtools/create-unit -name MOUNTAIN -nick CLONE -race DWARF -caste MALE -setUnitToFort -location [ 132 133 165 ]
The coordinates appear to be from 0 0 1 which is the top left corner in the circus. Not the height/depth bar on the right. Just to add to the confusion.

It would be nice to see this command restored to its old behaviour, so if you don't state a location it defaults to the in-game cursor.

Does anyone know of a good way to get the coordinates of the cursor in dfhack? Would be handy.

[lethosor]

My understanding from https://github.com/DFHack/scripts/pull/99#discussion_r322119747 is that the cursor working was unintentional, and would lead to undesired side-effects if the cursor wasn't active (and so the behavior was changed in 0.44.12-r3).

I would honestly suggest spawnunit as a more concise front-end, and it does specifically default to the cursor position. modtools scripts are generally intended to be used in mods (where a cursor typically wouldn't be active) and may be a little low-level (although create-unit is obviously useful in other cases).

The coordinate system you described is the standard internal coordinate system used by pretty much everything in DF, except for the relative height you see on the map. There are lots of ways to read from it - for example:

Code: [Select]

:lua printall(df.global.cursor)
A shorter way:

Code: [Select]

lua ~cursor

By the way, it's completely fine to post things like this in the main DFHack thread (but thanks for calling our attention to it from there - we don't always notice posts in the larger forum).

[Oafsalot]

Thanks, lethosor.

You've been a great help.

It took me a while to work out that the [] brackets were not optional. Maybe an example should be put in the documentation?

[lethosor]

It took me a while to work out that the [] brackets were not optional. Maybe an example should be put in the documentation?

It's an argument parsing technique that a lot of scripts use, so having examples of everything for every script could be a lot of work to maintain on our end. I might try to document how it works in a more centralized place, though.

[Atomic Chicken]

The documentation does quite pointedly include square brackets in its description of the location option (-location [ x y z ]). Is this unclear? Authors sometimes document things in a manner that seems obvious to them without considering how users unfamiliar with system might interpret it, so improvement suggestions are appreciated.

In general, if you see square brackets in the documentation, they should be included where indicated, making sure to leave a space between them and the contained text. In the case of -location, many modtools scripts allow you to specify -location [ \\LOCATION ] in the -command option to pass relevant coordinates to another script, such as modtools/create-unit. For example, modtools/reaction-trigger allows one to do this if they want to create a creature at the location of the workshop following a specific reaction. It would probably be beneficial to document some examples of this.

[bloop_bleep]

Usually [] means optional arguments, like in man page synopses, and lots of other documentation places. That might have caused the confusion.