noppes.npcs.api

Class AbstractNpcAPI

java.lang.Object

noppes.npcs.api.AbstractNpcAPI

public abstract class AbstractNpcAPI
extends java.lang.Object

This object stores functions available to all scripting handlers through the "API" keyword.

Constructor Summary

Constructors

Constructor and Description
AbstractNpcAPI()

Method Summary

Modifier and Type	Method and Description
abstract boolean	areForgeScriptsEnabled()
abstract boolean	areGlobalNPCScriptsEnabled()
abstract boolean	arePlayerScriptsEnabled()
abstract void	continueSounds()
abstract ICustomGui	createCustomGui(int id, int width, int height, boolean pauseGame)
abstract ICustomOverlay	createCustomOverlay(int id)
abstract IParticle	createEntityParticle(java.lang.String directory) Deprecated.
abstract IItemStack	createItem(java.lang.String id, int damage, int size)
abstract ICustomNpc<?>	createNPC(IWorld var1)
abstract IParticle	createParticle(java.lang.String directory)
abstract ISkinOverlay	createSkinOverlay(java.lang.String texture)
abstract ISound	createSound(java.lang.String directory)
abstract void	enableForgeScripts(boolean enable)
abstract void	enableGlobalNPCScripts(boolean enable)
abstract void	enablePlayerScripts(boolean enable)
abstract cpw.mods.fml.common.eventhandler.EventBus	events()
abstract void	executeCommand(IWorld var1, java.lang.String var2)
abstract java.lang.String[]	getAllBiomeNames()
abstract IPos[]	getAllInBox(IPos from, IPos to)
abstract IPos[]	getAllInBox(IPos from, IPos to, boolean sortByDistance) Forms a box with corners as the input IPos parameters, and returns all points inside the box as a list of IPos vectors.
abstract IPlayer<?>[]	getAllServerPlayers()
abstract net.minecraft.entity.INpc[]	getChunkLoadingNPCs()
abstract ICloneHandler	getClones()
abstract int	getCurrentPlayerCount()
abstract IDialogHandler	getDialogs()
abstract IFactionHandler	getFactions()
abstract java.io.File	getFile(java.lang.String path)
abstract java.io.File	getGlobalDir()
abstract IBlock	getIBlock(IWorld world, int x, int y, int z)
abstract IBlock	getIBlock(IWorld world, IPos pos)
abstract IContainer	getIContainer(net.minecraft.inventory.Container var1)
abstract IContainer	getIContainer(net.minecraft.inventory.IInventory var1)
abstract IDamageSource	getIDamageSource(net.minecraft.util.DamageSource var1)
abstract IDamageSource	getIDamageSource(IEntity<?> entity)
abstract IEntity<?>	getIEntity(net.minecraft.entity.Entity var1)
abstract IItemStack	getIItemStack(net.minecraft.item.ItemStack var1)
abstract INbt	getINbt(net.minecraft.nbt.NBTTagCompound nbtTagCompound)
abstract IPos	getIPos(net.minecraft.util.math.BlockPos pos)
abstract IPos	getIPos(double x, double y, double z)
abstract IPos	getIPos(float x, float y, float z)
abstract IPos	getIPos(int x, int y, int z)
abstract ITileEntity	getITileEntity(IWorld world, int x, int y, int z)
abstract ITileEntity	getITileEntity(IWorld world, IPos pos)
abstract ITileEntity	getITileEntity(net.minecraft.tileentity.TileEntity tileEntity)
abstract IWorld	getIWorld(int var1)
abstract IWorld	getIWorld(net.minecraft.world.World var1)
abstract IWorld[]	getIWorlds()
abstract IEntity<?>[]	getLoadedEntities()
abstract ITransportHandler	getLocations()
abstract int	getMaxPlayers()
abstract java.lang.String	getMOTD()
abstract INaturalSpawnsHandler	getNaturalSpawns()
abstract IPlayer<?>	getPlayer(java.lang.String username)
abstract java.lang.String[]	getPlayerNames()
abstract IQuestHandler	getQuests()
abstract java.lang.String	getRandomName(int dictionary, int gender) Generates a new name as a String using the Markov name generator.
abstract IRecipeHandler	getRecipes()
abstract java.lang.String	getServerOwner()
abstract int	getServerTime()
abstract java.io.File	getWorldDir()
static AbstractNpcAPI	Instance()
static boolean	IsAvailable()
abstract boolean	isHardcore()
abstract void	kickAllPlayers()
abstract void	pauseSounds()
abstract void	playSound(int id, ISound sound)
abstract void	playSoundAtEntity(IEntity<?> entity, java.lang.String sound, float volume, float pitch)
abstract void	playSoundToNearExcept(IPlayer<?> player, java.lang.String sound, float volume, float pitch)
abstract void	setMOTD(java.lang.String motd)
abstract long	sizeOfObject(java.lang.Object obj)
abstract ICustomNpc<?>	spawnNPC(IWorld var1, int var2, int var3, int var4) Spawns a new NPC in the world at the given coordinates and returns an ICustomNpc object of it.
abstract ICustomNpc<?>	spawnNPC(IWorld world, IPos pos)
abstract void	stopServer()
abstract void	stopSound(int id)
abstract void	stopSounds()
abstract INbt	stringToNbt(java.lang.String str)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNpcAPI

