-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path!!MEMBERTYPE_Methods_C_ScriptBindSoul.html
More file actions
595 lines (585 loc) · 44.6 KB
/
!!MEMBERTYPE_Methods_C_ScriptBindSoul.html
File metadata and controls
595 lines (585 loc) · 44.6 KB
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>C_ScriptBindSoul Methods</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Doc-O-Matic" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="STYLESHEET" href="default.css" type="text/css" />
<script type="text/javascript" src="scripts.js"></script>
</head>
<body class="Element700" onload="onBodyLoad();" onmousedown="onBodyMouseDown();">
<!-- Begin Popups -->
<!-- End Popups -->
<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element731">
<div class="Element730">
<a onclick="ToggleAllElements('5075626C6963204D6574686F6473,50726F746563746564204D6574686F6473,436C617373', 'linkToggleAllElements', 'imgToggleAllElements', 'Collapse All', 'Expand All');"><img src="btn_collapse_2.gif" border="0" alt="" title="" id="imgToggleAllElements" /></a><a id="linkToggleAllElements" onclick="ToggleAllElements('5075626C6963204D6574686F6473,50726F746563746564204D6574686F6473,436C617373', 'linkToggleAllElements', 'imgToggleAllElements', 'Collapse All', 'Expand All');">Collapse All</a></div>
</div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="33%">
<div class="Element1">
Warhorse ScripBind documentation</div>
</td><td width="34%">
<div class="Element2">
<a href="contents.html"><img src="btn_globals_contents_black.gif" border="0" alt="Contents" title="Contents" onmouseover="switchImage(this, 'btn_globals_contents_black_hover.gif');" onmouseout="switchImage(this, 'btn_globals_contents_black.gif');" /></a><a href="idx.html"><img src="btn_globals_index_black.gif" border="0" alt="Index" title="Index" onmouseover="switchImage(this, 'btn_globals_index_black_hover.gif');" onmouseout="switchImage(this, 'btn_globals_index_black.gif');" /></a><a href="index.html"><img src="btn_globals_home_black.gif" border="0" alt="Home" title="Home" onmouseover="switchImage(this, 'btn_globals_home_black_hover.gif');" onmouseout="switchImage(this, 'btn_globals_home_black.gif');" /></a></div>
</td><td width="33%">
<div class="Element90">
<a href="C_ScriptBindSoul__C_ScriptBindSoul@ISystem__@IGameFramework__@C_SoulList__.html"><img src="btn_prev_black.gif" border="0" alt="Previous" title="Previous" onmouseover="switchImage(this, 'btn_prev_black_hover.gif');" onmouseout="switchImage(this, 'btn_prev_black.gif');" /></a><a href="C_ScriptBindSoul.html"><img src="btn_up_black.gif" border="0" alt="Up" title="Up" onmouseover="switchImage(this, 'btn_up_black_hover.gif');" onmouseout="switchImage(this, 'btn_up_black.gif');" /></a><a href="C_ScriptBindSoul__AddBuff@IFunctionHandler__@char__.html"><img src="btn_next_black.gif" border="0" alt="Next" title="Next" onmouseover="switchImage(this, 'btn_next_black_hover.gif');" onmouseout="switchImage(this, 'btn_next_black.gif');" /></a></div>
</td></tr></table><div class="Element5">
C_ScriptBindSoul Methods</div>
</div>
</div>
<!-- End Page Header -->
<!-- Begin Client Area -->
<div class="Element720" id="areascroll">
<div class="Element721">
<!-- Begin Page Content -->
<div class="Element58">
<a name="53756D6D617279"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
The methods of the C_ScriptBindSoul class are listed here.</p></div>
</div>
<a name="436C617373"></a><div class="Element14">
<a onclick="toggleVisibilityStored('436C617373');" class="a_Element14"><img src="btn_collapse_2.gif" border="0" alt="" title="" id="img436C617373" />Class</a></div>
<div id="div436C617373">
<div class="Element11">
<div class="Element10">
<p class="Element10">
<a href="C_ScriptBindSoul.html">C_ScriptBindSoul Class</a></p></div>
</div>
</div>
<a name="50726F746563746564204D6574686F6473"></a><div class="Element14">
<a onclick="toggleVisibilityStored('50726F746563746564204D6574686F6473');" class="a_Element14"><img src="btn_collapse_2.gif" border="0" alt="" title="" id="img50726F746563746564204D6574686F6473" />Protected Methods</a></div>
<div id="div50726F746563746564204D6574686F6473">
<div class="Element11">
<div class="Element10">
<div class="Element212">
<div class="TableDiv">
<table cellspacing="0" class="Table0">
<tr>
<td class="Element200" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element201">
 </div></td><td class="Element200" valign="top" width="30%">
