Class EffEquipCompSwapEquipment

java.lang.Object
ch.njol.skript.lang.TriggerItem
ch.njol.skript.lang.Statement
ch.njol.skript.lang.Effect
org.skriptlang.skript.bukkit.itemcomponents.equippable.elements.EffEquipCompSwapEquipment
All Implemented Interfaces:
Debuggable, SyntaxElement, EquippableExperimentSyntax, ExperimentalSyntax, SimpleExperimentalSyntax, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Equippable Component - Swap Equipment") @Description("Whether the item can be swapped by right clicking with it in your hand.\nNOTE: Equippable component elements are experimental. Thus, they are subject to change and may not work as intended.\n") @Example("allow {_item} to swap equipment") @Example("set {_component} to the equippable component of {_item}\nprevent {_component} from swapping equipment on right click\n") @RequiredPlugins("Minecraft 1.21.2+") @Since("2.13") public class EffEquipCompSwapEquipment extends Effect implements EquippableExperimentSyntax
  • Constructor Details

    • EffEquipCompSwapEquipment

      public EffEquipCompSwapEquipment()
  • Method Details

    • register

      public static void register(SyntaxRegistry registry)
    • init

      public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)
      Description copied from interface: SyntaxElement
      Called just after the constructor and SyntaxElement.preInit().
      Specified by:
      init in interface SyntaxElement
      Parameters:
      exprs - all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out, it will still be included in this list holding the default value of the desired type, which usually depends on the event.
      matchedPattern - The index of the pattern which matched
      isDelayed - Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)
      parseResult - Additional information about the match.
      Returns:
      Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
      See Also:
    • execute

      protected void execute(org.bukkit.event.Event event)
      Description copied from class: Effect
      Executes this effect.
      Specified by:
      execute in class Effect
      Parameters:
      event - The event with which this effect will be executed
    • toString

      public String toString(@Nullable @Nullable org.bukkit.event.Event event, boolean debug)
      Specified by:
      toString in interface Debuggable
      Parameters:
      event - The event to get information from. This is always null if debug == false.
      debug - If true this should print more information, if false this should print what is shown to the end user
      Returns:
      String representation of this object