Package ch.njol.skript.effects

Class EffMessage

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

ch.njol.skript.effects.EffMessage

All Implemented Interfaces:

Debuggable, SyntaxElement

@Name("Message")
@Description({"Sends a message to the given player. Only styles written","in given string or in <a href=expressions.html#ExprColoured>formatted expressions</a> will be parsed.","Adding an optional sender allows the messages to be sent as if a specific player sent them.","This is useful with Minecraft 1.16.4\'s new chat ignore system, in which players can choose to ignore other players,","but for this to work, the message needs to be sent from a player."})
@Examples({"message \"A wild %player% appeared!\"","message \"This message is a distraction. Mwahaha!\"","send \"Your kill streak is %{kill streak::%uuid of player%}%.\" to player","if the targeted entity exists:","\tmessage \"You\'re currently looking at a %type of the targeted entity%!\"","on chat:","\tcancel event","\tsend \"[%player%] >> %message%\" to all players from player"})
@RequiredPlugins("Minecraft 1.16.4+ for optional sender")
@Since("1.0, 2.2-dev26 (advanced features), 2.5.2 (optional sender), 2.6 (sending objects)")
public class EffMessage
extends Effect

Field Summary

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

parent

Constructor Summary

Constructors

Constructor	Description
EffMessage()

Method Summary

Modifier and Type	Method	Description
protected void	execute(org.bukkit.event.Event e)	Executes this effect.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parser)	Called just after the constructor.
String	toString(@Nullable org.bukkit.event.Event e, boolean debug)

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

parse, run

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

debug, 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 ch.njol.skript.lang.SyntaxElement

getParser

Constructor Details

EffMessage

public EffMessage()

Method Details

init

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

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)

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

protected void execute(org.bukkit.event.Event e)

Description copied from class: Effect

Executes this effect.

Specified by:

execute in class Effect

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