-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path!!MEMBERTYPE_Methods_C_ScriptBindRPGModule.html
More file actions
212 lines (202 loc) · 14.1 KB
/
!!MEMBERTYPE_Methods_C_ScriptBindRPGModule.html
File metadata and controls
212 lines (202 loc) · 14.1 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
<?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_ScriptBindRPGModule 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,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,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_ScriptBindRPGModule__C_ScriptBindRPGModule@ISystem__@IGameFramework__@C_RPGModule__.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_ScriptBindRPGModule.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_ScriptBindRPGModule___GetConstant@IFunctionHandler__@SmartScriptTable@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_ScriptBindRPGModule 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_ScriptBindRPGModule 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_ScriptBindRPGModule.html">RPG</a></p></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_ScriptBindRPGModule___GetConstant@IFunctionHandler__@SmartScriptTable@char__.html">_GetConstant</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_ScriptBindRPGModule___SetConstant@IFunctionHandler__@SmartScriptTable@char__@float.html">_SetConstant</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
This is _SetConstant, a member of class C_ScriptBindRPGModule. </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_ScriptBindRPGModule__AddStatXP@IFunctionHandler_@ScriptHandle@framework__T_WUIDScriptType@char_@int@float@float.html">AddStatXP</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.AddStatXP(event, soul, statName, totalXp, oldProgress, newProgress)<br />Gives soul 'soul' X XP points towards RPG stat 'statName' (e.g. 'str' for strength, 'agi' for agility), where 'X = floor(totalXp * newProgress) - floor(totalXp * oldProgress)'.<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_ScriptBindRPGModule__CaptionObjectUsed@IFunctionHandler_@ScriptHandle@bool.html">CaptionObjectUsed</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_ScriptBindRPGModule__GetFactionById@IFunctionHandler_@int.html">GetFactionById</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.GetFactionById(factionId)<br />Returns faction with the given id or nil if no such faction exists.<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_ScriptBindRPGModule__GetFactions@IFunctionHandler_.html">GetFactions</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.GetFactions()<br />Rerturns an array of all factions.<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_ScriptBindRPGModule__GetHobbies@IFunctionHandler__.html">GetHobbies</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.GetHobbies()<br />Returns a table indexed by hobby names. </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_ScriptBindRPGModule__GetLocationById@IFunctionHandler_@char_.html">GetLocationById</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.GetLocationById()<br />Returns a location object or nil.<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_ScriptBindRPGModule__GetLocationByName@IFunctionHandler_@char_.html">GetLocationByName</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.GetLocationByName()<br />Returns a location object or nil.<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_ScriptBindRPGModule__GetLocations@IFunctionHandler_.html">GetLocations</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.GetLocations()<br />Returns an array of all locations.<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_ScriptBindRPGModule__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_ScriptBindRPGModule. </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_ScriptBindRPGModule__Help@IFunctionHandler__.html">Help</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.Help()<br />Print RPG constants/params with their values. You can supply one string argument to filter the results. </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_ScriptBindRPGModule__IsPublicEnemy@IFunctionHandler__@framework__T_WUIDScriptType.html">IsPublicEnemy</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.IsPublicEnemy(wuid)<br />Returns if soul represented by wuid is public enemy.<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_ScriptBindRPGModule__NotifyLevelXpGain@IFunctionHandler_@char__.html">NotifyLevelXpGain</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
This is NotifyLevelXpGain, a member of class C_ScriptBindRPGModule. </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_ScriptBindRPGModule__Release.html">Release</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
This is Release, a member of class C_ScriptBindRPGModule. </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_ScriptBindRPGModule__UnlockRecipe@IFunctionHandler_@ScriptHandle@int@int.html">UnlockRecipe</a> </div></td><td class="Element206" valign="top" width="60%">
<div class="Element207">
Syntax: RPG.UnlockRecipeStep()<br />Unlocks recipe step. </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>