Conditional Effects Documentation

Conditional Effects

Apply potion effects to players based on pre-defined conditions.

Setup

  1. Add the Conditional Effects jar to your plugins folder.
  2. Restart your server.
  3. Edit effects.yml to your liking.
  4. Type /conditionaleffects reload.

Commands:

  • /conditionaleffects help: Show the help message
  • /conditionaleffects reload: Reload the plugin
  • /conditionaleffects give <player> <effectId>: Give a conditional effect to a player
  • /conditionaleffects check <player> <effectId>: Manually check a conditional effect on a player

Permissions:

  • conditionaleffects.reload: Allows the user to reload the plugin
  • conditionaleffects.give: Allows the user to give conditional effects to players
  • conditionaleffects.check: Allows the user to manually check conditional effects on players

Effects

hub-effects:
  conditions-check-interval-ticks: 20
  effects:
  - SPEED, 1
  - JUMP_BOOST, 1
  conditions:
    worlds:
    - hub

This example effect will provide speed and jump boost effects in the hub world.

Settings

  • conditions-check-interval-ticks: The number of ticks between each condition check.
  • effects: The potion effects that will be applied when the conditions are met. In the format <EffectType>, [Amplifier], [Duration], [HideParticles], [ShowIcon].
  • conditions: The conditions that must be met in order for the effects to be applied. All conditions must be met for the effects to be applied. See the Conditions section below.

Conditions

  • worlds: Worlds that the effects will be applied in.
  • environments: Environments that the effects will be applied in (e.g. NETHER, OVERWORLD).
  • biomes: Biomes that the effects will be applied in.
  • gamemodes: Game modes that the effects will be applied in.
  • has-permission: Effects will only be applied to players with all of these permissions.
  • missing-permission: Effects will only be applied to players who don't have any of these permissions.
  • min-x: Minimum X coordinate where the effects will be applied.
  • max-x: Maximum X coordinate where the effects will be applied.
  • min-y: Minimum Y coordinate where the effects will be applied.
  • max-y: Maximum Y coordinate where the effects will be applied.
  • min-z: Minimum Z coordinate where the effects will be applied.
  • max-z: Maximum Z coordinate where the effects will be applied.
  • in-water: If true, effects will only be applied to players in water. If false, effects will only be applied to players not in water. If this setting is not provided, then effects will be applied regardless.
  • sneaking: If true, effects will only be applied to players who are sneaking. If false, effects will only be applied to players who are not sneaking. If this setting is not provided, then effects will be applied regardless.
  • blocking: If true, effects will only be applied to players who are blocking. If false, effects will only be applied to players who are not blocking. If this setting is not provided, then effects will be applied regardless.
  • climbing: If true, effects will only be applied to players who are climbing. If false, effects will only be applied to players who are not climbing. If this setting is not provided, then effects will be applied regardless.
  • gliding: If true, effects will only be applied to players who are gliding. If false, effects will only be applied to players who are not gliding. If this setting is not provided, then effects will be applied regardless.
  • glowing: If true, effects will only be applied to players who are glowing. If false, effects will only be applied to players who are not glowing. If this setting is not provided, then effects will be applied regardless.
  • riptiding: If true, effects will only be applied to players who are riptiding. If false, effects will only be applied to players who are not riptiding. If this setting is not provided, then effects will be applied regardless.
  • in-vehicle: If true, effects will only be applied to players in a vehicle. If false, effects will only be applied to players not in a vehicle. If this setting is not provided, then effects will be applied regardless.
  • sprinting: If true, effects will only be applied to players who are sprinting. If false, effects will only be applied to players who are not sprinting. If this setting is not provided, then effects will be applied regardless.
  • flying: If true, effects will only be applied to players who are flying. If false, effects will only be applied to players who are not flying. If this setting is not provided, then effects will be applied regardless.
  • on-fire: If true, effects will only be applied to players who are on fire. If false, effects will only be applied to players who are not on fire. If this setting is not provided, then effects will be applied regardless.
  • frozen: If true, effects will only be applied to players who are frozen. If false, effects will only be applied to players who are not frozen. If this setting is not provided, then effects will be applied regardless.