No edit summary
Tags: Manual revert Reverted
Line 1: Line 1:
'''Pro Tools''' are a mechanic that allow players to quickly make massive changes to their house by manipulating a selected area. You can access these tools through their command aliases or through the upper left of the Housing Menu. The mechanic is inspired by WorldEdit, a well known tool used by many advanced builders.
'''Pro Tools''' are a selection of block-manipulation tools that work by manipulating selection regions (not be be confused with [[Regions]], which are a part of Housing's [[Systems]]). This can also refer to the menu where these tools are accessed, which is in the top left of the [[Housing Menu]].


Pro Tools can only be used if the right [[Permissions and Groups|permissions]] are given by the house owner. To use them, the player must have permissions to build and use Pro Tools.
Pro Tools can only be accessed by [[Groups]] with the "Pro Tools" [[permission]], which is only enabled for the Owner by default. This permission only affects players if they also have permission to build.


== Usage ==
== Usage ==
[[File:2024-09-02 18.01.09.png|A cube created from randomised blocks using the set tool.|thumb]]
All tools work by right clicking while holding the associated item in the player's hand. Tools which require a provided block will open a menu that allows an item from the player's inventory to be selected. If a valid block is provided, then the Pro Tool's functionality will modify the currently selected region.  
Pro Tools can be used through either their item or command. Tools that require a block will open a menu if none is specified through the command, and will always open a menu if the item tool is used. Once valid arguments are provided, the change will take effect immediately. Should one wish to undo their command, they can simply use the undo tool or the command <code>/undo</code>.


An advantage you may get by using commands with Pro Tools is that you can use the block variants used on Minecraft 1.8.9, like how <code>planks:1</code> creates Spruce Planks. A list of these block IDs can be found on an external website such as [https://www.digminecraft.com/lists/item_id_list_pc_1_8.php this one]. Another advantage to using commands is that you can specify multiple blocks seperated by a comma to randomly select between them.
All tools can also be accessed via commands. Tools which require a provided block will require a block name or block id in their command argument(s). Block metadata can be included after the block name or id, with a colon separating the two values. All block ids and metadatas use 1.8.9 values, which can be found [https://www.digminecraft.com/lists/item_id_list_pc_1_8.php here].


== List of tools ==
When using the paste tool, the player's clipboard will be pasted with the paste position being the bottom-north-east corner.
 
Using the command version of a tool also allows for multiple blocks to be selected in a comma-separated array with no spaces, which results in each block in the selection being randomly selected from the supplied block palette.
 
[[File:2024-09-02 18.01.09.png|left|frame|alt=A rectangular cube made up of air, brick blocks, and magenta wool.|This cube was made with the command //set 0,45,35:2 (air, bricks, and magenta wool).]]
 
== Tools ==
{| class="wikitable"
{| class="wikitable"
! Tool !! Description !! Usable as
! Name !! Ingame Description !! Command Alias
|-
| Region Selection Tool || Selects a region with left and right clicks, which can then be modified with other tools. || //wand, //
|-
| Set Tool || Opens a menu with options to fill your selected region with a block type. || //set
|-
| Fill Tool || Opens a menu with options to fill your selected region with a block type. || //fill
|-
| Walls Tool || Opens a menu with options to Wall your selected region with a block type. || //walls
|-
|-
| Region Selection
| Wireframe Tool || Opens a menu with options to Wireframe your selected region with a block type. || //wireframe
|| Selects a region with left and right clicks, which can then be modified with other tools. Can be obtained quickly using <code>//</code>.
|| <ul> <li>Tool</li> <li><code>/pos1</code> <code>/pos2</code></li> </ul>
|-
|-
| Clear Selection
| Cut Tool || Deletes the selected region and copies it to your clipboard. || //cut
|| Clears your current selection, may cause slight issues with your clipboard.
|| <ul> <li><code>/clearselection</code> or <code>/desel</code></li> </ul>
|-
|-
| Set
| Copy Tool || Copies the selected region to your clipboard. || //copy
|| Lets you specify options to set your selected region with a block type.
|| <ul> <li>Tool</li> <li><code>/set <blocks></code> </ul>
|-
|-
| Fill
| Paste Tool || Pastes the contents of your clipboard to your plot at your location. || //paste
|| Lets you specify options to fill air blocks in your selected region with a block type.
|| <ul> <li>Tool</li> <li><code>/fill <blocks></code></li> </ul>
|-
|-
| Replace
| Undo Tool || Undoes your previous fill or paste operations. || //undo
|| Lets you specify options to fill air blocks in your selected region with a block type.
|}
|| <ul> <li><code>/replace <targets> <replacements></code></li> </ul>
 
== Hidden Tools/Commands ==
Some functionalities for "hidden" Pro Tools are only accessible through commands, and do not have an associated item nor do they show up in the Pro Tools menu.
 
{| class="wikitable"
! Name !! Custom Description !! Command Alias(es)
|-
|-
| Cut
| Replace Tool || Replaces a block or selection of blocks with a block or selection of blocks. || //replace
|| Removes all content in the selected region and copies it to your clipboard.
|| <ul> <li>Tool</li> <li><code>/cut</code></li> </ul>
|-
|-
| Copy
| Point A || Manually sets the region point associated with the Region Selection Tool's left click to the player's position. || //posa, //pos1
|| Copies all content in the selected region to your clipboard.
|| <ul> <li>Tool</li> <li><code>/copy</code></li> </ul>
|-
|-
| Paste
| Point B || Manually sets the region point associated with the Region Selection Tool's right click to the player's position. || //posb, //pos2
|| Pastes content from your clipboard. Unlike WorldEdit, the paste location is always from the Bottom North East corner.
|| <ul> <li>Tool</li> <li><code>/paste</code></li> </ul>
|-
|-
| Wireframe
| Teleport to Point A || Teleports the player to region point A. || //tpposa, //tppos1
|| Creates the outline of a cube in your selected region.
|| <ul> <li>Tool</li> <li><code>/wireframe <blocks></code></li> </ul>
|-
|-
| Walls
| Teleport to Point B || Teleports the player to region point B. || //tpposb, //tppos2
|| Creates vertical walls around a cube in your selected region.
|| <ul> <li>Tool</li> <li><code>/walls <blocks></code></li> </ul>
|-
|-
| Undo
| Up || Teleports the player to Y=194 || //up
|| Reverts the previous operation.
|| <ul> <li>Tool</li> <li><code>/undo</code></li> </ul>
|-
|-
 
| Pro Tools || Replaces the player's hotbar with, in order: Region Selection Tool, Set Tool, Fill Tool, Cut Tool, Copy Tool, Paste Tool, and Undo Tool. || //protools, //pt
|-
| Deselect || Deselects the player's current selection region. || //desel, //clearselection
|}
|}


== Trivia ==
== Trivia ==
* Clearing your selection will naturally make tools unusable as you have no selected region, this includes the Paste Tool despite it not actually needing a region to paste into.
Using the hidden deselect tool, most tools will become unusable. This includes the paste tool, despite the paste tool's functionality not requiring a selection region. Additionally, the deselect functionality does not work on the "Teleport to Point" commands, and these commands will remain functional after deselecting the current selection region.
* The Pro Tools menu found in the [[Housing Menu]] refers to ''Pro Mode'', a feature in Build Battle that Housing does not have. This is because Housing's Pro Tools are a fork of the ones used in Build Battle.
 
The Pro Tools button in the [[Housing Menu]] has the following description: "Utilize more advanced building tools specific to Pro Mode such as copying and pasting regions." This is from Hypixel [https://hypixel.net/build-battle/ Build Battle] Pro Mode, which is where Pro Tools originate from. This description is not accurate, as there is no "Pro Mode" in Housing.

Revision as of 16:42, 3 September 2024

Pro Tools are a selection of block-manipulation tools that work by manipulating selection regions (not be be confused with Regions, which are a part of Housing's Systems). This can also refer to the menu where these tools are accessed, which is in the top left of the Housing Menu.

Pro Tools can only be accessed by Groups with the "Pro Tools" permission, which is only enabled for the Owner by default. This permission only affects players if they also have permission to build.

Usage

All tools work by right clicking while holding the associated item in the player's hand. Tools which require a provided block will open a menu that allows an item from the player's inventory to be selected. If a valid block is provided, then the Pro Tool's functionality will modify the currently selected region.

All tools can also be accessed via commands. Tools which require a provided block will require a block name or block id in their command argument(s). Block metadata can be included after the block name or id, with a colon separating the two values. All block ids and metadatas use 1.8.9 values, which can be found here.

When using the paste tool, the player's clipboard will be pasted with the paste position being the bottom-north-east corner.

Using the command version of a tool also allows for multiple blocks to be selected in a comma-separated array with no spaces, which results in each block in the selection being randomly selected from the supplied block palette.

A rectangular cube made up of air, brick blocks, and magenta wool.
This cube was made with the command //set 0,45,35:2 (air, bricks, and magenta wool).

Tools

Name Ingame Description Command Alias
Region Selection Tool Selects a region with left and right clicks, which can then be modified with other tools. //wand, //
Set Tool Opens a menu with options to fill your selected region with a block type. //set
Fill Tool Opens a menu with options to fill your selected region with a block type. //fill
Walls Tool Opens a menu with options to Wall your selected region with a block type. //walls
Wireframe Tool Opens a menu with options to Wireframe your selected region with a block type. //wireframe
Cut Tool Deletes the selected region and copies it to your clipboard. //cut
Copy Tool Copies the selected region to your clipboard. //copy
Paste Tool Pastes the contents of your clipboard to your plot at your location. //paste
Undo Tool Undoes your previous fill or paste operations. //undo

Hidden Tools/Commands

Some functionalities for "hidden" Pro Tools are only accessible through commands, and do not have an associated item nor do they show up in the Pro Tools menu.

Name Custom Description Command Alias(es)
Replace Tool Replaces a block or selection of blocks with a block or selection of blocks. //replace
Point A Manually sets the region point associated with the Region Selection Tool's left click to the player's position. //posa, //pos1
Point B Manually sets the region point associated with the Region Selection Tool's right click to the player's position. //posb, //pos2
Teleport to Point A Teleports the player to region point A. //tpposa, //tppos1
Teleport to Point B Teleports the player to region point B. //tpposb, //tppos2
Up Teleports the player to Y=194 //up
Pro Tools Replaces the player's hotbar with, in order: Region Selection Tool, Set Tool, Fill Tool, Cut Tool, Copy Tool, Paste Tool, and Undo Tool. //protools, //pt
Deselect Deselects the player's current selection region. //desel, //clearselection

Trivia

Using the hidden deselect tool, most tools will become unusable. This includes the paste tool, despite the paste tool's functionality not requiring a selection region. Additionally, the deselect functionality does not work on the "Teleport to Point" commands, and these commands will remain functional after deselecting the current selection region.

The Pro Tools button in the Housing Menu has the following description: "Utilize more advanced building tools specific to Pro Mode such as copying and pasting regions." This is from Hypixel Build Battle Pro Mode, which is where Pro Tools originate from. This description is not accurate, as there is no "Pro Mode" in Housing.