Package ch.njol.skript.lang.function

Class FunctionReference<T>

java.lang.Object

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

All Implemented Interfaces:

Contract, Executable<org.bukkit.event.Event,T[]>

public class FunctionReference<T>
extends Object
implements Contract, Executable<org.bukkit.event.Event,T[]>

Reference to a Skript function.

Field Summary

Fields

Modifier and Type	Field	Description
final @Nullable String	script	Script in which this reference is found.

Constructor Summary

Constructors

Constructor	Description
FunctionReference(String functionName, @Nullable Node node, @Nullable String script, @Nullable Class<? extends T>[] returnTypes, Expression<?>[] params)

Method Summary

Modifier and Type	Method	Description
protected T @Nullable []	execute(org.bukkit.event.Event event)
T[]	execute(org.bukkit.event.Event event, Object... arguments)
Contract	getContract()	The contract is used in preference to the function for determining return type, etc.
@Nullable Function<? extends T>	getFunction()
@Nullable Class<? extends T>	getReturnType()
@Nullable Class<?>	getReturnType(Expression<?>... arguments)
boolean	isSingle()
boolean	isSingle(Expression<?>... arguments)
boolean	resetReturnValue()
String @Nullable []	returnedKeys()
String	toString(@Nullable org.bukkit.event.Event event, boolean debug)
boolean	validateFunction(boolean first)	Validates this function reference.
boolean	validateParameterArity(boolean first)

Methods inherited from class java.lang.Object

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

Field Details

script

@Nullable
public final @Nullable String script

Script in which this reference is found. Used for function unload safety checks.

Constructor Details

FunctionReference

public FunctionReference(String functionName,
 @Nullable
 @Nullable Node node,
 @Nullable
 @Nullable String script,
 @Nullable
 @Nullable Class<? extends T>[] returnTypes,
 Expression<?>[] params)

Method Details

validateParameterArity

public boolean validateParameterArity(boolean first)

validateFunction

public boolean validateFunction(boolean first)

Validates this function reference. Prints errors if needed.

Parameters:

first - True if this is called while loading a script. False when this is called when the function signature changes.

Returns:

True if validation succeeded.

getFunction

@Nullable
public @Nullable Function<? extends T> getFunction()

returnedKeys

public String @Nullable [] returnedKeys()

resetReturnValue

public boolean resetReturnValue()

execute

protected T @Nullable [] execute(org.bukkit.event.Event event)

isSingle

public boolean isSingle()

isSingle

public boolean isSingle(Expression<?>... arguments)

Specified by:

isSingle in interface Contract

Returns:

Whether, given these parameters, this will return a single value

See Also:

• Expression.isSingle()

getReturnType

@Nullable
public @Nullable Class<? extends T> getReturnType()

getReturnType

@Nullable
public @Nullable Class<?> getReturnType(Expression<?>... arguments)

Specified by:

getReturnType in interface Contract

Returns:

What this will return, given these parameters

See Also:

• Expression.getReturnType()

getContract

public Contract getContract()

The contract is used in preference to the function for determining return type, etc.

Returns:

The contract determining this function's parse-time hints, potentially this reference

toString

public String toString(@Nullable
 @Nullable org.bukkit.event.Event event,
 boolean debug)

execute

public T[] execute(org.bukkit.event.Event event,
 Object... arguments)

Specified by:

execute in interface Executable<org.bukkit.event.Event,T[]>