Package ch.njol.skript.expressions

Class ExprItemWithLore

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<T>

ch.njol.skript.expressions.base.PropertyExpression<ItemType,ItemType>

ch.njol.skript.expressions.ExprItemWithLore

All Implemented Interfaces:

Debuggable, Expression<ItemType>, SyntaxElement

@Name("Item with Lore")
@Description({"Returns the given item type with the specified lore added to it.","If multiple strings are passed, each of them will be a separate line in the lore."})
@Examples({"set {_test} to stone with lore \"line 1\" and \"line 2\"","give {_test} to player"})
@Since("2.3")
public class ExprItemWithLore
extends PropertyExpression<ItemType,ItemType>

Constructor Summary

Constructors

Constructor	Description
ExprItemWithLore()

Method Summary

Modifier and Type	Method	Description
protected ItemType[]	get(org.bukkit.event.Event e, ItemType[] source)	Converts the given source object(s) to the correct type.
Class<? extends ItemType>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean kleenean, SkriptParser.ParseResult parseResult)	Called just after the constructor.
String	toString(@Nullable org.bukkit.event.Event e, boolean debug)

Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression

get, get, getAll, getAnd, getExpr, isSingle, register, setExpr, simplify

Methods inherited from class ch.njol.skript.lang.util.SimpleExpression

acceptChange, change, check, check, check, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, 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, stream

Methods inherited from interface ch.njol.skript.lang.SyntaxElement

getParser

Constructor Details

ExprItemWithLore

public ExprItemWithLore()

Method Details

init

public boolean init(Expression<?>[] exprs,
 int matchedPattern,
 Kleenean kleenean,
 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 matched

kleenean - 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:

ParserInstance.isCurrentEvent(Class...)

get

protected ItemType[] get(org.bukkit.event.Event e,
 ItemType[] source)

Description copied from class: PropertyExpression

Converts the given source object(s) to the correct type.

Please note that the returned array must neither be null nor contain any null elements!

Specified by:

get in class PropertyExpression<ItemType,ItemType>

Returns:

An array of the converted objects, which may contain less elements than the source array, but must not be null.

See Also:

Converters.convert(Object[], Class, Converter)

getReturnType

public Class<? extends ItemType> 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 by Expression.getArray(Event)

toString

public String toString(@Nullable org.bukkit.event.Event e,
 boolean debug)

Parameters:

e - The event to get information to. 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