Package appeng.api.networking.ticking

Interface IGridTickable

All Superinterfaces:
IGridNodeService
public interface IGridTickable extends IGridNodeService
Implement on IGridHosts which want to use AE's Network Ticking Feature.

Important note regarding IGridTickables with more then one one node:

If your IGridHost hosts multiple nodes, it may be on multiple grids, or its node may be present on the same grid multiple times, this is as designed, however if you choose to use the grid to tick these Hosts you must be aware that they they should probably pick a single node to tick for, and not tick for each node.

  • Method Summary

    Modifier and Type
    Method
    Description
    TickingRequest
    getTickingRequest(IGridNode node)
    Return a valid TickingRequest to tell AE a guide for which type of responsiveness your device wants.
    TickRateModulation
    tickingRequest(IGridNode node, int ticksSinceLastCall)
    AE lets you adjust your tick rate based on the results of your tick, if your block as accomplished work you may wish to increase the ticking speed, if your block is idle you may wish to slow it down.

  • Method Details

    • getTickingRequest

      TickingRequest getTickingRequest(IGridNode node)
      Return a valid TickingRequest to tell AE a guide for which type of responsiveness your device wants.

      This will be called for your block entity any time your block entity changes grids, this can happen at any time, so if your using the sleep feature you may wish to preserve your sleep, in the result of this method. or you can simply reset it.

      Returns:
      a valid new TickingRequest

    • tickingRequest

      TickRateModulation tickingRequest(IGridNode node, int ticksSinceLastCall)
      AE lets you adjust your tick rate based on the results of your tick, if your block as accomplished work you may wish to increase the ticking speed, if your block is idle you may wish to slow it down.

      Its up to you.

      Note: this is never called if you return null from getTickingRequest.

      Parameters:
      ticksSinceLastCall - the number of world ticks that were skipped since your last tick, you can use this to adjust speed of processing or adjust your tick rate.
      Returns:
      tick rate adjustment.