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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>SetCommand</title>
<category>Objects</category>
<subcat>Commands</subcat>
<version>5.1 OC</version>
<syntax>
<rtype>bool</rtype>
<params>
<param>
<type>string</type>
<name>command</name>
<desc>Command name (as string). See the table below.</desc>
</param>
<param>
<type>object</type>
<name>target</name>
<optional />
<desc>target object for the command</desc>
</param>
<param>
<type>int</type>
<name>x</name>
<optional />
<desc>X target coordinate</desc>
</param>
<param>
<type>int</type>
<name>y</name>
<optional />
<desc>Y target coordinate</desc>
</param>
<param>
<type>object</type>
<name>target2</name>
<optional />
<desc>secondary target object</desc>
</param>
<param>
<type>any</type>
<name>Data</name>
<optional />
<desc>additional data for the command</desc>
</param>
<param>
<type>int</type>
<name>retries</name>
<optional />
<desc>Number of retries if the command fails, until the command fails completely.</desc>
</param>
</params>
</syntax>
<desc>Gives a command to an object. The object will try to complete the command using the internal artificial intelligence (including pathfinding).</desc>
<remark>
The following commands are defined:
<table>
<rowh>
<col>command</col>
<col>target</col>
<col>x, y</col>
<col>target2</col>
<col>Data</col>
<col>Description</col>
</rowh>
<row>
<literal_col>Acquire</literal_col>
<col>Null</col>
<col>0,0</col>
<col>Ignore container</col>
<col>Object type (id)</col>
<col>Type of object to be acquired. May be bought at the home base if necessary. Material contained in the specified container (Target2) is to be ignored in the search.</col>
</row>
<row>
<literal_col>Activate</literal_col>
<col>Target object</col>
<col></col>
<col></col>
<col></col>
<col>Activate the target object (exit from its container).</col>
</row>
<row>
<literal_col>Activate</literal_col>
<col>Null</col>
<col>0,0</col>
<col>Target object</col>
<col></col>
<col>Open the Get menu for the contents of the target object.</col>
</row>
<row>
<literal_col>Activate</literal_col>
<col>Null</col>
<col>Number,0</col>
<col>Target object</col>
<col>Object type (id)</col>
<col>Activate n objects of the specified type in the target object.</col>
</row>
<row>
<literal_col>Attack</literal_col>
<col>Target object</col>
<col></col>
<col></col>
<col></col>
<col>Attack the target object.</col>
</row>
<row>
<literal_col>Buy</literal_col>
<col>Null</col>
<col>0,0</col>
<col>Null</col>
<col>Object type (id)</col>
<col>Buy an object of the specified type at the closest friendly home base.</col>
</row>
<row>
<literal_col>Buy</literal_col>
<col>Basis</col>
<col>Number,0</col>
<col>Null</col>
<col>Object type (id)</col>
<col>Buy n objects of the specified type at the home base.</col>
</row>
<row>
<literal_col>Buy</literal_col>
<col>Basis</col>
<col></col>
<col></col>
<col></col>
<col>Open the Buy menu for the specified home base.</col>
</row>
<row>
<literal_col>Call</literal_col>
<col>Object</col>
<col>Par(1),Par(2)</col>
<col>Par(3)</col>
<col><em>Function</em> (string)</col>
<col>Call <em>Function</em> in the object script. Par(0) will be the calling object. If the command fails because underlaying commands have failed, the function <em>Function</em>Failed is called instead.</col>
</row>
<row>
<literal_col>Chop</literal_col>
<col>Target object</col>
<col></col>
<col></col>
<col></col>
<col>Fell the target object object (tree).</col>
</row>
<row>
<literal_col>Dig</literal_col>
<col>Null</col>
<col>Target position</col>
<col></col>
<col></col>
<col>Dig towards the target position.</col>
</row>
<row>
<literal_col>Drop</literal_col>
<col></col>
<col></col>
<col></col>
<col></col>
<col>Immediately drop the first object in the inventory.</col>
</row>
<row>
<literal_col>Drop</literal_col>
<col>Null</col>
<col>Target position</col>
<col></col>
<col></col>
<col>Drop the first object in the inventory at the target position.</col>
</row>
<row>
<literal_col>Drop</literal_col>
<col>Target object</col>
<col>Target position</col>
<col></col>
<col></col>
<col>Collect the target object and drop it at the target position.</col>
</row>
<row>
<literal_col>Enter</literal_col>
<col>Target object</col>
<col></col>
<col></col>
<col></col>
<col>Enter the target object.</col>
</row>
<row>
<literal_col>Exit</literal_col>
<col></col>
<col></col>
<col></col>
<col></col>
<col>Exit the current container.</col>
</row>
<row>
<literal_col>Follow</literal_col>
<col>Target object</col>
<col></col>
<col></col>
<col></col>
<col>Follow the target object (permanently).</col>
</row>
<row>
<literal_col>Get</literal_col>
<col>Target object</col>
<col></col>
<col></col>
<col></col>
<col>Collect the target object, dig it out if necessary.</col>
</row>
<row>
<literal_col>Get</literal_col>
<col>Null</col>
<col>Number,0</col>
<col>Target object</col>
<col>Object type (id)</col>
<col>Get the specified number of objects from the target object.</col>
</row>
<row>
<literal_col>Grab</literal_col>
<col>Target object</col>
<col>Offset</col>
<col></col>
<col></col>
<col>Grab the target object at the specified offset to the object center.</col>
</row>
<row>
<literal_col>Home</literal_col>
<col></col>
<col></col>
<col></col>
<col></col>
<col>Return to the closest friendly home base.</col>
</row>
<row>
<literal_col>Jump</literal_col>
<col></col>
<col></col>
<col></col>
<col></col>
<col>Jump into the current direction.</col>
</row>
<row>
<literal_col>Jump</literal_col>
<col>Null</col>
<col>Target position</col>
<col></col>
<col></col>
<col>Jump into the direction of the target position.</col>
</row>
<row>
<literal_col>MoveTo</literal_col>
<col>Target object</col>
<col>0,0</col>
<col>Null</col>
<col>No automatic adjustment? (bool)</col>
<col>Move to the position of the target object. Set iData to true to avoid automatic adjustment of the target coordinates to landscape surface.</col>
</row>
<row>
<literal_col>MoveTo</literal_col>
<col>Null</col>
<col>Target position</col>
<col>Null</col>
<col>No automatic adjustment? (bool)</col>
<col>Move to the target position. Set iData to true to avoid automatic adjustment of the target coordinates to landscape surface.</col>
</row>
<row>
<literal_col>None</literal_col>
<col></col>
<col></col>
<col></col>
<col></col>
<col>Clear all current commands.</col>
</row>
<row>
<literal_col>PushTo</literal_col>
<col>Target object</col>
<col>Target position</col>
<col></col>
<col></col>
<col>Push the target object to the target position.</col>
</row>
<row>
<literal_col>PushTo</literal_col>
<col>Object</col>
<col>0,0</col>
<col>Target object</col>
<col></col>
<col>Push the target object into the secondary target object.</col>
</row>
<row>
<literal_col>Put</literal_col>
<col>Target object</col>
<col></col>
<col></col>
<col></col>
<col>Put the first inventory object into the target object.</col>
</row>
<row>
<literal_col>Put</literal_col>
<col>Target object</col>
<col>Number,0</col>
<col></col>
<col></col>
<col>Put the specified number of inventory objects into the target object.</col>
</row>
<row>
<literal_col>Put</literal_col>
<col>Target object</col>
<col>0,0</col>
<col>Object</col>
<col></col>
<col>Collect the target object and put it into the secondary target object.</col>
</row>
<row>
<literal_col>Put</literal_col>
<col>Target object</col>
<col>0,0</col>
<col>Null</col>
<col>Object type (id)</col>
<col>Put the inventory object of the specified type into the target object.</col>
</row>
<row>
<literal_col>Put</literal_col>
<col>Target object</col>
<col>Number,0</col>
<col>Null</col>
<col>Object type (id)</col>
<col>Put the specified number of inventory objects of the specified type into the target object.</col>
</row>
<row>
<literal_col>Sell</literal_col>
<col>Null</col>
<col>0,0</col>
<col>Object2</col>
<col>Object type (id)</col>
<col>Sell an object of the specified type at the closest home base. If Object2 is specified, this one will be sold first.</col>
</row>
<row>
<literal_col>Sell</literal_col>
<col>Basis</col>
<col>Number,0</col>
<col>Object2</col>
<col>Object type (id)</col>
<col>Sell a number of objects of the specified type at the home base. If Object2 is specified, this one will be sold first.</col>
</row>
<row>
<literal_col>Sell</literal_col>
<col>Basis</col>
<col></col>
<col></col>
<col></col>
<col>Open Sell menu for the specified base object.</col>
</row>
<row>
<literal_col>Throw</literal_col>
<col></col>
<col></col>
<col></col>
<col></col>
<col>Throw the first inventory item immediately.</col>
</row>
<row>
<literal_col>Throw</literal_col>
<col>Null</col>
<col>Target position</col>
<col></col>
<col></col>
<col>Throw the first inventory item towards the target position.</col>
</row>
<row>
<literal_col>Throw</literal_col>
<col>Target object</col>
<col>Target position</col>
<col></col>
<col></col>
<col>Collect the target object and throw it towards the target position.</col>
</row>
<row>
<literal_col>UnGrab</literal_col>
<col></col>
<col></col>
<col></col>
<col></col>
<col>Let go of the object currently grabbed.</col>
</row>
<row>
<literal_col>Wait</literal_col>
<col>Null</col>
<col>0,0</col>
<col>Null</col>
<col>Frames</col>
<col>Wait specified number of frames/ticks.</col>
</row>
</table>
</remark>
<examples>
<example>
<code>SetCommand("Attack", <funclink>FindObject</funclink>(<funclink>Find_ID</funclink>(Clonk),<funclink>Sort_Distance</funclink>(0,0)), 0, 0, 0, 0, 10);</code>
<text>This script gives the clonk the order to attack the closest clonk of player 1. If the command fails (e.g. due to unsuccessful pathfinding), retry 10 times.</text>
</example>
</examples>
<related>
<funclink>GetCommand</funclink>
<funclink>AddCommand</funclink>
<funclink>AppendCommand</funclink>
<funclink>FinishCommand</funclink>
</related>
</func>
<author>PeterW</author><date>2001-11</date>
</funcs>
|
