mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2025-10-18 23:47:39 +00:00
55847460c5
ILuaAPI has been moved to dan200.computercraft.api.lua. One creates a new API by registering an instance of ILuaAPIFactory. This takes an instance of IComputerSystem and returns such an API. IComputerSystem is an extension of IComputerAccess, with methods to access additional information about the the computer, such as its label and filesystem.
48 lines
1.4 KiB
Java
48 lines
1.4 KiB
Java
/*
|
|
* This file is part of ComputerCraft - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2016. Do not distribute without permission.
|
|
* Send enquiries to dratcliffe@gmail.com
|
|
*/
|
|
|
|
package dan200.computercraft.api.lua;
|
|
|
|
import dan200.computercraft.api.ComputerCraftAPI;
|
|
|
|
/**
|
|
* Represents a {@link ILuaObject} which is stored as a global variable on computer startup.
|
|
*
|
|
* Before implementing this interface, consider alternative methods of providing methods. It is generally preferred
|
|
* to use peripherals to provide functionality to users.
|
|
*
|
|
* @see ILuaAPIFactory
|
|
* @see ComputerCraftAPI#registerAPIFactory(ILuaAPIFactory)
|
|
*/
|
|
public interface ILuaAPI extends ILuaObject
|
|
{
|
|
/**
|
|
* Get the globals this API will be assigned to. This will override any other global, so you should
|
|
*
|
|
* @return A list of globals this API will be assigned to.
|
|
*/
|
|
String[] getNames();
|
|
|
|
/**
|
|
* Called when the computer is turned on.
|
|
*
|
|
* One should only interact with the file system.
|
|
*/
|
|
default void startup() { }
|
|
|
|
/**
|
|
* Called every time the computer is ticked. This can be used to process various.
|
|
*/
|
|
default void update() { }
|
|
|
|
/**
|
|
* Called when the computer is turned off or unloaded.
|
|
*
|
|
* This should reset the state of the object, disposing any remaining file handles, or other resources.
|
|
*/
|
|
default void shutdown() { }
|
|
}
|