[Unity]客製化Inspector

 設計自己的Inspector!

緣由

自從改用GameManager的GameLoop來統一控制遊戲的整體流程後，唯一讓我困擾的是他的Inspector視窗，裡面的屬性真的太長~了，每次要除錯都要找一下子，雖然各資料屬性是class所以可以摺疊，但總歸還是非常不便(如圖，很長一大串)。


Editor資料夾

要使自己的腳本是在編輯中執行而不是在遊戲中執行的話，需要在Assets根目錄下新增一個資料夾取名為Editor，經由特殊資料夾名稱，系統會將下面的腳本認定為Editor 腳本(如圖)。


腳本

匯入與繼承

如我在資料夾內的那3個腳本一樣，新增一個腳本然後取一個你想要的名字吧。

1.首先需要匯入編輯器的命名空間 UnityEditor
2.然後添加Attribute : CustomEditor，其用途是告訴編輯器，哪一個腳本是你要自訂的對象。
3.使你腳本改繼承 Editor

using System.Collections;
using System.Collections.Generic;
using UnityEditor;

/// <summary>
/// 客製化GameManager (MainGameLoop) 的視窗
/// </summary>
[CustomEditor(typeof(MainGameLoop))]
public class GameManagerInspector : Editor
{

覆寫Inspector的GUI設計

Editor有很多功能可以覆載，我們這次只要處理Inspector，所以只要覆載OnInspectorGUI就好。
並且指定要編輯的物件 _gameLoop，這裡有一點要注意，是可以多物件編輯的，但是Editor.target只會引用第一個已編輯物件。


    
public class GameManagerInspector : Editor
{
    public override void OnInspectorGUI()
    {
        MainGameLoop _gameLoop = (MainGameLoop)target;

開始Inspector內的處理吧

GameLoop內的屬性簡單介紹

在進行Inspector的覆寫之前，先來介紹目標類別的一些屬性吧，以好比對指定了那些屬性。

提供選單列舉

為了讓使用者可以選擇目前要設定的屬性，所以我們要創造一個列舉，在裡面放入選單的元素，在Unity內，只要有列舉型別的全域變數，在inspector內就會被視為選單(如圖)。

    
    /// <summary>
    /// Inspector設定的頁面類型
    /// </summary>
    public enum SettingType
    {
        MainCameraProcess,
        BookUI,
        SoundEffect,
        WarUI,
        OptionPage,
        SavePage
    }
    public SettingType MainSettingType;

屬性

在GameLoop或你自己的有繼承MonoBehavior的類別內，有些需要在Inspector指定數值或物件的資料類別屬性，在此不贅述。
    
    [Header("BookUI的資料")]
    public BookUIData MainBookUIData;

    [Header("SoundEffectData的資料")]
    public SoundEffectData MainSoundEffectData;

    [Header("選項頁面的資料")]
    public UIOptionCtrlData MainUIOptionCtrlData;

    [Header("戰爭UI的資料")]
    public WarUICtrlData MainWarUICtrlData;

顯示下拉清單

回到Editor腳本的OnInspectorGUI()這裡，由於覆載了GUI的顯示功能，所以目前GameLoop的屬性視窗是什麼都不會顯示的，為此我們使用EditorGUILayout.EmumPopup來顯示下拉式選單，"頁面類型"為會顯示在上面的清單名稱。
    
        MainGameLoop _gameLoop = (MainGameLoop)target;

        //顯示下拉是列舉清單
        _gameLoop.MainSettingType =
            (MainGameLoop.SettingType)EditorGUILayout.EnumPopup("頁面類型",
            _gameLoop.MainSettingType);

序列化物件

屬性欄位

像是物件屬性，或是實質型別屬性(float,int...)其實有 像是EditorGUILayout.FloatField或是EditorGUILayout.ObjectField這種方法可以使用，但原本的Attribute就會消失，而在原本屬性名稱的位置則可以自由地輸入你想要的名稱。

由於要抓取自己的類別屬性，或是抓取普通的屬性，都可以使用屬性欄位PropertuField，為了方便使用，我統一都使用

EditorGUILayout.PropertyField

完成修改後，應用屬性修改ApplyModifiedProperties()很重要，不能沒有加。

另一點，"CanvasUI"是你那個屬性的名稱，也就是說，如果你的屬性是 float _value1;，那你要輸入的就是"_value1"。

true是用來確認要不要顯示內藏的值，如果沒有打true，則會再inspector顯示屬性的名稱與箭頭，但是不管打開關閉箭頭都不會有內部的值跑出來讓你設定


    
        serializedObject.Update();
        EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("CanvasUI"), true);
        serializedObject.ApplyModifiedProperties();

加入選擇

在來就是透過選單來切換要在Inspector顯示的屬性們啦!
我的作法是把所需要的資料都封裝在各自的資料類別內，這樣只要我抓取所宣告的資料類別屬性，我要動態的增減都不用再動到Editor腳本。
    
