Événements personnalisés
You can write your own event classes and dispatch those events using the method described above. An event class must extend the Event class. Depending on the exact nature of the event, more interfaces should be implemented, like Cancellable for events that can be cancelled by a listener or interfaces like AffectEntityEvent clarifying what sort of object is affected by your event.
Astuce
You can extend AbstractEvent for common methods to be implementated for you
Exemple : Classe d’Événement Personnalisée
The following class describes an event indicating a ServerPlayer has come in contact with FLARD and is now about to
mutate in a way specified by the event. Since the event can be cancelled by listeners, it implements the Cancellable
interface.
Puisque les événements personnalisés sont généralement destinés à être écoutés par les autres plugins, c’est dans votre intérêt de les documenter adéquatement. Cela inclut une liste d’objets généralement trouvés dans la Cause. Dans l’exemple ci-dessous, il serait probablement mentionné que la cause principale est généralement un objet de la classe fictive FLARDSource
.
import org.spongepowered.api.entity.living.player.server.ServerPlayer;
import org.spongepowered.api.event.Cancellable;
import org.spongepowered.api.event.Cause;
import org.spongepowered.api.event.impl.AbstractEvent;
public class PlayerMutationEvent extends AbstractEvent implements Cancellable {
public enum Mutation {
COMPULSIVE_POETRY,
ROTTED_SOCKS,
SPONTANEOUS_COMBUSTION;
};
private final Cause cause;
private final ServerPlayer victim;
private final Mutation mutation;
private boolean cancelled = false;
public PlayerMutationEvent(ServerPlayer victim, Mutation mutation, Cause cause) {
this.victim = victim;
this.mutation = mutation;
this.cause = cause;
}
public ServerPlayer victim() {
return this.victim;
}
public Mutation mutation() {
return this.mutation;
}
@Override
public boolean isCancelled() {
return this.cancelled;
}
@Override
public void setCancelled(boolean cancel) {
this.cancelled = cancel;
}
@Override
public Cause cause() {
return this.cause;
}
}
Exemple : Déclencher l’Événement Personnalisé
import org.spongepowered.api.event.Cause;
import org.spongepowered.api.event.EventContext;
import org.spongepowered.api.event.EventContextKeys;
import org.spongepowered.api.Sponge;
PluginContainer plugin = ...;
EventContext eventContext = EventContext.builder().add(EventContextKeys.PLUGIN, plugin).build();
PlayerMutationEvent event = new PlayerMutationEvent(victim, PlayerMutationEvent.Mutation.ROTTED_SOCKS,
Cause.of(eventContext, plugin));
Sponge.eventManager().post(event);
if (!event.isCancelled()) {
// Mutation code
}
N’oubliez pas que vous devez fournir une cause non vide. Si votre événement était un Cancellable
, assurez-vous qu’il n’était pas annulé avant d’effectuer l’action décrite par l’événement.
Exemple : Enregistrer les Événements Personnalisés
import net.kyori.adventure.text.Component;
import org.spongepowered.api.event.Listener;
@Listener
public void onPrivateMessage(PlayerMutationEvent event) {
if (event.mutation() == PlayerMutationEvent.Mutation.SPONTANEOUS_COMBUSTION) {
event.setCancelled(true);
event.victim().sendMessage(Component.text("You cannot combust here, this is a non-smoking area!"));
}
}