Package ch.njol.skript.lang.function

Class ScriptFunction<T>

java.lang.Object

ch.njol.skript.lang.function.Function<T>

ch.njol.skript.lang.function.ScriptFunction<T>

All Implemented Interfaces:

ReturnHandler<T>, Function<T>

public class ScriptFunction<T>
extends Function<T>
implements ReturnHandler<T>

Nested Class Summary

Nested classes/interfaces inherited from interface ch.njol.skript.lang.ReturnHandler

ReturnHandler.ReturnHandlerStack

Field Summary

Fields inherited from class ch.njol.skript.lang.function.Function

executeWithNulls

Constructor Summary

Constructors

Constructor	Description
ScriptFunction(Signature<T> sign, SectionNode node)
ScriptFunction(Signature<T> sign, Script script, SectionNode node)	Deprecated, for removal: This API element is subject to removal in a future version. use ScriptFunction(Signature, SectionNode) instead.

Method Summary

Modifier and Type	Method	Description
T @Nullable []	execute(FunctionEvent<?> event, Object[][] params)	Executes this function with given parameters.
final boolean	isSingleReturnValue()
boolean	resetReturnValue()	Resets the return value of the Function.
@NotNull String @Nullable []	returnedKeys()
final void	returnValues(org.bukkit.event.Event event, Expression<? extends T> value)	Called when EffReturn is executed
final @Nullable Class<? extends T>	returnValueType()	The return type of this return handler, or null if it can't accept return values in this context (e.g.
final void	setReturnValue(T[] values)	Deprecated, for removal: This API element is subject to removal in a future version. Use returnValues(Event, Expression) instead.

Methods inherited from class ch.njol.skript.lang.function.Function

execute, getName, getParameter, getParameters, getReturnType, getSignature, isSingle, signature, toString

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

loadReturnableSectionCode, loadReturnableSectionCode, loadReturnableTrigger

Constructor Details

ScriptFunction

@Deprecated(since="2.9.0",
            forRemoval=true)
public ScriptFunction(Signature<T> sign,
 Script script,
 SectionNode node)

Deprecated, for removal: This API element is subject to removal in a future version.

use ScriptFunction(Signature, SectionNode) instead.

ScriptFunction

public ScriptFunction(Signature<T> sign,
 SectionNode node)

Method Details

execute

public T @Nullable [] execute(FunctionEvent<?> event,
 Object[][] params)

Description copied from class: Function

Executes this function with given parameters. Usually, using Function.execute(Object[][]) is better; it handles optional and keyed arguments and function event creation automatically.

Specified by:

execute in class Function<T>

Parameters:

event - Associated function event. This is usually created by Skript.

params - Function parameters. There must be Signature.getMaxParameters() amount of them, and you need to manually handle default values.

Returns:

Function return value(s).

returnedKeys

@NotNull
public @NotNull String @Nullable [] returnedKeys()

Overrides:

returnedKeys in class Function<T>

Returns:

The keys of the values returned by this function, or null if no keys are returned.

setReturnValue

@Deprecated(since="2.9.0",
            forRemoval=true)
@Internal
public final void setReturnValue(@Nullable
 T[] values)

Deprecated, for removal: This API element is subject to removal in a future version.

Use returnValues(Event, Expression) instead.

resetReturnValue

public boolean resetReturnValue()

Description copied from class: Function

Resets the return value of the Function. Should be called right after execution.

Specified by:

resetReturnValue in class Function<T>

Returns:

Whether or not the return value was successfully reset

returnValues

public final void returnValues(org.bukkit.event.Event event,
 Expression<? extends T> value)

Description copied from interface: ReturnHandler

Called when EffReturn is executed

Specified by:

returnValues in interface ReturnHandler<T>

Parameters:

event - the event providing context

value - an expression representing the value(s) to return

isSingleReturnValue

public final boolean isSingleReturnValue()

Specified by:

isSingleReturnValue in interface ReturnHandler<T>

Returns:

whether this return handler may accept multiple return values

returnValueType

@Nullable
public final @Nullable Class<? extends T> returnValueType()

Description copied from interface: ReturnHandler

The return type of this return handler, or null if it can't accept return values in this context (e.g. a function without a return type).

Specified by:

returnValueType in interface ReturnHandler<T>

Returns:

the return type