Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jdsherbert/unity-serializable-dictionary
Custom C# Dictionary implementation, serializable by the Unity inspector.
https://github.com/jdsherbert/unity-serializable-dictionary
csharp csharp-code dictionary inspector serialization unity unity-3d unity-editor unity-scripts unity2d unity3d
Last synced: 1 day ago
JSON representation
Custom C# Dictionary implementation, serializable by the Unity inspector.
- Host: GitHub
- URL: https://github.com/jdsherbert/unity-serializable-dictionary
- Owner: JDSherbert
- License: mit
- Created: 2023-07-06T21:22:45.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-12T23:28:49.000Z (2 months ago)
- Last Synced: 2024-09-24T11:02:33.922Z (1 day ago)
- Topics: csharp, csharp-code, dictionary, inspector, serialization, unity, unity-3d, unity-editor, unity-scripts, unity2d, unity3d
- Language: C#
- Homepage: https://linktr.ee/JDSherbert
- Size: 43.9 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Unity - Serializable Dictionary
-----------------------------------------------------------------------
-----------------------------------------------------------------------
## Overview
Dictionaries cannot be serialized and displayed in the Unity inspector as is.
This pisses me off greatly, so I decided to write a quick and dirty code class to allow Dictionary Serialization in Unity.
Add this script to your project and discover the power of Dictionary Serialization!
To achieve serialization, the Serializable Dictionary class implements the `ISerializationCallbackReceiver` interface. This interface provides two callback methods: `OnBeforeSerialize()` and `OnAfterDeserialize()`. It also implements the `IDictionary` interface, allowing use of standard Dictionary behaviours.
By using the Serializable Dictionary class, you can easily create and manage key-value pairs directly in the Unity editor, allowing for dynamic customization and modification of data. This is particularly useful for scenarios where you need to store and modify structured data that should persist between editor sessions or during gameplay.
Note that while the Serializable Dictionary class provides a convenient way to work with serialized dictionaries in Unity, it is not a built-in Unity feature. I've tried my best to replicate the default Dictionary featureset but there may be some variance.
### Features:
- Allows Dictionary display in the inspector.
- Allows values to be serialized.
- Functions (mostly) like a standard C# Dictionary class.
### Usage:
1. Simply add this script to your project.
2. If you haven't got it, I'd recommend grabbing [Odin Inspector](https://github.com/TeamSirenix/odin-serializer) to make it look prettier!
Example Usage:
```cs
using UnityEngine;
using Sherbert.Framework.Generic;
public class DictionaryExample : MonoBehaviour
{
[SerializeField] private SerializableDictionary myDictionary = new();
}
```
-----------------------------------------------------------------------
## Prerequisites
If you haven't got it, I'd strongly recommend grabbing Odin Inspector to make your serialized variables look prettier.
You can grab Odin from here:
- Github: https://github.com/TeamSirenix/odin-serializer
- Unity Asset Store: https://assetstore.unity.com/packages/tools/utilities/odin-inspector-and-serializer-89041
-----------------------------------------------------------------------