Event isCancelled() in Untiy

Sandboxgamer · Jan 6th 2022

Hallo red51 ,

ich versuche gerade ein eignes Event zu schreiben, das man auch Abbrechen kann.

Nun weiß ich aber nicht, wo man nun abfragt, das das Event Abgebrochen ist, da du ja mal gesagt hast, dass Event, sobald sie abgearbeitet worden sind, verschwinden.

Ich bin gerade dabei iConomy für Untiy neu zu schreiben.

Mit folgender Methode soll einem Spieler das Cash geändert werden und dabei ein benutzerdefiniertes Event ausgeführt werden:

Java: Cash.java

public class Cash {
    private iConomy plugin;

    public Cash(iConomy plugin, Attribute Attribute) {
        this.plugin = plugin;
    }

    public boolean add(Player player, long amounth, PlayerGetCashEvent.Cause cause){
        PlayerGetCashEvent evt = new PlayerGetCashEvent(plugin, player, amounth, cause);
        plugin.triggerEvent(evt);
        
        if (!evt.isCancelled()){  //<---- Ist das so richtig? Oder kommt bei "evt" NULL raus?
            //TODO Cash ändern
        }
        
        return false;
    }


}

Display More

Das ist das Event:

Java: CashEvent.java

public class CashEvent extends Event {
        
    public static class PlayerGetCashEvent extends CashEvent implements Cancellable{

        private final iConomy plugin;
        private Player player, fromPlayer;
        private long amounth;
        private boolean cancel;
        private Cause cause;

        public PlayerGetCashEvent(iConomy plugin, Player player, long amounth, Cause cause) {
            this.cause = cause;
            this.plugin = plugin;
            this.player = player;
            this.amounth = amounth;
            this.cancel = false;
        }

        public PlayerGetCashEvent(iConomy plugin, Player player, long amounth, Player fromPlayer, Cause cause) {
            this.player = player;
            this.amounth = amounth;
            this.fromPlayer = fromPlayer;
            this.cause = cause;
            this.plugin = plugin;
            this.cancel = false;
        }

        public Player getOtherPlayer() {
            return fromPlayer;
        }

        public Player getPlayer() {
            return player;
        }

        public long getAmounth() {
            return amounth;
        }
        
        public String getAmounthAsString(){
            return plugin.Format.formatToString(amounth);
        }

        public Cause getCause(){
            return cause;
        }

        @Override
        public boolean isCancelled() {
            return cancel;
        }

        @Override
        public void setCancelled(boolean cancel) {
            this.cancel = cancel;
        }

        public enum Cause {
            Player,
            Bank,
            Pickup,
            Other,
            Unknow;
        }

    }
}

Display More

red51 · Jan 6th 2022

Quote from Sandboxgamer

ich versuche gerade ein eignes Event zu schreiben, das man auch Abbrechen kann.
Nun weiß ich aber nicht, wo man nun abfragt, das das Event Abgebrochen ist, da du ja mal gesagt hast, dass Event, sobald sie abgearbeitet worden sind, verschwinden.

Das kannst du grundsätzlich so machen Auch in der neuen Version dürfte das Konzept von eigenen Events weiterhin funktionieren. Zwar hat die "Event" Klasse dort noch ein paar zusätzliche Funktionen und Variablen, die in dem Fall aber irrelevant sind.

Das "Verschwinden" bzw. "Ungültigwerden" von Events betrifft aber in der neuen Version nur Events, die vom Spiel ausgelöst werden (da existiert nämlich auf nativer Gegenseite auch das Event mit den entsprechenden Daten, wird aber nach Abarbeiten des Event-Aufrufs gelöscht, wodurch dann das Java-Event ungültig wird). Eigene selbstgeschriebene Events sind davon aber nicht betroffen (da diese nur auf Java Seite bestehen), d.h. die kannst du in der neuen Version genauso verwenden wie in der Java Version.

Mit dem "Abbrechen" (also "Cancellable" Events) hängt das aber nicht zusammen: Die Events, die abgebrochen werden (durch einen Aufruf von "setCancelled(true)"), werden auf nativer Seite nicht weiter bearbeitet. Wenn zB das "PlayerDamageEvent" ausgelöst wird und mit einem Aufruf von "setCancelled(true)" abgebrochen wird, dann wird der Spieler auch keinen Schaden bekommen (also dann wird auf Spielseite so getan, als wäre das Event nie ausgelöst worden).

Bei selbstgeschriebenen Events ist das mit dem Abbrechen nur für einen selber relevant. Wie gesagt, das Spiel selbst weiß quasi nichts von selbstgeschriebenen Events (da sie auf nativer bzw. Spielseite nicht existieren), d.h. wenn du es mit "setCancelled(true)" abbrichst, dann ist das nur relevant, wenn du das selber irgendwo prüfst (also via "isCancelled()"). Du hast hier volle Kontrolle

Quote from Sandboxgamer

if (!evt.isCancelled()){ //<---- Ist das so richtig? Oder kommt bei "evt" NULL raus?

Das ist so korrekt. Wenn irgendein Plugin bzw. Listener, welches auf dieses Event lauscht, den Aufruf abgebrochen hat (mit "setCancelled(true)"), dann wirst du das an der Stelle prüfen können (also isCancelled()" wird in dem Fall true zurückgeben).

In diesem Beispiel ist "evt" übrigens niemals null, da du es ja kurz vorher zugewiesen hast (immer, wenn du eine Variable mit "new" zuweist, dann wird sie grundsätzlich niemals null sein danach - es sei denn, du weist irgendwann explizit "null" zu).

Participate now!