Package org.skriptlang.skript.bukkit.damagesource.elements

Class ExprCausingEntity

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<org.bukkit.entity.Entity>
ch.njol.skript.expressions.base.PropertyExpression<org.bukkit.damage.DamageSource,org.bukkit.entity.Entity>
ch.njol.skript.expressions.base.SimplePropertyExpression<org.bukkit.damage.DamageSource,org.bukkit.entity.Entity>
org.skriptlang.skript.bukkit.damagesource.elements.ExprCausingEntity
All Implemented Interfaces:
Debuggable, Expression<org.bukkit.entity.Entity>, Loopable<org.bukkit.entity.Entity>, Simplifiable<Expression<? extends org.bukkit.entity.Entity>>, SyntaxElement, DamageSourceExperimentSyntax, Converter<org.bukkit.damage.DamageSource,org.bukkit.entity.Entity>, ExperimentalSyntax, SimpleExperimentalSyntax, RuntimeErrorProducer, SyntaxRuntimeErrorProducer
@Name("Damage Source - Causing Entity") @Description({"The causing entity of a damage source.","The causing entity is the entity that ultimately caused the damage. (e.g. the entity that shot an arrow)","When setting a \'causing entity\' you must also set a \'direct entity\'.","Attributes of a damage source cannot be changed once created, only while within the \'custom damage source\' section."}) @Example("set {_source} to a custom damage source:\n\tset the damage type to magic\n\tset the causing entity to {_player}\n\tset the direct entity to {_arrow}\n\tset the damage location to location(0, 0, 10)\n") @Example("on damage:\n\tset {_causing} to the causing entity of event-damage source\n") @Since("2.12") @RequiredPlugins("Minecraft 1.20.4+") public class ExprCausingEntity extends ch.njol.skript.expressions.base.SimplePropertyExpression<org.bukkit.damage.DamageSource,org.bukkit.entity.Entity> implements DamageSourceExperimentSyntax

  • Constructor Details

    • ExprCausingEntity

      public ExprCausingEntity()

  • Method Details

    • init

      public boolean init(Expression<?>[] expressions, 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
      Overrides:
      init in class ch.njol.skript.expressions.base.SimplePropertyExpression<org.bukkit.damage.DamageSource,org.bukkit.entity.Entity>
      Parameters:
      expressions - 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:

    • convert

      @Nullable public @Nullable org.bukkit.entity.Entity convert(org.bukkit.damage.DamageSource damageSource)
      Description copied from interface: Converter
      Converts an object using this Converter.
      Specified by:
      convert in interface Converter<org.bukkit.damage.DamageSource,org.bukkit.entity.Entity>
      Specified by:
      convert in class ch.njol.skript.expressions.base.SimplePropertyExpression<org.bukkit.damage.DamageSource,org.bukkit.entity.Entity>
      Parameters:
      damageSource - The object to convert.
      Returns:
      The converted object.

    • acceptChange

      public Class<?> @Nullable [] acceptChange(Changer.ChangeMode mode)
      Description copied from interface: Expression
      Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.

      Use Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...) to test whether an expression supports changing, don't directly use this method!

      Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with super.change(...).

      Unlike Changer.acceptChange(ChangeMode) this method may print errors.

      Specified by:
      acceptChange in interface Expression<org.bukkit.entity.Entity>
      Overrides:
      acceptChange in class SimpleExpression<org.bukkit.entity.Entity>
      Parameters:
      mode - The mode to check
      Returns:
      An array of types that Expression.change(Event, Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

    • change

      public void change(org.bukkit.event.Event event, Object @Nullable [] delta, Changer.ChangeMode mode)
      Description copied from interface: Expression
      Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by Expression.acceptChange(ChangeMode)
      Specified by:
      change in interface Expression<org.bukkit.entity.Entity>
      Overrides:
      change in class SimpleExpression<org.bukkit.entity.Entity>
      Parameters:
      event - The event
      delta - An array with one or more instances of one or more of the classes returned by Expression.acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.
      mode - The Changer.ChangeMode of the attempted change

    • getReturnType

      public Class<org.bukkit.entity.Entity> getReturnType()
      Description copied from interface: Expression
      Gets the return type of this expression.
      Specified by:
      getReturnType in interface Expression<org.bukkit.entity.Entity>
      Returns:
      A supertype of any objects returned by Expression.getSingle(Event) and the component type of any arrays returned by Expression.getArray(Event)

    • getPropertyName

      protected String getPropertyName()
      Specified by:
      getPropertyName in class ch.njol.skript.expressions.base.SimplePropertyExpression<org.bukkit.damage.DamageSource,org.bukkit.entity.Entity>