https://github.com/Moolt/UnityRuntimePresets
Creating presets and using them in the compiled game.
https://github.com/Moolt/UnityRuntimePresets
editor presets runtime unity
Last synced: 6 months ago
JSON representation
Creating presets and using them in the compiled game.
- Host: GitHub
- URL: https://github.com/Moolt/UnityRuntimePresets
- Owner: Moolt
- License: mit
- Created: 2019-01-15T19:42:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-23T20:40:58.000Z (about 6 years ago)
- Last Synced: 2024-11-10T17:46:51.821Z (11 months ago)
- Topics: editor, presets, runtime, unity
- Language: C#
- Homepage:
- Size: 180 KB
- Stars: 45
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# What are (runtime) presets?
Presets are a way to store a components values to an asset file that can be reapplied to other components either in the [editor](https://docs.unity3d.com/Manual/Presets.html) or by [scripting](https://docs.unity3d.com/2018.2/Documentation/ScriptReference/Presets.Preset.html).
Presets have one downside though: They are placed in the `UnityEditor` namespace and can therefore not be used in your compiled game. Loading presets at runtime is unfourtunately not possible. This plug-in intends solve this problem.
Runtime presets are an alternative to the Unity presets by storing components as prefabs that can then be reapplied at runtime. Using runtime presets is nearly identical to using the default Unity presets:
```csharp
public class ApplyPreset : MonoBehaviour
{
public Preset _preset;
public Light _light;
private void Awake()
{
_preset.ApplyTo(_light);
}
}
```
## Setup
If you want to get a quick overview you should check out the [demo project](https://github.com/Moolt/UnityRuntimePresets/archive/master.zip).
You can also download the [package](https://github.com/Moolt/UnityRuntimePresets/raw/master/runtimePresets.unitypackage) containing only the essential scripts.
After downloading and importing the package, you will find a new entry `Create Runtime Preset` in the gear menu  of a component.
## Creating a runtime preset
Open the gear menu  on any GameObjects component and click `Create Runtime Preset`.
The plug-in will then create the preset in the `Assets` folder. A newly created preset will always have the default name `New Preset`. Rename it after creation to prevent it from being overwritten.
The preset is simply a prefab with a copy of your selected component. It also has an additional component called `Preset`. Keep this in mind as we'll need it in the next step.
## Loading runtime presets
Presets can be set in the inspector once you expose a variable of the `Preset` type.
```csharp
public class ApplyPreset : MonoBehaviour
{
//A preset which needs to be set in the inspector
public Preset _preset;
//A light component that we want to modify
public Light _light;
private void Awake()
{
//Presets store values of a specific component type
//Checking whether the values can be applied may be helpful
if(_preset.CanBeAppliedTo(_light))
{
//Transfers the values from the preset onto the _light component
_preset.ApplyTo(_light);
}
}
}
```
After compiling the script you can now set the preset and reference the light component. The `preset` field is restricted to only accepting `presets`. You won't accidentally reference something else than a `preset`.
## Creating presets during runtime
Presets can also be created during runtime. You will need any component to initialize the preset with. The preset can then be used to apply the values to any component of the same type.
```csharp
public class CreatePreset : MonoBehaviour
{
//A reference to a light from another gameObject
public Light otherLight;
//The preset we want to store the lights values in
private Preset _preset;
void Start()
{
//Getting the light component of this gameObject
var light = GetComponent();
//Create a new preset from "otherLight" and apply its values to "light"
_preset = Preset.From(otherLight);
_preset.ApplyTo(light);
//Removes the temporary object created to store the runtime preset
//This is optional
_preset.Free();
}
}
```
The examples might be a bit forced, but I often find myself in more complex situations where runtime presets can be a real life saver.
I hope I can save you some time with this plug-in. Feel free to contact me if you have any questions.