Expressions

With one pattern

Syntax

[local] [(plural|non(-|[ ])single))] expression <pattern>:
  return type: <skript type (cannot be a java type)> # optional
  loop of: <text> # 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, optional

With multiple patterns

Syntax

[local] [(plural|non(-|[ ])single))] expression:
  patterns:
    # patterns, one per line
  return type: <skript type (cannot be a java type)> # 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, optional

Property expression

Syntax

[local] <skript types> property <pattern>:
  return type: <skript type> # 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, optional

Property expressions have two patterns:

[the] <pattern> of %$<skript types>%
%$<skript types>%'[s] <pattern>

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.

expression-1 is always the object the property belongs to, even when the[the] <pattern> of %$<skript types>% form is used.

Flag local

Specifying 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.

Local expressions are guaranteed to be parsed before other custom expressions, but not necessarily before expressions from other addons.

Flag plural/non-single

Specifying that an expression is plural or non-single indicates that the expression may return more than one value regardless of context.

$ type modifier

If the expression is single or non-single depending on whether the input is single or non-single, you may prefix the type with a $.

example.sk

expression uppercase %$strings%:
  # ...

In the above example, uppercase "test" would be single and uppercase ("hello" and "world") would be non-single.

Option return type

Specifying 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

If the expression is non-single, this option specifies an alias that may be used if the expression is looped.

example.sk

plural expression test points:
  loop of: point

on script load:
  loop test points:
    # You may use "loop-point" instead of "loop-value" here

Section parse

Code 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.

Local variables created in this section are copied by-value to other sections.

example.sk

effect example:
  parse:
      set {_test} to 1
  get:
    # {_test} always starts at 1 here
    add 1 to {_test}
    # 2 is always returned 
    return {_test}

Section get

Code in this section is executed whenever the expression's value is read. This section must return a value and must not contain delays.

Return

Syntax

return [%objects%]

Section add/set/remove/remove all/delete/reset

Code in these sections is executed whenever the expression is changed using Skript's change effect (or by other means).

Change Value

Syntax

[the] change value[s]

Represents the value (or values) that the expression is being changed by.

If multiple change values are expected, use the plural form of the expression change values instead of the singular change value.