Сериализуемые классы

Часть раздела Архитектура игр в Unity путешествия по Unity на Coddy. Урок 15 из 50.

Скрипт с большим количеством настроек отображается в Inspector длинным плоским списком. Обычный класс C# позволяет сгруппировать их: пометь его атрибутом [System.Serializable], и поле этого класса будет отображаться в виде сворачиваемой группы с названием поля и полями класса внутри. Один класс может использоваться для нескольких полей и нескольких скриптов:

[System.Serializable]
public class Stats
{
    public float speed = 2f;
    public int damage = 10;
}

public class Enemy : MonoBehaviour
{
    public Stats normal;
    public Stats enraged;
    private Stats current;

    void Start()
    {
        current = normal;
    }

    void Update()
    {
        transform.Translate(0f, 0f, current.speed * Time.deltaTime);
    }

    public void Enrage()
    {
        current = enraged;
    }
}

В Inspector отображаются две сворачиваемые группы — Normal и Enraged, в каждой из которых есть Speed и Damage. У каждого Enemy есть собственные два объекта Stats, значения которых задаются в его Inspector, а код обращается к ним через normal.speed. Unity создаёт эти объекты при загрузке скрипта, поэтому normal никогда не равен null даже без = new Stats(), а значения инициализаторов полей (2 и 10) используются для нового Enemy. Структура работает так же с атрибутом: [System.Serializable] public struct Range { public float min; public float max; }, и, как Vector3, копируется при присваивании.

Атрибут необходим, потому что Unity сохраняет только те типы, для которых ей это указано. Без него класс невидим для Inspector: сворачиваемой группы нет, заданные там значения не сохраняются, а Unity не создаёт объект, поэтому normal.speed вызывает исключение NullReferenceException. Внутри класса действуют обычные правила Inspector: публичные поля или приватные поля с атрибутом [SerializeField], но не свойства и не статические поля.

Задание

Легко

У фонаря исследователя два луча, и клавиша Space переключает их: широкий тёплый луч для осмотра вокруг и сфокусированный холодный белый луч, который освещает глубину пещеры. В Flashlight.cs три настройки каждого луча хранятся в шести отдельных полях. Сцена уже настроена так, что настройки сгруппированы по лучам, и скрипт должен соответствовать ей:

Объяви структуру Beam с тремя публичными полями: color (тип Color), range и angle (типа float). Она должна отображаться в Inspector.
Замени шесть отдельных полей двумя полями Beam: wide и focused. В сцене для wide задан тёплый цвет, дальность 6 и угол 80, а для focused — холодный белый цвет, дальность 15 и угол 25.
Сделай так, чтобы Apply() считывал Beam текущего луча и задавал у Light значения color, range и spotAngle из него. Остальное оставь без изменений: фонарь начинает работу с широким лучом, а Space переключает лучи.

Нажми Play, затем Space, чтобы осветить дальний конец пещеры, а после этого нажми Check.

Попробуйте сами

using UnityEngine;
using UnityEngine.InputSystem;

public class Flashlight : MonoBehaviour
{
    public Color wideColor = Color.white;
    public float wideRange = 5f;
    public float wideAngle = 60f;
    public Color focusedColor = Color.white;
    public float focusedRange = 10f;
    public float focusedAngle = 30f;
    private bool focusedOn;
    private Light lamp;

    void Start()
    {
        lamp = GetComponent<Light>();
        Apply();
    }

    void Update()
    {
        if (Keyboard.current.spaceKey.wasPressedThisFrame)
        {
            focusedOn = !focusedOn;
            Apply();
        }
    }

    void Apply()
    {
        lamp.color = focusedOn ? focusedColor : wideColor;
        lamp.range = focusedOn ? focusedRange : wideRange;
        lamp.spotAngle = focusedOn ? focusedAngle : wideAngle;
    }
}