        switch (_gameLoop.MainSettingType)
        {
            case MainGameLoop.SettingType.MainCameraProcess:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainCameraProcessData"), true);
                break;
            case MainGameLoop.SettingType.BookUI:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainBookUIData"), true);
                break;
            case MainGameLoop.SettingType.SoundEffect:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainSoundEffectData"), true);
                break;
            case MainGameLoop.SettingType.WarUI:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainWarUICtrlData"), true);
                break;
        }


完成

完成的樣子

最後目標類別在Inspector視窗會顯示的樣子如圖，可以透過頁面類型，來自由切換想設定的值




完整程式碼

在此提供Editor部分的程式碼。

    
using System.Collections;
using System.Collections.Generic;
using UnityEditor;

/// <summary>
/// 客製化GameManager (MainGameLoop) 的視窗
/// </summary>
[CustomEditor(typeof(MainGameLoop))]
public class GameManagerInspector : Editor
{
    public override void OnInspectorGUI()
    {
        MainGameLoop _gameLoop = (MainGameLoop)target;

        //顯示下拉是列舉清單
        _gameLoop.MainSettingType =
            (MainGameLoop.SettingType)EditorGUILayout.EnumPopup("頁面類型",
            _gameLoop.MainSettingType);
        serializedObject.Update();
        switch (_gameLoop.MainSettingType)
        {
            case MainGameLoop.SettingType.MainCameraProcess:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainCameraProcessData"), true);
                break;
            case MainGameLoop.SettingType.BookUI:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainBookUIData"), true);
                break;
            case MainGameLoop.SettingType.SoundEffect:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainSoundEffectData"), true);
                break;
            case MainGameLoop.SettingType.WarUI:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainWarUICtrlData"), true);
                break;
            case MainGameLoop.SettingType.OptionPage:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainUIOptionCtrlData"), true);
                break;
            case MainGameLoop.SettingType.SavePage:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainUISaveCtrlData"), true);
                break;
            case MainGameLoop.SettingType.MissionPage:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainUIMissionCtrlData"), true);
                break;
            case MainGameLoop.SettingType.ItemPage:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainUIItemCtrlData"), true);
                break;
            case MainGameLoop.SettingType.WeaponPage:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainUIWeaponCtrlData"), true);
                break;
            case MainGameLoop.SettingType.WeaponProcess:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainWeaponProcessData"), true);
                break;
            case MainGameLoop.SettingType.MusicCtrl:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainMusicCtrlData"), true);
                break;
            case MainGameLoop.SettingType.PlayerCtrl:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainPlayerCtrlData"), true);
                break;
            case MainGameLoop.SettingType.DialogSystem:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainDialogSystemData"), true);
                break;
            case MainGameLoop.SettingType.PlotSystem:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainPlotData"), true);
                break;
            case MainGameLoop.SettingType.Training:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainTrainingData"), true);
                break;
            case MainGameLoop.SettingType.LoadingProcess:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainLoadingProcessData"), true);
                break;
            case MainGameLoop.SettingType.StoreSystem:
                EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("MainStoreData"), true);
                break;

        }

        EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("PlayerObject"), true);
        EditorGUILayout.PropertyField(serializedObject.FindProperty
                  ("GameBlack"), true);
        EditorGUILayout.PropertyField(serializedObject.FindProperty
                ("CanvasUI"), true);
        serializedObject.ApplyModifiedProperties();
    }
}

留言

張貼留言

這個網誌中的熱門文章

[Unity] 關於Android 的環境設定，使用自己的SDK/JDK/NDK

圖片
前言 由於有時候使用Unity安裝Android環境要用來開發 有時候很順利，但有時候也會遇見莫名其妙遺失SDK或是NDK這種問題 再加上Unity 在安裝編輯器的時候，選擇的Android 開發模組，它所安裝的sdk、jdk、ndk皆是各別安裝在各個版本的unit編輯器資料夾下,對於工作中會使用到各種版本的我來說，明明是同一個sdk 卻重複安裝 實在是很浪費硬碟空間，所以也想讓各個編輯器重複使用相同的工具 開始安裝 在此說明環境 Unity Editor 2022.3.20f1 ，因為Unity Hub的Bug，2022的某些版本使用Hub安裝會出現編輯器應用程式安裝失敗的問題 所幸直接使用 官網下載 的Unity Installer來安裝，並安裝Android的模組 打開Unity環境設定可以發現 將Unity提供的選項關閉，他上面會顯示需要使用的版本 像是 JDK      需要 11.0.14.1            NDK    需要 23.1.7778620 JDK  JDK我們可以使用OpenJDK的就好，輕鬆無負擔，可以從官網下載也可以用微軟提供的 因為微軟的比較好找到需要的版本所以這裡使用 微軟提供 的 在JDK 11的 Release頁面找到 11.0.14.1 依照你的系統下載所需的安裝檔 回到JDK的部分然後指定剛剛安裝的檔案資料夾 Unity一定會出現警告，但是沒關係，還是可以使用。 NDK和SDK 我們使用 Android Studio IDE來獲得 NDK 點開SDK Manager，選擇 SDK Tools 開啟 Show Package Details以顯示各種版本 找到NDK的位置點開摺疊 下載 23.1.7779620 版本 按下Apply 下載完畢後在SDK安裝位置下面找到NDK的資料夾 然後點選 23.1.7779620資料夾即可 SDK 接下來回到Android Studio的SDK Manager 並下載 Android SDK Command-line Tools(latest) 不下載最新版是有根據的，因為太新的SDK Command-line Tools 他所依照的JDK要求會太高，...
閱讀完整內容

