Giter Club home page Giter Club logo

kingdomcraft's Introduction

KingdomCraft

The #1 minecraft kingdom plugin for easily managing your kingdoms!

Download KingdomCraft 5.0 (beta) here: https://igufguf.com/project/1

Before using the api be sure to add "KingdomCraft" to your dependencies!

Retrieving the KingdomCraft plugin:
KingdomCraft kdc = (KingdomCraft) Bukkit.getPluginManager().getPlugin("KingdomCraft");
Retrieving the KingdomCraftApi Object:
KingdomCraftApi api = kdc.getApi();
Using the api to retrieve data from an online user:
KingdomUser user = api.getUserHandler().getUser(Player);
KingdomUser user = api.getUserHandler().getUser("iGufGuf");
Using the api to retrieve data from an offline user:
KingdomUser user = api.getUserHandler().getOfflineUser(UUID);

After modifying offline userdata make sure to save the data!

Saving a user object:
api.getUserHandler().save(user);
Using the api to retrieve data from a kingdom:
Kingdom kd = api.getKingdomHandler().getKingdom("kingdomname");
Saving the kingdom data:
api.getKingdomHandler().save(kd);
Manipulating custom data of a kingdom

KingdomUser, KingdomObject & KingdomRank all extends on KingdomData

Kingdom kd = api.getKingdomHandler().getKingdom("kingdomname");
Storable kingdomdata = kd.getKingdomData();

kingdomdata.getData("key");
kingdomdata.setData("key", value);

KingdomUser has also the possibility to use hasMemory, getMemory & setMemory, this data will not be written to the data file

Getting the relation of a kingdom:
KingdomRelation rel = api.getRelationHandler().getRelation(kingdom, targetkingdom);
Retrieving a kingdomrank from a kingdom
KingdomRank rank = kd.getRank("rankname");
Changing the rank/kingdom of a user:
api.getUserHandler().setRank(user, rank);
api.getUserHandler().setKingdom(user, kingdom);
Kingdom flags

KingdomFlags are custom options you can change for every kingdom, ex.: friendlyfire, invite-only

The KingdomFlags can have different values like integers, booleans, strings... etc. For this, it makes use of java generics for easier programming. The KingdomFlag class is extendable for more variation in possible value types.

Register new flags

public static final KingdomFlag<Boolean> INVITE_ONLY = new KingdomFlag<>("invite-only", Boolean.class);

FlagHandler flagHandler = api.getFlagHandler();
flagHandler.register(INVITE_ONLY);

It is recommend to use the flags by its direct reference like KingdomFlag.INVITE_ONLY. If this is not possible, you can use following method.

KingdomFlag flag = flagHandler.getFlag("friendlyfire");

Retrieve all flags for a kingdom

List<KingdomFlag> flags = flagHandler.getFlags(kd);

Changing or retrieving flag values for a kingdom

flagHandler.setFlag(kd, flag, value);
flagHandler.getFlag(kd, flag);

KingdomCraft Custom events

KingdomChatEvent

Called when a player sends a message that is manipulated with kingdomcraft

Methods: getPlayer, getFormat, setFormat(String), getMessage, setMessage(String), getReceivers, isCancelled, setCancelled(boolean)

KingdomJoinEvent

Called when a player joins a kingdom

Methods: getUser

user.getKingdom() & user.getRank() will return the new kingdom and rank.

KingdomLeaveEvent

Called when a player leaves a kingdom

Methods: getUser, getOldRank, getOldKingdom

KingdomPlayerAttackEvent

Called when two players damage eachother

Methods: getDamager, getTarget

Also contains the same methods from EntityDamageEvent

Other events

  • KingdomPreLoadEvent
  • KingdomLoadEvent
  • KingdomSaveEvent
  • KingdomUserLoadEvent
  • KingdomUserSaveEvent

kingdomcraft's People

Contributors

jorisguffens avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.