Transparency
Script function

world.Transparency

DOC_scripting Read about scripting

Type

Method

Summary

Sets the transparency of the main MUSHclient window under Windows XP

Prototype

boolean Transparency(long Key, short Amount);

DOC_data_types View list of data type meanings

Description

Under Windows XP or later operating systems, you can make the MUSHclient window semi-transparent, so that the underlying windows "show through". Under Windows NT/2000/95/98/ME this function does nothing.

Key: specifies the transparency colour key to be used when composing the layered window. All pixels painted by the window in this color will be transparent. This is an RGB code, you can use ColourNameToRGB to convert a name to RGB.

If the key is -1 then there is no colour key.

Amount: the amount of transparency for other colours, in the range 0 to 255. If outside this range the number will be coerced into it.

WARNING

Drawing transparent windows may slow down the program, as the operating system has to render to an off-screen bitmap and copy to the main window. This slow-down may not be obvious on fast PCs.

VBscript example

Transparency -1, 127  ' Make everything 50% transparent
Transparency 0, 255   ' Black is transparent, everything else is full intensity


Lua example

Transparency (-1, 127) -- Make everything 50% transparent
Transparency (0, 255)  -- Black is transparent, everything else is full intensity
Transparency (ColourNameToRGB ("red"), 64)  -- Red is transparent, everything else is 25% transparent


Return value

On success, returns true.
On failure, returns false (eg. under Windows 95).



See Also ...

Topics

DOC_scripting Scripting
DOC_utils Utilities

Functions

FNC_AddFont AddFont (Adds a custom font for use by MUSHclient)
FNC_Base64Decode Base64Decode (Takes a base-64 encoded string and decodes it.)
FNC_Base64Encode Base64Encode (Encodes a string using base-64 encoding.)
FNC_BlendPixel BlendPixel (Blends a single pixel with another, using a specified blending mode)
FNC_ChangeDir ChangeDir (Changes the MUSHclient working directory)
FNC_ColourNameToRGB ColourNameToRGB (Converts a named colour to a RGB colour code.)
FNC_CreateGUID CreateGUID (Creates a GUID - Global Unique Identifier)
FNC_EditDistance EditDistance (Returns the Levenshtein Edit Distance between two words)
FNC_ErrorDesc ErrorDesc (Converts a MUSHclient script error code into an human-readable description)
FNC_ExportXML ExportXML (Exports a world item in XML format)
FNC_FilterPixel FilterPixel (Performs a filtering operation on one pixel)
FNC_FixupEscapeSequences FixupEscapeSequences (Converts "escape sequences" like \t to their equivalent codes.)
FNC_FixupHTML FixupHTML (Fixes up text for writing as HTML)
FNC_FlashIcon FlashIcon (Flashes the MUSHclient icon on the Windows taskbar)
FNC_GenerateName GenerateName (Generates a random character name)
FNC_GetClipboard GetClipboard (Gets the clipboard contents)
FNC_GetScriptTime GetScriptTime (Returns the amount of time spent in script routines)
FNC_GetSoundStatus GetSoundStatus (Gets the status of a sound started by PlaySound)
FNC_GetUniqueID GetUniqueID (Creates a unique ID for general use, or for making Plugin IDs)
FNC_GetUniqueNumber GetUniqueNumber (Returns a unique number)
FNC_Hash Hash (Produces a hash (checksum) of a specified piece of text)
FNC_Help Help (Shows help for a script function, or a list of functions)
FNC_ImportXML ImportXML (Imports configuration data in XML format)
FNC_Metaphone Metaphone (Returns the metaphone code for the supplied word)
FNC_MoveMainWindow MoveMainWindow (Move and resize the main MUSHclient window)
FNC_MoveWorldWindow MoveWorldWindow (Move and resize a world window)
FNC_MoveWorldWindowX MoveWorldWindowX (Move and resize a specific world window)
FNC_MtRand MtRand (Returns pseudo-random number using the Mersenne Twister algorithm)
FNC_MtSrand MtSrand (Seed the Mersenne Twister pseudo-random number generator)
FNC_PlaySound PlaySound (Plays a sound using DirectSound)
FNC_ReadNamesFile ReadNamesFile (Loads in a file for generating character names)
FNC_Replace Replace (Replaces one substring with another)
FNC_SetBackgroundColour SetBackgroundColour (Sets a background colour for the output window)
FNC_SetBackgroundImage SetBackgroundImage (Sets a background image for the output window)
FNC_SetClipboard SetClipboard (Sets the clipboard contents)
FNC_SetForegroundImage SetForegroundImage (Sets a foreground image for the output window)
FNC_SetStatus SetStatus (Sets the status line text)
FNC_SetToolBarPosition SetToolBarPosition (Sets the position of the game toolbars on the screen.)
FNC_ShiftTabCompleteItem ShiftTabCompleteItem (Adds an item to the list shown for Shift+Tab completion)
FNC_Simulate Simulate (Simulate input from the MUD, for debugging purposes)
FNC_Sound Sound (Plays a sound)
FNC_StopSound StopSound (Stop playing a sound started by PlaySound)
FNC_StripANSI StripANSI (Strips ANSI colour sequences from a string)
FNC_Trace Trace (Trace mode property)
FNC_TraceOut TraceOut (Outputs the supplied message to the world Trace)
FNC_TranslateDebug TranslateDebug (Sends a debugging message to the localizing translator script)
FNC_TranslateGerman TranslateGerman (Translate German umluat sequences)
FNC_Trim Trim (Trims leading and trailing spaces from a string)

(Help topic: function=Transparency)

DOC_contents Documentation contents page