Package ch.njol.skript.expressions
Class ExprPlayerViewDistance
java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<T>
ch.njol.skript.expressions.base.PropertyExpression<F,T>
ch.njol.skript.expressions.base.SimplePropertyExpression<org.bukkit.entity.Player,Integer>
ch.njol.skript.expressions.ExprPlayerViewDistance
- All Implemented Interfaces:
Converter<org.bukkit.entity.Player,
,Integer> Debuggable
,Expression<Integer>
,SyntaxElement
@Name("View Distance")
@Description({"The view distance of a player as set by the server. Can be changed.","NOTE: This is the view distance sent by the server to the player.","This has nothing to do with client side view distance settings","NOTE: This may not work on some versions (such as MC 1.14.x).","The return value in this case will be the view distance set in system.properties."})
@Examples({"set view distance of player to 10","set {_view} to view distance of player","reset view distance of all players","add 2 to view distance of player"})
@RequiredPlugins("Paper")
@Since("2.4")
public class ExprPlayerViewDistance
extends SimplePropertyExpression<org.bukkit.entity.Player,Integer>
-
Nested Class Summary
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
Converter.ConverterInfo<F,
T>, Converter.ConverterUtils -
Field Summary
Fields inherited from interface ch.njol.skript.classes.Converter
NO_CHAINING, NO_COMMAND_ARGUMENTS, NO_LEFT_CHAINING, NO_RIGHT_CHAINING
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription@Nullable Class<?>[]
Tests whether this expression supports the given mode, and if yes what type it expects thedelta
to be.void
change
(org.bukkit.event.Event event, @Nullable Object[] delta, Changer.ChangeMode mode) Changes the expression's value by the given amount.@Nullable Integer
convert
(org.bukkit.entity.Player player) Converts an object from the given to the desired type.protected String
Gets the return type of this expression.Methods inherited from class ch.njol.skript.expressions.base.SimplePropertyExpression
get, init, toString
Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression
get, get, getAll, getAnd, getExpr, isSingle, register, registerDefault, setExpr, simplify
Methods inherited from class ch.njol.skript.lang.util.SimpleExpression
check, check, check, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, setTime, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface ch.njol.skript.lang.Expression
beforeChange, getAcceptedChangeModes, getOptionalSingle, stream
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser
-
Constructor Details
-
ExprPlayerViewDistance
public ExprPlayerViewDistance()
-
-
Method Details
-
convert
Description copied from interface:Converter
Converts an object from the given to the desired type. -
acceptChange
Description copied from interface:Expression
Tests whether this expression supports the given mode, and if yes what type it expects thedelta
to be.Use
Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...)
to test whether an expression supports changing, don't directly use this method!Please note that if a changer is registered for this expression's
returnType
this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) inExpression.change(Event, Object[], ChangeMode)
with super.change(...).Unlike
Changer.acceptChange(ChangeMode)
this method may print errors.- Specified by:
acceptChange
in interfaceExpression<Integer>
- Overrides:
acceptChange
in classSimpleExpression<Integer>
- Returns:
- An array of types that
Expression.change(Event, Object[], ChangeMode)
accepts as itsdelta
parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. ForChanger.ChangeMode.DELETE
andChanger.ChangeMode.RESET
this can return any non-null array to mark them as supported.
-
change
Description copied from interface:Expression
Changes the expression's value by the given amount. This will only be called on supported modes and with the desireddelta
type as returned byExpression.acceptChange(ChangeMode)
- Specified by:
change
in interfaceExpression<Integer>
- Overrides:
change
in classSimpleExpression<Integer>
delta
- An array with one or more instances of one or more of the the classes returned byExpression.acceptChange(ChangeMode)
for the given change mode (null forChanger.ChangeMode.DELETE
andChanger.ChangeMode.RESET
). This can be a Object[], thus casting is not allowed.
-
getReturnType
Description copied from interface:Expression
Gets the return type of this expression.- Returns:
- A supertype of any objects returned by
Expression.getSingle(Event)
and the component type of any arrays returned byExpression.getArray(Event)
-
getPropertyName
- Specified by:
getPropertyName
in classSimplePropertyExpression<org.bukkit.entity.Player,
Integer>
-