Package org.skriptlang.skript.bukkit.text.elements.effects

Class EffSendTitle

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

org.skriptlang.skript.bukkit.text.elements.effects.EffSendTitle

All Implemented Interfaces:

Debuggable, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Title - Send")
@Description({"Sends a title and/or subtitle to an audience with an optional fade in, stay, and/or fade out time.","If sending only the subtitle, it will only be shown if the audience currently has a title displayed. Otherwise, it will be shown when the audience is next shown a title.","Additionally, if no input is given for the times, the previous times of the last sent title will be used (or default values). Use the <a href=\'#EffResetTitle\'>reset title</a> effect to restore the default values for the times."})
@Example("send title \"Competition Started\" with subtitle \"Have fun, Stay safe!\" to player for 5 seconds") @Example("send title \"Hi %player%\" to player") @Example("send title \"Loot Drop\" with subtitle \"starts in 3 minutes\" to all players") @Example("send title \"Hello %player%!\" with subtitle \"Welcome to our server\" to player for 5 seconds with fadein 1 second and fade out 1 second") @Example("send subtitle \"Party!\" to all players")
@Since({"2.3","2.15 (support for showing anything)"})
public class EffSendTitle
extends Effect

Field Summary

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

parent

Constructor Summary

Constructors

Constructor	Description
EffSendTitle()

Method Summary

Modifier and Type	Method	Description
protected 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 ch.njol.skript.lang.Effect

getNode, getSyntaxTypeName, parse, preInit, run

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.log.runtime.RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

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

getParser

Methods inherited from interface org.skriptlang.skript.log.runtime.SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

EffSendTitle

public EffSendTitle()

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

protected 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