<div class="Element201">
Name </div></td><td class="Element204" valign="top" width="60%">
<div class="Element205">
Description </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /><img src="indicator_protected.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AddXP@IFunctionHandler__@char__@XP_T@bool.html">AddXP</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
 </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /><img src="indicator_protected.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetSoulValue@IFunctionHandler__@char___const.html">GetSoulValue</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
 </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /><img src="indicator_protected.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__OverrideCharacterElement@IFunctionHandler_@char_@entitymodule__T_CharacterElementId_S_CharacterBodyDescription___.html">OverrideCharacterElement</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
 </div></td></tr></table></div></div>
</div>
</div>
</div>
<a name="5075626C6963204D6574686F6473"></a><div class="Element14">
<a onclick="toggleVisibilityStored('5075626C6963204D6574686F6473');" class="a_Element14"><img src="btn_collapse_2.gif" border="0" alt="" title="" id="img5075626C6963204D6574686F6473" />Public Methods</a></div>
<div id="div5075626C6963204D6574686F6473">
<div class="Element11">
<div class="Element10">
<div class="Element212">
<div class="TableDiv">
<table cellspacing="0" class="Table0">
<tr>
<td class="Element200" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element201">
 </div></td><td class="Element200" valign="top" width="30%">
<div class="Element201">
Name </div></td><td class="Element204" valign="top" width="60%">
<div class="Element205">
Description </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AddBuff@IFunctionHandler__@char__.html">AddBuff</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AddBuff(string buff_id)<br />Adds buff identified by the database id. Returns the instance id.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AddInjury@IFunctionHandler_@float@char_.html">AddInjury</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AddInjury(1, 'head')<br />add [0,1] injury to a body part, bodyPartName from the database<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AddMetaRole@IFunctionHandler__@T_MetaRoleId.html">AddMetaRole</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AddMetaRole(id)<br />Adds a metarole ids to this soul.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AddMetaRoleByName@IFunctionHandler__@char_const_.html">AddMetaRoleByName</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AddMetaRoleByName(name)<br />Adds a metarole by its name to this soul.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AddPerk@IFunctionHandler__@char__.html">AddPerk</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AddPerk(string perk_id)<br />Adds perk identified by the database id. Returns the instance id.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AddSkillXP@IFunctionHandler__@char__@unsigned.html">AddSkillXP</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AddSkillXP(string skill, float xp)<br />Adds experience points. Returns how many levels had been reached (0 if no level was reached). </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AddStatXP@IFunctionHandler__@char__@unsigned.html">AddStatXP</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AddStatXP(string stat, float xp)<br />Adds experience points. Returns how many levels had been reached (0 if no level was reached). </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AdvanceToSkillLevel@IFunctionHandler__@char__@T_SoulLvlValue.html">AdvanceToSkillLevel</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AdvanceToSkillLevel(string skill, float level)<br />Set skill level using string name (use skill_name from database). The function will perform correct transition (it will add XPs). Cannot lower the level. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AdvanceToStatLevel@IFunctionHandler__@char__@T_SoulLvlValue.html">AdvanceToStatLevel</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:AdvanceToStatLevel(string stat, float level)<br />sets stat level, for example soul:AdvanceToStatLevel('str', 20), it will add xp. Cannot lower the level. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__AttachTo@IEntity__@C_Soul__.html">AttachTo</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
This is AttachTo, a member of class C_ScriptBindSoul. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__CalculateBarterDominance@IFunctionHandler__@framework__T_WUIDScriptType.html">CalculateBarterDominance</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: customer:CalculateBarterDominance(shopkeeperSoulWuid)<br />returns 1 if the soul has maximum dominance, -1 if the shopkeeper has maximum dominance<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__DealDamage@IFunctionHandler__@float@float.html">DealDamage</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:DealDamage(stamina, health, attackerId = invalid, suppressHitreaction = false, bodyPart = null)<br />Causes the soul to loose given stamina and health. Negative values are accepted and treated as a heal. BodyParts are passed by name (from the database).<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__DetachFrom@IEntity__.html">DetachFrom</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
 </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GenerateCompanionEventDebug@IFunctionHandler__.html">GenerateCompanionEventDebug</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GenerateCompanionEventDebug()<br />sends a play event for the primary dog companion. Just for debug.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetArchetype@IFunctionHandler__.html">GetArchetype</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetArchetype()<br />Returns a table containing the archetype properties.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetDerivedStat@IFunctionHandler__@char__.html">GetDerivedStat</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetDerivedStat(string stat, table context, table outUsedPerks)<br />returns current value of a derived stat given by the shortcut name (cha, ...)<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetFactionID@IFunctionHandler__.html">GetFactionID</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetFactionID()<br />Returns the ID of the faction that the soul belongs to.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetGatherMult@IFunctionHandler__.html">GetGatherMult</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetGatherMult( ScriptHandle id)<br />gets gather skill multiplier<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetGender@IFunctionHandler__.html">GetGender</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetGender()<br />Returns soul gender. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetHobbies@IFunctionHandler__.html">GetHobbies</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetHobbies()<br />Returns a table containing all soul's hobbies.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetId@IFunctionHandler__.html">GetId</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetId()<br />Returns unique and persistent id of this soul (WUID).<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /><img src="indicator_virtual.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetMemoryUsage@ICrySizer__@const.html">GetMemoryUsage</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
