com.useful.uCarsAPI

Class uCarsAPI

java.lang.Object

com.useful.uCarsAPI.uCarsAPI

public class uCarsAPI
extends java.lang.Object

Some basic API tools that allow plugins to manipulate uCars for their use

Author:

storm345

Constructor Summary

Constructors

Constructor and Description
uCarsAPI()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	adduCarsMeta(org.bukkit.plugin.Plugin plugin, java.util.UUID entityId, java.lang.String statName, com.useful.ucarsCommon.StatValue toAdd) Sets uCarMeta for a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)
java.lang.Boolean	checkIfCar(org.bukkit.entity.Minecart car) Checks if the given vehicle is a car
java.lang.Boolean	checkInCar(org.bukkit.entity.Player player) Checks if the given player is in a car
java.lang.Boolean	checkInCar(java.lang.String player) Checks if the given player is in a car
java.lang.Boolean	clearCarMeta(org.bukkit.plugin.Plugin plugin, java.util.UUID entityId) Clears uCarMeta for a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)
static uCarsAPI	getAPI() Get the running instance of the API implementation
org.bukkit.util.Vector	getTravelVector(org.bukkit.entity.Minecart car, org.bukkit.util.Vector travelVector)
com.useful.ucarsCommon.StatValue	getUcarMeta(org.bukkit.plugin.Plugin plugin, java.lang.String statName, java.util.UUID entityId) Gets uCarMeta for a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)
java.util.Map<java.lang.String,com.useful.ucarsCommon.StatValue>	getuCarMeta(java.util.UUID entityId) Gets all non-permanent uCarMeta for a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)
void	hookPlugin(org.bukkit.plugin.Plugin plugin) Will hook your plugin into uCars.
java.lang.Boolean	isPluginHooked(org.bukkit.plugin.Plugin plugin) Checks if your plugin is hooked, your plugin needs to be hooked to use the API
java.lang.Boolean	registerCarCheck(org.bukkit.plugin.Plugin plugin, CarCheck carCheck) Registers an isACar() check for your plugin, only one check is allowed per hooked plugin.
java.lang.Boolean	registerSpeedMod(org.bukkit.plugin.Plugin plugin, CarSpeedModifier speedMod) Registers an car speed mod check for your plugin, only one speed mod is allowed per hooked plugin.
java.lang.Boolean	removeUcarMeta(org.bukkit.plugin.Plugin plugin, java.lang.String statName, java.util.UUID entityId) Remove a meta value of a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)
java.lang.Boolean	runCarChecks(org.bukkit.entity.Minecart car)
void	unHookPlugin(org.bukkit.plugin.Plugin plugin) Call onDisable() to show the user your plugin being unhooked.
void	unHookPlugins() Will reset all hooked plugins -Don't call unless absolutely needed
java.lang.Boolean	unRegisterCarCheck(org.bukkit.plugin.Plugin plugin) Removes a carCheck registered by a plugin
java.lang.Boolean	unRegisterSpeedMod(org.bukkit.plugin.Plugin plugin) Removes a speed mod registered by a plugin
void	updateUcarMeta(java.util.UUID previousId, java.util.UUID newId) Updates the ID of a car entity

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

uCarsAPI

public uCarsAPI()

Method Detail

getAPI

public static uCarsAPI getAPI()

Get the running instance of the API implementation

Returns:

hookPlugin

public void hookPlugin(org.bukkit.plugin.Plugin plugin)

Will hook your plugin into uCars. This first step must be done before any API calls can be made.

Parameters:

plugin - Your plugin

unHookPlugin

public void unHookPlugin(org.bukkit.plugin.Plugin plugin)

Call onDisable() to show the user your plugin being unhooked. Else it will be unhooked automatically anyway.

Parameters:

plugin - Your plugin

unHookPlugins

public void unHookPlugins()

Will reset all hooked plugins -Don't call unless absolutely needed

isPluginHooked

public java.lang.Boolean isPluginHooked(org.bukkit.plugin.Plugin plugin)

Checks if your plugin is hooked, your plugin needs to be hooked to use the API

Parameters:

plugin - Your plugin

Returns:

True if the plugin is hooked, False if not

registerCarCheck

public java.lang.Boolean registerCarCheck(org.bukkit.plugin.Plugin plugin,
                                 CarCheck carCheck)

Registers an isACar() check for your plugin, only one check is allowed per hooked plugin. Trying to add more than one check will result in overriding the original

Parameters:

plugin - Your plugin

carCheck - The CarCheck to perform

Returns:

