Package ch.njol.skript.lang.function

Class Function<T>

java.lang.Object

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

All Implemented Interfaces:

Function<T>

Direct Known Subclasses:

JavaFunction, ScriptFunction

public abstract class Function<T>
extends Object
implements Function<T>

Functions can be called using arguments.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	executeWithNulls	Execute functions even when some parameters are not present.

Constructor Summary

Constructors

Constructor	Description
Function(Signature<T> sign)

Method Summary

Modifier and Type	Method	Description
abstract T @Nullable []	execute(FunctionEvent<?> event, Object[][] params)	Deprecated, for removal: This API element is subject to removal in a future version. Use Function.execute(FunctionEvent, FunctionArguments) instead.
final T @Nullable []	execute(Object[][] params)	Deprecated, for removal: This API element is subject to removal in a future version. Use Function.execute(FunctionEvent, FunctionArguments) instead.
String	getName()
Parameter<?>	getParameter(int index)	Deprecated, for removal: This API element is subject to removal in a future version. Use Signature.parameters() and Parameters.get(int) instead.
Parameter<?>[]	getParameters()	Deprecated, for removal: This API element is subject to removal in a future version. Use Signature.parameters() and Parameters.all() instead.
@Nullable ClassInfo<T>	getReturnType()
Signature<T>	getSignature()	Gets signature of this function that contains all metadata about it.
boolean	isSingle()
abstract boolean	resetReturnValue()	Resets the return value of the Function.
@NotNull String @Nullable []	returnedKeys()
@NotNull Signature<T>	signature()
String	toString()
Class<T>	type()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.skriptlang.skript.common.function.Function

execute

Field Details

executeWithNulls

public static boolean executeWithNulls

Execute functions even when some parameters are not present. Field is updated by SkriptConfig in case of reloads.

Constructor Details

Function

public Function(Signature<T> sign)

Method Details

getSignature

public Signature<T> getSignature()

Gets signature of this function that contains all metadata about it.

Returns:

A function signature.

signature

public @NotNull Signature<T> signature()

Specified by:

signature in interface Function<T>

Returns:

The signature belonging to this function.

getName

public String getName()

getParameters

@Deprecated(forRemoval=true,
            since="2.14")
public Parameter<?>[] getParameters()

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

Use Signature.parameters() and Parameters.all() instead.

getParameter

@Deprecated(forRemoval=true,
            since="2.14")
public Parameter<?> getParameter(int index)

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

Use Signature.parameters() and Parameters.get(int) instead.

isSingle

public boolean isSingle()

getReturnType

@Nullable
public @Nullable ClassInfo<T> getReturnType()

type

public Class<T> type()

Returns:

The return type of this signature. Returns null for no return type.

execute

@Deprecated(forRemoval=true,
            since="2.14")
public final T @Nullable [] execute(Object[][] params)

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

Use Function.execute(FunctionEvent, FunctionArguments) instead.

execute

@Deprecated(since="2.14",
            forRemoval=true)
public abstract T @Nullable [] execute(FunctionEvent<?> event,
 Object[][] params)

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

Use Function.execute(FunctionEvent, FunctionArguments) instead.

returnedKeys

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

Specified by:

returnedKeys in interface Function<T>

Returns:

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

resetReturnValue

public abstract boolean resetReturnValue()

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

Specified by:

resetReturnValue in interface Function<T>

Returns:

Whether or not the return value was successfully reset

toString

public String toString()

Overrides:

toString in class Object