nv4jKK85

1==>dumpConsoleFunctions();
2namespace Global {
3virtual Script onExit(()) {}
4virtual Script onExit(()) {}
5virtual Script initializeEditors(()) {}
6virtual Script onStart(()) {}
7virtual Script parseArgs(()) {}
8virtual Script parseArgs(()) {}
9virtual Script loadKeybindings(()) {}
10virtual Script onExit(()) {}
11virtual Script onStart(()) {}
12virtual Script clearChat(()) {}
13virtual Script EnvDataManagerDlgCtrlDesc_AddGroundCover(( string internal_name, string name )) {}
14virtual Script constructNewColor(( string pickColor, string colorType )) {}
15virtual Script updateColorPickerAlpha(( string alphaVal )) {}
16virtual Script updateRGBValues(( string location )) {}
17virtual Script updatePickerBaseColor(( string location )) {}
18virtual Script DoColorPickerUpdateCallback(()) {}
19virtual Script DoColorPickerCancelCallback(()) {}
20virtual Script DoColorPickerCallback(()) {}
21virtual Script setColorInfo(()) {}
22virtual Script GetColorF(( string currentColor, string callback, string root, string updateCallback, string cancelCallback )) {}
23virtual Script GetColorI(( string currentColor, string callback, string root, string updateCallback, string cancelCallback )) {}
24virtual Script ColorIntToFloat(( string color )) {}
25virtual Script ColorFloatToInt(( string color )) {}
26virtual Script scheduleScreenshot(()) {}
27virtual Script cm_debug_print(( string msg )) {}
28virtual Script stopMusic(()) {}
29virtual Script startMusic(()) {}
30virtual Script createBrowserWindow(( string name, string profileName )) {}
31virtual Script createContainer(()) {}
32virtual Script DebugAddLayerToTop(( string val )) {}
33virtual Script togglePostFXManager(( string val )) {}
34virtual Script setCameraMode(( string mode )) {}
35virtual Script clientCmdSetCameraSpeed(( string val )) {}
36virtual Script setCameraSpeed(( string val )) {}
37virtual Script dropPlayerAtCamera(( string val )) {}
38virtual Script dropCameraAtPlayer(( string val )) {}
39virtual Script cycleDebugRenderMode(( string val )) {}
40virtual Script setZoomFOV(( string val )) {}
41virtual Script toggleZoomFOV(()) {}
42virtual Script doHindLegsBreak(()) {}
43virtual Script doHindLegs(( string val )) {}
44virtual Script turnRight(( string val )) {}
45virtual Script turnLeft(( string val )) {}
46virtual Script brake(( string val )) {}
47virtual Script brakeLights(()) {}
48virtual Script clientCmdVehicleMapOff(()) {}
49virtual Script clientCmdVehicleMapOn(()) {}
50virtual Script HB_Tab4_Slot0(( string val )) {}
51virtual Script HB_Tab4_Slot9(( string val )) {}
52virtual Script HB_Tab4_Slot8(( string val )) {}
53virtual Script HB_Tab4_Slot7(( string val )) {}
54virtual Script HB_Tab4_Slot6(( string val )) {}
55virtual Script HB_Tab4_Slot5(( string val )) {}
56virtual Script HB_Tab4_Slot4(( string val )) {}
57virtual Script HB_Tab4_Slot3(( string val )) {}
58virtual Script HB_Tab4_Slot2(( string val )) {}
59virtual Script HB_Tab4_Slot1(( string val )) {}
60virtual Script HB_Tab3_Slot0(( string val )) {}
61virtual Script HB_Tab3_Slot9(( string val )) {}
62virtual Script HB_Tab3_Slot8(( string val )) {}
63virtual Script HB_Tab3_Slot7(( string val )) {}
64virtual Script HB_Tab3_Slot6(( string val )) {}
65virtual Script HB_Tab3_Slot5(( string val )) {}
66virtual Script HB_Tab3_Slot4(( string val )) {}
67virtual Script HB_Tab3_Slot3(( string val )) {}
68virtual Script HB_Tab3_Slot2(( string val )) {}
69virtual Script HB_Tab3_Slot1(( string val )) {}
70virtual Script HB_Tab2_Slot0(( string val )) {}
71virtual Script HB_Tab2_Slot9(( string val )) {}
72virtual Script HB_Tab2_Slot8(( string val )) {}
73virtual Script HB_Tab2_Slot7(( string val )) {}
74virtual Script HB_Tab2_Slot6(( string val )) {}
75virtual Script HB_Tab2_Slot5(( string val )) {}
76virtual Script HB_Tab2_Slot4(( string val )) {}
77virtual Script HB_Tab2_Slot3(( string val )) {}
78virtual Script HB_Tab2_Slot2(( string val )) {}
79virtual Script HB_Tab2_Slot1(( string val )) {}
80virtual Script HB_Tab1_Slot0(( string val )) {}
81virtual Script HB_Tab1_Slot9(( string val )) {}
82virtual Script HB_Tab1_Slot8(( string val )) {}
83virtual Script HB_Tab1_Slot7(( string val )) {}
84virtual Script HB_Tab1_Slot6(( string val )) {}
85virtual Script HB_Tab1_Slot5(( string val )) {}
86virtual Script HB_Tab1_Slot4(( string val )) {}
87virtual Script HB_Tab1_Slot3(( string val )) {}
88virtual Script HB_Tab1_Slot2(( string val )) {}
89virtual Script HB_Tab1_Slot1(( string val )) {}
90virtual Script switchShowClaims(( string down )) {}
91virtual Script showClaims(( string down )) {}
92virtual Script mouseWheelRot(( string val )) {}
93virtual Script mouseWheelDown(()) {}
94virtual Script mouseWheelUp(()) {}
95virtual Script rightSwingHit(()) {}
96virtual Script leftSwingHit(()) {}
97virtual Script overheadHit(()) {}
98virtual Script thrustHit(()) {}
99virtual Script toggleCmEditGuiMode(( string down )) {}
100virtual Script ActivateVoiceChat(( string down )) {}
101virtual Script toggleCmFreelookMode(( string down )) {}
102virtual Script toggleWarstancePose(( string val )) {}
103virtual Script toggleHelpDlg(( string val )) {}
104virtual Script forceFirstPerson(()) {}
105virtual Script forceThirdPerson(()) {}
106virtual Script toggleFirstPerson(( string val )) {}
107virtual Script gamepadAltTrigger(( string val )) {}
108virtual Script gamepadFire(( string val )) {}
109virtual Script shieldBash(( string val )) {}
110virtual Script altTrigger(( string val )) {}
111virtual Script mouseFire(( string val )) {}
112virtual Script isWarState(()) {}
113virtual Script switchAutorun(( string val )) {}
114virtual Script gamepadPitch(( string val )) {}
115virtual Script gamepadYaw(( string val )) {}
116virtual Script gamePadMoveY(( string val )) {}
117virtual Script gamePadMoveX(( string val )) {}
118virtual Script jump(( string val )) {}
119virtual Script pitch(( string val )) {}
120virtual Script yaw(( string val )) {}
121virtual Script getGamepadAdjustAmount(( string val )) {}
122virtual Script getMouseAdjustAmount(( string val )) {}
123virtual Script panDown(( string val )) {}
124virtual Script panUp(( string val )) {}
125virtual Script movedown(( string val )) {}
126virtual Script movedown2(( string val )) {}
127virtual Script moveup(( string val )) {}
128virtual Script isOwnControlCamera(()) {}
129virtual Script movebackward(( string val )) {}
130virtual Script moveforward(( string val )) {}
131virtual Script moveright(( string val )) {}
132virtual Script moveleft(( string val )) {}
133virtual Script setSpeed(( string speed )) {}
134virtual Script doScreenShotHudless(( string val )) {}
135virtual Script hideHUDs(( string val )) {}
136virtual Script resetVolley(()) {}
137virtual Script setVolley(()) {}
138virtual Script resetAbility(()) {}
139virtual Script unbindAbility(()) {}
140virtual Script setAbility(()) {}
141virtual Script togglePixelize(( string val )) {}
142virtual Script bringUpOptions(( string val )) {}
143virtual Script peerCmdShowCharCreate(( string this )) {}
144virtual Script peerCmdCS(( string peer, string serverIP, string serverPort, string accountHash )) {}
145virtual Script clientRpcCS(( string peer )) {}
146virtual Script updatePatchedTerCounterGui(( string loadedTerCount, string totalTerCount )) {}
147virtual Script updateForestPatchingCounterGui(( string loadedTerCount, string totalTerCount )) {}
148virtual Script updateObjPatchingCounterGui(( string loadedTerCount, string totalTerCount )) {}
149virtual Script updateGeoPatchingCounterGui(( string loadedTerCount, string totalTerCount )) {}
150virtual Script updatePatchingCounterGui(( string patchedTerCount, string totalTerCount )) {}
151virtual Script onTcpDownloadProgress(( string downloaded, string toDownload )) {}
152virtual Script clientRpcOK(( string cs )) {}
153virtual Script connectToContentServer(()) {}
154virtual Script reconnectToContentServer(( string errorMessage )) {}
155virtual Script connectToGameServer(()) {}
156virtual Script onManagersInitDone(()) {}
157virtual Script initManagersOnCharSelected(( string callback )) {}
158virtual Script _postBattleCleanup(()) {}
159virtual Script peerCmdBTL(( string peer, string cmd, string serverIP, string serverPort, string geoID, string serverID )) {}
160virtual Script checkJoinToServer(()) {}
161virtual Script markStreamingReadyState(()) {}
162virtual Script _requestWorldSelection(()) {}
163virtual Script peerCmdWJ(( string peer, string cmd, string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9 )) {}
164virtual Script peerCmdJS(( string this )) {}
165virtual Script peerCmdSA(( string peer, string geoID, string address, string port, string serverID )) {}
166
167
168/*! Duplicated session is online, should wait for %a1 ms
169 */
170
171virtual Script peerCmdDS(( string peer, string cmd, string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9 )) {}
172
173
174/*! Target server offline
175 */
176
177virtual Script peerCmdSO(( string peer )) {}
178virtual Script relay(( string server, string callback )) {}
179virtual Script connectDispatcher(( string server )) {}
180virtual Script connect(( string server, string callback )) {}
181virtual Script connectToServer(( string serverID )) {}
182virtual Script requestCleanup(()) {}
183virtual Script onWindowClose(()) {}
184virtual Script disconnectManagers(()) {}
185virtual Script cleanupPatches(()) {}
186virtual Script cleanupGroundCovers(()) {}
187virtual Script _disconnectedCleanupMakeQuit(( string needQuit )) {}
188virtual Script _disconnectedCleanupFinalDone(( string needQuit )) {}
189virtual Script _disconnectedCleanupFinal(( string needQuit )) {}
190virtual Script disconnectedCleanup(( string needQuit )) {}
191virtual Script processDisconnect(( string needQuit )) {}
192virtual Script disconnectBase(( string needQuit, string fastStreamingShutdown )) {}
193virtual Script disconnectWithMessageBox(( string title, string message )) {}
194virtual Script disconnectQuit(()) {}
195virtual Script Disconnect(()) {}
196
197
198/*! Called from select char dlg (Exit button) and fromCharacterErrorMessage(DISCONNECT)
199 */
200
201virtual Script disconnectServer(()) {}
202virtual Script getIRSPMetrics(()) {}
203virtual Script connectToDebugTCPServer(()) {}
204virtual Script clientCmdDebugTCPServerIsOn(( string serverPort )) {}
205virtual Script listAllServers(()) {}
206virtual Script updateCanvasTitle(()) {}
207virtual Script handleConnectionErrorMessage(( string msgType, string msgString, string msgError )) {}
208virtual Script lag(( string lag )) {}
209virtual Script dropConnectionToServer(( string serverID )) {}
210virtual Script initiateNewConnection(( string serverID, string addr )) {}
211virtual Script clientCmdIrsp(( string cmd, string a1, string a2, string a3 )) {}
212virtual Script peerCmdIrc(( string server, string cmd, string a1, string a2, string a3 )) {}
213virtual Script peerCmdUrls(( string peer, string urlName, string url )) {}
214virtual Script onWorldCreated(()) {}
215virtual Script peerCmdConnectionEstablished(( string server )) {}
216virtual Script startConnection(( string addr )) {}
217virtual Script initConnection(()) {}
218virtual Script resuscitate(( string magnitude )) {}
219virtual Script createRest(( string duration, string healAmount )) {}
220virtual Script dealDamage(( string partOfBody )) {}
221virtual Script healAllBodyFracture(( string durationMultiplier )) {}
222virtual Script healAllWound(( string durationMultiplier )) {}
223virtual Script removeAllFracture(()) {}
224virtual Script removeAllBodyBleeding(()) {}
225virtual Script removeAllBodyWound(()) {}
226virtual Script createAllFracture(()) {}
227virtual Script createAllBodyBleeding(()) {}
228virtual Script createAllBodyWound(()) {}
229virtual Script healFracture(( string partOfBody, string durationMultiplier )) {}
230virtual Script healWound(( string partOfBody, string durationMultiplier )) {}
231virtual Script removeFracture(( string partOfBody )) {}
232virtual Script removeBleeding(( string partOfBody )) {}
233virtual Script removeWound(( string partOfBody )) {}
234virtual Script createFracture(( string partOfBody )) {}
235virtual Script createBleeding(( string partOfBody )) {}
236virtual Script createWound(( string partOfBody )) {}
237virtual Script peerCmdUpdateServerDebugRaycastHitbox(( string server, string newHitbox )) {}
238virtual Script cmChatSendLocalMessageToServer(( string position, string message )) {}
239virtual Script createBuildSelectionGui(()) {}
240virtual Script createChatTab(()) {}
241virtual Script CloseAnimalHusbandryDlg(()) {}
242virtual Script closeSelectionListDlg(()) {}
243virtual Script openSelectionListDlg(( string buttonText, string is_build )) {}
244virtual Script showSkillStatDlg(( string show_skill )) {}
245virtual Script closeSkillStatDlg(()) {}
246virtual Script showCharWindow(( string val )) {}
247virtual Script showSkill(( string val )) {}
248virtual Script createMessageWindowSettings(()) {}
249virtual Script performSailToAbella(()) {}
250virtual Script showAbellaTicketConsumptionDialog(()) {}
251virtual Script openQuestSailDialog(()) {}
252virtual Script MakeTimerStringPretty(( string timer )) {}
253virtual Script createSkinsApplyWindow(()) {}
254virtual Script createSkinsApplyElement(( string id, string icon, string header, string desc, string canBuy )) {}
255virtual Script createSkinsListWindow(()) {}
256virtual Script createSkinsListVerticalDivider(()) {}
257virtual Script createSkinsListElement(( string icon, string equipType, string combine )) {}
258virtual Script createSkinsSelectWindow(()) {}
259virtual Script createSkinsSelectDivider(()) {}
260virtual Script createSkinsSelectElement(( string icon, string header, string desc, string status )) {}
261virtual Script createDeathWindow(( string hasInsurance )) {}
262virtual Script DeathWindowAddSkillLost(( string skillID, string skillLostBasic, string skillLostInsurance )) {}
263virtual Script checkProgressBarChildVisible(( string pregressPos, string chuld )) {}
264virtual Script setProgressBar(( string val )) {}
265virtual Script hideProgressBar(()) {}
266virtual Script showProgressBar(()) {}
267virtual Script deleteBattleBar(()) {}
268virtual Script createBattleBar(()) {}
269virtual Script testBattleList(()) {}
270virtual Script addBattleInList(( string battleID, string isAttack, string guildName, string time )) {}
271virtual Script createBattleListWindow(()) {}
272virtual Script testBattle(()) {}
273virtual Script addUserinList(( string parent, string id, string name, string prefix, string isPending, string isAttacker, string atkLeaderMode, string defLeaderMode, string viewerId )) {}
274virtual Script createBattleUserList(( string parent, string prefixName, string lblText )) {}
275virtual Script createBattleSideControl(( string parent, string prefixName, string icon )) {}
276virtual Script createBattleWindow(( string battle, string atkLeader, string defLeader )) {}
277virtual Script questTasks_debugAddTask(( string questId )) {}
278virtual Script questTasks_debugAdd(()) {}
279virtual Script questTasks_updateQuestTaskProps(( string taskItem )) {}
280virtual Script questTasks_setQuestItemName(( string questNameCtrl, string isActiveQuest )) {}
281virtual Script getCurrentQuestTaskNameText(( string textId, string textWidth )) {}
282virtual Script getIncompletedQuestTaskNameText(( string textId, string textWidth )) {}
283virtual Script getCompletedQuestTaskNameText(( string textId, string textWidth )) {}
284virtual Script getHighlightedQuestNameText(( string textId )) {}
285virtual Script getInactiveQuestNameText(( string textId )) {}
286virtual Script getActiveQuestNameText(( string textId )) {}
287virtual Script closeQuestTaskDescriptionWindow(()) {}
288virtual Script questTask_ShowQuestTaskDescription(( string description )) {}
289virtual Script questTask_ShowQuestTaskOnMap(( string taskId )) {}
290virtual Script questTasks_deleteQuest(( string questId )) {}
291virtual Script questTask_setQuestTaskStatus(( string questId, string taskId, string taskStatus )) {}
292virtual Script questTasks_setQuestActive(( string questId )) {}
293virtual Script questTask_addQuestTask(( string questId, string taskId, string taskName, string taskStatus, string taskDescription, string hasMapButton )) {}
294virtual Script questTask_addQuest(( string questId, string questName, string questIcon )) {}
295virtual Script deleteQuestTasksWindowProfiles(()) {}
296virtual Script createQuestTasksWindowProfiles(()) {}
297virtual Script closeQuestTasksWindow(()) {}
298virtual Script createQuestTasksWindow(()) {}
299virtual Script getQuestAnswerHighlightText(( string textId )) {}
300virtual Script getQuestAnswerNormalText(( string textId )) {}
301virtual Script getQuestGiverNameText(( string textId )) {}
302virtual Script clearQuestDialogAnswers(()) {}
303virtual Script addQuestDialogAnswer(( string answerId, string textId )) {}
304virtual Script setQuestDialogParameters(( string questSubject, string questGiverName, string questGiverType, string questGiverAvatar, string prevQuestText, string currentQuestText )) {}
305virtual Script deleteQuestDialogWindowProfiles(()) {}
306virtual Script createQuestDialogWindowProfiles(()) {}
307virtual Script closeQuestDialogWindow(()) {}
308virtual Script createQuestDialogWindow(()) {}
309virtual Script QuestFerryManSelectionSelected(()) {}
310virtual Script QuestFerryManSelectionDownPressed(()) {}
311virtual Script QuestFerryManSelectionUpPressed(()) {}
312virtual Script closeQuestFerryManSelectionDialog(()) {}
313virtual Script openQuestFerryManSelectionDialog(()) {}
314virtual Script horseTrainingDlgSetScore(( string score )) {}
315virtual Script closeHorseTrainingDlg(()) {}
316virtual Script openHorseTrainingDlg(( string timer )) {}
317virtual Script createHorseTrainingDlg(()) {}
318virtual Script runMoveBySpline(( string index )) {}
319virtual Script getRecordPointText(( string pt )) {}
320virtual Script addPlayerPosAndCameraRotationAsPoint(( string dialogStack, string pos, string rot )) {}
321virtual Script deleteRecordPointsProfiles(()) {}
322virtual Script createRecordPointsProfiles(()) {}
323virtual Script showRecordSplineKnotsDialog(()) {}
324virtual Script showRecordPointsDialog(()) {}
325virtual Script createTradePostRenameDialog(()) {}
326virtual Script createChangeStoreSizeDialog(( string storeWeight, string paymentStoreSize, string bonusStoreSize )) {}
327virtual Script createPayForStorePopUpScroll(()) {}
328virtual Script showSplitSupportCoinsDialog(()) {}
329virtual Script addInfoToSplitSupportCoinsDialog(( string coinTypeName, string coinTypeId )) {}
330virtual Script createPayForStoreDialog(()) {}
331virtual Script showChangeStoreSizeDialog(( string storeWeight, string paymentStoreSize, string bonusStoreSize )) {}
332virtual Script closePayForStoreDialog(()) {}
333virtual Script closeChangeStoreSizeDialog(()) {}
334virtual Script createSplitSupportCoinsDialog(()) {}
335virtual Script deleteTradePostProfiles(()) {}
336virtual Script createTradePostProfiles(()) {}
337virtual Script createTradePostWindow(()) {}
338virtual Script onTutorialScrollDownButtonClick(()) {}
339virtual Script closeTutorialInfoHint(()) {}
340virtual Script closeTutorialSimpleHint(()) {}
341virtual Script closeTutorialHintWindow(()) {}
342virtual Script addTutorialHintImage(( string picPath )) {}
343virtual Script addTutorialHintSpacing(( string pixels )) {}
344virtual Script addTutorialHintTextContent(( string textId )) {}
345virtual Script updateTutorialHintContent(()) {}
346virtual Script showTutorialHintWindow(()) {}
347virtual Script createTutorialInfoHintWindow(()) {}
348virtual Script createTutorialSimpleHintWindow(()) {}
349virtual Script deleteTutorialHintProfiles(()) {}
350virtual Script createTutorialHintProfiles(()) {}
351virtual Script createTutorialHintWindow(()) {}
352virtual Script UpdateHeraldryTimer(( string HeraldryButton )) {}
353virtual Script StopHeraldryTimer(( string HeraldryButton )) {}
354virtual Script StartHeraldryTimer(( string HeraldryButton )) {}
355virtual Script closeResizeClaimWindow(()) {}
356virtual Script showResizeClaimWindow(()) {}
357virtual Script findStatValText(( string parent )) {}
358virtual Script addStatInfo(( string val, string txt )) {}
359virtual Script addItemDescription(( string informer )) {}
360virtual Script addSkillInfo(( string colName, string colVal, string informer )) {}
361virtual Script createItemRegion(( string informer )) {}
362virtual Script findExeconTimer(( string parent )) {}
363virtual Script createEffectCtrl(( string pnl, string effect, string magnitude, string positive )) {}
364virtual Script addItemEffects(( string informer, string effectGroup, string effectGroupMagnitude, string effectGroupPositive )) {}
365virtual Script createItemsFeatureEffect(( string informer )) {}
366virtual Script createItemsDurability(( string parent, string imageIndex, string informer )) {}
367virtual Script createItemsQWD(( string informer )) {}
368virtual Script createItemsQW(( string informer )) {}
369virtual Script createItemsWeight(( string informer )) {}
370virtual Script createItemsQQW(( string informer )) {}
371virtual Script createIconText(( string parent, string imageIndex, string text )) {}
372virtual Script createIconPnl(( string parent, string imageIndex )) {}
373virtual Script addRowTooltipinfo(( string colName, string colVal, string name, string val )) {}
374virtual Script createContainersWeight(( string informer )) {}
375virtual Script createContainersName(( string informer )) {}
376virtual Script createObjectsTypesName(( string informer )) {}
377virtual Script createDoubleTextCtrl(( string profile )) {}
378virtual Script createVerticalStackControl(()) {}
379virtual Script createHorizontalStackControl(()) {}
380virtual Script createTextCtrl(( string profile, string text )) {}
381virtual Script createCaptionTextCtrl(()) {}
382virtual Script createMLTextCtrl(()) {}
383virtual Script createImageCtrl(( string imageIndex )) {}
384virtual Script calcTooltipPosition(( string cursorPosX, string cursorPosY, string windowSizeX, string windowSizeY )) {}
385virtual Script createBaseTooltip(()) {}
386virtual Script PersonalClaimShowBuyButton(( string val )) {}
387virtual Script createPersonalClaimWindow(()) {}
388virtual Script userWantsToExit(( string type )) {}
389virtual Script closeExitTimerDlg(()) {}
390virtual Script openExitTimerDlg(( string seconds, string finishCommand )) {}
391virtual Script onControlObjectDead(()) {}
392virtual Script onExitTimerAutoclose(()) {}
393virtual Script onExitTimerCancelPressed(()) {}
394virtual Script onExitTimerExitPressed(()) {}
395virtual Script showGameSettingsDlg(()) {}
396virtual Script createGameSettingsDlg(()) {}
397virtual Script HeraldryDialogSetCharge(( string num, string imageIndex, string position, string size, string color )) {}
398virtual Script HeraldryDialogSetBackground(( string fillTypeIndex, string color1, string color2 )) {}
399virtual Script HeraldryShowLog(()) {}
400virtual Script createHeraldrySettingDialogProfiles(()) {}
401virtual Script createHeraldrySettingDialog(()) {}
402virtual Script addHeraldrySymbolInTable(( string parent, string imageIndex, string nameIndex, string stateOn )) {}
403virtual Script getHeraldrySymbolName(( string imageName )) {}
404virtual Script addHeraldryFillTypeInTable(( string parent, string imageIndex, string stateOn )) {}
405virtual Script getHeraldryFillTypeName(( string imageName )) {}
406virtual Script createHeraldrySymbolPanel(( string name )) {}
407virtual Script createFillTypePanel(( string name )) {}
408virtual Script onColorClick(( string this )) {}
409virtual Script hideHeraldry(()) {}
410virtual Script showHeraldry(()) {}
411virtual Script showSymbols(()) {}
412virtual Script showfillType(()) {}
413virtual Script addEmblemColorButton(( string pnl, string pos, string colorIndex, string colorName, string pnlIndex )) {}
414virtual Script deleteHeraldryWindowProfiles(()) {}
415virtual Script createHeraldryWindowProfiles(()) {}
416virtual Script createHeraldry(()) {}
417virtual Script applyRenamePreset(( string new_preset_name, string cur_name_preset, string cur_name_menu )) {}
418virtual Script setNewPresetName(( string new_preset_name )) {}
419virtual Script createNewPreset(( string name_preset, string name_menu )) {}
420virtual Script createNewPresetCopyFrom(( string new_preset, string cur_preset, string name_menu )) {}
421virtual Script copyObjToPath(( string old_path, string new_path )) {}
422virtual Script deleteAllPresetFile(( string preset_path )) {}
423virtual Script checkDefHotBarPresetPath(()) {}
424virtual Script setStateCheckBox(( string old_check_box, string new_check_box )) {}
425virtual Script setDefaultHotBarPreset(( string name_preset )) {}
426virtual Script checkHotBarPresetCheckBox(( string name_preset )) {}
427virtual Script setDefaultHUDPreset(( string name_preset )) {}
428virtual Script checkDefaultHUDPreset(( string name_preset )) {}
429virtual Script setCheckBoxHUDPreset(( string name_preset )) {}
430virtual Script resetCurHudPreset(()) {}
431virtual Script resetPreset(( string name_preset, string name_menu )) {}
432virtual Script deletePreset(( string name_preset, string name_menu )) {}
433virtual Script loadObjectPropertyXml(( string object, string file_name )) {}
434virtual Script saveObjectPropertyXml(( string object, string file_name )) {}
435virtual Script saveGui(()) {}
436virtual Script saveHotBar(()) {}
437virtual Script loadAllGuiProperty(( string only_pos )) {}
438virtual Script loadHotBarData(()) {}
439virtual Script loadGui(()) {}
440virtual Script createClaimTileLegendItems(( string stackCtrl )) {}
441virtual Script createTileLegendItems(( string stackCtrl )) {}
442virtual Script createTilesLegendItem(( string tileImageIndex, string tileDescrText )) {}
443virtual Script renamePreset(( string menu_name, string preset_name )) {}
444virtual Script ApplyBindQueue(()) {}
445virtual Script CancelOptionsControlsDlg(()) {}
446virtual Script ShowOptionsControls(()) {}
447virtual Script createOptionsControlsDlg(()) {}
448virtual Script restartMusic(()) {}
449virtual Script OptAudioUpdateVoiceChatVolume(( string volume )) {}
450virtual Script OptAudioUpdateChannelVolume(( string description, string volume )) {}
451virtual Script OptAudioUpdateMasterVolume(( string volume )) {}
452virtual Script addOptionsAudiArrowSlider(( string id_label, string slider_range, string slider_name, string slider_command )) {}
453virtual Script createOptionsAudioDlg(()) {}
454virtual Script addArrowSlider(( string id_label, string slider_range, string slider_name, string slider_command, string text_edit_name, string text_edit_command, string id_descrip )) {}
455virtual Script addCheckBox(( string id_label, string id_descrip, string name_check_box, string command_check_box )) {}
456virtual Script addCheckBoxRow(( string id_label_left, string id_descrip_left, string name_check_box_left, string command_check_box_left, string id_label_right, string id_descrip_right, string name_check_box_right, string command_check_box_right )) {}
457virtual Script addDropDown(( string id_label, string popup_name, string popup_command )) {}
458virtual Script changePreset(( string preset )) {}
459virtual Script toggleBorderlessWindow(()) {}
460virtual Script _makePrettyResString(( string resString )) {}
461virtual Script createOptionsVideoDlg(()) {}
462virtual Script updateTrebuchetRopeAngle(()) {}
463virtual Script createTrebuchetWindow(()) {}
464virtual Script createBarterWindow(()) {}
465virtual Script CharSelectionCreatePressed(()) {}
466virtual Script checkChilSkillSlider(( string parentSlider, string childSlider )) {}
467virtual Script clearSliders(()) {}
468virtual Script SetAssaulterRange(( string min, string max )) {}
469virtual Script SetSlingerRange(( string min, string max )) {}
470virtual Script SetFootmanRange(( string min, string max )) {}
471virtual Script SetMilitiaRange(( string min, string max )) {}
472virtual Script SetCavalrymanRange(( string min, string max )) {}
473virtual Script SetHuntingRange(( string min, string max )) {}
474virtual Script SetNatureloreRange(( string min, string max )) {}
475virtual Script SetConstructRange(( string min, string max )) {}
476virtual Script SetArtisanRange(( string min, string max )) {}
477virtual Script SetIntelligenceRange(( string min, string max )) {}
478virtual Script SetWillpowerRange(( string min, string max )) {}
479virtual Script SetConstitutionRange(( string min, string max )) {}
480virtual Script SetAgilityRange(( string min, string max )) {}
481virtual Script SetStrenghtRange(( string min, string max )) {}
482virtual Script createRandomizeButton(( string command )) {}
483virtual Script createDropBox(( string popUpMenuName, string caption )) {}
484virtual Script createColorSlider(( string sliderName, string colorName, string caption )) {}
485virtual Script createTextEditSlider(( string caption, string slider_name, string text_value_name )) {}
486virtual Script createSimpleSlider(( string sliderName, string caption, string range )) {}
487virtual Script createEditBox(( string editBoxName, string caption, string maxLength )) {}
488virtual Script createNamedStackControl(( string caption )) {}
489virtual Script createPopUpScroll(()) {}
490virtual Script createComboStackCombatSkills(( string combo_stack_ctrl, string group_num )) {}
491virtual Script createComboStackCraftingSkills(( string combo_stack_ctrl, string group_num )) {}
492virtual Script createComboStackAttributes(( string combo_stack_ctrl, string group_num )) {}
493virtual Script createComboStackSettingAppearance(( string combo_stack_ctrl, string group_num )) {}
494virtual Script createComboStackRace(( string combo_stack_ctrl, string group_num )) {}
495virtual Script createCharRaceButton(( string name, string text, string defaultState )) {}
496virtual Script createComboStackSex(( string combo_stack_ctrl, string group_num )) {}
497virtual Script createComboStackName(( string combo_stack_ctrl, string group_num )) {}
498virtual Script createComboStackItem(( string combo_stack_ctrl, string name, string pnl_height, string group_num, string image, string is_race )) {}
499virtual Script createWindowCreateCharacter(()) {}
500virtual Script fadeScreen(( string fade )) {}
501virtual Script togglSettingsMenu(( string show )) {}
502virtual Script toggleEscMenu(( string show )) {}
503virtual Script hideEscMenu(()) {}
504virtual Script showEscMenuOptions(()) {}
505virtual Script showEscMenu(()) {}
506virtual Script setBuildName(( string name )) {}
507virtual Script createBuildComponentsItem(( string key )) {}
508virtual Script hideCharacterSelectionDialog(()) {}
509virtual Script showCharacterSelectionDialog(()) {}
510virtual Script initManagersOnCreatePlayer(()) {}
511virtual Script createStatFrame(( string handle, string nameId, string icon )) {}
512virtual Script createCharSlotButton(( string internalName )) {}
513virtual Script endIntro(()) {}
514virtual Script showLifeIsFeudalIntro(()) {}
515virtual Script showXsollaIntro(()) {}
516virtual Script showBitboxIntro(()) {}
517virtual Script createIntroWindow(( string videoFile, string command )) {}
518virtual Script createBuildWindow(()) {}
519virtual Script createAuthorityWindowProfiles(()) {}
520virtual Script createAuthorityWindow(( string is_manager, string typeid )) {}
521virtual Script MessageBoxYesNoOld(( string title, string message, string yesCallback, string noCallback )) {}
522virtual Script MessageBoxOKCancelOld(( string title, string message, string callback, string cancelCallback )) {}
523virtual Script MessageBoxOKOld(( string title, string message, string callback )) {}
524virtual Script CmTerminateMessageDialogue(( string messageIDToDelete )) {}
525virtual Script CmSetDialogueMessageID(( string messageID )) {}
526virtual Script MessageIDBoxDlg(( string dialog, string title, string message, string btn1Callback, string btn1Caption, string btn2Callback, string btn2Caption, string btn3Callback, string btn3Caption, string timer )) {}
527virtual Script CmMessageIDBoxClose(()) {}
528virtual Script CmMessageIDBox(( string title, string message, string btnCallback, string btn1Caption, string btn2Caption, string btn3Caption, string closeBtnIndex, string timer )) {}
529virtual Script setBtnCenterXPos(( string btn )) {}
530virtual Script setBtnPos(( string btn, string x )) {}
531virtual Script MBIDSetText(( string text, string frame, string msg )) {}
532virtual Script MessageBoxYesNoCancel(( string title, string message, string yesCallback, string noCallback, string cancelCallback )) {}
533virtual Script MessageBoxYesNo(( string title, string message, string yesCallback, string noCallback )) {}
534virtual Script MessageBoxOKCancel(( string title, string message, string callback, string cancelCallback )) {}
535virtual Script MessageBoxOK(( string title, string message, string callback )) {}
536virtual Script MBSetText(( string text, string frame, string msg )) {}
537virtual Script messageCallback(( string dlg, string callback )) {}
538virtual Script InputCancel(( string guiContent )) {}
539virtual Script InputCancelCmd(( string guiContent, string commandName )) {}
540virtual Script InputOK(( string guiContent, string commandName )) {}
541virtual Script MessageBoxRenameContainer(()) {}
542virtual Script MessageBoxDelchar(( string slot )) {}
543virtual Script CharSelectionDelcharOK(( string slot, string givenText )) {}
544virtual Script CharSelectionDelcharDoubleCheck(( string slot, string givenText )) {}
545virtual Script ShowNameBoxInput(( string command_name )) {}
546virtual Script createMessageBoxInputText(( string command_name, string cancelCommandName, string caption, string label )) {}
547virtual Script createMessageIDBoxDlg(( string MessageBoxName )) {}
548virtual Script createBreedingHorizontalStack(( string mainStack )) {}
549virtual Script createBreedingVerticalStack(( string mainStack )) {}
550virtual Script createAnimalHusbandryVerticalSplitter(( string parent )) {}
551virtual Script createAnimalHusbandryHorizontalSplitter(( string parent )) {}
552virtual Script createAnimalHusbandryBreedingSlot(( string index )) {}
553virtual Script createAnimalHusbandryDeed(()) {}
554virtual Script createAnimalHusbandryBreedingPanel(()) {}
555virtual Script createAnimalHusbandry(()) {}
556virtual Script addEventMsgInfoWindow(( string text, string type )) {}
557virtual Script createMsgEventWindow(()) {}
558virtual Script msgEventWindowDefaultProperty(()) {}
559virtual Script setAnimatePos(( string wnd, string maxY )) {}
560virtual Script MsgStackCommand(( string type )) {}
561virtual Script addMsgStackInfoWindow(( string text, string type )) {}
562virtual Script createMsgStackInfoWindow(()) {}
563virtual Script msgStackInfoWindowDefaultProperty(()) {}
564virtual Script addMsgInfoWindow(( string text, string important, string type )) {}
565virtual Script createMessageWindow(( string pos, string ext, string saveFileName, string autoWidth, string msgCount )) {}
566virtual Script onContextMenuDown(( string container )) {}
567virtual Script onContextMenuUp(( string container )) {}
568virtual Script showMenuDecor(( string decor, string menu_item, string is_left, string is_def, string is_sub )) {}
569virtual Script createContextMenuDecor(( string parent, string is_left, string is_sub )) {}
570virtual Script createGroupWidgetButton(( string menu, string text, string group )) {}
571virtual Script addInGroupAbilityWidgetButton(( string menu, string text, string skillID, string image )) {}
572virtual Script createSingleAbilityWidgetButton(( string menu, string text, string image )) {}
573virtual Script createDefaultAbilityWidgetButton(( string menu, string text )) {}
574virtual Script createAbilityWidgetButton(( string menu )) {}
575virtual Script createGroupAbilitysStack(( string skillID, string image )) {}
576virtual Script createContextMenuContainer(( string main_pnl, string pos )) {}
577virtual Script createContextSubMenuContainer(( string main_pnl, string pos )) {}
578virtual Script createAbilityWidget(( string menu_pos, string full_screen )) {}
579virtual Script Lif_ContextMenu_OnPressedContext(( string val )) {}
580virtual Script Lif_ContextMenu_OnPressedDefault(( string val )) {}
581virtual Script checkGuildTagAndNameCtrl(()) {}
582virtual Script applyGuildName(()) {}
583virtual Script cancelGuildNameEditMode(()) {}
584virtual Script setGuildNameEditMode(()) {}
585virtual Script checkGuildNameEditMode(( string state )) {}
586virtual Script safeClearChilds(( string pnl )) {}
587virtual Script disableBtnForNewbieWorld(( string btn )) {}
588virtual Script createMMOGuildCtrl(( string parent )) {}
589virtual Script createPopUpTitleScroll(()) {}
590virtual Script RecipesClick(( string skillInfo )) {}
591virtual Script UsableItemsClick(( string skillInfo )) {}
592virtual Script SkillLvl100Click(( string skillPnl )) {}
593virtual Script SkillLvl90Click(( string skillPnl )) {}
594virtual Script SkillLvl60Click(( string skillPnl )) {}
595virtual Script SkillLvl30Click(( string skillPnl )) {}
596virtual Script SkillLvl0Click(( string skillPnl )) {}
597virtual Script setUnknownSkillBorder(( string btnSkillLvl )) {}
598virtual Script setKnownSkillBorder(( string btnSkillLvl )) {}
599virtual Script createSkillInfo(()) {}
600virtual Script createSkillLvlControl(( string skillInfo )) {}
601virtual Script createAbilityInfoControl(( string skillInfo, string id, string icon, string name, string desc )) {}
602virtual Script createRecipeItemsTable(( string skillInfo )) {}
603virtual Script additemsIconInTable(( string skillInfo, string icon )) {}
604virtual Script createSkillMapPnl(( string parent, string skillGroup )) {}
605virtual Script GetBoosterSku(( string type )) {}
606virtual Script showAlignmentBar(()) {}
607virtual Script showHungerBar(()) {}
608virtual Script showStaminaBar(()) {}
609virtual Script showHealthBar(()) {}
610virtual Script updateMaxSkillcap(( string max_val1, string max_val2, string max_val3 )) {}
611virtual Script updateSkillcap(( string cur_val, string max_val, string skill_group )) {}
612virtual Script showGuild(()) {}
613virtual Script showSkills(()) {}
614virtual Script showStats(()) {}
615virtual Script addSkill(( string skillPanel, string skillTypeId, string skillInfo )) {}
616virtual Script addSkills(( string skillPanel, string groupSkill, string skillInfo )) {}
617virtual Script getSkillItemPosition(( string skill_type_id )) {}
618virtual Script getSkillLinePosition(( string skillPanel, string skillCtrl, string skillTypeId )) {}
619virtual Script createSkillItem(( string skillInfo )) {}
620virtual Script addSkillLine(( string parent, string pos, string len )) {}
621virtual Script createCraftingComponentsPanel(()) {}
622virtual Script createCraftingComponentPanel(( string name )) {}
623virtual Script createCraftWindow(()) {}
624virtual Script setEquipCountText(( string textCtrl, string val )) {}
625virtual Script resetHighlightSlot(( string slot_ctrl, string slot )) {}
626virtual Script setHighlightSlot(( string slot_ctrl, string slot )) {}
627virtual Script showSkinsList(()) {}
628virtual Script showSkinsWindow(( string slotId )) {}
629virtual Script showHideMiniCharWindow(()) {}
630virtual Script createEquipmentWindow(()) {}
631virtual Script createCharParamStatsPnl(()) {}
632virtual Script closeCharacterWindow(()) {}
633virtual Script setTabIcon(( string tabBitmap, string iconName )) {}
634virtual Script showSocial(()) {}
635virtual Script showStatEqip(()) {}
636virtual Script showMinorSkills(()) {}
637virtual Script showCombatSkills(()) {}
638virtual Script showCraftingSkills(()) {}
639virtual Script socialClick(()) {}
640virtual Script equipStatsClick(()) {}
641virtual Script MinorSkillsClick(()) {}
642virtual Script combatSkillsClick(()) {}
643virtual Script craftingSkillsClick(()) {}
644virtual Script showCharacterWindowSelectedTabDecor(( string selectTab )) {}
645virtual Script createCharacterWindow(()) {}
646virtual Script toggleMap(( string val )) {}
647virtual Script createGuiMapWindow(()) {}
648virtual Script createHotBarWindow(()) {}
649virtual Script createHotBarTabBook(()) {}
650virtual Script initCraftworkBrewingTankOptionsDlg(( string maxProductCount, string bitmap )) {}
651virtual Script openProspectingRadiusDialog(( string minRadius, string maxRadius, string caption, string label, string bitmap )) {}
652virtual Script ShowInventory(( string val )) {}
653virtual Script showSplitStackItemDialog(( string quantity1, string max_stack_size1, string quantity2, string max_stack_size2, string bitmap, string name )) {}
654virtual Script updateVersionBarText(()) {}
655virtual Script refreshCenterTextCtrl(()) {}
656virtual Script refreshBottomTextCtrl(()) {}
657virtual Script closeCreditsWindow(()) {}
658virtual Script createCreditsWindow(()) {}
659virtual Script onServerQueryStatus(( string status, string msg, string value )) {}
660virtual Script showDirectConnectDialog(( string maxPwdLen, string callbackFunctionName )) {}
661virtual Script showPasswordDialog(( string descr, string maxPwdLen, string callbackFunctionName )) {}
662virtual Script updateJudgementHourInfo(( string startTime, string duration, string weekShedule )) {}
663virtual Script updateAdditionalServerInfo(( string SkillsStatsMult, string Skillcap, string TerraformingSpeed, string CraftingPeriod, string AnimalBFPeriod, string DayCycle, string AnimalsCount, string ObjectDecayRate )) {}
664virtual Script updateMainServerInfo(( string pName, string bLocked, string nPlayersCount, string nMaxPlayersCount, string nLatency )) {}
665virtual Script createServerItem(( string nId, string bLocked, string pName, string nPlayersCount, string nMaxPlayersCount, string nLatency )) {}
666virtual Script updateServerListButtonSortType(( string btn, string imageSortIndex, string buttonSortType )) {}
667virtual Script setServerListSortType(( string buttonId )) {}
668virtual Script clearButtonSortType(( string buttonId )) {}
669virtual Script getSortButtonById(( string buttonId )) {}
670virtual Script createServerList(( string serverListName, string bVisible )) {}
671virtual Script createJoinWorldWindow(()) {}
672virtual Script createCreateWorldWindow(()) {}
673virtual Script createMainMenuMultiplayerWindow(()) {}
674virtual Script createSubtitlesTheoraCtrl(( string videoFile, string command, string internalName )) {}
675virtual Script showHorseBar(( string show )) {}
676virtual Script setHorseBar(( string hp, string stamina )) {}
677virtual Script createHorseGUI(()) {}
678virtual Script setOxygenBar(( string val )) {}
679virtual Script createOxygenBar(()) {}
680virtual Script setStaminaBar(( string firstVal, string secondVal, string max )) {}
681virtual Script createStaminaBar(()) {}
682virtual Script setHealthBar(( string firstVal, string secondVal, string max )) {}
683virtual Script createHPBar(()) {}
684virtual Script setHungerBar(( string val )) {}
685virtual Script createHungerBar(()) {}
686virtual Script changeBarValues(( string barCtrl, string val, string maxVal )) {}
687virtual Script updateBarLayout(( string barCtrl )) {}
688virtual Script closeGroupUnitWindow(()) {}
689virtual Script clearUnitMemberWidgets(()) {}
690virtual Script createUnitMemberBar(( string barName, string barImageIndex )) {}
691virtual Script createUnitMemberWidget(( string unitName, string unitIcon )) {}
692virtual Script createUnitWindow(()) {}
693virtual Script updateControlsComboStep(( string comboStep, string bMaximized )) {}
694virtual Script createComboStep(()) {}
695virtual Script deleteCombosWindow(()) {}
696virtual Script closeCombosWindow(()) {}
697virtual Script createCombosWindow(()) {}
698virtual Script deleteAlignmentBar(()) {}
699virtual Script closeAlignmentBar(()) {}
700virtual Script createAlignmentBar(()) {}
701virtual Script closeTargetBar(()) {}
702virtual Script createTargetBar(()) {}
703virtual Script calcCritWeaponWeight(( string informer )) {}
704virtual Script calcDefence(( string informer )) {}
705virtual Script calcMaxMinOHDmg(( string informer, string data_block )) {}
706virtual Script calcMaxMinSwingDmg(( string informer, string data_block )) {}
707virtual Script calcMaxMinThrustDmg(( string informer, string data_block )) {}
708virtual Script calcMaxMinDmg(( string informer, string data_block, string index, string factor )) {}
709virtual Script createWillpowerTooltip(( string informer )) {}
710virtual Script createIntelectTooltip(( string informer )) {}
711virtual Script createConstitutionTooltip(( string informer )) {}
712virtual Script createAgilityTooltip(( string informer )) {}
713virtual Script createStrengthTooltip(( string informer )) {}
714virtual Script createWoundTooltip(( string informer )) {}
715virtual Script createEffectTooltip(( string informer )) {}
716virtual Script createTextTooltip(( string informer )) {}
717virtual Script createNameTooltip(( string informer )) {}
718virtual Script createBlueprintTooltip(( string informer )) {}
719virtual Script createHorsesTooltip(( string informer )) {}
720virtual Script createOutfitsTooltip(( string informer )) {}
721virtual Script createArmorTooltip(( string informer )) {}
722virtual Script createShieldsTooltip(( string informer )) {}
723virtual Script createAmmoWeaponTooltip(( string informer )) {}
724virtual Script createRangedWeaponTooltip(( string informer )) {}
725virtual Script createMeleeWeaponTooltip(( string informer )) {}
726virtual Script createGameplayObjectsTooltip(( string informer )) {}
727virtual Script createCraftToolsEquipmentTooltip(( string informer )) {}
728virtual Script createBagTooltip(( string informer )) {}
729virtual Script createAlchemyTooltip(( string informer )) {}
730virtual Script fillTooltipTemplate(()) {}
731virtual Script setAdvancedLighting(()) {}
732virtual Script onDeactivateAdvancedLM(()) {}
733virtual Script onActivateAdvancedLM(()) {}
734virtual Script unlockShadowViz(()) {}
735virtual Script lockShadowViz(()) {}
736
737
738/*!  For convenience, push the viz dialog and set the light manually from the console.
739 */
740
741virtual Script showShadowVizForLight(( string light )) {}
742
743
744/*!  Called from the WorldEditor when an object is selected.
745 */
746
747virtual Script _setShadowVizLight(( string light, string force )) {}
748
749
750/*!  Toggles the visualization of the pre-pass lighting buffer.
751 */
752
753virtual Script toggleShadowViz(()) {}
754
755
756/*!  Toggles the visualization of the AL lighting specular power buffer.
757 */
758
759virtual Script toggleLightSpecularViz(( string enable )) {}
760
761
762/*!  Toggles the visualization of the AL lighting color buffer.
763 */
764
765virtual Script toggleLightColorViz(( string enable )) {}
766
767
768/*!  Toggles the visualization of the AL normals buffer.
769 */
770
771virtual Script toggleNormalsViz(( string enable )) {}
772
773
774/*!  Toggles the visualization of the AL depth buffer.
775 */
776
777virtual Script toggleDepthViz(( string enable )) {}
778virtual Script onLightManagerDeactivate(( string lmName )) {}
779virtual Script onLightManagerActivate(( string lmName )) {}
780virtual Script initLightingSystems(()) {}
781virtual Script initRenderManager(()) {}
782virtual Script clientCmdGhostAllGhostAlwaysReceived(()) {}
783virtual Script onGhostAlwaysObjectReceived(()) {}
784virtual Script onGhostAlwaysStarted(( string ghostCount )) {}
785virtual Script updateStreamingProgress(()) {}
786virtual Script onStreamingEndLoad(()) {}
787virtual Script onStreamingBeginLoad(()) {}
788virtual Script onStreamingEndFastLoad(()) {}
789virtual Script onStreamingBeginFastLoad(()) {}
790virtual Script onStreamingEndReloadWorld(( string callback )) {}
791virtual Script onStreamingBeginReloadWorld(()) {}
792virtual Script onStreamingEndInitialLoadWorld(( string callback )) {}
793virtual Script onStreamingBeginInitialLoadWorld(()) {}
794virtual Script updateGMtext(()) {}
795virtual Script clientCmdReadyStateAck(()) {}
796virtual Script clientDestroyWorld(()) {}
797virtual Script clientReloadWorld(( string geoID, string callback )) {}
798virtual Script clientCreateWorld(( string geoID, string callback )) {}
799virtual Script defaultMessageCallback(( string msgType, string msgString, string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10 )) {}
800virtual Script onServerMessage(( string a, string b, string c, string d, string e, string f, string g, string h, string i )) {}
801virtual Script addMessageCallback(( string msgType, string func )) {}
802virtual Script clientCmdServerMessage(( string msgType, string msgString, string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10 )) {}
803virtual Script clientCmdChatMessage(( string sender, string voice, string pitch, string msgString, string a1, string a2, string a3, string a4, string a5, string a6, string a7, string a8, string a9, string a10 )) {}
804virtual Script cm_config_CalcPlayerPostHitTimeScale(( string lvl )) {}
805virtual Script cm_config_CalcPlayerHitTimeScale(( string lvl )) {}
806virtual Script showWelcomeMessage(()) {}
807virtual Script cmJoinDefaultChats(()) {}
808virtual Script initManagers(()) {}
809virtual Script initClient(()) {}
810virtual Script setLoadingGuiText(( string text )) {}
811virtual Script updateLoadingTextProgress(()) {}
812virtual Script loadLoadingGui(( string text )) {}
813virtual Script changeTooltipText(()) {}
814virtual Script deleteLoadingGui(()) {}
815virtual Script createLoadingGui(()) {}
816virtual Script netSimulateLag(( string msDelay, string packetLossPercent )) {}
817
818
819/*!  A helper function which will return the ghosted client object
820 from a server object when connected to a local server.
821 */
822
823virtual Script serverToClientObject(( string serverObject )) {}
824virtual Script initBaseClient(()) {}
825virtual Script updateNetGraphData(( string obj, string name0, string val0, string name1, string val1, string name2, string val2, string name3, string val3, string name4, string val4, string name5, string val5 )) {}
826virtual Script updateNetGraphCountsStats(()) {}
827virtual Script updateNetGraphTrafficStats(()) {}
828virtual Script toggleNetGraphCounter(()) {}
829virtual Script toggleNetGraphTraffic(()) {}
830virtual Script getNextGraphPos(()) {}
831virtual Script toggleNetGraph(()) {}
832virtual Script createNetGraph(( string graphName, string pos )) {}
833virtual Script deleteNetGraphGui(()) {}
834virtual Script createNetGraphGui(()) {}
835virtual Script execNetGraphGuiGUI(()) {}
836virtual Script postVerbose(( string string )) {}
837
838/*!  Toggles the visualization of the AL lighting specular power buffer.
839 */
840
841virtual Script toggleSpecMapViz(( string enable )) {}
842
843/*!  Toggles the visualization of the AL lighting specular power buffer.
844 */
845
846virtual Script toggleColorBufferViz(( string enable )) {}
847virtual Script doDirtyDrop(()) {}
848virtual Script doRainDrop(()) {}
849virtual Script doBloodDrop(()) {}
850virtual Script initDrinkPostEffect(( string distQ, string refrac1, string refrac2 )) {}
851virtual Script initPostEffects(()) {}
852virtual Script imposterMetricsCallback(()) {}
853virtual Script clientCmdClearBottomPrint(()) {}
854virtual Script clientCmdClearCenterPrint(()) {}
855virtual Script clientCmdBottomPrint(( string message, string time, string size )) {}
856virtual Script clientCmdCenterPrint(( string message, string time, string size )) {}
857virtual Script metrics(( string expr )) {}
858virtual Script videoMetricsCallback(()) {}
859virtual Script audioMetricsCallback(()) {}
860virtual Script irspMetricsCallback(()) {}
861virtual Script streamingMetricsCallback(()) {}
862virtual Script detailsMetricsCallback(()) {}
863virtual Script tergenMetricsCallback(()) {}
864virtual Script termemMetricsCallback(()) {}
865virtual Script eproxyMetricsCallback(()) {}
866virtual Script partMetricsCallback(()) {}
867virtual Script particleMetricsCallback(()) {}
868virtual Script lightMetricsCallback(()) {}
869virtual Script basicShadowMetricsCallback(()) {}
870virtual Script shadowMetricsCallback(()) {}
871virtual Script renderMetricsCallback(()) {}
872virtual Script decalMetricsCallback(()) {}
873virtual Script reflectMetricsCallback(()) {}
874virtual Script timeMetricsCallback(()) {}
875virtual Script sfxStatesMetricsCallback(()) {}
876virtual Script sfxSourcesMetricsCallback(()) {}
877virtual Script sfxMetricsCallback(()) {}
878virtual Script forestMetricsCallback(()) {}
879virtual Script groundCoverMetricsCallback(()) {}
880virtual Script netMetricsCallback(()) {}
881virtual Script terrainMetricsCallback(()) {}
882virtual Script gfxMetricsCallback(()) {}
883virtual Script fpsMetricsCallback(()) {}
884virtual Script parseMissionGroupForIds(( string className, string childGroup )) {}
885virtual Script parseMissionGroup(( string className, string childGroup )) {}
886virtual Script shareValueSafeDelay(( string source, string dest, string delayMs )) {}
887virtual Script shareValueSafe(( string source, string dest )) {}
888virtual Script setValueSafe(( string dest, string val )) {}
889virtual Script loadFileText(( string file )) {}
890virtual Script fieldPos(( string text, string field, string start )) {}
891virtual Script wordPos(( string text, string word, string start )) {}
892virtual Script validateDatablockName(( string name )) {}
893
894/*!  This will close the console and take a large format
895 screenshot by tiling the current backbuffer and save
896 it to the root game folder.
897
898 For instance a tile setting of 4 with a window set to
899 800x600 will output a 3200x2400 screenshot.
900 */
901
902virtual Script tiledScreenShot(( string tiles, string overlap )) {}
903
904/*!  Internal function which generates unique filename
905 and triggers a screenshot capture.
906 */
907
908virtual Script _screenShot(( string tiles, string overlap, string hudless )) {}
909
910/*!  This is bound in initializeCommon() to take
911 a screenshot on a keypress.
912 */
913
914virtual Script doScreenShot(( string val )) {}
915virtual Script stopMovie(()) {}
916virtual Script recordMovie(( string movieName, string fps, string encoder )) {}
917virtual Script formatSessionNumber(( string number )) {}
918virtual Script formatImageNumber(( string number )) {}
919virtual Script InspectVarsToggleCursor(()) {}
920virtual Script InspectVars(( string filter )) {}
921virtual Script GuiEditorIsActive(()) {}
922virtual Script EditorIsActive(()) {}
923virtual Script resetCanvas(()) {}
924virtual Script initializeCanvas(()) {}
925virtual Script configureCanvas(()) {}
926
927/*!  Resumes the playback of paused sound sources.
928 
929 @param %pauseSet    An optional SimSet which contains the paused sound 
930sources to be resumed.  If not specified the global 
931SfxSourceGroup is used.
932 @deprecated
933
934 */
935
936virtual Script sfxResume(( string pauseSet )) {}
937
938/*!  Pauses the playback of active sound sources.
939 
940 @param %channels    An optional word list of channel indices or an empty 
941string to pause sources on all channels.
942 @param %pauseSet    An optional SimSet which is filled with the paused 
943sources.  If not specified the global SfxSourceGroup 
944is used.
945
946 @deprecated
947
948 */
949
950virtual Script sfxPause(( string channels, string pauseSet )) {}
951virtual Script sfxSetChannelVolume(( string channel, string volume )) {}
952virtual Script sfxGetChannelVolume(( string channel )) {}
953virtual Script sfxStopAll(( string channel )) {}
954virtual Script sfxGetVoiceChatVolume(( string volume )) {}
955virtual Script sfxSetVoiceChatVolume(( string volume )) {}
956virtual Script sfxGetMasterVolume(( string volume )) {}
957virtual Script sfxSetMasterVolume(( string volume )) {}
958virtual Script sfxGroupToOldChannel(( string group )) {}
959virtual Script sfxOldChannelToGroup(( string channel )) {}
960
961/*!  Try to detect and initalize the best SFX device available.
962 */
963
964virtual Script sfxAutodetect(()) {}
965
966/*!  Determines which of the two SFX providers is preferable.
967 */
968
969virtual Script sfxCompareProvider(( string providerA, string providerB )) {}
970
971/*!  Destroys the current sound system device.
972 */
973
974virtual Script sfxShutdown(()) {}
975
976/*!  This initializes the sound system device from
977 the defaults in the $pref::SFX:: globals.
978 */
979
980virtual Script sfxInit(()) {}
981
982/*!  This initializes the sound system device from
983 the defaults in the $pref::SFX:: globals.
984 */
985
986virtual Script sfxStartup(()) {}
987virtual Script reloadMaterials(()) {}
988virtual Script loadMaterialsRecursivelyInFolder(( string rootFolder )) {}
989virtual Script loadMaterials(()) {}
990virtual Script reloadCoreMaterials(()) {}
991virtual Script loadCoreMaterials(()) {}
992virtual Script dumpKeybindings(()) {}
993virtual Script guiShutdown(()) {}
994virtual Script shutdownCore(()) {}
995virtual Script initializeCore(()) {}
996virtual Script GraphicsQualityAutodetect_Apply(( string shaderVer, string intel, string videoMem )) {}
997virtual Script GraphicsQualityAutodetect(()) {}
998virtual Script loadDirs(( string dirPath )) {}
999virtual Script dumpSysInfo(( string where )) {}
1000virtual Script loadDir(( string dir )) {}
1001virtual Script clientCmdTakeCameraPos(( string pos )) {}
1002virtual Script createCanvas(( string windowTitle )) {}
1003virtual Script isScriptFile(( string path )) {}
1004virtual Script compileFiles(( string pattern )) {}
1005virtual Script defaultParseArgs(()) {}
1006virtual Script popFront(( string list, string delim )) {}
1007virtual Script pushBack(( string list, string token, string delim )) {}
1008virtual Script pushFront(( string list, string token, string delim )) {}
1009virtual void initSoundsManager() {}
1010virtual void removeSoundsManager() {}
1011virtual void PlaySound2D() {}
1012virtual void toggleVmode(( bool state )) {}
1013virtual void setFittingModeCamera(( bool state )) {}
1014virtual void ReviveCharacter(()) {}
1015virtual string getSunPos(( Point3F worldPos, int hour, int minute, int seconds )) {}
1016virtual void setMapUrl() {}
1017virtual void toggleMinimap() {}
1018virtual void changeStreamingSpeed() {}
1019virtual void _checkSimManagerValidity(()) {}
1020virtual void loadAttackAnimationsXml() {}
1021virtual void loadXmlDataForSpecialAttacks() {}
1022virtual void InitVolley() {}
1023virtual void CancelVolley() {}
1024virtual void unloadComplexObjectTypes(()) {}
1025
1026/*! @brief Set the default FOV for a camera.
1027@param defaultFOV The default field of view in degrees
1028@ingroup CameraSystem */
1029
1030virtual void setDefaultFov(( float defaultFOV )) {}
1031
1032/*! @brief Set the zoom speed of the camera.
1033This affects how quickly the camera changes from one field of view to another.
1034@param speed The camera's zoom speed in ms per 90deg FOV change
1035@ingroup CameraSystem */
1036
1037virtual void setZoomSpeed(( int speed )) {}
1038
1039/*! @brief Set the FOV of the camera.
1040@param FOV The camera's new FOV in degrees
1041@ingroup CameraSystem */
1042
1043virtual void setFov(( float FOV )) {}
1044
1045/*! @brief Prevents mouse movement from being processed
1046
1047In the source, whenever a mouse move event occurs GameTSCtrl::onMouseMove() is called. Whenever snapToggle() is called, it will flag a variable that can prevent this from happening: gSnapLine. This variable is not exposed to script, so you need to call this function to trigger it.
1048
1049@tsexample
1050// Snapping is off by default, so we will toggle
1051// it on first:
1052PlayGui.snapToggle();
1053
1054// Mouse movement should be disabled
1055// Let's turn it back on
1056PlayGui.snapToggle();
1057@endtsexample
1058
1059@ingroup GuiGame */
1060
1061virtual void snapToggle(()) {}
1062
1063/*! Get the MissionArea object, if any.
1064
1065@ingroup enviroMisc
1066
1067 */
1068
1069virtual string getMissionAreaServerObject(()) {}
1070virtual void setInteriorRenderMode() {}
1071virtual void clientCmdDbgAddRenderNode() {}
1072virtual void clientCmdDbgClearRenderNodes() {}
1073virtual float getPlayerVitality(()) {}
1074virtual float oxygenRatio(()) {}
1075virtual float getOxygen(()) {}
1076virtual void setPlayerVitalityDelay(( float delay )) {}
1077virtual int getHungerRate(()) {}
1078virtual void dbgEnableTransitions() {}
1079virtual void dbgDisableTransitions() {}
1080virtual void approachBuildCamera() {}
1081virtual void moveAwayBuildCamera() {}
1082virtual void AskServerForEffects() {}
1083virtual void askServerForHitboxRayCast() {}
1084virtual void printServerHitboxRayCastResult() {}
1085virtual string getFirstName() {}
1086virtual string getLastName() {}
1087virtual int getGender() {}
1088virtual void stopAmbientSounds() {}
1089virtual void startAmbientSounds() {}
1090virtual void setServerRenderedHitbox(( int hitbox )) {}
1091virtual string getShapeBaseImageData(( int objectTypeId )) {}
1092
1093/*! Saves the decals for the active mission in the entered filename.
1094@param decalSaveFile Filename to save the decals at.
1095@tsexample
1096// Set the filename to save the decals in. If no filename is set, then the decals will
1097default to <activeMissionName>.mis.decals
1098%fileName = "./missionDecals.mis.decals";
1099// Inform the decal manager to save the decals for the active mission.
1100decalManagerSave(%fileName);
1101@endtsexample
1102@ingroup FX */
1103
1104virtual void decalManagerSave(( String decalSaveFile="" )) {}
1105
1106/*! Loads the decals from the entered filename.
1107@param fileName Filename to load the decals from.
1108@return True if the decal manager was able to load the requested file, false if it could not.
1109@tsexample
1110// Set the filename to load the decals from.
1111%fileName = "./missionDecals.mis.decals";
1112// Inform the decal manager to load the decals from the entered filename.
1113decalManagerLoad(%fileName);
1114@endtsexample
1115@ingroup FX */
1116
1117virtual bool decalManagerLoad(( string fileName )) {}
1118
1119/*! Returns if the decal manager has unsaved modifications.
1120@return True if the decal manager has unsaved modifications, false if everything has been saved.
1121@tsexample
1122// Ask the decal manager if it has unsaved modifications.
1123%hasUnsavedModifications = decalManagerDirty();
1124@endtsexample
1125@ingroup FX */
1126
1127virtual bool decalManagerDirty(()) {}
1128
1129/*! Removes all decals currently loaded in the decalManager.
1130@tsexample
1131// Tell the decal manager to remove all existing decals.
1132decalManagerClear();
1133@endtsexample
1134@ingroup FX */
1135
1136virtual void decalManagerClear(()) {}
1137
1138/*! Adds a new decal to the decal manager.
1139@param position Position for new decal to be placed. 
1140@param normal Up vector for the decal.  Like the axel for this decal.
1141@param rot Distance for this decal to be rotated around the normal, like a tire on an axel.
1142@param scale Physical scale of new decal.
1143@param decalData DecalData Datablock to use for the new decal.
1144@param isImmortal Whether or not this decal is immortal. If immortal, it does not age and must be removed explicitly.
1145@return Returns the ID of the new decal object or -1 on failure.
1146@tsexample
1147// Specify the decal position
1148%position = "1.0 1.0 1.0";
1149
1150// Specify the up vector
1151%normal = "0.0 0.0 1.0";
1152
1153// Specify the rotation for the decal
1154%rotation = "0.5";
1155
1156// Specify the scale for the decal
1157%scale = "0.35";
1158
1159// Specify the decalData datablock to use for this new decal
1160%decalData = "decalDatablockName";
1161
1162// Specify if this decal is immortal. Immortal decals don't age and must be removed explicitly.
1163%immortal = "false";
1164
1165// Tell the decal manager to remove all existing decals.
1166decalManagerAddDecal( %position, %normal, %rotation, %scale, %decalData, %immortal);
1167@endtsexample
1168@ingroup FX */
1169
1170virtual int decalManagerAddDecal(( Point3F position, Point3F normal, float rot, float scale, DecalData decalData, bool isImmortal=false )) {}
1171
1172/*! Remove specified decal from the scene.
1173@return Returns true if successful, false if decal not found.
1174@param decalID Entry ID of the decal to remove.
1175@tsexample
1176// Specify a decal ID to be removed
1177%decalID = 1;
1178
1179// Tell the decal manager to remove the specified decal ID.
1180decalManagerRemoveDecal( %decalId )
1181@endtsexample
1182@ingroup FX */
1183
1184virtual bool decalManagerRemoveDecal(( int decalID )) {}
1185
1186/*! Calculates how much an explosion effects a specific object. Use this to determine
1187damage values to objects based on their distance from the explosion's center point.
1188@tsexample
1189// Get the position of an explosion.
1190%position = ExplosionData.getPosition();
1191
1192// Set a list of TypeMasks (defined in gameFunctioncs.cpp), seperated by the | character.
1193%TypeMasks = $TypeMasks::StaticObjectType | $TypeMasks::ItemObjectType
1194
1195// Call the function, and acquire the value of effect, from 0.0f - 1.0f.
1196%effectValue = calcExplosionCoverage(%position , %sceneObjectToEffect , %TypeMasks);
1197@endtsexample
1198@ingroup FX */
1199
1200virtual float calcExplosionCoverage(( Point3F pos=Point3F(0.0f, 0.0f, 0.0f), int id=NULL, int covMask=NULL )) {}
1201
1202/*! @brief Called on the client each time a datablock has been received.
1203
1204This callback is typically used to notify the player of how far along in the datablock download process they are.
1205
1206@param index The index of the datablock just received.
1207@param total The total number of datablocks to be received.
1208
1209@see GameConnection, GameConnection::transmitDataBlocks(), GameConnection::onDataBlocksDone()
1210
1211@ingroup Networking
1212 */
1213
1214void onDataBlockObjectReceived( int index, int total );
1215 {01} <ConsoleEntry::eval> [432241] 
1216virtual void attachTCP(( SimObject tcp )) {}
1217virtual void dumpProcessList() {}
1218virtual void Sprint() {}
1219virtual void SprintOn() {}
1220virtual bool physicsPluginPresent() {}
1221virtual bool physicsInit() {}
1222virtual void physicsDestroy() {}
1223virtual bool physicsInitWorld() {}
1224virtual void physicsDestroyWorld() {}
1225virtual void physicsStartSimulation() {}
1226virtual void physicsStopSimulation() {}
1227virtual bool physicsSimulationEnabled() {}
1228virtual void physicsSetTimeScale() {}
1229virtual float physicsGetTimeScale() {}
1230virtual void physicsStoreState() {}
1231virtual void physicsRestoreState() {}
1232virtual void physicsDebugDraw() {}
1233virtual void cmVoronoiTest(( Point3F pos, Point3F size, int substanceType, int count, float impulse, int delay )) {}
1234virtual void cmVoronoiExplode(( PhysicsDebris debris, Point3F pos, float radius, float impulse )) {}
1235
1236/*! @brief Add a string to the bad word filter
1237
1238The bad word filter is a table containing words which will not be displayed in chat windows. Instead, a designated replacement string will be displayed.  There are already a number of bad words automatically defined.
1239
1240@param badWord Exact text of the word to restrict.
1241@return True if word was successfully added, false if the word or a subset of it already exists in the table
1242@see filterString()
1243
1244@tsexample
1245// In this game, "Foobar" is banned
1246%badWord = "Foobar";
1247
1248// Returns true, word was successfully added
1249addBadWord(%badWord);
1250
1251// Returns false, word has already been added
1252addBadWord("Foobar");@endtsexample
1253@ingroup Game */
1254
1255virtual bool addBadWord(( string badWord )) {}
1256
1257/*! @brief Replaces the characters in a string with designated text
1258
1259Uses the bad word filter to determine which characters within the string will be replaced.
1260
1261@param baseString  The original string to filter.
1262@param replacementChars A string containing letters you wish to swap in the baseString.
1263@return The new scrambled string 
1264@see addBadWord()
1265@see containsBadWords()
1266@tsexample
1267// Create the base string, can come from anywhere
1268%baseString = "Foobar";
1269
1270// Create a string of random letters
1271%replacementChars = "knqwrtlzs";
1272
1273// Filter the string
1274%newString = filterString(%baseString, %replacementChars);
1275
1276// Print the new string to console
1277echo(%newString);@endtsexample
1278@ingroup Game */
1279
1280virtual string filterString(( string baseString=NULL, string replacementChars=NULL )) {}
1281
1282/*! @brief Checks to see if text is a bad word
1283
1284The text is considered to be a bad word if it has been added to the bad word filter.
1285
1286@param text Text to scan for bad words
1287@return True if the text has bad word(s), false if it is clean
1288@see addBadWord()
1289@see filterString()
1290@tsexample
1291// In this game, "Foobar" is banned
1292%badWord = "Foobar";
1293
1294// Add a banned word to the bad word filter
1295addBadWord(%badWord);
1296
1297// Create the base string, can come from anywhere like user chat
1298%userText = "Foobar";
1299
1300// Create a string of random letters
1301%replacementChars = "knqwrtlzs";
1302
1303// If the text contains a bad word, filter it before printing
1304// Otherwise print the original text
1305if(containsBadWords(%userText))
1306{
1307^// Filter the string
1308^%filteredText = filterString(%userText, %replacementChars);
1309
1310^// Print filtered text
1311^echo(%filteredText);
1312}
1313else
1314^echo(%userText);
1315
1316@endtsexample
1317@ingroup Game */
1318
1319virtual bool containsBadWords(( string text )) {}
1320virtual void EULA() {}
1321virtual void CmConfiguration_init() {}
1322virtual void initCmLangManager() {}
1323virtual string getPathToTranslatedFileIfExists() {}
1324virtual void initCmMessages() {}
1325virtual void MessageIDBoxBtnCallback() {}
1326virtual void startShowingBoxedMessages() {}
1327virtual void stopShowingBoxedMessages() {}
1328virtual void clearQueuedBoxedMessages() {}
1329virtual void cmShowMessage() {}
1330virtual string GetMessageIDText() {}
1331virtual bool isPermanentDeathGame(()) {}
1332virtual bool isColonizationGameMode(()) {}
1333virtual bool isColonizationQuestComplete(()) {}
1334virtual void initManagersListThreaded(( ArrayObject list, string callbackCmd=nullptr )) {}
1335virtual void deactivateDirectInput() {}
1336virtual void activateDirectInput() {}
1337virtual string strToPlayerName() {}
1338virtual void lockMouse() {}
1339virtual bool setNetPort() {}
1340virtual void closeNetPort() {}
1341virtual void saveJournal() {}
1342virtual void playJournal() {}
1343virtual int getSimTime() {}
1344virtual int getRealTime() {}
1345virtual int getVersionNumber() {}
1346virtual string getVersionString() {}
1347virtual string getEngineName() {}
1348virtual string getCompileTimeString() {}
1349virtual string getBuildString() {}
1350virtual void cleanupBattleUI(()) {}
1351virtual void initBreedingManager() {}
1352virtual void removeBreedingManager() {}
1353virtual void CharacterNameCache_remove() {}
1354virtual void initCharacterInfo() {}
1355virtual void removeCharacterInfo() {}
1356virtual void cmChatCreate(()) {}
1357
1358/*! connects to CmChat */
1359
1360virtual void cmChatConnect(()) {}
1361virtual bool cmChatExist(()) {}
1362
1363/*! return true if connection with IRC server exists. */
1364
1365virtual bool cmChatOnline(()) {}
1366
1367/*! joins channel in CmChat */
1368
1369virtual void cmChatJoin(( String channel )) {}
1370
1371/*! sends a message to CmChat */
1372
1373virtual bool cmChatCommand(( String channel, String message )) {}
1374
1375/*! receives a local chat message */
1376
1377virtual void clientCmdLocalChatMessage(( String nickFrom1, Point3F point, String message )) {}
1378virtual void onChatMessage(( String message, String voice, String pitch )) {}
1379virtual void cmChat_onServerMessage(( String message )) {}
1380virtual void cmChatShutdown(( String quitMessage )) {}
1381virtual void cmChatLoadPropertyXml(( string filename )) {}
1382virtual bool cmChatSavePropertyXml(( string filename )) {}
1383virtual void cmSystemChatCommand(( String message )) {}
1384virtual void CraftworkBrewingTankOptionsOk() {}
1385virtual void CloseBuildPosition() {}
1386virtual void SendBuildObject() {}
1387virtual void CloseDropPosition() {}
1388virtual void SendDropObject() {}
1389virtual void clearBuildParams() {}
1390virtual void BuildSelection_Close(()) {}
1391virtual void BuildSelection_SelectSubcategory(( int abilityId, int parentObjectId )) {}
1392virtual void BuildSelection_SelectListItem(( int recipeId )) {}
1393virtual void BuildSelection_OnBuildClicked(( int recipeId )) {}
1394virtual void CloseSiegePosition() {}
1395virtual void SiegePositionDone() {}
1396virtual void CloseObserve() {}
1397virtual void toggleObserve() {}
1398virtual void clearObserve() {}
1399virtual void CloseResizeClaim(()) {}
1400virtual void ApplyResizeClaim(()) {}
1401virtual void initCustomisationManager() {}
1402virtual void removeCustomisationManager() {}
1403virtual void BodyFeaturesChangePressed() {}
1404virtual int GetNumberOfBodyFeatures() {}
1405virtual void FacialFeaturesChangePressed() {}
1406virtual int GetNumberOfFacialFeatures() {}
1407virtual void BeardChangePressed() {}
1408virtual int GetNumberOfFacialHairs() {}
1409virtual void GenderMalePressed() {}
1410virtual void GenderFemalePressed() {}
1411virtual int GetCurrentGender() {}
1412virtual void HairColorChangePressed() {}
1413virtual int GetNumberOfHairColors() {}
1414virtual void HairChangePressed() {}
1415virtual int GetNumberOfHaircuts() {}
1416virtual void HeadChangePressed() {}
1417virtual int GetNumberOfHeads() {}
1418virtual void RandomAppearancePressed() {}
1419virtual void RaceChangePressed() {}
1420virtual string GetRace(()) {}
1421virtual void SkinColorChangePressed() {}
1422virtual int GetNumberOfSkinColors() {}
1423virtual void VoiceChangePressed() {}
1424virtual int GetNumberOfVoices() {}
1425virtual void removeClientEquipmentSingleton() {}
1426virtual void removeClientComplexObjectManager() {}
1427virtual void initLoadClaimRules() {}
1428virtual void resetClaims() {}
1429virtual void DebugPrintClaims(( bool includeUnmovableObjects=false )) {}
1430
1431/*! initial load of guilds */
1432
1433virtual void initLoadGuildsClient(()) {}
1434
1435/*! reset guilds upon disconnect */
1436
1437virtual void resetGuilds(()) {}
1438
1439/*! open browser window for create guild */
1440
1441virtual void guildCreateBrowserOpen(()) {}
1442
1443/*! open browser window with guilds management */
1444
1445virtual void guildManagementBrowserOpen(()) {}
1446
1447/*! open browser window with personal land management */
1448
1449virtual void personalManagementBrowserOpen(()) {}
1450virtual void clearHeraldryInfoCache() {}
1451virtual void reheraldry(()) {}
1452virtual void cleanupHerbs() {}
1453virtual void initHerbalManager() {}
1454virtual void removeHerbalManager() {}
1455virtual void initMixingManager() {}
1456virtual void removeMixingManager() {}
1457virtual bool isClientInventoryInitialized() {}
1458virtual void loadInventoryPos() {}
1459virtual void applySplitStackItem() {}
1460virtual void cancelSplitStackItem() {}
1461virtual void ShowHideInventory() {}
1462virtual void showInventoryWnd() {}
1463virtual bool CloseInventory() {}
1464virtual void clearJudgementHourStatus() {}
1465virtual void setShowClaimsMode(( String input )) {}
1466
1467/*! initial load of lands DB */
1468
1469virtual void initLoadLands(()) {}
1470
1471/*! reset lands on disconnect */
1472
1473virtual void resetLands(()) {}
1474
1475/*! redraw guild lands - debug function */
1476
1477virtual void redrawLands(()) {}
1478virtual void printBattleZones(()) {}
1479virtual void DebugPrintLands(()) {}
1480virtual void commandToServer() {}
1481virtual void commandToPeer() {}
1482virtual void removeTaggedString() {}
1483virtual string addTaggedString() {}
1484virtual string getTaggedString() {}
1485virtual string buildTaggedString() {}
1486virtual void queryLanServers() {}
1487virtual void querySingleServer() {}
1488virtual void cancelServerQuery() {}
1489virtual void stopServerQuery() {}
1490virtual int getServerCount() {}
1491virtual bool setServerInfo() {}
1492virtual void OpenGameSettings() {}
1493virtual void applyLanguage() {}
1494virtual void BtnUnlock() {}
1495virtual void SureDoneBind() {}
1496virtual void DoneBind() {}
1497virtual void FireBind() {}
1498virtual void OpenOptionsControls() {}
1499virtual void ProcessBindQueue() {}
1500virtual void reloadHUDPreset() {}
1501virtual void reloadHotBarPreset() {}
1502virtual bool checkPresetName() {}
1503virtual void addDeletePreset() {}
1504virtual void addResetPreset() {}
1505virtual void addNewHUDPreset() {}
1506virtual void addNewHotBarPreset() {}
1507virtual void addSetDefaultHUDPreset() {}
1508virtual void addSetDefaultHotBarPreset() {}
1509virtual void addRenamePreset() {}
1510virtual void applyPresetActions() {}
1511virtual void CloseOptionsControlsDlg() {}
1512virtual void FerrymanSelectionDialogAnswer(( string serverIDStr )) {}
1513virtual void QuestAnswerPressed(( int questSubjectId, int answerId )) {}
1514virtual void SetActiveTask(( int questTaskId )) {}
1515virtual void loadTriggersManager(()) {}
1516virtual bool initSkillsManager() {}
1517virtual void clearSkillsManager() {}
1518virtual string getSkillName() {}
1519virtual int getFirstBaseSkill() {}
1520virtual int getChildCount() {}
1521virtual int getChildSkill() {}
1522virtual int getNextBaseSkill() {}
1523virtual int getFirstSecondSkill() {}
1524virtual int getNextSecondSkill() {}
1525virtual void getUpdateSkillcap() {}
1526virtual bool checkSittingAndLayingState() {}
1527virtual void RenameYesCallback() {}
1528virtual void RenameNoCallback() {}
1529virtual void prospectingRadiusSelected(( int radius )) {}
1530virtual void prospectingRadiusReset() {}
1531virtual void renameTradePostObjectDone(( String name )) {}
1532virtual void renameTradePostObjectCanceled(()) {}
1533virtual bool IsPerformingAbility() {}
1534virtual void CancelPerformingAbility() {}
1535virtual void clearPerformingAbilityInfo() {}
1536virtual bool SkinsLoadAvailable(( int slotId=0 )) {}
1537virtual void SkinsSelectSkin(( int slotId, int skinId )) {}
1538virtual void SkinsApplySkin(( int slotId, int skinId )) {}
1539virtual void SkinsReset(()) {}
1540
1541/*! Executes the given slash-command */
1542
1543virtual void doSlashCommand(( string command )) {}
1544virtual void startTimeLapse(()) {}
1545virtual void stopTimeLapse(()) {}
1546virtual void statusTimeLapse(()) {}
1547virtual void onInitClientDone(()) {}
1548virtual void saveRecordPointsToXml(( string filePath, Point3F centerPoint, ArrayObject points )) {}
1549virtual void movePlayerToRecordPoint(( Point3F centerPoint, Point3F recordPoint, Point3F cameraRotation )) {}
1550virtual void timeLapseAddKnot(()) {}
1551virtual string timeLapsePositionOnSpline(( float splineParam )) {}
1552virtual string timeLapseRotationOnSpline(( float splineParam )) {}
1553virtual void timeLapseClearKnots(()) {}
1554virtual int timeLapseGetSplineKnotsCount(()) {}
1555virtual void startTutorial(()) {}
1556virtual void onCloseTutorialSimpleHint(()) {}
1557virtual void onCloseTutorialInfoHint(()) {}
1558virtual void resetTutorialProgress(()) {}
1559
1560/*! show tutorial */
1561
1562virtual void tutorialShowSection(()) {}
1563virtual string getHorseDataByItemTypeId(( int objectTypeId )) {}
1564virtual void openXsollaStore(( int item=0 )) {}
1565virtual void consumeXsollaItem(( int item, Xsolla::ConsumeSource source, String scriptCallback )) {}
1566virtual void initXsollaManager(()) {}
1567virtual void shutdownXsollaManager(()) {}
1568virtual bool isXsollaAvaliable(()) {}
1569virtual void checkAbellaTicket(( String scriptCallback )) {}
1570virtual void checkXsollaItem(( int itemSku, Xsolla::ConsumeSource source, String scriptCallback )) {}
1571virtual void consumeAbellaTicket(( String failedCallback )) {}
1572virtual int getPowerBoosterStatus(( int type )) {}
1573virtual string getPowerBoosterTimer(( int type )) {}
1574virtual string getPowerBoosterCooldown(( int type )) {}
1575virtual string testJavaScriptBridge() {}
1576virtual string TestFunction2Args() {}
1577virtual void cls() {}
1578virtual string getClipboard() {}
1579virtual bool setClipboard() {}
1580
1581/*! @brief Logs a message to the console.
1582
1583@param message The message text.
1584@note By default, messages will appear white in the console.
1585@ingroup Logging */
1586
1587virtual void log(( string message )) {}
1588
1589/*! @brief Logs an error message to the console.
1590
1591@param message The message text.
1592@note By default, errors will appear red in the console.
1593@ingroup Logging */
1594
1595virtual void logError(( string message )) {}
1596
1597/*! @brief Logs a warning message to the console.
1598
1599@param message The message text.
1600
1601@note By default, warnings will appear turquoise in the console.
1602@ingroup Logging */
1603
1604virtual void logWarning(( string message )) {}
1605virtual bool startNewLogFile(()) {}
1606
1607/*! @brief Dumps all declared console classes to the console.
1608
1609@param dumpScript Optional parameter specifying whether or not classes defined in script should be dumped.
1610@param dumpEngine Optional parameter specifying whether or not classes defined in the engine should be dumped.
1611@ingroup Logging */
1612
1613virtual void dumpConsoleClasses(( bool dumpScript=true, bool dumpEngine=true )) {}
1614
1615/*! @brief Dumps all declared console functions to the console.
1616@param dumpScript Optional parameter specifying whether or not functions defined in script should be dumped.
1617@param dumpEngine Optional parameter specitying whether or not functions defined in the engine should be dumped.
1618@ingroup Logging */
1619
1620virtual void dumpConsoleFunctions(( bool dumpScript=true, bool dumpEngine=true )) {}
1621
1622/*! Return the integer character code value corresponding to the first character in the given string.
1623@param chr a (one-character) string.
1624@return the UTF32 code value for the first character in the given string.
1625@ingroup Strings */
1626
1627virtual int strasc(( string chr )) {}
1628
1629/*! Format the given value as a string using printf-style formatting.
1630@param format A printf-style format string.
1631@param value The value argument matching the given format string.
1632
1633@tsexample
1634// Convert the given integer value to a string in a hex notation.
1635%hex = strformat( "%x", %value );
1636@endtsexample
1637@ingroup Strings
1638@see http://en.wikipedia.org/wiki/Printf */
1639
1640virtual string strformat(( string format, string value )) {}
1641
1642/*! Compares two strings using case-<b>sensitive</b> comparison.
1643@param str1 The first string.
1644@param str2 The second string.
1645@return 0 if both strings are equal, a value <0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >1 otherwise.
1646
1647@tsexample
1648if( strcmp( %var, "foobar" ) == 0 )
1649echo( "%var is equal to 'foobar'" );
1650@endtsexample
1651@see stricmp
1652@see strnatcmp
1653@ingroup Strings */
1654
1655virtual int strcmp(( string str1, string str2 )) {}
1656
1657/*! Compares two strings using case-<b>insensitive</b> comparison.
1658@param str1 The first string.
1659@param str2 The second string.
1660@return 0 if both strings are equal, a value <0 if the first character different in str1 has a smaller character code value than the character at the same position in str2, and a value >0 otherwise.
1661
1662@tsexample
1663if( stricmp( "FOObar", "foobar" ) == 0 )
1664echo( "this is always true" );
1665@endtsexample
1666@see strcmp
1667@see strinatcmp
1668@ingroup Strings */
1669
1670virtual int stricmp(( string str1, string str2 )) {}
1671
1672/*! Compares two strings using "natural order" case-<b>sensitive</b> comparison.
1673Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way.  For example, the string "hello10" is considered greater than the string "hello2" even though the first numeric character in "hello10" actually has a smaller character value than the corresponding character in "hello2".  However, since 10 is greater than 2, strnatcmp will put "hello10" after "hello2".
1674@param str1 The first string.
1675@param str2 The second string.
1676
1677@return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value <0 if @a str1 comes before @a str2 in a natural order.
1678
1679@tsexample
1680// Bubble sort 10 elements of %array using natural order
1681do
1682{
1683%swapped = false;
1684for( %i = 0; %i < 10 - 1; %i ++ )
1685if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 )
1686{
1687%temp = %array[ %i ];
1688%array[ %i ] = %array[ %i + 1 ];
1689%array[ %i + 1 ] = %temp;
1690%swapped = true;
1691}
1692}
1693while( %swapped );
1694@endtsexample
1695@see strcmp
1696@see strinatcmp
1697@ingroup Strings */
1698
1699virtual int strnatcmp(( string str1, string str2 )) {}
1700
1701/*! Compares two strings using "natural order" case-<b>insensitive</b> comparison.
1702Natural order means that rather than solely comparing single character code values, strings are ordered in a natural way.  For example, the string "hello10" is considered greater than the string "hello2" even though the first numeric character in "hello10" actually has a smaller character value than the corresponding character in "hello2".  However, since 10 is greater than 2, strnatcmp will put "hello10" after "hello2".
1703@param str1 The first string.
1704@param str2 The second string.
1705@return 0 if the strings are equal, a value >0 if @a str1 comes after @a str2 in a natural order, and a value <0 if @a str1 comes before @a str2 in a natural order.
1706
1707@tsexample
1708
1709// Bubble sort 10 elements of %array using natural order
1710do
1711{
1712%swapped = false;
1713for( %i = 0; %i < 10 - 1; %i ++ )
1714if( strnatcmp( %array[ %i ], %array[ %i + 1 ] ) > 0 )
1715{
1716%temp = %array[ %i ];
1717%array[ %i ] = %array[ %i + 1 ];
1718%array[ %i + 1 ] = %temp;
1719%swapped = true;
1720}
1721}
1722while( %swapped );
1723@endtsexample
1724@see stricmp
1725@see strnatcmp
1726@ingroup Strings */
1727
1728virtual int strinatcmp(( string str1, string str2 )) {}
1729
1730/*! Get the length of the given string in bytes.
1731@note This does <b>not</b> return a true character count for strings with multi-byte characters!
1732@param str A string.
1733@return The length of the given string in bytes.
1734@ingroup Strings */
1735
1736virtual int strlen(( string str )) {}
1737
1738/*! Find the start of @a substring in the given @a string searching from left to right.
1739@param string The string to search.
1740@param substring The string to search for.
1741@return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found.
1742
1743@tsexample
1744strstr( "abcd", "c" ) // Returns 2.
1745@endtsexample
1746@ingroup Strings */
1747
1748virtual int stristr(( string string, string substring )) {}
1749
1750/*! Find the start of @a needle in @a haystack searching from left to right beginning at the given offset.
1751@param haystack The string to search.
1752@param needle The string to search for.
1753@return The index at which the first occurrence of @a needle was found in @a haystack or -1 if no match was found.
1754
1755@tsexample
1756strpos( "b ab", "b", 1 ) // Returns 3.
1757@endtsexample
1758@ingroup Strings */
1759
1760virtual int strpos(( string haystack, string needle, int start=0 )) {}
1761
1762/*! Find the start of @a substring in the given @a string searching from left to right.
1763@param string The string to search.
1764@param substring The string to search for.
1765@return The index into @a string at which the first occurrence of @a substring was found or -1 if @a substring could not be found.
1766
1767@tsexample
1768strstr( "abcd", "c" ) // Returns 2.
1769@endtsexample
1770@ingroup Strings */
1771
1772virtual int strstr(( string string, string substring )) {}
1773
1774/*! Remove leading whitespace from the string.
1775@param str A string.
1776@return A string that is the same as @a str but with any leading (i.e. leftmost) whitespace removed.
1777
1778@tsexample
1779ltrim( "   string  " ); // Returns "string  ".
1780@endtsexample
1781@see rtrim
1782@see trim
1783@ingroup Strings */
1784
1785virtual string ltrim(( string str )) {}
1786
1787/*! Remove trailing whitespace from the string.
1788@param str A string.
1789@return A string that is the same as @a str but with any trailing (i.e. rightmost) whitespace removed.
1790
1791@tsexample
1792rtrim( "   string  " ); // Returns "   string".
1793@endtsexample
1794@see ltrim
1795@see trim
1796@ingroup Strings */
1797
1798virtual string rtrim(( string str )) {}
1799
1800/*! Remove leading and trailing whitespace from the string.
1801@param str A string.
1802@return A string that is the same as @a str but with any leading (i.e. leftmost) and trailing (i.e. rightmost) whitespace removed.
1803
1804@tsexample
1805trim( "   string  " ); // Returns "string".
1806@endtsexample
1807@ingroup Strings */
1808
1809virtual string trim(( string str )) {}
1810
1811/*! Remove all occurrences of characters contained in @a chars from @a str.
1812@param str The string to filter characters out from.
1813@param chars A string of characters to filter out from @a str.
1814@return A version of @a str with all occurrences of characters contained in @a chars filtered out.
1815
1816@tsexample
1817stripChars( "teststring", "se" ); // Returns "tttring".@endtsexample
1818@ingroup Strings */
1819
1820virtual string stripChars(( string str, string chars )) {}
1821
1822/*! Return an all lower-case version of the given string.
1823@param str A string.
1824@return A version of @a str with all characters converted to lower-case.
1825
1826@tsexample
1827strlwr( "TesT1" ) // Returns "test1"
1828@endtsexample
1829@see strupr
1830@ingroup Strings */
1831
1832virtual string strlwr(( string str )) {}
1833
1834/*! Return an all upper-case version of the given string.
1835@param str A string.
1836@return A version of @a str with all characters converted to upper-case.
1837
1838@tsexample
1839strupr( "TesT1" ) // Returns "TEST1"
1840@endtsexample
1841@see strlwr
1842@ingroup Strings */
1843
1844virtual string strupr(( string str )) {}
1845
1846/*! Find the first occurrence of the given character in @a str.
1847@param str The string to search.
1848@param chr The character to search for.  Only the first character from the string is taken.
1849@return The remainder of the input string starting with the given character or the empty string if the character could not be found.
1850
1851@see strrchr
1852@ingroup Strings */
1853
1854virtual string strchr(( string str, string chr )) {}
1855
1856/*! Find the last occurrence of the given character in @a str.@param str The string to search.
1857@param chr The character to search for.  Only the first character from the string is taken.
1858@return The remainder of the input string starting with the given character or the empty string if the character could not be found.
1859
1860@see strchr
1861@ingroup Strings */
1862
1863virtual string strrchr(( string str, string chr )) {}
1864
1865/*! Replace all occurrences of @a from in @a source with @a to.
1866@param source The string in which to replace the occurrences of @a from.
1867@param from The string to replace in @a source.
1868@param to The string with which to replace occurrences of @from.
1869@return A string with all occurrences of @a from in @a source replaced by @a to.
1870
1871@tsexample
1872strreplace( "aabbccbb", "bb", "ee" ) // Returns "aaeeccee".
1873@endtsexample
1874@ingroup Strings */
1875
1876virtual string strreplace(( string source, string from, string to )) {}
1877
1878/*! Return a string that repeats @a str @a numTimes number of times delimiting each occurrence with @a delimiter.
1879@param str The string to repeat multiple times.
1880@param numTimes The number of times to repeat @a str in the result string.
1881@param delimiter The string to put between each repetition of @a str.
1882@return A string containing @a str repeated @a numTimes times.
1883
1884@tsexample
1885strrepeat( "a", 5, "b" ) // Returns "ababababa".
1886@endtsexample
1887@ingroup Strings */
1888
1889virtual string strrepeat(( string str, int numTimes, string delimiter="" )) {}
1890
1891/*! @brief Return a substring of @a str starting at @a start and continuing either through to the end of @a str (if @a numChars is -1) or for @a numChars characters (except if this would exceed the actual source string length).
1892@param str The string from which to extract a substring.
1893@param start The offset at which to start copying out characters.
1894@param numChars Optional argument to specify the number of characters to copy.  If this is -1, all characters up the end of the input string are copied.
1895@return A string that contains the given portion of the input string.
1896
1897@tsexample
1898getSubStr( "foobar", 1, 2 ) // Returns "oo".
1899@endtsexample
1900
1901@ingroup Strings */
1902
1903virtual string getSubStr(( string str, int start, int numChars=-1 )) {}
1904
1905/*! Match a pattern against a string.
1906@param pattern The wildcard pattern to match against.  The pattern can include characters, '*' to match any number of characters and '?' to match a single character.
1907@param str The string which should be matched against @a pattern.
1908@param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string.  If false, differences in casing are ignored.
1909@return True if @a str matches the given @a pattern.
1910
1911@tsexample
1912strIsMatchExpr( "f?o*R", "foobar" ) // Returns true.
1913@endtsexample
1914@see strIsMatchMultipleExpr
1915@ingroup Strings */
1916
1917virtual bool strIsMatchExpr(( string pattern, string str, bool caseSensitive=false )) {}
1918
1919/*! Match a multiple patterns against a single string.
1920@param patterns A tab-separated list of patterns.  Each pattern can include charaters, '*' to match any number of characters and '?' to match a single character.  Each of the patterns is tried in turn.
1921@param str The string which should be matched against @a patterns.
1922@param caseSensitive If true, characters in the pattern are matched in case-sensitive fashion against this string.  If false, differences in casing are ignored.
1923@return True if @a str matches any of the given @a patterns.
1924
1925@tsexample
1926strIsMatchMultipleExpr( "*.cs *.gui *.mis", "mymission.mis" ) // Returns true.
1927@endtsexample
1928@see strIsMatchExpr
1929@ingroup Strings */
1930
1931virtual bool strIsMatchMultipleExpr(( string patterns, string str, bool caseSensitive=false )) {}
1932
1933/*! Get the numeric suffix of the given input string.
1934@param str The string from which to read out the numeric suffix.
1935@return The numeric value of the number suffix of @a str or -1 if @a str has no such suffix.
1936
1937@tsexample
1938getTrailingNumber( "test123" ) // Returns '123'.
1939@endtsexample
1940
1941@see stripTrailingNumber
1942@ingroup Strings */
1943
1944virtual int getTrailingNumber(( string str )) {}
1945
1946/*! Strip a numeric suffix from the given string.
1947@param str The string from which to strip its numeric suffix.
1948@return The string @a str without its number suffix or the original string @a str if it has no such suffix.
1949
1950@tsexample
1951stripTrailingNumber( "test123" ) // Returns "test".
1952@endtsexample
1953
1954@see getTrailingNumber
1955@ingroup Strings */
1956
1957virtual string stripTrailingNumber(( string str )) {}
1958
1959/*! Test whether the character at the given position is a whitespace character.
1960Characters such as tab, space, or newline are considered whitespace.
1961@param str The string to test.
1962@param index The index of a character in @a str.
1963@return True if the character at the given index in @a str is a whitespace character; false otherwise.
1964
1965@see isalnum
1966@ingroup Strings */
1967
1968virtual bool isspace(( string str, int index )) {}
1969
1970/*! Test whether the character at the given position is an alpha-numeric character.
1971Alpha-numeric characters are characters that are either alphabetic (a-z, A-Z) or numbers (0-9).
1972@param str The string to test.
1973@param index The index of a character in @a str.
1974@return True if the character at the given index in @a str is an alpha-numeric character; false otherwise.
1975
1976@see isspace
1977@ingroup Strings */
1978
1979virtual bool isalnum(( string str, int index )) {}
1980
1981/*! Test whether the given string begins with the given prefix.
1982@param str The string to test.
1983@param prefix The potential prefix of @a str.
1984@param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account.
1985@return True if the first characters in @a str match the complete contents of @a prefix; false otherwise.
1986
1987@tsexample
1988startsWith( "TEST123", "test" ) // Returns true.
1989@endtsexample
1990@see endsWith
1991@ingroup Strings */
1992
1993virtual bool startsWith(( string str, string prefix, bool caseSensitive=false )) {}
1994
1995/*! @brief Test whether the given string ends with the given suffix.
1996
1997@param str The string to test.
1998@param suffix The potential suffix of @a str.
1999@param caseSensitive If true, the comparison will be case-sensitive; if false, differences in casing will not be taken into account.
2000@return True if the last characters in @a str match the complete contents of @a suffix; false otherwise.
2001
2002@tsexample
2003startsWith( "TEST123", "123" ) // Returns true.
2004@endtsexample
2005
2006@see startsWith
2007@ingroup Strings */
2008
2009virtual bool endsWith(( string str, string suffix, bool caseSensitive=false )) {}
2010
2011/*! Find the first occurrence of the given character in the given string.
2012@param str The string to search.
2013@param chr The character to look for.  Only the first character of this string will be searched for.
2014@param start The index into @a str at which to start searching for the given character.
2015@return The index of the first occurrence of @a chr in @a str or -1 if @a str does not contain the given character.
2016
2017@tsexample
2018strchrpos( "test", "s" ) // Returns 2.
2019@endtsexample
2020@ingroup Strings */
2021
2022virtual int strchrpos(( string str, string chr, int start=0 )) {}
2023
2024/*! Find the last occurrence of the given character in the given string.
2025@param str The string to search.
2026@param chr The character to look for.  Only the first character of this string will be searched for.
2027@param start The index into @a str at which to start searching for the given character.
2028@return The index of the last occurrence of @a chr in @a str or -1 if @a str does not contain the given character.
2029
2030@tsexample
2031strrchrpos( "test", "t" ) // Returns 3.
2032@endtsexample
2033@ingroup Strings */
2034
2035virtual int strrchrpos(( string str, string chr, int start=0 )) {}
2036
2037/*! Extract the word at the given @a index in the whitespace-separated list in @a text.
2038Words in @a text must be separated by newlines, spaces, and/or tabs.
2039@param text A whitespace-separated list of words.
2040@param index The zero-based index of the word to extract.
2041@return The word at the given index or "" if the index is out of range.
2042
2043@tsexample
2044getWord( "a b c", 1 ) // Returns "b"
2045@endtsexample
2046
2047@see getWords
2048@see getWordCount
2049@see getField
2050@see getRecord
2051@ingroup FieldManip */
2052
2053virtual string getWord(( string text, int index )) {}
2054
2055/*! Extract a range of words from the given @a startIndex onwards thru @a endIndex.
2056Words in @a text must be separated by newlines, spaces, and/or tabs.
2057@param text A whitespace-separated list of words.
2058@param startIndex The zero-based index of the first word to extract from @a text.
2059@param endIndex The zero-based index of the last word to extract from @a text.  If this is -1, all words beginning with @a startIndex are extracted from @a text.
2060@return A string containing the specified range of words from @a text or "" if @a startIndex is out of range or greater than @a endIndex.
2061
2062@tsexample
2063getWords( "a b c d", 1, 2, ) // Returns "b c"
2064@endtsexample
2065
2066@see getWord
2067@see getWordCount
2068@see getFields
2069@see getRecords
2070@ingroup FieldManip */
2071
2072virtual string getWords(( string text, int startIndex, int endIndex=-1 )) {}
2073
2074/*! Replace the word in @a text at the given @a index with @a replacement.
2075Words in @a text must be separated by newlines, spaces, and/or tabs.
2076@param text A whitespace-separated list of words.
2077@param index The zero-based index of the word to replace.
2078@param replacement The string with which to replace the word.
2079@return A new string with the word at the given @a index replaced by @a replacement or the original string if @a index is out of range.
2080
2081@tsexample
2082setWord( "a b c d", 2, "f" ) // Returns "a b f d"
2083@endtsexample
2084
2085@see getWord
2086@see setField
2087@see setRecord
2088@ingroup FieldManip */
2089
2090virtual string setWord(( string text, int index, string replacement )) {}
2091
2092/*! Remove the word in @a text at the given @a index.
2093Words in @a text must be separated by newlines, spaces, and/or tabs.
2094@param text A whitespace-separated list of words.
2095@param index The zero-based index of the word in @a text.
2096@return A new string with the word at the given index removed or the original string if @a index is out of range.
2097
2098@tsexample
2099removeWord( "a b c d", 2 ) // Returns "a b d"
2100@endtsexample
2101
2102@see removeField
2103@see removeRecord
2104@ingroup FieldManip */
2105
2106virtual string removeWord(( string text, int index )) {}
2107
2108/*! Return the number of whitespace-separated words in @a text.
2109Words in @a text must be separated by newlines, spaces, and/or tabs.
2110@param text A whitespace-separated list of words.
2111@return The number of whitespace-separated words in @a text.
2112
2113@tsexample
2114getWordCount( "a b c d e" ) // Returns 5
2115@endtsexample
2116
2117@see getFieldCount
2118@see getRecordCount
2119@ingroup FieldManip */
2120
2121virtual int getWordCount(( string text )) {}
2122virtual bool isWordInSet() {}
2123virtual int getWordIndex() {}
2124
2125/*! Extract the field at the given @a index in the newline and/or tab separated list in @a text.
2126Fields in @a text must be separated by newlines and/or tabs.
2127@param text A list of fields separated by newlines and/or tabs.
2128@param index The zero-based index of the field to extract.
2129@return The field at the given index or "" if the index is out of range.
2130
2131@tsexample
2132getField( "a b" TAB "c d" TAB "e f", 1 ) // Returns "c d"
2133@endtsexample
2134
2135@see getFields
2136@see getFieldCount
2137@see getWord
2138@see getRecord
2139@ingroup FieldManip */
2140
2141virtual string getField(( string text, int index )) {}
2142
2143/*! Extract a range of fields from the given @a startIndex onwards thru @a endIndex.
2144Fields in @a text must be separated by newlines and/or tabs.
2145@param text A list of fields separated by newlines and/or tabs.
2146@param startIndex The zero-based index of the first field to extract from @a text.
2147@param endIndex The zero-based index of the last field to extract from @a text.  If this is -1, all fields beginning with @a startIndex are extracted from @a text.
2148@return A string containing the specified range of fields from @a text or "" if @a startIndex is out of range or greater than @a endIndex.
2149
2150@tsexample
2151getFields( "a b" TAB "c d" TAB "e f", 1 ) // Returns "c d" TAB "e f"
2152@endtsexample
2153
2154@see getField
2155@see getFieldCount
2156@see getWords
2157@see getRecords
2158@ingroup FieldManip */
2159
2160virtual string getFields(( string text, int startIndex, int endIndex=-1 )) {}
2161
2162/*! Replace the field in @a text at the given @a index with @a replacement.
2163Fields in @a text must be separated by newlines and/or tabs.
2164@param text A list of fields separated by newlines and/or tabs.
2165@param index The zero-based index of the field to replace.
2166@param replacement The string with which to replace the field.
2167@return A new string with the field at the given @a index replaced by @a replacement or the original string if @a index is out of range.
2168
2169@tsexample
2170setField( "a b" TAB "c d" TAB "e f", 1, "g h" ) // Returns "a b" TAB "g h" TAB "e f"
2171@endtsexample
2172
2173@see getField
2174@see setWord
2175@see setRecord
2176@ingroup FieldManip */
2177
2178virtual string setField(( string text, int index, string replacement )) {}
2179
2180/*! Remove the field in @a text at the given @a index.
2181Fields in @a text must be separated by newlines and/or tabs.
2182@param text A list of fields separated by newlines and/or tabs.
2183@param index The zero-based index of the field in @a text.
2184@return A new string with the field at the given index removed or the original string if @a index is out of range.
2185
2186@tsexample
2187removeField( "a b" TAB "c d" TAB "e f", 1 ) // Returns "a b" TAB "e f"
2188@endtsexample
2189
2190@see removeWord
2191@see removeRecord
2192@ingroup FieldManip */
2193
2194virtual string removeField(( string text, int index )) {}
2195
2196/*! Return the number of newline and/or tab separated fields in @a text.
2197@param text A list of fields separated by newlines and/or tabs.
2198@return The number of newline and/or tab sepearated elements in @a text.
2199
2200@tsexample
2201getFieldCount( "a b" TAB "c d" TAB "e f" ) // Returns 3
2202@endtsexample
2203
2204@see getWordCount
2205@see getRecordCount
2206@ingroup FieldManip */
2207
2208virtual int getFieldCount(( string text )) {}
2209
2210/*! Extract the record at the given @a index in the newline-separated list in @a text.
2211Records in @a text must be separated by newlines.
2212@param text A list of records separated by newlines.
2213@param index The zero-based index of the record to extract.
2214@return The record at the given index or "" if @a index is out of range.
2215
2216@tsexample
2217getRecord( "a b" NL "c d" NL "e f", 1 ) // Returns "c d"
2218@endtsexample
2219
2220@see getRecords
2221@see getRecordCount
2222@see getWord
2223@see getField
2224@ingroup FieldManip */
2225
2226virtual string getRecord(( string text, int index )) {}
2227
2228/*! Extract a range of records from the given @a startIndex onwards thru @a endIndex.
2229Records in @a text must be separated by newlines.
2230@param text A list of records separated by newlines.
2231@param startIndex The zero-based index of the first record to extract from @a text.
2232@param endIndex The zero-based index of the last record to extract from @a text.  If this is -1, all records beginning with @a startIndex are extracted from @a text.
2233@return A string containing the specified range of records from @a text or "" if @a startIndex is out of range or greater than @a endIndex.
2234
2235@tsexample
2236getRecords( "a b" NL "c d" NL "e f", 1 ) // Returns "c d" NL "e f"
2237@endtsexample
2238
2239@see getRecord
2240@see getRecordCount
2241@see getWords
2242@see getFields
2243@ingroup FieldManip */
2244
2245virtual string getRecords(( string text, int startIndex, int endIndex=-1 )) {}
2246
2247/*! Replace the record in @a text at the given @a index with @a replacement.
2248Records in @a text must be separated by newlines.
2249@param text A list of records separated by newlines.
2250@param index The zero-based index of the record to replace.
2251@param replacement The string with which to replace the record.
2252@return A new string with the record at the given @a index replaced by @a replacement or the original string if @a index is out of range.
2253
2254@tsexample
2255setRecord( "a b" NL "c d" NL "e f", 1, "g h" ) // Returns "a b" NL "g h" NL "e f"
2256@endtsexample
2257
2258@see getRecord
2259@see setWord
2260@see setField
2261@ingroup FieldManip */
2262
2263virtual string setRecord(( string text, int index, string replacement )) {}
2264
2265/*! Remove the record in @a text at the given @a index.
2266Records in @a text must be separated by newlines.
2267@param text A list of records separated by newlines.
2268@param index The zero-based index of the record in @a text.
2269@return A new string with the record at the given @a index removed or the original string if @a index is out of range.
2270
2271@tsexample
2272removeRecord( "a b" NL "c d" NL "e f", 1 ) // Returns "a b" NL "e f"
2273@endtsexample
2274
2275@see removeWord
2276@see removeField
2277@ingroup FieldManip */
2278
2279virtual string removeRecord(( string text, int index )) {}
2280
2281/*! Return the number of newline-separated records in @a text.
2282@param text A list of records separated by newlines.
2283@return The number of newline-sepearated elements in @a text.
2284
2285@tsexample
2286getRecordCount( "a b" NL "c d" NL "e f" ) // Returns 3
2287@endtsexample
2288
2289@see getWordCount
2290@see getFieldCount
2291@ingroup FieldManip */
2292
2293virtual int getRecordCount(( string text )) {}
2294
2295/*! Return the first word in @a text.
2296@param text A list of words separated by newlines, spaces, and/or tabs.
2297@return The word at index 0 in @a text or "" if @a text is empty.
2298
2299@note This is equal to 
2300@tsexample_nopar
2301getWord( text, 0 )
2302@endtsexample
2303
2304@see getWord
2305@ingroup FieldManip */
2306
2307virtual string firstWord(( string text )) {}
2308
2309/*! Return all but the first word in @a text.
2310@param text A list of words separated by newlines, spaces, and/or tabs.
2311@return @a text with the first word removed.
2312
2313@note This is equal to 
2314@tsexample_nopar
2315getWords( text, 1 )
2316@endtsexample
2317
2318@see getWords
2319@ingroup FieldManip */
2320
2321virtual string restWords(( string text )) {}
2322virtual string nextToken() {}
2323
2324/*! @brief Returns the string from a tag string.
2325@see \ref syntaxDataTypes
2326@ingroup Networking */
2327
2328virtual string detag(( string str )) {}
2329virtual string getTag() {}
2330virtual void echo() {}
2331virtual void warn() {}
2332virtual void error() {}
2333virtual void hack() {}
2334virtual void info() {}
2335virtual bool launchExternalApplication() {}
2336virtual int launchExternalApplicationThreaded() {}
2337virtual bool killProcess() {}
2338
2339/*! @brief Logs the value of the given variable to the console.
2340
2341Prints a string of the form "<variableName> = <variable value>" to the console.
2342
2343@param variableName Name of the local or global variable to print.
2344
2345@tsexample
2346%var = 1;
2347debugv( "%var" ); // Prints "%var = 1"
2348@endtsexample
2349
2350@ingroup Debugging */
2351
2352virtual void debugv(( string variableName )) {}
2353
2354/*! @brief Replace all characters in @a text that need to be escaped for the string to be a valid string literal with their respective escape sequences.
2355
2356All characters in @a text that cannot appear in a string literal will be replaced by an escape sequence (\\n, \\t, etc).
2357
2358The primary use of this function is for converting strings suitable for being passed as string literals to the TorqueScript compiler.
2359
2360@param text A string
2361@return A duplicate of the text parameter with all unescaped characters that cannot appear in string literals replaced by their respective escape sequences.
2362
2363@tsxample
2364expandEscape( "str" NL "ing" ) // Returns "str\ning".
2365@endtsxample
2366
2367@see collapseEscape
2368@ingroup Strings */
2369
2370virtual string expandEscape(( string text )) {}
2371
2372/*! Replace all escape sequences in @a text with their respective character codes.
2373
2374This function replaces all escape sequences (\\n, \\t, etc) in the given string with the respective characters they represent.
2375
2376The primary use of this function is for converting strings from their literal form into their compiled/translated form, as is normally done by the TorqueScript compiler.
2377
2378@param text A string.
2379@return A duplicate of @a text with all escape sequences replaced by their respective character codes.
2380
2381@tsexample
2382// Print:
2383//
2384//    str
2385//    ing
2386//
2387// to the console.  Note how the backslash in the string must be escaped here
2388// in order to prevent the TorqueScript compiler from collapsing the escape
2389// sequence in the resulting string.
2390echo( collapseEscape( "str\ning" ) );
2391@endtsexample
2392
2393@see expandEscape
2394
2395@ingroup Strings */
2396
2397virtual string collapseEscape(( string text )) {}
2398
2399/*! @brief Determines how log files are written.
2400
2401Sets the operational mode of the console logging system.
2402
2403@param mode Parameter specifying the logging mode.  This can be:
2404- 1: Open and close the console log file for each seperate string of output.  This will ensure that all parts get written out to disk and that no parts remain in intermediate buffers even if the process crashes.
2405- 2: Keep the log file open and write to it continuously.  This will make the system operate faster but if the process crashes, parts of the output may not have been written to disk yet and will be missing from the log.
2406
2407Additionally, when changing the log mode and thus opening a new log file, either of the two mode values may be combined by binary OR with 0x4 to cause the logging system to flush all console log messages that had already been issued to the console system into the newly created log file.
2408
2409@note Xbox 360 does not support logging to a file. Use Platform::OutputDebugStr in C++ instead.@ingroup Logging */
2410
2411virtual void setLogMode(( int mode )) {}
2412virtual bool isQuitRequested(()) {}
2413
2414/*! Display an error message box showing the given @a message and then shut down the engine and exit its process.
2415This function cleanly uninitialized the engine and then exits back to the system with a process exit status indicating an error.
2416
2417@param message The message to log to the console and show in an error message box.
2418
2419@see quit
2420
2421@ingroup Platform */
2422
2423virtual void quitWithErrorMessage(( string message )) {}
2424
2425/*! Open the given URL or file in the user's web browser.
2426
2427@param address The address to open.  If this is not prefixed by a protocol specifier ("...://"), then the function checks whether the address refers to a file or directory and if so, prepends "file://" to @a adress; if the file check fails, "http://" is prepended to @a address.
2428
2429@tsexample
2430gotoWebPage( "http://www.garagegames.com" );
2431@endtsexample
2432
2433@ingroup Platform */
2434
2435virtual void gotoWebPage(( string address )) {}
2436
2437/*! Display a startup splash window suitable for showing while the engine still starts up.
2438
2439@note This is currently only implemented on Windows.
2440
2441@return True if the splash window could be successfully initialized.
2442
2443@ingroup Platform */
2444
2445virtual bool displaySplashWindow(()) {}
2446
2447/*! Returns true if the splash window is currently active.
2448
2449@note This is currently only implemented on Windows.
2450
2451@return True if the splash window is active and visible.
2452
2453@ingroup Platform */
2454
2455virtual bool isSplashWindowActive(()) {}
2456
2457/*! Close and remove splash window.
2458
2459@note This is currently only implemented on Windows.
2460
2461@ingroup Platform */
2462
2463virtual void closeSplashWindow(()) {}
2464
2465/*! Test whether Torque is running in web-deployment mode.
2466In this mode, Torque will usually run within a browser and certain restrictions apply (e.g. Torque will not be able to enter fullscreen exclusive mode).
2467@return True if Torque is running in web-deployment mode.
2468@ingroup Platform */
2469
2470virtual bool getWebDeployment(()) {}
2471
2472/*! Count the number of bits that are set in the given 32 bit integer.
2473@param v An integer value.
2474
2475@return The number of bits that are set in @a v.
2476
2477@ingroup Utilities */
2478
2479virtual int countBits(( int v )) {}
2480
2481/*! Generate a new universally unique identifier (UUID).
2482
2483@return A newly generated UUID.
2484
2485@ingroup Utilities */
2486
2487virtual string generateUUID(()) {}
2488virtual string call() {}
2489
2490/*! Get the absolute path to the file in which the compiled code for the given script file will be stored.
2491@param scriptFileName %Path to the .cs script file.
2492@return The absolute path to the .dso file for the given script file.
2493
2494@note The compiler will store newly compiled DSOs in the prefs path but pre-existing DSOs will be loaded from the current paths.
2495
2496@see compile
2497@see getPrefsPath
2498@ingroup Scripting */
2499
2500virtual string getDSOPath(( string scriptFileName )) {}
2501
2502/*! Compile a file to bytecode.
2503
2504This function will read the TorqueScript code in the specified file, compile it to internal bytecode, and, if DSO generation is enabled or @a overrideNoDDSO is true, will store the compiled code in a .dso file in the current DSO path mirrorring the path of @a fileName.
2505
2506@param fileName Path to the file to compile to bytecode.
2507@param overrideNoDSO If true, force generation of DSOs even if the engine is compiled to not generate write compiled code to DSO files.
2508
2509@return True if the file was successfully compiled, false if not.
2510
2511@note The definitions contained in the given file will not be made available and no code will actually be executed.  Use exec() for that.
2512
2513@see getDSOPath
2514@see exec
2515@ingroup Scripting */
2516
2517virtual bool compile(( string fileName, bool overrideNoDSO=false )) {}
2518
2519/*! Execute the given script file.
2520@param fileName Path to the file to execute
2521@param noCalls Deprecated
2522@param journalScript Deprecated
2523@return True if the script was successfully executed, false if not.
2524
2525@tsexample
2526// Execute the init.cs script file found in the same directory as the current script file.
2527exec( "./init.cs" );
2528@endtsexample
2529
2530@see compile
2531@see eval
2532@ingroup Scripting */
2533
2534virtual bool exec(( string fileName, bool noCalls=false, bool journalScript=false )) {}
2535virtual string eval() {}
2536virtual string getVariable() {}
2537virtual void setVariable() {}
2538virtual bool isFunction() {}
2539virtual string getFunctionPackage() {}
2540virtual bool isMethod() {}
2541virtual string getMethodPackage() {}
2542virtual bool isDefined() {}
2543virtual bool isCurrentScriptToolScript() {}
2544virtual string getModNameFromPath() {}
2545virtual void pushInstantGroup() {}
2546virtual void popInstantGroup() {}
2547virtual string getPrefsPath() {}
2548virtual bool execPrefs() {}
2549
2550/*! Write out the definitions of all global variables matching the given name @a pattern.
2551If @a fileName is not "", the variable definitions are written to the specified file.  Otherwise the definitions will be printed to the console.
2552
2553The output are valid TorqueScript statements that can be executed to restore the global variable values.
2554
2555@param pattern A global variable name pattern.  Must begin with '$'.
2556@param filename %Path of the file to which to write the definitions or "" to write the definitions to the console.
2557@param append If true and @a fileName is not "", then the definitions are appended to the specified file. Otherwise existing contents of the file (if any) will be overwritten.
2558
2559@tsexample
2560// Write out all preference variables to a prefs.cs file.
2561export( "$prefs::*", "prefs.cs" );
2562@endtsexample
2563
2564@ingroup Scripting */
2565
2566virtual void export(( string pattern, string filename="", bool append=false )) {}
2567
2568/*! Undefine all global variables matching the given name @a pattern.
2569@param pattern A global variable name pattern.  Must begin with '$'.
2570@tsexample
2571// Define a global variable in the "My" namespace.
2572$My::Variable = "value";
2573
2574// Undefine all variable in the "My" namespace.
2575deleteVariables( "$My::*" );
2576@endtsexample
2577
2578@see strIsMatchExpr
2579@ingroup Scripting */
2580
2581virtual void deleteVariables(( string pattern )) {}
2582
2583/*! Enable or disable tracing in the script code VM.
2584
2585When enabled, the script code runtime will trace the invocation and returns from all functions that are called and log them to the console. This is helpful in observing the flow of the script program.
2586
2587@param enable New setting for script trace execution, on by default.
2588@ingroup Debugging */
2589
2590virtual void trace(( bool enable=true )) {}
2591
2592/*! Enable or disable step tracing in the script code VM.
2593
2594When tracing is on, the script code runtime will trace how deep it in code and log with '#' symbol the current depth to the console.  This is helpful in finding what the script program flow is.
2595
2596@param enable New setting for script step trace execution.
2597@ingroup Debugging */
2598
2599virtual void stepTrace(( bool enable=true )) {}
2600
2601/*! Test whether the engine has been compiled with TORQUE_SHIPPING, i.e. in a form meant for final release.
2602
2603@return True if this is a shipping build; false otherwise.
2604
2605@ingroup Platform */
2606
2607virtual bool isShippingBuild(()) {}
2608
2609/*! Test whether the engine has been compiled with TORQUE_DEBUG, i.e. if it includes debugging functionality.
2610
2611@return True if this is a debug build; false otherwise.
2612
2613@ingroup Platform */
2614
2615virtual bool isDebugBuild(()) {}
2616
2617/*! Test whether the engine has been compiled with TORQUE_TOOLS, i.e. if it includes tool-related functionality.
2618
2619@return True if this is a tool build; false otherwise.
2620
2621@ingroup Platform */
2622
2623virtual bool isToolBuild(()) {}
2624virtual string getEngineVersion(()) {}
2625
2626/*! @brief Prints the scripting call stack to the console log.
2627
2628Used to trace functions called from within functions. Can help discover what functions were called (and not yet exited) before the current point in scripts.
2629
2630@ingroup Debugging */
2631
2632virtual void backtrace(()) {}
2633virtual void dumpScope() {}
2634virtual string getScopeName() {}
2635
2636/*! @brief Returns true if the identifier is the name of a declared package.
2637
2638@ingroup Packages
2639 */
2640
2641virtual bool isPackage(( String identifier )) {}
2642
2643/*! @brief Activates an existing package.
2644
2645The activation occurs by updating the namespace linkage of existing functions and methods. If the package is already activated the function does nothing.
2646@ingroup Packages
2647 */
2648
2649virtual void activatePackage(( String packageName )) {}
2650
2651/*! @brief Deactivates a previously activated package.
2652
2653The package is deactivated by removing its namespace linkages to any function or method. If there are any packages above this one in the stack they are deactivated as well. If the package is not on the stack this function does nothing.
2654@ingroup Packages
2655 */
2656
2657virtual void deactivatePackage(( String packageName )) {}
2658
2659/*! @brief Returns a space delimited list of the active packages in stack order.
2660
2661@ingroup Packages
2662 */
2663
2664virtual string getPackageList(()) {}
2665
2666/*! @brief Returns true if the passed identifier is the name of a declared class.
2667
2668@ingroup Console */
2669
2670virtual bool isClass(( string identifier )) {}
2671
2672/*! @brief Returns true if the class is derived from the super class.
2673
2674If either class doesn't exist this returns false.
2675@param className The class name.
2676@param superClassName The super class to look for.
2677@ingroup Console */
2678
2679virtual bool isMemberOfClass(( string className, string superClassName )) {}
2680
2681/*! @brief Returns the description string for the named class.
2682
2683@param className The name of the class.
2684@return The class description in string format.
2685@ingroup Console */
2686
2687virtual string getDescriptionOfClass(( string className )) {}
2688
2689/*! @brief Returns the category of the given class.
2690
2691@param className The name of the class.
2692@ingroup Console */
2693
2694virtual string getCategoryOfClass(( string className )) {}
2695
2696/*! @brief Returns a list of classes that derive from the named class.
2697
2698If the named class is omitted this dumps all the classes.
2699@param className The optional base class name.
2700@return A tab delimited list of classes.
2701@ingroup Editors
2702@internal */
2703
2704virtual string enumerateConsoleClasses(( string className="" )) {}
2705
2706/*! @brief Provide a list of classes that belong to the given category.
2707
2708@param category The category name.
2709@return A tab delimited list of classes.
2710@ingroup Editors
2711@internal */
2712
2713virtual string enumerateConsoleClassesByCategory(( String category )) {}
2714virtual void debugNetStart(( string val )) {}
2715virtual void clientCmdNetDebugSessionStart(( string val )) {}
2716virtual void globalStartNetDebug(( string sessionName )) {}
2717
2718/*! @brief Dumps network statistics for each class to the console.
2719
2720@note This method only works when TORQUE_NET_STATS is defined in torqueConfig.h.
2721@ingroup Networking
2722 */
2723
2724virtual void dumpNetStats(()) {}
2725virtual void debugNetEnd(()) {}
2726virtual void clientCmdNetDebugSessionStop(()) {}
2727virtual void globalStopNetDebug(()) {}
2728
2729/*! @brief Determines the memory consumption of a class or object.
2730
2731@param objectOrClass The object or class being measured.
2732@return Returns the total size of an object in bytes.
2733@ingroup Debugging
2734 */
2735
2736virtual int sizeof(( string objectOrClass )) {}
2737
2738/*! Dumps the engine scripting documentation to the specified file overwriting any existing content.
2739@param outputFile The relative or absolute output file path and name.
2740@return Returns true if successful.
2741@ingroup Console */
2742
2743virtual bool dumpEngineDocs(( string outputFile )) {}
2744virtual int getEnumTypeID() {}
2745virtual int getEnumItemCount() {}
2746virtual string getEnumItemName() {}
2747virtual int getEnumItemValue() {}
2748
2749/*! @brief Returns the first file in the directory system matching the given pattern.
2750
2751Use the corresponding findNextFile() to step through the results.  If you're only interested in the number of files returned by the pattern match, use getFileCount().
2752
2753This function differs from findFirstFileMultiExpr() in that it supports a single search pattern being passed in.
2754
2755@note You cannot run multiple simultaneous file system searches with these functions.  Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid.
2756
2757@param pattern The path and file name pattern to match against.
2758@param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern.
2759@return The path of the first file matched by the search or an empty string if no matching file could be found.
2760
2761@tsexample
2762// Execute all .cs files in a subdirectory and its subdirectories.
2763for( %file = findFirstFile( "subdirectory/*.cs" ); %file !$= ""; %file = findNextFile() )
2764exec( %file );
2765@endtsexample
2766
2767@see findNextFile()@see getFileCount()@see findFirstFileMultiExpr()@ingroup FileSearches */
2768
2769virtual string findFirstFile(( string pattern, bool recurse=true )) {}
2770
2771/*! @brief Returns the next file matching a search begun in findFirstFile().
2772
2773@param pattern The path and file name pattern to match against.  This is optional and may be left out as it is not used by the code.  It is here for legacy reasons.
2774@return The path of the next filename matched by the search or an empty string if no more files match.
2775
2776@tsexample
2777// Execute all .cs files in a subdirectory and its subdirectories.
2778for( %file = findFirstFile( "subdirectory/*.cs" ); %file !$= ""; %file = findNextFile() )
2779exec( %file );
2780@endtsexample
2781
2782@see findFirstFile()@ingroup FileSearches */
2783
2784virtual string findNextFile(( string pattern="" )) {}
2785
2786/*! @brief Returns the number of files in the directory tree that match the given patterns
2787
2788This function differs from getFileCountMultiExpr() in that it supports a single search pattern being passed in.
2789
2790If you're interested in a list of files that match the given pattern and not just the number of files, use findFirstFile() and findNextFile().
2791
2792@param pattern The path and file name pattern to match against.
2793@param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern counting files in subdirectories.
2794@return Number of files located using the pattern
2795
2796@tsexample
2797// Count the number of .cs files in a subdirectory and its subdirectories.
2798getFileCount( "subdirectory/*.cs" );
2799@endtsexample
2800
2801@see findFirstFile()@see findNextFile()@see getFileCountMultiExpr()@ingroup FileSearches */
2802
2803virtual int getFileCount(( string pattern, bool recurse=true )) {}
2804
2805/*! @brief Returns the first file in the directory system matching the given patterns.
2806
2807Use the corresponding findNextFileMultiExpr() to step through the results.  If you're only interested in the number of files returned by the pattern match, use getFileCountMultiExpr().
2808
2809This function differs from findFirstFile() in that it supports multiple search patterns to be passed in.
2810
2811@note You cannot run multiple simultaneous file system searches with these functions.  Each call to findFirstFile() and findFirstFileMultiExpr() initiates a new search and renders a previous search invalid.
2812
2813@param pattern The path and file name pattern to match against, such as *.cs.  Separate multiple patterns with TABs.  For example: "*.cs" TAB "*.dso"
2814@param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename patterns.
2815@return String of the first matching file path, or an empty string if no matching files were found.
2816
2817@tsexample
2818// Find all DTS or Collada models
2819%filePatterns = "*.dts" TAB "*.dae";
2820%fullPath = findFirstFileMultiExpr( %filePatterns );
2821while ( %fullPath !$= "" )
2822{
2823echo( %fullPath );
2824%fullPath = findNextFileMultiExpr( %filePatterns );
2825}
2826@endtsexample
2827
2828@see findNextFileMultiExpr()@see getFileCountMultiExpr()@see findFirstFile()@ingroup FileSearches */
2829
2830virtual string findFirstFileMultiExpr(( string pattern, bool recurse=true )) {}
2831
2832/*! @brief Returns the next file matching a search begun in findFirstFileMultiExpr().
2833
2834@param pattern The path and file name pattern to match against.  This is optional and may be left out as it is not used by the code.  It is here for legacy reasons.
2835@return String of the next matching file path, or an empty string if no matching files were found.
2836
2837@tsexample
2838// Find all DTS or Collada models
2839%filePatterns = "*.dts" TAB "*.dae";
2840%fullPath = findFirstFileMultiExpr( %filePatterns );
2841while ( %fullPath !$= "" )
2842{
2843echo( %fullPath );
2844%fullPath = findNextFileMultiExpr( %filePatterns );
2845}
2846@endtsexample
2847
2848@see findFirstFileMultiExpr()@ingroup FileSearches */
2849
2850virtual string findNextFileMultiExpr(( string pattern="" )) {}
2851
2852/*! @brief Returns the number of files in the directory tree that match the given patterns
2853
2854If you're interested in a list of files that match the given patterns and not just the number of files, use findFirstFileMultiExpr() and findNextFileMultiExpr().
2855
2856@param pattern The path and file name pattern to match against, such as *.cs.  Separate multiple patterns with TABs.  For example: "*.cs" TAB "*.dso"
2857@param recurse If true, the search will exhaustively recurse into subdirectories of the given path and match the given filename pattern.
2858@return Number of files located using the patterns
2859
2860@tsexample
2861// Count all DTS or Collada models
2862%filePatterns = "*.dts" TAB "*.dae";
2863echo( "Nunmer of shape files:" SPC getFileCountMultiExpr( %filePatterns ) );
2864@endtsexample
2865
2866@see findFirstFileMultiExpr()@see findNextFileMultiExpr()@ingroup FileSearches */
2867
2868virtual int getFileCountMultiExpr(( string pattern, bool recurse=true )) {}
2869
2870/*! @brief Provides the CRC checksum of the given file.
2871
2872@param fileName The path to the file.
2873@return The calculated CRC checksum of the file, or -1 if the file could not be found.
2874@ingroup FileSystem */
2875
2876virtual int getFileCRC(( string fileName )) {}
2877virtual int crc32() {}
2878
2879/*! @brief Provides the CRC checksum of the given file.
2880
2881@param fileName The path to the file.
2882@return The calculated CRC checksum of the file, or -1 if the file could not be found.
2883@ingroup FileSystem */
2884
2885virtual string getFileCRC32(( string fileName )) {}
2886
2887/*! @brief Determines if the specified file exists or not
2888
2889@param fileName The path to the file.
2890@return Returns true if the file was found.
2891@ingroup FileSystem */
2892
2893virtual bool isFile(( string fileName )) {}
2894
2895/*! @brief Determines if the specified file exists or not
2896
2897@param fileName The path to the file.
2898@return Returns true if the file was found.
2899@ingroup FileSystem */
2900
2901virtual bool fileExists(( string fileName )) {}
2902
2903/*! @brief Determines if a specified directory exists or not
2904
2905@param directory String containing path in the form of "foo/bar"
2906@return Returns true if the directory was found.
2907@note Do not include a trailing slash '/'.
2908@ingroup FileSystem */
2909
2910virtual bool IsDirectory(( string directory )) {}
2911
2912/*! @brief Determines if a file name can be written to using File I/O
2913
2914@param fileName Name and path of file to check
2915@return Returns true if the file can be written to.
2916@ingroup FileSystem */
2917
2918virtual bool isWriteableFileName(( string fileName )) {}
2919
2920/*! @brief Start watching resources for file changes
2921
2922Typically this is called during initializeCore().
2923
2924@see stopFileChangeNotifications()
2925@ingroup FileSystem */
2926
2927virtual void startFileChangeNotifications(()) {}
2928
2929/*! @brief Stop watching resources for file changes
2930
2931Typically this is called during shutdownCore().
2932
2933@see startFileChangeNotifications()
2934@ingroup FileSystem */
2935
2936virtual void stopFileChangeNotifications(()) {}
2937
2938/*! @brief Gathers a list of directories starting at the given path.
2939
2940@param path String containing the path of the directory
2941@param depth Depth of search, as in how many subdirectories to parse through
2942@return Tab delimited string containing list of directories found during search, "" if no files were found
2943@ingroup FileSystem */
2944
2945virtual string getDirectoryList(( string path, int depth=0 )) {}
2946
2947/*! @brief Determines the size of a file on disk
2948
2949@param fileName Name and path of the file to check
2950@return Returns filesize in KB, or -1 if no file
2951@ingroup FileSystem */
2952
2953virtual int fileSize(( string fileName )) {}
2954
2955/*! @brief Returns a platform specific formatted string with the last modified time for the file.
2956
2957@param fileName Name and path of file to check
2958@return Formatted string (OS specific) containing modified time, "9/3/2010 12:33:47 PM" for example
2959@ingroup FileSystem */
2960
2961virtual string fileModifiedTime(( string fileName )) {}
2962
2963/*! @brief Returns a platform specific formatted string with the creation time for the file.@param fileName Name and path of file to check
2964@return Formatted string (OS specific) containing created time, "9/3/2010 12:33:47 PM" for example
2965@ingroup FileSystem */
2966
2967virtual string fileCreatedTime(( string fileName )) {}
2968
2969/*! @brief Delete a file from the hard drive
2970
2971@param path Name and path of the file to delete
2972@note THERE IS NO RECOVERY FROM THIS. Deleted file is gone for good.
2973@return True if file was successfully deleted
2974@ingroup FileSystem */
2975
2976virtual bool fileDelete(( string path )) {}
2977virtual bool removeFolderWithAllFiles(( string path )) {}
2978
2979/*! @brief Get the extension of a file
2980
2981@param fileName Name and path of file
2982@return String containing the extension, such as ".exe" or ".cs"
2983@ingroup FileSystem */
2984
2985virtual string fileExt(( string fileName )) {}
2986
2987/*! @brief Get the base of a file name (removes extension)
2988
2989@param fileName Name and path of file to check
2990@return String containing the file name, minus extension
2991@ingroup FileSystem */
2992
2993virtual string fileBase(( string fileName )) {}
2994
2995/*! @brief Get the file name of a file (removes extension and path)
2996
2997@param fileName Name and path of file to check
2998@return String containing the file name, minus extension and path
2999@ingroup FileSystem */
3000
3001virtual string fileName(( string fileName )) {}
3002
3003/*! @brief Get the path of a file (removes name and extension)
3004
3005@param fileName Name and path of file to check
3006@return String containing the path, minus name and extension
3007@ingroup FileSystem */
3008
3009virtual string filePath(( string fileName )) {}
3010
3011/*! @brief Reports the current directory
3012
3013@return String containing full file path of working directory
3014@ingroup FileSystem */
3015
3016virtual string getWorkingDirectory(()) {}
3017
3018/*! @brief Converts a relative file path to a full path
3019
3020For example, "./console.log" becomes "C:/Torque/t3d/examples/FPS Example/game/console.log"
3021@param path Name of file or path to check
3022@param cwd Optional current working directory from which to build the full path.
3023@return String containing non-relative directory of path
3024@ingroup FileSystem */
3025
3026virtual string makeFullPath(( string path, string cwd="" )) {}
3027
3028/*! @brief Turns a full or local path to a relative one
3029
3030For example, "./game/art" becomes "game/art"
3031@param path Full path (may include a file) to convert
3032@param to Optional base path used for the conversion.  If not supplied the current working directory is used.
3033@returns String containing relative path
3034@ingroup FileSystem */
3035
3036virtual string makeRelativePath(( string path, string to="" )) {}
3037
3038/*! @brief Combines two separate strings containing a file path and file name together into a single string
3039
3040@param path String containing file path
3041@param file String containing file name
3042@return String containing concatenated file name and path
3043@ingroup FileSystem */
3044
3045virtual string pathConcat(( string path, string file )) {}
3046
3047/*! @brief Gets the name of the game's executable
3048
3049@return String containing this game's executable name
3050@ingroup FileSystem */
3051
3052virtual string getExecutableName(()) {}
3053
3054/*! @brief Get the absolute path to the directory that contains the main.cs script from which the engine was started.
3055
3056This directory will usually contain all the game assets and, in a user-side game installation, will usually be read-only.
3057
3058@return The path to the main game assets.
3059
3060@ingroup FileSystem
3061 */
3062
3063virtual string getMainDotCsDir(()) {}
3064
3065/*! @brief Copy a file to a new location.
3066@param fromFile %Path of the file to copy.
3067@param toFile %Path where to copy @a fromFile to.
3068@param noOverwrite If true, then @a fromFile will not overwrite a file that may already exist at @a toFile.
3069@return True if the file was successfully copied, false otherwise.
3070@note Only present in a Tools build of Torque.
3071@ingroup FileSystem */
3072
3073virtual bool pathCopy(( string fromFile, string toFile, bool noOverwrite=true )) {}
3074
3075/*! @brief Return the current working directory.
3076
3077@return The absolute path of the current working directory.
3078
3079@note Only present in a Tools build of Torque.
3080@see getWorkingDirectory()@ingroup FileSystem */
3081
3082virtual string getCurrentDirectory(()) {}
3083
3084/*! @brief Set the current working directory.
3085
3086@param path The absolute or relative (to the current working directory) path of the directory which should be made the new working directory.
3087
3088@return True if the working directory was successfully changed to @a path, false otherwise.
3089
3090@note Only present in a Tools build of Torque.
3091@ingroup FileSystem */
3092
3093virtual bool setCurrentDirectory(( string path )) {}
3094
3095/*! @brief Create the given directory or the path leading to the given filename.
3096
3097If @a path ends in a trailing slash, then all components in the given path will be created as directories (if not already in place).  If @a path, does @b not end in a trailing slash, then the last component of the path is taken to be a file name and only the directory components of the path will be created.
3098
3099@param path The path to create.
3100
3101@note Only present in a Tools build of Torque.
3102@ingroup FileSystem */
3103
3104virtual bool createPath(( string path )) {}
3105virtual string expandFilename() {}
3106virtual string expandOldFilename() {}
3107virtual string collapseFilename() {}
3108virtual void setScriptPathExpando() {}
3109virtual void removeScriptPathExpando() {}
3110virtual bool isScriptPathExpando() {}
3111virtual int nameToID() {}
3112virtual bool isObject() {}
3113virtual int spawnObject() {}
3114virtual void cancel() {}
3115virtual void cancelAll() {}
3116virtual bool isEventPending() {}
3117virtual int getEventTimeLeft() {}
3118virtual int getScheduleDuration() {}
3119virtual int getTimeSinceStart() {}
3120virtual int schedule() {}
3121virtual string getUniqueName() {}
3122virtual string getUniqueInternalName() {}
3123virtual bool isValidObjectName() {}
3124
3125/*! Delete all the datablocks we've downloaded.
3126
3127This is usually done in preparation of downloading a new set of datablocks, such as occurs on a mission change, but it's also good post-mission cleanup. */
3128
3129virtual void deleteDataBlocks(()) {}
3130
3131/*! @brief Serialize the object to a file.
3132
3133@param object The object to serialize.
3134@param filename The file name and path.
3135@ingroup Console
3136 */
3137
3138virtual bool saveObject(( SimObject object, string filename )) {}
3139
3140/*! @brief Loads a serialized object from a file.
3141
3142@param Name and path to text file containing the object
3143@ingroup Console
3144 */
3145
3146virtual string loadObject(( string filename )) {}
3147virtual bool savePropertyXml(( SimObject object, string filename )) {}
3148virtual bool loadPropertyXml(( SimObject object, string filename )) {}
3149
3150/*! @brief Initializes and open the telnet console.
3151
3152@param port^^  Port to listen on for console connections (0 will shut down listening).
3153@param consolePass Password for read/write access to console.
3154@param listenPass  Password for read access to console.
3155@param writerPass  Password for write-only access to console.
3156@param remoteEcho  [optional] Enable echoing back to the client, off by default.
3157
3158@ingroup Debugging */
3159
3160virtual void telnetSetParameters(( int port, String consolePass, String listenPass, String writerPass, bool remoteEcho=false )) {}
3161virtual void dbgSetParameters() {}
3162virtual bool dbgIsConnected() {}
3163virtual void dbgDisconnect() {}
3164virtual void AbilityWidgetRun(( bool showMenu )) {}
3165virtual bool ContextMenuClose(()) {}
3166virtual void ContextMenuScroll(()) {}
3167virtual void ShowSubContextMenu(( string group, GuiControl ctrl )) {}
3168virtual void closeSubContextMenu(()) {}
3169virtual void SelectionHighlight() {}
3170virtual bool isInSelectionHighlightMode() {}
3171virtual void DNetSetLogging() {}
3172virtual void setGameTimeScale() {}
3173virtual float getGameTimeScale() {}
3174virtual void setGameDayTime(( int secondsSinceMidnight )) {}
3175virtual void midnight(()) {}
3176virtual void morning(()) {}
3177virtual void noon(()) {}
3178virtual void evening(()) {}
3179virtual string getGameTime(()) {}
3180virtual void Forest_TestFindTree(( int valForestKey )) {}
3181
3182/*! Populate the font cache for the specified font with characters from the specified string.
3183@param faceName The name of the font face.
3184@param fontSize The size of the font in pixels.
3185@param string The string to populate.
3186@ingroup Font
3187 */
3188
3189virtual void populateFontCacheString(( string faceName, int fontSize, string string )) {}
3190
3191/*! Populate the font cache for the specified font with Unicode code points in the specified range.
3192@param faceName The name of the font face.
3193@param fontSize The size of the font in pixels.
3194@param rangeStart The start Unicode point.
3195@param rangeEnd The end Unicode point.
3196@note We only support BMP-0, so code points range from 0 to 65535.
3197@ingroup Font
3198 */
3199
3200virtual void populateFontCacheRange(( string faceName, int fontSize, int rangeStart, int rangeEnd )) {}
3201
3202/*! Dumps to the console a full description of all cached fonts, along with info on the codepoints each contains.
3203@ingroup Font
3204 */
3205
3206virtual void dumpFontCacheStatus(()) {}
3207
3208/*! Force all cached fonts to serialize themselves to the cache.
3209@ingroup Font
3210 */
3211
3212virtual void writeFontCache(()) {}
3213
3214/*! Populate the font cache for all fonts with characters from the specified string.
3215@ingroup Font
3216 */
3217
3218virtual void populateAllFontCacheString(( string string )) {}
3219
3220/*! Populate the font cache for all fonts with Unicode code points in the specified range.
3221@param rangeStart The start Unicode point.
3222@param rangeEnd The end Unicode point.
3223@note We only support BMP-0, so code points range from 0 to 65535.
3224@ingroup Font
3225 */
3226
3227virtual void populateAllFontCacheRange(( int rangeStart, int rangeEnd )) {}
3228
3229/*! Export specified font to the specified filename as a PNG. The image can then be processed in Photoshop or another tool and reimported using importCachedFont. Characters in the font are exported as one long strip.
3230@param faceName The name of the font face.
3231@param fontSize The size of the font in pixels.
3232@param fileName The file name and path for the output PNG.
3233@param padding The padding between characters.
3234@param kerning The kerning between characters.
3235@ingroup Font
3236 */
3237
3238virtual void exportCachedFont(( string faceName, int fontSize, string fileName, int padding, int kerning )) {}
3239
3240/*! Import an image strip from exportCachedFont. Call with the same parameters you called exportCachedFont.
3241@param faceName The name of the font face.
3242@param fontSize The size of the font in pixels.
3243@param fileName The file name and path for the input PNG.
3244@param padding The padding between characters.
3245@param kerning The kerning between characters.
3246@ingroup Font
3247 */
3248
3249virtual void importCachedFont(( string faceName, int fontSize, string fileName, int padding, int kerning )) {}
3250
3251/*! Copy the specified old font to a new name. The new copy will not have a platform font backing it, and so will never have characters added to it. But this is useful for making copies of fonts to add postprocessing effects to via exportCachedFont.
3252@param oldFontName The name of the font face to copy.
3253@param oldFontSize The size of the font to copy.
3254@param newFontName The name of the new font face.
3255@ingroup Font
3256 */
3257
3258virtual void duplicateCachedFont(( string oldFontName, int oldFontSize, string newFontName )) {}
3259virtual void registerFont(( string fontName )) {}
3260
3261/*! Returns a tab-seperated string of the detected devices across all adapters.
3262@ingroup GFX
3263 */
3264
3265virtual string getDisplayDeviceList(()) {}
3266
3267/*! Returns a list of the unflagged GFX resources. See flagCurrentGFXResources for usage details.
3268@ingroup GFX
3269@see flagCurrentGFXResources, clearGFXResourceFlags, describeGFXResources */
3270
3271virtual void listGFXResources(( bool unflaggedOnly=false )) {}
3272
3273/*! @brief Flags all currently allocated GFX resources.
3274Used for resource allocation and leak tracking by flagging current resources then dumping a list of unflagged resources at some later point in execution.
3275@ingroup GFX
3276@see listGFXResources, clearGFXResourceFlags, describeGFXResources */
3277
3278virtual void flagCurrentGFXResources(()) {}
3279
3280/*! Clears the flagged state on all allocated GFX resources. See flagCurrentGFXResources for usage details.
3281@ingroup GFX
3282@see flagCurrentGFXResources, listGFXResources, describeGFXResources */
3283
3284virtual void clearGFXResourceFlags(()) {}
3285
3286/*! @brief Dumps a description of GFX resources to a file or the console.
3287@param resourceTypes A space seperated list of resource types or an empty string for all resources.
3288@param filePath A file to dump the list to or an empty string to write to the console.
3289@param unflaggedOnly If true only unflagged resources are dumped. See flagCurrentGFXResources.
3290@note The resource types can be one or more of the following:
3291
3292  - texture
3293  - texture target
3294  - window target
3295  - vertex buffers
3296  - primitive buffers
3297  - fences
3298  - cubemaps
3299  - shaders
3300  - stateblocks
3301
3302@ingroup GFX
3303 */
3304
3305virtual void describeGFXResources(( string resourceTypes, string filePath, bool unflaggedOnly=false )) {}
3306
3307/*! Dumps a description of all state blocks.
3308@param filePath A file to dump the state blocks to or an empty string to write to the console.
3309@ingroup GFX
3310 */
3311
3312virtual void describeGFXStateBlocks(( string filePath )) {}
3313
3314/*! Returns the pixel shader version for the active device.
3315@ingroup GFX
3316 */
3317
3318virtual float getPixelShaderVersion(()) {}
3319
3320/*! @brief Sets the pixel shader version for the active device.
3321This can be used to force a lower pixel shader version than is supported by the device for testing or performance optimization.
3322@param version The floating point shader version number.
3323@note This will only affect shaders/materials created after the call and should be used before the game begins.
3324@see $pref::Video::forcedPixVersion
3325@ingroup GFX
3326 */
3327
3328virtual void setPixelShaderVersion(( float version )) {}
3329
3330/*! Get the string describing the active GFX device.
3331@ingroup GFX
3332 */
3333
3334virtual string getDisplayDeviceInformation(()) {}
3335
3336/*! Returns the best texture format for storage of HDR data for the active device.
3337@ingroup GFX
3338 */
3339
3340virtual string getBestHDRFormat(()) {}
3341
3342/*! Get the maximum level of anisotropic filtering supportrf by current GFX device.
3343@ingroup GFX
3344 */
3345
3346virtual int getMaxAnisotropy(()) {}
3347
3348/*! Returns the width, height, and bitdepth of the screen/desktop.
3349
3350@ingroup GFX */
3351
3352virtual string getDesktopResolution(()) {}
3353virtual void rebakeTerrainAtlases() {}
3354virtual void seasonsBakeImposter() {}
3355virtual void seasonsSetMonth() {}
3356virtual void seasonsForcedSetMonth() {}
3357virtual int getCurrentSeasonNum() {}
3358virtual void reloadAllShaders(()) {}
3359virtual void reloadShader(( string name=NULL )) {}
3360virtual void reloadWater(()) {}
3361virtual void reloadRTW(()) {}
3362virtual void reloadTerrain(()) {}
3363
3364/*! Adds a global shader macro which will be merged with the script defined macros on every shader.  The macro will replace the value of an existing macro of the same name.  For the new macro to take effect all the shaders in the system need to be reloaded.
3365@see resetLightManager, removeGlobalShaderMacro
3366@ingroup Rendering
3367 */
3368
3369virtual void addGlobalShaderMacro(( string name, string value=NULL )) {}
3370
3371/*! Removes an existing global macro by name.
3372@see addGlobalShaderMacro
3373@ingroup Rendering
3374 */
3375
3376virtual void removeGlobalShaderMacro(( string name )) {}
3377virtual void triggerTextureMemoryWarning() {}
3378virtual void reloadStreamableTextures() {}
3379virtual void triggerTextureOutOfMemoryError() {}
3380virtual void setAvalableTextureMemory() {}
3381
3382/*! Releases all textures and resurrects the texture manager.
3383@ingroup GFX
3384 */
3385
3386virtual void flushTextureCache(()) {}
3387
3388/*! Release the unused pooled textures in texture manager freeing up video memory.
3389@ingroup GFX
3390 */
3391
3392virtual void cleanupTexturePool(()) {}
3393
3394/*! Reload all the textures from disk.
3395@ingroup GFX
3396 */
3397
3398virtual void reloadTextures(()) {}
3399
3400/*! Dump the textures from disk.
3401@ingroup GFX
3402 */
3403
3404virtual void dumpTextures(()) {}
3405
3406/*! Returns a list of texture profiles in the format: ProfileName TextureCount TextureMB
3407@ingroup GFX
3408 */
3409
3410virtual string getTextureProfileStats(()) {}
3411virtual void printTextureProfileStats() {}
3412
3413/*! Takes a screenshot with optional tiling to produce huge screenshots.
3414@param file The output image file path.
3415@param format Either JPEG or PNG.
3416@param tileCount If greater than 1 will tile the current screen size to take a large format screenshot.
3417@param tileOverlap The amount of horizontal and vertical overlap between the tiles used to remove tile edge artifacts from post effects.
3418@ingroup GFX
3419 */
3420
3421virtual void screenShot(( string file, string format, int tileCount=1, float tileOverlap=0, bool hudless=false )) {}
3422
3423/*! Returns the count of active DDSs files in memory.
3424@ingroup Rendering
3425 */
3426
3427virtual int getActiveDDSFiles(()) {}
3428
3429/*! Returns image info in the following format: width TAB height TAB bytesPerPixel. It will return an empty string if the file is not found.
3430@ingroup Rendering
3431 */
3432
3433virtual string getBitmapInfo(( string filename )) {}
3434virtual void profileCameraInit() {}
3435virtual void profileCameraSavePosition() {}
3436virtual void profileCameraResetPosition() {}
3437virtual void profileCameraStart() {}
3438
3439/*! Begins a video capture session.
3440@see stopVideoCapture
3441@ingroup Rendering
3442 */
3443
3444virtual void startVideoCapture(( GuiCanvas canvas, string filename, string encoder="THEORA", float framerate=30.0f, Point2I resolution=Point2I(0, 0) )) {}
3445
3446/*! Stops the video capture session.
3447@see startVideoCapture
3448@ingroup Rendering
3449 */
3450
3451virtual void stopVideoCapture(()) {}
3452
3453/*! Load a journal file and capture it video.
3454@ingroup Rendering
3455 */
3456
3457virtual void playJournalToVideo(( string journalFile, string videoFile=NULL, string encoder="THEORA", float framerate=30.0f, Point2I resolution=Point2I(0, 0) )) {}
3458virtual void cmHotBarLoadPropertyXml(( string filename )) {}
3459virtual void cmHotBarLoadDataXml(( string filename )) {}
3460virtual void cmHotBarSavePropertyXml(( string filename )) {}
3461virtual void cmHotBarSaveDataXml(( string filename )) {}
3462virtual void HB_SlotActivate(( int tabId, int slotId, bool pressed )) {}
3463virtual void clearHotBars() {}
3464virtual int getHorseHPBarIndex(()) {}
3465virtual int getHorseStaminaBarIndex(()) {}
3466virtual int getBtnShowInventory(()) {}
3467virtual int getBtnShowHeraldry(()) {}
3468virtual int getBtnHideHeraldry(()) {}
3469virtual void dumpAtlas(()) {}
3470virtual void addGlobalImageAtlas(( String atlasFileName, BitmapIndicesEnum elementCount )) {}
3471virtual void clearGlobalImageAtlas(()) {}
3472virtual int getMessageBtnClose(()) {}
3473virtual int getEscMenuButton(( int btn_idx )) {}
3474virtual int getOptionsVideoButton(()) {}
3475virtual int getOptionsBottomBorder(()) {}
3476virtual int getEmptyUnflattenedTilesIcon() {}
3477virtual int getEmptyFlattenedTilesIcon() {}
3478virtual int getBlockedTilesIcon() {}
3479virtual int getAltitudeAboveTileIcon() {}
3480virtual int getTileIconClaimWhite() {}
3481virtual int getTileIconClaimGray() {}
3482virtual int getTileIconClaimDarkGreen() {}
3483virtual int getTileIconClaimGreen() {}
3484virtual int getTileIconClaimRed() {}
3485virtual int getOptionsTopBorder(()) {}
3486virtual int getCombatGnomeStartCooldown(()) {}
3487virtual int getCombatGnomeEndCooldown(()) {}
3488virtual int getBtnGreenhouseNormal(()) {}
3489virtual int getBackgroundEmblem(()) {}
3490virtual int getBtnPositionSymbol(()) {}
3491virtual int getShadowPreview(()) {}
3492virtual int getBackgroundPreview(()) {}
3493virtual int getEmblemColorChervlenNormal(()) {}
3494virtual int getEmblemColorChervlenMouseOver(()) {}
3495virtual int getEmblemColorGoldNormal(()) {}
3496virtual int getEmblemColorGoldMouseOver(()) {}
3497virtual int getEmblemColorGreenNormal(()) {}
3498virtual int getEmblemColorGreenMouseOver(()) {}
3499virtual int getEmblemColorBlackNormal(()) {}
3500virtual int getEmblemColorBlackMouseOver(()) {}
3501virtual int getEmblemColorPurpleNormal(()) {}
3502virtual int getEmblemColorPurpleMouseOver(()) {}
3503virtual int getEmblemColorOrangeNormal(()) {}
3504virtual int getEmblemColorOrangeMouseOver(()) {}
3505virtual int getEmblemColorAzureNormal(()) {}
3506virtual int getEmblemColorAzureMouseOver(()) {}
3507virtual int getEmblemColorSilverNormal(()) {}
3508virtual int getEmblemColorSilverMouseOver(()) {}
3509virtual int getEmblemColorBlackChervlenNormal(()) {}
3510virtual int getEmblemColorBlackChervlenMouseOver(()) {}
3511virtual int getEmblemColorBlackOrangeNormal(()) {}
3512virtual int getEmblemColorBlackOrangeMouseOver(()) {}
3513virtual int getEmblemColorBlackGoldNormal(()) {}
3514virtual int getEmblemColorBlackGoldMouseOver(()) {}
3515virtual int getEmblemColorBlackGreenNormal(()) {}
3516virtual int getEmblemColorBlackGreenMouseOver(()) {}
3517virtual int getEmblemColorBlackAzureNormal(()) {}
3518virtual int getEmblemColorBlackAzureMouseOver(()) {}
3519virtual int getEmblemColorBlackPurpleNormal(()) {}
3520virtual int getEmblemColorBlackPurpleMouseOver(()) {}
3521virtual int getEmblemColorBlackBlackNormal(()) {}
3522virtual int getEmblemColorBlackBlackMouseOver(()) {}
3523virtual int getEmblemColorBlackSilverNormal(()) {}
3524virtual int getEmblemColorBlackSilverMouseOver(()) {}
3525virtual int getEmblemColorSelected(()) {}
3526virtual int getBtnSymbolSizeSmall(()) {}
3527virtual int getBtnSymbolSizeMedium(()) {}
3528virtual int getBtnSymbolSizeLarge(()) {}
3529virtual int getBorderSymbolSelected(()) {}
3530virtual int getShadowBackground(()) {}
3531virtual int getShadowBackgroundMouseOver(()) {}
3532virtual int getShadowSymbol(()) {}
3533virtual int getShadowSymbolMouseOver(()) {}
3534virtual int getRelatedBackgroundIcon(()) {}
3535virtual int getContrastingBackgroundIcon(()) {}
3536virtual int getSymbolLargeIcon(()) {}
3537virtual int getMapStarImageIndex(()) {}
3538virtual int getBtnCenterToPlayerIndex(()) {}
3539virtual int getBtnPolitIndex(()) {}
3540virtual int getBtnHeightIndex(()) {}
3541virtual int getBtnPlusIndex(()) {}
3542virtual int getBtnMapIndex(()) {}
3543virtual int getBtnMinusIndex(()) {}
3544virtual int getMessageBoxPasswordDlgButtonIndex(()) {}
3545virtual int getMessageBoxPasswordDlgCheckBoxStateOn(()) {}
3546virtual int getMessageBoxPasswordDlgCheckBoxStateOff(()) {}
3547virtual int getMessageBoxPasswordDlgTextEditLeft(()) {}
3548virtual int getMessageBoxPasswordDlgTextEditRight(()) {}
3549virtual int getMessageBoxPasswordDlgTextEditBackground(()) {}
3550virtual int getVerticalSeparatorUserList(()) {}
3551virtual int getHorizontalSeparatorUserList(()) {}
3552virtual int getMonumentCrownLeader(()) {}
3553virtual int getBtnExclude(()) {}
3554virtual int getMonumentTextEditBorder(()) {}
3555virtual int getBtnEdit(()) {}
3556virtual int getBtnEditApply(()) {}
3557virtual int getBtnEditCancel(()) {}
3558virtual int getMonumentProgressBorder(()) {}
3559virtual int getMonumentProgressBackground(()) {}
3560virtual int getMonumentIconPnl(()) {}
3561virtual int getMonumentIcon(()) {}
3562virtual int getMonumentLvlUpBtn(()) {}
3563virtual int MonumentProgressBar(()) {}
3564virtual int getMonumentUserListBtnPnl(()) {}
3565virtual int getBtnKick(()) {}
3566virtual int getBuildListItemsSkillPnl(()) {}
3567virtual int getListItemDecor(()) {}
3568virtual int getShadowBorderBottom(()) {}
3569virtual int getShadowBorderLeft(()) {}
3570virtual int getSkillStatBtnPanel(()) {}
3571virtual int getSkillBtnIcon(()) {}
3572virtual int getStatBtnIcon(()) {}
3573virtual int getGuildBtnIcon(()) {}
3574virtual int getCraftSkill(()) {}
3575virtual int getCombatSkill(()) {}
3576virtual int getMinorSkill(()) {}
3577virtual int getSelectSkill(()) {}
3578virtual int getSkillItemActiveBorder(()) {}
3579virtual int getSkillBtnStatus(()) {}
3580virtual int getCharacterStatusBorder(()) {}
3581virtual int getGuildNameBorder(()) {}
3582virtual int getGuildEditNameBorder(()) {}
3583virtual int getHungerPanel(()) {}
3584virtual int getHealthPanel(()) {}
3585virtual int getLvlPanel(()) {}
3586virtual int getSkillcapBar(()) {}
3587virtual int getSkillDescriptionDecorLine(()) {}
3588virtual int getSkillLine(()) {}
3589virtual void changeStrengthLock() {}
3590virtual void changeAgilityLock() {}
3591virtual void changeWillpowerLock() {}
3592virtual void changeIntellectLock() {}
3593virtual void changeConstitutionLock() {}
3594virtual string CmGuiChatSelectedWindow(()) {}
3595virtual void activateCmChat(()) {}
3596virtual void clearChatWindows() {}
3597virtual void CloseSelectionList() {}
3598virtual void SelectionListSelect() {}
3599
3600/*! @brief Strip TorqueML control characters from the specified string, returning a 'clean' version.
3601
3602@param inString String to strip TorqueML control characters from.
3603@tsexample
3604// Define the string to strip TorqueML control characters from
3605%string = "<font:Arial:24>How Now <color:c43c12>Brown <color:000000>Cow";
3606
3607// Request the stripped version of the string
3608%strippedString = StripMLControlChars(%string);
3609@endtsexample
3610
3611@return Version of the inputted string with all TorqueML characters removed.
3612
3613@see References
3614
3615@ingroup GuiCore */
3616
3617virtual string StripMLControlChars(( string inString )) {}
3618
3619/*! @brief Used to exclude/prevent all other instances using the same identifier specified
3620
3621@note Not used on OSX, Xbox, or in Win debug builds
3622
3623@param appIdentifier Name of the app set up for exclusive use.
3624@return False if another app is running that specified the same appIdentifier
3625
3626@ingroup Platform
3627@ingroup GuiCore */
3628
3629virtual bool excludeOtherInstance(( string appIdentifer )) {}
3630virtual bool isCanvasFocused(()) {}
3631virtual void setCmFreelookMode(( bool freelookMode, bool ignorCounter )) {}
3632virtual bool getCmFreelookMode() {}
3633virtual void setCmEditGuiMode() {}
3634virtual void toggleConsole() {}
3635virtual void overridePlatformCursor() {}
3636virtual void showCursor() {}
3637virtual void hideCursor() {}
3638virtual void CloseAcceptDlg() {}
3639virtual void CheckboxClicked() {}
3640virtual void AcceptSentence() {}
3641virtual void debugShowSpecAttack() {}
3642virtual void updateGmIndication() {}
3643virtual int getComboWindowStartCooldown() {}
3644virtual int getComboWindowEndCooldown() {}
3645virtual void CraftOptionsClose() {}
3646virtual void CraftOptionsSelect1() {}
3647virtual void CraftOptionsSelect2() {}
3648virtual void CraftOptionsSelect3() {}
3649virtual void CraftOptionsSelect4() {}
3650virtual int getCreateWorldWindowBackground() {}
3651virtual int getCreateWorldWindowBigCheckBox() {}
3652virtual int getCreateWorldWindowSmallCheckBox() {}
3653virtual int getCreateWorldWindowSplitter() {}
3654virtual int getCreatedWorldListSplitter() {}
3655virtual int getCreateWorldButtonWorldInfo() {}
3656
3657/*! cmShowMessage() */
3658
3659virtual void GuiPersonalClaimPremiumResize(( bool buy )) {}
3660virtual void setMinigameUrl() {}
3661virtual string getGuildHeraldryCooldown(()) {}
3662virtual void alchemyCraftButtonClick(()) {}
3663virtual int getBarterWindowWorkAreaSplitter() {}
3664virtual bool CreateCraftToolWindow(()) {}
3665virtual void testSmelting() {}
3666virtual int getTradePostWindowBackground() {}
3667virtual void changeStoreCoins(( int selectedId, int playerCoins, int tradePostCoins )) {}
3668virtual void changeStoreSize() {}
3669virtual void onLoadGuiComplete() {}
3670virtual int getTrebuchetAngleAttackBackground() {}
3671virtual int getTrebuchetAngleAttackSlider() {}
3672virtual int getTrebuchetAngleAttackRotationCenter() {}
3673virtual int getTrebuchetFireButton() {}
3674virtual void initTooltipTemplateManager() {}
3675virtual void removeTooltipTemplateManager() {}
3676virtual void addTooltipTemplate(( TooltipFunctionType function, int id, String metod )) {}
3677virtual int getGroupWindowHardHPBar() {}
3678virtual int getGroupWindowSoftHPBar() {}
3679virtual int getGroupWindowHardStamBar() {}
3680virtual int getGroupWindowSoftStamBar() {}
3681virtual int getGroupWindowWidgetBackground() {}
3682virtual int getGroupWindowWidgetLeftBorder() {}
3683virtual int getGroupWindowWidgetRightBorder() {}
3684virtual int getCoreLangTable() {}
3685virtual void setCoreLangTable() {}
3686
3687/*! A callback called by the engine when a light manager is activated.
3688@param name The name of the light manager being activated.
3689@ingroup Lighting
3690 */
3691
3692void onLightManagerActivate( string name );
3693 {01} <ConsoleEntry::eval> [432241] 
3694
3695/*! A callback called by the engine when a light manager is deactivated.
3696@param name The name of the light manager being deactivated.
3697@ingroup Lighting
3698 */
3699
3700void onLightManagerDeactivate( string name );
3701 {01} <ConsoleEntry::eval> [432241] 
3702
3703/*! Finds and activates the named light manager.
3704@return Returns true if the light manager is found and activated.
3705@ingroup Lighting
3706 */
3707
3708virtual bool setLightManager(( string name )) {}
3709
3710/*! Will generate static lighting for the scene if supported by the active light manager.
3711
3712If mode is "forceAlways", the lightmaps will be regenerated regardless of whether lighting cache files can be written to. If mode is "forceWritable", then the lightmaps will be regenerated only if the lighting cache files can be written.
3713@param completeCallbackFn The name of the function to execute when the lighting is complete.
3714@param mode One of "forceAlways",  "forceWritable" or "loadOnly".
3715@return Returns true if the scene lighting process was started.
3716@ingroup Lighting
3717 */
3718
3719virtual bool lightScene(( string completeCallbackFn=NULL, string mode=NULL )) {}
3720
3721/*! Returns a tab seperated list of light manager names.
3722@ingroup Lighting
3723 */
3724
3725virtual string getLightManagerNames(()) {}
3726
3727/*! Returns the active light manager name.
3728@ingroup Lighting
3729 */
3730
3731virtual string getActiveLightManager(()) {}
3732
3733/*! @brief Deactivates and then activates the currently active light manager.This causes most shaders to be regenerated and is often used when global rendering changes have occured.
3734@ingroup Lighting
3735 */
3736
3737virtual void resetLightManager(()) {}
3738virtual bool setShadowManager() {}
3739virtual string setShadowVizLight() {}
3740virtual void reInitMaterials() {}
3741virtual void addMaterialMapping() {}
3742virtual string getMaterialMapping() {}
3743virtual void dumpMaterialInstances() {}
3744virtual string getMapEntry() {}
3745
3746/*! Add two vectors.
3747@param a The first vector.
3748@param b The second vector.
3749@return The vector @a a + @a b.
3750
3751@tsexample
3752//-----------------------------------------------------------------------------
3753//
3754// VectorAdd( %a, %b );
3755//
3756// The sum of vector a, (ax, ay, az), and vector b, (bx, by, bz) is:
3757//
3758//     a + b = ( ax + bx, ay + by, az + bz )
3759//
3760//-----------------------------------------------------------------------------
3761%a = "1 0 0";
3762%b = "0 1 0";
3763
3764// %r = "( 1 + 0, 0 + 1, 0 + 0 )";
3765// %r = "1 1 0";
3766%r = VectorAdd( %a, %b );
3767@endtsexample
3768
3769@ingroup Vectors */
3770
3771virtual string VectorAdd(( VectorF a, VectorF b )) {}
3772
3773/*! Subtract two vectors.
3774@param a The first vector.
3775@param b The second vector.
3776@return The vector @a a - @a b.
3777
3778@tsexample
3779//-----------------------------------------------------------------------------
3780//
3781// VectorSub( %a, %b );
3782//
3783// The difference of vector a, (ax, ay, az), and vector b, (bx, by, bz) is:
3784//
3785//     a - b = ( ax - bx, ay - by, az - bz )
3786//
3787//-----------------------------------------------------------------------------
3788
3789%a = "1 0 0";
3790%b = "0 1 0";
3791
3792// %r = "( 1 - 0, 0 - 1, 0 - 0 )";
3793// %r = "1 -1 0";
3794%r = VectorSub( %a, %b );
3795@endtsexample
3796
3797@ingroup Vectors */
3798
3799virtual string VectorSub(( VectorF a, VectorF b )) {}
3800
3801/*! Scales a vector by a scalar.
3802@param a The vector to scale.
3803@param scalar The scale factor.
3804@return The vector @a a * @a scalar.
3805
3806@tsexample
3807//-----------------------------------------------------------------------------
3808//
3809// VectorScale( %a, %v );
3810//
3811// Scaling vector a, (ax, ay, az), but the scalar, v, is:
3812//
3813//     a * v = ( ax * v, ay * v, az * v )
3814//
3815//-----------------------------------------------------------------------------
3816
3817%a = "1 1 0";
3818%v = "2";
3819
3820// %r = "( 1 * 2, 1 * 2, 0 * 2 )";
3821// %r = "2 2 0";
3822%r = VectorScale( %a, %v );
3823@endtsexample
3824
3825@ingroup Vectors */
3826
3827virtual string VectorScale(( VectorF a, float scalar )) {}
3828
3829/*! Brings a vector into its unit form, i.e. such that it has the magnitute 1.
3830@param v The vector to normalize.
3831@return The vector @a v scaled to length 1.
3832
3833@tsexample
3834//-----------------------------------------------------------------------------
3835//
3836// VectorNormalize( %a );
3837//
3838// The normalized vector a, (ax, ay, az), is:
3839//
3840//     a^ = a / ||a||
3841//        = ( ax / ||a||, ay / ||a||, az / ||a|| )
3842//
3843//-----------------------------------------------------------------------------
3844
3845%a = "1 1 0";
3846%l = 1.414;
3847
3848// %r = "( 1 / 1.141, 1 / 1.141, 0 / 1.141 )";
3849// %r = "0.707 0.707 0";
3850%r = VectorNormalize( %a );
3851@endtsexample
3852
3853@ingroup Vectors */
3854
3855virtual string VectorNormalize(( VectorF v )) {}
3856
3857/*! Compute the dot product of two vectors.
3858@param a The first vector.
3859@param b The second vector.
3860@return The dot product @a a * @a b.
3861
3862@tsexample
3863//-----------------------------------------------------------------------------
3864//
3865// VectorDot( %a, %b );
3866//
3867// The dot product between vector a, (ax, ay, az), and vector b, (bx, by, bz), is:
3868//
3869//     a . b = ( ax * bx + ay * by + az * bz )
3870//
3871//-----------------------------------------------------------------------------
3872
3873%a = "1 1 0";
3874%b = "2 0 1";
3875
3876// %r = "( 1 * 2 + 1 * 0 + 0 * 1 )";
3877// %r = 2;
3878%r = VectorDot( %a, %b );
3879@endtsexample
3880
3881@ingroup Vectors */
3882
3883virtual float VectorDot(( VectorF a, VectorF b )) {}
3884
3885/*! Calculcate the cross product of two vectors.
3886@param a The first vector.
3887@param b The second vector.
3888@return The cross product @a x @a b.
3889
3890@tsexample
3891//-----------------------------------------------------------------------------
3892//
3893// VectorCross( %a, %b );
3894//
3895// The cross product of vector a, (ax, ay, az), and vector b, (bx, by, bz), is
3896//
3897//     a x b = ( ( ay * bz ) - ( az * by ), ( az * bx ) - ( ax * bz ), ( ax * by ) - ( ay * bx ) )
3898//
3899//-----------------------------------------------------------------------------
3900
3901%a = "1 1 0";
3902%b = "2 0 1";
3903
3904// %r = "( ( 1 * 1 ) - ( 0 * 0 ), ( 0 * 2 ) - ( 1 * 1 ), ( 1 * 0 ) - ( 1 * 2 ) )";
3905// %r = "1 -1 -2";
3906%r = VectorCross( %a, %b );
3907@endtsexample
3908
3909@ingroup Vectors */
3910
3911virtual string VectorCross(( VectorF a, VectorF b )) {}
3912
3913/*! Compute the distance between two vectors.
3914@param a The first vector.
3915@param b The second vector.
3916@return The length( @a b - @a a ).
3917
3918@tsexample
3919//-----------------------------------------------------------------------------
3920//
3921// VectorDist( %a, %b );
3922//
3923// The distance between vector a, (ax, ay, az), and vector b, (bx, by, bz), is
3924//
3925//     a -> b = ||( b - a )||
3926//            = ||( bx - ax, by - ay, bz - az )||
3927//            = mSqrt( ( bx - ax ) * ( bx - ax ) + ( by - ay ) * ( by - ay ) + ( bz - az ) * ( bz - az ) )
3928//
3929//-----------------------------------------------------------------------------
3930
3931%a = "1 1 0";
3932%b = "2 0 1";
3933
3934// %r = mSqrt( ( 2 - 1 ) * ( 2 - 1) + ( 0 - 1 ) * ( 0 - 1 ) + ( 1 - 0 ) * ( 1 - 0 ) );
3935// %r = mSqrt( 3 );
3936%r = VectorDist( %a, %b );
3937@endtsexample
3938
3939@ingroup Vectors */
3940
3941virtual float VectorDist(( VectorF a, VectorF b )) {}
3942
3943/*! Calculate the magnitude of the given vector.
3944@param v A vector.
3945@return The length of vector @a v.
3946
3947@tsexample
3948//-----------------------------------------------------------------------------
3949//
3950// VectorLen( %a );
3951//
3952// The length or magnitude of  vector a, (ax, ay, az), is:
3953//
3954//     ||a|| = Sqrt( ax * ax + ay * ay + az * az )
3955//
3956//-----------------------------------------------------------------------------
3957
3958%a = "1 1 0";
3959
3960// %r = mSqrt( 1 * 1 + 1 * 1 + 0 * 0 );
3961// %r = mSqrt( 2 );
3962// %r = 1.414;
3963%r = VectorLen( %a );
3964@endtsexample
3965
3966@ingroup Vectors */
3967
3968virtual float VectorLen(( VectorF v )) {}
3969
3970/*! Create an orthogonal basis from the given vector.
3971@param aaf The vector to create the orthogonal basis from.
3972@return A matrix representing the orthogonal basis.
3973@ingroup Vectors */
3974
3975virtual string VectorOrthoBasis(( AngAxisF aa )) {}
3976
3977/*! Linearly interpolate between two vectors by @a t.
3978@param a Vector to start interpolation from.
3979@param b Vector to interpolate to.
3980@param t Interpolation factor (0-1).  At zero, @a a is returned and at one, @a b is returned.  In between, an interpolated vector between @a a and @a b is returned.
3981@return An interpolated vector between @a a and @a b.
3982
3983@tsexample
3984//-----------------------------------------------------------------------------
3985//
3986// VectorLerp( %a, %b );
3987//
3988// The point between vector a, (ax, ay, az), and vector b, (bx, by, bz), which is
3989// weighted by the interpolation factor, t, is
3990//
3991//     r = a + t * ( b - a )
3992//       = ( ax + t * ( bx - ax ), ay + t * ( by - ay ), az + t * ( bz - az ) )
3993//
3994//-----------------------------------------------------------------------------
3995
3996%a = "1 1 0";
3997%b = "2 0 1";
3998%v = "0.25";
3999
4000// %r = "( 1 + 0.25 * ( 2 - 1 ), 1 + 0.25 * ( 0 - 1 ), 0 + 0.25 * ( 1 - 0 ) )";
4001// %r = "1.25 0.75 0.25";
4002%r = VectorLerp( %a, %b );
4003@endtsexample
4004
4005@ingroup Vectors */
4006
4007virtual string VectorLerp(( VectorF a, VectorF b, float t )) {}
4008
4009/*! Create a transform from the given translation and orientation.
4010@param position The translation vector for the transform.
4011@param orientation The axis and rotation that orients the transform.
4012@return A transform based on the given position and orientation.
4013@ingroup Matrices */
4014
4015virtual string MatrixCreate(( VectorF position, AngAxisF orientation )) {}
4016
4017/*! @Create a matrix from the given rotations.
4018
4019@param Vector3F X, Y, and Z rotation in *radians*.
4020@return A transform based on the given orientation.
4021@ingroup Matrices */
4022
4023virtual string MatrixCreateFromEuler(( Point3F angles )) {}
4024
4025/*! @brief Multiply the two matrices.
4026
4027@param left First transform.
4028@param right Right transform.
4029@return Concatenation of the two transforms.
4030@ingroup Matrices */
4031
4032virtual string MatrixMultiply(( TransformF left, TransformF right )) {}
4033
4034/*! @brief Multiply the vector by the transform assuming that w=0.
4035
4036This function will multiply the given vector by the given transform such that translation will not affect the vector.
4037
4038@param transform A transform.
4039@param vector A vector.
4040@return The transformed vector.
4041@ingroup Matrices */
4042
4043virtual string MatrixMulVector(( TransformF transform, VectorF vector )) {}
4044
4045/*! @brief Multiply the given point by the given transform assuming that w=1.
4046
4047This function will multiply the given vector such that translation with take effect.
4048@param transform A transform.
4049@param point A vector.
4050@return The transformed vector.
4051@ingroup Matrices */
4052
4053virtual string MatrixMulPoint(( TransformF transform, Point3F point )) {}
4054
4055/*! Get the center point of an axis-aligned box.
4056
4057@param b A Box3F, in string format using "minExtentX minExtentY minExtentZ maxExtentX maxExtentY maxExtentZ"
4058@return Center of the box.
4059@ingroup Math */
4060
4061virtual string getBoxCenter(( Box3F box )) {}
4062
4063/*! Set the current seed for the random number generator.
4064Based on this seed, a repeatable sequence of numbers will be produced by getRandom().
4065@param seed The seed with which to initialize the randon number generator with.  The same seed will always leed tothe same sequence of pseudo-random numbers.
4066If -1, the current timestamp will be used as the seed which is a good basis for randomization.
4067@ingroup Random */
4068
4069virtual void setRandomSeed(( int seed=-1 )) {}
4070
4071/*! Get the current seed used by the random number generator.
4072@return The current random number generator seed value.
4073@ingroup Random */
4074
4075virtual int getRandomSeed(()) {}
4076virtual float getRandom() {}
4077
4078/*! Solve a quadratic equation (2nd degree polynomial) of form a*x^2 + b*x + c = 0.
4079@param a First Coefficient.@param b Second Coefficient.@param c Third Coefficient.@returns A triple, containing: (sol x0 x1). (sol) is the number of solutions(being 0, 1, or 2), and (x0) and (x1) are the solutions, if any.@ingroup Math */
4080
4081virtual string mSolveQuadratic(( float a, float b, float c )) {}
4082
4083/*! Solve a cubic equation (3rd degree polynomial) of form a*x^3 + b*x^2 + c*x + d = 0.
4084@param a First Coefficient.@param b Second Coefficient.@param c Third Coefficient.@param d Fourth Coefficient.@returns A 4-tuple, containing: (sol x0 x1 x2). (sol) is the number of solutions(being 0, 1, 2 or 3), and (x0), (x1) and (x2) are the solutions, if any.@ingroup Math */
4085
4086virtual string mSolveCubic(( float a, float b, float c, float d )) {}
4087
4088/*! Solve a quartic equation (4th degree polynomial) of form a*x^4 + b*x^3 + c*x^2 + d*x + e = 0.
4089@param a First Coefficient.@param b Second Coefficient.@param c Third Coefficient.@param d Fourth Coefficient.@param e Fifth Coefficient.@returns A 5-tuple, containing: (sol x0 x1 x2 c3). (sol) is the number of solutions(being 0, 1, 2, 3 or 4), and (x0), (x1), (x2) and (x3) are the solutions, if any.@ingroup Math */
4090
4091virtual string mSolveQuartic(( float a, float b, float c, float d, float e )) {}
4092
4093/*! Round v down to the nearest integer.
4094@param v Number to convert to integer.@returns Number converted to integer.@ingroup Math */
4095
4096virtual int mFloor(( float v )) {}
4097
4098/*! Round v to the nearest integer.
4099@param v Number to convert to integer.@returns Number converted to integer.@ingroup Math */
4100
4101virtual int mRound(( float v )) {}
4102
4103/*! Round v up to the nearest integer.
4104@param v Number to convert to integer.@returns Number converted to integer.@ingroup Math */
4105
4106virtual int mCeil(( float v )) {}
4107
4108/*! Formats the specified number to the given number of decimal places.
4109@param v Number to format.@param precision Number of decimal places to format to (1-9).@returns Number formatted to the specified number of decimal places.@ingroup Math */
4110
4111virtual string mFloatLength(( float v, int precision )) {}
4112
4113/*! Calculate absolute value of specified value.
4114@param v Input Value.@returns Absolute value of specified value.@ingroup Math */
4115
4116virtual float mAbs(( float v )) {}
4117
4118/*! Calculate the remainder of v/d.
4119@param v Input Value.@param d Divisor Value.@returns The remainder of v/d.@ingroup Math */
4120
4121virtual float mFMod(( float v, float d )) {}
4122
4123/*! Calculate the square-root of v.
4124@param v Input Value.@returns The square-root of the input value.@ingroup Math */
4125
4126virtual float mSqrt(( float v )) {}
4127
4128/*! Calculate b raised to the p-th power.
4129@param v Input Value.@param p Power to raise value by.@returns v raised to the p-th power.@ingroup Math */
4130
4131virtual float mPow(( float v, float p )) {}
4132
4133/*! Calculate the natural logarithm of v.
4134@param v Input Value.@returns The natural logarithm of the input value.@ingroup Math */
4135
4136virtual float mLog(( float v )) {}
4137
4138/*! Calculate the sine of v.
4139@param v Input Value (in radians).@returns The sine of the input value.@ingroup Math */
4140
4141virtual float mSin(( float v )) {}
4142
4143/*! Calculate the cosine of v.
4144@param v Input Value (in radians).@returns The cosine of the input value.@ingroup Math */
4145
4146virtual float mCos(( float v )) {}
4147
4148/*! Calculate the tangent of v.
4149@param v Input Value (in radians).@returns The tangent of the input value.@ingroup Math */
4150
4151virtual float mTan(( float v )) {}
4152
4153/*! Calculate the arc-sine of v.
4154@param v Input Value (in radians).@returns The arc-sine of the input value.@ingroup Math */
4155
4156virtual float mAsin(( float v )) {}
4157
4158/*! Calculate the arc-cosine of v.
4159@param v Input Value (in radians).@returns The arc-cosine of the input value.@ingroup Math */
4160
4161virtual float mAcos(( float v )) {}
4162
4163/*! Calculate the arc-tangent (slope) of a line defined by rise and run.
4164@param rise of line.@param run of line.@returns The arc-tangent (slope) of a line defined by rise and run.@ingroup Math */
4165
4166virtual float mAtan(( float rise, float run )) {}
4167
4168/*! Convert specified radians into degrees.
4169@param radians Input Value (in radians).@returns The specified radians value converted to degrees.@ingroup Math */
4170
4171virtual float mRadToDeg(( float radians )) {}
4172
4173/*! Convert specified degrees into radians.
4174@param degrees Input Value (in degrees).@returns The specified degrees value converted to radians.@ingroup Math */
4175
4176virtual float mDegToRad(( float degrees )) {}
4177
4178/*! Clamp the specified value between two bounds.
4179@param v Input value.@param min Minimum Bound.@param max Maximum Bound.@returns The specified value clamped to the specified bounds.@ingroup Math */
4180
4181virtual float mClamp(( float v, float min, float max )) {}
4182
4183/*! Clamp the specified value between 0 and 1 (inclusive).
4184@param v Input value.@returns The specified value clamped between 0 and 1 (inclusive).@ingroup Math */
4185
4186virtual float mSaturate(( float v )) {}
4187
4188/*! Calculate the greater of two specified numbers.
4189@param v1 Input value.@param v2 Input value.@returns The greater value of the two specified values.@ingroup Math */
4190
4191virtual float getMax(( float v1, float v2 )) {}
4192
4193/*! Calculate the lesser of two specified numbers.
4194@param v1 Input value.@param v2 Input value.@returns The lesser value of the two specified values.@ingroup Math */
4195
4196virtual float getMin(( float v1, float v2 )) {}
4197
4198/*! Calculate linearly interpolated value between two specified numbers using specified normalized time.
4199@param v1 Interpolate From Input value.@param v2 Interpolate To Input value.@param time Normalized time used to interpolate values (0-1).@returns The interpolated value between the two specified values at normalized time t.@ingroup Math */
4200
4201virtual float mLerp(( float v1, float v2, float time )) {}
4202
4203/*! Return the value of PI (half-circle in radians).
4204@returns The value of PI.@ingroup Math */
4205
4206virtual float mPi(()) {}
4207
4208/*! Return the value of 2*PI (full-circle in radians).
4209@returns The value of 2*PI.@ingroup Math */
4210
4211virtual float m2Pi(()) {}
4212
4213/*! Returns whether the value is an exact power of two.
4214@param v Input value.@returns Whether the specified value is an exact power of two.@ingroup Math */
4215
4216virtual bool mIsPow2(( int v )) {}
4217virtual void TestMarching() {}
4218virtual void TestAdvancedMarching() {}
4219virtual void TestSphere() {}
4220virtual void TestPrism() {}
4221virtual void SwitchPoints() {}
4222virtual void CleanTestMarching() {}
4223virtual void csInit(( TCPConnection cs, GeoID::UnderlyingType rawGeoId, int serverId )) {}
4224virtual void csReset(()) {}
4225virtual void csReInit(( TCPConnection cs, GeoID::UnderlyingType rawGeoId, int serverId )) {}
4226virtual string getTerFilePath(( int terID, string basePath=nullptr )) {}
4227virtual string getTer2FilePath_Server_Index(( int terID, string basePath=nullptr )) {}
4228virtual string getTer2FilePath_Server_Data(( int terID, string basePath=nullptr )) {}
4229virtual string getTer2FilePath_Client_Index(( int terID, string basePath=nullptr )) {}
4230virtual string getTer2FilePath_Client_Data(( int terID, string basePath=nullptr )) {}
4231virtual void recreatePatcher() {}
4232virtual string getServerUuid() {}
4233virtual void restartInstance() {}
4234virtual int getCurrentProcessId() {}
4235virtual string getComputerName() {}
4236virtual string getCLocaleName() {}
4237virtual string getIcuLocaleName() {}
4238virtual int getIcuLCID() {}
4239virtual int sysinfoGetWindowsVersionMajor() {}
4240virtual int sysinfoGetWindowsVersionMinor() {}
4241virtual string sysinfoGetTotalVirtualMemory() {}
4242virtual string sysinfoGetUsedVirtualMemory() {}
4243virtual string sysinfoGetFreeVirtualMemory() {}
4244virtual string sysinfoGetOwnVirtualMemoryUsage() {}
4245virtual string sysinfoGetTotalPhysicalMemory() {}
4246virtual string sysinfoGetUsedPhysicalMemory() {}
4247virtual string sysinfoGetFreePhysicalMemory() {}
4248virtual string sysinfoGetOwnMemoryUsage() {}
4249virtual string sysinfoGetCPUUsage() {}
4250virtual string sysinfoGetOwnCPUUsage() {}
4251virtual string getTemporaryDirectory() {}
4252virtual string getTemporaryFileName() {}
4253virtual string getUserDataDirectory() {}
4254virtual string getUserHomeDirectory() {}
4255virtual string getIPLocal() {}
4256virtual bool redbookOpen() {}
4257virtual bool redbookClose() {}
4258virtual bool redbookPlay() {}
4259virtual bool redbookStop() {}
4260virtual int redbookGetTrackCount() {}
4261virtual float redbookGetVolume() {}
4262virtual bool redbookSetVolume() {}
4263virtual int redbookGetDeviceCount() {}
4264virtual string redbookGetDeviceName() {}
4265virtual string redbookGetLastError() {}
4266virtual int startPrecisionTimer() {}
4267virtual int stopPrecisionTimer() {}
4268
4269/*! Display a modal message box using the platform's native message box implementation.
4270
4271@param title The title to display on the message box window.
4272@param message The text message to display in the box.
4273@param buttons Which buttons to put on the message box.
4274@param icons Which icon to show next to the message.
4275@return One of $MROK, $MRCancel, $MRRetry, and $MRDontSave identifying the button that the user pressed.
4276@tsexample
4277messageBox( "Error", "" );
4278@endtsexample
4279
4280@ingroup Platform */
4281
4282virtual int messageBox(( string title, string message, MBButtons buttons=MBOkCancel, MBIcons icons=MIInformation )) {}
4283virtual void initDisplayDeviceInfo() {}
4284virtual void updateWinConsoleTitle() {}
4285
4286/*! enableWinconsole(bool); */
4287
4288virtual void enableWinConsole(( bool doEnable )) {}
4289
4290/*! Shut down the engine and exit its process.
4291This function cleanly uninitializes the engine and then exits back to the system with a process exit status indicating a clean exit.
4292
4293@see quitWithErrorMessage
4294
4295@ingroup Platform */
4296
4297virtual void quit(()) {}
4298virtual string getWindowsVersionName() {}
4299virtual string getWindowsVersionNum() {}
4300virtual string getExperienceRating() {}
4301virtual int getRAMavail() {}
4302virtual int getRAMtotal() {}
4303virtual string getWindowsDefaultLocaleName() {}
4304virtual string getWindowsUserDefaultLocaleName() {}
4305virtual int getWindowsDefaultLangID() {}
4306virtual bool enableJoystick() {}
4307virtual void disableJoystick() {}
4308virtual bool isJoystickEnabled() {}
4309virtual bool enableXInput() {}
4310virtual void disableXInput() {}
4311virtual void resetXInput() {}
4312virtual bool isXInputConnected() {}
4313virtual int getXInputState() {}
4314virtual void echoInputState() {}
4315virtual void rumble() {}
4316virtual bool shellExecute() {}
4317virtual bool isJoystickDetected() {}
4318virtual string getJoystickAxes() {}
4319virtual void mathInit() {}
4320virtual bool checkNamedPipeOpen(( String pipeName )) {}
4321virtual bool isPipedStdIO(()) {}
4322virtual void askToGenerateCrashReport(( int errorCodeId, String errorCodeMsg )) {}
4323virtual void ping(( int level, int timestamp )) {}
4324virtual void crtEnableDebug() {}
4325virtual void crtCheckMemory() {}
4326virtual bool isKoreanBuild() {}
4327
4328/*! Creates a 64x64 normal map texture filled with noise. The texture is saved to randNormTex.png in the location of the game executable.
4329
4330@ingroup GFX */
4331
4332virtual void dumpRandomNormalMap(()) {}
4333virtual void reloadWeather() {}
4334virtual void toggleWeather() {}
4335virtual void clearServerPaths() {}
4336virtual void clearClientPaths() {}
4337
4338/*! Set the reflection texture format.
4339@ingroup GFX
4340 */
4341
4342virtual void setReflectFormat(( GFXFormat format )) {}
4343
4344/*! @brief See if any objects of the given types are present in box of given extent.
4345
4346@note Extent parameter is last since only one radius is often needed.  If one radius is provided, the yRadius and zRadius are assumed to be the same.  Unfortunately, if you need to use the client container, you'll need to set all of the radius parameters.  Fortunately, this function is mostly used on the server.
4347@param  mask   Indicates the type of objects we are checking against.
4348@param  center Center of box.
4349@param  xRadius Search radius in the x-axis. See note above.
4350@param  yRadius Search radius in the y-axis. See note above.
4351@param  zRadius Search radius in the z-axis. See note above.
4352@param useClientContainer Optionally indicates the search should be within the client container.
4353@return true if the box is empty, false if any object is found.
4354@ingroup Game */
4355
4356virtual bool containerBoxEmpty(( int mask, Point3F center, float xRadius, float yRadius=-1, float zRadius=-1, bool useClientContainer=false )) {}
4357
4358/*! @brief Start a search for items at the given position and within the given radius, filtering by mask.
4359
4360@param pos Center position for the search
4361@param radius Search radius
4362@param mask Bitmask of object types to include in the search
4363@param useClientContainer Optionally indicates the search should be within the client container.
4364@see containerSearchNext
4365@ingroup Game */
4366
4367virtual void initContainerRadiusSearch(( Point3F pos, float radius, int mask, bool useClientContainer=false )) {}
4368
4369/*! @brief Start a search for all items of the types specified by the bitset mask.
4370
4371@param mask Bitmask of object types to include in the search
4372@param useClientContainer Optionally indicates the search should be within the client container.
4373@see containerSearchNext
4374@ingroup Game */
4375
4376virtual void initContainerTypeSearch(( int mask, bool useClientContainer=false )) {}
4377
4378/*! @brief Get next item from a search started with initContainerRadiusSearch() or initContainerTypeSearch().
4379
4380@param useClientContainer Optionally indicates the search should be within the client container.
4381@return the next object found in the search, or null if no more
4382@tsexample
4383// print the names of all nearby ShapeBase derived objects
4384%position = %obj.getPosition;
4385%radius = 20;
4386%mask = $TypeMasks::ShapeBaseObjectType;
4387initContainerRadiusSearch( %position, %radius, %mask );
4388while ( (%targetObject = containerSearchNext()) != 0 )
4389{
4390echo( "Found: " @ %targetObject.getName() );
4391}
4392@endtsexample
4393@see initContainerRadiusSearch()
4394@see initContainerTypeSearch()
4395@ingroup Game */
4396
4397virtual string containerSearchNext(( bool useClientContainer=false )) {}
4398
4399/*! @brief Get distance of the center of the current item from the center of the current initContainerRadiusSearch.
4400
4401@param useClientContainer Optionally indicates the search should be within the client container.
4402@return distance from the center of the current object to the center of the search
4403@see containerSearchNext
4404@ingroup Game */
4405
4406virtual float containerSearchCurrDist(( bool useClientContainer=false )) {}
4407
4408/*! @brief Get the distance of the closest point of the current item from the center of the current initContainerRadiusSearch.
4409
4410@param useClientContainer Optionally indicates the search should be within the client container.
4411@return distance from the closest point of the current object to the center of the search
4412@see containerSearchNext
4413@ingroup Game */
4414
4415virtual float containerSearchCurrRadiusDist(( bool useClientContainer=false )) {}
4416virtual void listObjects(()) {}
4417
4418/*! @brief Cast a ray from start to end, checking for collision against items matching mask.
4419
4420If pExempt is specified, then it is temporarily excluded from collision checks (For instance, you might want to exclude the player if said player was firing a weapon.)
4421@param start An XYZ vector containing the tail position of the ray.
4422@param end An XYZ vector containing the head position of the ray
4423@param mask A bitmask corresponding to the type of objects to check for
4424@param pExempt An optional ID for a single object that ignored for this raycast
4425@param useClientContainer Optionally indicates the search should be within the client container.
4426@returns A string containing either null, if nothing was struck, or these fields:
4427<ul><li>The ID of the object that was struck.</li><li>The x, y, z position that it was struck.</li><li>The x, y, z of the normal of the face that was struck.</li></ul>@ingroup Game */
4428
4429virtual string containerRayCast(( Point3F start, Point3F end, int mask, SceneObject pExempt=NULL, bool useClientContainer=false )) {}
4430virtual void reloadOcclusionCulling() {}
4431virtual void DbgSetVisibleDistance(( float dist=500 )) {}
4432virtual int getCentralTerrain(()) {}
4433virtual int getServerCentralTerrain(()) {}
4434virtual void shiftWorld(( Point2F offset )) {}
4435
4436/*! @brief Load all path information from interiors.
4437
4438This function is usually called from the loadMissionStage2() server-side function after the mission file has loaded.
4439
4440@tsexample
4441// Inform the engine to load all path information from interiors.
4442pathOnMissionLoadDone();
4443
4444@endtsexample
4445@ingroup Game */
4446
4447virtual void pathOnMissionLoadDone(()) {}
4448
4449/*! Return a newline-separated list of all active states.
4450@return A list of the form
4451@verbatim
4452stateName1 NL stateName2 NL stateName3 ...
4453@endverbatim
4454where each element is the name of an active state object.
4455
4456@tsexample
4457// Disable all active states.
4458foreach$( %state in sfxGetActiveStates() )
4459%state.disable();
4460@endtsexample
4461
4462@ingroup SFX */
4463
4464virtual string sfxGetActiveStates(()) {}
4465
4466/*! Get a list of all available sound devices.
4467The return value will be a newline-separated list of entries where each line describes one available sound device.  Each such line will have the following format:@verbatim
4468provider TAB device TAB hasHardware TAB numMaxBuffers
4469@endverbatim
4470- provider: The name of the device provider (e.g. "FMOD").
4471- device: The name of the device as returned by the device layer.
4472- hasHardware: Whether the device supports hardware mixing or not.
4473- numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer.  If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode.  Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system.
4474
4475@return A newline-separated list of information about all available sound devices.
4476@see sfxCreateDevice
4477@see sfxGetDeviceInfo
4478
4479@see $SFX::DEVICE_INFO_PROVIDER
4480
4481@see $SFX::DEVICE_INFO_NAME
4482
4483@see $SFX::DEVICE_INFO_USEHARDWARE
4484
4485@see $SFX::DEVICE_INFO_MAXBUFFERS
4486
4487@ref SFX_devices
4488@ingroup SFX */
4489
4490virtual string sfxGetAvailableDevices(()) {}
4491
4492/*! Try to create a new sound device using the given properties.
4493If a sound device is currently initialized, it will be uninitialized first.  However, be aware that in this case, if this function fails, it will not restore the previously active device but rather leave the sound system in an uninitialized state.
4494
4495Sounds that are already playing while the new device is created will be temporarily transitioned to virtualized playback and then resume normal playback once the device has been created.
4496
4497In the core scripts, sound is automatically set up during startup in the sfxStartup() function.
4498
4499@param provider The name of the device provider as returned by sfxGetAvailableDevices().
4500@param device The name of the device as returned by sfxGetAvailableDevices().
4501@param useHardware Whether to enabled hardware mixing on the device or not.  Only relevant if supported by the given device.
4502@param maxBuffers The maximum number of concurrent voices for this device to use or -1 for the device to pick its own reasonable default.@return True if the initialization was successful, false if not.
4503@note This function must be called before any of the sound playback functions can be used.
4504@see sfxGetAvailableDevices
4505@see sfxGetDeviceInfo
4506@see sfxDeleteDevice
4507
4508@ref SFX_devices
4509@ingroup SFX */
4510
4511virtual bool sfxCreateDevice(( string provider, string device, bool useHardware, int maxBuffers )) {}
4512
4513/*! Delete the currently active sound device and release all its resources.
4514SFXSources that are still playing will be transitioned to virtualized playback mode. When creating a new device, they will automatically transition back to normal playback.
4515
4516In the core scripts, this is done automatically for you during shutdown in the sfxShutdown() function.
4517
4518@see sfxCreateDevice
4519
4520@ref SFX_devices
4521@ingroup SFX */
4522
4523virtual void sfxDeleteDevice(()) {}
4524
4525/*! Return information about the currently active sound device.
4526The return value is a tab-delimited string of the following format:
4527@verbatim
4528provider TAB device TAB hasHardware TAB numMaxBuffers TAB caps
4529@endverbatim
4530- provider: The name of the device provider (e.g. "FMOD").
4531- device: The name of the device as returned by the device layer.
4532- hasHardware: Whether the device supports hardware mixing or not.
4533- numMaxBuffers: The maximum number of concurrent voices supported by the device's mixer.  If this limit limit is exceeded, i.e. if there are more active sounds playing at any one time, then voice virtualization will start culling voices and put them into virtualized playback mode.  Voice virtualization may or may not be provided by the device itself; if not provided by the device, it will be provided by Torque's sound system.
4534- caps: A bitfield of capability flags.
4535
4536@return A tab-separated list of properties of the currently active sound device or the empty string if no sound device has been initialized.
4537@see sfxCreateDevice
4538@see sfxGetAvailableDevices
4539
4540@see $SFX::DEVICE_INFO_PROVIDER
4541
4542@see $SFX::DEVICE_INFO_NAME
4543
4544@see $SFX::DEVICE_INFO_USEHARDWARE
4545
4546@see $SFX::DEVICE_INFO_MAXBUFFERS
4547
4548@see $SFX::DEVICE_INFO_CAPS
4549
4550@see $SFX::DEVICE_CAPS_REVERB
4551
4552@see $SFX::DEVICE_CAPS_VOICEMANAGEMENT
4553
4554@see $SFX::DEVICE_CAPS_OCCLUSION
4555
4556@see $SFX::DEVICE_CAPS_DSPEFFECTS
4557
4558@see $SFX::DEVICE_CAPS_MULTILISTENER
4559
4560@see $SFX::DEVICE_CAPS_FMODDESIGNER
4561
4562@ref SFX_devices
4563@ingroup SFX */
4564
4565virtual string sfxGetDeviceInfo(()) {}
4566virtual int sfxCreateSource() {}
4567virtual int sfxPlay() {}
4568virtual int sfxPlayOnce() {}
4569
4570/*! Stop playback of the given @a source.
4571This is equivalent to calling SFXSource::stop().
4572
4573@param source The source to put into stopped state.
4574
4575@ingroup SFX */
4576
4577virtual void sfxStop(( SFXSource source )) {}
4578
4579/*! Stop playback of the given @a source (if it is not already stopped) and delete the @a source.
4580
4581The advantage of this function over directly calling delete() is that it will correctly handle volume fades that may be configured on the source.  Whereas calling delete() would immediately stop playback and delete the source, this functionality will wait for the fade-out to play and only then stop the source and delete it.
4582
4583@param source A sound source.
4584
4585@ref SFXSource_fades
4586
4587@ingroup SFX */
4588
4589virtual void sfxStopAndDelete(( SFXSource source )) {}
4590
4591/*! Mark the given @a source for deletion as soon as it moves into stopped state.
4592
4593This function will retroactively turn the given @a source into a play-once source (see @ref SFXSource_playonce).
4594
4595@param source A sound source.
4596
4597@ingroup SFX */
4598
4599virtual void sfxDeleteWhenStopped(( SFXSource source )) {}
4600
4601/*! Get the falloff curve type currently being applied to 3D sounds.
4602
4603@return The current distance model type.
4604
4605@ref SFXSource_volume
4606
4607@ref SFX_3d
4608
4609@ingroup SFX */
4610
4611virtual string sfxGetDistanceModel(()) {}
4612
4613/*! Set the falloff curve type to use for distance-based volume attenuation of 3D sounds.
4614
4615@param model The distance model to use for 3D sound.
4616
4617@note This setting takes effect globally and is applied to all 3D sounds.
4618
4619@ingroup SFX */
4620
4621virtual void sfxSetDistanceModel(( SFXDistanceModel model )) {}
4622
4623/*! Get the current global doppler effect setting.
4624
4625@return The current global doppler effect scale factor (>=0).
4626
4627@see sfxSetDopplerFactor
4628
4629@ref SFXSource_doppler
4630
4631@ingroup SFX */
4632
4633virtual float sfxGetDopplerFactor(()) {}
4634
4635/*! Set the global doppler effect scale factor.
4636@param value The new doppler shift scale factor.
4637@pre @a value must be >= 0.
4638@see sfxGetDopplerFactor
4639
4640@ref SFXSource_doppler
4641
4642@ingroup SFX */
4643
4644virtual void sfxSetDopplerFactor(( float value )) {}
4645
4646/*! Get the current global scale factor applied to volume attenuation of 3D sounds in the logarithmic model.
4647@return The current scale factor for logarithmic 3D sound falloff curves.
4648
4649@see sfxGetDistanceModel
4650@see SFXDistanceModel
4651
4652@ref SFXSource_volume
4653@ref SFX_3d
4654@ingroup SFX */
4655
4656virtual float sfxGetRolloffFactor(()) {}
4657
4658/*! Set the global scale factor to apply to volume attenuation of 3D sounds in the logarithmic model.
4659@param value The new scale factor for logarithmic 3D sound falloff curves.
4660
4661@pre @a value must be > 0.
4662@note This function has no effect if the currently distance model is set to SFXDistanceModel::Linear.
4663
4664@see sfxGetDistanceModel
4665@see SFXDistanceModel
4666
4667@ref SFXSource_volume
4668@ref SFX_3d
4669@ingroup SFX */
4670
4671virtual void sfxSetRolloffFactor(( float value )) {}
4672
4673/*! Dump information about all current SFXSource instances to the console.
4674The dump includes information about the playback status for each source, volume levels, virtualization, etc.
4675@param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump.
4676@see SFXSource
4677@see sfxDumpSourcesToString
4678@ingroup SFX */
4679
4680virtual void sfxDumpSources(( bool includeGroups=false )) {}
4681
4682/*! Dump information about all current SFXSource instances to a string.
4683The dump includes information about the playback status for each source, volume levels, virtualization, etc.
4684@param includeGroups If true, direct instances of SFXSources (which represent logical sound groups) will be included. Otherwise only instances of subclasses of SFXSources are included in the dump.
4685@return A string containing a dump of information about all currently instantiated SFXSources.
4686@see SFXSource
4687@see sfxDumpSources
4688@ingroup SFX */
4689
4690virtual string sfxDumpSourcesToString(( bool includeGroups=false )) {}
4691virtual void fmodDumpDSPInfo() {}
4692virtual void fmodDumpMemoryStats() {}
4693
4694/*! @brief Returns the current %ActionMap.
4695@see ActionMap@ingroup Input */
4696
4697virtual string getCurrentActionMap(()) {}
4698virtual void SendCharactersListReq() {}
4699virtual int CreateCharacterGetMaxStatPoints(()) {}
4700virtual int CreateCharacterGetMaxCraftingSkillPoints(()) {}
4701virtual int CreateCharacterGetMaxFightingSkillPoints(()) {}
4702virtual void normalizeStatSliders() {}
4703virtual void normalizeCraftingSkillSliders() {}
4704virtual void normalizeFightingSkillSliders() {}
4705virtual void randomizeStatSliders() {}
4706virtual void randomizeCraftingSkillSliders() {}
4707virtual void randomizeFightingSkillSliders() {}
4708virtual void CreateCharacterCancelPressed() {}
4709virtual void CreateCharacterNextPressed() {}
4710virtual void CharNameAvailableReceived() {}
4711virtual void sendExitRequestToServer() {}
4712virtual void sendExitCancelRequestToServer() {}
4713virtual void CharSelectionSlotPressed() {}
4714virtual bool CharSelectionDelcharSure(( int slot, string name )) {}
4715virtual void CharSelectionDelPressed() {}
4716virtual void openCharacterCreationDialog() {}
4717virtual void closeCharacterSelectionDialog() {}
4718virtual void CharSelectionPlayPressed() {}
4719RN/*! Returns the maximum number of supported character slots. */
4720
4721virtual int CharSelectionGetMaxCharSlots(()) {}
4722
4723
4724/*! Add a zip task in the queue.
4725@param dlZipItem Item object id
4726 */
4727
4728virtual void processZipItem(( dlZipItem zipItem )) {}
4729virtual string calcSha1() {}
4730virtual void SubstanceManager_init() {}
4731virtual void SubstanceManager_clear() {}
4732virtual string makeGeoId(( int terId, int offsetX, int offsetY )) {}
4733virtual int GetServerCentralTer(( int serverID )) {}
4734virtual string GetServerTerIDList(( int serverID, bool includeSideTers=false )) {}
4735virtual float getTerrainTopAtPosition() {}
4736virtual float getTerrainTopLevel() {}
4737virtual void tmpHideAllNakedMans() {}
4738virtual void tmpSwitchNakedMan() {}
4739virtual void detachTerrains() {}
4740virtual void preloadData() {}
4741virtual void validateAllTerMatRemap() {}
4742virtual void initGlobalRemapIndex() {}
4743virtual void SaveMapFiles() {}
4744virtual void Tunnels_PrintBlockCount(()) {}
4745virtual void Tunnels_VisualizeSrvCollision(( int terID, int x, int y, int altitude )) {}
4746virtual void Tunnels_ClearSrvCollisions(()) {}
4747virtual void Tunnels_VerifyManagersSync(()) {}
4748virtual void tsUpdateImposterImages() {}
4749virtual void setDisableSkinnedMatCheck(( bool isDisabled=true )) {}
4750virtual void calculateVelocity(( bool enabled )) {}
4751virtual void resetFPSTracker() {}
4752virtual void beginSampling() {}
4753virtual void stopSampling() {}
4754virtual void enableSamples() {}
4755virtual string getCmVersionString() {}
4756virtual string getCmVersionStringNoPrefix() {}
4757virtual int openWeb() {}
4758virtual void terminate() {}