From 107abb042fc76f2d3409b667a1edd652800f5de0 Mon Sep 17 00:00:00 2001
From: Johannes Lohrer <johanneslohrer@msn.com>
Date: Sun, 29 Dec 2013 12:09:19 +0100
Subject: [PATCH] Example Component

---
 .../textures/items/placeholder.png            | Bin 0 -> 806 bytes
 .../oc/api/example/component/ExampleItem.java |  16 ++++
 .../example/component/ExampleItemDriver.java  |  59 ++++++++++++
 .../component/ExampleItemEnvironment.java     |  86 ++++++++++++++++++
 4 files changed, 161 insertions(+)
 create mode 100644 assets/opencomputers/textures/items/placeholder.png
 create mode 100644 li/cil/oc/api/example/component/ExampleItem.java
 create mode 100644 li/cil/oc/api/example/component/ExampleItemDriver.java
 create mode 100644 li/cil/oc/api/example/component/ExampleItemEnvironment.java

diff --git a/assets/opencomputers/textures/items/placeholder.png b/assets/opencomputers/textures/items/placeholder.png
new file mode 100644
index 0000000000000000000000000000000000000000..3f34c8dafdc1a696973459e67d533963c4222b91
GIT binary patch
literal 806
zcmV+>1KIqEP)<h;3K|Lk000e1NJLTq000mG000mO0ssI2kdbIM00001b5ch_0Itp)
z=>Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D06}y`Sad^gZEa<4
zbO1wAML|?gQaT`KWG!lNWoICEF)lD5D0OpbZf77#N=G0{P(?=|b~Z98EFf`pVQgu1
zc_2L?IWP*aMOc#n000_vMObuGZ)S9NVRB^vP+@6qbS_RsR3LUUE;TMOF-P-4Hvj+v
zNJ&INR5(vnQcFu}Q5Ze{MWjH@ONx@OE9pQ7q8K#t5;hYAQ4DdQ;9DH%K%JyTiX$tE
zs7M|7BElz%Pkigu`#bK^Bloce=j?O#xAwQz`Zn?Xe~3gPi9}+v+1zfoTCK(>u;1H(
z`1jZ8>8ZtH>2|x#W)siJWD<|Z$t?h70)b%PfuxyCrdqAmYPIV1I-b2=Z!j3x?RFG!
zxm=-8czk?J;Du6>X0=*JqtSRgo=&IB<#M%Jfe?*GIUEj)#bPiRM@L6n0*}WdI~a||
ze!qWvd;9S4kjZ31p%D6by<R$<{%r>)lezam;^N}s<>e)nN<mVwSPX~5&(F_iXJ;V%
z0m0|<Nmao4`T5=5U8mE568K&$7B@FHFuJd$)3=hK2l1iK<MALR*uWZgp)H@!E0s#r
zsZ=VtTrQPLu_k0P88&|I5Q#)I8cn5A2?m3KK%iQ!A_=Wl`}z5aZrN-W@(8ep!y&$B
zvst6jNF);1*VhPYKA%56KKlLs_xE>nLk-4aFc=6lGMmkq>+9<)lz;~HE|&`mF%$S%
zuh+0tE|-(Zq(Y(ido|!5@(?8i;IPeR({8uZ>9k(2M;<39Cu}wwqu5HizrRP{x3@QF
zczSw5pIk0iDwROPKydKo<s~LSqtUjekptxZ+JUs;a5#SKfJ`9<KQTUd`1<-no&;jP
zy1M%K_&^BIjXQ&|4-XG<9<Bq9i^XCXVxdq#9%8YWz`#+Y)9DZyg+ifHsRsuKAYcK2
kh9aNO=X5%;W-u7P0sCQdh5+iXod5s;07*qoM6N<$g80K;i2wiq

literal 0
HcmV?d00001

