Package forestry.api.apiculture

Interface IBeekeepingLogic

All Superinterfaces:
INbtReadable, INbtWritable
public interface IBeekeepingLogic extends INbtWritable, INbtReadable
Stores beekeeping logic for bee housings. Get one with BeeManager.beeRoot.createBeekeepingLogic(IBeeHousing housing) Save and load it to NBT using the INbtWritable methods.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_WORK_THROTTLE
    The default number of ticks per queen work cycle.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canDoBeeFX()
    Whether bee fx should be active.
    boolean
    canWork()
    Checks that the bees can work, setting error conditions on the housing where needed
    void
    clearCachedValues()
    Force the logic to refresh any cached values and error states.
    void
    doBeeFX()
    Display bee fx.
    void
    doWork()
    Performs actual work, breeding, production, etc.
    int
    getBeeProgressPercent()
    Get the progress bar for breeding and production.
    List<net.minecraft.core.BlockPos>
    getFlowerPositions()
    Used by bee fx to direct bees to nearby flowers.
    default void
    readData(net.minecraft.network.FriendlyByteBuf data)
     
    default void
    setWorkThrottle(int workThrottle)
    Changes the number of ticks per work cycle for this beekeeping logic.
    void
    syncToClient()
    Sync to client by using INbtWritable.write(net.minecraft.nbt.CompoundTag) in your BlockEntity.getUpdateTag()
    void
    syncToClient(net.minecraft.server.level.ServerPlayer player)
     
    default void
    writeData(net.minecraft.network.FriendlyByteBuf data)
     

    Methods inherited from interface forestry.api.core.INbtReadable

    read

    Methods inherited from interface forestry.api.core.INbtWritable

    write

  • Field Details

    • DEFAULT_WORK_THROTTLE

      static final int DEFAULT_WORK_THROTTLE
      The default number of ticks per queen work cycle.
      See Also:

  • Method Details

    • canWork

      boolean canWork()
      Checks that the bees can work, setting error conditions on the housing where needed
      Returns:
      true if no errors are present and doWork should be called

    • doWork

      void doWork()
      Performs actual work, breeding, production, etc.

    • clearCachedValues

      void clearCachedValues()
      Force the logic to refresh any cached values and error states. Call this when a player opens the gui so that all errors are up to date.

    • setWorkThrottle

      default void setWorkThrottle(int workThrottle)
      Changes the number of ticks per work cycle for this beekeeping logic. The default work throttle is 550 ticks per work cycle, which is 27.5 seconds per work cycle.
      Parameters:
      workThrottle - The number of ticks per work cycle.
      Since:
      2.2.4

    • syncToClient

      void syncToClient()
      Sync to client by using INbtWritable.write(net.minecraft.nbt.CompoundTag) in your BlockEntity.getUpdateTag()

    • syncToClient

      void syncToClient(net.minecraft.server.level.ServerPlayer player)

    • getBeeProgressPercent

      int getBeeProgressPercent()
      Get the progress bar for breeding and production. To avoid network spam, this is only available server-side, and must be synced manually to the client when a GUI is open.

    • canDoBeeFX

      boolean canDoBeeFX()
      Whether bee fx should be active. Internally, this is automatically synced to the client.

    • doBeeFX

      void doBeeFX()
      Display bee fx. Calls IBee.doFX(IEffectData[] storedData, IBeeHousing housing) on the queen. Internally, the queen is automatically synced to the client for the fx.

    • getFlowerPositions

      List<net.minecraft.core.BlockPos> getFlowerPositions()
      Used by bee fx to direct bees to nearby flowers. These positions are synced to the client from the server.

    • readData

      default void readData(net.minecraft.network.FriendlyByteBuf data)

    • writeData

      default void writeData(net.minecraft.network.FriendlyByteBuf data)