dan200.computercraft.api

Class ComputerCraftAPI

java.lang.Object

dan200.computercraft.api.ComputerCraftAPI

public final class ComputerCraftAPI
extends java.lang.Object

The static entry point to the ComputerCraft API. Members in this class must be called after mod_ComputerCraft has been initialised, but may be called before it is fully loaded.

Constructor Summary

Constructors

Constructor and Description
ComputerCraftAPI()

Method Summary

Modifier and Type	Method and Description
static IMount	createResourceMount(java.lang.Class<?> modClass, java.lang.String domain, java.lang.String subPath) Creates a file system mount to a resource folder, and returns it.
static IWritableMount	createSaveDirMount(net.minecraft.world.World world, java.lang.String subPath, long capacity) Creates a file system mount that maps to a subfolder of the save directory for a given world, and returns it.
static int	createUniqueNumberedSaveDir(net.minecraft.world.World world, java.lang.String parentSubPath) Creates a numbered directory in a subfolder of the save directory for a given world, and returns that number.
static IWiredNode	createWiredNodeForElement(IWiredElement element) Construct a new wired node for a given wired element
static java.lang.String	getAPIVersion()
static int	getBundledRedstoneOutput(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.EnumFacing side) If there is a Computer or Turtle at a certain position in the world, get it's bundled redstone output.
static java.lang.String	getInstalledVersion()
static IWiredElement	getWiredElementAt(net.minecraft.world.IBlockAccess world, net.minecraft.util.math.BlockPos pos, net.minecraft.util.EnumFacing side) Get the wired network element for a block in world
static IPacketNetwork	getWirelessNetwork() Attempt to get the game-wide wireless network.
static boolean	isInstalled()
static void	registerAPIFactory(ILuaAPIFactory upgrade)
static void	registerBundledRedstoneProvider(IBundledRedstoneProvider provider) Registers a bundled redstone provider to provide bundled redstone output for blocks.
static void	registerMediaProvider(IMediaProvider provider) Registers a media provider to provide IMedia implementations for Items
static void	registerPeripheralProvider(IPeripheralProvider provider) Registers a peripheral provider to convert blocks into IPeripheral implementations.
static void	registerPermissionProvider(ITurtlePermissionProvider provider) Deprecated. Prefer using TurtleBlockEvent or the standard Forge events.
static void	registerPocketUpgrade(IPocketUpgrade upgrade)
static void	registerTurtleUpgrade(ITurtleUpgrade upgrade) Registers a new turtle turtle for use in ComputerCraft.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComputerCraftAPI

public ComputerCraftAPI()

Method Detail

isInstalled

public static boolean isInstalled()

getInstalledVersion

@Nonnull
public static java.lang.String getInstalledVersion()

getAPIVersion

@Nonnull
public static java.lang.String getAPIVersion()

createUniqueNumberedSaveDir

public static int createUniqueNumberedSaveDir(@Nonnull
                                              net.minecraft.world.World world,
                                              @Nonnull
                                              java.lang.String parentSubPath)

Creates a numbered directory in a subfolder of the save directory for a given world, and returns that number. Use in conjunction with createSaveDirMount() to create a unique place for your peripherals or media items to store files.

Parameters:

world - The world for which the save dir should be created. This should be the server side world object.

parentSubPath - The folder path within the save directory where the new directory should be created. eg: "computercraft/disk"

Returns:

The numerical value of the name of the new folder, or -1 if the folder could not be created for some reason. eg: if createUniqueNumberedSaveDir( world, "computer/disk" ) was called returns 42, then "computer/disk/42" is now available for writing.

See Also:

createSaveDirMount(World, String, long)

createSaveDirMount

@Nullable
public static IWritableMount createSaveDirMount(@Nonnull
                                                           net.minecraft.world.World world,
                                                           @Nonnull
                                                           java.lang.String subPath,
                                                           long capacity)

Creates a file system mount that maps to a subfolder of the save directory for a given world, and returns it. Use in conjunction with IComputerAccess.mount() or IComputerAccess.mountWritable() to mount a folder from the users save directory onto a computers file system.

Parameters:

world - The world for which the save dir can be found. This should be the server side world object.

subPath - The folder path within the save directory that the mount should map to. eg: "computer/disk/42". Use createUniqueNumberedSaveDir() to create a new numbered folder to use.

capacity - The amount of data that can be stored in the directory before it fills up, in bytes.

Returns:

The mount, or null if it could be created for some reason. Use IComputerAccess.mount() or IComputerAccess.mountWritable() to mount this on a Computers' file system.

See Also:

createUniqueNumberedSaveDir(World, String), IComputerAccess.mount(String, IMount), IComputerAccess.mountWritable(String, IWritableMount), IMount, IWritableMount

