-
Notifications
You must be signed in to change notification settings - Fork 0
/
ref.html
255 lines (236 loc) · 10.3 KB
/
ref.html
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<html>
<head>
<title>Java-nightfall Data File Reference</title>
</head>
<body>
<h1>Java-nightfall Reference</h1>
<h2>NodeData.json</h2>
<table border=1>
<tr><th colspan=4 style="padding:10px;">Root Node</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"nodes"</td>
<td><tt>[</tt><i>node...</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The list of nodes</td></tr>
<tr><td>"links"</td>
<td><tt>[[</tt><i>nodename</i><tt>,</tt> <i>nodename</i><tt>]<i>...</i>]</tt></td><td><b>REQUIRED</b></td>
<td>A list of links between nodes</td></tr>
<tr><th colspan=4 style="padding:10px;">node</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"name"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The name used to indentify node in the code</td></tr>
<tr><td>"title"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The name of the node shown to the user</td></tr>
<tr><td>"desc"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The description of the node</td></tr>
<tr><td>"image"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The icon of the node</td></tr>
<tr><td>"pos"</td>
<td><tt>[</tt><i>integer</i><tt>,</tt> <i>integer</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The position of the node</td></tr>
<tr><td>"battle"</td>
<td><i>string</i></td><td><b>REQUIRED IF "warez" IS NOT PRESENT</b></td>
<td>The databattle</td></tr>
<tr><td>"warez"</td>
<td><tt>[</tt><i>item...</i><tt>]</tt></td><td><b>REQUIRED IF "battle" IS NOT PRESENT</b></td>
<td>The list of warez items</td></tr>
<tr><td>"status"</td>
<td><tt>"unknown"</tt>, <tt>"visible"</tt> or <tt>"open"</tt></td><td><tt>"unknown"</tt></td>
<td>The status of the node</td></tr>
<tr><th colspan=4 style="padding:10px;">item</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"agent"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The name of the agent</td></tr>
<tr><td>"value"</td>
<td><i>integer</i></td><td><b>REQUIRED</b></td>
<td>The value of the item</td></tr>
</table>
<h2>BattleData.json</h2>
<b>The root node is a list</b>
<br/>
<table border=1>
<tr><th colspan=4 style="padding:10px;">battle</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"name"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The name used to indentify battle in the code</td></tr>
<tr><td>"size"</td>
<td><tt>[</tt><i>integer</i><tt>,</tt> <i>integer</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The size of the battle</td></tr>
<tr><td>"uploads"</td>
<td><tt>[</tt><tt>[</tt><i>integer</i><tt>,</tt> <i>integer</i><tt>]</tt><i>...</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The list of upload slot locations</td></tr>
<tr><td>"units"</td>
<td><tt>[</tt><i>unit...</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The list of enemy units</td></tr>
<tr><td>"credits"</td>
<td><tt>[</tt><i>credit...</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The list of credit slots</td></tr>
<tr><td>"dataSlots"</td>
<td><tt>[</tt><tt>[</tt><i>integer</i><tt>,</tt> <i>integer</i><tt>]</tt><i>...</i><tt>]</tt></td><td>OPTIONAL</td>
<td>The list of data slots</td></tr>
<tr><td>"reward"</td>
<td><i>integer</i></td><td><tt>0</tt></td>
<td>The credit bonus</td></tr>
<tr><th colspan=4 style="padding:10px;">unit</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"name"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The name of the agent</td></tr>
<tr><td>"pos"</td>
<td><tt>[</tt><i>integer</i><tt>,</tt> <i>integer</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The position of the agent</td></tr>
<tr><th colspan=4 style="padding:10px;">credit</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"amount"</td>
<td><i>integer</i></td><td><b>REQUIRED</b></td>
<td>The amount</td></tr>
<tr><td>"pos"</td>
<td><tt>[</tt><i>integer</i><tt>,</tt> <i>integer</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The position of the agent</td></tr>
</table>
<h2>MessageData.json</h2>
<b>The root node is a list</b>
<br/>
<table border=1>
<tr><th colspan=4 style="padding:10px;">message</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"name"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The name used to indentify message in the code</td></tr>
<tr><td>"title"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The title of the message</td></tr>
<tr><td>"text"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The content of the message</td></tr>
<tr><td>"image"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The avatar of the sender</td></tr>
<tr><td>"show after"</td>
<td><i>event</i></td><td>OPTIONAL</td>
<td>Show the message after this event</td></tr>
<tr><td>"buttons"</td>
<td><tt>[</tt><i>button...</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>Buttons</td></tr>
<tr><th colspan=4 style="padding:10px;">event</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"event"</td>
<td><tt>"victory"</tt>,<br/><tt>"defeat"</tt><br/>or <tt>"newgame"</tt></td><td><b>REQUIRED</b></td>
<td>A victory event is fired when players wins a level and a defeat level when a level is lost. The newgame event is fired on the very first time the player opens the game.</td></tr>
<tr><td>"battle"</td>
<td><i>string</i></td><td><b>REQUIRED IF THE EVENT IS "victory" OR "defeat"</b></td>
<td>The databattle player wins or loses</td></tr>
<tr><th colspan=4 style="padding:10px;">button</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"text"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The text</td></tr>
<tr><td>"onclick"</td>
<td><tt>[</tt><i>action...</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>A list of actions</td></tr>
<tr><th colspan=4 style="padding:10px;">action</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"action"</td>
<td><tt>"close"</tt>,<br/>
<tt>"show message"</tt>,<br/>
<tt>"open databattle"</tt>,<br/>
<tt>"open node"</tt>,<br/>
<tt>"set visible"</tt>,<br/>
<tt>"give agent"</tt><br/>
or <tt>"give credit"</tt></td><td><b>REQUIRED</b></td>
<td>The name of the action.
<ul><li>"close" closes the message window.</li>
<li>"show message" opens a new message.</li>
<li>"open databattle" opens a databattle (node, if present, is not marked defeated in victory).</li>
<li>"open node" opens a databattle in a node.</li>
<li>"set visible" sets a node visible, but not playable.</li>
<li>"give agent" gives a new agent to the player.</li>
<li>"give credit" gives some credit to the player.</li></ul></td></tr>
<tr><td>"name"</td>
<td><i>string</i></td><td><b>REQUIRED IF THE ACTION IS "show message", "open databattle", "open node", "set visible" OR "give agent"</b></td>
<td>The name of the message, databattle, node or agent.</td></tr>
<tr><td>"amount"</td>
<td><i>integer</i></td><td><b>REQUIRED IF THE ACTION IS "give credit"</b></td>
<td>The amount credit given.</td></tr>
</table>
<h2>AgentData.json</h2>
<b>The root node is a list</b>
<br/>
<table border=1>
<tr><th colspan=4 style="padding:10px;">agent</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"name"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The name used to indentify message in the code</td></tr>
<tr><td>"desc"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The description</td></tr>
<tr><td>"color"</td>
<td><tt>"rrggbb"</tt></td><td><b>REQUIRED</b></td>
<td>The color of the agent</td></tr>
<tr><td>"thumb"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The agent icon</td></tr>
<tr><td>"move"</td>
<td><i>integer</i></td><td><b>REQUIRED</b></td>
<td>The speed of the agent.</td></tr>
<tr><td>"size"</td>
<td><i>integer</i></td><td><b>REQUIRED</b></td>
<td>The max size of the agent.</td></tr>
<tr><td>"abilities"</td>
<td><tt>[</tt><i>ability...</i><tt>]</tt></td><td><b>REQUIRED</b></td>
<td>The abilities</td></tr>
<tr><th colspan=4 style="padding:10px;">ability</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"source"</td>
<td><tt>"BasicAttack"</tt>,<br/>
<tt>"SelfHarmingAttack"</tt>,<br/>
<tt>"ExpandTail"</tt>,<br/>
<tt>"ModifyProperties"</tt><br/>
or <tt>"ModifyGrid"</tt></td><td><b>REQUIRED</b></td>
<td>The ability source.
<ul><li>"BasicAttack" a basic attack.</li>
<li>"SelfHarmingAttack" an attack wich harms both the targent and the agent.</li>
<li>"ExpandTail" expands the tail of the target.</li>
<li>"ModifyProperties" modifies the max size and the move speed of the target.</li>
<li>"ModifyGrid" Adds or deletes sectors.</li></ul></td></tr>
<tr><td>"params"</td>
<td><i>sourceparams</i></td><td><b>REQUIRED</b></td>
<td>A list of parameters to the source.</td></tr>
<tr><th colspan=4 style="padding:10px;">sourceparams</th></tr>
<tr><th>Name</th><th>Value</th><th>Default value</th><th>Description</th></tr>
<tr><td>"name"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The name</td></tr>
<tr><td>"desc"</td>
<td><i>string</i></td><td><b>REQUIRED</b></td>
<td>The description</td></tr>
<tr><td>"range"</td>
<td><i>integer</i></td><td><b>REQUIRED</b></td>
<td>The range of the ability.</td></tr>
<tr><td>"minsize"</td>
<td><i>integer</i></td><td><b>REQUIRED</b></td>
<td>The min size required to perform.</td></tr>
<tr><td>"self damage"</td>
<td><i>integer</i></td><td><b>REQUIRED IF THE ABILITY IS NOT "BasicAttack"</b></td>
<td>The damage to the performer.</td></tr>
<tr><td>"damage"</td>
<td><i>integer</i></td><td><b>REQUIRED IF THE ABILITY IS "BasicAttack" OR "SelfHarmingAttack"</b></td>
<td>The damage to the target.</td></tr>
<tr><td>"move"</td>
<td><i>integer</i></td><td><b>REQUIRED IF THE ABILITY IS "ModifyProperties"</b></td>
<td>The change of the move speed.</td></tr>
<tr><td>"rsize"</td>
<td><i>integer</i></td><td><b>REQUIRED IF THE ABILITY IS "ModifyProperties"</b></td>
<td>The change of the max size.</td></tr>
<tr><td>"type"</td>
<td><tt>true</tt> or <tt>false</tt></td><td><b>REQUIRED IF THE ABILITY IS "ModifyGrid"</b></td>
<td>True adds sectors and false removes sectors.</td></tr>
</table>
</body>
</html>