logo

Jak szukać przykładów i dokumentacji?

 

Dokumentacja metod platformy

Metody platformy posiadają dokumentację połączoną z kodem. Dzięki temu Visual Studio od razu po wybraniu metody pokaże Ci, co ona robi, jakie przyjmuje parametry oraz co zwraca. Jeżeli chcesz ręcznie przejrzeć metody i ich opisy, możesz zerknąć na te dwa linki:


- server-commands.ts
- client-commands.ts

 

Dokumentacja Union

Niestety, metody Union to tak naprawdę metody silnika Gothic, dlatego nie ma do nich obfitej dokumentacji. Najbardziej popularne przypadki przenieśliśmy do metod platformy. Aby stworzyć NPCa, nie potrzebujesz wykonać kilku metod Uniona (co jest normalnie praktyką, jeżeli piszesz w czystym Unionie), tylko jedną metodę Servera - CreateNpc. Na szczęście, do Uniona powstało już sporo pluginów, w których można podpatrzeć przykłady użycia. Ale jak je znaleźć?


Wyszukiwarka metod Union


Przez ostatnie lata powstało kilkadziesiąt projektów open source tworzących wtyczki do Union. Stworzyłem stronę, na której możesz wyszukać daną metodę we wszystkich najpopularniejszych źródłach (GitHub, forum WorldOfPlayers.ru). Nie jest to tak efektywne jak użycie dokumentacji, niestety metod Uniona jest kilka tysięcy i nie ma co liczyć, że ktoś to kiedyś wszystko udokumentuje.

 

Link: https://gothictogether.com/unionsearch

 

Przykłady z trybów gry

Zerknij na naszego GitLaba tutaj: https://gitlab.com/gothictogether! GitLab niestety nie pozwala szukać w obszarze grupy, więc możesz spróbować znaleźć dobry przykład w kodzie jednego z naszych gamemodów.

 

Zestaw gotowych snippetów

Postanowiłem również zbierać proste kilkulinijkowe przykłady użycia funkcjonalności, tak zwane Snippety - gotowe do przekopiowania i zmodyfikowania fragmenty kodu. Zerknij na naszego Discorda na forum Snippets, gdzie znajduje się kilkadziesiąt przykładów.