API
autor: Wysłane przez Anubis w pon., 30/07/2012 - 19:01jGuardian posiada także API pozwalające na tworzenie własnych pluginów. Rozpoczynając pisanie własnego plugina musimy stworzyć nowy projekt w np. Eclipse i dodać do Build Path'a pliki JAR:
- Common.jar
- common.JGuardianMySQL.jar
- jguardian.jar
- frostbite.bf3.BattleField3.jar
- frostbite.jar
- jeśli chcemy korzystać z interface'ów udostępnionych przez inne pluginy, oczywistym jest dodanie także ich
Po stworzeniu nowej klasy modyfikujemy jej kod aby implementował interface IMainPlugin, który wymaga implementacji metod (w kolejności ich wykonywania):public boolean init(ISettings settings);
init jest wywoływany w momencie pierwszego odwołania do plugina. Jako parametr dostajemy obiekt udostępniający interface ISettings, który niesie ze sobą możliwość odczytu pliku XML ustawień plugina.
public String getName();
służy do pobrania nazwy plugina. Nazwa nie powinna się zmieiać, ponieważ ma wpływ na inne pluginy oraz wygląd bazy.
public String getAuthor();
służy do pobrania informacji o autorze plugina
public String getDescription();
służy do pobrania opisu plugina
public void setPLuginManagerRef(PluginManagerCommands pinterface);
służy do ustawienia managera pluginów. Interface ten pozwala m.in. na pobranie informacji o innych pluginach, rejestrowanie oraz wyrejestrowanie się z komend/eventów...
public void registerEvents();
tu rejestrujemy się na eventy
public void registerCommands();
tu rejestrujemy swoje komendy
public boolean PrepareToStart();
wywoływany gdy wszystkie pluginy zostaną załadowane. Tu można pobierać do nich referencje, można zacząć inicjalizować plugin.
public boolean startPlugin();
od tego miejsca plugin powinien już w pełni działać
public String getVersion(); //no called yet
pobiera wersję
public void stopPlugin();
wywoływany w momencie zatrzymywania programu. Tu czyścimy obiekty plugina, stopujemy wątki itp.