Package ch.njol.skript.lang.function

Class JavaFunction<T>

java.lang.Object

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

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

Direct Known Subclasses:

SimpleJavaFunction

public abstract class JavaFunction<T>
extends Function<T>

Field Summary

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

executeWithNulls

Constructor Summary

Constructors

Constructor	Description
JavaFunction(Signature<T> sign)
JavaFunction(String name, Parameter<?>[] parameters, ClassInfo<T> returnType, boolean single)
JavaFunction(String name, Parameter<?>[] parameters, ClassInfo<T> returnType, boolean single, @Nullable Contract contract)

Method Summary

Modifier and Type	Method	Description
JavaFunction<T>	description(String... description)	Only used for Skript's documentation.
JavaFunction<T>	examples(String... examples)	Only used for Skript's documentation.
abstract T @Nullable []	execute(FunctionEvent<?> event, Object[][] params)	Executes this function with given parameters.
String @Nullable []	getDescription()
String @Nullable []	getExamples()
String @Nullable []	getKeywords()
@Nullable String	getSince()
JavaFunction<T>	keywords(String... keywords)	Only used for Skript's documentation.
boolean	resetReturnValue()	Resets the return value of the Function.
@NotNull String @Nullable []	returnedKeys()
void	setReturnedKeys(@NotNull String @Nullable [] keys)	Sets the keys that will be returned by this function.
JavaFunction<T>	since(String since)	Only used for Skript's documentation.

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

JavaFunction

public JavaFunction(Signature<T> sign)

JavaFunction

public JavaFunction(String name,
 Parameter<?>[] parameters,
 ClassInfo<T> returnType,
 boolean single)

JavaFunction

public JavaFunction(String name,
 Parameter<?>[] parameters,
 ClassInfo<T> returnType,
 boolean single,
 @Nullable
 @Nullable Contract contract)

Method Details

execute

public abstract 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.

setReturnedKeys

public void setReturnedKeys(@NotNull
 @NotNull String @Nullable [] keys)

Sets the keys that will be returned by this function.
Note: The length of the keys array must match the number of return values.

Parameters:

keys - An array of keys to be returned by the function. Can be null.

Throws:

IllegalStateException - If the function is returns a single value.

description

public JavaFunction<T> description(String... description)

Only used for Skript's documentation.

Returns:

This JavaFunction object

examples

public JavaFunction<T> examples(String... examples)

Only used for Skript's documentation.

Returns:

This JavaFunction object

keywords

public JavaFunction<T> keywords(String... keywords)

Only used for Skript's documentation.

Parameters:

keywords -

Returns:

This JavaFunction object

since

public JavaFunction<T> since(String since)

Only used for Skript's documentation.

Returns:

This JavaFunction object

getDescription

public String @Nullable [] getDescription()

getExamples

public String @Nullable [] getExamples()

getKeywords

public String @Nullable [] getKeywords()

getSince

@Nullable
public @Nullable String getSince()

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