admin mGUI v0.2.1 - skrypt na tworzenie gui

mGUI, wprowadzenie:

• pewnie zastanawiacie się moi drodzy dlaczego was tu zgromadziłem i czym jest ten skryptowy cud przedstawiony w tytule - otóż znajdujecie się właśnie w poście nowego i niesamowitego dodatku do formatowania GUI stworzonego całkowicie w Skript.
   
• mGUI to w zamyśle połączenie oraz rozszerzenie najlepszych funkcji z popularnych dodaktów SkQuery oraz TuSKe; skrypt ma być ich aktualizowaną, niezbugowaną i przyjemną w użyciu alternatywą. Cały system owego dodatku opiera się na zasadzie identyfikatorów (każde GUI ma swój unikatowy ciąg znaków ustalany przez użytkownika), które pozwalają w prosty sposób odnosić się i zarządzać dowolnym GUI w dowolnym miejscu.
• Dzięki użyciu dodatku skript-reflect w skrypcie mogłem zrezygnować z funkcji na rzecz customowych efektów, warunków i innych (skromna dokumentacja znajduje się poniżej)

Instalacja, wymagania:

• skrypt pobieramy z linku poniżej, zapisujemy w pustym pliku w folderze /plugins/Skript/scripts (ważne jest to aby skrypt miał swój osobny plik; nie powinno się go edytować na własną rękę; nie powinno się zmieniać kolejności poszczególnych wydarzeń w skrypcie).
  
  po wgraniu i załadowaniu skryptu na serwer będzie on gotowy do użycia
  mGUI aktualizuje się automatycznie w przypadku posiadania dodatku AxAutoUpdate (ważne jest by nie usuwać drugiej linijki z wersją skryptu)
• zaznaczam iż skrypt pisany jest dla nowszych wersji minecrafta (tj. 1.14 i wyższych)
  testowane na: Paper 1.16.3; Skript 2.5.1; skript-reflect 2.1.0
   
• Wymagane pluginy:
  • Skript 2.4
  • skript-reflect
  • ^{[opcjonalnie]} Skrypt AxAutoUpdate autorstwa @xAxee

 
Nowe efekty, wyrażenia, wydarzenia i warunki:

