Unity’de Özel Menü Öğeleri Oluşturma: MenuItem Attribute Rehberi

Giriş: Neden Unity’de Özel Menü Öğeleri Oluşturmalıyız?

Unity geliştirme sürecinde, sıkça tekrarlanan görevler veya özel ihtiyaçlara yönelik araçlar geliştirmek, verimliliği önemli ölçüde artırabilir. Unity’nin sunduğu zengin API setinin bir parçası olan `MenuItem` attribute, tam da bu noktada devreye girer. Bu attribute sayesinde, Unity editörünün üst menü çubuğuna (File, Edit, Assets, GameObject, Component, Window, Help) kendi özel menü öğelerinizi ekleyebilirsiniz. Bu makalede, Unity MenuItem attribute’unun ne olduğunu, nasıl kullanıldığını, pratik ipuçlarını, yaygın hataları ve performans notlarını detaylı bir şekilde inceleyeceğiz.

Özel menü öğeleri oluşturmak, geliştirme ekibinizin iş akışını standartlaştırmanıza, karmaşık işlemleri tek tıklamayla gerçekleştirmenize ve genel olarak daha düzenli bir proje ortamı sağlamanıza olanak tanır. Bir oyun geliştiricisi olarak, kendi özel araçlarınızı oluşturarak zaman kazanmak ve yaratıcılığınıza odaklanmak istersiniz. İşte `MenuItem` attribute’u, bu amaca hizmet eden güçlü bir editör uzantısıdır.

MenuItem Attribute Nedir ve Nasıl Kullanılır?

`MenuItem` attribute’u, Unity editöründe özel menü öğeleri oluşturmak için kullanılan bir C# attribute’udur. Bu attribute ile işaretlenmiş statik metotlar, Unity editörü açıldığında veya scriptler derlendiğinde otomatik olarak menüye eklenir.

Temel Kullanım Söz Dizimi

Bir `MenuItem` oluşturmak için yapmanız gerekenler oldukça basittir:

1. using UnityEditor; namespace’ini dahil edin.
2. Bir statik (static) ve geri dönüş değeri olmayan (void) bir metot tanımlayın.
3. Bu metodu [MenuItem("Menü Yolu/Menü Adı")] attribute’u ile işaretleyin.
4. Bu scripti projenizdeki herhangi bir Editor adında bir klasörün içine veya alt klasörüne yerleştirin.

İşte temel bir örnek:

using UnityEditor;
using UnityEngine;

public class CustomMenuTools
{
    [MenuItem("Tools/My Custom Tools/Merhaba Unity")]
    public static void SayMerhaba()
    {
        Debug.Log("Merhaba Unity!");
    }
}

Yukarıdaki kod bloğu, Unity editöründeki “Tools” menüsü altında “My Custom Tools” adında bir alt menü ve onun altında da “Merhaba Unity” adında bir öğe oluşturacaktır. Bu öğeye tıklandığında, Unity konsoluna “Merhaba Unity!” yazdırılacaktır.

Metodun static olması zorunludur, çünkü Unity editörü bu metodu bir sınıf örneği oluşturmadan doğrudan çağırır. void olması da aynı şekilde gereklidir, çünkü Unity editörü bu metottan bir değer beklememektedir.

Menü Yolları ve Hiyerarşi

Menü yolunu belirtirken eğik çizgi (/) kullanarak alt menüler oluşturabilirsiniz. Ayrıca, Unity’nin standart menü yollarını da kullanabilirsiniz:

• Assets/
• GameObject/
• Window/
• Tools/ (Genellikle özel araçlar için tercih edilir)
• Help/

Örneğin, “Assets” menüsüne bir öğe eklemek için:

using UnityEditor;
using UnityEngine;

public class AssetMenuTools
{
    [MenuItem("Assets/Create/My Custom Asset")]
    public static void CreateMyCustomAsset()
    {
        Debug.Log("Özel bir asset oluşturuldu!");
        // Gerçek asset oluşturma mantığı buraya gelir
    }
}

Kısayollar ve Menü Sıralaması

Menü öğelerine kısayollar ekleyerek iş akışınızı daha da hızlandırabilirsiniz. Kısayollar, menü yolunun sonuna özel karakterlerle eklenir:

• % : Ctrl (Windows) / Command (macOS)
• # : Shift
• & : Alt
• _ : Sonraki karakteri kısayol olarak atar (örn: _A ile A tuşu)

Örnek:

using UnityEditor;
using UnityEngine;

