Skip to content

Commit 37e7ea1

Browse files
committed
Update: README.md & docs
1 parent 4f744fd commit 37e7ea1

File tree

4 files changed

+46
-11
lines changed

4 files changed

+46
-11
lines changed

Assets/Editor Toolbox/README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -810,11 +810,11 @@ Allows to serialize Types and pick them through a dedicated picker.
810810

811811
```csharp
812812
[TypeConstraint(typeof(Collider), AllowAbstract = false, AllowObsolete = false, TypeSettings = TypeSettings.Class, TypeGrouping = TypeGrouping.None)]
813-
public SerializedType var1;
813+
public SerializedType serializedType;
814814

815815
public void Usage()
816816
{
817-
var type = var1.Type;
817+
System.Type type = serializedType.Type;
818818
}
819819
```
820820

@@ -825,19 +825,19 @@ public void Usage()
825825
Allows to serialize SceneAssets and use them in Runtime.
826826

827827
```csharp
828-
public SerializedScene scene;
828+
public SerializedScene serializedScene;
829829

830830
public void Usage()
831831
{
832-
UnityEngine.SceneManagement.SceneManager.LoadScene(scene.BuildIndex);
832+
UnityEngine.SceneManagement.SceneManager.LoadScene(serializedScene.BuildIndex);
833833
}
834834
```
835835

836836
![inspector](https://github.com/arimger/Unity-Editor-Toolbox/blob/develop/Docs/serializedscene.png)
837837
838838
```csharp
839839
[SceneDetails]
840-
public SerializedScene scene;
840+
public SerializedScene serializedScene;
841841
```
842842
![inspector](https://github.com/arimger/Unity-Editor-Toolbox/blob/develop/Docs/scenedetails.png)
843843
@@ -875,12 +875,30 @@ public void Usage()
875875

876876
Allows to serialize DateTime.
877877

878+
```csharp
879+
public SerializedDateTime serializedDateTime;
880+
881+
public void Usage()
882+
{
883+
System.DateTime dateTime = serializedDateTime;
884+
}
885+
```
886+
878887
![inspector](https://github.com/arimger/Unity-Editor-Toolbox/blob/develop/Docs/serializeddate.png)
879888
880889
#### SerializedDirectory
881890

882891
Allows to serialize folders in form of assets and retrieve direct paths in runtime.
883892

893+
```csharp
894+
public SerializedDirectory serializeDirectory;
895+
896+
public void Usage()
897+
{
898+
string path = serializeDirectory.DirectoryPath;
899+
}
900+
```
901+
884902
![inspector](https://github.com/arimger/Unity-Editor-Toolbox/blob/develop/Docs/serializeddirectory.png)
885903
886904
## Editor Extensions

Assets/Editor Toolbox/Runtime/Serialization/SerializedScene.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ public class SerializedScene : ISerializationCallbackReceiver
2525
[SerializeField]
2626
private int buildIndex;
2727

28-
2928
void ISerializationCallbackReceiver.OnBeforeSerialize()
3029
{
3130
UpdateProperties();

Docs/serializedtype.png

-1.53 KB
Loading

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -810,11 +810,11 @@ Allows to serialize Types and pick them through a dedicated picker.
810810

811811
```csharp
812812
[TypeConstraint(typeof(Collider), AllowAbstract = false, AllowObsolete = false, TypeSettings = TypeSettings.Class, TypeGrouping = TypeGrouping.None)]
813-
public SerializedType var1;
813+
public SerializedType serializedType;
814814

815815
public void Usage()
816816
{
817-
var type = var1.Type;
817+
System.Type type = serializedType.Type;
818818
}
819819
```
820820

@@ -825,19 +825,19 @@ public void Usage()
825825
Allows to serialize SceneAssets and use them in Runtime.
826826

827827
```csharp
828-
public SerializedScene scene;
828+
public SerializedScene serializedScene;
829829

830830
public void Usage()
831831
{
832-
UnityEngine.SceneManagement.SceneManager.LoadScene(scene.BuildIndex);
832+
UnityEngine.SceneManagement.SceneManager.LoadScene(serializedScene.BuildIndex);
833833
}
834834
```
835835

836836
![inspector](https://github.com/arimger/Unity-Editor-Toolbox/blob/develop/Docs/serializedscene.png)
837837
838838
```csharp
839839
[SceneDetails]
840-
public SerializedScene scene;
840+
public SerializedScene serializedScene;
841841
```
842842
![inspector](https://github.com/arimger/Unity-Editor-Toolbox/blob/develop/Docs/scenedetails.png)
843843
@@ -875,12 +875,30 @@ public void Usage()
875875

876876
Allows to serialize DateTime.
877877

878+
```csharp
879+
public SerializedDateTime serializedDateTime;
880+
881+
public void Usage()
882+
{
883+
System.DateTime dateTime = serializedDateTime;
884+
}
885+
```
886+
878887
![inspector](https://github.com/arimger/Unity-Editor-Toolbox/blob/develop/Docs/serializeddate.png)
879888
880889
#### SerializedDirectory
881890

882891
Allows to serialize folders in form of assets and retrieve direct paths in runtime.
883892

893+
```csharp
894+
public SerializedDirectory serializeDirectory;
895+
896+
public void Usage()
897+
{
898+
string path = serializeDirectory.DirectoryPath;
899+
}
900+
```
901+
884902
![inspector](https://github.com/arimger/Unity-Editor-Toolbox/blob/develop/Docs/serializeddirectory.png)
885903
886904
## Editor Extensions

0 commit comments

Comments
 (0)