FalchusLib

A library designed to simplify & speed up software development.

Features

• Reusable utilities for common tasks
• Abstraction layers for easier integration
• Productivity helpers to speed up development
• Cross-platform and maintainable design

Installation

<repository>
  <id>falchus.com</id>
  <url>https://repo.falchus.com/releases</url>
</repository>

<dependency>
  <groupId>com.falchus</groupId>
  <artifactId>lib-java</artifactId>
  <version>[1.0.0,)</version>
</dependency>

Usage

Tasks

com.falchus.lib.task.Task

static Task runTask(Runnable runnable);

static Task runTaskTimer(Runnable runnable, long period, TimeUnit unit);
void runTaskTimer(long period, TimeUnit unit);

static Task runTaskTimer(Runnable runnable, long delay, long period, TimeUnit unit);
void runTaskTimer(long delay, long period, TimeUnit unit);

static Task runTaskLater(Runnable runnable, long delay, TimeUnit unit);
void runTaskLater(long delay, TimeUnit unit);

static void end(int id);
void end();

int getId();

@Override
void onRun(int tick) {}

@Override
void onEnd() {}

• com.falchus.lib.task.impl.CountdownTask

  CountdownTask(int remaining);
  
  @Override
  void onCountdown(int remaining) {}

Builders

com.falchus.lib.utils.builder.ClassInstanceBuilder

ClassInstanceBuilder(Class clazz);

ClassInstanceBuilder(String name);
ClassInstanceBuilder(String... names);

ClassInstanceBuilder withParams(Map<Class, Object>... params);

Object build();

com.falchus.lib.utils.builder.HTTPServerBuilder

HTTPServerBuilder port(int port);

HTTPServerBuilder route(String path, BiConsumer<HttpExchange, Map<String, String>> handler);
HTTPServerBuilder defaultHandler(BiConsumer<HttpExchange, Map<String, String>> handler);

HTTPServer build(String ip);

Storage

com.falchus.lib.storage.Storage

<T> void save(T value);

<T> T load();

void delete();

• com.falchus.lib.storage.impl.json.JsonStorage
  • com.falchus.lib.storage.impl.json.JsonArrayStorage
  • com.falchus.lib.storage.impl.json.JsonObjectStorage

com.falchus.lib.storage.serializer.Serializer

String serialize(T value);
T deserialize(String content);

• com.falchus.lib.storage.serializer.json.JsonSerializer
  • com.falchus.lib.storage.serializer.json.JsonArraySerializer
  • com.falchus.lib.storage.serializer.json.JsonObjectSerializer

HTTP

com.falchus.lib.utils.http.HTTPRequest

static String get(String url);

com.falchus.lib.utils.http.HTTPServer

void start();
void stop(int delay);

static void sendText(HttpExchange exchange, String text, int statusCode);
static void sendJson(HttpExchange exchange, String json, int statusCode);

Events

com.falchus.lib.events.Cancellable

boolean isCancelled();
void setCancelled(boolean cancelled);

com.falchus.lib.events.Event

Event(boolean async);

boolean callEvent();

com.falchus.lib.events.EventExecutor

void execute(Event event);

com.falchus.lib.events.EventHandler

EventPriority priority();

boolean ignoreCancelled();

com.falchus.lib.manager.EventManager

static void registerListener(Listener listener);
static void unregisterListener(Listener listener);

static void callEvent(Event event);

com.falchus.lib.events.listener.Listener com.falchus.lib.events.listener.RegisteredListener

void execute(Event event);

Reflection & Wrapping

com.falchus.lib.utils.reflection.ReflectionUtils

static Class getClass(String name);
static Class getFirstClass(String... names);

static Field getField(Class clazz, String name);
static Field getField(Object instance, String name);
static Field getFirstField(Class clazz, String... names);
static Field getFirstField(Object instance, String... names);
static Field getFirstField(Set<Class> classes, String... names);

static void setField(Object instance, Field field, Object value);
static void setField(Object instance, String name, Object value);
static void setField(Field field, Object value);
static void setField(Class clazz, String name, Object value);
static void setFirstField(Object instance, Object value, String... names);
static void setFirstField(Class clazz, Object value, String... names);
static void setFirstField(Object instance, Set<Class> classes, Object value, String... names);

static Method getMethod(Class clazz, String name, Class... params);
static Method getMethod(Object instance, String name, Class... params);
static Method getFirstMethod(Class clazz, List<Class> params, String... names);
static Method getFirstMethod(Object instance, List<Class> params, String... names);
static Method getFirstMethod(Set<Class> classes, List<Class> params, String... names);

static Constructor getConstructor(Class clazz, Class... params);
static Constructor getConstructor(Object instance, Class... params);
static Constructor getFirstConstructor(Class clazz, Set<List<Class>> params);
static Constructor getFirstConstructor(Object instance, Set<List<Class>> params);
static Constructor getFirstConstructor(Set<Class> classes, Set<List<Class>> params);

