Buildable Edge Object Type SO
Last updated
Last updated
These scriptable objects store all the data for buildable edge objects.
For each buildable edge object, you need to create one of these assets and fill in the required data.
You can create a new scriptable object, go to Asset > Create > SoulGames > Easy Grid Builder Pro > BuildableEdgeObjectTypeSO.
NOTE: Buildable Edge Objects snap to the four corners of a grid cell and can be built upto four objects in a single grid cell.
Property | Function | Required |
---|---|---|
Unique Object Name | Name for the buildable object - Must be unique. | Yes |
Object Description | A description of the object - Will be used in the UI in future. | No |
Object Tool Tip Description | A tool tip description of the object - Will be used in the UI in future. | No |
Buildable Category SO | Requires BuildableCategorySO asset - If this object is not added it will not be displayed in Easy Grid Builder Pro UI. | No |
Object Icon | Require a sprite - Used to display the object in Easy Grid Builder Pro UI. | No |
Object Prefab | List of object prefabs - This is the prefab that will be spawned. If more than one is provided, one prefab will choose randomly each time to spawn. | Yes |
Ghost Prefab | This is used to display a temporary ghost visual before spawning the object in build mode. If this is empty, first prefab in the Object Prefab list will be used instead. | No |
Placeable Ghost Material | A custom material to be used in temporary ghost objects when they are place-able on the grid. If empty, the ghost object's default material will be used instead. | No |
Not-Placeable Ghost Material | A custom material to be used in temporary ghost objects when they are not placeable on the grid. If empty, the ghost object's default material will be used instead. | No |
Set Built Object Layer | Set the build object's layer after the build is complete | No |
Built Object Layer | Layer that build object will have after the build | No |
Show Grid Below Object | Set a canvas grid under the build object | No |
Object Grid Canvas | Grid Canvas prefab - Located in EasyGridBuilder Pro > Prefabs > Canvas Grid Samples. | No |
Grid Image Sprite | Sprite to display the grid cells - Located in EasyGridBuilder Pro > Prefabs > Canvas Grid Samples. | No |
Grid Image Placeable Color | Custom color to the grid when the object is place-able on the grid | No |
Grid Image Not-Placeable Color | Custom color to the grid when the object is not place-able on the grid | No |
Hold Key To Place | Enable the ability to place objects while holding the placement key (Paint Mode) | No |
Place & Auto Deselect | Enable the ability to deselect currently placing object automatically, after placing the object. | No |
Enable Build Condition | Enable using build conditions for the buildable object | No |
Build Condition SO | Require BuildConditionSO asset - This asset will hold all the build condition data. | No |
Your defined BuildableEdgeObjectTypeSO assets should be added to the Buildable Edge Object Type SO List in all the Easy Grid Builder Pro grid systems, in order to use them in the specific grids.
Also, you need to add the asset to the Buildable Edge imageObject components in all the object prefab/prefabs.
If you are using build conditions in your defined BuildableEdgeObjectTypeSO asset, you will also need to add the asset to the Buildable Edge Object Type SO List under Multi Grid Build Condition Manager component.
You can find pre-defined BuildableGridObjectTypeSO assets located in EasyGridBuilder Pro > Scriptable Objects > Modular Buildalbe Object Type SO (Grid & Edge Objects).