ClearScreen function

From StealthBot Wiki

Jump to: navigation, search

The ClearScreen() subroutine is available to StealthBot through the Script Support Class. It allows users to clear the chat screen of messages.

Contents

Development

The ClearScreen function was added in StealthBot version 2.7 by the request of Imhotep.

In 2.7.2, its options were increased from "both" and "chat only" to "both", "chat only" and "whisper only".

Documentation

'// CLEARSCREEN
'// Empties the bot's current chat window
'//  CLEAROPTION:
'//   1 = clear chat window
'//   2 = clear whisper window
'//   3 (default) = clear both chat and whisper window
Public Function ClearScreen(Optional ByVal ClearOption As Integer) As String

    Call frmChat.ClearChatScreen(ClearOption)

End Function

Summary

This subroutine will clear the chat and/or whisper windows and then display a message on completion.

Syntax

ClearScreen [ClearOption]

Arguments

  • ClearOption specifies which of the three actions that the function can perform. The third option is chosen if this argument is omitted.
    1. = Clears the chat window only and prints "Chat window cleared."
    2. = Clears the whisper window only and prints "Whisper window cleared." to that window.
    3. = Clears both the chat and whisper windows and prints "Chat and whisper windows cleared."

Example usage

  • Clear both the chat and the whisper windows:
  • ClearScreen
    
  • Clear the chat window:
  • ClearScreen 1
    
  • Clear the whisper window:
  • ClearScreen 2
    

See also

Personal tools