🧑‍🎓Advanced Topics

Vibe's file structure in the Assets folder

Vibe folder -> Contains Core and Optional files. These are the same in every project you import Vibe into.

Vibe / Core folder -> Contains scripts and other files required for Vibe to function. Do not modify the contents of this folder.

Vibe / Optional folder -> Contains Examples and other optional files. Feel free to modify or delete it altogether.

Vibe Project Files folder -> Contains definitions specific to your project. This includes your settings, custom inspectors you created, etc.

Adding Styles to Properties, Buttons and Groups

Styles change the look of their parent Element. If you make a Style a child of a Property or a Button, the Style will apply its effect to its parent.

A Color Style is a child of a Property "Origin". The Style is applied only to that Property.

If you make a Style a child of a Group, the Style will be applied to the Group itself and all children of that Group.

A Color Style is a child of a Group. The Style is applied to all elements inside the Group, and the Group itself.

Using Style Conditions

Conditions are used to decide whether their parent Style should be applied.

A Style is applied if it has no Conditions, or all Conditions are satisfied.

In the example below, the "Origin" property is disabled in Play Mode

We are in Play Mode. The Play Mode Condition returns True - the Disabled Style is applied. This disables the "Origin" Property in the Inspector.

Renaming Classes, Properties

When you create a Custom Inspector for a components using Vibe, it saves names of classes and their members (properties, methods) to retrieve it later. This means the references can potentially be lost when you rename them in your code.

Vibe will automatically try to fix any such occurrences in the background. There are some good practices to make it failproof:

1. Don't rename a class and its members at the same time. Rename the class, select it in the Inspector for Vibe to automatically update the saved config, then rename the members.

2. When renaming properties, use Unity's FormerlySerializedAs attribute.

Troubleshooting:

• If you lose a reference to your class, you can easily create a new Custom Inspector and one-click copy the old settings:

  

  Use this option to copy inspector element hierarchy from another saved custom inspector.

• If you lose a reference to a property or a method, you can select it under its new name or delete it from the Inspector altogether.

Deleting a Custom Inspector created with Vibe

If you decide you no longer want to use the custom inspector created with Vibe, take the following steps:

1. Open the Inspector Builder by selecting "Edit Inspector with Vibe" from the component's Context menu.

2. In the Inspector Builder, select the "Reset to Default" option.

Using Vibe in a project with Odin or other Custom Inspectors

If your project contains other Custom Inspector scripts or assets (i.e. Odin, Naughty Attributes), these will be used by default.

When you create a new Custom Inspector using Vibe, it will become the default custom inspector for that specific class.

If you decide you no longer want to use Vibe for that class, follow these steps:

1. Open Vibe's Inspector Builder.

2. Select "Reset to Default"

3. (If using Odin) Go to Tools > Odin > Preferences → Editor Types Tab → Update Editors button to re-enable Odin's custom inspector for this class.

There is currently no way to use Odin features in Vibe's Custom Inspector.