B1uscr34m

Teamspeak 3 LUA Functions

Aug 10th, 2015
477
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
  1. Currently available TS3 clientlib functions to be called from Lua:
  2.  
  3. ********** Clientlib **********
  4.  
  5. *** Common ***
  6. ts3.getClientLibVersion() > version, error
  7. ts3.getClientLibVersionNumber() > versionNumber, error
  8.  
  9. *** Error handling ***
  10. ts3.getErrorMessage(errorCode) > errorMessage, error
  11.  
  12. *** Loggin ***
  13. ts3.logMessage(logMessage, severity, channel, logID) > error
  14.  
  15. *** Preprocessor ***
  16. ts3.getPreProcessorInfoValueFloat(serverConnectionHandlerID, ident) > result, error
  17. ts3.getPreProcessorConfigValue(serverConnectionHandlerID, ident) > result, error
  18. ts3.setPreProcessorConfigValue(serverConnectionHandlerID, ident, value) > error
  19.  
  20. *** Encoder ***
  21. ts3.getEncodeConfigValue(serverConnectionHandlerID, ident) > result, error
  22.  
  23. *** Playback ***
  24. ts3.getPlaybackConfigValueAsFloat(serverConnectionHandlerID, ident) > result, error
  25. ts3.setPlaybackConfigValue(serverConnectionHandlerID, ident, value) > error
  26. ts3.setClientVolumeModifier(serverConnectionHandlerID, clientID, value) > error
  27.  
  28. *** Interaction with the server
  29. ts3.requestClientMove(serverConnectionHandlerID, clientID, newChannelID, password) > error
  30. ts3.requestClientVariables(serverConnectionHandlerID, clientID) > error
  31. ts3.requestClientKickFromChannel(serverConnectionHandlerID, clientID, kickReason) > error
  32. ts3.requestClientKickFromServer(serverConnectionHandlerID, clientID, kickReason) > error
  33. ts3.requestChannelDelete(serverConnectionHandlerID, channelID, force) > error
  34. ts3.requestChannelMove(serverConnectionHandlerID, channelID, newChannelParentID) > error
  35. ts3.requestSendPrivateTextMsg(serverConnectionHandlerID, message, targetClientID) > error
  36. ts3.requestSendChannelTextMsg(serverConnectionHandlerID, message, targetChannelID) > error
  37. ts3.requestSendServerTextMsg(serverConnectionHandlerID, message) > error
  38. ts3.requestConnectionInfo(serverConnectionHandlerID, clientID) > error
  39. ts3.requestChannelSubscribe(serverConnectionHandlerID, channelIDArray) > error
  40. ts3.requestChannelUnsubscribe(serverConnectionHandlerID, channelIDArray) > error
  41. ts3.requestChannelSubscribeAll(serverConnectionHandlerID) > error
  42. ts3.requestChannelUnsubscribeAll(serverConnectionHandlerID) > error
  43. ts3.requestChannelDescription(serverConnectionHandlerID, channelID) > error
  44. ts3.requestMuteClients(serverConnectionHandlerID, clientIDArray) > error
  45. ts3.requestUnmuteClients(serverConnectionHandlerID, clientIDArray) > error
  46.  
  47. *** Access clientlib information ***
  48. *** Query own client ID ***
  49. ts3.getClientID(serverConnectionHandlerID) > clientID, error
  50.  
  51. *** Client info ***
  52. ts3.getClientSelfVariableAsInt(serverConnectionHandlerID, flag) > result, error
  53. ts3.getClientSelfVariableAsString(serverConnectionHandlerID, flag) > result, error
  54. ts3.setClientSelfVariableAsInt(serverConnectionHandlerID, flag, value) > error
  55. ts3.setClientSelfVariableAsString(serverConnectionHandlerID, flag, value) > error
  56. ts3.flushClientSelfUpdates(serverConnectionHandlerID) > error
  57. ts3.getClientVariableAsInt(serverConnectionHandlerID, clientID, flag) > result, error
  58. ts3.getClientVariableAsUInt64(serverConnectionHandlerID, clientID, flag) > result, error
  59. ts3.getClientVariableAsString(serverConnectionHandlerID, clientID, flag) > result, error
  60. ts3.getClientList(serverConnectionHandlerID) > clientsList, error
  61. ts3.getChannelOfClient(serverConnectionHandlerID, clientID) > channelID, error
  62.  
  63. *** Client connection info
  64. ts3.getConnectionStatus(serverConnectionHandlerID) > result, error
  65. ts3.getConnectionVariableAsUInt64(serverConnectionHandlerID, clientID, flag) > result, error
  66. ts3.getConnectionVariableAsDouble(serverConnectionHandlerID, clientID, flag) > result, error
  67. ts3.getConnectionVariableAsString(serverConnectionHandlerID, clientID, flag) > result, error
  68. ts3.cleanUpConnectionInfo(serverConnectionHandlerID, clientID) > error
  69.  
  70. *** Channel info ***
  71. ts3.getChannelVariableAsInt(serverConnectionHandlerID, channelID, flag) > result, error
  72. ts3.getChannelVariableAsString(serverConnectionHandlerID, channelID, flag) > result, error
  73. ts3.getChannelIDFromChannelNames(serverConnectionHandlerID, channelNames) > channelID, error
  74. ts3.setChannelVariableAsInt(serverConnectionHandlerID, channelID, flag, value) > error
  75. ts3.setChannelVariableAsString(serverConnectionHandlerID, channelID, flag, value) > error
  76. ts3.flushChannelUpdates(serverConnectionHandlerID, channelID) > error
  77. ts3.flushChannelCreation(serverConnectionHandlerID, channelParentID) > error
  78. ts3.getChannelList(serverConnectionHandlerID) > channelList, error
  79. ts3.getChannelClientList(serverConnectionHandlerID, channelID) > clientList, error
  80. ts3.getParentChannelOfChannel(serverConnectionHandlerID, channelID) > parentChannelID, error
  81.  
  82. *** Server info ***
  83. ts3.getServerConnectionHandlerList() > serverConnectionHandlerIDList, error
  84. ts3.getServerVariableAsInt(serverConnectionHandlerID, flag) > result, error
  85. ts3.getServerVariableAsUInt64(serverConnectionHandlerID, flag) > result, error
  86. ts3.getServerVariableAsString(serverConnectionHandlerID, flag) > result, error
  87. ts3.requestServerVariables(serverConnectionHandlerID) > error
  88.  
  89. ********** Clientlib rare **********
  90.  
  91. *** Sound ***
  92. ts3.playWaveFile(serverConnectionHandlerID, path) > error
  93.  
  94. *** Client related ***
  95. ts3.requestClientEditDescription(serverConnectionHandlerID, clientID, clientDescription) > error
  96.  
  97. *** Interacting with the server - general ***
  98. ts3.requestClientPoke(serverConnectionHandlerID, clientID, message) > error
  99. ts3.requestServerTemporaryPasswordAdd(serverConnectionHandlerID, password, description, duration, targetChannelID, targetChannelPW, returnCode) > error
  100. ts3.requestServerTemporaryPasswordDel(serverConnectionHandlerID, password, returnCode) > error
  101. ts3.requestServerTemporaryPasswordList(serverConnectionHandlerID, returnCode) > error
  102.  
  103. *** Interacting with the server - banning ***
  104. ts3.banclient(serverConnectionHandlerID, clientID, timeInSeconds, banReason) > error
  105. ts3.banclientdbid(serverConnectionHandlerID, clientDBID, timeInSeconds, banReason) > error
  106. ts3.banadd(serverConnectionHandlerID, ipRegExp, nameRegexp, uniqueIdentity, timeInSeconds, banReason) > error
  107. ts3.bandel(serverConnectionHandlerID, banID) > error
  108. ts3.bandelall(serverConnectionHandlerID) > error
  109. ts3.requestBanList(serverConnectionHandlerID) > error
  110.  
  111. *** Interacting with the server - complain ***
  112. ts3.requestComplainAdd(serverConnectionHandlerID, targetClientDatabaseID, complainReason) > error
  113. ts3.requestComplainDel(serverConnectionHandlerID, targetClientDatabaseID, fromClientDatabaseID) > error
  114. ts3.requestComplainDelAll(serverConnectionHandlerID, targetClientDatabaseID) > error
  115. ts3.requestComplainList(serverConnectionHandlerID, targetClientDatabaseID) > error
  116.    
  117. ********** Client functions **********
  118.  
  119. ts3.getAppPath() > appPath
  120. ts3.getResourcesPath() > resourcesPath
  121. ts3.getConfigPath() > configPath
  122. ts3.getPluginPath() > pluginPath
  123. ts3.getCurrentServerConnectionHandlerID() > serverConnectionHandlerID
  124. ts3.printMessage(serverConnectionHandlerID, message, pluginMessageTargetMode)
  125. ts3.printMessageToCurrentTab(message)
  126. ts3.urlsToBB(textWithURLs) > bbCodeText
  127. ts3.sendPluginCommand(serverConnectionHandlerID, command, targetMode, targetIDsArray) > error
  128. ts3.getDirectories(path) > result
  129. ts3.setPluginMenuEnabled(menuID, enabled)
  130. ts3.getClientDisplayName(serverConnectionHandlerID, clientID) > displayName, error
  131. ts3.getPermissionIDByName(serverConnectionHandlerID, permissionName) > permissionID, error
  132. ts3.getClientNeededPermission(serverConnectionHandlerID, permissionName) > result, error
  133. ts3.guiConnect(connectTab, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, soundProfile, userIdentity, oneTimeKey, phoneticName) > scHandlerID, error
  134. ts3.createBookmark(bookmarkuuid, serverLabel, serverAddress, serverPassword, nickname, channel, channelPassword, captureProfile, playbackProfile, hotkeyProfile, soundProfile, userIdentity, oneTimeKey, phoneticName) > error
RAW Paste Data