Používání Visual Studio Tools for Unity

V této části se dozvíte, jak používat nástroje Visual Studio Tools pro integraci a produktivitu Unity a jak používat ladicí program sady Visual Studio pro vývoj pro Unity.

Otevření skriptů Unity v sadě Visual Studio

Po nastavení sady Visual Studio jako externího editoru pro Unity se poklikáním na skript z editoru Unity automaticky spustí nebo přepne do sady Visual Studio a otevře vybraný skript.

Případně můžete visual Studio otevřít bez otevřeného skriptu ve zdrojovém editoru výběrem nabídky Assets > Open C# Project v Unity.

Screenshot of the Open C# project in Visual Studio.

Screenshot of the Open C# project in Visual Studio for Mac.

Přístup k dokumentaci k Unity

K dokumentaci ke skriptování Unity se dostanete rychle ze sady Visual Studio. Pokud Visual Studio Tools for Unity místně nenajde dokumentaci k rozhraní API, pokusí se ji najít online.

  • V sadě Visual Studio zvýrazněte nebo umístěte kurzor na rozhraní Unity API, o které se chcete dozvědět, a stiskněte kombinaci kláves Ctrl+Alt+M, Ctrl+H.
  • Místo vazby klíčů můžete použít také nabídku Reference k rozhraní Unity API nápovědy>.

Screenshot of the Unity API Reference menu in Visual Studio.

  • V Visual Studio pro Mac zvýrazněte nebo umístěte kurzor na rozhraní Unity API, o které se chcete dozvědět, a stiskněte Cmd+.
  • Místo vazby klíčů můžete použít také nabídku Reference k rozhraní Unity API nápovědy>.

Screenshot of the Unity API Reference menu in Visual Studio for Mac.

IntelliSense pro zprávy rozhraní Unity API

Dokončování kódu IntelliSense usnadňuje implementaci zpráv rozhraní Unity API ve skriptech MonoBehaviour a pomáhá s učením rozhraní Unity API. Použití IntelliSense pro zprávy Unity:

  1. Umístěte kurzor na nový řádek uvnitř těla třídy, která je odvozena od MonoBehaviour.

  2. Začněte psát název zprávy Unity, například OnTriggerEnter.

  3. Jakmile jsou písmena "ontri" zadána, zobrazí se seznam návrhů Technologie IntelliSense.

Screenshot of using IntelliSense in Visual Studio.

  1. Výběr v seznamu lze změnit třemi způsoby:

    • Klávesami Šipka nahoru a Šipka dolů

    • Kliknutím myší na požadovanou položku.

    • Pokračujte zadáním názvu požadované položky.

  2. IntelliSense může vložit vybranou zprávu Unity, včetně všech nezbytných parametrů:

    • Stisknutím klávesy Tab.

    • Stisknutím klávesy Enter.

    • Poklikáním na vybranou položku

Screenshot of the Insert Unity message from IntelliSense in Visual Studio.

Průvodce skriptováním Unity MonoBehavior

Pomocí průvodce MonoBehavior můžete zobrazit seznam všech metod rozhraní Unity API a rychle implementovat prázdnou definici. Tato funkce, zejména s povolenou možností Generovat komentáře metod, je užitečná, pokud se stále učíte, co je dostupné v rozhraní Unity API.

Vytvoření prázdných definic metody MonoBehavior pomocí průvodce MonoBehavior:

  1. V sadě Visual Studio umístěte kurzor na místo, kam chcete vložit metody, a stisknutím kombinace kláves Ctrl+Shift+M spusťte průvodce MonoBehavior. V Visual Studio pro Mac stiskněte klávesy Cmd+Shift+M.

  2. V okně Vytvořit metody skriptů zaškrtněte políčko vedle názvu každé metody, kterou chcete přidat.

  3. Pomocí rozevíracího seznamu Verze rozhraní vyberte požadovanou verzi.

  4. Ve výchozím nastavení jsou metody vloženy do pozice kurzoru. Alternativně se můžete rozhodnout, že je vložíte za libovolnou metodu, která je už ve vaší třídě implementovaná, změnou hodnoty rozevíracího seznamu Kurzor na požadované místo.

  5. Pokud chcete, aby průvodce vygeneroval komentáře pro vybrané metody, zaškrtněte políčko Generovat komentáře metody. Tyto komentáře vám pomůžou pochopit, kdy je metoda volána a jaké jsou její obecné odpovědnosti.

  6. Kliknutím na tlačítko OK ukončete průvodce a vložte metody do kódu.

