Tool

Principles :

The Dungeon Painter tool will use some ScriptableObjects as Datas for generating the Dungeon.

The main Datas object is the DungeonDatas. This one will keep datas of all the dungeon cells. It will also keep a reference to the DungeonBrush.

DungeonBrush will handle all the brushes ans layouts. You can make multiple DungeonBrushes and share one between multiple DungeonDatas to re-use the same brushes.

DungeonCellBuildingBrush and DungeonCellDetailsBrush keeps datas about the brush

The DungeonCellBuildingLayout and DungeonCellDetailsLayout are embeded inside the Brushes and provide informations about how the dungeons cells will be generated (Walls, floor, details,...). I've designed the tool so that it is easy for you to create your own Layouts if you want something more complex.

DungeonCells is the Prefab used to spawn all the cells.

Dungeon is the dungeon prefab on which all the cells will be attached.

Tool presentation :

Tool Header : Allows you to perform operation like :

Select which floor to edit,
Zoom on the grid
Transfer floor datas : send all cells datas from the current floor to another floor (Destroy cells on the current floor)
Copy floor datas : copy all cells datas from the current floor to another floor
Erase floor datas : erase all the cells from the current floor
Erase all datas : erase all the cells from all the floors

Tool modes : Choose the current tool mode :

Paint building : Paint the cells adding floor, walls,...
Paint details : Add details to already created cells (Chests, torches, pillars,...).
Select : Select a cell to manually place doors and walls, or select multiple cells and copy/cut/past them or drag them by holding Ctrl.

Cell grid : You see here the plans of your dungeons. Hold mouse right click and drag to move the view. Click on the CenterView button to center the view to the origin.

Current mode options : The options for the current tool mode.

Tool Mode : Paint Building

Dungeon Datas : Set whatare the datas the tool will use

Brushes : Set the Datas for brushes.

You can share DungeonDatas or Brushes between multiple Dungeons. Make sure these two values are setup before you paint anything.

You can then select/add/remove your brushes

Brush group : Cells which are on the same group won't create wall between them. It's really usefull when you want to use different brushes for a single room.

Automatically place walls : Choose if the walls should be automatically placed

Automatically place doors : Choose if the doors should be automatically placed

Use double doors : If checked, two doors meshes will be spawn at door intersections.

Layout : Choose your layout. You can create you own layout if you want more complexe behaviors. The simple layout allows you to place walls, doors, floor and corners.

Refresh : Re-create the cells

Save : Save the datas and update the Dungeons in the scene (Don't forget to save the datas before exiting the tool !).

Tool Mode : Paint Details

Dungeon Datas and Brushes : same as Paint Building

You can select/add/remove your brushes and set their visual (size, color, texture)

Layout : Choose your layout. You can create you own layout if you want more complexe behaviors. The simple layout allows you to place multiple items and modify their location :

offset/height offset : it's a percentage of the cell size.
Snap to floor/wall : perform a line trace to snap the item to the floor/wall. Floors must be on the FloorLayer and walls must be on the Wall layer ! plus, you need to place collider on these prefebs if you want the line trace success.
Prefab : The prefab to spawn.

Tool Mode : Select

This mode Allows you to select cell(s) and edit them.

When one cell is celected, you can modify its walls and corners

Other infos :

Other commands :
- Hold Right mouse click to move the view
- "Ctrl-Z" to undo
- In Paint Building/Details mode :
  - Click on a cell while holding "Alt" to select the brush of the cell
  - Click on a cell wjile holding "Shift" to clear the cell
- In Select mode :
  - Hold Left click and drag mouse to make selection rectangle
  - Click on selection, hold "Ctrl" and drag the mouse to drag the selection
  - "Ctrl-C/Ctrl-V" to copy past cells

How to change the cell size and height ?

Select the DungeonCell prefab and change the size and height parameter of the cell. It must be the same cell as the one you've linked in your dungeon prefab.

Google Sites

Report abuse