Package wbs.utils.util.entities.state.tracker

Class GameModeState

java.lang.Object
wbs.utils.util.entities.state.tracker.GameModeState
All Implemented Interfaces:
org.bukkit.configuration.serialization.ConfigurationSerializable, EntityState<org.bukkit.entity.Player>
public class GameModeState extends Object implements EntityState<org.bukkit.entity.Player>, org.bukkit.configuration.serialization.ConfigurationSerializable
An EntityState that captures the game mode a Player is currently in.
See Also:
  • HumanEntity.getGameMode()

  • Constructor Details

    • GameModeState

      public GameModeState()
      Creates the state with no starting value - if the state is restored, it will have no effect

    • GameModeState

      public GameModeState(@Nullable @Nullable org.bukkit.GameMode mode)
      Parameters:
      mode - The game mode the player is in.

  • Method Details

    • captureState

      public void captureState(org.bukkit.entity.Player target)
      Description copied from interface: EntityState
      Capture the state of an instance of EntityState according to the implementation, and store it until EntityState.restoreState(T) is called.
      Specified by:
      captureState in interface EntityState<org.bukkit.entity.Player>
      Parameters:
      target - The EntityState from which to capture.

    • restoreState

      public void restoreState(org.bukkit.entity.Player target)
      Description copied from interface: EntityState
      Restore the state of an instance of EntityState according to the implementation.
      Specified by:
      restoreState in interface EntityState<org.bukkit.entity.Player>
      Parameters:
      target - The EntityState for which to the stored state.

    • getMode

      @Nullable public @Nullable org.bukkit.GameMode getMode()
      Returns:
      The game mode the player is in.

    • setMode

      public void setMode(@Nullable @Nullable org.bukkit.GameMode mode)
      Parameters:
      mode - The game mode the player is in.

    • restoreAfter

      @NotNull public @NotNull Set<Class<? extends EntityState<?>>> restoreAfter()
      Description copied from interface: EntityState
      Used to build a graph of captured states, allowing states to be restored in the appropriate order, such as restoring AllowFlightState after GameModeState, to prevent a change to GameMode.SURVIVAL from overriding the Player.getAllowFlight() state.
      Specified by:
      restoreAfter in interface EntityState<org.bukkit.entity.Player>
      Returns:
      A set of classes to restore after, if present in a given SavedEntityState.

    • deserialize

      public static GameModeState deserialize(Map<String,Object> args)
      Deserializer method for converting a Map into this object, for use in EntityStateManager
      Parameters:
      args - The partially deserialized Map.
      Returns:
      An instance of this class, deserialized from args.

    • serialize

      @NotNull public @NotNull Map<String,Object> serialize()
      Specified by:
      serialize in interface org.bukkit.configuration.serialization.ConfigurationSerializable