This is GetMemoryUsage, a member of class C_ScriptBindSoul. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetMetaRoles@IFunctionHandler__.html">GetMetaRoles</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetMetaRoles()<br />Returns a table=array containing metarole ids.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetNameStringId@IFunctionHandler__.html">GetNameStringId</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetNameString()<br />returns value of name_string_id column from soul db table<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetNextLevelSkillXP@IFunctionHandler__@char_@unsigned.html">GetNextLevelSkillXP</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetNextLevelSkillXP(string skill, uint level)<br />How many XP points is required for going from the level to level + 1.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetNextLevelStatXP@IFunctionHandler__@char_@unsigned.html">GetNextLevelStatXP</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetNextLevelStatXP(string stat, uint level)<br />How many XP points is required for going from the level to level + 1.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetPerceivedSuperfaction@IFunctionHandler_.html">GetPerceivedSuperfaction</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetPerceivedSuperfaction()<br />Returns the perceived super faction (calculated from all cloths) for this soul. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetReadCaptionObjectText@IFunctionHandler__.html">GetReadCaptionObjectText</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
 </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetRelationship@IFunctionHandler__@framework__T_WUIDScriptType.html">GetRelationship</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetRelationship(otherSoulId)<br />returns the relationship between this and the other soul (-1 the worst enemies, 1 the best friends) Optional second argument selects the superfaction type for the other party. Can be Original, Current or Perceived. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetRoles@IFunctionHandler__.html">GetRoles</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetRoles()<br />Returns a table=array containing role ids.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetSchedule@IFunctionHandler__.html">GetSchedule</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetSchedule()<br />Returns a table containing float-encoded times indexed by activities.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetSkillLevel@IFunctionHandler__@char__.html">GetSkillLevel</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetSkillLevel(string skill)<br />Get skill value using string name (use skill_name from database).<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetSkillProgress@IFunctionHandler__@char__.html">GetSkillProgress</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetSkillProgress(string skill)<br />Get skill progress from the current level to the next [0,1) using string name (use skill_name from database). </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetSocialClass@IFunctionHandler__.html">GetSocialClass</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetSocialClass()<br />Returns social class as a table with Id, Name and Wealth keys. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetSoul@SmartScriptTable.html">GetSoul</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
 </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetState@IFunctionHandler__@char__.html">GetState</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetState(string state)<br />returns state value for a given name (health, stamina,...) </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetStatLevel@IFunctionHandler__@char__.html">GetStatLevel</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetStatLevel(string stat)<br />returns stat value for a given name (str, agi, spc, vit, hea, bar, ...) </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetStatProgress@IFunctionHandler__@char__.html">GetStatProgress</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetStatProgress(string stat)<br />returns stat progress from the current level to the next level [0,1) for a given name (str, agi, spc, vit, hea, bar, ...) </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__GetSuperfaction@IFunctionHandler_.html">GetSuperfaction</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:GetSuperfaction()<br />Returns the true super faction of soul. Optional second argument selects the superfaction type for the other party. Can be Original, Current or Perceived.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__HasAbility@IFunctionHandler__@char__.html">HasAbility</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:HasAbility(string ability)<br />returns true if soul have ability (cha, ...) </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__HasBuffDebug@IFunctionHandler__@char_.html">HasBuffDebug</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:HasBuffDebug("89dada87-6e6c-5d2c-a17a-483ada14b90b")<br />supply buff definition id<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__HasMetaRoleByName@IFunctionHandler_@char_.html">HasMetaRoleByName</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:HasMetaRoleByName()<br />Returns true if soul have specified role. Returns false if the soul doesn't have the specified meta role or the meta role doesn't exist.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__HasRoleByName@IFunctionHandler__@char_const_.html">HasRoleByName</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:HasRoleByName(name)<br />Returns true if soul have specified role.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__HaveSkill@IFunctionHandler__@char__.html">HaveSkill</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:HaveSkill(string skill)<br />Returns true if the soul can use this level. Parameter is name from the database.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__HealBleeding@IFunctionHandler__@float@int.html">HealBleeding</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:HealBleeding(0.5, 1)<br />heal [0,1] bleeding on body part<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__IsDialogRestricted@IFunctionHandler__.html">IsDialogRestricted</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:IsDialogRestricted()<br />return whether dialog is currently restricted<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__IsInCombatDanger@IFunctionHandler__.html">IsInCombatDanger</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:IsInCombatDanger()<br />returns 1 if the soul in in combat danger<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__IsPublicEnemy@IFunctionHandler__.html">IsPublicEnemy</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
 </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__ModifyMoraleDebug@IFunctionHandler__@int.html">ModifyMoraleDebug</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:ModifyMoraleDebug(5)<br />debug function to modify morale, given the database change id<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__ModifyPlayerReputation@IFunctionHandler__@char__.html">ModifyPlayerReputation</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:ModifyPlayerReputation('murder', true)<br />Modify NPCs relationship (reputation) to player by the given name from the database.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__OnCompanionEvent@IFunctionHandler_@framework__T_WUIDScriptType@char_.html">OnCompanionEvent</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:OnCompanionEvent(companion, 'EventName')<br />sends an event.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__OnPerkUsed@IFunctionHandler__@char__.html">OnPerkUsed</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:OnPerkUsed("89dada87-6e6c-5d2c-a17a-483ada14b90b")<br />supply perk definition id<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__OverrideHair@IFunctionHandler_@char_.html">OverrideHair</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:OverrideHair("483ee159-9888-4955-ee19-e41d97637592")<br />supply hair guid (character_hair).<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__OverrideHead@IFunctionHandler_@char_.html">OverrideHead</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:OverrideHead("4e653afe-1b23-db1e-74c8-350b21b958a8")<br />supply head guid (character_head).<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__Release.html">Release</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
