src/main/java/gregtech/api/task/TickableTask.java


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

package gregtech.api.task;

import javax.annotation.Nonnull;

import net.minecraft.nbt.NBTTagCompound;

/**
 * This class aims at separating logic run on {@link TaskHost}, rather than using interface layers.
 * It has two main functionalities: Run tick and Save/Load.
 * 
 * @param <T> Type of the host
 */
public abstract class TickableTask<T extends TaskHost> {

    @Nonnull
    protected final T taskHost;

    public TickableTask(@Nonnull T taskHost) {
        this.taskHost = taskHost;
        taskHost.registerTask(this);
    }

    /**
     * @return Name of this task. Tasks with conflicting name cannot be registered to the same machine.
     */
    @Nonnull
    public abstract String getName();

    /**
     * Called once per world tick.
     */
    public abstract void update(long tick, boolean isServerSide);

    /**
     * Save info to NBT.
     */
    public void writeToNBT(@Nonnull NBTTagCompound nbt) {}

    /**
     * Read info from NBT.
     */
    public void readFromNBT(@Nonnull NBTTagCompound nbt) {}

    @Override
    public String toString() {
        return "TickableTask{" + "name=" + getName() + ", taskHost=" + taskHost + "}";
    }
}