Name GetInfo
Type Method
Summary Gets information about the current world
Prototype VARIANT GetInfo(long InfoType);
Description Gets details about the current world.

You can obtain various "types" of information about the world by specifying an "InfoType". The possible InfoTypes are:

(strings - configuration)

1 - Server name (IP address)
2 - World name
3 - Character name
4 - Send to world - file preamble
5 - Send to world - file postamble
6 - Send to world - line preamble
7 - Send to world - line postamble
8 - World notes
9 - Sound on new activity
10 - Scripts editor
11 - Log file preamble
12 - Log file postamble
13 - Log file line preamble - player input
14 - Log file line preamble - notes
15 - Log file line preamble - MUD output
16 - Log file line postamble - player input
17 - Log file line postamble - notes
18 - Log file line postamble - MUD output
19 - Speed Walk Filler
20 - Output window font name
21 - Speed walk prefix
22 - Text sent on connecting
23 - Input font name
24 - Paste to world - file preamble
25 - Paste to world - file postamble
26 - Paste to world - line preamble
27 - Paste to world - line postamble
28 - Scripting language
29 - Script function for world open
30 - Script function for world close
31 - Script function for world connect
32 - Script function for world disconnect
31 - Script function for world get focus
32 - Script function for world lose focus
35 - Script file name
36 - Scripting prefix
37 - Auto-say string
38 - Auto-say override
39 - Tab-completion defaults
40 - Auto-log file name
41 - Recall window - line preamble
42 - Terminal ID (telnet negotiation)
43 - Mapping failure message
44 - Script function for MXP starting up
45 - Script function for MXP closing down
46 - Script function for MXP error
47 - Script function for MXP tag open
48 - Script function for MXP tag close
49 - Script function for MXP variable set
50 - Sound to play for beeps

(strings - calculated at runtime)

51 - Current log file name
52 - Last "immediate" script expression
53 - Current status line message
54 - World file pathname
55 - World title

(booleans - calculated at runtime)

101 - 'No Echo' flag
102 - Debug incoming packets
103 - Decompressing
104 - MXP active
105 - Pueblo active
106 - Disconnected flag (true if not connected)
107 - Currently-connecting flag
108 - OK-to-disconnect flag
109 - Trace flag
110 - Script file changed
111 - 'World file is modified' flag
112 - Automapper active flag

(numbers (longs) - calculated at runtime)

201 - Total lines received
202 - Lines received but not yet seen (new lines)
203 - Total lines sent
204 - Packets received
205 - Packets sent
206 - Total uncompressed bytes received
207 - Total compresssed bytes received
208 - MCCP protocol in use (0=none, 1 - or 2)
209 - MXP error count
210 - MXP tags received
211 - MXP entities received
212 - Output font height
213 - Output font width
214 - Input font height
215 - Input font width
216 - Total bytes received
217 - Total bytes sent
218 - Count of variables
219 - Count of triggers
220 - Count of timers
221 - Count of aliases
222 - Count of queued commands
223 - Count of mapper items
224 - Count of lines in output window
225 - Count of custom MXP elements
226 - Count of custom MXP entities



(dates - calculated at runtime)

301 - Time connected
302 - Time log file was last flushed to disk
303 - When script file was last modified

Note: Available in MUSHclient version 3.18 onwards.
VBscript example 
'
'  List the lot
'

dim i, info

for i = 1 to 303
  info = world.GetInfo (i)
  if not isnull (info) then
   world.note i & " = " & info
  end if
next

'
' Find world IP address
'

world.note world.getinfo (1)
Jscript example 
//
//  display all information
//

for (i = 1; i <= 303; i++)
  {
  info = world.getinfo (i);
  if (info)
    world.note (i + " = " + info);
  }
PerlScript example 
#
#  Display world IP address
#

$world->note ($world->GetInfo (1));
Returns The specified information about the world, as described above.
An EMPTY variant, if a date is undefined.
A NULL variant if the InfoType is not a valid type.

See also ...