This is Release, a member of class C_ScriptBindSoul. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__RemoveAllBuffsByGuid@IFunctionHandler__@char__.html">RemoveAllBuffsByGuid</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:RemoveAllBuffsByGuid(buffDatabaseId)<br />Forces removal of all buffs of the same database guid. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__RemoveBuff@IFunctionHandler__@framework__T_WUIDScriptType.html">RemoveBuff</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:RemoveBuff(buffInstanceId)<br />Forces removal of a buff. Supply the buff instance id. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__RemoveMetaRole@IFunctionHandler__@T_MetaRoleId.html">RemoveMetaRole</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:RemoveMetaRole(id)<br />Removes a metarole from this soul.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__RemoveMetaRoleByName@IFunctionHandler__@char_const_.html">RemoveMetaRoleByName</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:RemoveMetaRoleByName(metaroleName)<br />Removes a metarole from this soul.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__RemovePerk@IFunctionHandler__@char__.html">RemovePerk</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:RemovePerk(PerkInstanceId)<br />Forces removal of a perk. Supply the perk id. </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__RestrictDialog@IFunctionHandler__@bool.html">RestrictDialog</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:RestrictDialog(true)<br />set soul to dialog restricted mode so it cannot be speak to (hint will not be shown, and this functionality is implemented in lua, using IsDialogRestricted) Also deletes all unfinished requests<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__SetPlayerReputationDebug@IFunctionHandler__@float@int@bool.html">SetPlayerReputationDebug</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:SetPlayerReputationDebug(-0.5, 7, true)<br />debug function to directly set reputation. Use the target flags from the database.<br /> </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__SetSkillLevelDebug@IFunctionHandler__@char__@T_SoulLvlValue.html">SetSkillLevelDebug</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:SetSkillLevelDebug(string skill, float level)<br />Set skill level using string name (use skill_name from database). </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__SetState@IFunctionHandler__@char__@float.html">SetState</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:SetState(string state, float value)<br />sets state value for a given name (health, stamina,...) </div></td></tr><tr>
<td class="Element202" valign="top" width="10%" style="white-space: nowrap;">
<div class="Element203">
<img src="indicator_method.gif" border="0" alt="" title="" /> </div></td><td class="Element202" valign="top" width="30%">
<div class="Element203">
<a href="C_ScriptBindSoul__SetStatLevelDebug@IFunctionHandler__@char__@T_SoulLvlValue.html">SetStatLevelDebug</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: soul:SetStatLevelDebug(string stat, float level)<br />sets stat level, for example soul:SetStatLevelDebug('str', 20), sets strength to 20 </div></td></tr></table></div></div>
</div>
</div>
</div>
</div>
<!-- End Page Content -->
<!-- Begin Page Footer -->
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="100%">
<div class="Element3">
Copyright (c) 2012. All rights reserved.</div>
</td></tr></table></div>
<!-- End Page Footer -->
<div class="Element950">
<p><a href="http://www.doc-o-matic.com" target="_blank">Made with Doc-O-Matic® Express</a></p><p><a href="http://www.doc-o-matic.com" target="_blank"><img src="doc-o-matic_button.gif" border="0" alt="Doc-O-Matic" title="Doc-O-Matic" /></a></p></div>
</div>
</div>
<!-- End Client Area -->
</body></html>