-
Notifications
You must be signed in to change notification settings - Fork 0
/
DOCUMENTATION.txt
294 lines (181 loc) · 8.8 KB
/
DOCUMENTATION.txt
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
Author: code34 nicolas_boiteux@yahoo.fr
Copyright (C) 2013-2018 Nicolas BOITEUX
CLASS OO_PDW - Pesistent Data World
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
--------------------------------------------------------------------------------------------------------------
Function: _pdw = ["new", "inidbi"] call OO_PDW;
Create a new pdw object with a specific driver
inidbi requires inidbi addons (only avalaible on windows)
Parameters:
string - can be "inidbi" or "profile"
--------------------------------------------------------------------------------------------------------------
Function: ["setSaveName", "nameofsave"] call _pdw;
Set the name of the save
Parameters:
string - name of the save
Return : nothing
--------------------------------------------------------------------------------------------------------------
Function: ["setDbName", "mydb"] call _pdw;
Set the DB name for inidbi (Not avalaible for profile)
Parameters:
string - name of the inidbi db
Return : nothing
--------------------------------------------------------------------------------------------------------------
Function: _bool = ["savePlayer", _player] call _pdw;
Save playable unit informations: position, damage, dir
Parameters:
_player - playable unit object
Return : True if success
--------------------------------------------------------------------------------------------------------------
Function: _bool = ["loadPlayer", _player] call _pdw;
Load playable unit informations : position, damage, dir
Parameters:
_player - playable unit object
Return : True if success
--------------------------------------------------------------------------------------------------------------
Function: _bool = ["saveUnit", [_label,_unit]] call _pdw;
Save unit : type, position, damage, dir
Parameters:
_label : string label of the unit
_unit - unit object (MAN unit)
Return : True if success
--------------------------------------------------------------------------------------------------------------
Function: _unit = ["loadUnit", [_label, _group]] call _pdw;
Load unit : type, position, damage, dir
Parameters:
_label - string label for the unit
_group - group object where the unit have to be restore
Return : unit otherwise false;
--------------------------------------------------------------------------------------------------------------
Function: _bool = ["loadInventory", [_label, _unit]] call _pdw;
Load a preset of equipment (all stuffs in backpacks, weapons, etc)
Parameters:
_label : string label for the preset
_unit : unit object which will load the preset inventory
Return : True if success
--------------------------------------------------------------------------------------------------------------
Function: _bool = ["saveInventory", [_label, _unit]] call _pdw;
Save in a preset all the equipment of the unit (all stuffs in backpacks, weapons, etc)
Parameters:
_label : string label for the preset
_unit : unit object which will be used to save the preset inventory
Return : True if success
--------------------------------------------------------------------------------------------------------------
Function: ["clearInventory", _unit] call _pdw;
Remove all the equipement
Parameters:
_unit : unit object where the inventory will be clear
Return : Nothing
--------------------------------------------------------------------------------------------------------------
Function: ["clearObject", _object] call _pdw;
Remove all the cargo
Parameters:
_object : object where all cargo will be removed
Return : Nothing
--------------------------------------------------------------------------------------------------------------
Function: "savePlayers" call _pdw;
Save all players informations and inventory presets
Parameters:
nothing
Return : Nothing
--------------------------------------------------------------------------------------------------------------
Function: "loadPlayers" call _pdw;
Load all players informations and inventory presets
Parameters:
nothing
Return : Nothing
--------------------------------------------------------------------------------------------------------------
Function: _bool = "saveGroups" call _pdw;
Save all AI groups informations and inventory presets
Parameters:
nothing
Return : True if success
--------------------------------------------------------------------------------------------------------------
Function: "loadGroups" call _pdw;
Load all AI groups informations and inventory presets
Parameters:
nothing
Return : Nothing
--------------------------------------------------------------------------------------------------------------
Function: "saveObjects" call _pdw;
Save all objects informations : type, position, damage according the filters
If no filters, all objects are saved (except soldiers & logics)
filter methods (describe above):
setIncludingMarkers
setExcludingMarkers
setAroundPos
setExcludingTypes
setIncludingTypes
setExcludingObjects
setIncludingObjects
Parameters: none
Return : True if success
--------------------------------------------------------------------------------------------------------------
Function: ["setIncludingMarkers", _array] call _pdw;
Set array of markers containing objects to save
Parameters: _array : array containing objects
Return : none
--------------------------------------------------------------------------------------------------------------
Function: ["setExcludingMarkers", _array] call _pdw;
Set array of markers where objects don't have to be save
Parameters: _array : array containing objects
Return : none
--------------------------------------------------------------------------------------------------------------
Function: ["setAroundPos", _array] call _pdw;
Set array of positions of x distance perimeter, where objects have to be save
Parameters: _array : array containing [[position, distance], [position, distance], ..]
Return : none
--------------------------------------------------------------------------------------------------------------
Function: ["setExcludingTypes", _array] call _pdw;
Set array of of objects type, dont have to be save.
Parameters: _array : array containing types of object ["B_Heli_Light_01_F"]
Return : none
--------------------------------------------------------------------------------------------------------------
Function: ["setIncludingTypes", _array] call _pdw;
Set array of of objects type to whitelist
Parameters: _array : array containing types of object ["B_Heli_Light_01_F"]
Return : none
--------------------------------------------------------------------------------------------------------------
Function: ["setExcludingObjects", _array] call _pdw;
Set array of of objects, dont have to be save.
Parameters: _array : array containing object
Return : none
--------------------------------------------------------------------------------------------------------------
Function: ["setIncludingObjects", _array] call _pdw;
Set array of of objects that have to be save
Parameters: _array : array containing object
Return : none
------------------------------------------------------------------------------------------------------------
Function: _array = "loadObjects" call _pdw;
Load and return all objects loaded
Parameters:
none
Return : array of objects
--------------------------------------------------------------------------------------------------------------
Function: _bool = ["saveObject", [_label, _object]] call _pdw;
Save object, and all its cargo
Parameters:
_label : string label of the object to save
_object : object
Return : True if success
--------------------------------------------------------------------------------------------------------------
Function: _object = ["loadObject", _label] call _pdw;
Load object and return object loaded
Parameters:
_label : string label of the object to load
Return : object
--------------------------------------------------------------------------------------------------------------
Function: ["delete", _pdw] call OO_PDW;
Destroy the pdw object
Parameters:
object - pdw object
Return : nothing