Package ch.njol.skript.lang
Class Effect
java.lang.Object
ch.njol.skript.lang.TriggerItem
ch.njol.skript.lang.Statement
ch.njol.skript.lang.Effect
- All Implemented Interfaces:
Debuggable
,SyntaxElement
,RuntimeErrorProducer
,SyntaxRuntimeErrorProducer
- Direct Known Subclasses:
AsyncEffect
,EffAllowAging
,EffBreedable
,EffectSectionEffect
,EffFishingLure
,EffGenerateLoot
,EffMakeAdultOrBaby
,EffPullHookedEntity
,EffRegisterTag
,EffRotate
,EffTextDisplayDropShadow
,EffTextDisplaySeeThroughBlocks
An effect which is unconditionally executed when reached, and execution will usually continue with the next item of the trigger after this effect is executed (the stop effect
for example stops the trigger, i.e. nothing else will be executed after it)
- See Also:
-
Field Summary
Fields inherited from class ch.njol.skript.lang.TriggerItem
parent
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
execute
(org.bukkit.event.Event event) Executes this effect.getNode()
Returns the sourceNode
for any errors the implementing class emits.@NotNull String
static @Nullable Effect
boolean
preInit()
Called immediately after the constructor.final boolean
run
(org.bukkit.event.Event event) Executes this item.Methods inherited from class ch.njol.skript.lang.TriggerItem
debug, executionIntent, getActualNext, getIndentation, getNext, getParent, getTrigger, setNext, setParent, toString, walk, walk
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface ch.njol.skript.lang.Debuggable
toString
Methods inherited from interface org.skriptlang.skript.log.runtime.RuntimeErrorProducer
error, error, getRuntimeErrorManager, warning, warning
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser, init
Methods inherited from interface org.skriptlang.skript.log.runtime.SyntaxRuntimeErrorProducer
getErrorSource
-
Constructor Details
-
Effect
protected Effect()
-
-
Method Details
-
preInit
public boolean preInit()Description copied from interface:SyntaxElement
Called immediately after the constructor. This should be used to do any work that need to be done prior to downstream initialization. This is not intended to be used by syntaxes directly, but by parent classes to do work prior to the initialization of the child classes.- Specified by:
preInit
in interfaceSyntaxElement
- Returns:
- Whether this expression was pre-initialised successfully. An error should be printed prior to returning false to specify the cause.
-
execute
protected abstract void execute(org.bukkit.event.Event event) Executes this effect.- Parameters:
event
- The event with which this effect will be executed
-
run
public final boolean run(org.bukkit.event.Event event) Description copied from class:TriggerItem
Executes this item.- Specified by:
run
in classTriggerItem
- Parameters:
event
- The event to run this item with- Returns:
- True if the next item should be run, or false for the item following this item's parent.
-
parse
-
getNode
Description copied from interface:SyntaxRuntimeErrorProducer
Returns the sourceNode
for any errors the implementing class emits.
Used for accessing the line contents viaNode.getKey()
and the line number viaNode.getLine()
.
A standard implementation is to store the Node duringSyntaxElement.init(Expression[], int, Kleenean, SkriptParser.ParseResult)
viaParserInstance.getNode()
.- Specified by:
getNode
in interfaceSyntaxRuntimeErrorProducer
- Returns:
- The source that produced a runtime error.
-
getSyntaxTypeName
- Specified by:
getSyntaxTypeName
in interfaceSyntaxElement
- Returns:
- A string naming the type of syntax this is. e.g. "expression", "section".
-