UI code in 2d-space-shooter sample

mendop · September 10, 2024, 9:01am

I see in ui-toolkit docs that all code that interacts with ui should be inside the OnEnable method, yet the sample has it in Awake method.
It’s confusing right now for someone following the official sample.

github.com

Unity-Technologies/com.unity.multiplayer.samples.bitesize/blob/main/Basic/2DSpaceShooter/Assets/Scripts/NetworkManagerHud.cs

using System;
using System.Collections;
using System.Runtime.CompilerServices;
using System.Text.RegularExpressions;
using Unity.Netcode;
using Unity.Netcode.Transports.UTP;
using UnityEngine;
using UnityEngine.UIElements;

[RequireComponent(typeof(NetworkManager))]
[DisallowMultipleComponent]
public class NetworkManagerHud : MonoBehaviour
{
    NetworkManager m_NetworkManager;

    UnityTransport m_Transport;

    // This is needed to make the port field more convenient. GUILayout.TextField is very limited and we want to be able to clear the field entirely so we can't cache this as ushort.
    string m_PortString = "7777";
    string m_ConnectAddress = "127.0.0.1";

This file has been truncated. show original

DarkRewar · September 10, 2024, 9:09am

I don’t understand what your question is.

Yet, it doesn’t matter where you put your UITK code. It depends on your needs ; you may use it once at Start/Awake/OnEnable if you want, but you could totally Query() your elements at anytime anywhere.

For example: you could make a routing system that instantiate views at runtime. Then, you will retrieve your UIElements in a specific method that isn’t a Unity native method.

mendop · September 10, 2024, 9:33am

The docs page says:
“Unity loads a UI Document component’s source UXML when OnEnable is called on the component. To ensure the visual tree is loaded correctly, add logic to interact with the controls inside the OnEnable method.”

This means if you do it in Awake() it might not work correctly.