RequireComponent attribute

[paulpach]

This is pretty awesome, ty, I have a suggestion:

You implemented GetComponent, and GetComponentProperty.

But I have a suggestion that does not have runtime cost, and that makes sure that the component exists. For example:

public partial class MyComponent : MonoBehaviour{
     [RequiredComponent] private TMP_Text text;
}

would generate:

[RequireComponent(typeof(TMP_Text))]
public partial class MyComponent : MonoBehaviour{
     [SerializeField] private TMP_Text text;

    public void OnValidate() {
        if (text == null)
            TryGetComponent<TMP_Text>(out text);
    }
}

By adding the [RequiredComponent] at the top of the class, it would make sure the component is added to the gameobject.

By adding the assignment in the OnValidate, this enforces the field is assigned in the editor with zero cost at runtime.

Ideally it would generate the OnValidate method, but if the user defines one, it would generate a ValidateFields() method that the user defined OnValidate has to call.

[VPDPersonal]

That's a good idea. Will definitely take this to work. Note that there are some limitations that slightly change the template you suggested.

I don't think it's a good idea to use OnValidate by default, because in theory other generators can do it too (which is also not good in my opinion). And we cannot analyse code written by other generators. So most likely the generation will look like this

Source code:

public partial class MyComponent : MonoBehaviour
{
     [RequiredComponent]
     [SerializeField] private TMP_Text _text;
     
     private void OnValidate() 
     {
         ValidateFields();
     }
}

Generated code:

[RequireComponent(typeof(TMP_Text))]
public partial class MyComponent : MonoBehaviour
{
    private void ValidateFields()
    {
        if (_text == null)
            _text = GetComponet<TMP_Text>();
    }
}

[paulpach]

Sounds good.

For context, here is a similar thing implemented using property drawers:

https://discussions.unity.com/t/a-different-requirecomponent/663125

I am not 100% sure, but you might need to call UnityEditor.Undo.RecordObject so that the editor is aware that the field changed and save it.