Package fr.prodrivers.bukkit.commons.storage.player

Class StoredPlayer

java.lang.Object
io.ebean.Model
fr.prodrivers.bukkit.commons.storage.player.StoredPlayer
@MappedSuperclass public class StoredPlayer extends io.ebean.Model
Stored Player

Base model for storing cross-plugin and cross-medium data related to players. Include most commons values across plugins.

This model can be extended in your plugin to add other attributes.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StoredPlayer(UUID uniqueId)
    Create a new stored player for player's provided Unique ID

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addDisciplinaryAction(PlayerDisciplinaryAction disciplinaryAction)
    Add a disciplinary actions to a player
    io.ebean.Database
    db()
     
    boolean
    delete()
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    boolean
    delete(io.ebean.Transaction transaction)
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    boolean
    deletePermanent()
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    boolean
    deletePermanent(io.ebean.Transaction transaction)
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    void
    flush()
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    List<PlayerDisciplinaryAction>
    getDisciplinaryActions()
    Get disciplinary actions made against player
    @NonNull String
    getLanguage()
    Get stored player's language
    @NonNull Date
    getLastSeen()
    Get stored player's last seen date
    double
    getMoney()
    Get stored player's amount of money
    @NonNull String
    getName()
    Get stored player's name
    UUID
    getUniqueId()
    Get stored player's unique ID
    void
    insert()
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    void
    insert(io.ebean.Transaction transaction)
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    boolean
    isConnected()
    Get stored player's connection status
    void
    refresh()
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    void
    removeDisciplinaryAction(PlayerDisciplinaryAction disciplinaryAction)
    Remove a disciplinary actions from a player
    void
    removeExpiredDisciplinaryActions()
    Remove expired disciplinary actions from a player
    void
    save()
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    void
    save(io.ebean.Transaction transaction)
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    void
    setConnected(boolean connected)
    Set stored player's connection status
    void
    setLanguage(@NonNull String language)
    Set stored player's language
    void
    setLastSeen(@NonNull Date lastSeen)
    Set stored player's last seen date
    void
    setMoney(double money)
    Set stored player's amount of money
    void
    setName(@NonNull String name)
    Set stored player's name
    void
    update()
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
    void
    update(io.ebean.Transaction transaction)
    Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.

    Methods inherited from class io.ebean.Model

    markAsDirty, markPropertyUnset

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • StoredPlayer

      public StoredPlayer(UUID uniqueId)
      Create a new stored player for player's provided Unique ID
      Parameters:
      uniqueId - Player's unique ID

  • Method Details

    • db

      public io.ebean.Database db()
      Overrides:
      db in class io.ebean.Model

    • save

      public void save()
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      save in class io.ebean.Model

    • save

      public void save(io.ebean.Transaction transaction)
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      save in class io.ebean.Model
      Parameters:
      transaction - Unused

    • flush

      public void flush()
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      flush in class io.ebean.Model

    • update

      public void update()
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      update in class io.ebean.Model

    • update

      public void update(io.ebean.Transaction transaction)
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      update in class io.ebean.Model
      Parameters:
      transaction - Unused

    • insert

      public void insert()
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      insert in class io.ebean.Model

    • insert

      public void insert(io.ebean.Transaction transaction)
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      insert in class io.ebean.Model
      Parameters:
      transaction - Unused

    • delete

      public boolean delete()
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      delete in class io.ebean.Model

    • delete

      public boolean delete(io.ebean.Transaction transaction)
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      delete in class io.ebean.Model
      Parameters:
      transaction - Unused

    • deletePermanent

      public boolean deletePermanent()
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      deletePermanent in class io.ebean.Model

    • deletePermanent

      public boolean deletePermanent(io.ebean.Transaction transaction)
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      deletePermanent in class io.ebean.Model
      Parameters:
      transaction - Unused

    • refresh

      public void refresh()
      Disable method to avoid conflicting Ebean databases, as this method may use the first registered Ebean instance.
      Overrides:
      refresh in class io.ebean.Model

    • getUniqueId

      public UUID getUniqueId()
      Get stored player's unique ID
      Returns:
      Stored player's unique ID

    • getName

      public @NonNull String getName()
      Get stored player's name
      Returns:
      Stored player's name

    • setName

      public void setName(@NonNull String name)
      Set stored player's name
      Parameters:
      name - Stored player's name

    • getLastSeen

      public @NonNull Date getLastSeen()
      Get stored player's last seen date
      Returns:
      Stored player's last seen date

    • setLastSeen

      public void setLastSeen(@NonNull Date lastSeen)
      Set stored player's last seen date
      Parameters:
      lastSeen - Stored player's last seen date

    • isConnected

      public boolean isConnected()
      Get stored player's connection status
      Returns:
      Stored player's connection status

    • setConnected

      public void setConnected(boolean connected)
      Set stored player's connection status
      Parameters:
      connected - Stored player's connection status

    • getMoney

      public double getMoney()
      Get stored player's amount of money
      Returns:
      Stored player's amount of money

    • setMoney

      public void setMoney(double money)
      Set stored player's amount of money
      Parameters:
      money - Stored player's amount of money

    • getLanguage

      public @NonNull String getLanguage()
      Get stored player's language
      Returns:
      Stored player's language

    • setLanguage

      public void setLanguage(@NonNull String language)
      Set stored player's language
      Parameters:
      language - Stored player's language

    • getDisciplinaryActions

      public List<PlayerDisciplinaryAction> getDisciplinaryActions()
      Get disciplinary actions made against player
      Returns:
      Player's disciplinary actions

    • addDisciplinaryAction

      public void addDisciplinaryAction(PlayerDisciplinaryAction disciplinaryAction)
      Add a disciplinary actions to a player
      Parameters:
      disciplinaryAction - Player's disciplinary actions

    • removeDisciplinaryAction

      public void removeDisciplinaryAction(PlayerDisciplinaryAction disciplinaryAction)
      Remove a disciplinary actions from a player
      Parameters:
      disciplinaryAction - Player's disciplinary actions

    • removeExpiredDisciplinaryActions

      public void removeExpiredDisciplinaryActions()
      Remove expired disciplinary actions from a player