Screenshot of the monobehavior wizard dialog in Visual Studio.

Screenshot of the monobehavior wizard dialog in Visual Studio for Mac.

Unity Project Explorer

Průzkumník projektu Unity zobrazuje všechny soubory a adresáře projektu Unity stejným způsobem jako Editor Unity. To se liší od procházení skriptů Unity pomocí normálního Průzkumník řešení sady Visual Studio, který je uspořádá do projektů a řešení vygenerovaného sadou Visual Studio.

  • V hlavní nabídce sady Visual Studio zvolte Zobrazit > Unity Project Explorer. Klávesová zkratka: Alt+Shift E+

Screenshot of the Unity Project Explorer window.

  • V Visual Studio pro Mac se panel řešení při otevření projektu Unity automaticky chová takto.

Ladění Unity

Visual Studio Tools for Unity umožňuje ladit editor i herní skripty pro projekt Unity pomocí výkonného ladicího programu sady Visual Studio.

Ladění v editoru Unity

Spuštění ladění

  1. Připojení Visual Studio do Unity kliknutím na tlačítko Tlačítko Přehrát s popiskem Připojit k Unity nebo použijte klávesovou zkratku F5.

Screenshot of the Attach to Unity button in Visual Studio.

  1. Připojení Visual Studio do Unity kliknutím na tlačítko Tlačítko Přehrát nebo napište Command + Return nebo F5.

Screenshot of the Play button in Visual Studio for Mac.

  1. Přepněte na Unity a kliknutím na tlačítko Přehrát spusťte hru v editoru.

Screenshot of the Play button in Unity on Windows.

Screenshot of the Play button in Unity on macOS.

  1. Když je hra spuštěná v editoru Unity během připojení k sadě Visual Studio, všechny zarážky, ke kterým došlo, pozastaví spuštění hry a vyvolá řádek kódu, ve kterém hra v sadě Visual Studio dosáhla zarážky.

Zastavení ladění

Klikněte na tlačítko Zastavit v sadě Visual Studio nebo použijte klávesovou zkratku Shift + F5.

Screenshot of the Stop button in Visual Studio.

Klikněte na tlačítko Zastavit v Visual Studio pro Mac nebo stiskněte Shift+Command+Return.

Screenshot of the Stop button in Visual Studio for Mac.

Další informace o ladění v sadě Visual Studio najdete v dokumentaci k prvnímu zobrazení ladicího programu sady Visual Studio.

Připojení k Unity a Play

Pro větší pohodlí můžete změnit tlačítko Připojit k Unity na Režim Připojit k Unity a Play .

  1. Klikněte na malou šipkudolů vedle tlačítka Připojit k Unity .

  2. V rozevírací nabídce vyberte Připojit k Unity a Přehrát .

    Screenshot of the Attach and play button in Visual Studio.

Tlačítko Přehrát se označí jako Připojit k Unity a Play. Kliknutím na toto tlačítko nebo pomocí klávesové zkratky F5 se teď automaticky přepne do editoru Unity a spustí se hra v editoru, a to kromě připojení ladicího programu sady Visual Studio.

Spuštění ladění a přehrávání editoru Unity můžete dokončit v jednom kroku přímo z Visual Studio pro Mac výběrem konfigurace Připojit k Unity a Play.

Screenshot of the Attach to Unity and Play button in Visual Studio for Mac.

Poznámka:

Pokud jste spustili ladění pomocí konfigurace Připojit k Unity a Play , tlačítko Zastavit také zastaví Unity Editor.

Ladění sestavení přehrávače Unity

Pomocí sady Visual Studio můžete ladit vývojové buildy hráčů Unity.

Povolení ladění skriptů v přehrávači Unity

  1. V Unity otevřete Nastavení sestavení výběrem Nastavení sestavení souboru>.

  2. V okně Sestavení Nastavení označte políčka Ladění vývojového sestavení a skriptů.

    Screenshot of the Unity build settings for debugging.