[Godot] Sprite Sheet 使用以及HDR Glow 發光效果

圖片
前言 由於我想在Godot中實現2D的Glow效果，所以試著用出來。 注意:我的版本是 4.1.1 的Net版本，我有發現到目前使用 「相容」(Compatibility) 會出現 "Godot environment is not supported when using the GL compatibility backend yet" 的錯誤，所以這個範例只好使用 前向渲染 ( Forward+ ) 準備素材: 要使用 Sprite Sheet 一張 要用來發光的 Emission 貼圖一張 我是用Aseprite直接畫的，大家也可以自己試著畫畫看，只要透過灰階就可描繪出你想要的亮暗變化 Godot操作 這裡使用的是 Forward+ Render引擎   1. 世界環境  在主要節點下添加一個 WorldEnvironment 節點 並新增環境 2.設定背景 在世界環境的屬性面板將Background的模式設成 畫布( Canvas ) 3.設定Glow 首先要打開 Glow ，請Enable它 再來將混合模式測定成 疊加 會比較明顯 (用預設的柔光也可喔，只是數值要激進一點) 接下來調整 HDR閾值 理論上就會有效果了 HDR Threshold 當 HDR Threshold ，是用來判定當哪些光源亮度超過一個特定值時，會應用到Glow效果，所以如果你會發現當你設成0.9或其他小於1的值時，畫面上開始有發光效果了，這就代表你原本場頸上所有的亮度都低於1，所以當閾值為1時，看起來才沒有什麼效果 HDR Scale HDR Scale 會影響 HDR閾值與實際亮度之間的差距，所以當你將其數值調小時，亮度的尺度會被壓縮，就更輕易地超過了HDR閾值，所以也會有更亮的效果 最後我是調成如圖，但是你也可以隨意抓效果 4. Sprite動畫 a. 建立動畫2D精靈圖 新增一個 AnimatedSprite2D 節點 b. 新增Sprite Frames 在屬性中的Animation欄位內的 Sprite Frames 指定或是新增你要的精靈圖幀 c. 編輯 Sprite Frames  點兩下 剛剛指定的資源 這時會發現下方有打開一個 Sprite Frame 的視窗欄位 d. 匯入 SpriteSheet 還記得有準備 Spri...
閱讀完整內容

[Godot] 起始之初，編輯器認識:關聯Rider IDE

圖片
    在 9/13 號也就是今天，Unity 官方發布了一篇新聞稿，提及了他們的新政策，其有關於當超過多少營收且超過一定安裝數時，開發者就需要開始為每個安裝數支付所謂的Unity Runtime fee，離所當然的引起了廣大開發人員的不滿，也讓我深深感受到被獨大的商業引擎公司掐住脖子的壓迫感，為了可以更自在地開發遊戲，以及預防往後還有類似事情發生，我決定開始使用Godot引擎 圖源:維基百科/Godot Godot Game engine 是一款MIT授權的自由開源軟體，自由度非常高，而且產生物也完全歸使用者所有，引擎本身的開發又是由社群驅動的，說實話蠻吸引我的。 Godot 支援 跨平台，可以發布在  Windows Linux MacOS HTML5平台 ios 通用Windows平台(UWP) VR平台 以及Godot 3.5 開始提供的 Android平台 Godot 的腳本語言是使用於類似python 的GDScript、C#和C++，但是由於我是從Unity逃過來的，所以會選擇C#來開發，並且IDE就使用Rider吧 據官方 文檔 所說，Godot中的C#比起一些單純的GDScript還要快上4倍，並且用C++會更快，但是要注意C#與Godot通訊時會消耗許多吃效能的處理 以下先來介紹要怎麼把Rider與Godot整合 1. 打開你的Godot專案 2. 在上方工具欄的 編輯器 ，選擇 編輯器設定 3.在左側的視窗往下滑，滑到 Dotnet 設定， 點選 編輯器 4. 將外部編輯器(External Editor)選成 JetBrains Rider 就可以按 關閉 了 5. 在Rider中，請記得安裝 Godot Support 外掛 ，Github :  網址 然後當你直接點選你專案的CS檔應該就會自動開啟Rider了
閱讀完整內容