Class ExprFurnaceSlot
java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Slot>
org.skriptlang.skript.bukkit.furnace.elements.ExprFurnaceSlot
- All Implemented Interfaces:
Debuggable
,Expression<Slot>
,Loopable<Slot>
,SyntaxElement
@Name("Furnace Slot")
@Description("A slot of a furnace, i.e. either the ore, fuel or result slot.")
@Examples({"set the fuel slot of the clicked block to a lava bucket","set the block\'s ore slot to 64 iron ore","clear the result slot of the block","on smelt:","\tif the fuel slot is charcoal:","\t\tadd 5 seconds to the burn time"})
@Events({"smelt","fuel burn"})
@Since("1.0, 2.8.0 (syntax rework)")
public class ExprFurnaceSlot
extends SimpleExpression<Slot>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected Slot @Nullable []
get
(org.bukkit.event.Event event) This is the internal method to get an expression's values.
To get the expression's value from the outside useSimpleExpression.getSingle(Event)
orSimpleExpression.getArray(Event)
.Gets the return type of this expression.boolean
init
(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Called just after the constructor.boolean
isSingle()
boolean
setTime
(int time) Sets the time of this expression, i.e.toString
(@Nullable org.bukkit.event.Event event, boolean debug) Methods inherited from class ch.njol.skript.lang.util.SimpleExpression
acceptChange, change, check, check, check, getAll, getAnd, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, simplify, supportsLoopPeeking, toString
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.Expression
beforeChange, canBeSingle, canReturn, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, possibleReturnTypes, stream
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser
-
Constructor Details
-
ExprFurnaceSlot
public ExprFurnaceSlot()
-
-
Method Details
-
init
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Description copied from interface:SyntaxElement
Called just after the constructor.- 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 matchedisDelayed
- 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:
-
get
Description copied from class:SimpleExpression
This is the internal method to get an expression's values.
To get the expression's value from the outside useSimpleExpression.getSingle(Event)
orSimpleExpression.getArray(Event)
.- Specified by:
get
in classSimpleExpression<Slot>
- Parameters:
event
- The event with which this expression is evaluated.- Returns:
- An array of values for this event. May not contain nulls.
-
isSingle
public boolean isSingle()- Returns:
- true if this expression will ever only return one value at most, false if it can return multiple values.
-
getReturnType
Description copied from interface:Expression
Gets the return type of this expression.- Returns:
- A supertype of any objects returned by
Expression.getSingle(Event)
and the component type of any arrays returned byExpression.getArray(Event)
-
toString
- 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
-
setTime
public boolean setTime(int time) Description copied from class:SimpleExpression
Sets the time of this expression, i.e. whether the returned value represents this expression before or after the event.This method will not be called if this expression is guaranteed to be used after a delay (an error will be printed immediately), but will be called if it only can be after a delay (e.g. if the preceding delay is in an if or a loop) as well as if there's no delay involved.
If this method returns false the expression will be discarded and an error message is printed. Custom error messages must be of
ErrorQuality.SEMANTIC_ERROR
to be printed (NB:Skript.error(String)
always creates semantic errors).This implementation sets the time but returns false.
- Specified by:
setTime
in interfaceExpression<Slot>
- Overrides:
setTime
in classSimpleExpression<Slot>
- Parameters:
time
- -1 for past or 1 for future. 0 is never passed to this method as it represents the default state.- Returns:
- Whether this expression has distinct time states, e.g. a player never changes but a block can. This should be sensitive for the event (using
ParserInstance.isCurrentEvent(Class)
). - See Also:
-