Interface IStructureEventTogglePrepare

All Superinterfaces:
IAnimatedArchitectureEvent, ICancellableAnimatedArchitectureEvent, IStructureToggleEvent
All Known Implementing Classes:
StructureEventTogglePrepare
public interface IStructureEventTogglePrepare extends IStructureToggleEvent, ICancellableAnimatedArchitectureEvent
Represents a toggle action that might be applied to a structure. Note that not cancelling this event does not mean that action is guaranteed to take place, as other factors might prevent that from happening (e.g. the structure being locked).

If you are looking for a guaranteed action, use IStructureEventToggleStart instead.

  • Method Details

    • getNewCuboid

      Cuboid getNewCuboid()
      Gets the new coordinates of the structure after the toggle.
      Returns:
      The new coordinates of the structure after the toggle.