noppes.npcs.scripted.interfaces.entity

Interface IPlayer<T extends net.minecraft.entity.player.EntityPlayerMP>

All Superinterfaces:

IEntity<T>, IEntityLivingBase<T>

All Known Subinterfaces:

IDBCPlayer

public interface IPlayer<T extends net.minecraft.entity.player.EntityPlayerMP>
extends IEntityLivingBase<T>

Method Summary

Modifier and Type	Method and Description
void	addFactionPoints(int faction, int points)
boolean	blocking()
boolean	canHarvestBlock(IBlock block)
void	clearInventory()
void	clearItemInUse()
void	closeGui()
void	closeOverlay(int id)
void	continueSounds()
void	disableMouseInput(long time, int... buttonIds)
IEntity	dropOneItem(boolean dropStack)
void	finishQuest(int id)
void	finishQuest(IQuest quest) Add the quest from finished quest list
IQuest[]	getActiveQuests()
ICustomGui	getCustomGui()
IPlayerData	getData()
noppes.npcs.scripted.entity.ScriptDBCPlayer<T>	getDBCPlayer()
java.lang.String	getDisplayName()
int	getExpLevel()
int	getFactionPoints(int faction)
IQuest[]	getFinishedQuests()
int	getHunger()
IItemStack[]	getInventory()
int	getMode()
java.lang.String	getName()
IContainer	getOpenContainer()
IOverlayHandler	getOverlays()
noppes.npcs.scripted.ScriptPixelmonPlayerData	getPixelmonData() Requires pixelmon to be installed
float	getSaturation()
ITimers	getTimers()
int	getType()
boolean	giveItem(IItemStack item, int amount)
boolean	giveItem(java.lang.String id, int damage, int amount)
boolean	hasAchievement(java.lang.String achievement)
boolean	hasActiveQuest(int id)
boolean	hasActiveQuest(IQuest quest)
boolean	hasBukkitPermission(java.lang.String permission)
boolean	hasFinishedQuest(int id)
boolean	hasFinishedQuest(IQuest quest)
boolean	hasReadDialog(IDialog dialog)
boolean	hasReadDialog(int id)
boolean	interactWith(IEntity entity)
int	inventoryItemCount(IItemStack item, boolean ignoreNBT, boolean ignoreDamage)
boolean	isScriptingDev()
void	kick(java.lang.String reason)
void	mountEntity(net.minecraft.entity.Entity ridingEntity)
void	pauseSounds()
void	playSound(int id, ISound sound)
void	playSound(java.lang.String name, float volume, float pitch)
void	readDialog(IDialog dialog)
void	readDialog(int id)
int	removeAllItems(IItemStack item, boolean ignoreNBT, boolean ignoreDamage)
boolean	removeItem(IItemStack item, int amount, boolean ignoreNBT, boolean ignoreDamage)
boolean	removeItem(java.lang.String id, int damage, int amount)
void	removeQuest(int id)
void	removeQuest(IQuest quest) Removes the quest from active and finished quest list
void	resetSpawnpoint()
void	sendMessage(java.lang.String message)
void	setExpLevel(int level)
void	setFactionPoints(int faction, int points)
void	setHunger(int hunger)
void	setMode(int type)
void	setPosition(double x, double y, double z)
void	setPosition(double x, double y, double z, int dimensionId)
void	setRotation(float rotationYaw, float rotationPitch)
void	setSaturation(float saturation)
void	setSpawnpoint(int x, int y, int z) Same as the /spawnpoint command
void	showCustomGui(ICustomGui gui)
void	showCustomOverlay(ICustomOverlay overlay)
void	showDialog(IDialog dialog)
void	showDialog(int id)
void	startQuest(int id)
void	startQuest(IQuest quest) Add the quest from active quest list
void	stopQuest(int id)
void	stopQuest(IQuest quest) Removes the quest from active quest list
void	stopSound(int id)
void	stopSounds()
void	stopUsingItem()
boolean	typeOf(int type)
void	unreadDialog(IDialog dialog)
void	unreadDialog(int id)
void	updatePlayerInventory()

Methods inherited from interface noppes.npcs.scripted.interfaces.entity.IEntityLivingBase

addPotionEffect, canSeeEntity, clearPotionEffects, getArmor, getAttackTarget, getHealth, getHeldItem, getLookingAtBlock, getLookingAtEntities, getLookingAtEntities, getLookingAtPos, getLookVector, getMaxHealth, getMCEntity, getPotionEffect, hurt, hurt, hurt, isAttacking, setArmor, setAttackTarget, setHealth, setHeldItem, swingHand

Methods inherited from interface noppes.npcs.scripted.interfaces.entity.IEntity