• Spoiler

  • Events (wydarzenia):

    • 
      
      
      [on] [m[-]]gui click

      wykonuje się w momencie gdy gracz klika na slot ustawiony przez ten skrypt, dostępne wartości do pobrania to:

      • event-player - zwraca gracza który kliknął

      • event-number - indeks klikniętego slota

      • event-item - kliknięty przedmiot

      • event-click type - rodzaj kliknięcia (np. lewy przycisk, prawy, lewy z shiftem itp.)

  • Expressions (wyrażenia):

    • 
      
      
      [m[-]]gui of %player%
      %player%'s [m[-]]gui

      zwraca id GUI, które aktualnie ma otwarte dany gracz

  • Conditions (warunki):

    • 
      
      
      %integer% of [[m[-]]gui] %string% is unstealable

      w zasadzie zbędna raczej rzecz - sprawdza czy kliknięcie w slota powinno zostać zablokowane  (czy można wyjąć przedmiot)

    • 
      
      
      %player% has [m[-]]gui

      sprawdzamy czy gracz ma otwarte jakieś GUI ze skryptu

  • Efects (efekty):

    • 
      
      
      (create|make) [a] new [m[-]]gui %strings% with %integer% row[s] named %string%
      (create|make) [a] new [m[-]]gui %strings% with %integer% row[s] and shape %strings% named %string%

      • tworzymy nowe GUI o zadanych ID, liczbie rzędów, nazwie
      • tworzymy nowe GUI o zadanych ID, kształcie, liczbie rzędów, nazwie

    • 
      
      
      (format|make|set) [m[-]]gui slot[s] %numbers% of %strings% (with|to) %item%
      (format|make|set) [m[-]]gui slot[s] %numbers% of %strings% (with|to) %item% to be unstealable
      (format|make|set) [m[-]]gui slot[s] %numbers% of %strings% (with|to) %item% to close
      (format|make|set) [m[-]]gui slot[s] %numbers% of %strings% (with|to) %item% to open gui %string%
      (format|make|set) [m[-]]gui slot[s] %numbers% of %strings% (with|to) %item% to run %commandsender% command %string%
      (format|make|set) [m[-]]gui slot[s] %numbers% of %strings% (with|to) %item% to close and run %commandsender% command %string%

      tworzymy sloty o zadanych indeksach w wybranych gui o podanych ID z uzyciem przedmiotu
      przypadki kolejno:

      • przedmiot można wyciągać

      • przedmiotu nie można wyciągać

      • przedmiotu nie można wyciągać + po kliknieciu gui się zamknie

      • przedmiotu nie można wyciągać + po kliknieciu gui się zamknie + otworzy się nowe gui o podanym ID

      • przedmiotu nie można wyciągać + gracz lub konsola wykona podaną komendę

      • przedmiotu nie można wyciągać + gracz lub konsola wykona podaną komendę + gui zostanie zamknięte

    • 
      
      
      (format|make|set) [m[-]]gui shape[s] %strings% of %strings% (with|to) %item%
      (format|make|set) [m[-]]gui shape[s] %strings% of %strings% (with|to) %item% to be unstealable
      (format|make|set) [m[-]]gui shape[s] %strings% of %strings% (with|to) %item% to close
      (format|make|set) [m[-]]gui shape[s] %strings% of %strings% (with|to) %item% to open gui %string%
      (format|make|set) [m[-]]gui shape[s] %strings% of %strings% (with|to) %item% to run %commandsender% command %string%
      (format|make|set) [m[-]]gui shape[s] %strings% of %strings% (with|to) %item% to close and run %commandsender% command %string%

      wypełniamy wybrane kształty w wybranych gui wybranymi przedmiotami
      przypadki kolejno:

      • przedmiot można wyciągać

      • przedmiotu nie można wyciągać

      • przedmiotu nie można wyciągać + po kliknieciu gui się zamknie

      • przedmiotu nie można wyciągać + po kliknieciu gui się zamknie + otworzy się nowe gui o podanym ID

      • przedmiotu nie można wyciągać + gracz lub konsola wykona podaną komendę

      • przedmiotu nie można wyciągać + gracz lub konsola wykona podaną komendę + gui zostanie zamknięte

    • 
      
      
      (format|make|set) [m[-]]gui next slot of %strings% (with|to) %item%
      (format|make|set) [m[-]]gui next slot of %strings% (with|to) %item% to be unstealable
      (format|make|set) [m[-]]gui next slot of %strings% (with|to) %item% to close
      (format|make|set) [m[-]]gui next slot of %strings% (with|to) %item% to open gui %string%
      (format|make|set) [m[-]]gui next slot of %strings% (with|to) %item% to run %commandsender% command %string%
      (format|make|set) [m[-]]gui next slot of %strings% (with|to) %item% to close and run %commandsender% command %string%

      wstawiamy przedmiot do pierwszego wolnego slotu w gui o podanych ID
      przypadki kolejno:

      • przedmiot można wyciągać

      • przedmiotu nie można wyciągać

      • przedmiotu nie można wyciągać + po kliknieciu gui się zamknie

      • przedmiotu nie można wyciągać + po kliknieciu gui się zamknie + otworzy się nowe gui o podanym ID

      • przedmiotu nie można wyciągać + gracz lub konsola wykona podaną komendę

      • przedmiotu nie można wyciągać + gracz lub konsola wykona podaną komendę + gui zostanie zamknięte

    • 
      
      
      [[m[-]]gui] fill [empty slots of] %strings% with %item%
      [[m[-]]gui] fill all slots of %strings% with %item%

      wypełniamy wszystkie lub wszystkie wolne sloty w gui o podanych ID

    • 
      
      
      close [m[-]]gui %string% [to %players%]

      zamyka gui o danym ID wszystkim graczom, którzy mają go otwarte (lub tylko wybranym, którzy są podani w drugim argumencie)

    • 
      
      
      open [m[-]]gui %string% to %players%

      otwiera gui o danym ID podanym graczom

    • 
      
      
      execute slot %integer% of [[m[-]]gui] %string% for %player%

      efekt niepotrzebny użytkownikowi
      wykonuje wszystkie akcje jakie są przypisane do danego slotu w danym GUI (np. komendy, zamykanie gui, otwieranie gui)

Przykłady użycia:

• ze skryptu korzystamy identycznie jak z wymienionych wyżej dodatków, z tą różnicą, że nie możemy tu otworzyć ekwipunku graczowi - musimy najpierw go stworzyć (nadać ID, podać parametry i najlepiej też sformatować sloty) - dopiero po tych działaniach bezpiecznie otworzymy nowe GUI wybranym graczom, przykłady:
  GUI o ID pierwsze.gui z 3 rzędami i nazwą zawiera na slocie pierwszym przedmiot który wykonuje komendę /eco give player 100

  command /nasze-nowe-gui:
  	trigger:
  		create new mgui "pierwsze.gui" with 3 rows named "jakaś nazwa"
  
  		make mgui slot 1 of "pierwsze.gui" with stone named "&aDodaj sobie 100$" to run console command "eco give %player% 100"
  
  		open mgui "pierwsze.gui" to all players

  
  w drugim przykładzie zróbmy funkcję, która wyśle wiadomość o rodzaju kliknięcia i wykonajmy ją po kliknięciu w GUI, które w całości wypełnione zostanie żółtymi szybami
  w tym celu będziemy nasłuchiwać customowego eventu 'mgui click'

  function rodzajKliknięcia(prawy: boolean):
  	if {_prawy} is true:
  		broadcast "&6kliknięto prawym przyciskiem w slot"
  	else:
  		broadcast "&9kliknięto lewym przyciskiem w slot"
  
  command /nasze-nowe-gui:
  	trigger:
  		create new mgui "pierwsze.gui" with 3 rows named "jakaś nazwa"
  		make mgui slot (integers from 0 to 26) of "pierwsze.gui" with yellow glass pane to be unstealable
  		open mgui "pierwsze.gui" to player
  
  on mgui click:
  	if (mgui of player) is "pierwsze.gui":
  		if number is between  and 26:
  			if click type is left mouse button:
  				rodzajKliknięcia(false)
  			else if click type is right mouse button:
  				rodzajKliknięcia(true)
  				add 1 of apple named "kliknąłeś prawym" to inventory of player