True if registered, False if not because plugin isn't hooked

unRegisterCarCheck

public java.lang.Boolean unRegisterCarCheck(org.bukkit.plugin.Plugin plugin)

Removes a carCheck registered by a plugin

Parameters:

plugin - Your plugin

Returns:

True if unregistered, False if not because plugin isn't hooked

runCarChecks

public java.lang.Boolean runCarChecks(org.bukkit.entity.Minecart car)

registerSpeedMod

public java.lang.Boolean registerSpeedMod(org.bukkit.plugin.Plugin plugin,
                                 CarSpeedModifier speedMod)

Registers an car speed mod check for your plugin, only one speed mod is allowed per hooked plugin. Trying to add more than one check will result in overriding the original

Parameters:

plugin - Your plugin

speedMod - The speedMod to add

Returns:

True if registered, False if not because plugin isn't hooked

unRegisterSpeedMod

public java.lang.Boolean unRegisterSpeedMod(org.bukkit.plugin.Plugin plugin)

Removes a speed mod registered by a plugin

Parameters:

plugin - Your plugin

Returns:

True if unregistered, False if not because plugin isn't hooked

getTravelVector

public org.bukkit.util.Vector getTravelVector(org.bukkit.entity.Minecart car,
                                     org.bukkit.util.Vector travelVector)

getuCarMeta

public java.util.Map<java.lang.String,com.useful.ucarsCommon.StatValue> getuCarMeta(java.util.UUID entityId)

Gets all non-permanent uCarMeta for a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)

Parameters:

entityId - Id of the uCar entity (ID can be changed without your notice So don't use this for tracking cars)

Returns:

All the meta set for that car

adduCarsMeta

public java.lang.Boolean adduCarsMeta(org.bukkit.plugin.Plugin plugin,
                             java.util.UUID entityId,
                             java.lang.String statName,
                             com.useful.ucarsCommon.StatValue toAdd)

Sets uCarMeta for a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)

Parameters:

plugin - Your plugin

entityId - Id of the uCar entity (ID can be changed without your notice So don't use this for tracking cars)

toAdd - The ucarMeta to add to the car

statName - The key/Name of the stat eg. 'myPlugin.myStat'

Returns:

True is successful and False if plugin is not hooked or unsuccessful

getUcarMeta

public com.useful.ucarsCommon.StatValue getUcarMeta(org.bukkit.plugin.Plugin plugin,
                                           java.lang.String statName,
                                           java.util.UUID entityId)

Gets uCarMeta for a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)

Parameters:

plugin - Your plugin

entityId - Id of the uCar entity (ID can be changed without your notice So don't use this for tracking cars)

statName - The key/Name of the stat eg. 'myPlugin.myStat'

Returns:

ucarMeta is successful and null if not existing on car or plugin is not hooked or unsuccessful

removeUcarMeta

public java.lang.Boolean removeUcarMeta(org.bukkit.plugin.Plugin plugin,
                               java.lang.String statName,
                               java.util.UUID entityId)

Remove a meta value of a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)

Parameters:

plugin - Your plugin

statName - The name of the stat to remove

entityId - The entityId of the car

Returns:

True if removed, False if plugin not hooked or removal unsuccessful (Not set)

clearCarMeta

public java.lang.Boolean clearCarMeta(org.bukkit.plugin.Plugin plugin,
                             java.util.UUID entityId)

Clears uCarMeta for a car -uCarMeta is removed each time the server restarts so use for temporary buffs such as speed-buffs or upgrades (If you track and save them)

Parameters:

plugin - Your plugin

entityId - Id of the uCar entity (ID can be changed without your notice So don't use this for tracking cars)

Returns:

True is successful and False is plugin is not hooked or unsuccessfull

updateUcarMeta

public void updateUcarMeta(java.util.UUID previousId,
                  java.util.UUID newId)

Updates the ID of a car entity

Parameters:

previousId - The old ID of the entity

newId - The new ID of the entity

checkIfCar

public java.lang.Boolean checkIfCar(org.bukkit.entity.Minecart car)

Checks if the given vehicle is a car

Parameters:

car - The Minecart to check if it's a car

Returns:

True if it's a car

checkInCar

public java.lang.Boolean checkInCar(org.bukkit.entity.Player player)

Checks if the given player is in a car

Parameters:

player - The player to check

Returns:

True if they're in a car

checkInCar

public java.lang.Boolean checkInCar(java.lang.String player)

Checks if the given player is in a car

Parameters:

player - The player to check

Returns:

True if they're in a car