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
  • Spawn Effects
  • Scaling Effect
  • Positioning Effect
  • Spawn Game Objects
  • Destroy Effects
  • Spawn Game Objects
  • Interaction Effects
  • Material Changes
  • Sound Effects
  • Usage Instructions
  1. Secondary Components

Buildable Object Effects

PreviousGrid Cell Indicator Visual GeneratorNextGrid Custom Surface Projector

Last updated 5 months ago

The Buildable Object Effects component located in: SoulGames > Easy Grid Builder Pro 2 > Scripts > Grid Visuals Scripts provides visual, audio, and interaction effects for buildable objects within the Easy Grid Builder Pro 2 system. These effects include animations during spawning, spawning objects during spawning and destruction, material changes during interactions, and sound effects to enhance user feedback. Simply put this component adds a great final polish to your Buildable Objects.


Spawn Effects

You can add scaling and positioning animations to your Buildable Objects using customizable animation curves with this section of the component. Also additionally you have the option to spawn additional game objects on creation. (Ex: Particle effects)

Scaling Effect

Property
Function
Required

Use Scaling Effect On Spawn

Enables scaling animation on spawn

No

Block Scalling Effect For Ghost Object

Prevents scaling effects for ghost objects while attempting to place them on the grid

No

Scaling Affect X Axis

Determines the X axis is affected by scaling

No

Scaling Affect Y Axis

Determines the Y axis is affected by scaling

No

Scaling Affect Z Axis

Determines the Z axis is affected by scaling

No

Scale Effect Animation Curve

Defines the scaling animation curve. (Time and Scale)

No

Target Scale

Final scale after the animation is complete (once the scaling animation reaches this scale value it will stop)

No

Positioning Effect

Property
Function
Required

Use Position Effect On Spawn

Enables positioning animation on spawn

No

Block Position Effect For Ghost Object

Prevents positioning effects for ghost objects while attempting to place them on the grid

No

Position Affect X Axis

Determines the X axis is affected by positioning

No

Position Affect Y Axis

Determines the Y axis is affected by positioning

No

Position Affect Z Axis

Determines the Z axis is affected by positioning

No

Position Effect Animation Curve

Defines the positioning animation curve. (Time and Position)

No

Spawn Game Objects

Property
Function
Required

Use Spawn Game Objects On Spawn

Enables spawning objects on spawn

No

Spawn Game Object List

List of objects to spawn

No

Prevent Spawn In Ghost Mode

Prevents spawning objects on ghost object mode while attempting to place them on the grid

No

Spawn Random One From List

Spawns only one random object from the list

No

Spawn Local Position

Custom position for spawned objects

No

Spawn Local Rotation

Custom rotation for spawned objects

No

Spawn Local Scale

Custom scale for spawned objects

No

Spawnned Object Lifetime

The lifetime of spawned objects (destroyed after this time)

No


Destroy Effects

You can spawn additional game objects on Buildable Object Destruction. (Ex: When you destroy a built object you can spawn an explosion Particle effect)

Spawn Game Objects

Property
Function
Required

Use Spawn Game Objects On Destroy

Enables spawning objects during destruction

No

Spawn Game Object List

List of objects to spawn

No

Spawn Random One From List

Spawns only one random object from the list

No

Spawn Local Position

Custom position for spawned objects

No

Spawn Local Rotation

Custom rotation for spawned objects

No

Spawn Local Scale

Custom scale for spawned objects

No

Spawnned Object Lifetime

The lifetime of spawned objects (destroyed after this time)

No


Interaction Effects

With Interaction Effects, you can add Change Buildable Object's material on hover, selection, and movement states easily. Additionally, you can exclude objects that should not be affected by the material change. Also, you add audio feedback for interactions such as hover enter/exit, and selection.

Material Changes

Property
Function
Required

Change Object Material

Enables material changes during interactions

No

Root Object

The root game object to which the material change should be applied

Yes

Exclude Child Objects

Child game objects of the Root Object to exclude from the material change

No

Base Material

Default material of the object. (the original material of the object)

No

Destroyer Hover Change Material

Material applied during Destroy Mode hover

No

Selector Hover Change Material

Material applied during Select Mode hover

No

Selector Selected Material

Material applied when Select Mode selected

No

Mover Hover Change Material

Material applied during Move Mode hover

No

Sound Effects

Property
Function
Required

Make Sound Effect

Enables sound effects

No

Destroyer Hover Enter Audio Clip

Audio clip to play during Destroy Mode hover enter

No

Destroyer Hover Exit Audio Clip

Audio clip to play during Destroy Mode hover exit

No

Selector Hover Enter Audio Clip

Audio clip to play during Select Mode hover enter

No

Selector Hover Exit Audio Clip

Audio clip to play during Select Mode hover exit

No

Selector Selected Audio Clip

Audio clip to play during Select Mode selected

No

Selector Deselected Audio Clip

Audio clip to play during Select Mode deselected

No

Mover Hover Enter Audio Clip

Audio clip to play during Move Mode hover enter

No

Mover Hover Exit Audio Clip

Audio clip to play during Move Mode hover exit

No

Mover Start Moving Audio Clip

Audio clip to play during Move Mode start moving

No

Mover End Moving Audio Clip

Audio clip to play during Move Mode end moving

No


Usage Instructions

This component is specifically designed for use with Easy Grid Builder Pro 2 Buildable Objects. After creating your Buildable Objects, attach this component to the root game object (the same object where the Buildable Grid / Edge / Corner / Free Object component is attached). Then, configure the necessary properties to suit your needs.

You can inspect the Buildable Objects used in the Easy Grid Builder Pro 2 Demo scenes. Most of these objects have the Buildable Spawn Effects component attached to them.