public class ShortcutMenu
{
    [MenuItem("Tools/Clear Console %#c")] // Ctrl/Cmd + Shift + C
    public static void ClearConsole()
    {
        // UnityEditor.LogEntries.Clear(); // Konsolu temizlemek için gerçek kod
        Debug.Log("Konsol temizlendi!");
    }
}

Menü öğelerinin sıralamasını kontrol etmek için `priority` parametresini kullanabilirsiniz. Daha düşük sayılar, öğenin menüde daha üstte görünmesini sağlar. Varsayılan değerler genellikle 10’un katlarıdır (örn. 10, 20, 30…). Kendi öğelerinizi bu aralıklara yerleştirerek istediğiniz gibi sıralayabilirsiniz.

using UnityEditor;
using UnityEngine;

public class PriorityMenu
{
    [MenuItem("Tools/Item A", priority = 1)]
    public static void ItemA() { Debug.Log("Item A"); }

    [MenuItem("Tools/Item B", priority = 100)]
    public static void ItemB() { Debug.Log("Item B"); }
}

Gelişmiş Kullanım: MenuItem Validation (Doğrulama)

Bazen bir menü öğesinin yalnızca belirli koşullar altında aktif olmasını istersiniz (örneğin, sahnede belirli bir türde GameObject seçiliyken). İşte bu noktada Unity MenuItem attribute’unun `validate` parametresi devreye girer. Bir doğrulama metodu, menü öğesinin gösterilip gösterilmeyeceğini veya grileşip grileşmeyeceğini belirler. Doğrulama metodu da ana metot gibi `static` ve `void` olmalı, ancak geriye bir `bool` değeri döndürmelidir.

using UnityEditor;
using UnityEngine;

public class ValidationMenuTools
{
    [MenuItem("GameObject/My Tools/Reset Position")]
    public static void ResetSelectedObjectPosition()
    {
        if (Selection.activeGameObject != null)
        {
            Selection.activeGameObject.transform.position = Vector3.zero;
            Debug.Log($"{Selection.activeGameObject.name} pozisyonu sıfırlandı.");
        }
    }

    // Doğrulama metodu
    [MenuItem("GameObject/My Tools/Reset Position", validate = true)]
    public static bool ValidateResetSelectedObjectPosition()
    {
        // Sahnede bir GameObject seçili ise menü öğesini aktif yap
        return Selection.activeGameObject != null;
    }
}

Yukarıdaki örnekte, “Reset Position” menü öğesi, yalnızca sahnede aktif bir GameObject seçiliyken aktif olacaktır. Eğer hiçbir GameObject seçili değilse, menü öğesi grileşecek ve tıklanamaz hale gelecektir. Bu, kullanıcının yalnızca ilgili durumlarda araçları görmesini sağlayarak kullanıcı deneyimini iyileştirir.

Pratik İpuçları ve Kullanım Senaryoları

İpucu 1: Sık Kullanılan İşlemleri Otomatikleştirme

Sıkça tekrarladığınız görevleri `MenuItem` kullanarak otomatikleştirin. Örneğin, belirli bir prefab’ı sahneye eklemek, sahnedeki tüm geçici objeleri temizlemek veya oyun ayarlarını varsayılan değerlerine sıfırlamak gibi işlemler için özel menü öğeleri oluşturabilirsiniz.

using UnityEditor;
using UnityEngine;

public class AutomationTools
{
    [MenuItem("Tools/Game Setup/Create Player Prefab")]
    public static void CreatePlayerPrefab()
    {
        // Prefab oluşturma ve sahneye ekleme mantığı
        GameObject player = GameObject.CreatePrimitive(PrimitiveType.Capsule);
        player.name = "Player";
        player.AddComponent<Rigidbody>();
        Debug.Log("Oyuncu prefab'ı oluşturuldu.");
    }
}

İpucu 2: Seçim Odaklı Araçlar Geliştirme

Unity’nin `Selection` sınıfını kullanarak, seçili GameObject’ler veya asset’ler üzerinde işlem yapan menü öğeleri oluşturabilirsiniz. Bu, bağlama duyarlı ve güçlü araçlar geliştirmenizi sağlar. Unity MenuItem ile bu tür araçlar, editör deneyiminizi kişiselleştirir.

using UnityEditor;
using UnityEngine;

public class SelectionTools
{
    [MenuItem("GameObject/Rename Selected To Square")]
    public static void RenameSelected()
    {
        foreach (GameObject obj in Selection.gameObjects)
        {
            obj.name = "Square_" + obj.name;
        }
        Debug.Log("Seçili objelerin isimleri güncellendi.");
    }

