UnCodeX
Ogólnie
UnCodeX przetwarza kod źródłowy UnrealScript i przedstawia go w bardziej nawigacyjnym formacie. Pozwala programiście łatwo nawigować kod źródłowy i tym samym zyskać więcej wglądu w jaki sposób wszystkie klasy są ze sobą powiązane. Dodatkowo JavaDoc, jako dokument HTML, może zostać utworzony ze źródła.
UnCodeX jest doskonałym towarzyszem, kiedy używasz swojego ulubionego edytora tekstowego do programowania w UnrealScript, ale może też być przydatnym dodatkiem do UnrealScript tak jak edytory
nFringe albo WOTgreal.
Ten dokument wyjaśni jak zainstalować i używać UnCodeX.
Instalacja
[list=1]
- Pobierz najnowszą wersję UnCodeX ze strony projektu.
- Uruchom instalator i podążaj za kolejnymi krokami.
- Przy pierwszym uruchomieniu UnCodeX zostaniesz zachęcony do zmiany ustawień. Wciśnij yes, aby otworzyć okno ustawień programu.
[list=1]
- Jedyną wymaganą konfiguracją jest ustawienie Source Paths.
- Wciśnij przycisk add i wybierz katalog, który zawiera kod UnrealScript, który chcesz dołączyć.
- Dla UDK powinieneś wybrać c:\UDK\Development\Src
- Zamknij okno ustawień, wciskając przycisk ok.
- UnCodeX zachęci cię teraz do przeskanowania i analizy źródeł.
[list=1]
- Wciśnij yes, aby zeskanować i przeanalizować
- Ten proces może potrwać trochę czasu w zależności od ilości plików źródłowych i od szybkości twojego komputera
- Kiedy dokonasz zmian strukturalnych, jak dodanie nowych paczek, powinieneś przebudować i przeanalizować drzewo. Może być to zrobione poprzez menu Tree > Rebuild & Analyse (Ctrl+B)
- UnCodeX jest teraz gotowy do użycia.
Aby uzyskać więcej informacji o innych ustawieniach, proszę sprawdzić plik pomocy UnCodeX.
Jeżeli napotkasz błędy podczas analizy kodu źródłowego, proszę sprawdzić sekcję
Usuwania błędów.
Zastosowanie
Główne oknoPoniżej znajduje się zrzut ekranu głównych okien w domyślnej konfiguracji.

