Pierwszy projekt #

Proste wprowadzenie do pracy z SessionAPI, obejmujące podstawy zarządzania sesjami i komponentami.

Listenery w bibliotece #

Każdy komponent (Session, Board, Controller) posiada wbudowane zdarzenia wewnętrzne, które odpowiadają za różne etapy życia komponentu oraz interakcję z graczami.

• onComponentInit() – Wywoływany automatycznie, gdy komponent zostaje utworzony. Używany do inicjalizacji komponentu (np. tworzenie zasobów, uruchamianie wątków, inicjowanie logiki).

• onComponentDestroy() – Wywoływany automatycznie, gdy komponent jest wyłączany. Używany do usuwania zasobów i elementów stworzonych przez komponent (np. zatrzymywanie wątków, czyszczenie danych).

• onPlayerInit() – Wywoływany automatycznie, gdy gracz dołącza do sesji (lub jeśli komponent został uruchomiony po dołączeniu gracza). Używany do nadania graczowi właściwości, przenoszenia go na mapę itp.

• onPlayerDestroy() – Wywoływany automatycznie, gdy gracz opuszcza sesję. Używany do usuwania właściwości gracza, które były przypisane na potrzeby sesji (np. usuwanie efektów czy zmiany statusu).

Tworzenie głównej klasy kontenera #

Session to klasa zarządzająca sesją gry, odpowiadająca za graczy, mapę i kontrolery. Inicjuje, uruchamia i kończy sesję, zapewniając organizację i kontrolę nad grą.

public class MyContainer extends Session {
	public MyContainer(JavaPlugin plugin) {
		super(plugin);
	}

	@NotNull
	@Override
	// Ta metoda jest wywoływana automatycznie, aby zdefiniować domyślną mapę dla kontenera.
	// Mapa może być później zmieniona za pomocą metody .setBoard(#Board), jeśli zajdzie taka potrzeba.
	protected Board defaultBoard() {
		return new MyBoard(this);
	}

	@Override
	// Ta metoda jest wywoływana automatycznie w momencie tworzenia instancji sesji.
	public void onComponentInit(ComponentConstructor event) {
		super.onComponentInit(event);
		// Aby dodać kontroler do drzewa komponentów sesji, tworzymy jego instancję,
		// a jako argument przekazujemy "this" (jako rodzica), co oznacza, że kontroler będzie podłączony do bieżącej sesji.
		// Następnie uruchamiamy kontroler, aby zaczął działać.
		new MyController(this).start();
        // Nie musimy przechowywać jego instancji, ponieważ zostanie automatycznie wyłączony wraz z wyłączeniem rodzica, w tym przypadku MySession.
	}
}

Najważniejsze listenery #

• onComponentInit() – Wywoływany automatycznie podczas tworzenia instancji sesji, używany do uruchomienia wymaganych zasobów.

• onComponentDestroy() – Wywoływany automatycznie podczas usuwania sesji, służy do zwolnienia i usunięcia zasobów.

Najważniejsze metody #

• start() – Uruchamia sesję, buduje mapę, oraz inicjuje i uruchamia wszystkie kontrolery.

• stop() – Usuwa sesję, w tym strukturę, mapę i graczy, a także usuwa listenery oraz wątki związane z sesją.

• addPlayer(#Player) – Dodaje gracza do kontenera.

• removePlayer(#Player) – Usuwa gracza z kontenera.

• setBoard(#Board) – Zmienia mapę w sesji.

Tworzenie klasy odpowiedzialnej za mapę #

Board to klasa reprezentująca mapę, odpowiedzialna za jej budowanie i usuwanie. Posiada listenery do obsługi tworzenia i niszczenia planszy, a także do inicjalizacji graczy.

public class MyBoard extends Board {
	public MyBoard(Session session) {
		super(session);
	}
}

Najważniejsze listenery #

• generate() – Wywoływany do zbudowania mapy.

• degenerate() – Wywoływany do usunięcia mapy.

Tworzenie kontrolera #

Kontroler obsługuje logikę dla graczy. W tym przypadku wysyłamy wiadomość "Hello, world!" do każdego gracza, który dołącza do kontenera.

public class MyController extends Controller {
	public MyController(BaseComponent baseComponent) {
		super(baseComponent);
	}

	@Override
	public void onPlayerInit(PlayerConstructor event) {
		super.onPlayerInit(event);
		var player = event.getPlayer();
		player.sendMessage("Hello world!");
	}
}

Listenery Bukkit #

• defineListeners() : Listener (Bukkit) – Metoda wywoływana automatycznie. Jej zadaniem jest zwrócenie klas typu Listener, które będą obsługiwać zdarzenia związane z danym kontrolerem w systemie Bukkit.

@Override
public Listeners defineListeners() {
    return super.defineListeners().add(MyListener.class);
}

private static class MyListener implements Listener { 
    @EventHandler(ignoreCancelled = true) 
    public void onPlayerJump(PlayerJumpEvent event) {
        var player = event.getPlayer();
        var session = SessionManager.session(player);
        ListenerManager.each(session, MyListener.class, MyController.class, myController -> {
           player.sendMessage("Skoczyłeś!"); 
        });
    }
}

Uruchamianie kontenera instancji sesji #

Aby uruchomić kontener, tworzymy jego instancję i wywołujemy metodę start(). Dodanie gracza do kontenera wywołuje przygotowaną logikę, np. powitanie.

var container = new MyContainer(plugin);
container.start();
container.addPlayer(player);

Utworzona struktura drzewa sesji #

Po uruchomieniu sesji zostanie stworzona zaplanowana struktura drzewa, która umożliwia łatwą wymianę rozwiązań, ponieważ wszystko jest obudowane w komponenty. Jest ona dobrze ustrukturyzowana i zapewnia przewidywalne zwalnianie zasobów. Kiedy fragment drzewa zostaje odłączony, wszystkie jego elementy, łącznie z dziećmi, są rekurencyjnie niszczone, a listenery uruchamiane w przewidywalnej kolejności.