Class Flags

java.lang.Object
cn.lunadeer.dominion.api.dtos.flag.Flags

public class Flags extends Object
  • Field Details

    • ANIMAL_SPAWN

      public static final EnvFlag ANIMAL_SPAWN
    • ANIMAL_BREED

      public static final EnvFlag ANIMAL_BREED
    • ANIMAL_SPAWNER

      public static final EnvFlag ANIMAL_SPAWNER
    • ANIMAL_SPAWN_EGG

      public static final EnvFlag ANIMAL_SPAWN_EGG
    • ANIMAL_MOVE

      public static final EnvFlag ANIMAL_MOVE
    • VILLAGER_SPAWN

      public static final EnvFlag VILLAGER_SPAWN
    • VILLAGER_BREED

      public static final EnvFlag VILLAGER_BREED
    • VILLAGER_SPAWNER

      public static final EnvFlag VILLAGER_SPAWNER
    • VILLAGER_SPAWN_EGG

      public static final EnvFlag VILLAGER_SPAWN_EGG
    • MONSTER_SPAWN

      public static final EnvFlag MONSTER_SPAWN
    • MONSTER_SPAWNER

      public static final EnvFlag MONSTER_SPAWNER
    • MONSTER_SPAWN_EGG

      public static final EnvFlag MONSTER_SPAWN_EGG
    • MONSTER_MOVE

      public static final EnvFlag MONSTER_MOVE
    • MONSTER_DAMAGE

      public static final EnvFlag MONSTER_DAMAGE
    • ENDER_MAN

      @Deprecated public static final EnvFlag ENDER_MAN
      Deprecated.
      Former combined Enderman block movement flag retained for migration.
    • ENDER_MAN_PICKUP_BLOCK

      public static final EnvFlag ENDER_MAN_PICKUP_BLOCK
    • ENDER_MAN_PLACE_BLOCK

      public static final EnvFlag ENDER_MAN_PLACE_BLOCK
    • ENDER_MAN_SPAWN

      public static final EnvFlag ENDER_MAN_SPAWN
    • ENDER_MAN_TELEPORT

      public static final EnvFlag ENDER_MAN_TELEPORT
    • TNT_EXPLODE

      public static final EnvFlag TNT_EXPLODE
    • TNT_DAMAGE_ENTITY

      public static final EnvFlag TNT_DAMAGE_ENTITY
    • WITHER_SPAWN

      public static final EnvFlag WITHER_SPAWN
    • WITHER_EXPLODE

      public static final EnvFlag WITHER_EXPLODE
    • WITHER_BREAK_BLOCK

      public static final EnvFlag WITHER_BREAK_BLOCK
    • CREEPER_EXPLODE

      public static final EnvFlag CREEPER_EXPLODE
    • CREEPER_DAMAGE_ENTITY

      public static final EnvFlag CREEPER_DAMAGE_ENTITY
    • WITHER_SKULL_EXPLODE

      public static final EnvFlag WITHER_SKULL_EXPLODE
    • WITHER_SKULL_DAMAGE_ENTITY

      public static final EnvFlag WITHER_SKULL_DAMAGE_ENTITY
    • ENDER_CRYSTAL_EXPLODE

      public static final EnvFlag ENDER_CRYSTAL_EXPLODE
    • ENDER_CRYSTAL_DAMAGE_ENTITY

      public static final EnvFlag ENDER_CRYSTAL_DAMAGE_ENTITY
    • FIREBALL_EXPLODE

      public static final EnvFlag FIREBALL_EXPLODE
    • FIREBALL_DAMAGE_ENTITY

      public static final EnvFlag FIREBALL_DAMAGE_ENTITY
    • TNT_DAMAGE_ARMOR_STAND

      public static final EnvFlag TNT_DAMAGE_ARMOR_STAND
    • TNT_DAMAGE_HANGING_ENTITY

      public static final EnvFlag TNT_DAMAGE_HANGING_ENTITY
    • CREEPER_DAMAGE_ARMOR_STAND

      public static final EnvFlag CREEPER_DAMAGE_ARMOR_STAND
    • CREEPER_DAMAGE_HANGING_ENTITY

      public static final EnvFlag CREEPER_DAMAGE_HANGING_ENTITY
    • WITHER_SKULL_DAMAGE_ARMOR_STAND

      public static final EnvFlag WITHER_SKULL_DAMAGE_ARMOR_STAND
    • WITHER_SKULL_DAMAGE_HANGING_ENTITY

      public static final EnvFlag WITHER_SKULL_DAMAGE_HANGING_ENTITY
    • ENDER_CRYSTAL_DAMAGE_ARMOR_STAND

      public static final EnvFlag ENDER_CRYSTAL_DAMAGE_ARMOR_STAND
    • ENDER_CRYSTAL_DAMAGE_HANGING_ENTITY

      public static final EnvFlag ENDER_CRYSTAL_DAMAGE_HANGING_ENTITY
    • FIREBALL_DAMAGE_ARMOR_STAND

      public static final EnvFlag FIREBALL_DAMAGE_ARMOR_STAND
    • FIREBALL_DAMAGE_HANGING_ENTITY

      public static final EnvFlag FIREBALL_DAMAGE_HANGING_ENTITY
    • BED_EXPLODE

      public static final EnvFlag BED_EXPLODE
    • ANCHOR_EXPLODE

      public static final EnvFlag ANCHOR_EXPLODE
    • BLOCK_EXPLODE

      @Deprecated public static final EnvFlag BLOCK_EXPLODE
      Deprecated.
      Former combined bed and respawn-anchor explosion flag retained for migration.
    • DRAGON_BREAK_BLOCK

      public static final EnvFlag DRAGON_BREAK_BLOCK
    • FIRE_SPREAD

      public static final EnvFlag FIRE_SPREAD
    • BURN

      @Deprecated public static final EnvFlag BURN
      Deprecated.
      Former combined burn flag from before block/entity burning was split.
    • BURN_BLOCK

      public static final EnvFlag BURN_BLOCK
    • BURN_ENTITY

      @Deprecated public static final EnvFlag BURN_ENTITY
      Deprecated.
      Former combined fire/lava entity damage flag retained for migration.
    • BURN_ENTITY_FIRE

      public static final EnvFlag BURN_ENTITY_FIRE
    • BURN_ENTITY_LAVA

      public static final EnvFlag BURN_ENTITY_LAVA
    • FLOW_IN_WATER

      public static final EnvFlag FLOW_IN_WATER
    • FLOW_IN_LAVA

      public static final EnvFlag FLOW_IN_LAVA
    • FLOW_IN_PROTECTION

      @Deprecated public static final EnvFlag FLOW_IN_PROTECTION
      Deprecated.
      Former combined water/lava flow flag retained for migration.
    • GRAVITY_BLOCK

      public static final EnvFlag GRAVITY_BLOCK
    • ICE_MELT

      public static final EnvFlag ICE_MELT
    • ICE_FORM_NATURAL

      public static final EnvFlag ICE_FORM_NATURAL
    • ICE_FORM_FROST_WALKER

      public static final EnvFlag ICE_FORM_FROST_WALKER
    • ICE_FORM

      @Deprecated public static final EnvFlag ICE_FORM
      Deprecated.
      Former combined natural and Frost Walker ice formation flag retained for migration.
    • SNOW_ACCUMULATION

      public static final EnvFlag SNOW_ACCUMULATION
    • SNOW_MELT

      public static final EnvFlag SNOW_MELT
    • TRAMPLE

      public static final EnvFlag TRAMPLE
    • MOB_TRAMPLE

      public static final EnvFlag MOB_TRAMPLE
    • DECAY

      public static final EnvFlag DECAY
    • HOPPER_OUTSIDE

      public static final EnvFlag HOPPER_OUTSIDE
    • PISTON_OUTSIDE

      public static final EnvFlag PISTON_OUTSIDE
    • TRIG_PRESSURE_PROJ

      public static final EnvFlag TRIG_PRESSURE_PROJ
    • TRIG_PRESSURE_MOB

      public static final EnvFlag TRIG_PRESSURE_MOB
    • TRIG_PRESSURE_DROP

      public static final EnvFlag TRIG_PRESSURE_DROP
    • ITEM_FRAME_PROJ_DAMAGE

      @Deprecated public static final EnvFlag ITEM_FRAME_PROJ_DAMAGE
      Deprecated.
      The former coarse hanging-entity projectile flag. It is retained as a migration source for existing configuration and database columns, but is not registered as an active flag anymore.
    • ARMOR_STAND_MOB_DAMAGE

      public static final EnvFlag ARMOR_STAND_MOB_DAMAGE
    • HANGING_ENTITY_MOB_DAMAGE

      public static final EnvFlag HANGING_ENTITY_MOB_DAMAGE
    • ARMOR_STAND_EXPLOSION_DAMAGE

      @Deprecated public static final EnvFlag ARMOR_STAND_EXPLOSION_DAMAGE
      Deprecated.
      Former source-agnostic explosion damage flag retained for migration.
    • HANGING_ENTITY_EXPLOSION_DAMAGE

      @Deprecated public static final EnvFlag HANGING_ENTITY_EXPLOSION_DAMAGE
      Deprecated.
      Former source-agnostic explosion damage flag retained for migration.
    • MOB_DROP_ITEM

      public static final EnvFlag MOB_DROP_ITEM
    • SHOW_BORDER

      public static final EnvFlag SHOW_BORDER
    • ADMIN

      public static final PriFlag ADMIN
    • RESIZE

      public static final PriFlag RESIZE
    • RENAME

      public static final PriFlag RENAME
    • CREATE_SUB

      public static final PriFlag CREATE_SUB
    • DELETE_SUB

      public static final PriFlag DELETE_SUB
    • RESIZE_SUB

      public static final PriFlag RESIZE_SUB
    • RENAME_SUB

      public static final PriFlag RENAME_SUB
    • MOVE

      public static final PriFlag MOVE
    • TELEPORT

      public static final PriFlag TELEPORT
    • FLY

      public static final PriFlag FLY
    • RIDING

      public static final PriFlag RIDING
    • ENDER_PEARL

      public static final PriFlag ENDER_PEARL
    • RAID

      public static final PriFlag RAID
    • PLACE

      public static final PriFlag PLACE
    • PLACE_FLOWER_POT_CONTENT

      public static final PriFlag PLACE_FLOWER_POT_CONTENT
    • PLACE_LIQUID

      public static final PriFlag PLACE_LIQUID
    • PLACE_ENTITY

      @Deprecated public static final PriFlag PLACE_ENTITY
      Deprecated.
      Former coarse decorative-entity placement flag retained for migration.
    • PLACE_ARMOR_STAND

      public static final PriFlag PLACE_ARMOR_STAND
    • PLACE_HANGING_ENTITY

      public static final PriFlag PLACE_HANGING_ENTITY
    • BREAK_BLOCK

      public static final PriFlag BREAK_BLOCK
    • BREAK_FLOWER_POT_CONTENT

      public static final PriFlag BREAK_FLOWER_POT_CONTENT
    • BREAK_LIQUID

      public static final PriFlag BREAK_LIQUID
    • BREAK_ENTITY

      @Deprecated public static final PriFlag BREAK_ENTITY
      Deprecated.
      Former coarse decorative-entity breaking flag retained for migration.
    • ARMOR_STAND_DIRECT_BREAK

      public static final PriFlag ARMOR_STAND_DIRECT_BREAK
    • ARMOR_STAND_PROJECTILE_BREAK

      public static final PriFlag ARMOR_STAND_PROJECTILE_BREAK
    • HANGING_ENTITY_DIRECT_BREAK

      public static final PriFlag HANGING_ENTITY_DIRECT_BREAK
    • HANGING_ENTITY_PROJECTILE_BREAK

      public static final PriFlag HANGING_ENTITY_PROJECTILE_BREAK
    • ARMOR_STAND_PLAYER_DAMAGE

      @Deprecated public static final PriFlag ARMOR_STAND_PLAYER_DAMAGE
      Deprecated.
      Former combined player damage flag retained for migration.
    • HANGING_ENTITY_PLAYER_DAMAGE

      @Deprecated public static final PriFlag HANGING_ENTITY_PLAYER_DAMAGE
      Deprecated.
      Former combined player damage flag retained for migration.
    • IGNITE

      public static final PriFlag IGNITE
    • PICK_UP

      public static final PriFlag PICK_UP
    • DROP_ITEM

      public static final PriFlag DROP_ITEM
    • DOOR

      public static final PriFlag DOOR
    • TRAPDOOR

      public static final PriFlag TRAPDOOR
    • FENCE_GATE

      public static final PriFlag FENCE_GATE
    • BUTTON

      public static final PriFlag BUTTON
    • LEVER

      public static final PriFlag LEVER
    • PRESSURE

      public static final PriFlag PRESSURE
    • RED_STONE_POWDER

      public static final PriFlag RED_STONE_POWDER
    • REPEATER

      public static final PriFlag REPEATER
    • COMPARER

      public static final PriFlag COMPARER
    • NOTE_BLOCK

      public static final PriFlag NOTE_BLOCK
    • CONTAINER

      @Deprecated public static final PriFlag CONTAINER
      Deprecated.
      The former coarse container flag. It is retained as a migration source for existing configuration and database columns, but is not registered as an active flag anymore.
    • CHEST

      public static final PriFlag CHEST
    • BARREL

      public static final PriFlag BARREL
    • SHULKER_BOX

      public static final PriFlag SHULKER_BOX
    • ARMOR_STAND_INTERACTIVE

      public static final PriFlag ARMOR_STAND_INTERACTIVE
    • ITEM_FRAME_CONTENT

      public static final PriFlag ITEM_FRAME_CONTENT
    • HOPPER

      public static final PriFlag HOPPER
    • DROPPER

      public static final PriFlag DROPPER
    • DISPENSER

      public static final PriFlag DISPENSER
    • FURNACE

      public static final PriFlag FURNACE
    • BLAST_FURNACE

      public static final PriFlag BLAST_FURNACE
    • SMOKER

      public static final PriFlag SMOKER
    • FLOWER_POT

      public static final PriFlag FLOWER_POT
    • COPPER_CHEST

      public static final PriFlag COPPER_CHEST
    • SHELF

      public static final PriFlag SHELF
    • CRAFT

      public static final PriFlag CRAFT
    • CRAFTER

      public static final PriFlag CRAFTER
    • ANVIL

      public static final PriFlag ANVIL
    • ENCHANT

      public static final PriFlag ENCHANT
    • BREW

      public static final PriFlag BREW
    • BEACON

      public static final PriFlag BEACON
    • JUKEBOX

      public static final PriFlag JUKEBOX
    • LECTERN

      public static final PriFlag LECTERN
    • BOOKSHELF

      public static final PriFlag BOOKSHELF
    • DRAGON_EGG

      public static final PriFlag DRAGON_EGG
    • ITEM_FRAME_INTERACTIVE

      public static final PriFlag ITEM_FRAME_INTERACTIVE
    • EDIT_SIGN

      public static final PriFlag EDIT_SIGN
    • BED

      public static final PriFlag BED
    • ANCHOR

      public static final PriFlag ANCHOR
    • VEHICLE_SPAWN

      public static final PriFlag VEHICLE_SPAWN
    • VEHICLE_DESTROY

      public static final PriFlag VEHICLE_DESTROY
    • HARVEST

      public static final PriFlag HARVEST
    • SOWING

      public static final PriFlag SOWING
    • FERTILIZER

      public static final PriFlag FERTILIZER
    • PLANT_TREE

      public static final PriFlag PLANT_TREE
    • FEED

      public static final PriFlag FEED
    • SHEAR

      public static final PriFlag SHEAR
    • LEASH

      public static final PriFlag LEASH
    • DYE

      public static final PriFlag DYE
    • HONEY

      public static final PriFlag HONEY
    • CAKE

      public static final PriFlag CAKE
    • TRADE

      public static final PriFlag TRADE
    • PROJECTILE_CHARGE

      public static final PriFlag PROJECTILE_CHARGE
    • ARROW_LAUNCH

      public static final PriFlag ARROW_LAUNCH
    • ARROW_HIT

      public static final PriFlag ARROW_HIT
    • ARROW_DAMAGE

      public static final PriFlag ARROW_DAMAGE
    • SHOOT

      @Deprecated public static final PriFlag SHOOT
      Deprecated.
      Former combined bow/crossbow and arrow flag retained for migration.
    • TRIDENT_LAUNCH

      public static final PriFlag TRIDENT_LAUNCH
    • TRIDENT_HIT

      public static final PriFlag TRIDENT_HIT
    • TRIDENT

      @Deprecated public static final PriFlag TRIDENT
      Deprecated.
      Former combined trident launch and impact flag retained for migration.
    • FIREBALL_LAUNCH

      public static final PriFlag FIREBALL_LAUNCH
    • FIREBALL_HIT

      public static final PriFlag FIREBALL_HIT
    • FIREBALL

      @Deprecated public static final PriFlag FIREBALL
      Deprecated.
      Former combined fireball launch and impact flag retained for migration.
    • WIND_CHARGE_LAUNCH

      public static final PriFlag WIND_CHARGE_LAUNCH
    • WIND_CHARGE_HIT

      public static final PriFlag WIND_CHARGE_HIT
    • WIND_CHARGE_EXPLODE

      public static final PriFlag WIND_CHARGE_EXPLODE
    • WIND_CHARGE

      @Deprecated public static final PriFlag WIND_CHARGE
      Deprecated.
      Former combined wind charge launch, impact and explosion flag retained for migration.
    • EGG

      public static final PriFlag EGG
    • HOOK

      public static final PriFlag HOOK
    • PVP

      public static final PriFlag PVP
    • MONSTER_KILLING

      public static final PriFlag MONSTER_KILLING
    • ANIMAL_KILLING

      public static final PriFlag ANIMAL_KILLING
    • VILLAGER_KILLING

      public static final PriFlag VILLAGER_KILLING
  • Constructor Details

    • Flags

      public Flags()
  • Method Details

    • getAllFlags

      public static List<Flag> getAllFlags()
      Returns a list of all flags.
      Returns:
      a list of all flags
    • getAllEnvFlags

      public static List<EnvFlag> getAllEnvFlags()
      Returns a list of all environment flags.
      Returns:
      a list of all environment flags
    • getAllPriFlags

      public static List<PriFlag> getAllPriFlags()
      Returns a list of all privilege flags.
      Returns:
      a list of all privilege flags
    • getAllEnvFlagsEnable

      public static List<EnvFlag> getAllEnvFlagsEnable()
      Returns a list of all enabled environment flags.
      Returns:
      a list of all enabled environment flags
    • getAllPriFlagsEnable

      public static List<PriFlag> getAllPriFlagsEnable()
      Returns a list of all enabled privilege flags.
      Returns:
      a list of all enabled privilege flags
    • getAllFlagsEnable

      public static List<Flag> getAllFlagsEnable()
      Returns a list of all enabled flags.
      Returns:
      a list of all enabled flags
    • getFlag

      public static Flag getFlag(String name)
      Returns a flag by its name from all flags.
      Parameters:
      name - the name of the flag
      Returns:
      the flag with the given name, or null if not found
    • getEnvFlag

      public static EnvFlag getEnvFlag(String name)
      Returns an environment flag by its name.
      Parameters:
      name - the name of the environment flag
      Returns:
      the environment flag with the given name, or null if not found
    • getPreFlag

      public static PriFlag getPreFlag(String name)
      Returns a privilege flag by its name.
      Parameters:
      name - the name of the privilege flag
      Returns:
      the privilege flag with the given name, or null if not found
    • registerEnvFlag

      public static boolean registerEnvFlag(org.bukkit.plugin.java.JavaPlugin plugin, EnvFlag flag)
      Registers an environment flag.

      Need to run applyNewCustomFlags() to make the new flag work.

      Parameters:
      plugin - the plugin registering the flag
      flag - the environment flag to register
      Returns:
      true if the flag was successfully registered, false otherwise
    • registerPriFlag

      public static boolean registerPriFlag(org.bukkit.plugin.java.JavaPlugin plugin, PriFlag flag)
      Registers a privilege flag.

      Need to run applyNewCustomFlags() to make the new flag work.

      Parameters:
      plugin - the plugin registering the flag
      flag - the privilege flag to register
      Returns:
      true if the flag was successfully registered, false otherwise
    • applyChanges

      public static CompletableFuture<Void> applyChanges()
      Applies new custom flags by reloading the configuration and cache. This should be called after registering new flags to ensure they take effect.
    • applyNewCustomFlags

      @Deprecated public static void applyNewCustomFlags() throws Exception
      Deprecated.
      use applyChanges() and observe the returned future
      Queues registered flag and flag-group changes for application.
      Throws:
      Exception
    • getRevision

      public static long getRevision()
    • getLegacySource

      @Internal public static Flag getLegacySource(Flag flag)
      Returns the legacy flag whose value should seed a newly split flag.
    • getLegacySources

      @Internal public static List<Flag> getLegacySources(Flag flag)
      Returns all legacy flags whose values should seed a newly split flag. Most split flags have one source. The historical burn flag is included as a fallback for installations that never had the intermediate burn_entity column.
    • preserveAllowedSpawnEggValue

      @Internal public static boolean preserveAllowedSpawnEggValue(Flag flag)