[list=1]
- To jest drzewo klasy. Pokazuje dziedziczenie wszystkich klas. Jest to główna część interfejsu użytkownika i jest to jedyna część, której nie możesz przesunąć lub wyłączyć. Klikając PPM na tym drzewie pokażą się jakieś dodatkowe funkcjonalności.
- To jest paczka drzewa. Pokazuje różne paczki i klasy, którą są zawarte. Możesz łatwo przełączać się między dwoma drzewami na wybranej klasie, używając Ctrl+Tab.
- Podgląd źródła. To pokazuje tylko przeczytane, z podświetloną składnią wersję kodu źródłowego wybranej klasy. Możesz kliknąć na znane klasy UnrealScript, aby przeglądnąć kod źródłowy tej klasy.
- To jest dziennik. Poza zakomunikowaniem różnych informacji jak błędy czy ostrzeżenia przy analizie kodu źródłowego i błędów programu, jest również używany do wyświetlania pełnych wyników wyszukiwania tekstu.
Piąty element głównego okna jest domyślnie ukryty: Property Inspector (pol.
Inspektor właściwości) (Ctrl+Alt+I). Ten element pokazuje szczegóły aktualnie wybranej klasy. W te szczegóły wliczają się zdefiniowane zmienne, struktury, wyliczenia, stałe, funkcje i stany. Kiedy klikniesz na te właściwości, zostaniesz bezpośrednio przekierowany do
source preview (pol.
podglądu źródła) do miejsca, w którym właściwość została zdefiniowana w kodzie źródłowym.
Pokazujesz i ukrywasz różne panele poprzez główne menu w podmenu
View. Możesz przesuwać panele poprzez ciągnięcie uchwytów (dwie poziome lub pionowe kreski) w górę lub lewo. I możesz zmienić rozmiar paneli poprzez wsuwanie części między panele.
Wyszukiwanie Są różne metody, by przeszukać kod UnrealScript w UnCodeX.
Kiedy jedno z drzew (drzewo klasy lub drzewo paczki) jest zwinięte, możesz zacząć pisać i wtedy automatycznie spróbuje znaleźć następną klasę (lub paczkę), która zaczyna się od tekstu, który właśnie wpisałeś. Zacznie wyszukiwanie od aktualnie zaznaczonego elementu. Możesz użyć
Find > Find Next (F3), aby znaleźć następny element, który zacznie się od wpisanego tekstu (patrz pasek stanu aplikacji). Wciśnij klawisz ESC, aby anulować wyszukiwanie w miejscu.
Możesz również znaleźć klasę poprzez otwarcie okna
Find Class (w menu
Find lub
Ctrl+F).
Trzecią możliwością wyszukiwania jest tak zwane wyszukiwanie
Full Text (
Ctrl+T). Wyszukiwanie pełnotekstowe pozwala ci szukać tekstu we wszystkich plikach źródłowych. W pełnym wyszukiwaniu możesz używać wyrażeń regularnych (tylko podstawowe funkcje wyrażeń regularnych mogą zostać użyte). Możesz również ograniczyć zakres plików źródłowych do przeszukania, to pozwoli ci do przeszukania tylko hierarchicznego podzbioru kodu źródłowego. Wyniki wyszukiwania pełnego tekstu zostaną kolejno wymienione w oknie dziennika. Klikając na te wyniki, otworzy się plik źródłowy w danym miejscu w podglądzie źródła, albo klikając dwukrotnie, otworzy się w skonfigurowanym edytorze.
Uruchamianie gryPoprzez menu
Launch game możesz uruchomić instancję klienta lub serwera gry. Dwie opcje
Run server i
Join server mogą być skonfigurowane w menu ustawień.
Opcja
Run ... (Ctrl+X) w menu
Launch game dostarcza więcej opcji uruchamiania różnych instancji gry. To jest podstawowy graficzny interfejs użytkownika do konfigurowania i wykonania polecenia. Można także utworzyć kilka ustawień.
Usuwanie błędów
Analiza kodu źródłowego Podczas analizy kodu źródłowego mogłeś natknąć się na następujące ostrzeżeniami albo błędy:
Odrzucony leksem (ang. Discarding token)[indent]Możesz zignorować tą wiadomość. Czasami parser kodu źródłowego natrafia na znaki, których nie oczekiwano, ale mógł bezpiecznie zignorować.[/indent]
Pusta paczka (ang. Empty package)[indent]UnCodeX znalazł katalog w jednej ze ścieżek źródła, która przypomina paczkę UnrealScript, ale nie znajduje w niej żadnej klasy. Jeśli później dodasz klasy do tej paczki, to będziesz musiał przebudować drzewo.[/indent]
Dostrzeżony sierota (ang. Orphan detected)[indent]Wspomniana klasa rozszerza klasę, która nie została znaleziona w istniejącym drzewie klasy. Albo popełniłeś błąd programistyczny, albo zapomniałeś dołączyć ścieżki źródła, która zawiera paczkę z tą klasą.[/indent]
Nieobsługiwany wyjątek w klasie... (ang. Unhandled exception in class...)[indent]Kiedy taki błąd jak ten pojawia się podczas analizy kodu źródłowego, to prawdopodobnie jest spowodowany poważnym błędem w kodzie źródłowym. Ten błąd często występuje w spisie historii, ostatni wpis w historii zazwyczaj wskazuje, w którym wierszu zaczyna coś być źle. Ale najlepszym sposobem, aby znaleźć błąd jest kompilacja kodu. Jeśli otrzymujesz ten błąd kiedy indziej, to prawdopodobnie jest to defekt w programie.[/indent]
Brakujące klasy lub paczki UnCodeX nie rozpoznaje nowych paczek automatycznie, i z tego samego powodu nie znajduje nowych klas w istniejących paczkach. Aby je zobaczyć, musisz przebudować i zanalizować drzewa klasy i paczki.
Tłumaczenie ze strony:
http://udn.epicgames.com/Three/UnCodeX.htmlDokumentacja klas UnrealScript (utworzona za pomocą UnCodeX):
http://www.codekisk.com/unreal/ut3/scriptref/Dokumentacja na wiki klas UnrealScript:
http://wiki.beyondunreal.com/Category:UDK-specific_classes