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>

public class ScriptFunction<T>
extends Function<T>

Field Summary

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

executeWithNulls

Constructor Summary

Constructors

Constructor	Description
ScriptFunction(Signature<T> sign, Script script, SectionNode node)

Method Summary

Modifier and Type	Method	Description
@Nullable T[]	execute(FunctionEvent<?> e, Object[][] params)	Executes this function with given parameters.
boolean	resetReturnValue()	Resets the return value of the Function.
final void	setReturnValue(@Nullable T[] value)	Should only be called by EffReturn.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptFunction

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

Method Details

setReturnValue

public final void setReturnValue(@Nullable T[] value)

Should only be called by EffReturn.

execute

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

Description copied from class: Function

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

Specified by:

execute in class Function<T>

Parameters:

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

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