world.GetCommandList

MUSHclient script function (Method) — introduced in version 3.18

Returns some or all commands from the command history

Prototype

VARIANT GetCommandList(long Count);

Data type meanings

Description

This returns a variant array of the nominated number of most recent commands (in the command history window).

You can get all available commands by requesting a count of zero. (You can get the most recently saved command by requesting a count of 1).

If you request more than the available number, then the number of items in the array may be less than that requested.

You can get the current command (not yet in the command history list) by using world.GetCommand.

VBscript example

dim commandList
dim iCount

'
' Get last 10 commands
'
  commandList = world.GetCommandList (10)

  If Not IsEmpty (commandList) Then
    For Each command In commandList  
      world.Note command 
    Next
  End If

'
' ------------------------
'

'
' Get most recent command
'

  world.note world.getcommandlist (1) (0)

Jscript example

//
// Get last 10 commands
//
  
  commandList = new VBArray(world.GetCommandList (10)).toArray();

  if (commandList) 
    for (i = 0; i < commandList.length; i++)
        world.note (commandList [i]);

PerlScript example

#
#  Get last 10 commands
#

foreach $item (Win32::OLE::in ($world->GetCommandList (10)))
 {
 $world->note($item);
 }

Python example

#
# Get last 10 commands
#

commandList = world.GetCommandList (10)
if (commandList ):
  for c in commandList : world.Note (c)

Lua example

--
-- Get last 10 commands
--

for k, v in ipairs (GetCommandList (10)) do 
  print (k, v)   --> command number, what the command was
end

Return value

If there are no commands in the history list then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the specified number of commands (counting from the most recent). Use "ubound" to find the number of commands in the list.

See also