Class EffTeleport

java.lang.Object

ch.njol.skript.lang.TriggerItem

ch.njol.skript.lang.Statement

ch.njol.skript.lang.Effect

org.skriptlang.skript.bukkit.entity.elements.effects.EffTeleport

All Implemented Interfaces:

Debuggable, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Teleport")
@Description("Teleport an entity to a specific location.\nThis effect is delayed by default, as it waits for the chunk of the location to be loaded before teleporting.\nThe keyword 'force' may be used to bypass this behavior (preventing the delay), but note that it may cause lag spikes or other server performance issues when teleporting to unloaded chunks.\nTeleport flags are properties to retain during a teleport, such as direction, passengers, and velocities.\n")
@Example("teleport the player to {home::%uuid of player%}") @Example("teleport the attacker to the victim") @Example("on dismount:\n\tcancel event\n\tteleport the player to {server::spawn} retaining vehicle and passengers\n")
@Since("1.0, 2.10 (flags)")
public class EffTeleport
extends Effect

Field Summary

Fields inherited from class TriggerItem

parent

Constructor Summary

Constructors

Constructor	Description
EffTeleport()

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)
protected @Nullable TriggerItem	walk(org.bukkit.event.Event event)	Executes this item and returns the next item to run.

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

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

EffTeleport

public EffTeleport()

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

walk

@Nullable
protected @Nullable TriggerItem walk(org.bukkit.event.Event event)

Description copied from class: TriggerItem

Executes this item and returns the next item to run.

Overriding classes must call TriggerItem.debug(Event, boolean). If this method is overridden, TriggerItem.run(Event) is not used anymore and can be ignored.

Overrides:

walk in class TriggerItem

Parameters:

event - The event

Returns:

The next item to run or null to stop execution

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