Package ch.njol.skript.expressions

Class ExprHiddenPlayers

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<org.bukkit.entity.Player>

ch.njol.skript.expressions.ExprHiddenPlayers

All Implemented Interfaces:

Debuggable, Expression<org.bukkit.entity.Player>, SyntaxElement

@Name("Hidden Players")
@Description("The players hidden from a player that were hidden using the <a href=\'effects.html#EffPlayerVisibility\'>player visibility</a> effect.")
@Examples("message \"&lt;light red&gt;You are currently hiding: &lt;light gray&gt;%hidden players of the player%\"")
@Since("2.3")
public class ExprHiddenPlayers
extends SimpleExpression<org.bukkit.entity.Player>

Constructor Summary

Constructors

Constructor	Description
ExprHiddenPlayers()

Method Summary

Modifier and Type	Method	Description
@Nullable org.bukkit.entity.Player[]	get(org.bukkit.event.Event e)	This is the internal method to get an expression's values. To get the expression's value from the outside use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).
@Nullable Expression<org.bukkit.entity.Player>	getPlayers()
Class<? extends org.bukkit.entity.Player>	getReturnType()	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()
String	toString(@Nullable org.bukkit.event.Event e, 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, 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

ExprHiddenPlayers

public ExprHiddenPlayers()

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

ParserInstance.isCurrentEvent(Class...)

isSingle

public boolean isSingle()

Returns:

true if this expression will ever only return one value at most, false if it can return multiple values.

get

public @Nullable org.bukkit.entity.Player[] get(org.bukkit.event.Event e)

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 use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).

Specified by:

get in class SimpleExpression<org.bukkit.entity.Player>

Parameters:

e - The event

Returns:

An array of values for this event. May not contain nulls.

getPlayers

public @Nullable Expression<org.bukkit.entity.Player> getPlayers()

getReturnType

public Class<? extends org.bukkit.entity.Player> 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