Easy Grid Builder Pro 2 Documentation
Easy Grid Builder Pro 2 Documentation
  • Getting Started
    • Introduction
    • Quick Start Guide
    • API Documentation
      • API - All Accessible Events
      • API - Grid Manager Classes
      • API - Easy Grid Builder Pro Class
      • API - Grid Buildable Classes
    • Render Pipeline Compatibility
    • Third Party Assets Compatibility
    • Patch Notes
  • Walk Through Tutorial
    • Make a 2D City Builder
      • Setting Up The Scene
      • Setting Up the Grid Values
      • Setting Up Visual - Object Grid
      • Creating Buildable Objects
      • Creating Buildable Object SO Assets
      • Adding Grid Area Disablers And Enablers
    • Make a 3D City Builder
      • Setting Up The Scene
      • Exploring Grid Properties
      • Adding Grid Visuals - Object Grid
      • Creating Buildable Objects
      • Creating Buildable Object SO Assets
      • Explore UI and Quick Play Testing
      • Exploring Grid Managers
      • Exploring Grid Modules
      • Polishing Buildable Objects with Effects
      • Adding Grid Visuals - Procedural Grid
      • Setting Up Custom Surface Projection
      • Adding Terrain
    • Make a 3D Modular House Builder
    • Review Demo Scenes
  • Explore Major Features
    • Setting Up Buildable Objects
    • Setting Up Buildable Objects SO Assets
    • Grid UI Features
    • Grid Visual - Object Grid Features
    • Grid Visual - Procedural Grid Features
    • Explore Build Conditions
    • Explore Grid Heat Map Features
  • Scriptable Objects
    • Buildable Grid Object SO
      • Buildable Grid Object Category SO
    • Buildable Edge Object SO
      • Buildable Edge Object Category SO
    • Buildable Corner Object SO
      • Buildable Corner Object Category SO
    • Buildable Free Object SO
      • Buildable Free Object Category SO
    • Buildable Object UI Category SO
    • Grid Modifier SO
  • Primary Components
    • Easy Grid Builder Pro XZ / XY
      • Easy Grid Builder Pro
      • Editor Grid Visual Handler XZ / XY
      • Grid Data Handler
    • Buildable Object Configurator
    • Buildable Grid Object
    • Buildable Edge Object
    • Buildable Corner Object
    • Buildable Free Object
    • Grid Manager
      • Grid Built Objects Manager
      • Grid Input Manager
      • Grid Save And Load Manager
      • Grid Heat Map Manager
      • Grid Area Modifier Manager
      • Grid Area Disabler Manager
      • Grid Area Enabler Manager
      • Grid UI Manager
    • Buildable Grid Object Ghost
    • Buildable Edge Object Ghost
    • Buildable Corner Object Ghost
    • Buildable Free Object Ghost
    • Buildable Object Destroyer
    • Buildable Object Selector
    • Buildable Object Mover
  • Secondary Components
    • Grid Heat Map
    • Grid Area
    • Grid Area Disabler
      • Basic Grid Area Disabler
    • Grid Area Enabler
      • Basic Grid Area Enabler
    • Grid Area Modifier
    • Buildable Free Object Snapper
    • Grid Area Visual Generator
    • Grid Cell Indicator Visual Generator
    • Buildable Object Effects
    • Grid Custom Surface Projector
    • UI Third Person Cursor Handler
  • Utility Components
    • Terrain Data Manager
    • Global Time Tick Manager
    • WASD Camera Controller
    • Scaling Effect
    • Easy Screen Shot Maker
Powered by GitBook
On this page
  • General Settings
  • Area Shape
  • Gizmos
  • Visual Settings
  • Scrolling Noise
  • Interactions And Active Self
  • Example Use case
  • API
  1. Secondary Components

Grid Area Visual Generator

PreviousBuildable Free Object SnapperNextGrid Cell Indicator Visual Generator

Last updated 3 months ago

The Grid Area Visual Generator is a component designed to visually represent specific grid areas generated in runtime within the Easy Grid Builder Pro 2 system. You can locate this component in: SoulGames > Easy Grid Builder Pro 2 > Scripts > Grid Visuals Scripts This component supports dynamic visualization of grid areas on various surfaces, including flat and non-flat terrains. It is versatile for generating rectangular or circular visual indicators and includes customizable materials and effects for enhanced visual feedback.

You can attach this component to your Buildable Objects to display a unique underline grid visual specific to that object. This visual can be dynamically controlled during grid interactions, such as grid mode changes, selection events, and more.

General Settings

Property
Function
Required

Grid Axis

Defines the plane of the grid (XZ or XY)

Yes

Warp Around Surface Below

Enables warping of the generated visual indicator to align with underlying surfaces

No

Custom Warp Surface Layer Mask

Specifies which layers are eligible for surface warping

No

Raycast Above Offset

