Lua Manual / Docs

[Neico]

Is there a documentation already available that shows which functions / libs are available and which args do they have on the Client / Server?

i only got a small list by creating a PrintTable (this function is a modified version from Garry's Mod to work with TS3, i didn't made use of the indent arg yet feel free to expand it :P) function and calling it like that: ts3.printMessage( serverConnectionHandlerID, PrintTable( ts3 ) )

function PrintTable( t, indent, done )
    done = done or {}
    indent = indent or 0
    local output = ""

    for key, value in pairs( t ) do
        if type( value ) == "table" and not done[value] then
            done [value] = true
            output = output .. tostring ( key ) .. ":" .. PrintTable( value, indent + 2, done ) .. "\n"
        else
            output = output .. tostring ( key ) .. "\t=\t" .. type( value ) .. "\n"
        end
    end
    return output
end

ts3:
    getChannelIDFromChannelNames = function
    requestChannelUnsubscribeAll = function
    requestChannelDescription = function
    getClientSelfVariableAsString = function
    requestServerVariables = function
    setPreProcessorConfigValue = function
    getClientID = function
    logMessage = function
    getParentChannelOfChannel = function
    getClientSelfVariableAsInt = function
    printMessage = function
    getChannelClientList = function
    requestClientMove = function
    requestChannelDelete = function
    requestClientPoke = function
    requestChannelSubscribe = function
    requestSendTextMsg = function
    flushClientSelfUpdates = function
    getPlaybackConfigValueAsFloat = function
    setClientSelfVariableAsString = function
    getChannelVariableAsString = function
    requestClientKickFromServer = function
    getChannelVariableAsInt = function
    playWaveFile = function
    getServerVariableAsInt = function
    getConfigPath = function
    requestChannelUnsubscribe = function
    getClientList = function
    getCurrentServerConnectionHandlerID = function
    setClientSelfVariableAsInt = function
    getPluginPath = function
    urlsToBB = function
    getServerConnectionHandlerList = function
    flushChannelUpdates = function
    getServerVariableAsUInt64 = function
    requestChannelMove = function
    getChannelList = function
    flushChannelCreation = function
    getServerVariableAsString = function
    setChannelVariableAsString = function
    setChannelVariableAsInt = function
    getResourcesPath = function
    setPlaybackConfigValue = function
    requestClientVariables = function
    getCurrentChatServerConnectionHandlerID = function
    getClientVariableAsString = function
    requestChannelSubscribeAll = function
    getPreProcessorInfoValueFloat = function
    getEncodeConfigValue = function
    getClientVariableAsInt = function
    getChannelOfClient = function
    getAppPath = function
    requestClientKickFromChannel = function
    getPreProcessorConfigValue = function
    getClientLibVersion = function
    getErrorMessage = function

[Thomas]

In the scripts directory there should be a file named ts3events.lua.
Take a look at this file. There you can see the events and at end of file, there is a list with available commands.

[Neico]

oh there i only saw the event functions :/

[Thomas]

Of course, there is a list.

From

ts3.getClientLibVersion() > version, error

to

ts3.urlsToBB(textWithURLs) > bbCodeText

[Digital-Storm]

I would have to say that they are almost unreadable too though. See attachment for example.

[Dobermann]

Just use an other Editor like notepad++ and it is readable.

[Flaver aKa hooK]

Or try WordPad
it should work too

-Flaver 'hooK'

[heberpcl]

How changer "Channel Type" with lua function. Example Temporary->Permanent

[SilentStorm]

Disclaimer: The following Code has not been tested at all!

*** Use the currently displayed Server Tab ***
local serverConnectionHandlerID = ts3.getCurrentServerConnectionHandlerID()
*** Get own Client ID on currently displayed Server Tab ***
local myClientID, clientIDError = ts3.getClientID(serverConnectionHandlerID)
*** Get current Channel on active Server Tab ***
local channelID, channelIDError = ts3.getChannelOfClient(serverConnectionHandlerID, myClientID)
*** Set Channel as Permanent ***
ts3.setChannelVariableAsInt(serverConnectionHandlerID, channelID, ts3defs.ChannelProperties.CHANNEL_FLAG_PERMANENT, 1)
*** Remove Semi Permanent Flag just to be on the safe side ***
ts3.setChannelVariableAsInt(serverConnectionHandlerID, channelID, ts3defs.ChannelProperties.CHANNEL_FLAG_SEMI_PERMANENT, 0)
*** Send Channel modifications to the Server ***
ts3.flushChannelUpdates(serverConnectionHandlerID, channelID)

Will (try to) change whatever Channel you are currently in on the Server whom's Tab is currently displayed to a Permanent Channel. This is a very crude Implementation and should not be used in a production environment. It does not check if you are actually connected to a server on the current Tab (or any errors for that matter), nor does it store or check the results of the API Calls that do the work.

It will fail if you do not have permissions, are not connected, etc.