Variables Tutorial

Each of the variables in the config follows a certain format. Here you can find the explanation of the options you can use. Everytime you modify something in this file you must reload the plugin using /svar reload

Variable Type

Type of the variable. You can use PLAYER or GLOBAL.

• GLOBAL: The variable is set for the whole server.

• PLAYER: The variable is set for a player in particular.

variable_type: GLOBAL

Value Type

Value format of the variable. You can use TEXT, INTEGER or DOUBLE.

• TEXT: The variable accepts all values.

• INTEGER: The variable accepts only numbers.

• DOUBLE: The variable accepts numbers with decimals.

If you want to use the add/reduce commands you must set this option to INTEGER or DOUBLE.

value_type: TEXT

Initial Value

The initial or default value of the variable.

 initial_value: "off"
 initial_value: 500

Possible Values

The possible values of this variable. You'll not be able to set the variable to a different value. Format: <value>;(optional)<display>

The "display" is optional and it is a visual representation of the variable which can be used as a PlaceholderAPI variable. Always use a single word for the value option, if you need multiple words, use something like this: "this_is_the_first_value".

possible_values:
- "off;&c&lPortal Disabled"
- "on;&a&lPortal Enabled"

possible_values:
- "1"
- "2"
- "3"

This parameter is completely optional.

Limitations

Conditions that the variable will have. You will not be able to change the variable if the new value doesn't respect these conditions.

Min Value

Minimum value of the variable. Only works with Value Type on INTEGER or DOUBLE.

limitations:
  min_value: 0

Max Value

Maximum value of the variable. Only works with Value Type on INTEGER or DOUBLE.

limitations:
  max_value: 100

Manage Out of Range

If this option is set to true, when changing the variable's value, to something that is outside the max/min limits, the out of range error will disappear, and instead, the limit will be used as the new value.

limitations:
  manage_out_of_range: true

# Example 1
# /svar set test_variable 1500
# This command will throw an error, because the max value is 1000.
limitations:
  max_value: 1000
  
# Example 2
# /svar set test_variable 1500
# manage_out_of_range is set to true, so this command will set the value to 1000 (the max value).
limitations:
  max_value: 1000
  manage_out_of_range: true

Max Characters

Maximum number of characters of the variable. Only works with Value Type on TEXT.

limitations:
  max_characters: 10

Max Decimals

Maximum number of decimals. Only works with Value Type on DOUBLE.

In contrast to the previous options, this is not really a limitation, but a transformation, which means the final value of the variable will always have a maximum of X decimals, even if you used many more decimals on the command to modify its value.

limitations:
  max_decimals: 3