Skip to main content

Events

ShowControl fires normal Bukkit events. Listen to them like any other event.

All events are in the package tech.sbdevelopment.showcontrol.api.events.

EventWhenCancellableExtra data
ShowStartEventBefore a show startsYesgetFrom(), isLoop()
ShowEndEventAfter a show finished or was stoppedNogetReason(): FINISHED or CANCELLED
ShowPauseEventWhen a show is pausedNogetTime(): the show time
ShowResumeEventWhen a paused show continuesNogetTime(): the show time
CueTriggerEventBefore a cue playsYesgetCue()

Every event has getShow().

  • Cancelling ShowStartEvent keeps the show from starting.
  • Cancelling CueTriggerEvent skips that one cue. The show keeps running.

Example​

Announce shows in chat, and skip all firework cues while it rains.

import org.bukkit.Bukkit;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import tech.sbdevelopment.showcontrol.api.events.CueTriggerEvent;
import tech.sbdevelopment.showcontrol.api.events.ShowEndEvent;
import tech.sbdevelopment.showcontrol.api.events.ShowStartEvent;

public class ShowListener implements Listener {
@EventHandler
public void onStart(ShowStartEvent event) {
Bukkit.broadcastMessage("The show " + event.getShow().getName() + " is starting!");
}

@EventHandler
public void onEnd(ShowEndEvent event) {
if (event.getReason() == ShowEndEvent.Reason.FINISHED) {
Bukkit.broadcastMessage("Thanks for watching!");
}
}

@EventHandler
public void onCue(CueTriggerEvent event) {
boolean firework = event.getCue().getData().getTriggerId().equals("firework");
if (firework && Bukkit.getWorlds().getFirst().hasStorm()) {
event.setCancelled(true);
}
}
}