clearStoredData, clearTempData, despawn, dropItem, extinguish, getAge, getAllNbt, getBlockX, getBlockY, getBlockZ, getDimension, getEntityId, getHeight, getMotionX, getMotionY, getMotionZ, getMount, getNbt, getPitch, getPos, getRider, getRotation, getStoredData, getSurroundingEntities, getSurroundingEntities, getTempData, getTypeName, getUniqueID, getWidth, getWorld, getX, getY, getYOffset, getZ, hasCollided, hasStoredData, hasTempData, inFire, inLava, inWater, isAirborne, isAlive, isBurning, isSneaking, isSprinting, knockback, knockback, removeStoredData, removeTempData, setBurning, setImmune, setInvisible, setMotion, setMotionX, setMotionY, setMotionZ, setMount, setNbt, setPitch, setPos, setRider, setRotation, setSneaking, setSprinting, setStoredData, setTempData, setX, setY, setZ, spawnParticle, storeAsClone

Method Detail

getDisplayName

java.lang.String getDisplayName()

Returns:

Returns the displayed name of the player

getName

java.lang.String getName()

Returns:

Returns the players name

kick

void kick(java.lang.String reason)

setPosition

void setPosition(double x,
                 double y,
                 double z)

Specified by:

setPosition in interface IEntity<T extends net.minecraft.entity.player.EntityPlayerMP>

Parameters:

x - The x position

y - The y position

z - The z position

setPosition

void setPosition(double x,
                 double y,
                 double z,
                 int dimensionId)

getHunger

int getHunger()

setHunger

void setHunger(int hunger)

getSaturation

float getSaturation()

setSaturation

void setSaturation(float saturation)

showDialog

void showDialog(IDialog dialog)

hasReadDialog

boolean hasReadDialog(IDialog dialog)

readDialog

void readDialog(IDialog dialog)

unreadDialog

void unreadDialog(IDialog dialog)

showDialog

void showDialog(int id)

hasReadDialog

boolean hasReadDialog(int id)

readDialog

void readDialog(int id)

unreadDialog

void unreadDialog(int id)

hasFinishedQuest

boolean hasFinishedQuest(IQuest quest)

hasActiveQuest

boolean hasActiveQuest(IQuest quest)

startQuest

void startQuest(IQuest quest)

Add the quest from active quest list

Parameters:

quest - The quest

finishQuest

void finishQuest(IQuest quest)

Add the quest from finished quest list

Parameters:

quest - The quest

stopQuest

void stopQuest(IQuest quest)

Removes the quest from active quest list

Parameters:

quest - The quest

removeQuest

void removeQuest(IQuest quest)

Removes the quest from active and finished quest list

Parameters:

quest - The quest

hasFinishedQuest

boolean hasFinishedQuest(int id)

hasActiveQuest

boolean hasActiveQuest(int id)

startQuest

void startQuest(int id)

Parameters:

id - The quest ID

finishQuest

void finishQuest(int id)

Parameters:

id - The quest ID

stopQuest

void stopQuest(int id)

Parameters:

id - The quest ID

removeQuest

void removeQuest(int id)

Parameters:

id - The quest ID

getFinishedQuests

IQuest[] getFinishedQuests()

getType

int getType()

Specified by:

getType in interface IEntity<T extends net.minecraft.entity.player.EntityPlayerMP>

Specified by:

getType in interface IEntityLivingBase<T extends net.minecraft.entity.player.EntityPlayerMP>

Returns:

Returns the EntityType of this entity

See Also:

EntityType

typeOf

boolean typeOf(int type)

Specified by:

typeOf in interface IEntity<T extends net.minecraft.entity.player.EntityPlayerMP>

Specified by:

typeOf in interface IEntityLivingBase<T extends net.minecraft.entity.player.EntityPlayerMP>

Parameters:

type - @EntityType to check

Returns:

Returns whether the entity is type of the given @EntityType

addFactionPoints

void addFactionPoints(int faction,
                      int points)

Parameters:

faction - The faction id

points - The points to increase. Use negative values to decrease

setFactionPoints

void setFactionPoints(int faction,
                      int points)

Parameters:

faction - The faction id

points - The new point value for this faction

getFactionPoints

int getFactionPoints(int faction)

Parameters:

faction - The faction id

Returns:

points

sendMessage

void sendMessage(java.lang.String message)

Parameters:

message - The message you want to send. Compatible with formatting codes, which can be found on the attached link.

See Also:

Minecraft formatting codes

getMode

int getMode()

Returns:

Return gamemode. 0: Survival, 1: Creative, 2: Adventure

setMode

void setMode(int type)

Parameters:

type - The gamemode type. 0:SURVIVAL, 1:CREATIVE, 2:ADVENTURE