Vyberte instanci Unity, ke které chcete připojit ladicí program.

  • V sadě Visual Studio v hlavní nabídce zvolte Ladicí program Debug > Attach Unity Debugger.

    Screenshot of the Attach Unity Debugging Window in Visual Studio.

    Dialogové okno Vybrat instanci Unity zobrazí některé informace o jednotlivých instancích Unity, ke kterým se můžete připojit.

    Screenshot of the Choose an instance of Unity to connect to window in Visual Studio.

    Project Název projektu Unity, který běží v této instanci Unity.

    Počítač Název počítače nebo zařízení, na kterém je tato instance Unity spuštěná.

    Zadejte Editor, pokud je tato instance Unity spuštěna jako součást Unity Editoru; Player if this instance of Unity is a stand-alone player.

    Port Číslo portu soketu UDP, přes který tato instance Unity komunikuje.

Důležité

Vzhledem k tomu, že Visual Studio Tools for Unity a instance Unity komunikují přes síťový soket UDP, může brána firewall potřebovat pravidlo, které ji povolí. V případě potřeby se může zobrazit výzva, budete muset autorizovat připojení, aby služba VSTU a Unity mohla komunikovat.

Výběr instance Unity, která se nezobrazuje v seznamu

Pokud máte v seznamu spuštěný známý přehrávač Unity Player, který se nezobrazuje v seznamu, můžete použít tlačítko Vstupní IP adresa v okně Vybrat instanci Unity. Zadejte IP adresu a port spuštěného Unity Playeru pro připojení ladicího programu.

Aby bylo snazší pokračovat v ladění přehrávače bez nutnosti zadávat IP adresu a port pokaždé, povolte nastavení Použít uložené ladicí cíle v nabídce Nástroje Možnosti > nástroje > pro Unity > Obecné.

Screenshot of the Use saved debug targets setting.

Visual Studio zobrazí uložené cíle ladění jako možnost na tlačítku Připojit k Unity.

Screenshot of the Saved debug target setting.

  • V Visual Studio pro Mac v horní nabídce zvolte Spustit > připojení k procesu.
  • V dialogovém okně Připojit k procesu vyberte možnost Unity Debugger v rozevírací nabídce ladicího programu v dolní části.
  • Ze seznamu vyberte instanci Unity a klikněte na tlačítko Připojit .

Ladění knihovny DLL v projektu Unity

Mnoho vývojářů Unity píše komponenty kódu jako externí knihovny DLL, aby se jejich funkce mohly snadno sdílet s jinými projekty. Visual Studio Tools for Unity usnadňuje ladění kódu v těchto knihovnách DLL bez problémů s jiným kódem v projektu Unity.

Poznámka:

Visual Studio Tools for Unity v tuto chvíli podporuje jenom spravované knihovny DLL. Nepodporuje ladění nativních knihoven DLL kódu, jako jsou ty napsané v jazyce C++.

Všimněte si, že zde popsaný scénář předpokládá, že máte zdrojový kód – to znamená, že vyvíjíte nebo znovu používáte vlastní kód první strany nebo máte zdrojový kód do knihovny třetí strany a plánujete ho nasadit do projektu Unity jako knihovnu DLL. Tento scénář nepopisuje ladění knihovny DLL, pro které nemáte zdrojový kód.

Ladění spravovaného projektu knihovny DLL použitého v projektu Unity

  1. Přidejte existující projekt knihovny DLL do řešení sady Visual Studio vygenerované nástroji Visual Studio Tools for Unity. Méně často můžete spustit nový spravovaný projekt knihovny DLL, který bude obsahovat součásti kódu v projektu Unity; V takovém případě můžete do řešení sady Visual Studio přidat nový spravovaný projekt knihovny DLL.

    Screenshot of the Add > Existing Item menu.

    V obou případech visual Studio Tools for Unity udržuje odkaz na projekt, i když musí znovu vygenerovat soubory projektu a řešení, takže tyto kroky stačí provést jen jednou.

  2. Odkazovat na správný profil architektury Unity v projektu knihovny DLL. V sadě Visual Studio ve vlastnostech projektu knihovny DLL nastavte vlastnost Target framework na verzi architektury Unity, kterou používáte. Jedná se o knihovnu základních tříd Unity, která odpovídá kompatibilitě rozhraní API, kterou cílí váš projekt, například úplné knihovny základní třídy Unity, mikro nebo webové základní třídy. To brání knihovně DLL v volání metod architektury, které existují v jiných architekturách nebo úrovních kompatibility, ale které nemusí existovat ve verzi architektury Unity, kterou používáte.

