Package noppes.npcs.api

Class AbstractNpcAPI

  • public abstract class AbstractNpcAPI
extends Object
    This object stores functions available to all scripting handlers through the "API" keyword.

    • Constructor Detail

      • AbstractNpcAPI

        public AbstractNpcAPI()

    • Method Detail

      • getTempData

        public abstract Object getTempData​(String key)
        Parameters:
        key - Get temp data for this key
        Returns:
        Returns the stored temp data

      • setTempData

        public abstract void setTempData​(String key,
                                 Object value)
        Tempdata gets cleared when the server restarts. All worlds share the same temp data.
        Parameters:
        key - The key for the data stored
        value - The data stored

      • hasTempData

        public abstract boolean hasTempData​(String key)
        Parameters:
        key - The key thats going to be tested against the temp data
        Returns:
        Whether or not temp data containes the key

      • removeTempData

        public abstract void removeTempData​(String key)
        Parameters:
        key - The key for the temp data to be removed

      • clearTempData

        public abstract void clearTempData()
        Removes all tempdata

      • getTempDataKeys

        public abstract String[] getTempDataKeys()

      • getStoredData

        public abstract Object getStoredData​(String key)
        Parameters:
        key - The key of the data to be returned
        Returns:
        Returns the stored data

      • setStoredData

        public abstract void setStoredData​(String key,
                                   Object value)
        Stored data persists through world restart. Unlike tempdata only Strings and Numbers can be saved
        Parameters:
        key - The key for the data stored
        value - The data stored. This data can be either a Number or a String. Other data is not stored

      • hasStoredData

        public abstract boolean hasStoredData​(String key)
        Parameters:
        key - The key of the data to be checked
        Returns:
        Returns whether or not the stored data contains the key

      • removeStoredData

        public abstract void removeStoredData​(String key)
        Parameters:
        key - The key of the data to be removed

      • clearStoredData

        public abstract void clearStoredData()
        Remove all stored data

      • getStoredDataKeys

        public abstract String[] getStoredDataKeys()

      • registerICommand

        public abstract void registerICommand​(ICommand command)

      • getICommand

        public abstract ICommand getICommand​(String commandName,
                                     int priorityLevel)

      • addGlobalObject

        public abstract void addGlobalObject​(String key,
                                     Object obj)

      • removeGlobalObject

        public abstract void removeGlobalObject​(String key)

      • hasGlobalObject

        public abstract boolean hasGlobalObject​(String key)

      • sizeOfObject

        public abstract long sizeOfObject​(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 File getFile​(String path)

      • getServerOwner

        public abstract String getServerOwner()

      • getMagicHandler

        public abstract IMagicHandler getMagicHandler()

      • getPartyHandler

        public abstract IPartyHandler getPartyHandler()

      • getScriptHooks

        public abstract IScriptHookHandler getScriptHooks()
        Get the script hook handler for registering custom hooks. Addon mods can use this to register hooks that will appear in script editor GUIs.
        Returns:
        The script hook handler

      • getAuctions

        public abstract IAuctionHandler getAuctions()
        Get the auction handler for managing auctions via scripts.
        Returns:
        The auction handler, or null if auctions are disabled

      • createTelegraph

        public abstract ITelegraph createTelegraph​(String type)
        Create a telegraph directly. Convenience method equivalent to getTelegraphs().create(type).
        Parameters:
        type - Type name: "circle", "ring", "line", "cone", "point"
        Returns:
        A new telegraph configuration

      • getAllBiomeNames

        public abstract String[] getAllBiomeNames()

      • 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.
        Parameters:
        var1 - the world
        var2 - X position
        var3 - Y position
        var4 - Z position
        Returns:
        the spawned NPC

      • getIEntity

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

      • getPlayer

        public abstract IPlayer<?> getPlayer​(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)

      • 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)

      • getIPos

        public abstract IPos getIPos​(long serializedPos)

      • 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)
        Parameters:
        var1 - the Minecraft world
        Returns:
        A single IWorld from Loaded IWorlds

      • getIWorld

        public abstract IWorld getIWorld​(int var1)
        Parameters:
        var1 - the dimension ID
        Returns:
        A single IWorld from Loaded IWorlds

      • getIWorldLoad

        public abstract IWorld getIWorldLoad​(int var1)
        This will forcefully load the dimension if it is not loaded Forge sometimes automatically, unloads the End when all players are no longer present.
        Parameters:
        var1 - the dimension ID
        Returns:
        A single IWorld from Loaded/Unloaded IWorlds

      • getActionManager

        public abstract IActionManager getActionManager()
        Returns:
        The global IActionManager for the server

      • getIWorlds

        public abstract IWorld[] getIWorlds()
        Returns:
        The list of all LOADED IWorlds

      • getIDamageSource

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

      • getEnergyHandler

        public abstract IEnergyHandler getEnergyHandler()

      • events

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

      • getGlobalDir

        public abstract File getGlobalDir()

      • getWorldDir

        public abstract File getWorldDir()

      • IsAvailable

        public static boolean IsAvailable()

      • executeCommand

        public abstract void executeCommand​(IWorld var1,
                                    String var2)

      • getRandomName

        public abstract 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
        Returns:
        a random name

      • getINbt

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

      • stringToNbt

        public abstract INbt stringToNbt​(String str)

      • getAllServerPlayers

        public abstract IPlayer<?>[] getAllServerPlayers()

      • getPlayerNames

        public abstract String[] getPlayerNames()

      • createItemFromNBT

        public abstract IItemStack createItemFromNBT​(INbt nbt)

      • createItem

        public abstract IItemStack createItem​(String id,
                                      int damage,
                                      int size)

      • playSoundAtEntity

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

      • playSoundToNearExcept

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

      • getMOTD

        public abstract String getMOTD()
        Returns:
        Returns the server's Message of The Day.

      • setMOTD

        public abstract void setMOTD​(String motd)
        Parameters:
        motd - The server's new Message of The Day.

      • createParticle

        public abstract IParticle createParticle​(String directory)
        Parameters:
        directory - the particle texture directory
        Returns:
        A new IParticle object initialized with the given texture.

      • createSound

        public abstract ISound createSound​(String directory)

      • playSound

        public abstract void playSound​(int id,
                               ISound sound)

      • playSound

        public abstract void playSound​(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)
        Parameters:
        id - the overlay ID
        Returns:
        A new ICustomOverlay overlay object with the given ID.

      • createSkinOverlay

        public abstract ISkinOverlay createSkinOverlay​(String texture)
        Parameters:
        texture - the texture path
        Returns:
        A new ISkinOverlay object initialized with the given texture.

      • millisToTime

        public abstract String millisToTime​(long millis)

      • ticksToTime

        public abstract String ticksToTime​(long ticks)

      • createAnimation

        public abstract IAnimation createAnimation​(String name,
                                           float speed,
                                           byte smooth)

      • createFrame

        public abstract IFrame createFrame​(int duration)

      • createFrame

        public abstract IFrame createFrame​(int duration,
                                   float speed,
                                   byte smooth)

      • createPart

        public abstract IFramePart createPart​(String name,
                                      float[] rotation,
                                      float[] pivot)

      • createPart

        public abstract IFramePart createPart​(String name,
                                      float[] rotation,
                                      float[] pivot,
                                      float speed,
                                      byte smooth)

      • createPart

        public abstract IFramePart createPart​(int partId)

      • createPart

        public abstract IFramePart createPart​(int partId,
                                      float[] rotation,
                                      float[] pivot)

      • createPart

        public abstract IFramePart createPart​(int partId,
                                      float[] rotation,
                                      float[] pivot,
                                      float speed,
                                      byte smooth)