API Manager - Nutty101/NPC-Police GitHub Wiki
API is class that allows custom communication with the NPCPolice plugin from your own plugins. This allows further expansion of the plugin without the need to modify the base plugin itself. It also ensures that your customization points do not break, based on changes that I do to the plugin internally down the road.
- Author: Sir_Nutty (Bruce Johnson)
- Since: 2.1.8
This method provides access to the players information, as well as custom methods to change information on that player.
-
Parameters:
player
— OfflinePlayer class from bukkit representing the player you wantto gain information on.
-
Returns:
PlayerManager
returns an object that allows forinteraction with the players record.
-
Since: 2.1.1
This method provides access to a list of jail names for a specific world.
-
Parameters:
world
— Pass a world object from bukkit representing the world you wouldlike to get string list of all jail names
-
Returns:
List
returns a listing of all jail shortnamesin the referenced world
-
Since: 2.1.1
This method provides access to the configuration settings for the named jail.
-
Parameters:
jailName
— Pass a string object with the jails short name like to get aconfiguration object for
-
Returns:
JailManager
returns an object with methods andconfiguration information
-
Since: 2.1.1
This method provides access to the configuration settings for any jail in the location specified.
-
Parameters:
jailLocation
— Pass a bukkit Location object to get any jail at the specificpoint
-
Returns:
JailManager
returns an object with methods andconfiguration information
-
Since: 2.1.1
This method provides access to the configuration settings for any jail in the location specified.
-
Parameters:
disable
— Passing a true will stop the plugin from processing damage basedon bukkit events
-
Since: 2.1.1
This method allows passing customized damage from another plugin to the NPCPolice plugin.
Make sure you stop all damage processing via disableMonitoringDamage(boolean), otherwise you can cause double events.
-
Parameters:
event
— Pass a new EntityDamageByEntityEvent, or a modified event withyour damage modifier.
-
Since: 2.1.1