diff --git a/li/cil/oc/api/example/component/ExampleItem.java b/li/cil/oc/api/example/component/ExampleItem.java
new file mode 100644
index 000000000..93212f651
--- /dev/null
+++ b/li/cil/oc/api/example/component/ExampleItem.java
@@ -0,0 +1,16 @@
+package li.cil.oc.api.example.component;
+
+
+import net.minecraft.item.Item;
+
+public class ExampleItem extends Item{
+    //for convenience reasons
+    public static ExampleItem thisItem;
+    public ExampleItem(int id){
+        super(id);
+        thisItem = this;
+        setTextureName("opencomputers:placeholder");
+    }
+    //add all the important methods for your item like images and logic (not lua stuff)
+
+}
diff --git a/li/cil/oc/api/example/component/ExampleItemDriver.java b/li/cil/oc/api/example/component/ExampleItemDriver.java
new file mode 100644
index 000000000..43bd7be43
--- /dev/null
+++ b/li/cil/oc/api/example/component/ExampleItemDriver.java
@@ -0,0 +1,59 @@
+package li.cil.oc.api.example.component;
+
+import cpw.mods.fml.common.event.FMLInitializationEvent;
+import li.cil.oc.api.Driver;
+import li.cil.oc.api.driver.Item;
+import li.cil.oc.api.driver.Slot;
+import li.cil.oc.api.network.ManagedEnvironment;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+import net.minecraft.tileentity.TileEntity;
+
+
+public class ExampleItemDriver implements Item {
+
+
+    @Override
+    public boolean worksWith(ItemStack item) {
+        return item.getItem().equals(ExampleItem.thisItem);
+    }
+
+    @Override
+    public ManagedEnvironment createEnvironment(ItemStack stack, TileEntity container) {
+        //return the environment for the item
+        return new ExampleItemEnvironment();
+    }
+
+    @Override
+    public Slot slot(ItemStack stack) {
+        return Slot.Upgrade;//This is the part where you define in which slot the item fits.
+    }
+
+    /**
+     * This is a example implementation of dataTag. If you prefere a different way to retrieve the compund
+     * feel free to use it
+     * @param stack the item to get the child tag from.
+     * @return
+     */
+    @Override
+    public NBTTagCompound dataTag(ItemStack stack) {
+        if (!stack.hasTagCompound()) {
+            stack.setTagCompound(new NBTTagCompound("tag"));
+        }
+        NBTTagCompound nbt = stack.getTagCompound();
+        if (!nbt.hasKey("yournamespace" + "data")) {
+            nbt.setCompoundTag("yournamespace" + "data", new NBTTagCompound());
+        }
+        return nbt.getCompoundTag("yournamespace" + "data");
+    }
+
+    //This is supposed to be your proxy where you init your stuff
+    public class Proxy{
+
+
+        public void  init(FMLInitializationEvent e) {
+            //in the init methode add this to register the driver
+            Driver.add(new ExampleItemDriver());
+        }
+    }
+}
diff --git a/li/cil/oc/api/example/component/ExampleItemEnvironment.java b/li/cil/oc/api/example/component/ExampleItemEnvironment.java
new file mode 100644
index 000000000..80e7e9e95
--- /dev/null
+++ b/li/cil/oc/api/example/component/ExampleItemEnvironment.java
@@ -0,0 +1,86 @@
+package li.cil.oc.api.example.component;
+
+
+import li.cil.oc.api.Network;
+import li.cil.oc.api.network.*;
+import net.minecraft.nbt.NBTTagCompound;
+
+public class ExampleItemEnvironment implements ManagedEnvironment {
+    /**
+     * ********************************************Default methods***************************
+     */
+    private Node node;
+
+    public ExampleItemEnvironment() {
+        //for a more detailed description read the documentation of each parameter
+        node = Network
+                //Visibility defines who can reach the component
+                .newNode(this, Visibility.Network)
+                        //if the component shall be reached in the component network,
+                        // Visibility defines from where the component can be accessed with lua (
+                .withComponent("ExampleItem", Visibility.Neighbors)
+                        //if you want to have power
+                .withConnector()
+                        //finally creates the node required!
+                .create();
+    }
+
+
+    @Override
+    public Node node() {
+        return node;
+    }
+
+    @Override
+    public void onConnect(Node node) {
+        //do stuff
+    }
+
+    @Override
+    public void onDisconnect(Node node) {
+        //do stuff
+
+    }
+    @Override
+    public void onMessage(Message message) {
+        //do stuff
+    }
+
+    @Override
+    public boolean canUpdate() {
+        //used to indicate if the component shall be updated every tick only called once!
+        return false;
+    }
+
+    @Override
+    public void update() {
+        //do stuff on update (only called if canUpdate returns true)
+    }
+
+    @Override
+    public void load(NBTTagCompound nbt) {
+        //example if you want different implementation do so!
+        if (node != null)
+            node.load(nbt.getCompoundTag("node"));
+    }
+
+    @Override
+    public void save(NBTTagCompound nbt) {
+        //example if you want different implementation do so!
+        if (node != null) {
+            NBTTagCompound compound = new NBTTagCompound();
+            node.save(compound);
+            nbt.setCompoundTag("node", compound);
+        }
+
+    }
+    /**
+     * ********************************************Custom methods***************************
+     */
+    //This is a example method that can be called from lua. The lua name and java name don't need
+    //to be the same
+    @LuaCallback("test")
+    public Object[] testName(Context computer, Arguments arguments) {
+        return new Object[]{"Hello", " Lua"};
+    }
+}