Package fr.multimc.api.spigot.games

Class GameInstance

java.lang.Object
fr.multimc.api.spigot.games.GameInstance
All Implemented Interfaces:
org.bukkit.event.Listener
Direct Known Subclasses:
SampleGameInstance
public class GameInstance extends Object implements org.bukkit.event.Listener

  • Constructor Details

    • GameInstance

      public GameInstance(@NotNull @NotNull org.bukkit.plugin.java.JavaPlugin plugin, @NotNull @NotNull GamesManager gamesManager, @NotNull @NotNull GameSettings settings, @NotNull @NotNull org.bukkit.Location instanceLocation, @NotNull @NotNull List<MmcTeam> mmcTeams, int instanceId)

  • Method Details

    • allocate

      public static void allocate(@NotNull @NotNull Schematic schematic, @NotNull @NotNull org.bukkit.Location location)
      Past the gameSchematic for the instance (can be called for pre-allocation too)
      Parameters:
      schematic - Schematic to paste
      location - Location to paste the gameSchematic

    • init

      public void init(boolean isPreAllocated)
      Initialize game instance
      Parameters:
      isPreAllocated - If the gameSchematic is already pasted

    • start

      public void start()
      Start game instance

    • stop

      public void stop()
      Default instance stop (players will return to the lobby)

    • restart

      public void restart()
      Restart game instance

    • tick

      public void tick()
      Method called every tick delay defined in InstanceSettings

    • cancel

      public void cancel() throws IllegalStateException
      Throws:
      IllegalStateException

    • isCancelled

      public boolean isCancelled()

    • teleportPlayer

      public void teleportPlayer(@NotNull @NotNull MmcPlayer mmcPlayer, @Nullable @Nullable org.bukkit.Location location)
      Asynchronously teleport a player to a location
      Parameters:
      mmcPlayer - Player to teleport
      location - Target location

    • teleportPlayersToSpawn

      public void teleportPlayersToSpawn()
      Teleport all players to their spawn

    • teleportPlayerToSpawn

      public void teleportPlayerToSpawn(@NotNull @NotNull MmcPlayer player)
      Teleport a player to his spawn
      Parameters:
      player - MmcPlayer to teleport

    • setPlayerSpawn

      public void setPlayerSpawn(@NotNull @NotNull MmcPlayer mmcPlayer, @Nullable @Nullable org.bukkit.Location location)
      Asynchronously set a player spawn
      Parameters:
      mmcPlayer - Player to set spawn
      location - Target location

    • broadcast

      public void broadcast(@Nonnull net.kyori.adventure.text.Component message)
      Broadcast a message to all players in the instance
      Parameters:
      message - Message to broadcast

    • onPlayerReconnect

      public void onPlayerReconnect(@NotNull @NotNull MmcPlayer mmcPlayer)
      Called to reconnect a disconnected player
      Parameters:
      mmcPlayer - Player to reconnect

    • onPlayerDisconnect

      public void onPlayerDisconnect(@NotNull @NotNull MmcPlayer mmcPlayer)
      Called when a player disconnect from the server

    • updateState

      protected void updateState(@NotNull @NotNull GameState state)
      Called to update instance state for InstanceManager
      Parameters:
      state - New InstanceState

    • onSpectatorJoin

      public void onSpectatorJoin(@NotNull @NotNull MmcPlayer spectator)
      Called when a spectator spectate this game
      Parameters:
      spectator - MmcPlayer instance of the spectator

    • onSpectatorLeave

      public void onSpectatorLeave(@NotNull @NotNull MmcPlayer spectator)
      Called when a spectator stop spectating this game
      Parameters:
      spectator - MmcPlayer instance of the spectator

    • isPlayerOnInstance

      public boolean isPlayerOnInstance(@NotNull @NotNull MmcPlayer mmcPlayer)
      Check if the player is on this instance
      Parameters:
      mmcPlayer - Target player
      Returns:
      True if the player is on this instance

    • isSpectatorOnInstance

      public boolean isSpectatorOnInstance(@NotNull @NotNull MmcPlayer spectator)
      Check if the spectator is on this instance
      Parameters:
      spectator - Target spectator
      Returns:
      True if the spectator is on this instance

    • getPlugin

      public org.bukkit.plugin.Plugin getPlugin()

    • getSpectators

      public List<MmcPlayer> getSpectators()

    • getLogger

      public Logger getLogger()

    • getInstanceSettings

      public GameSettings getInstanceSettings()

    • getInstanceLocation

      public org.bukkit.Location getInstanceLocation()

    • getTeams

      public List<MmcTeam> getTeams()

    • getInstanceId

      public int getInstanceId()

    • getInstanceEntities

      public List<org.bukkit.entity.Entity> getInstanceEntities()

    • getRemainingTime

      public int getRemainingTime()

    • isRunning

      public boolean isRunning()

    • getPlayers

      public List<MmcPlayer> getPlayers()

    • getInstanceState

      public GameState getInstanceState()

    • getPlayerSpawns

      public Map<UUID,org.bukkit.Location> getPlayerSpawns()

    • getInstanceStateUpdates

      public Map<Long,GameState> getInstanceStateUpdates()

    • setRemainingTime

      public void setRemainingTime(int remainingTime)