Expressions
[local] [(plural|non(-|[ ])single))] expression <pattern>:
return type: <skript type (cannot be a java type)> # optional
loop of: <text> # optional
usable in:
# events, optional
parse:
# code, optional
get:
# code, optional
add:
# code, optional
set:
# code, optional
remove:
# code, optional
remove all:
# code, optional
delete:
# code, optional
reset:
# code, optionalProperty expressions have two patterns:
When property expressions are used, if multiple inputs are passed, the get section is called multiple times with each individual input passed as the first expression.
Flag local
localSpecifying that an expression is local makes the expression only usable from within the script that it is defined in. This allows you to create expression that do not interfere with expressions from other addons or scripts.
Flag plural/non-single
plural/non-singleSpecifying that an expression is plural or non-single indicates that the expression may return more than one value regardless of context.
$ type modifier
$ type modifierIf the expression is single or non-single depending on whether the input is single or non-single, you may prefix the type with a $.
In the above example, uppercase "test" would be single and uppercase ("hello" and "world") would be non-single.
Option return type
return typeSpecifying a return type restricts the possible values that an expression returns, allowing Skript to potentially resolve type conflicts or perform optimizations.
In most cases, explicitly specifying a return type is unnecessary.
Option loop of
loop ofIf the expression is non-single, this option specifies an alias that may be used if the expression is looped.
Section usable in
usable inEach entry in this section should be either an imported class or a custom event (syntax: custom event %string%).
This condition will error if it is used outside of all the given events.
Section parse
parseCode in this section is executed whenever the effect is parsed. This section may be used to emit errors if the effect is used in an improper context.
If this section is included, you must also continue if the effect was parsed successfully.
Section get
getCode in this section is executed whenever the expression's value is read. This section must return a value and must not contain delays.
Return
Section add/set/remove/remove all/delete/reset
add/set/remove/remove all/delete/resetCode in these sections is executed whenever the expression is changed using Skript's change effect (or by other means).
Change Value
Represents the value (or values) that the expression is being changed by.
Last updated
Was this helpful?