• w kolejnym przykładzie stwórzmy bardzo prosty skrypt na kit:
  tworzymy komendę, która otworzy nam gui o ID kit-narzędzia i ustawiamy opóźnienie jej użycia na 10 minut
  podczas uruchamiania skrypty tworzymy nowe GUI z czterema rzędami, nazwą i kształtem
  wypełniamy kształt - literę z - szarym szkłem
  dodajemy przedmioty kitu do listy, a następnie zapętlamy ją i ustawiamy wynik pętli jako 'następny wolny' slot w gui
  na koniec wypełniamy wszystkie pozostałe sloty jasnym szarym szkłem

  command kit:
  	cooldown: 10 minutes
  	cooldown message: Tej komendy można używać raz na 10 minut
  	trigger:
  		open gui "kit-narzedzia" to player
  
  on load:
  	set {_shape::*} to "z-z-z-z-z-z-z-z-z", "z--------z", "z--------z" and "z-z-z-z-z-z-z-z-z"
  	create new gui "kit-narzedzia" with 4 rows and shape {_shape::*} named "&3Odbierz swój kit"
  
  	set gui shape "z" of "kit-narzedzia" to gray glass pane to be unstealable
  
  	add wooden sword to {_items::*}
  	add golden axe of sharpness 5 to {_items::*}
  	add golden pickaxe of efficiency 5 to {_items::*}
  	add golden shovel to {_items::*}
  	add 8 of baked potato to {_items::*}
  	add 16 of apple to {_items::*}
  	add 2 of ender pearl to {_items::*}
  	add 32 of stone named "&bMagiczny kamień z kitu" with lore "&3a oto jego" and "&3opis" to {_items::*}
  
  	loop {_items::*}:
  		set gui next slot of "kit-narzedzia" to loop-value
  
  	fill "kit-narzedzia" with light gray glass pane

   

Changelog:

• Spoiler

  v0.2.1:

  • Błędy:
    • naprawiono błąd z efektem 'next slot' powodujący nakładanie się przedmiotów na siebie
  • Nowości:
    • składnia została delikatnie zmieniona, aby chociaż trochę uprzyjemnić pisanie

  v0.2.0:

  • Błędy:
    • naprawiono błąd związany z nową wersją Skripta wysypujący błędy do konsoli
    • ze względu na niewielkie zainteresowanie skryptem, postanowiłem czasowo zrezygnować z automatycznej aktualizacji (funkcja wróci w przyszłych aktualizacjach)
    • ze względu na błędy zmuszony byłem dodać opcję czyszczenia GUI po wyłączeniu skryptu (serwera) - opcja whitelisty została usunięta
    • ze względu na błędy w skript-reflect, od tej wersji podanie nazwy GUI jest wymagane
  • Nowości:
    • od teraz można tworzyć jednocześnie wiele identycznych GUI

      
      
      
      create new mgui with id ("pierwsze.ID", "drugie.ID" and "trzecie.ID") with 1 row named ""

       

    • można wstawiać przedmioty do wielu GUI jednocześnie

      
      
      
      set mgui slot 10 of ("pierwsze.ID" and "drugie.ID") to carrot item

       

    • dodano opcję wypełniania całego GUI dowolnym przedmiotem (przedmioty nie mają efektu po kliknięciu, ale nie można ich zabrać)

      
      
      
      mgui fill all slots of "pierwsze.ID" with diamond

       

    • dodano opcję wypełniania wszystkich wolnych slotów w GUI dowolnym przedmiotem( przedmioty nie mają efektu po kliknięciu, ale nie można ich zabrać)

      
      
      
      mgui fill ("pierwsze.ID" and "drugie.ID") with diamond

       

    • dodano opcję wstawiania przedmiotu do pierwszego wolnego slotu w GUI (identycznie jak w TuSKe)

      
      
      
      set mgui next slot of "pierwsze.ID" to potato item

       

    • dodano opcję tworzenia GUI przy użyciu symboli oddzielonych myślnikiem (identycznie jak w TuSKe)

      
      
      
      set {_shape::*} to "z-z-z-z-z-z-z-z-z", "z-x-x-x-x-x-x-x-z" and "z-z-z-z-z-z-z-z-z"
      create mgui "pierwsze.ID" with 3 rows and shape {_shape::*} named "nazwa GUI"

       

    • dodano opcję formatowania slotów w oparciu o uprzednio nadane symbole (identycznie jak w TuSKe)

      
      
      
      set mgui shape "x" of "pierwsze.ID" with orange glass pane to be unstealable
      set mgui shape "z" of "pierwsze.ID" with gray glass pane to be unstealable

       

Pobieranie:

• ^{mGUI wersja 0.1.6}
• ^{mGUI wersja 0.2.0}
• mGUI wersja 0.2.1

^{Miłego dnia}