createResourceMount

@Nullable
public static IMount createResourceMount(@Nonnull
                                                    java.lang.Class<?> modClass,
                                                    @Nonnull
                                                    java.lang.String domain,
                                                    @Nonnull
                                                    java.lang.String subPath)

Creates a file system mount to a resource folder, and returns it. Use in conjunction with IComputerAccess.mount() or IComputerAccess.mountWritable() to mount a resource folder onto a computer's file system. The files in this mount will be a combination of files in the specified mod jar, and resource packs that contain resources with the same domain and path.

Parameters:

modClass - A class in whose jar to look first for the resources to mount. Using your main mod class is recommended. eg: MyMod.class

domain - The domain under which to look for resources. eg: "mymod".

subPath - The domain under which to look for resources. eg: "mymod/lua/myfiles".

Returns:

The mount, or null if it could be created for some reason. Use IComputerAccess.mount() or IComputerAccess.mountWritable() to mount this on a Computers' file system.

See Also:

IComputerAccess.mount(String, IMount), IComputerAccess.mountWritable(String, IWritableMount), IMount

registerPeripheralProvider

public static void registerPeripheralProvider(@Nonnull
                                              IPeripheralProvider provider)

Registers a peripheral provider to convert blocks into IPeripheral implementations.

Parameters:

provider - The peripheral provider to register.

See Also:

IPeripheral, IPeripheralProvider

registerTurtleUpgrade

public static void registerTurtleUpgrade(@Nonnull
                                         ITurtleUpgrade upgrade)

Registers a new turtle turtle for use in ComputerCraft. After calling this, users should be able to craft Turtles with your new turtle. It is recommended to call this during the load() method of your mod.

Parameters:

upgrade - The turtle upgrade to register.

See Also:

ITurtleUpgrade

registerBundledRedstoneProvider

public static void registerBundledRedstoneProvider(@Nonnull
                                                   IBundledRedstoneProvider provider)

Registers a bundled redstone provider to provide bundled redstone output for blocks.

Parameters:

provider - The bundled redstone provider to register.

See Also:

IBundledRedstoneProvider

getBundledRedstoneOutput

public static int getBundledRedstoneOutput(@Nonnull
                                           net.minecraft.world.World world,
                                           @Nonnull
                                           net.minecraft.util.math.BlockPos pos,
                                           @Nonnull
                                           net.minecraft.util.EnumFacing side)

If there is a Computer or Turtle at a certain position in the world, get it's bundled redstone output.

Parameters:

world - The world this block is in.

pos - The position this block is at.

side - The side to extract the bundled redstone output from.

Returns:

If there is a block capable of emitting bundled redstone at the location, it's signal (0-65535) will be returned. If there is no block capable of emitting bundled redstone at the location, -1 will be returned.

See Also:

IBundledRedstoneProvider

registerMediaProvider

public static void registerMediaProvider(@Nonnull
                                         IMediaProvider provider)

Registers a media provider to provide IMedia implementations for Items

Parameters:

provider - The media provider to register.

See Also:

IMediaProvider

registerPermissionProvider

@Deprecated
public static void registerPermissionProvider(@Nonnull
                                                           ITurtlePermissionProvider provider)

Deprecated. Prefer using TurtleBlockEvent or the standard Forge events.

Registers a permission provider to restrict where turtles can move or build.

Parameters:

provider - The turtle permission provider to register.

See Also:

ITurtlePermissionProvider

registerPocketUpgrade

public static void registerPocketUpgrade(@Nonnull
                                         IPocketUpgrade upgrade)

getWirelessNetwork

public static IPacketNetwork getWirelessNetwork()

Attempt to get the game-wide wireless network.

Returns:

The global wireless network, or null if it could not be fetched.

registerAPIFactory

public static void registerAPIFactory(@Nonnull
                                      ILuaAPIFactory upgrade)

createWiredNodeForElement

@Nonnull
public static IWiredNode createWiredNodeForElement(@Nonnull
                                                             IWiredElement element)

Construct a new wired node for a given wired element

Parameters:

element - The element to construct it for

Returns:

The element's node

See Also:

IWiredSender.getNode()

getWiredElementAt

@Nullable
public static IWiredElement getWiredElementAt(@Nonnull
                                                         net.minecraft.world.IBlockAccess world,
                                                         @Nonnull
                                                         net.minecraft.util.math.BlockPos pos,
                                                         @Nonnull
                                                         net.minecraft.util.EnumFacing side)

Get the wired network element for a block in world

Parameters:

world - The world the block exists in

pos - The position the block exists in

side - The side to extract the network element from

Returns:

The element's node

See Also:

IWiredSender.getNode()