Package noppes.npcs.api

Class NpcAPI

java.lang.Object
noppes.npcs.api.NpcAPI
public abstract class NpcAPI extends Object
Note this API should only be used Server side not on the client

  • Constructor Details

    • NpcAPI

      public NpcAPI()

  • Method Details

    • createNPC

      public abstract ICustomNpc createNPC(net.minecraft.world.level.Level world)
      Doesnt spawn the npc in the world

    • spawnNPC

      public abstract ICustomNpc spawnNPC(net.minecraft.world.level.Level level, int x, int y, int z)
      Creates and spawns an npc

    • getIEntity

      public abstract IEntity getIEntity(net.minecraft.world.entity.Entity entity)

    • getIBlock

      public abstract IBlock getIBlock(net.minecraft.world.level.Level level, net.minecraft.core.BlockPos pos)

    • getIContainer

      public abstract IContainer getIContainer(net.minecraft.world.Container container)

    • getIContainer

      public abstract IContainer getIContainer(net.minecraft.world.inventory.AbstractContainerMenu container)

    • getIItemStack

      public abstract IItemStack getIItemStack(net.minecraft.world.item.ItemStack itemstack)

    • getIWorld

      public abstract IWorld getIWorld(net.minecraft.server.level.ServerLevel world)

    • getIWorld

      public abstract IWorld getIWorld(String dimension)
      Parameters:
      dimension - 'minecraft:overworld', 'minecraft:the_nether', 'minecraft:the_end'

    • getIWorld

      public abstract IWorld getIWorld(net.minecraft.world.level.dimension.DimensionType dimension)

    • getIWorlds

      public abstract IWorld[] getIWorlds()

    • getINbt

      public abstract INbt getINbt(net.minecraft.nbt.CompoundTag compound)

    • getIPos

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

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

    • getIDamageSource

      public abstract IDamageSource getIDamageSource(net.minecraft.world.damagesource.DamageSource damagesource)

    • stringToNbt

      public abstract INbt stringToNbt(String str)

    • createMail

      public abstract IPlayerMail createMail(String sender, String subject)

    • createCustomGui

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

    • createOverlay

      public abstract IOverlay createOverlay(int id)

    • getRawPlayerData

      public abstract INbt getRawPlayerData(String uuid)
      Get player data even if they are offline
      Parameters:
      uuid -
      Returns:

    • events

      public abstract net.minecraftforge.eventbus.api.IEventBus events()
      Used by modders
      Returns:
      The event bus where you register CustomNPCEvents

    • getGlobalDir

      public abstract File getGlobalDir()
      Returns:
      Returns the .minecraft/customnpcs folder or [yourserverfolder]/customnpcs

    • getLevelDir

      public abstract File getLevelDir()
      Returns:
      Returns the .minecraft/saves/[yourworld]/customnpcs folder or [yourserverfolder]/[yourworld]/customnpcs

    • IsAvailable

      public static boolean IsAvailable()

    • Instance

      public static NpcAPI Instance()

    • hasPermissionNode

      public abstract boolean hasPermissionNode(String permission)

    • executeCommand

      public abstract String executeCommand(IWorld world, String command)
      Parameters:
      world - The world in which the command is executed
      command - The Command to execute
      Returns:

    • getRandomName

      public abstract String getRandomName(int dictionary, int gender)
      Parameters:
      dictionary - 0:roman, 1:japanese, 2:slavic, 3:welsh, 4:saami, 5:old-norse, 6:ancient-greek, 7:aztec, 8:classic-cnpcs, 9:spanish
      gender - 0:random, 1:male, 2:female
      Returns:
      Returns a randomly generated name