public AbstractNpcAPI()

Method Detail

sizeOfObject

public abstract long sizeOfObject(java.lang.Object obj)

stopServer

public abstract void stopServer()

getCurrentPlayerCount

public abstract int getCurrentPlayerCount()

getMaxPlayers

public abstract int getMaxPlayers()

kickAllPlayers

public abstract void kickAllPlayers()

isHardcore

public abstract boolean isHardcore()

getFile

public abstract java.io.File getFile(java.lang.String path)

getServerOwner

public abstract java.lang.String getServerOwner()

getFactions

public abstract IFactionHandler getFactions()

getRecipes

public abstract IRecipeHandler getRecipes()

getQuests

public abstract IQuestHandler getQuests()

getDialogs

public abstract IDialogHandler getDialogs()

getClones

public abstract ICloneHandler getClones()

getNaturalSpawns

public abstract INaturalSpawnsHandler getNaturalSpawns()

getLocations

public abstract ITransportHandler getLocations()

getAllBiomeNames

public abstract java.lang.String[] getAllBiomeNames()

createNPC

public abstract ICustomNpc<?> createNPC(IWorld var1)

spawnNPC

public abstract ICustomNpc<?> spawnNPC(IWorld var1,
                                       int var2,
                                       int var3,
                                       int var4)

Spawns a new NPC in the world at the given coordinates and returns an ICustomNpc object of it.

spawnNPC

public abstract ICustomNpc<?> spawnNPC(IWorld world,
                                       IPos pos)

getIEntity

public abstract IEntity<?> getIEntity(net.minecraft.entity.Entity var1)

getPlayer

public abstract IPlayer<?> getPlayer(java.lang.String username)

getChunkLoadingNPCs

public abstract net.minecraft.entity.INpc[] getChunkLoadingNPCs()

getLoadedEntities

public abstract IEntity<?>[] getLoadedEntities()

getIBlock

public abstract IBlock getIBlock(IWorld world,
                                 int x,
                                 int y,
                                 int z)

getIBlock

public abstract IBlock getIBlock(IWorld world,
                                 IPos pos)

getITileEntity

public abstract ITileEntity getITileEntity(IWorld world,
                                           IPos pos)

getITileEntity

public abstract ITileEntity getITileEntity(IWorld world,
                                           int x,
                                           int y,
                                           int z)

getITileEntity

public abstract ITileEntity getITileEntity(net.minecraft.tileentity.TileEntity tileEntity)

getIPos

public abstract IPos getIPos(net.minecraft.util.math.BlockPos pos)

getIPos

public abstract IPos getIPos(int x,
                             int y,
                             int z)

getIPos

public abstract IPos getIPos(double x,
                             double y,
                             double z)

getIPos

public abstract IPos getIPos(float x,
                             float y,
                             float z)

getAllInBox

public abstract IPos[] getAllInBox(IPos from,
                                   IPos to,
                                   boolean sortByDistance)

Forms a box with corners as the input IPos parameters, and returns all points inside the box as a list of IPos vectors.

Parameters:

from - The starting IPos vector, first corner of the box.

to - The ending IPos vector, opposite corner of the box.

sortByDistance - Sorts the list by distance from the "from" IPos parameter.

Returns:

The list of all IPos vectors inside the box.

getAllInBox

public abstract IPos[] getAllInBox(IPos from,
                                   IPos to)

getIContainer

public abstract IContainer getIContainer(net.minecraft.inventory.IInventory var1)

