Package org.skriptlang.skript.common.function

Interface Parameter.Modifier

All Known Implementing Classes:

Parameter.Modifier.RangedModifier

Enclosing interface:

Parameter<T>

public static interface Parameter.Modifier

Represents a modifier that can be applied to a parameter when constructing one using DefaultFunction.Builder.parameter(String, Class, Modifier[]).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Parameter.Modifier.RangedModifier<T extends Comparable<T>>	Modifier specifying valid range bounds for numeric parameters.

Field Summary

Fields

Modifier and Type	Field	Description
static final Parameter.Modifier	KEYED	The modifier for parameters that support optional keyed expressions.
static final Parameter.Modifier	OPTIONAL	The modifier for parameters that are optional.
static final Parameter.Modifier	RANGED	A modifier to use for checking if a parameter is ranged.

Method Summary

Static Methods

Modifier and Type	Method	Description
static Parameter.Modifier	of()
static <T extends Comparable<T>> Parameter.Modifier.RangedModifier<T>	ranged(T min, T max)	Creates a range modifier with inclusive min and max bounds.

Field Details

OPTIONAL

static final Parameter.Modifier OPTIONAL

The modifier for parameters that are optional.

KEYED

static final Parameter.Modifier KEYED

The modifier for parameters that support optional keyed expressions.

See Also:

• KeyProviderExpression
• KeyReceiverExpression

RANGED

static final Parameter.Modifier RANGED

A modifier to use for checking if a parameter is ranged. Do NOT use for declaring a parameter to be ranged, use ranged(Comparable, Comparable) Accessing the min and the max values can be done via Parameter.getModifier(Class).

Method Details

of

static Parameter.Modifier of()

Returns:

A new Modifier instance to be used as a custom flag.

ranged

static <T extends Comparable<T>>
Parameter.Modifier.RangedModifier<T> ranged(T min,
 T max)

Creates a range modifier with inclusive min and max bounds.