Class EffCommand

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

org.skriptlang.skript.bukkit.command.elements.effects.EffCommand

All Implemented Interfaces:

Debuggable, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Command")
@Description("Executes a command. This can be useful to use other plugin in triggers.\nIf the command is a BungeeCord side command, you can use the '[bungeecord]' keyword option to execute the command on the proxy.\n")
@Example("make player execute command \"/home\"") @Example("execute console command \"/say Hello everyone!\"") @Example("execute player bungeecord command \"/alert &6Testing Announcement!\"")
@Since("1.0, 2.8.0 (BungeeCord command)")
public class EffCommand
extends Effect

Field Summary

Fields inherited from class TriggerItem

parent

Constructor Summary

Constructors

Constructor	Description
EffCommand()

Method Summary

Modifier and Type	Method	Description
static boolean	dispatchCommand(org.bukkit.command.CommandSender sender, String command, RuntimeErrorProducer errorProducer)
void	execute(org.bukkit.event.Event event)	Executes this effect.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor and SyntaxElement.preInit().
static void	register(SyntaxRegistry syntaxRegistry)
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)

Methods inherited from class Effect

getNode, getSyntaxTypeName, parse, preInit, run

Methods inherited from class Statement

parse, parse

Methods inherited from class TriggerItem

debug, executionIntent, getActualNext, getIndentation, getNext, getParent, getTrigger, setNext, setParent, toString, walk, walk

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

Methods inherited from interface SyntaxElement

getParser

Methods inherited from interface SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

EffCommand

public EffCommand()

Method Details

register

public static void register(SyntaxRegistry syntaxRegistry)

init

public boolean init(Expression<?>[] exprs,
 int matchedPattern,
 Kleenean isDelayed,
 SkriptParser.ParseResult parseResult)

Description copied from interface: SyntaxElement

Called just after the constructor and SyntaxElement.preInit().

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...)

execute

public void execute(org.bukkit.event.Event event)

Description copied from class: Effect

Executes this effect.

Specified by:

execute in class Effect

Parameters:

event - The event with which this effect will be executed

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

dispatchCommand

@Internal
public static boolean dispatchCommand(org.bukkit.command.CommandSender sender,
 String command,
 RuntimeErrorProducer errorProducer)