Documentation

Windows

A Window is a visual screen that can contain buttons, server output, a command line, and a status bar.

A Window contains Class folders, and other settings such as aliases, triggers, macros, etc. These settings can only be accessed by the package that contains the window.

Example

Take a look at your default session package. Just open your session Offline and click the Settings button in the toolbar to open the Package Editor. In the "tree-view" on the left, you will see the contents of the current package, which starts with a Window object at the top. This is the main window that displays the output from the server.

Novice users will normally just have a single Window within the default package for your server session. But a package can actually contain many different windows. For example, you might create other windows to capture text from various "chat channels" on your server.

A new log window

When displaying a lot of information to the screen, it is easy for important information to get lost.  One common way to improve this is to create a separate window to contain all of the important text. For example, if you want to be sure and see any line with the word "error" in it, you can capture this to a separate log window using the #CAPTURE command in a trigger. Like this:

#TRIGGER {error} {#CAPTURE Errors}

In this case, we are telling TeSSH to send any line that matches the pattern "error" to a window called "Errors". The #CAPTURE command will automatically create the window if it doesn't already exist. Also, by default, the new window will not have a command line or status bar. You can change these options in the Package Editor or by right-clicking the window and selecting Window Options.

You can also create a new window within a script using the #WINDOW command.

Window network connections

By default, the initial Window object is set to use the main session network connection. However, each Window can actually have it's own network connection. In the Package Editor, select the Window object and you will see three options for the network connection:

  • No network connection
  • Use main session network connection
  • Override network connection
If you select the Override option, you can enter a different hostname and port. This allows you to create multiple windows connected to different hosts or MUDs.

The easy way to create a new window with a new network connection is to just use the File/New Connection menu option, or the New Connection option from the Sessions drop-down menu. It will prompt you to enter a host and port and will then create a new window connected to that host.

Add comment

Login or register to post comments