WorldEvent Files

A guide for the options in a WorldEvent YAML file.

First, here is what an empty WorldEvent file should have:

name:
description:
aliases:
element:
time:
modifier:
attributes:
frequency:
startmessage:
endmessage:
darkensky:
createfog:

Name & Description

These options are quite self-explanatory. They are the name of the event and a description of it for in-game use.

An important note, the name option should match the name of the file. E.g.; SozinsComet and SozinsComet.yml

Aliases

The aliases option is a list of alternative names that can be used in commands.

Element

This option indicates the element which the event should affect. Options for this include Air, Earth, Fire, Water, and Chi.

This option may work with custom elements, but as their are no custom elements in core, it cannot be guaranteed.

This option may work with subelements, but cannot be guaranteed.

Time

This option lets you assign when the event should happen in a daycycle. Options include DAY, NIGHT, BOTH.

Modifier

The modifier option is the numerical value to buff or nerf abilities in the specified element during the worldevent. If the modifier is zero or less, bending in that element will not work. Setting the value between zero and one will mostly nerf abilities, and greater than one will buff them.

Highly advised to avoid setting the modifier higher than 4, or to do so with extreme caution. Unintended side effects may occur.

Attributes

The attributes option is a list of ability attributes to modify using the modifier option. If you're looking for a specific part of an ability you want to modify, look at the code. Any variable with the Attribute annotation can be modified using the name it gives. Some general attributes are Damage, Range, Knockback, ChargeTime, Duration, Speed, etc.

Each item in the list is composed of two parts: the attribute and the operation to use. Acceptable operations are MULTIPLICATION, DIVISION, ADDITION, and SUBTRACTION. The attribute and operation are bound together with ::. An example list would look like:

attributes:
- Damage::MULTIPLICATION
- Range::MULTIPLICATION
- Knockback::MULTIPLICATION
- ChargeTime::DIVISION
- Duration::MULTIPLICATION
- Speed::MULTIPLICATION
- Width::MULTIPLICATION

Frequency

This option is for how often the event should occur. Do not use zero.

Start Message & End Message

Self-explanatory options, messages to be sent when the worldevent starts and ends.

Darken Sky

This option is true or false, will cause the sky to darken (a reddish color) while the worldevent is happening.

Create Fog

This option is true or false, will cause fog to appear while the worldevent is happening.