mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2025-10-21 00:47:39 +00:00
48 lines
2.3 KiB
Java
48 lines
2.3 KiB
Java
/*
|
|
* This file is part of the public ComputerCraft API - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2022. 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 javax.annotation.Nonnull;
|
|
|
|
/**
|
|
* An interface passed to peripherals and {@link IDynamicLuaObject}s by computers or turtles, providing methods
|
|
* that allow the peripheral call to interface with the computer.
|
|
*/
|
|
public interface ILuaContext
|
|
{
|
|
/**
|
|
* Queue a task to be executed on the main server thread at the beginning of next tick, but do not wait for it to
|
|
* complete. This should be used when you need to interact with the world in a thread-safe manner but do not care
|
|
* about the result or you wish to run asynchronously.
|
|
*
|
|
* When the task has finished, it will enqueue a {@code task_completed} event, which takes the task id, a success
|
|
* value and the return values, or an error message if it failed.
|
|
*
|
|
* @param task The task to execute on the main thread.
|
|
* @return The "id" of the task. This will be the first argument to the {@code task_completed} event.
|
|
* @throws LuaException If the task could not be queued.
|
|
* @see LuaFunction#mainThread() To run functions on the main thread and return their results synchronously.
|
|
*/
|
|
long issueMainThreadTask( @Nonnull ILuaTask task ) throws LuaException;
|
|
|
|
/**
|
|
* Queue a task to be executed on the main server thread at the beginning of next tick, waiting for it to complete.
|
|
* This should be used when you need to interact with the world in a thread-safe manner.
|
|
*
|
|
* Note that the return values of your task are handled as events, meaning more complex objects such as maps or
|
|
* {@link IDynamicLuaObject} will not preserve their identities.
|
|
*
|
|
* @param task The task to execute on the main thread.
|
|
* @return The objects returned by {@code task}.
|
|
* @throws LuaException If the task could not be queued, or if the task threw an exception.
|
|
*/
|
|
@Nonnull
|
|
default MethodResult executeMainThreadTask( @Nonnull ILuaTask task ) throws LuaException
|
|
{
|
|
return TaskCallback.make( this, task );
|
|
}
|
|
}
|