The height above the surface from which raycasting is performed to determine the Warp Surface

No

Space Between Visual and Surface

The distance between to offset the grid visuals from the detected surface (This is used for offsetting the visual slightly to prevent overlapping)

No

Update On Position Change

Determines whether the visuals update dynamically when the component's position changes (If the Visual is static and won't change its position during runtime disable this)

No

Area Shape

Property
Function
Required

Shape

Defines the shape of the generated visual area (Rectangle or Circle)

Yes

Cell Size

Specifies the size of each visual cell. (While this doesn’t have to match your Grid System’s cell size, it is recommended to keep them the same in most cases)

Yes

Width

Number of cells along the width of the visual shape

Yes

Length

Number of cells along the length of the visual shape

Yes

Radius

Radius for circular grid visuals (This is ignored for Rectangular shape)

Yes

Gizmos

Property
Function
Required

Enable Gizmos

Toggles the display of debugging gizmos

No

Enable Simplified Gizmos

Displays a simplified gizmo representation (Better for editor performance)

No

Gizmo Color

Sets the color for the debug gizmos

No

If the blue gizmos aren’t visible, ensure that "Show Gizmos" is enabled in your Scene view.

Visual Settings

Property
Function
Required

Visual Material

Material applied to the grid visuals

Yes

Cell Image Texture

The texture used for each cell in the grid visual

Yes

Cell Show Color

Color when the generated visual is visible

Yes

Cell Hide Color

Color when the generated visual is hidden

Yes

Cell Show Color HDR

Similar to the Cell Show Color property this one uses an emissive HDR color

No

Cell Hide Color HDR

Similar to the Cell Hide Color property this one uses an emissive HDR color

No

Color Transition Speed

Speed of color transitions between show and hide

Yes

In the Visual Material property, custom materials cannot be used. Instead, you must use the specific material called Grid Quad Shader Graph Material, located in: SoulGames > Easy Grid Builder Pro 2 > Misc Assets > Materials.

This material uses the Grid Quad Shader Graph shader, which is specifically designed for these components. If you need multiple versions of this material, simply duplicate it and use the duplicates with the Grid Area Visual Generator component.

For the Cell Image Texture property, you can use any of the provided cell textures located in: SoulGames > Easy Grid Builder Pro 2 > Misc Assets > Grid Textures > Cell Textures, or you can use any custom cell texture you’ve designed.

Scrolling Noise

You can apply a Scrolling Noise effect to the generated grid visuals, similar to the functionality available in the Visual - Object Grid section of your Easy Grid Builder Pro XZ / XY components.

Property
Function
Required

Use Scrolling Noise

Enables scrolling noise textures on the generated visuals

No

Noise Texture

The texture used for noise

No

Texture Tiling

Tiling factor for the noise texture

No

Texture Scrolling

Scrolling speed and direction for the noise texture

No

For the Noise Texture property, you can use any of the provided noise textures located in: SoulGames > Easy Grid Builder Pro 2 > Misc Assets > Grid Textures > Scrolling Noise Textures, or you can use any custom cell texture you’ve designed.

Interactions And Active Self

Property
Function
Required

Is Attached To A Buildable Object

Set if the component is attached to a GameObject that has a Buildable Object component

No

Buildable Object

If the Attached To A Buildable Object property is enabled, a reference to the attached Buildable Object component

No

Deactivate On Ghost Mode

If Is Attached To A Buildable Object, Automatically hides visuals in ghost mode while attempting to place the Buildable Object on the grid

No

Deactivate After Build

If Is Attached To A Buildable Object, Hides visuals after the Buildable Object is placed

No

Toggle On Select

If Is Attached To A Buildable Object, Toggles visibility when the Buildable Object is selected

No

Toggle On Move

If Is Attached To A Buildable Object, Toggles visibility when the Buildable Object is moved

No

Activate On Default Mode

Activate the visibility on Grid Mode None (Default)

No

Activate On Build Mode

Activate the visibility on Grid Mode Build

No

Activate On Destroy Mode

Activate the visibility on Grid Mode Destroy

No

Activate On Select Mode

Activate the visibility on Grid Mode Select

No

Activate On Move Mode

Activate the visibility on Grid Mode Move

No

Example Use case

This component generates a Visualizable Grid at runtime using the provided properties. It can be used to:

  • Display an underlined grid visual for Buildable Objects (e.g., highlighting an object's area) by attaching this to Buildable Objects.

  • Highlight specific areas on the grid independently.

This component is highly versatile and fully customizable, allowing you to adapt it to meet your specific requirements.

API

namespace SoulGames.EasyGridBuilderPro
public void SetInputEnableGridAreaVisual()
// Enables the grid area visual by starting the LerpAndEnable() coroutine
public void SetInputDisableGridAreaVisual()
// Disables the grid area visual by starting the LerpAndDisable() coroutine