getIContainer

public abstract IContainer getIContainer(net.minecraft.inventory.Container var1)

getIItemStack

public abstract IItemStack getIItemStack(net.minecraft.item.ItemStack var1)

getIWorld

public abstract IWorld getIWorld(net.minecraft.world.World var1)

getIWorld

public abstract IWorld getIWorld(int var1)

getIWorlds

public abstract IWorld[] getIWorlds()

getIDamageSource

public abstract IDamageSource getIDamageSource(net.minecraft.util.DamageSource var1)

getIDamageSource

public abstract IDamageSource getIDamageSource(IEntity<?> entity)

events

public abstract cpw.mods.fml.common.eventhandler.EventBus events()

getGlobalDir

public abstract java.io.File getGlobalDir()

getWorldDir

public abstract java.io.File getWorldDir()

IsAvailable

public static boolean IsAvailable()

Instance

public static AbstractNpcAPI Instance()

executeCommand

public abstract void executeCommand(IWorld var1,
                                    java.lang.String var2)

getRandomName

public abstract java.lang.String getRandomName(int dictionary,
                                               int gender)

Generates a new name as a String using the Markov name generator.

Parameters:

dictionary - An integer representing which dictionary to use: 0: Roman 1: Japanese 2: Slavic 3: Welsh 4: Saami 5: Old Norse 6: Ancient Greek 7: Aztec 8: CustomNPCs Classic 9: Spanish

gender - The gender of the name: 0: Random 1: Male 2: Female

getINbt

public abstract INbt getINbt(net.minecraft.nbt.NBTTagCompound nbtTagCompound)

stringToNbt

public abstract INbt stringToNbt(java.lang.String str)

getAllServerPlayers

public abstract IPlayer<?>[] getAllServerPlayers()

getPlayerNames

public abstract java.lang.String[] getPlayerNames()

createItem

public abstract IItemStack createItem(java.lang.String id,
                                      int damage,
                                      int size)

playSoundAtEntity

public abstract void playSoundAtEntity(IEntity<?> entity,
                                       java.lang.String sound,
                                       float volume,
                                       float pitch)

playSoundToNearExcept

public abstract void playSoundToNearExcept(IPlayer<?> player,
                                           java.lang.String sound,
                                           float volume,
                                           float pitch)

getMOTD

public abstract java.lang.String getMOTD()

Returns:

Returns the server's Message of The Day.

setMOTD

public abstract void setMOTD(java.lang.String motd)

Parameters:

motd - The server's new Message of The Day.

createParticle

public abstract IParticle createParticle(java.lang.String directory)

Returns:

A new IParticle object initialized with the given texture.

createEntityParticle

@Deprecated
public abstract IParticle createEntityParticle(java.lang.String directory)

Deprecated.

createSound

public abstract ISound createSound(java.lang.String directory)

playSound

public abstract void playSound(int id,
                               ISound sound)

stopSound

public abstract void stopSound(int id)

pauseSounds

public abstract void pauseSounds()

continueSounds

public abstract void continueSounds()

stopSounds

public abstract void stopSounds()

getServerTime

public abstract int getServerTime()

Returns:

The uptime of the server in MC ticks.

arePlayerScriptsEnabled

public abstract boolean arePlayerScriptsEnabled()

areForgeScriptsEnabled

public abstract boolean areForgeScriptsEnabled()

areGlobalNPCScriptsEnabled

public abstract boolean areGlobalNPCScriptsEnabled()

enablePlayerScripts

public abstract void enablePlayerScripts(boolean enable)

enableForgeScripts

public abstract void enableForgeScripts(boolean enable)

enableGlobalNPCScripts

public abstract void enableGlobalNPCScripts(boolean enable)

createCustomGui

public abstract ICustomGui createCustomGui(int id,
                                           int width,
                                           int height,
                                           boolean pauseGame)

Parameters:

id - The id of the custom GUI.

width - The width of the GUI in pixels.

height - The height of the GUI in pixels.

pauseGame - Whether the GUI pauses the game or not.

Returns:

A new ICustomGui object with the given attributes.

createCustomOverlay

public abstract ICustomOverlay createCustomOverlay(int id)

Returns:

A new ICustomOverlay overlay object with the given ID.

createSkinOverlay

public abstract ISkinOverlay createSkinOverlay(java.lang.String texture)

Returns:

A new ISkinOverlay object initialized with the given texture.