API tools faq
paste
Advertisement
Dimac

hi na

Dimac
Oct 25th, 2016
131
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
Lua 6.20 KB | None | 0 0
raw download clone embed print report
  1. Currently available TS3 clientlib functions to be called from Lua:
  2.  
  3. ********** Clientlib **********
  4.  
  5. *** Common ***
  6. ts3.getClientLibVersion() > version, error
  7.  
  8. *** Error handling ***
  9. ts3.getErrorMessage(errorCode) > errorMessage, error
  10.  
  11. *** Loggin ***
  12. ts3.logMessage(logMessage, severity, channel, logID) > error
  13.  
  14. *** Preprocessor ***
  15. ts3.getPreProcessorInfoValueFloat(serverConnectionHandlerID, ident) > result, error
  16. ts3.getPreProcessorConfigValue(serverConnectionHandlerID, ident) > result, error
  17. ts3.setPreProcessorConfigValue(serverConnectionHandlerID, ident, value) > error
  18.  
  19. *** Encoder ***
  20. ts3.getEncodeConfigValue(serverConnectionHandlerID, ident) > result, error
  21.  
  22. *** Playback ***
  23. ts3.getPlaybackConfigValueAsFloat(serverConnectionHandlerID, ident) > result, error
  24. ts3.setPlaybackConfigValue(serverConnectionHandlerID, ident, value) > error
  25.  
  26. *** Interaction with the server
  27. ts3.requestClientMove(serverConnectionHandlerID, clientID, newChannelID, password) > error
  28. ts3.requestClientVariables(serverConnectionHandlerID, clientID) > error
  29. ts3.requestClientKickFromChannel(serverConnectionHandlerID, clientID, kickReason) > error
  30. ts3.requestClientKickFromServer(serverConnectionHandlerID, clientID, kickReason) > error
  31. ts3.requestChannelDelete(serverConnectionHandlerID, channelID, force) > error
  32. ts3.requestChannelMove(serverConnectionHandlerID, channelID, newChannelParentID) > error
  33. ts3.requestSendPrivateTextMsg(serverConnectionHandlerID, message, targetClientID) > error
  34. ts3.requestSendChannelTextMsg(serverConnectionHandlerID, message, targetChannelID) > error
  35. ts3.requestSendServerTextMsg(serverConnectionHandlerID, message) > error
  36. ts3.requestConnectionInfo(serverConnectionHandlerID, clientID) > error
  37. -- requestClientSetWhisperList  TODO
  38. ts3.requestChannelSubscribe(serverConnectionHandlerID, channelID) > error
  39. ts3.requestChannelUnsubscribe(serverConnectionHandlerID, channelID) > error
  40. ts3.requestChannelSubscribeAll(serverConnectionHandlerID) > error
  41. ts3.requestChannelUnsubscribeAll(serverConnectionHandlerID) > error
  42. ts3.requestChannelDescription(serverConnectionHandlerID, channelID) > error
  43. -- requestMuteClients  TODO
  44. -- requestUnmuteClients  TODO
  45.  
  46. *** Access clientlib information ***
  47. *** Query own client ID ***
  48. ts3.getClientID(serverConnectionHandlerID) > clientID, error
  49.  
  50. *** Client info ***
  51. ts3.getClientSelfVariableAsInt(serverConnectionHandlerID, flag) > result, error
  52. ts3.getClientSelfVariableAsString(serverConnectionHandlerID, flag) > result, error
  53. ts3.setClientSelfVariableAsInt(serverConnectionHandlerID, flag, value) > error
  54. ts3.setClientSelfVariableAsString(serverConnectionHandlerID, flag, value) > error
  55. ts3.flushClientSelfUpdates(serverConnectionHandlerID) > error
  56. ts3.getClientVariableAsInt(serverConnectionHandlerID, clientID, flag) > result, error
  57. ts3.getClientVariableAsUInt64(serverConnectionHandlerID, clientID, flag) > result, error
  58. ts3.getClientVariableAsString(serverConnectionHandlerID, clientID, flag) > result, error
  59. ts3.getClientList(serverConnectionHandlerID) > clientsList, error
  60. ts3.getChannelOfClient(serverConnectionHandlerID, clientID) > channelID, error
  61.  
  62. *** Client connection info
  63. ts3.getConnectionStatus(serverConnectionHandlerID) > result, error
  64. getConnectionVariableAsUInt64(serverConnectionHandlerID, clientID, flag) > result, error
  65. getConnectionVariableAsDouble(serverConnectionHandlerID, clientID, flag) > result, error
  66. getConnectionVariableAsString(serverConnectionHandlerID, clientID, flag) > result, error
  67. cleanUpConnectionInfo(serverConnectionHandlerID, clientID) > error
  68.  
  69. *** Channel info ***
  70. ts3.getChannelVariableAsInt(serverConnectionHandlerID, channelID, flag) > result, error
  71. ts3.getChannelVariableAsString(serverConnectionHandlerID, channelID, flag) > result, error
  72. ts3.getChannelIDFromChannelNames(serverConnectionHandlerID, channelNames) > channelID, error
  73. ts3.setChannelVariableAsInt(serverConnectionHandlerID, channelID, flag, value) > error
  74. ts3.setChannelVariableAsString(serverConnectionHandlerID, channelID, flag, value) > error
  75. ts3.flushChannelUpdates(serverConnectionHandlerID, channelID) > error
  76. ts3.flushChannelCreation(serverConnectionHandlerID, channelParentID) > error
  77. ts3.getChannelList(serverConnectionHandlerID) > channelList, error
  78. ts3.getChannelClientList(serverConnectionHandlerID, channelID) > clientList, error
  79. ts3.getParentChannelOfChannel(serverConnectionHandlerID, channelID) > parentChannelID, error
  80.  
  81. *** Server info ***
  82. ts3.getServerConnectionHandlerList() > serverConnectionHandlerIDList, error
  83. ts3.getServerVariableAsInt(serverConnectionHandlerID, flag) > result, error
  84. ts3.getServerVariableAsUInt64(serverConnectionHandlerID, flag) > result, error
  85. ts3.getServerVariableAsString(serverConnectionHandlerID, flag) > result, error
  86. ts3.requestServerVariables(serverConnectionHandlerID) > error
  87.  
  88. ********** Clientlib rare **********
  89.  
  90. *** Sound ***
  91. ts3.playWaveFile(serverConnectionHandlerID, path) > error
  92.  
  93. *** Interacting with the server - general ***
  94. ts3.requestClientPoke(serverConnectionHandlerID, clientID, message) > error
  95.  
  96. *** Interacting with the server - banning ***
  97. ts3.banclient(serverConnectionHandlerID, clientID, timeInSeconds, banReason) > error
  98. ts3.banadd(serverConnectionHandlerID, ipRegExp, nameRegexp, uniqueIdentity, timeInSeconds, banReason) > error
  99. ts3.bandel(serverConnectionHandlerID, banID) > error
  100. ts3.bandelall(serverConnectionHandlerID) > error
  101. ts3.requestBanList(serverConnectionHandlerID) > error
  102.  
  103. *** Interacting with the server - complain ***
  104. requestComplainAdd(serverConnectionHandlerID, targetClientDatabaseID, complainReason) > error
  105. requestComplainDel(serverConnectionHandlerID, targetClientDatabaseID, fromClientDatabaseID) > error
  106. requestComplainDelAll(serverConnectionHandlerID, targetClientDatabaseID) > error
  107. requestComplainList(serverConnectionHandlerID, targetClientDatabaseID) > error
  108.    
  109. ********** Client functions **********
  110.  
  111. ts3.getAppPath() > appPath
  112. ts3.getResourcesPath() > resourcesPath
  113. ts3.getConfigPath() > configPath
  114. ts3.getPluginPath() > pluginPath
  115. ts3.getCurrentServerConnectionHandlerID() > serverConnectionHandlerID
  116. ts3.printMessage(serverConnectionHandlerID, message, pluginMessageTargetMode)
  117. ts3.printMessageToCurrentTab(message)
  118. ts3.urlsToBB(textWithURLs) > bbCodeText
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!