Package org.spongepowered.api.block.transaction

Interface NotificationTicket

public interface NotificationTicket
Represents a notification that is being proposed to the engine.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    invalidate()
    Invalidates this ticket.
    LocatableBlock
    notifier()
    Gets the notifier block that scheduled this notification.
    default Vector3i
    notifierPosition()
    Gets the notifier position that scheduled this notification.
    void
    setValid(boolean valid)
    Sets whether this ticket is valid or not.
    BlockSnapshot
    target()
    Gets the target block of this notification.
    default Vector3i
    targetPosition()
    Gets the target position of this notification.
    boolean
    valid()
    Gets whether this ticket is marked as valid.

  • Method Details

    • notifier

      LocatableBlock notifier()
      Gets the notifier block that scheduled this notification.
      Returns:
      The notifier block

    • notifierPosition

      default Vector3i notifierPosition()
      Gets the notifier position that scheduled this notification.
      Returns:
      The notifier position

    • target

      BlockSnapshot target()
      Gets the target block of this notification.
      Returns:
      The target block

    • targetPosition

      default Vector3i targetPosition()
      Gets the target position of this notification.
      Returns:
      The target position

    • valid

      boolean valid()
      Gets whether this ticket is marked as valid.
      Returns:
      The valid state of this ticket

    • setValid

      void setValid(boolean valid)
      Sets whether this ticket is valid or not.
      Parameters:
      valid - The valid state of this ticket

    • invalidate

      default void invalidate()
      Invalidates this ticket.