Skip to content

Commit

Permalink
Improve anchor selection docs (#1070)
Browse files Browse the repository at this point in the history
* Update scan_tool.mdoc

* Explain remove buttons better too

* Clarify air blocks
  • Loading branch information
uecasm authored Sep 3, 2024
1 parent ea4d6fe commit b1c520e
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions src/content/wiki/items/scan_tool.mdoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ The scan tool is a very useful tool. With the scan tool, you can scan any struct

**Hint:** There are three placeholder blocks that help in building schematics, read more about them {% item name="placeholderblocks" /%}.

### Step Zero

Optionally, shift-left-click the "anchor block" (see below for more info). Usually you can skip this, but sometimes it needs to be selected manually.

### Step One

Then left-click a lower front corner (left or right makes no difference) at the ground level of the structure.
Expand All @@ -30,12 +34,23 @@ Next, right-click in the air to get the scan tool GUI.

Here you will be able to see the coordinates for the scan you just did and can change them. You will also be able to give your scan a name. Use the green arrow if you are ready to save your scan or the red X to cancel the scan and start over.

You can click on the Show Resources button to see all the blocks that are in your scan. When scrolling through the blocks that are in your scan, you have two options:
# Resources

You can click on the Show Resources button to see all the blocks that are in your scan. When scrolling through the blocks that are in your scan, you have three options:

* Remove, to remove any of the blocks you see in your scan that you don't want in there.
* Replace, to replace that block with any other block you prefer for that scan.
* Remove Filtered, to remove all of the blocks you see (you're expected to use a filter to select a subset first).

WARNING: these buttons will delete actual blocks or entities in your world. It may be a good idea to scan first so you have a backup in case you remove too much!

# Anchor Block

Every blueprint needs an "anchor". This is shown as a red box when scanning and building, and is the block that the blueprint will rotate around. Most importantly, though, it's the block that defines what kind of blueprint this is.

For regular buildings, the hut block for the building must be the anchor. For upgradable decorations, the {% item name="deco_controller" /%} must be the anchor. For other decorations, you can either use a {% item name="tag_anchor" /%} (if you want to use the {% item name="tag_tool" /%}) or any other block (otherwise; including air blocks).

You can also shift + left-click on a block to set the anchor position. (You can set it to a block outside of the scan, but that won't work for obvious reasons.) The anchor position is where the scan will rotate around when placing it with the {% item name="deco_controller" /%}. **Do not** change the anchor block in this case, as if you do, the decoration won't be upgradable!
You can select the anchor for your scan explicitly, by shift-left-clicking the desired block. If you don't do this, the scan tool will try to guess -- most of the time this works, but if you have more than one possible anchor inside your scan box then it won't be able to figure it out and you'll get an error message in chat. In that case you will have to set it manually. (Having more than one possible anchor is normal if you're scanning a building that has child buildings, or if you've included certain blocks like the {% item name="stash" /%} -- other times it might be because you've added a {% item name="tag_anchor" /%} when you shouldn't have.)

{% version name="1.19" after=true %}
# Multiple Scan Slots
Expand Down

0 comments on commit b1c520e

Please sign in to comment.