ScatterTool - Megasploot/Dungeondraft GitHub Wiki

Overview

The tool used to scatter objects. Inherits from Tool.

Accessed by Global.Editor.Tools["ScatterTool"].

Controls

Controls are UI elements that can be accessed by indexing Controls[id].

RangeSlider Controls["Rotation"]

Allows the user to adjust the range of random rotation.

 

RangeSlider Controls["Scale"]

Allows the user to adjust the range of random scaling.

 

HSlider Controls["Spread"]

Allows the user to adjust how far apart to spread the objects.

 

Properties

Prop Preview

Gets the preview Prop. This is the object that follows the user's cursor before it is actually placed. Call confirm to force it to place.

See Prop.

 

int ActiveLayer

Gets and sets whether the tool's layer.

 

bool Shadow

Gets and sets whether the tool will place objects with shadows.

 

bool BlockLight

Gets and sets whether the tool will place objects that block light.

 

Functions

void PromoteCustomColor()

Updates the Preview with any changes in custom color.