-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathzos_api_notes.txt
More file actions
282 lines (189 loc) · 9.78 KB
/
zos_api_notes.txt
File metadata and controls
282 lines (189 loc) · 9.78 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
h5. SettingSystemType
* SETTING_TYPE_CHAT_GLOBALS
* SETTING_TYPE_CHAT_TABS
* GetDynamicChatChannelName(*integer* _channelId_)
** _Returns:_ *string* _name_
* GetChatChannelId(*string* _name_)
** _Returns:_ *integer* _channelId_
* CanWriteGuildChannel(*integer* _channelId_)
** _Returns:_ *bool* _canWrite_
* GetNumChatContainers()
** _Returns:_ *integer* _numContainers_
* GetNumChatContainerTabs(*luaindex* _chatContainerIndex_)
** _Returns:_ *integer* _numContainerTabs_
* GetChatContainerTabInfo(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_)
** _Returns:_ *string* _name_, *bool* _isLocked_, *bool* _isInteractable_, *bool* _isCombatLog_, *bool* _areTimestampsEnabled_
* GetNumChatCategories()
** _Returns:_ *integer* _numCategories_
* IsChatContainerTabCategoryEnabled(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_, *[ChatChannelCategories|#ChatChannelCategories]* _chatCategory_)
** _Returns:_ *bool* _enabled_
* SetChatContainerTabCategoryEnabled(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_, *[ChatChannelCategories|#ChatChannelCategories]* _chatCategory_, *bool* _enabled_)
* SetChatContainerTabInfo(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_, *string* _name_, *bool* _isLocked_, *bool* _isInteractable_, *bool* _areTimestampsEnabled_)
* ResetChatContainerTabToDefault(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_)
* GetChatContainerColors(*luaindex* _chatContainerIndex_)
** _Returns:_ *number* _bgRed_, *number* _bgGreen_, *number* _bgBlue_, *number* _bgMinAlpha_, *number* _bgMaxAlpha_
* SetChatContainerColors(*luaindex* _chatContainerIndex_, *number* _bgRed_, *number* _bgGreen_, *number* _bgBlue_, *number* _bgMinAlpha_, *number* _bgMaxAlpha_)
* ResetChatContainerColorsToDefault(*luaindex* _chatContainerIndex_)
* AddChatContainer()
* RemoveChatContainer(*luaindex* _chatContainerIndex_)
* AddChatContainerTab(*luaindex* _chatContainerIndex_, *string* _name_, *bool* _isCombatLog_)
* RemoveChatContainerTab(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_)
* TransferChatContainerTab(*luaindex* _fromChatContainerIndex_, *luaindex* _fromTabIndex_, *luaindex* _toChatContainerIndex_, *luaindex* _toTabIndex_)
* GetChatFontSize()
** _Returns:_ *integer* _fontSize_
* SetChatFontSize(*integer* _fontSize_)
* GetGamepadChatFontSize()
** _Returns:_ *integer* _gamepadFontSize_
* SetGamepadChatFontSize(*integer* _gamepadFontSize_)
* ResetChatFontSizeToDefault()
* GetChatCategoryColor(*[ChatChannelCategories|#ChatChannelCategories]* _category_)
** _Returns:_ *number* _red_, *number* _green_, *number* _blue_
* SetChatCategoryColor(*[ChatChannelCategories|#ChatChannelCategories]* _category_, *number* _red_, *number* _green_, *number* _blue_)
* ResetChatCategoryColorToDefault(*[ChatChannelCategories|#ChatChannelCategories]* _category_)
* GetChannelCategoryFromChannel(*[MsgChannelType|#MsgChannelType]* _channel_)
** _Returns:_ *[ChatChannelCategories|#ChatChannelCategories]* _category_
* IsChatBubbleCategoryEnabled(*[ChatChannelCategories|#ChatChannelCategories]* _category_)
** _Returns:_ *bool* _enabled_
* SetChatBubbleCategoryEnabled(*[ChatChannelCategories|#ChatChannelCategories]* _category_, *bool* _enabled_)
* IsChatSystemAvailableForCurrentPlatform()
** _Returns:_ *bool* _enabled_
* SetChatLogEnabled(*bool* _isEnabled_)
* IsChatLogEnabled()
** _Returns:_ *bool* _isEnabled_
h5. ChatChannelCategories
* CHAT_CATEGORY_COMBAT_ALLIANCE_POINTS
* CHAT_CATEGORY_COMBAT_BLOCK_ABSORBED_DEFEND
* CHAT_CATEGORY_COMBAT_DEATH
* CHAT_CATEGORY_COMBAT_DIRECT_DAMAGE
* CHAT_CATEGORY_COMBAT_DIRECT_HEAL
* CHAT_CATEGORY_COMBAT_DODGE_PARRY_MISS
* CHAT_CATEGORY_COMBAT_DOT
* CHAT_CATEGORY_COMBAT_DRAIN
* CHAT_CATEGORY_COMBAT_ENERGIZE
* CHAT_CATEGORY_COMBAT_EXPERIENCE
* CHAT_CATEGORY_COMBAT_GAINED_EFFECT
* CHAT_CATEGORY_COMBAT_HOT
* CHAT_CATEGORY_COMBAT_LOST_EFFECT
* CHAT_CATEGORY_COMBAT_OTHER
* CHAT_CATEGORY_COMBAT_RANK_POINTS
* CHAT_CATEGORY_COMBAT_RESIST
* CHAT_CATEGORY_COMBAT_TELVAR_STONES
* CHAT_CATEGORY_EMOTE
* CHAT_CATEGORY_GUILD_1
* CHAT_CATEGORY_GUILD_2
* CHAT_CATEGORY_GUILD_3
* CHAT_CATEGORY_GUILD_4
* CHAT_CATEGORY_GUILD_5
* CHAT_CATEGORY_MONSTER_EMOTE
* CHAT_CATEGORY_MONSTER_SAY
* CHAT_CATEGORY_MONSTER_WHISPER
* CHAT_CATEGORY_MONSTER_YELL
* CHAT_CATEGORY_OFFICER_1
* CHAT_CATEGORY_OFFICER_2
* CHAT_CATEGORY_OFFICER_3
* CHAT_CATEGORY_OFFICER_4
* CHAT_CATEGORY_OFFICER_5
* CHAT_CATEGORY_PARTY
* CHAT_CATEGORY_SAY
* CHAT_CATEGORY_SYSTEM
* CHAT_CATEGORY_WHISPER_INCOMING
* CHAT_CATEGORY_WHISPER_OUTGOING
* CHAT_CATEGORY_YELL
* CHAT_CATEGORY_ZONE
* CHAT_CATEGORY_ZONE_ENGLISH
* CHAT_CATEGORY_ZONE_FRENCH
* CHAT_CATEGORY_ZONE_GERMAN
* CHAT_CATEGORY_ZONE_JAPANESE
* CHAT_CATEGORY_ZONE_RUSSIAN
h5. ChatChannelCategoryHeaders
* CHAT_CATEGORY_HEADER_CHANNELS
* CHAT_CATEGORY_HEADER_COMBAT
* CHAT_CATEGORY_HEADER_GUILDS
* ExecuteChatCommand(*string* _text_)
* SendChatMessage *private* (*string* _message_, *integer* _channelId_, *string* _target_)
* GetChatterGreeting()
** _Returns:_ *string* _optionString_
* GetChatterData()
** _Returns:_ *string* _text_, *integer* _numOptions_, *bool* _atGreeting_
* GetDynamicChatChannelName(*integer* _channelId_)
** _Returns:_ *string* _name_
* GetChatChannelId(*string* _name_)
** _Returns:_ *integer* _channelId_
* CanWriteGuildChannel(*integer* _channelId_)
** _Returns:_ *bool* _canWrite_
* GetNumChatContainers()
** _Returns:_ *integer* _numContainers_
* GetNumChatContainerTabs(*luaindex* _chatContainerIndex_)
** _Returns:_ *integer* _numContainerTabs_
* GetChatContainerTabInfo(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_)
** _Returns:_ *string* _name_, *bool* _isLocked_, *bool* _isInteractable_, *bool* _isCombatLog_, *bool* _areTimestampsEnabled_
* GetNumChatCategories()
** _Returns:_ *integer* _numCategories_
* IsChatContainerTabCategoryEnabled(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_, *[ChatChannelCategories|#ChatChannelCategories]* _chatCategory_)
** _Returns:_ *bool* _enabled_
* SetChatContainerTabCategoryEnabled(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_, *[ChatChannelCategories|#ChatChannelCategories]* _chatCategory_, *bool* _enabled_)
* SetChatContainerTabInfo(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_, *string* _name_, *bool* _isLocked_, *bool* _isInteractable_, *bool* _areTimestampsEnabled_)
* ResetChatContainerTabToDefault(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_)
* GetChatContainerColors(*luaindex* _chatContainerIndex_)
** _Returns:_ *number* _bgRed_, *number* _bgGreen_, *number* _bgBlue_, *number* _bgMinAlpha_, *number* _bgMaxAlpha_
* SetChatContainerColors(*luaindex* _chatContainerIndex_, *number* _bgRed_, *number* _bgGreen_, *number* _bgBlue_, *number* _bgMinAlpha_, *number* _bgMaxAlpha_)
* ResetChatContainerColorsToDefault(*luaindex* _chatContainerIndex_)
* AddChatContainer()
* RemoveChatContainer(*luaindex* _chatContainerIndex_)
* AddChatContainerTab(*luaindex* _chatContainerIndex_, *string* _name_, *bool* _isCombatLog_)
* RemoveChatContainerTab(*luaindex* _chatContainerIndex_, *luaindex* _tabIndex_)
* TransferChatContainerTab(*luaindex* _fromChatContainerIndex_, *luaindex* _fromTabIndex_, *luaindex* _toChatContainerIndex_, *luaindex* _toTabIndex_)
* GetChatFontSize()
** _Returns:_ *integer* _fontSize_
* SetChatFontSize(*integer* _fontSize_)
* GetGamepadChatFontSize()
** _Returns:_ *integer* _gamepadFontSize_
* SetGamepadChatFontSize(*integer* _gamepadFontSize_)
* ResetChatFontSizeToDefault()
* GetChatCategoryColor(*[ChatChannelCategories|#ChatChannelCategories]* _category_)
** _Returns:_ *number* _red_, *number* _green_, *number* _blue_
* SetChatCategoryColor(*[ChatChannelCategories|#ChatChannelCategories]* _category_, *number* _red_, *number* _green_, *number* _blue_)
* ResetChatCategoryColorToDefault(*[ChatChannelCategories|#ChatChannelCategories]* _category_)
* GetChannelCategoryFromChannel(*[MsgChannelType|#MsgChannelType]* _channel_)
** _Returns:_ *[ChatChannelCategories|#ChatChannelCategories]* _category_
* IsChatBubbleCategoryEnabled(*[ChatChannelCategories|#ChatChannelCategories]* _category_)
** _Returns:_ *bool* _enabled_
* SetChatBubbleCategoryEnabled(*[ChatChannelCategories|#ChatChannelCategories]* _category_, *bool* _enabled_)
* IsChatSystemAvailableForCurrentPlatform()
** _Returns:_ *bool* _enabled_
* SetSessionIgnore(*string* _userName_, *bool* _isIgnoredThisSession_)
* ClearSessionIgnores()
* SetChatLogEnabled(*bool* _isEnabled_)
* IsChatLogEnabled()
** _Returns:_ *bool* _isEnabled_
* GetChatterOption(*luaindex* _optionIndex_)
** _Returns:_ *string* _optionString_, *integer* _optionType_, *integer* _optionalArgument_, *bool* _isImportant_, *bool* _chosenBefore_
* SelectChatterOption(*luaindex* _optionIndex_)
* GetChatterOptionCount()
** _Returns:_ *integer* _optionCount_
* ResetChatter()
* GetChatterFarewell()
** _Returns:_ *string* _backToTOCString_, *string* _farewellString_, *bool* _isImportant_
* GetAgentChatRequestInfo()
** _Returns:_ *bool* _isChatRequested_, *integer* _millisecondsSinceRequest_
* IsAgentChatActive()
** _Returns:_ *bool* _isActive_
* AcceptAgentChat()
* DeclineAgentChat()
* GetNumDefaultQuickChats()
** _Returns:_ *integer* _numQuickChats_
* GetDefaultQuickChatName(*luaindex* _index_)
** _Returns:_ *string* _name_
* GetDefaultQuickChatMessage(*luaindex* _index_)
** _Returns:_ *string* _message_
* PlayDefaultQuickChat *private* (*luaindex* _index_)
* EVENT_AGENT_CHAT_ACCEPTED
* EVENT_AGENT_CHAT_DECLINED
* EVENT_AGENT_CHAT_FORCED
* EVENT_AGENT_CHAT_REQUESTED
* EVENT_AGENT_CHAT_TERMINATED
* EVENT_CHATTER_BEGIN (*integer* _optionCount_, *integer* _debugSource_)
* EVENT_CHATTER_END
* EVENT_CHAT_CATEGORY_COLOR_CHANGED (*integer* _categoryId_, *number* _red_, *number* _green_, *number* _blue_)
* EVENT_CHAT_LOG_TOGGLED (*bool* _opened_)
* EVENT_CHAT_MESSAGE_CHANNEL (*[MsgChannelType|#MsgChannelType]* _channelType_, *string* _fromName_, *string* _text_, *bool* _isCustomerService_, *string* _fromDisplayName_)