Jump to content

API Console: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
Text console additions
Text console additions


===Functions provided for this class===
==Functions provided for this class==
{||-|[[API Console.AddText|AddText]]|Adds a window to the list of consoles available|-|[[API Console.AddMemory|AddMemory]]|Adds a window to the list of consoles available|-|[[API Console.GetDefault|GetDefault]]|Gets the default (read-only) console window|-|[[API Console.SetMemMode|SetMemMode]]|Sets whether to show address and bytes for the console|-|[[API Console.WriteText|WriteText]]|Adds a block of text to the console window|-|[[API Console.GetLineText|GetLineText]]|Reads a line of text from the given console, pass -1 for final line|-|[[API Console.SetLineText|SetLineText]]|Writes a line of text from the given console, pass -1 for final line|-|[[API Console.GetLineBytes|GetLineBytes]]|Reads a line of bytes from the given console extending the array if needed|-|[[API Console.SetLineBytes|SetLineBytes]]|Writes a line of bytes from the given console, pass -1 for final line|-|[[API Console.CountLines|CountLines]]|Counts the number of lines in the console|-|[[API Console.ClearText|ClearText]]|Clears all the text in the console|}
{|
|-
|width="35%"|[[API Console.AddText|AddText]]
|Adds a window to the list of consoles available
|-
|width="35%"|[[API Console.AddMemory|AddMemory]]
|Adds a window to the list of consoles available
|-
|width="35%"|[[API Console.GetDefault|GetDefault]]
|Gets the default (read-only) console window
|-
|width="35%"|[[API Console.SetMemMode|SetMemMode]]
|Sets whether to show address and bytes for the console
|-
|width="35%"|[[API Console.WriteText|WriteText]]
|Adds a block of text to the console window
|-
|width="35%"|[[API Console.GetLineText|GetLineText]]
|Reads a line of text from the given console, pass -1 for final line
|-
|width="35%"|[[API Console.SetLineText|SetLineText]]
|Writes a line of text from the given console, pass -1 for final line
|-
|width="35%"|[[API Console.GetLineBytes|GetLineBytes]]
|Reads a line of bytes from the given console extending the array if needed
|-
|width="35%"|[[API Console.SetLineBytes|SetLineBytes]]
|Writes a line of bytes from the given console, pass -1 for final line
|-
|width="35%"|[[API Console.CountLines|CountLines]]
|Counts the number of lines in the console
|-
|width="35%"|[[API Console.ClearText|ClearText]]
|Clears all the text in the console
|}


===Examples===
 
==Examples==
''No examples available''

Revision as of 16:57, 11 May 2013

<sidebar>API contents</sidebar> Text console additions

Functions provided for this class

AddText Adds a window to the list of consoles available
AddMemory Adds a window to the list of consoles available
GetDefault Gets the default (read-only) console window
SetMemMode Sets whether to show address and bytes for the console
WriteText Adds a block of text to the console window
GetLineText Reads a line of text from the given console, pass -1 for final line
SetLineText Writes a line of text from the given console, pass -1 for final line
GetLineBytes Reads a line of bytes from the given console extending the array if needed
SetLineBytes Writes a line of bytes from the given console, pass -1 for final line
CountLines Counts the number of lines in the console
ClearText Clears all the text in the console


Examples

No examples available