Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.GetFrame

Name GetFrame
Type Method
Summary Returns the address of the main MUSHclient frame window
Prototype long GetFrame();

View list of data type meanings
Description

This returns the memory address of the main MUSHclient MDI frame. This is intended for advanced programmers who wish to access the MUSHclient window in their own programs.
Lua notes 
In Lua the address is given as "light userdata" type. This is not particularly useful in Lua, however you can print it, and you could use it in custom-written programs.
Returns The memory address of the main frame window.

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home