Poznámka:

Následující informace se vyžadují jenom v případě, že používáte starší verzi modulu runtime Unity. Pokud používáte nový modul runtime Unity, nemusíte už tyto vyhrazené profily 3.5 používat. Použijte profil .NET 4.x kompatibilní s vaší verzí Unity.

Screenshot of the selecting target framework for a project in Visual Studio.

  1. Zkopírujte knihovnu DLL do složky Asset projektu Unity. V Unity jsou prostředky soubory zabalené a nasazené společně s vaší aplikací Unity, aby je bylo možné načíst za běhu. Vzhledem k tomu, že knihovny DLL jsou propojené za běhu, musí být knihovny DLL nasazené jako prostředky. Aby bylo možné nasadit jako prostředek, vyžaduje Editor Unity, aby knihovny DLL byly vloženy do složky Assets v projektu Unity. Můžete to udělat dvěma způsoby:

    • Upravte nastavení sestavení projektu knihovny DLL tak, aby zahrnovala podefinovaný úkol, který zkopíruje výstupní soubory DLL a PDB z jeho výstupní složky do složky Assets vašeho projektu Unity.

    • Upravte nastavení sestavení projektu knihovny DLL tak, aby jeho výstupní složka byla složka Assets vašeho projektu Unity. Soubory DLL i PDB se umístí do složky Assets .

    Soubory PDB jsou potřeba k ladění, protože obsahují symboly ladění knihovny DLL a mapují kód knihovny DLL na jeho formulář zdrojového kódu. Pokud cílíte na starší verzi modulu runtime, nástroje Visual Studio Tools for Unity použijí informace z knihovny DLL a PDB k vytvoření souboru DLL.MDB, což je formát symbolu ladění, který používá starší skriptovací modul Unity. Pokud cílíte na nový modul runtime a používáte Portable-PDB, Visual Studio Tools for Unity se nepokusí provádět žádné převody symbolů, protože nový modul runtime Unity dokáže nativně využívat soubory Portable-PDB.

    Další informace o generování PDB najdete tady. Pokud cílíte na nový modul runtime, ujistěte se, že je "Informace o ladění" nastavené na "Portable", aby bylo možné správně vygenerovat Portable-PDB. Pokud cílíte na starší verzi modulu runtime, musíte použít hodnotu Úplné.

  2. Ladění kódu Teď můžete ladit zdrojový kód knihovny DLL společně se zdrojovým kódem projektu Unity a používat všechny funkce ladění, které jste použili, například zarážky a krokování kódu.

Klávesové zkratky

K funkcím Unity Tools for Visual Studio se můžete rychle dostat pomocí jejich klávesových zkratek. Tady je souhrn dostupných klávesových zkratek.

Příkaz Zástupce Název příkazu zástupce
Otevření Průvodce MonoBehaviorem Ctrl+Shift+M EditorContextMenus.CodeWindow.ImplementMonoBehaviours
Otevření Průzkumníka projektů Unity Alt+Shift+E View.UnityProjectExplorer
Dokumentace k Access Unity Ctrl+Alt+M, Ctrl H+ Help.UnityAPIReference
Připojení k ladicím programu Unity (přehrávač nebo editor) bez výchozího nastavení Debug.AttachUnityDebugger

Kombinace klávesových zkratek můžete změnit, pokud se vám výchozí nastavení nelíbí. Informace o tom, jak ho změnit, najdete v tématu Identifikace a přizpůsobení klávesových zkratek v sadě Visual Studio.

Příkaz Zástupce Název příkazu zástupce
Otevření Průvodce MonoBehaviorem Cmd+Shift+M EditorContextMenus.CodeWindow.ImplementMonoBehaviours
Dokumentace k Access Unity Cmd+' Help.UnityAPIReference

Kombinace klávesových zkratek můžete změnit, pokud se vám výchozí nastavení nelíbí. Informace o tom, jak ho změnit, najdete v tématu Přizpůsobení integrovaného vývojového prostředí (IDE).