Package org.skriptlang.skript.bukkit.input.elements.conditions

Class CondIsPressingKey

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Condition

org.skriptlang.skript.bukkit.input.elements.conditions.CondIsPressingKey

All Implemented Interfaces:

Debuggable, SyntaxElement, Conditional<org.bukkit.event.Event>

@Name("Is Pressing Key")
@Description("Checks if a player is pressing a certain input key.")
@Examples({"on player input:","\tif player is pressing forward movement key:","\t\tsend \"You are moving forward!\""})
@Since("2.10")
@Keywords({"press","input"})
@RequiredPlugins("Minecraft 1.21.2+")
public class CondIsPressingKey
extends Condition

Nested Class Summary

Nested classes/interfaces inherited from class ch.njol.skript.lang.Condition

Condition.ConditionType

Nested classes/interfaces inherited from interface org.skriptlang.skript.lang.condition.Conditional

Conditional.Operator

Field Summary

Fields inherited from class ch.njol.skript.lang.TriggerItem

parent

Constructor Summary

Constructors

Constructor	Description
CondIsPressingKey()

Method Summary

Modifier and Type	Method	Description
boolean	check(org.bukkit.event.Event event)	Checks whether this condition is satisfied with the given event.
boolean	init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor.
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

Methods inherited from class ch.njol.skript.lang.Condition

evaluate, getSyntaxTypeName, isNegated, parse, run, setNegated

Methods inherited from class ch.njol.skript.lang.Statement

parse, parse

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 org.skriptlang.skript.lang.condition.Conditional

evaluate, evaluateAnd, evaluateAnd, evaluateAnd, evaluateAnd, evaluateNot, evaluateNot, evaluateOr, evaluateOr, evaluateOr, evaluateOr

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

toString

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

getParser

Constructor Details

CondIsPressingKey

public CondIsPressingKey()

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.

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:

• ParserInstance.isCurrentEvent(Class...)

check

public boolean check(org.bukkit.event.Event event)

Description copied from class: Condition

Checks whether this condition is satisfied with the given event. This should not alter the event or the world in any way, as conditions are only checked until one returns false. All subsequent conditions of the same trigger will then be omitted.

You might want to use SimpleExpression.check(Event, Predicate)

Specified by:

check in class Condition

Parameters:

event - the event to check

Returns:

true if the condition is satisfied, false otherwise or if the condition doesn't apply to this event.

toString

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

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