unity-atoms/docs/tutorials/generator.md

---
id: generator
title: Generator
hide_title: true
sidebar_label: Generator
---

# Generator

Almost any project will eventually have custom data or reference types. These types can also be used as Unity Atoms variables or passed along as event data. Use the generator to create atoms for your own project specific types.

The Generator is a powerful tool that allows you to generate your own Atoms fast and easy via an Unity editor window. It liberates you from writing otherwise tedious boilerplate code and lets you instead focus on what is important.

The Generator can be found by clicking on _Tools / Unity Atoms / Generator_ in the top menu bar:

![generator_top-bar-menu](../assets/generator/top-bar-menu.png)

The Generator looks like this:

![generator_window](../assets/generator/window.png)

## Options

### Relative write path

The path where the generated Atoms will be written to. The path is relative to your project's root folder (Assets).

### Type name

This is the name of the type that you want to generate. Lets say you want to create your own struct and generate Atoms for it:

```cs
[Serializable]
public struct MyStruct
{
    public int Number;
}

```

You would then type `MyStruct` as the type name.

### Is type Equatable?

Is the type provided in the above field implementing [`IEquatable`](https://docs.microsoft.com/en-us/dotnet/api/system.iequatable-1?view=netframework-4.8)? You need to add the following to `MyStruct` to make it implement `IEquatable`:

```cs
using System;

[Serializable]
public struct MyStruct : IEquatable<MyStruct>
{
    public int Number;

    public bool Equals(MyStruct other)
    {
        return this.Number == other.Number;
    }

    public override bool Equals(object obj)
    {
        return Equals((MyStruct)obj);
    }

    public override int GetHashCode()
    {
        return Number.GetHashCode();
    }
}

```

If your type does not implement [`IEquatable`](https://docs.microsoft.com/en-us/dotnet/api/system.iequatable-1?view=netframework-4.8) you will need to manually implement the `ValueEquals` method in the generated `AtomVariable`.

### Type namespace

Enter the namespace of the type that you have provided. If for example `MyStruct` was under the namespace `MyNamespace`:

```cs
namespace MyNamespace
{
    [Serializable]
    public struct MyStruct : IEquatable<MyStruct>
    {
        // ...
    }
}

```

You would then enter `MyNamespace`as the type namespace.

### Sub Unity Atoms namespace

By default the Atoms that gets generated will be under the namespace `UnityAtoms`. If you for example like it to be under `UnityAtoms.MyNamespace` you would then enter `MyNamespace` in this field.

### Type(s) to generate

This is a list of Atom types that you want to generate. Simply select the Atoms that you want to generate. Some Atoms depend on other Atoms. If you unselect an Atom that other Atoms depend on, then the Generator will unselect those depending Atoms. Below you find the dependency graph:

-   Pair Action - depends on Pair
-   Pair Event - depends on Pair
-   Value List - depends on Event
-   Event Reference Listener - depends on Action, Variable, Event, Pair Event, Function x 2, Variable Instancer, Pair Event Reference and Unity Event and Pair.
-   Pair Event Reference Listener - depends on Pair Action, Variable, Event, Pair Event, Function x 2, Variable Instancer, Event Reference and Pair Unity Event and Pair.
-   Reference - depends on Constant, Variable, Event, Pair Event, Function x 2 and Variable Instancer and Pair.
-   Event Reference - depends on Variable, Event, Pair Event, Function x 2, Variable Instancer, Event Instancer and Pair.
-   Pair Event Reference - depends on Variable, Event, Pair Event, Function x 2, Variable Instancer, Pair Event Instancer and Pair.
-   Set Variable Value - depends on Event, Pair Event, Function x 2, Variable, Constant, Reference, Variable Instancer and Pair.
-   Pair Unity Event - depends on Pair.
-   Variable - depends on Event, Pair Event, Pair and Function x 2
-   Variable Instancer - depsends on Variable, Event, Pair Event, Function x 2 and Pair.
-   Event Instancer - depsends on Event.
-   Pair Event Instancer - depsends on Event and Pair.

### Close & Generate

The close button will close the window, while the generate button will generate your Atoms.