Package org.skriptlang.skript.lang.experiment

Interface Experiment

All Known Implementing Classes:
Feature
public interface Experiment
An optional, potentially-experimental feature enabled per-script with the using X syntax. Experiments provided by Skript itself are found in Feature. This can also represent an unknown experiment 'used' by a script that was not declared or registered by Skript or any of its addons.

  • Method Details

    • unknown

      @Internal static Experiment unknown(String text)

    • constant

      static Experiment constant(String codeName, LifeCycle phase, String... patterns)
      A constant experiment provider (designed for the use of addons).
      Parameters:
      codeName - The debug 'code name' of this feature.
      phase - The stability of this feature.
      patterns - What the user may write to match the feature. Defaults to the codename if not set.
      Returns:
      An experiment flag.

    • codeName

      String codeName()
      A simple, printable code-name for this pattern for warnings and debugging. Ideally, this should be matched by one of the pattern() entries.
      Returns:
      The code name of this experiment.

    • phase

      LifeCycle phase()
      Returns:
      The safety phase of this feature.

    • isKnown

      default boolean isKnown()
      Returns:
      Whether this feature was declared by Skript or a real extension.

    • pattern

      SkriptPattern pattern()
      Returns:
      The compiled matching pattern for this experiment

    • matches

      default boolean matches(String text)
      Returns:
      Whether the usage pattern of this experiment matches the input text