cn.academy.ability.api.Controllable.java Source code

Introduction

Here is the source code for cn.academy.ability.api.Controllable.java

Source

/**
* Copyright (c) Lambda Innovation, 2013-2016
* This file is part of the AcademyCraft mod.
* https://github.com/LambdaInnovation/AcademyCraft
* Licensed under GPLv3, see project root for more information.
*/
package cn.academy.ability.api;

import cn.academy.ability.api.context.ClientRuntime;
import cn.academy.ability.api.ctrl.SkillInstance;
import cn.lambdalib.annoreg.core.Registrant;
import cn.lambdalib.annoreg.mc.RegInitCallback;
import cn.lambdalib.s11n.nbt.NBTS11n;
import cn.lambdalib.s11n.nbt.NBTS11n.BaseSerializer;
import cn.lambdalib.s11n.network.NetworkS11n;
import cn.lambdalib.s11n.network.NetworkS11n.ContextException;
import cn.lambdalib.s11n.network.NetworkS11n.NetS11nAdaptor;
import cpw.mods.fml.relauncher.Side;
import cpw.mods.fml.relauncher.SideOnly;
import io.netty.buffer.ByteBuf;
import net.minecraft.entity.player.EntityPlayer;
import net.minecraft.nbt.NBTBase;
import net.minecraft.nbt.NBTTagByteArray;
import net.minecraft.util.ResourceLocation;

/**
 * This class has ability to create a SkillInstance to override
 * a specific ability key. Used in Skill for indexing.
 * @author WeAthFolD
 */
@Registrant
public abstract class Controllable {

    @RegInitCallback
    private static void init() {
        NetworkS11n.addDirect(Controllable.class, new NetS11nAdaptor<Controllable>() {
            @Override
            public void write(ByteBuf buf, Controllable obj) {
                buf.writeByte(obj.getCategory().getCategoryID());
                buf.writeByte(obj.getControlID());
            }

            @Override
            public Controllable read(ByteBuf buf) throws ContextException {
                Category cat = CategoryManager.INSTANCE.getCategory(buf.readByte());
                return cat.getControllable(buf.readByte());
            }
        });
        NBTS11n.addBase(Controllable.class, new BaseSerializer<NBTBase, Controllable>() {
            @Override
            public NBTBase write(Controllable value) {
                return new NBTTagByteArray(
                        new byte[] { (byte) value.getCategory().getCategoryID(), (byte) value.getControlID() });
            }

            @Override
            public Controllable read(NBTBase tag, Class<? extends Controllable> type) {
                byte[] bytes = ((NBTTagByteArray) tag).func_150292_c();
                Category cat = CategoryManager.INSTANCE.getCategory(bytes[0]);
                return cat.getControllable(bytes[1]);
            }
        });
    }

    private Category category;
    private int id;

    public Controllable() {
    }

    final void addedControllable(Category _category, int _id) {
        category = _category;
        id = _id;
    }

    public final Category getCategory() {
        return category;
    }

    public final int getControlID() {
        return id;
    }

    @SideOnly(Side.CLIENT)
    @Deprecated
    public SkillInstance createSkillInstance(EntityPlayer player) {
        return null;
    }

    /**
     * Invoked when given {@link Controllable} was activated. (e.g. The skill was in the switched preset),
     *  register the KeyDelegates into the runtime.
     *
     *  @param keyID The key ID associated with the skill currently
     */
    @SideOnly(Side.CLIENT)
    public /*abstract*/ void activate(ClientRuntime rt, int keyID) {
    }

    /**
     * Return the icon of this controllable. Used in KeyHint display UI.
     */
    public abstract ResourceLocation getHintIcon();

    /**
     * Return the hint text of the controllable. Used in KeyHint display UI.
     */
    public abstract String getHintText();

    /**
     * @return Whether this controllable should override the vanilla key control.
     */
    public boolean shouldOverrideKey() {
        return true;
    }

}