PL/Resource:Helpmanager

Helpmanager dostarcza graczom informacji o interfejsach GUI na serwerze i innych skryptach. Ma on prosty mechanizm dodawania nowych instrukcji. Dodatkowo gracz otrzymuje powiadomienie na dole ekranu po załadowaniu się zasobu.

Użycie

Proste GUI

Jeśli chcesz dodać jakiś tekst, dodaj poniższą linijkę do meta.xml

<config src="help.xml" type="client"/>

Zawartość poniżej węzła głównego pliku help.xml zostanie wyświetlona na karcie pomocy w zasobie. Można także dodać opcjonalną opcję popup="no" do węzła głównego, aby określić, że nie chcesz, aby gracz był powiadamiany, gdy strona będzie dostępna.

Przykładowo

<help popup="no">
Jakiś pomocny tekst
</help>

Tekst pomocowy powinien wyjaśniać zasady rozgrywki trybu gry, opisywać przypisane klawisze oraz komendy. Pamiętaj, że te instrukcje są dla graczy - nie dla skrypterów, więc staraj pisać się prostym językiem.

Własne GUI

Możesz dodać swoje własne GUI panelu pomocy, dodając ręcznie zakładkę w skrypcie

mojaZakladka = call(getResourceFromName("helpmanager"), "addHelpTab", getThisResource(), true)

Możesz dodać zawartość, używając zwróconego elementu GUI jako elementu nadrzędnego GUI dla swoich widżetów. Nie ma potrzeby ich niszczenia podczas usuwania strony/zatrzymywania zasobów, ponieważ menedżer zajmuje się czyszczeniem.

Klawiszologia

F9: Otwiera/zamyka okno pomocy

Komendy

gamehelp: Otwiera/zamyka okno pomocy

Eksportowane funkcje

Server

bool showHelp ( element showTo )

Pokazuje okno pomocy dla elementu showTo, podążając w dół drzewka.

bool hideHelp ( element hideTo )

Ukrywa okno pomocy dla elementu showTo, podążając w dół drzewka.

Client

bool showHelp ()

Pokazuje okno pomocy dla danego klienta (localPlayer)

bool hideHelp ()

Ukrywa okno pomocy dla danego klienta (localPlayer)

gui-tab addHelpTab ( resource forResource, [bool showPopup = true] )

Dodaje zakładkę o nazwie określonego zasobu do okna pomocy. Jeśli showPopup jest ustawione na false to powiadomienie o pojawieniu się nowej strony nie zostanie wyświetlone.

bool removeHelpTab ( resource forResource )

Usuwa zakładkę o nazwie określonego zasobu z panelu pomocy.

Wywoływane zdarzenia (eventy)

Client

(Dla wszystkich zdarzeń source to localPlayer)

onHelpShown ()

onHelpHidden ()