Package de.gurkenlabs.litiengine.entities

Interface TriggerActivatingCondition

All Superinterfaces:
java.util.EventListener
All Known Subinterfaces:
TriggerListener
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface
public interface TriggerActivatingCondition
extends java.util.EventListener
This listener provides a callback that allows to check conditions for activating a Trigger and prevent the activation if necessary.

  • Method Summary

    Modifier and TypeMethodDescription
    java.lang.StringcanActivate​(TriggerEvent event)
    Allows to register functions that contain additional checks for the trigger activation.

  • Method Details

    • canActivate

      java.lang.String canActivate​(TriggerEvent event)
      Allows to register functions that contain additional checks for the trigger activation. The return value of the function is considered the reason why the trigger cannot be activated. If the function returns anything else than null, the activation is cancelled and the result of the function is send to the activator entity.
      Parameters:
      event - The event data that contains information about the trigger.
      Returns:
      The reason why the trigger cannot be activated or null if it can be activated.