mirror of
https://github.com/codewriter-packages/Tri-Inspector.git
synced 2025-01-22 00:08:51 -05:00
Readme
This commit is contained in:
VladV
parent
bc62ea4b21
commit
e3a127c335
199
README.md
199
README.md
@ -1,27 +1,29 @@
|
||||
# Tri Inspector [](#) [](#) 
|
||||
|
||||
_Advanced inspector attributes for Unity_
|
||||
|
||||
|
||||
|
||||
- [Attributes](#Attributes)
|
||||
- [Misc](#Misc)
|
||||
- [Validation](#Validation)
|
||||
- [Styling](#Styling)
|
||||
- [Collections](#Collections)
|
||||
- [Conditionals](#Conditionals)
|
||||
- [Buttons](#Buttons)
|
||||
- [Debug](#Debug)
|
||||
- [Groups](#Groups)
|
||||
- [Misc](#Misc)
|
||||
- [Validation](#Validation)
|
||||
- [Styling](#Styling)
|
||||
- [Collections](#Collections)
|
||||
- [Conditionals](#Conditionals)
|
||||
- [Buttons](#Buttons)
|
||||
- [Debug](#Debug)
|
||||
- [Groups](#Groups)
|
||||
- [Customization](#Customization)
|
||||
- [Custom Drawers](#Custom-Drawers)
|
||||
- [Validators](#Validators)
|
||||
- [Property Processors](#Property-Processors)
|
||||
- [Custom Drawers](#Custom-Drawers)
|
||||
- [Validators](#Validators)
|
||||
- [Property Processors](#Property-Processors)
|
||||
- [How to Install](#How-to-Install)
|
||||
- [License](#License)
|
||||
|
||||
## Attributes
|
||||
|
||||
### Misc
|
||||
|
||||
#### ShowInInspector
|
||||
|
||||
Shows non-serialized property in the inspector.
|
||||
@ -82,9 +84,7 @@ private void OnMaterialChanged()
|
||||
|
||||
### Validation
|
||||
|
||||
Tri Inspector has some builtin validators such as `missing reference` and `type mismatch` error.
|
||||
Additionally you can mark out your code with validation attributes
|
||||
or even write own validators.
|
||||
Tri Inspector has some builtin validators such as `missing reference` and `type mismatch` error. Additionally you can mark out your code with validation attributes or even write own validators.
|
||||
|
||||
|
||||
|
||||
@ -116,56 +116,137 @@ private TriValidationResult ValidateTexture()
|
||||
|
||||
### Styling
|
||||
|
||||
#### HideLabel
|
||||
#### Title
|
||||
|
||||
|
||||
|
||||
```csharp
|
||||
[Title("My Title")]
|
||||
public string val;
|
||||
|
||||
[Title("$" + nameof(_myTitleField))]
|
||||
public Rect rect;
|
||||
|
||||
[Title("$" + nameof(MyTitleProperty))]
|
||||
public Vector3 vec;
|
||||
|
||||
[Title("Button Title")]
|
||||
[Button]
|
||||
public void MyButton()
|
||||
{
|
||||
}
|
||||
|
||||
private string _myTitleField = "Serialized Title";
|
||||
|
||||
private string MyTitleProperty => DateTime.Now.ToLongTimeString();
|
||||
```
|
||||
|
||||
#### HideLabel
|
||||
|
||||
|
||||
|
||||
```csharp
|
||||
[Title("Wide Vector")]
|
||||
[HideLabel]
|
||||
public Vector3 vector;
|
||||
|
||||
[Title("Wide String")]
|
||||
[HideLabel]
|
||||
public string str;
|
||||
```
|
||||
|
||||
#### LabelText
|
||||
|
||||
|
||||
|
||||
```csharp
|
||||
[LabelText("My Label")]
|
||||
[LabelText("Custom Label")]
|
||||
public int val;
|
||||
|
||||
[LabelText("$" + nameof(DynamicLabel))]
|
||||
public Vector3 vec;
|
||||
|
||||
public string DynamicLabel => DateTime.Now.ToShortTimeString();
|
||||
```
|
||||
|
||||
#### LabelWidth
|
||||
|
||||
|
||||
|
||||
```csharp
|
||||
[LabelWidth(100)]
|
||||
public int defaultWidth;
|
||||
|
||||
[LabelWidth(40)]
|
||||
public int thin;
|
||||
|
||||
[LabelWidth(300)]
|
||||
public int customInspectorVeryLongPropertyName;
|
||||
```
|
||||
|
||||
#### GUIColor
|
||||
```csharp
|
||||
[GUIColor(0, 1, 0)]
|
||||
```
|
||||
|
||||
#### Space
|
||||
|
||||
|
||||
```csharp
|
||||
[Space]
|
||||
[GUIColor(0.8f, 1.0f, 0.6f)]
|
||||
public Vector3 vec;
|
||||
|
||||
[GUIColor(0.6f, 0.9f, 1.0f)]
|
||||
[Button]
|
||||
public void BlueButton() { }
|
||||
|
||||
[GUIColor(1.0f, 0.6f, 0.6f)]
|
||||
[Button]
|
||||
public void RedButton() { }
|
||||
```
|
||||
|
||||
#### Indent
|
||||
|
||||
|
||||
|
||||
```csharp
|
||||
[Title("Custom Indent")]
|
||||
[Indent]
|
||||
```
|
||||
public int a;
|
||||
|
||||
#### Title
|
||||
```csharp
|
||||
[Title("My Title")]
|
||||
public int val;
|
||||
```
|
||||
[Indent(2)]
|
||||
public int b;
|
||||
|
||||
#### Header
|
||||
```csharp
|
||||
[Header("My Header")]
|
||||
[Indent(3)]
|
||||
public int c;
|
||||
|
||||
[Indent(4)]
|
||||
public int d;
|
||||
```
|
||||
|
||||
#### PropertySpace
|
||||
|
||||
|
||||
|
||||
```csharp
|
||||
[PropertySpace(SpaceBefore = 10,
|
||||
SpaceAfter = 20)]
|
||||
[Space, PropertyOrder(0)]
|
||||
public Vector3 vecField;
|
||||
|
||||
[ShowInInspector, PropertyOrder(1)]
|
||||
[PropertySpace(SpaceBefore = 10, SpaceAfter = 30)]
|
||||
public Rect RectProperty { get; set; }
|
||||
|
||||
[PropertyOrder(2)]
|
||||
public bool b;
|
||||
```
|
||||
|
||||
#### PropertyTooltip
|
||||
|
||||
|
||||
|
||||
```csharp
|
||||
[PropertyTooltip("My Tooltip")]
|
||||
[PropertyTooltip("This is tooltip")]
|
||||
public Rect rect;
|
||||
|
||||
[PropertyTooltip("$" + nameof(DynamicTooltip))]
|
||||
public Vector3 vec;
|
||||
|
||||
public string DynamicTooltip => DateTime.Now.ToShortTimeString();
|
||||
```
|
||||
|
||||
#### InlineEditor
|
||||
@ -212,14 +293,31 @@ public List<Material> list;
|
||||
### Conditionals
|
||||
|
||||
#### ShowIf
|
||||
```csharp
|
||||
public bool visible;
|
||||
|
||||
[ShowIf(nameof(visible))]
|
||||
public float val;
|
||||
|
||||
|
||||
```csharp
|
||||
public Material material;
|
||||
public bool toggle;
|
||||
public SomeEnum someEnum;
|
||||
|
||||
[ShowIf(nameof(material), null)]
|
||||
public Vector3 showWhenMaterialIsNull;
|
||||
|
||||
[ShowIf(nameof(toggle))]
|
||||
public Vector3 showWhenToggleIsTrue;
|
||||
|
||||
[ShowIf(nameof(toggle), false)]
|
||||
public Vector3 showWhenToggleIsFalse;
|
||||
|
||||
[ShowIf(nameof(someEnum), SomeEnum.Two)]
|
||||
public Vector3 showWhenSomeEnumIsTwo;
|
||||
|
||||
public enum SomeEnum { One, Two, Three }
|
||||
```
|
||||
|
||||
#### HideIf
|
||||
|
||||
```csharp
|
||||
public bool visible;
|
||||
|
||||
@ -228,6 +326,7 @@ public float val;
|
||||
```
|
||||
|
||||
#### EnableIf
|
||||
|
||||
```csharp
|
||||
public bool visible;
|
||||
|
||||
@ -236,6 +335,7 @@ public float val;
|
||||
```
|
||||
|
||||
#### DisableIf
|
||||
|
||||
```csharp
|
||||
public bool visible;
|
||||
|
||||
@ -243,23 +343,26 @@ public bool visible;
|
||||
public float val;
|
||||
```
|
||||
|
||||
|
||||
#### HideInPlayMode / ShowInPlayMode
|
||||
|
||||
```csharp
|
||||
[HideInPlayMode] [ShowInPlayMode]
|
||||
```
|
||||
|
||||
#### DisableInPlayMode / EnableInPlayMode
|
||||
|
||||
```csharp
|
||||
[DisableInPlayMode] [EnableInPlayMode]
|
||||
```
|
||||
|
||||
#### HideInEditMode / ShowInEditMode
|
||||
|
||||
```csharp
|
||||
[HideInEditMode] [ShowInEditMode]
|
||||
```
|
||||
|
||||
#### DisableInEditMode / EnableInEditMode
|
||||
|
||||
```csharp
|
||||
[DisableInEditMode] [EnableInEditMode]
|
||||
```
|
||||
@ -281,8 +384,16 @@ private void DoButton()
|
||||
### Debug
|
||||
|
||||
#### ShowDrawerChain
|
||||
|
||||
|
||||
|
||||
```csharp
|
||||
[ShowDrawerChain]
|
||||
[Indent]
|
||||
[PropertySpace]
|
||||
[Title("Custom Title")]
|
||||
[GUIColor(1.0f, 0.8f, 0.8f)]
|
||||
public Vector3 vec;
|
||||
```
|
||||
|
||||
### Groups
|
||||
@ -355,6 +466,7 @@ public class BoolDrawer : TriValueDrawer<bool>
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
@ -379,6 +491,7 @@ public class LabelWidthDrawer : TriAttributeDrawer<LabelWidthAttribute>
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
@ -398,6 +511,7 @@ public class TriBoxGroupDrawer : TriGroupDrawer<DeclareBoxGroupAttribute>
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### Validators
|
||||
@ -419,6 +533,7 @@ public class MissingReferenceValidator<T> : TriValueValidator<T>
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
@ -437,6 +552,7 @@ public class RequiredValidator : TriAttributeValidator<RequiredAttribute>
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### Property Processors
|
||||
@ -458,6 +574,7 @@ public class HideInPlayModeProcessor : TriPropertyHideProcessor<HideInPlayModeAt
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
@ -477,15 +594,17 @@ public class DisableInPlayModeProcessor : TriPropertyDisableProcessor<DisableInP
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## How to Install
|
||||
|
||||
Minimal Unity Version is 2020.3.
|
||||
|
||||
Library distributed as git package ([How to install package from git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html))
|
||||
<br>Git URL: `https://github.com/codewriter-packages/Tri-Inspector.git`
|
||||
|
||||
After installing the package, you need to unpack the `Installer.unitypackage` that comes with the package.
|
||||
After installing the package, you need to unpack the `Installer.unitypackage` that comes with the package.
|
||||
|
||||
Then in `ProjectSettings`/`TriInspector` enable `Full` mode for Tri Inspector.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user