# Foliage Editor

**Foliage Tools** is a Land Editor tool designed for automated placement of game entities. \
The Foliage brush allows for quick and easy creation of realistic and optimized landscape scenes. \
The brush parameters enable you to configure the brush composition as well as the density, scale, tilt angle, and other characteristics of the entities included in the brush, giving you full control over entity placement when filling a scene.

<figure><img src="https://2358506489-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2UV9d5d9aTZPISbocWyo%2Fuploads%2F1EgtcOuhcGcjIVET3jF4%2Ffoliage.png?alt=media&#x26;token=60134748-bf05-490b-946e-27388db51049" alt=""><figcaption><p>Foliage editor Interface elements</p></figcaption></figure>

## Foliage editor interface elements

* [Main Menu](#main-menu) \[1]
* [Brush settings](#brush-settings) \[2]
* [Foliage List](#foliage-list) \[3]
* [Properties Window](#properties-window) for the selected entity  \[4]

## Main Menu

The **Foliage Tools** main menu \[1] provides basic functions for working with brushes. You can load previously saved brushes, save current settings, or create new brushes based on existing ones.

<table data-header-hidden><thead><tr><th width="218">Control Button</th><th>Description</th></tr></thead><tbody><tr><td><code>Load</code></td><td>Load a previously saved brush.</td></tr><tr><td><code>Save</code></td><td>Save the current brush.</td></tr><tr><td><code>Save As</code></td><td>Save the current brush as a new file or create a new brush.</td></tr></tbody></table>

## Brush settings

The brush settings \[2] determine how the tool will operate when placing entities. You can adjust the brush size, entity placement density, and manage the checkboxes that control whether entities can be placed on various surfaces, providing flexibility and control over scene creation.

<table><thead><tr><th width="222">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>Brush File</code></td><td>The file name with a relative path to the brush.</td></tr><tr><td><code>Brush Size</code></td><td>Determines the brush size within the range [0.0-3000.0].</td></tr><tr><td><code>Paint Density</code></td><td>Entity placement density, a general multiplier for each active entity within the range [0.0-1.0]. </td></tr><tr><td><code>Landscape</code></td><td>Checkbox controlling permission to place entities on the landscape.</td></tr><tr><td><code>Static Meshes</code></td><td>Checkbox controlling permission to place a foliage on static meshes (for example: grass on buildings)</td></tr><tr><td><code>Foliage</code></td><td>Checkbox controlling permission to place a foliage on other blocking foliage geometry.</td></tr></tbody></table>

{% hint style="info" %}
The **Landscape** checkbox is enabled by default. The ability to toggle the **Landscape**, **Static Meshes**, and **Foliage** checkboxes is temporarily disabled.
{% endhint %}

## Foliage List

The **Foliage List** window \[3] contains a list of entities that can be placed in the scene using the loaded brush. The control buttons allow you to add new entities to the list, delete unnecessary ones, and clear the entire list to create a new selection of entities.

<table><thead><tr><th width="213">Control Button</th><th>Description</th></tr></thead><tbody><tr><td><code>Add</code></td><td>Add a new entity to the list.</td></tr><tr><td><code>Delete</code></td><td>Remove an entity from the list.</td></tr><tr><td><code>Clear</code></td><td>Clear a foliage list.</td></tr><tr><td><code>Generate</code></td><td>Generate a foliage list from selected entities.</td></tr></tbody></table>

## Properties Window

The **Properties** window for the selected entity \[4] is designed to configure the parameters of the selected entity from the foliage list. These settings allow you to adjust the entity's activity and its behavior when placed in the scene.

<figure><img src="https://2358506489-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2UV9d5d9aTZPISbocWyo%2Fuploads%2FQgLqa7sLc5K3o8wYRY4z%2Feditor.png?alt=media&#x26;token=62875c6d-4bd2-4a4f-b961-015234e4f6a0" alt=""><figcaption><p><strong>Properties</strong> window</p></figcaption></figure>

### **Base properties**

This group of parameters controls the entity's activity and specifies the path to the entity file that will be used for placement.

<table><thead><tr><th width="245">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>Activate</code></td><td>Checkbox that determines whether the selected entity is active for painting.</td></tr><tr><td><code>Entity</code></td><td>The relative path to the entity file that will be used for painting.</td></tr></tbody></table>

### **Painting**

The parameters in the **Painting** section define the density of entities, the minimum distance between them, and their scale. These parameters provide control over how entities will be placed in the scene.

<table><thead><tr><th width="245">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>Density</code></td><td>Determines the density of entity instances during painting.</td></tr><tr><td><code>Radius</code></td><td>The minimum distance between entity instances during painting.</td></tr><tr><td><code>Apply Radius to All</code></td><td>Enables applying the specified radius settings to all entities in the foliage list.</td></tr><tr><td><code>Scale</code></td><td>Determines the random scale of entities within a specified range.</td></tr></tbody></table>

### **Placement**

The parameters in the **Placement** section control the placement of entities in the scene space, including offset, orientation to the surface normal, random rotation and tilt, as well as allowable angles and heights for placement.

<table><thead><tr><th width="262">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>Z Offset</code></td><td>Sets random offset along the Z-axis for each entity instance.</td></tr><tr><td><code>Align to Normal</code></td><td>Enables alignment of entity instances to the surface normal.</td></tr><tr><td><code>Align Max Angle</code></td><td>Sets the maximum deviation angle of the entity instance from the normal.</td></tr><tr><td><code>Random Yaw</code></td><td>Determines the random rotation of the entity instance around the vertical axis.</td></tr><tr><td><code>Random Pitch Angle</code></td><td>Determines the random tilt of the entity instance along the X-axis.</td></tr><tr><td><code>Ground Slope Angle</code></td><td>Restricts entity placement to surfaces with a specified slope angle.</td></tr><tr><td><code>Height</code></td><td>Determines the height range within which entities can be placed.</td></tr></tbody></table>

### **View**

The **View** settings define the visual parameters of entity instances and are used for fine-tuning the appearance of entities in the scene.

<table><thead><tr><th width="250">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>Opacity</code></td><td>Controls the level of entity transparency.</td></tr><tr><td><code>Color</code></td><td>Sets the color of entities in the scene.</td></tr></tbody></table>