annotate README.md @ 23:e1f3843950f7

add README.
author Kazuma Takeda
date Thu, 15 Dec 2016 23:59:10 +0900
parents
children 3039d158e31b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
23
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
1 # Jungle-Sharp
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
2
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
3 using UnityEngine.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
4 tree structure database.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
5
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
6 # How to use Jungle-Sharp
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
7
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
8 namespace is JungleDB, so you write c# script.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
9
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
10 using JungleDB;
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
11
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
12 # How to use Jungle Database.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
13
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
14 - need interface.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
15
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
16 Jungle
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
17 JungleTree
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
18 JungleTreeEditor
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
19 NodePath
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
20
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
21 1. Create Instance Jungle from DefaultJungle Class.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
22 2. Create Tree in 1's Jungle Instance.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
23 3. Set 2'Tree to Jungle Tree.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
24 4. Change Tree Mode to Editor Tree Mode, so Set JungleTreeEditor.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
25 5. Create root a Path.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
26 6. Put Key(String) and Value(Byte Array) Attribute from path to TreeEditor.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
27
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
28 private void Start () {
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
29 Jungle jungle = new DefaultJungle(null, "TestJungle", new DefaultTreeEditor(new DefaultTraverser()));
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
30 jungle.createNewTree ("TestTree");
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
31 JungleTree tree = jungle.getTreeByName ("TestTree");
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
32 JungleTreeEditor editor = tree.getTreeEditor();
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
33 NodePath root = new DefaultNodePath ();
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
34 // if put root.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
35 Either<Error, JungleTreeEditor> putAttr = editor.putAttribute(root, "Key", "Value"); // <-1>
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
36 if(putAttr.isA()) { // put error.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
37 // Expection
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
38 }
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
39
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
40 editor = putAttr.b();
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
41
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
42 // elif put root children path.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
43 NodePath path = root.add(0);
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
44 Either<Error, JungleTreeEditor> createRootChild = editor.addNewChildAt(root, 0); // <-1, 0>
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
45 if(createRootChild.isA()) { // child create error.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
46 // Expection
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
47 }
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
48
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
49 editor = createRootChild.b(); // success create root child.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
50
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
51 putAttr = editor.putAttribute(path, "Key", "Value");
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
52 if(putAttr.isA()) { // put error.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
53 // Expection
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
54 }
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
55
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
56 editor = putAttr.b();
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
57
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
58 // else put other path child.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
59 path = path.add(0);
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
60 Either<Error, JungleTreeEditor> createPathChild = editor.addNewChildAt(path, 0); // <-1, 0, 0>
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
61 if(createPathChild.isA()) { // child create error.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
62 // Expection
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
63 }
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
64
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
65 editor = createPathChild.b();
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
66
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
67 putAttr = editor.putAttribute(path, "Key", "Value");
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
68 if(putAttr.isA()) { // put error.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
69 // Expection
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
70 }
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
71
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
72 editor = putAttr.b();
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
73
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
74 // end put Attribute function.
e1f3843950f7 add README.
Kazuma Takeda
parents:
diff changeset
75 }