effects

Ban Player

• Description: Ban/unban the specified players with an optional reason, duration and by whom.
  If the sender is not specified, the ban will be issued by the console.
  If the duration is not specified, the ban will be permanent.
• Patterns:
  • ban %players/playerRefs/uuids%
  • ban %players/playerRefs/uuids% by %commandSender%
  • ban %players/playerRefs/uuids% for %duration%
  • ban %players/playerRefs/uuids% for %duration% by %commandSender%
  • ban %players/playerRefs/uuids% (for reason|due to|because) %string%
  • ban %players/playerRefs/uuids% (for reason|due to|because) %string% by %commandSender%
  • ban %players/playerRefs/uuids% for %duration% (for reason|due to|because) %string%
  • ban %players/playerRefs/uuids% for %duration% (for reason|due to|because) %string% by %commandSender%
  • unban %players/playerRefs/uuids%
• Examples:

ban player
ban {_player} by player
ban player for 10 minutes
ban {_player} for 1 week by {_player}
ban player due to "You cheated!"
ban {_someUUID} due to "You cheated!" by player
ban {_p} for 1 hour due to "You cheated!"
ban {_p} for 10 minutes due to "Be nicer in chat" by player
unban player
unban {_uuid}

• Since: 1.0.0

Broadcast

• Description: Broadcasts a message to all players in the server or in a specific world.
• Pattern: broadcast %strings% [(to|in) %worlds%]
• Examples:

broadcast "HELLO EVERYONE!!!"
broadcast "Free Cheese At Spawn" in world named "default"

Cancel Event

• Description: Cancels/uncancels the current event.
• Patterns:
  • cancel event
  • uncancel event
• Examples:

on chat:
	cancel event

• Since: 1.0.0

Delay

• Description: Delays the execution of the next statements for a specified duration.
• Patterns:
  • (wait|halt) [for] %duration%
  • (wait|halt) (until|while) %=boolean% [for %*duration%]
• Since: 1.0.0

Kick Player

• Description: Kicks the specified players with an optional reason.
• Patterns:
  • kick %players/playerRefs%
  • kick %players/playerRefs% (for reason|due to|because) %string%
• Examples:

kick all players due to "Cheating!"
kick player due to "Bad chat message!"
kick all players

• Since: 1.0.0

Kill Entity

• Description: Kills the specified entities with an optional damage cause.
• Patterns:
  • kill %entities%
  • kill %entities% with damage cause %damageCause%
• Examples:

kill all players
kill all players with damage cause slashing

• Since: 1.0.0

Send Message

• Description: Sends a message to a command sender such as a player or the console.
• Pattern: send [message[s]] %strings/messages% [to %-messageReceivers%]
• Examples:

send "Welcome to the server" to player

• Since: 1.0.0

Teleport

• Description: Teleport entities to a location.
• Pattern: teleport %entities% to %location%
• Examples:

teleport all players to {_location}
teleport player to bed location of player

• Since: 1.0.0

EffAsync

• Pattern: async[hronous[ly]] [(do|execute)] <.+>

EffChange

• Patterns:
  • set %~objects% to %objects%
  • %~objects% = %objects%
  • add %objects% to %~objects%
  • %~objects% += %objects%
  • remove %objects% from %~objects%
  • %~objects% -= %objects%
  • remove (all|every) %objects% from %~objects%
  • (delete|clear) %~objects%
  • reset %~objects%

EffContinue

• Pattern: continue [%*integer% loop[s]]

EffDoIf

• Pattern: [(do|execute)] <.+?>[,] [only] if %=boolean%

EffEscape

• Pattern: escape %integer% [(level|line)[s]]

EffExit

• Patterns:
  • (exit|stop) [[the] trigger]
  • (exit|stop) [(a|the [current]|this)] (section|loop|condition[al])
  • (exit|stop) %*integer% (section|loop|condition[al])[s]
  • (exit|stop) (every|all [[of] the]) (section|loop|condition[al])[s]

EffInlineCondition

• Pattern: continue [only] if %=boolean%

EffReturn

• Pattern: return %objects%

ExecExprListOperators

• Patterns:
  • extract [the] (last|first|%integer%(st|nd|rd|th)) element out [of] %objects%
  • pop %objects%
  • (shift|poll) %objects%
  • splice %objects% (from %integer% to %integer%|starting (at|from) %integer%|up to %integer%) [[with] step %integer%]

ExecExprReplace

• Patterns:
  • replace [(all|every|[the] first|[the] last)] [(regex [pattern[s]])] %strings% in %strings% with %string%
  • replace [(all|every|[the] first|[the] last)] [(regex [pattern[s]])] %strings% with %string% in %strings%