com.falchus.lib.utils.wrapper.Wrapper

Wrapper(T handle);

Field getField(String name);
Field getFirstField(String... names);

void setField(Field field, Object value);
void setFirstField(Object value, String... names);

Method getMethod(String name, Class... params);
Method getFirstMethod(List<Class> params, String... names);

Constructor getConstructor(Class... params);
Constructor getFirstConstructor(Set<List<Class>> params);

<U extends Wrapper<?>> U as(Class<U> clazz, Class... params);

• com.falchus.lib.utils.wrapper.impl.ClassWrapper

  ClassWrapper(T handle, Set<Class> classes);
  
  Set<Class> getClasses();

  • com.falchus.lib.utils.wrapper.impl.FirstClassWrapper

    FirstClassWrapper(T handle, Set<String> names);

Minecraft

Use <scope>provided</scope> and install via /plugins folder!

Download: https://www.spigotmc.org/resources/falchuslib.132261

plugin.yml

name: Example
version: 1.0.0
main: com.example.Example
author: Example

depend: [FalchusLib]

velocity-plugin.json

{
  "id": "example",
  "name": "Example",
  "version": "1.0.0",
  "main": "com.example.Example",
  "authors": ["Example"],
  "dependencies": [{"id": "falchuslib", "optional": false}]
}

Usage

Utils

com.falchus.lib.minecraft.spigot.utils.EntityUtils

static Entity getBukkitEntity(Object entity);

static void setYawPitch(Object entity, float yaw, float pitch);

com.falchus.lib.minecraft.spigot.utils.ItemUtils

static ItemStack setUUID(ItemStack item, UUID uuid);
static UUID getUUID(ItemStack item);

static ItemStack clearNBT(ItemStack item);

static ItemStack[] itemStackArrayFromBase64(String base64);
static String itemStackArrayToBase64(ItemStack[] items);

com.falchus.lib.minecraft.spigot.utils.PlayerUtils

static void sendPacket(Player player, Object packet);

static void sendTitle(Player player, String title, String subtitle);

static void playSound(Player player, Location location, Sound sound, float volume, float pitch);

static void freeze(Player player);
static void unfreeze(Player player);

static String getLuckPermsRankPrefix(Player player);

static void vanish(Player player);
static void unvanish(Player player);

static Object getEntityPlayer(Player player);

static GameProfile getProfile(Object entityPlayer);

static int getPing(Player player);

static void setSkin(Player player, UUID uuid);
static void resetSkin(Player player);

static void setName(Player player, String name);
static void resetName(Player player);

static void refresh(Player player);

static void addEntityPlayer(Player player, Object entityPlayer);
static void removeEntityPlayer(Player player, Object entityPlayer);
static void spawnEntityPlayer(Player player, Object entityPlayer);

static void connectToServer(Player player, String server);

com.falchus.lib.minecraft.spigot.utils.SchedulerUtils

static void runTask(Runnable runnable);

static void runTaskAsync(Runnable runnable);

static void runTaskForEntity(Entity entity, Runnable runnable);

static void runTaskLater(Runnable runnable, long delayTicks);

com.falchus.lib.minecraft.spigot.utils.ServerUtils

static Object getMcServer();
static Object getBukkitServer();

static Version getVersion();
static String getVersionString();
static int getMajorVersion();
static int getMinorVersion();

static double[] getRecentTps();

com.falchus.lib.minecraft.spigot.utils.WorldUtils

static void setGameRule(World world, com.falchus.lib.minecraft.spigot.enums.GameRule gameRule, String value);

static Object[] getWorldBiomes(World world);
static Object getNmsBiome(Biome biome);
static int getBiomeId(Biome biome);

static Object getWorldServer(World world);

static Biome getBiome(com.falchus.lib.minecraft.spigot.enums.Biome biome);

static Material getMaterial(com.falchus.lib.minecraft.spigot.enums.Material material);

Commands

com.falchus.lib.minecraft.command.BaseCommand

String getPermission();
String getNoPermissionMessage();

String getUsageMessage();

void executeCommand(Object sender, String[] args);

List<String> tabComplete(Object sender, String[] args);

boolean hasPermission(Object sender);

void sendMessage(Object s, String message);

• com.falchus.lib.minecraft.command.impl.SpigotCommandAdapter
• com.falchus.lib.minecraft.command.impl.VelocityCommandAdapter

Events

com.falchus.lib.minecraft.spigot.events.LobbyCancelEvent

boolean isCancelled();

void setCancelled(boolean cancelled);

Event getEvent();

com.falchus.lib.minecraft.spigot.events.player.PlayerClientJoinEvent

Player getPlayer();

Client getClient();

com.falchus.lib.minecraft.spigot.events.player.PlayerPacketEvent

boolean isAsynchronous();

boolean isCancelled();

void setCancelled(boolean cancelled);

Player getPlayer();

PacketWrapper getPacket();

