Difference between revisions of "ISKernel:console (Data Type)"

From Lavish Software Wiki
Jump to navigation Jump to search
 
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
== Description ==
 
== Description ==
 +
The data type for the InnerSpace Console. The methods control the Console's visibility.
  
 
== Members ==
 
== Members ==
 +
*[[DataType:bool|bool]] '''Open''': TRUE if the console is currently visible
 +
*[[DataType:bool|bool]] '''Echo''': TRUE if console "echo" is enabled (i.e. not squelched, and 'echo off' has not been used)
  
 
== Methods ==
 
== Methods ==
 +
*'''Toggle''': Toggles the console visibility
 +
*'''Open''': Opens the console
 +
*'''Close''': Closes the console
  
 
== Returns ==
 
== Returns ==
 +
''(none)''
  
 
== Examples ==
 
== Examples ==
 +
===See if console is open===
 +
*${Console.Open}
 +
:This will Return '''TRUE''' if the console is visible
 +
===Toggle console visibility===
 +
*Console:Toggle
 +
===Open the console===
 +
*Console:Open
 +
===Close the console===
 +
*Console:Close
 +
 +
 +
 +
;Example code
 +
function main()
 +
{
 +
if !${Console.Open}
 +
press 0
 +
wait 20
 +
[[Command:Call|Call]] main
 +
}
 +
 +
''This would bascially pause your script if you open the console window''
  
 
== See Also ==
 
== See Also ==
* [[LavishScript:Data Types|LavishScript Data Types]]
+
*[[LavishScript:Data Types|Data Types]]
* [[IS:Session|Inner Space Session]]
+
*[[IS:Kernel#Data_Types|Kernel Data Types]]
 +
 
 +
 
 +
{{DT-Stub}}
 +
[[Category:Inner Space]]
 +
[[Category:Inner Space Kernel]]
 +
[[Category:Inner Space Kernel Data Types]]

Latest revision as of 04:38, 19 October 2005

Description

The data type for the InnerSpace Console. The methods control the Console's visibility.

Members

  • bool Open: TRUE if the console is currently visible
  • bool Echo: TRUE if console "echo" is enabled (i.e. not squelched, and 'echo off' has not been used)

Methods

  • Toggle: Toggles the console visibility
  • Open: Opens the console
  • Close: Closes the console

Returns

(none)

Examples

See if console is open

  • ${Console.Open}
This will Return TRUE if the console is visible

Toggle console visibility

  • Console:Toggle

Open the console

  • Console:Open

Close the console

  • Console:Close


Example code
function main()
{
if !${Console.Open}
press 0
wait 20
Call main
}

This would bascially pause your script if you open the console window

See Also