getInventory

IItemStack[] getInventory()

Returns:

Returns a IItemStack array size 36

Since:

1.7.10d

inventoryItemCount

int inventoryItemCount(IItemStack item,
                       boolean ignoreNBT,
                       boolean ignoreDamage)

Parameters:

item - The item to be checked

ignoreNBT - Whether the item's NBT tags will be checked to be equal

ignoreDamage - Whether the item's damage will be checked to be equal

Returns:

How many of this item the player has

removeItem

boolean removeItem(java.lang.String id,
                   int damage,
                   int amount)

Parameters:

id - The items name

damage - The damage value

amount - How many will be removed

Returns:

True if the items were removed succesfully. Returns false incase a bigger amount than what the player has was given or item doesnt exist

Since:

1.7.10c

removeItem

boolean removeItem(IItemStack item,
                   int amount,
                   boolean ignoreNBT,
                   boolean ignoreDamage)

Parameters:

item - The Item type to be removed

amount - How many will be removed

ignoreNBT - Whether the item's NBT tags will be checked to be equal

ignoreDamage - Whether the item's damage will be checked to be equal

Returns:

True if the items were removed succesfully. Returns false incase a bigger amount than what the player has was given

removeAllItems

int removeAllItems(IItemStack item,
                   boolean ignoreNBT,
                   boolean ignoreDamage)

Parameters:

item - The item to be removed from the players inventory

ignoreNBT - Whether the item's NBT tags will be checked to be equal

ignoreDamage - Whether the item's damage will be checked to be equal

Returns:

The amount of item stacks that were removed

giveItem

boolean giveItem(IItemStack item,
                 int amount)

Parameters:

item - Item to be added

amount - The amount of the item to be added

Returns:

Returns whether or not it gave the item succesfully

Since:

1.7.10c

giveItem

boolean giveItem(java.lang.String id,
                 int damage,
                 int amount)

Parameters:

id - The items name

damage - The damage value

amount - The amount of the item to be added

Returns:

Returns whether or not it gave the item succesfully

Since:

1.7.10c

setSpawnpoint

void setSpawnpoint(int x,
                   int y,
                   int z)

Same as the /spawnpoint command

Parameters:

x - The x position

y - The y position

z - The z position

resetSpawnpoint

void resetSpawnpoint()

setRotation

void setRotation(float rotationYaw,
                 float rotationPitch)

disableMouseInput

void disableMouseInput(long time,
                       int... buttonIds)

stopUsingItem

void stopUsingItem()

clearItemInUse

void clearItemInUse()

clearInventory

void clearInventory()

playSound

void playSound(java.lang.String name,
               float volume,
               float pitch)

playSound

void playSound(int id,
               ISound sound)

stopSound

void stopSound(int id)

pauseSounds

void pauseSounds()

continueSounds

void continueSounds()

stopSounds

void stopSounds()

mountEntity

void mountEntity(net.minecraft.entity.Entity ridingEntity)

dropOneItem

IEntity dropOneItem(boolean dropStack)

canHarvestBlock

boolean canHarvestBlock(IBlock block)

interactWith

boolean interactWith(IEntity entity)

hasAchievement

boolean hasAchievement(java.lang.String achievement)

Parameters:

achievement - The achievement id. For a complete list see http://minecraft.gamepedia.com/Achievements

Returns:

Returns whether or not the player has this achievement

hasBukkitPermission

boolean hasBukkitPermission(java.lang.String permission)

Parameters:

permission - Bukkit/Cauldron permission

Returns:

Returns whether or not the player has the permission

getExpLevel

int getExpLevel()

Returns:

Returns the exp level

Since:

1.7.10c

setExpLevel

void setExpLevel(int level)

Parameters:

level - The new exp level you want to set

Since:

1.7.10c

getPixelmonData

noppes.npcs.scripted.ScriptPixelmonPlayerData getPixelmonData()

Requires pixelmon to be installed

Since:

1.7.10d

getTimers

ITimers getTimers()

updatePlayerInventory

void updatePlayerInventory()

getDBCPlayer

noppes.npcs.scripted.entity.ScriptDBCPlayer<T> getDBCPlayer()

blocking

boolean blocking()

getData

IPlayerData getData()

isScriptingDev

boolean isScriptingDev()

getActiveQuests

IQuest[] getActiveQuests()

getOpenContainer

IContainer getOpenContainer()

showCustomGui

void showCustomGui(ICustomGui gui)

getCustomGui

ICustomGui getCustomGui()

closeGui

void closeGui()

showCustomOverlay

void showCustomOverlay(ICustomOverlay overlay)

closeOverlay

void closeOverlay(int id)

getOverlays

IOverlayHandler getOverlays()