    [MenuItem("GameObject/Rename Selected To Square", validate = true)]
    public static bool ValidateRenameSelected()
    {
        return Selection.gameObjects != null && Selection.gameObjects.Length > 0;
    }
}

İpucu 3: Çalışma Akışını Hızlandıran Kısayollar

Sıkça kullandığınız editör fonksiyonlarına veya kendi özel araçlarınıza kısayollar atayarak fare hareketini azaltın. Özellikle tekrar eden test senaryoları veya sahne düzenleme işlemleri için bu oldukça faydalıdır. İyi tasarlanmış bir Unity MenuItem kısayolu, geliştirme sürenizi kısaltabilir.

Yaygın Hatalar ve Çözümleri

Hata 1: Statik ve Void Olmayan Metotlar

Hata: `MenuItem` ile işaretlenmiş metodun `static` veya `void` olmaması.
Çözüm: Metodunuzu mutlaka public static void olarak tanımlayın. Validation metotları için ise public static bool kullanın.

Hata 2: Editor Klasörüne Yerleştirilmeyen Scriptler

Hata: `MenuItem` içeren script’in projenin kök dizininde veya standart bir klasörde olması.
Çözüm: `MenuItem` gibi editör scriptleri, Unity’nin Editor adını taşıyan özel bir klasörün içinde veya bir alt klasöründe bulunmalıdır (örn: `Assets/Editor/MyTools.cs`). Bu klasördeki scriptler yalnızca editörde derlenir ve oyunun çalışma zamanı derlemesine dahil edilmez.

Hata 3: `using UnityEditor;` Eksikliği

Hata: Script dosyasının başında using UnityEditor; ifadesinin unutulması.
Çözüm: `MenuItem` attribute’u `UnityEditor` namespace’i içinde yer aldığından, bu namespace’i dahil etmeniz gerekir.

Hata 4: Çakışan Kısayollar veya Menü Yolları

Hata: Birden fazla menü öğesinin aynı yola veya aynı kısayola sahip olması.
Çözüm: Her menü öğesi için benzersiz bir yol ve kısayol kullanmaya özen gösterin. Çakışmalar, beklenen davranışın gerçekleşmemesine veya bir menü öğesinin diğerini geçersiz kılmasına neden olabilir. Unity MenuItem yollarının benzersizliği önemlidir.

Hata 5: Validation Metodunda Hata

Hata: Validation metodunun karmaşık veya uzun süren işlemler içermesi.
Çözüm: Validation metotları, Unity editörü menüyü her çizdiğinde (genellikle her frame’de) çağrılır. Bu nedenle, bu metotların çok hafif ve hızlı olması gerekir. Ağır işlemlerden kaçının ve yalnızca gerekli kontrolleri yapın. Aksi takdirde editör performansı düşebilir.

Performans ve Optimizasyon Notları

Unity MenuItem attribute’u ve ilişkili metotlar yalnızca Unity editörü ortamında çalışır. Oyununuz derlenip bir yapım (build) olarak dışarı aktarıldığında, bu kodlar dahil edilmez. Bu nedenle, `MenuItem`’in kendisinin oyununuzun çalışma zamanı performansı üzerinde doğrudan bir etkisi yoktur.

Ancak, yukarıda bahsedildiği gibi, özellikle `validate` metotlarının ve `MenuItem` tarafından çağrılan fonksiyonların performansına dikkat etmek önemlidir. Eğer bir `MenuItem` fonksiyonu çok karmaşık ve uzun süren bir işlem yapıyorsa, bu işlem editörü kilitleyebilir veya yanıt vermemesine neden olabilir. Uzun süren işlemler için ilerleme çubukları (`EditorUtility.DisplayProgressBar`) kullanmak veya işlemi ayrı bir thread’de (dikkatli bir şekilde) çalıştırmak gibi yöntemler düşünülebilir.

Sonuç

Unity MenuItem attribute’u, Unity editörünü kendi ihtiyaçlarınıza göre özelleştirmenizi sağlayan güçlü ve esnek bir araçtır. Özel menü öğeleri oluşturarak geliştirme süreçlerinizi hızlandırabilir, tekrarlayan görevleri otomatikleştirebilir ve ekibinizin iş akışını daha verimli hale getirebilirsiniz. Bu makaledeki ipuçlarını ve yaygın hata çözümlerini uygulayarak, Unity’de daha verimli ve keyifli bir geliştirme deneyimi yaşayabilirsiniz. Kendi özel araçlarınızı oluşturmaktan çekinmeyin; bu, bir oyun geliştiricisinin en değerli yeteneklerinden biridir.