mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2025-10-31 13:42:59 +00:00
42 lines
1.8 KiB
Java
42 lines
1.8 KiB
Java
/*
|
|
* This file is part of the public ComputerCraft API - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2021. This API may be redistributed unmodified and in full only.
|
|
* For help using the API, and posting your mods, visit the forums at computercraft.info.
|
|
*/
|
|
|
|
package dan200.computercraft.api.lua;
|
|
|
|
import dan200.computercraft.api.peripheral.IDynamicPeripheral;
|
|
|
|
import javax.annotation.Nonnull;
|
|
|
|
/**
|
|
* An interface for representing custom objects returned by peripherals or other Lua objects.
|
|
*
|
|
* Generally, one does not need to implement this type - it is sufficient to return an object with some methods annotated with {@link LuaFunction}. {@link
|
|
* IDynamicLuaObject} is useful when you wish your available methods to change at runtime.
|
|
*/
|
|
public interface IDynamicLuaObject
|
|
{
|
|
/**
|
|
* Get the names of the methods that this object implements. This should not change over the course of the object's lifetime.
|
|
*
|
|
* @return The method names this object provides.
|
|
* @see IDynamicPeripheral#getMethodNames()
|
|
*/
|
|
@Nonnull
|
|
String[] getMethodNames();
|
|
|
|
/**
|
|
* Called when a user calls one of the methods that this object implements.
|
|
*
|
|
* @param context The context of the currently running lua thread. This can be used to wait for events or otherwise yield.
|
|
* @param method An integer identifying which method index from {@link #getMethodNames()} the computer wishes to call.
|
|
* @param arguments The arguments for this method.
|
|
* @return The result of this function. Either an immediate value ({@link MethodResult#of(Object...)} or an instruction to yield.
|
|
* @throws LuaException If the function threw an exception.
|
|
*/
|
|
@Nonnull
|
|
MethodResult callMethod( @Nonnull ILuaContext context, int method, @Nonnull IArguments arguments ) throws LuaException;
|
|
}
|