Difference between revisions of "Script Support Class"
(→List of SSC global variables) |
m (1 revision imported) |
(No difference)
| |
Latest revision as of 08:20, 1 December 2017
The SSC object is available automatically to all scripts loaded, and the functions are exposed so that the SSC. part of the call is optional.
History
The Script Support Class was created with the script system to give scripts access to internal bot functions.
The contents of the Script Support Class are packaged with the bot on every release in ScriptSupportClass.txt to provide scripters easy access to the functions available.
How to use
Syntax:
[SSC.]FunctionName Argument, Argument ReturnValue = [SSC.]FunctionName(Argument, Argument)
Where the [ ] means that this part is optional!
List of SSC global variables
- BotFlags
- myChannel
- myUsername
- myTrigger REMOVED
List of SSC functions
- AddChat(params saElements())
- AddQ(sText, optional msg_priority, optional Tag)
- BanKickUnban(Inpt, SpeakerAccess, optional Mode)
- BotClose()
- BotPath()
- C_Dec(vToCast)
- Channel()
- Clan()
- ClearScreen(optional DoNotClearWhispers)
- Color()
- Command(Username, Message, optional IsLocal, optional Whispered)
- Connect()
- Crc32(str)
- CreateNls(Username, Password)
- DataBufferEx()
- DeleteUrlCache(sUrl)
- Disconnect()
- DoBeep(lFreq, lDuration)
- DoReplace(sString, sFind, sReplace) REMOVED
- DoStatstringParse(sStatstring)
- Dsp(intID, strMessage, optional strUsername, optional lngColor)
- FileTimeToDate(strTime, optional HighValue)
- FlashBotWindow()
- ForceBncsPacketParse(PacketData)
- Friends()
- GetApphInstance()
- GetBotVersion()
- GetBotVersionNumber()
- GetCommandLine()
- GetCommands(optional Database)
- GetConfigEntry(sSection, sEntryName, sFileName)
- GetConfigPath()
- GetConnectionUptime()
- GetCurrentServerIP()
- GetCurrentUsername()
- GetDBEntry(Username, optional Access, optional Flags, optional EntryType)
- GetGTC()
- GetInternalData(iIndex, lDataType)
- GetInternalDataByUsername(sUser, lDataType)
- GetInternalUserCount()
- GetNameByPosition(iPosition)
- GetObserved()
- GetObservers()
- GetPositionByName(sUser)
- GetQueueSize()
- GetScriptByName(ScriptName)
- GetScriptControl()
- GetStdDBEntry(Username, optional Access, optional Flags, optional EntryType)
- GetSystemUptime()
- GetUserDatabase()
- GetUserProfile(optional Username)
- GetUserStats(sStatstring)
- GetWinCursorPos(lCursorX, lCursorY)
- IsDebug()
- IsOnline()
- IsSafelisted(Username)
- IsShitlisted(Username)
- Logger()
- Match(sString, sPattern, DoPreparation)
- MediaPlayer()
- ObserveFunction(sFunction)
- ObserveScript(Script)
- OSVersion()
- PadQueue()
- PadQueueCounter()
- PingByName(Username)
- PrepareLikeCheck(sText)
- PrintUrlToFile(sFileName, sUrl)
- Queue()
- Quotes()
- ReloadScript()
- ReloadSettings(DoNotLoadFontSettings)
- RequestProfileKey(sUsername, sKey)
- ResolveHostName(strHostName, optional errCode)
- Scripts()
- SetBotProfile(sNewSex, sNewLocation, sNewDescription)
- SetSCTimeOut(newValue)
- SetWinCursorPos(lCursorX, lCursorY)
- Sha1(Data, optional IsHex)
- Sleep(milliseconds) REMOVED
- StrConvEx(str, Conv, optional locale)
- StringFormat(source, params())
- UtcNow()
- VerifyServerSignature(IPAddress, ServerSignature)
- VetoThisMessage()
- WinFindWindow(lpClassName, lpWindowName)
- WinFindWindowEx(hWnd1, hWnd2, lpsz1, lpsz2)
- WinSendMessage(hWnd, wMsg, wParam, lParam)
- WriteConfigEntry(sSection, sEntryName, sValue, sFileName)
- XSha1(str, optional IsHex)
