Jak utworzyć plik z pluginem, aby pisać własne skrypty?
Wstęp
Cześć!
Z racji tego, że zrobiłem grę, która wymagała ode mnie dowiedzenia się tego i owego o MV, to chcę podzielić się z tą wiedzą,
abyście mogli tworzyć własne uniwersalne rozwiązania!
Poradnik ten, będzie tyczyć się tylko i wyłącznie utworzenia odpowiedniego pliku z pluginu do MV,
w którym tym pluginie dopiero będzie można pisać skrypty.
Składowe każdego pluginu (trzeba pamiętać)
Aby jednak to było możliwe, musimy wiedzieć jak to ma działać.
Jak wejdziemy w jeden z pluginów, dla przykładu weźmy
Community_Basic to naszym oczom ukaże się to:
.png)
Ustawienia skryptu i wprowadzenie współrzędnych.
Po lewej stronie mamy
I. General Settings, który zawiera:
- Name, czyli nazwę pluginu. Z tego miejsca też możemy przełączyć się na inny plugin
- Status, który mówi nam o tym, czy ten plugin jest włączony lub wyłączony. Możemy to zmieniać
- Opis - chociaż nie jest to napisane, to wiadomo, że to jest to pole pod nazwą
- Autor, czyli po prostu autor pluginu (pozdrawiamy RM CoreScript team)
II. Help - opis tego jak używać pluginu (w tym przypadku raczej jest marnie)
A po prawej stronie mamy parametry pluginu, czyli wszystkie rzeczy, którymi możemy dany plugin ustawiać.
Dobrą praktyką jest to, abyśmy dostarczali wszystkie potrzebne informacje - robić opis, uzupełnić help, dawać sensowne rzeczy do ustawiania.
Utworzenie własnego pliku pluginu
Tak w zasadzie jest to banalne
W katalogu z naszą grą wchodzimy do folderu
js/plugins i tam tworzymy plik:
[moja_nazwa_pluginu].js dla przykładu: EnterVPL.js lub
pierwszy_plugin.js
Ważne w nazwie pliku jest to, aby nie pisać polskich znaków diakrytycznych (np. ąęśź itd.) oraz spacji.
Jak już to zrobimy to musimy otworzyć plik (najlepiej edytorem kodu - polecam Visual Studio Code) i w pliku wpisać te wszystkie składowe.
Oczywiście jeśli chodzi o parametry i help to można to zostawić na sam koniec
(chociaż jeśli wiesz co będzie do ustawiania to lepiej zrobić to od razu), ale dla potrzeb poradnika pasuje mi to pokazać ze wszystkim.
Tutaj posłużę się kodem z pliku Community_Basic.js.
Na początku pliku jest komentarz zawierający wcześniej opisywane dane, a pod nim drugi komentarz w zasadzie
zawierający to samo, ale w innym języku:
Zaczyna się jazda, bo muszę wyjaśnić linijka po linijce o co z tym chodzi :D
Początek bloku opisów
Na samej górze mamy znaki
/*: to rozpoczyna blok naszych informacji o pluginie.
Jak przewiniesz ten kod mniej więcej do połowy to zobaczysz
/*:ja - to różni się od pierwszego tym,
że mówi nam w jakim języku są opisy. Jeśli nie poda się języka oznacza to, że to jest domyślny opis
dla wszystkich nieustawionych języków. W skrócie ten plugin ma dla wszystkich po angielsku i dla Japonii po japońsku.
Opis, autor, pomoc
Dalej poniżej mamy
* @plugindesc Plugin used to set basic parameters.
* @author RM CoreScript team
*
* @help This plugin does not provide plugin commands.
*
@plugindesc - opis pluginu - po tym piszemy nasz opis
@author - autor - wiadomo co napisać ;)
@help - piszemy jak obsługiwać plugin, czy ma jakieś komendy, itd.
Parametry
Dalej możemy opisywać nasze parametry, które składają się z dwóch lub trzech wartości
* @param cacheLimit
* @desc For setting the upper limit of image memory cache. (MPix)
* @default 10
*
@param - nazwa naszego parametru - najlepiej napisać po angielsku trzymając się zasady
camelCase (kliknij)
@desc - krótki opis naszego parametru
@default - wartość domyślna parametru - jeśli chcemy, aby była. Jeśli nie to można to pominąć. Dobrą praktyką jest jednak to, aby niczego nie zostawiać przypadkowi
Parametrów wpisujemy tyle ile potrzebujemy.
Koniec bloku opisów
Jeśli już wszystko podamy to kończymy opisy w nowej lini za pomocą
*/
Używanie parametrów w kodzie pluginu
Gdy już mamy gotowe opisy to pod nimi (tak 3 puste linie niżej) możemy tak na prawdę zająć się pisaniem pluginu.
Skoro opisywaliśmy parametry to też chcemy je jakoś pobrać. W tym celu należy użyć statycznej klasy
PluginManager, a dokładnie jej metody
parameters. Na przykład:
Zakończenie
To tak w zasadzie nam wystarczy do tego, aby utworzyć najprostszy plik pluginu. Dla ułatwienia sobie sprawy polecam pouczyć się podstaw
języka JavaScript, ponieważ MV jest oparty na funkcjach prototypowych i na ich podstawie tworzy obiekty
(trzeba jednak coś wiedzieć, aby zrozumieć to zdanie).
W kolejnych tematach będę udostępniać fragmenty skryptów z wyjaśnieniami oraz z tym, że można w nich używać parametry.
Jeśli chcecie się nauczyć coś więcej o pluginach to zaglądajcie do innych plików. W nich jest ukryta wiedza,
której wam już nikt nie zabierze ;) Np. w ten sposób można nauczyć się nieco inaczej pobierać parametry :)
Uff.. Mam nadzieję, że nie nakomplikowałem i że jest w miarę wszystko do zrozumienia. W razie czego to pytajcie i pytajcie,
gdyby coś się jednak niejasnego okazało
Pozdrawiam :D
Autor: EnterVPL
Email:
entervpl@gmil.com