• com.falchus.lib.minecraft.spigot.events.player.PlayerPacketInEvent
• com.falchus.lib.minecraft.spigot.events.player.PlayerPacketOutEvent

Player Elements

com.falchus.lib.minecraft.spigot.player.elements.PlayerElement

void update();
static <T extends PlayerElement> void updateAll(Class<T> clazz);

void sendUpdating(long intervalTicks, Runnable runnable);

void remove();

static <T extends PlayerElement> T get(Class<T> clazz, Player player);

• com.falchus.lib.minecraft.spigot.player.elements.impl.Actionbar

  void send(Supplier<String> message);
  void sendUpdating(long intervalTicks, Supplier<String> message);

• com.falchus.lib.minecraft.spigot.player.elements.impl.Bossbar

  void send(Supplier<String> message, Supplier<Double> progress);
  void sendUpdating(long intervalTicks, Supplier<String> message, Supplier<Double> progress);
  
  void setProgress(double progress);

• com.falchus.lib.minecraft.spigot.player.elements.impl.Chat

  void send(Supplier<String> prefix);
  void sendUpdating(long intervalTicks, Supplier<String> prefix);

• com.falchus.lib.minecraft.spigot.player.elements.impl.Nametag

  void send(Supplier<String> prefix, Supplier<String> suffix);
  void sendUpdating(long intervalTicks, Supplier<String> prefix, Supplier<String> suffix);

• com.falchus.lib.minecraft.spigot.player.elements.impl.Scoreboard

  void send(Supplier<List<String>> lines);
  void sendUpdating(long intervalTicks, Supplier<String> title, Supplier<String> titleColor, Supplier<String> titleSecondColor, Supplier<List<String>> lines);
  
  void setTitle(String title, String titleColor, String titleSecondColor);

• com.falchus.lib.minecraft.spigot.player.elements.impl.Tablist

  void send(Supplier<List<String>> header, Supplier<List<String>> footer, Supplier<String> name);
  void sendUpdating(long intervalTicks, Supplier<List<String>> header, Supplier<List<String>> footer, Supplier<String> name);

Packets

com.falchus.lib.minecraft.spigot.packets.wrapper.PacketWrapper

<T extends PacketWrapper> T as(Class<T> clazz);

Builders

com.falchus.lib.minecraft.spigot.utils.builder.EntityPlayerBuilder

EntityPlayerBuilder setName(String name);

EntityPlayerBuilder setUUID(UUID uuid);

EntityPlayerBuilder setSkin(String skinValue, String skinSignature);

EntityPlayerBuilder setInvisible(boolean invisible);

EntityPlayerBuilder setLocation(Location location);

EntityPlayerBuilder withInteractListener(Consumer<Player> onPlayerInteract);

EntityPlayerBuilder lookAtPlayer(boolean lookAtPlayer);

Object build();

com.falchus.lib.minecraft.spigot.utils.builder.InventoryBuilder

InventoryBuilder(String title, Integer size);

InventoryBuilder dynamicSize(boolean dynamicSize);

InventoryBuilder setItem(int slot, ItemStack item);
InventoryBuilder setItem(int slot, ItemStack item, Consumer<Player> onClick);
InventoryBuilder setItem(int slot, ItemStack item, TriConsumer<Player, ItemStack, InventoryClickEvent> onClick);

InventoryBuilder setOpenAnimation(InventoryOpenAnimation openAnimation);

InventoryBuilder addItem(ItemStack item);
InventoryBuilder addItem(ItemStack item, Consumer<Player> onClick);
InventoryBuilder addItem(ItemStack item, TriConsumer<Player, ItemStack, InventoryClickEvent> onClick);

InventoryBuilder withClickListener(TriConsumer<Player, ItemStack, InventoryClickEvent> onClick);

InventoryBuilder fill(ItemStack filler);
InventoryBuilder fill();

void open(Player player);
void openPage(Player player, int page);

Inventory build();
List<Inventory> buildPages();

com.falchus.lib.minecraft.spigot.utils.builder.ItemBuilder

ItemBuilder(Material material, int amount);
ItemBuilder(Material material);

ItemBuilder(com.falchus.lib.minecraft.spigot.enums.Material material, int amount);
ItemBuilder(com.falchus.lib.minecraft.spigot.enums.Material material);

ItemBuilder(ItemStack item);

ItemBuilder setName(String name);

ItemBuilder setLore(List<String> lore);

ItemBuilder addEnchantment(Enchantment enchantment, int level);

ItemBuilder addItemFlag(ItemFlag itemFlag);

ItemBuilder setDurability(short durability);

ItemBuilder setSkullOwner(String owner);
ItemBuilder setSkullTexture(String texture);

ItemBuilder setUUID(UUID uuid);

ItemBuilder withInteractListener(Consumer<Player> onPlayerInteract);
ItemBuilder withInventoryClickListener(TriConsumer<Player, ItemStack, InventoryClickEvent> onInventoryClick);

ItemStack build();