Package dev.engine_room.flywheel.api.visual

Interface TickableVisual

All Superinterfaces:
Visual
All Known Subinterfaces:
SimpleTickableVisual
public interface TickableVisual extends Visual
An interface giving Visuals a hook to have a function called at the end of every tick.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    TickableVisual.Context
    The context passed to the tick plan.

  • Method Summary

    Modifier and Type
    Method
    Description
    Plan<TickableVisual.Context>
    planTick()
    Invoked every tick.

    Methods inherited from interface dev.engine_room.flywheel.api.visual.Visual

    delete, update

  • Method Details

    • planTick

      Plan<TickableVisual.Context> planTick()
      Invoked every tick.
      The implementation is free to parallelize the invocation of this plan. You must ensure proper synchronization if you need to mutate anything outside this visual.
      This plan and the one returned by DynamicVisual.planFrame() will never be invoked simultaneously.
      Instancer/Instance creation/acquisition is safe here.