Packageru.antkarlov.anthill.debug
Classpublic class AntConsole
InheritanceAntConsole Inheritance AntWindow Inheritance flash.display.Sprite

Language Version : ActionScript 3
Since : 22.11.2011
Runtime Versions : AIR 1.0, Flash Player 9.0.0

Отладочная консоль позволяет выводить сообщений и предупреждения о работе игры не зависимо от того в какой версии Flash Player запущена игра (Debugger или Release).

По мимо вывода сообщений в консоли можно зарегистрировать пользовательские команды и вызывать отладочные методы вводом команд. Реализована поддержка команд с аргументами.

Пример использования простых команд без аргументов:

     // Метод простой команды
     function testCommand():void {
       trace("test command executed!");
     }
     
     // Регистрация простой команды
     AntG.console.registerCommand("test", testCommand, "Its a simple command.");
     

Пример использования сложных команд с аргументами:

     // Метод команды с аргументами, количество аргументов не ограничено.
     function testCommandWithArgs(aArg1:int, aArg2:String):void {
       trace("test command with arguments: " + aArg1 + " " + aArg2);
     }
     
     // Регистрация команды с аргументами в консоли.
     AntG.console.registerCommandWithArgs("test_args", testCommandWithArgs, [ int, String ], "Its a command with arguments.");
     



Public Properties
 PropertyDefined By
 Inheritedtitle : String
[write-only] Устанавливает заголовок окна.
AntWindow
Protected Properties
 PropertyDefined By
  _arguments : AntStorage
Хранилище зарегистрированных аргументов для команд.
AntConsole
  _background : Sprite
Помошник для визуализации окна консоли.
AntConsole
  _blinkInterval : Number = 0
Помошник для реализации мигания курсора.
AntConsole
 Inherited_btnClose : AntSysButton
Кнопка закрытия окна.
AntWindow
  _color : uint
Текущий цвет строки.
AntConsole
  _commandStr : String
Текущая команда введенная в консоль.
AntConsole
  _cursorVisible : Boolean = true
Помошник для реализации мигания курсора.
AntConsole
  _descriptions : AntStorage
Хранилище зарегистрированных описаний для команд.
AntConsole
 Inherited_fButton : TextFormat
AntWindow
  _fDefault : TextFormat
Стандартное форматирование текста.
AntConsole
 Inherited_fGray : TextFormat
Формат текста.
AntWindow
  _fInput : TextFormat
Форматирование текста для строки ввода.
AntConsole
  _fNumbering : TextFormat
Форматирование текста для нумерации строк.
AntConsole
  _functions : AntStorage
Хранилище зарегистрированных методов.
AntConsole
 Inherited_fWhite : TextFormat
AntWindow
 Inherited_height : int
Размер окна по высоте.
AntWindow
 Inherited_isMove : Boolean
Флаг определяющий производится ли перетаскивание окна.
AntWindow
  _lastCommands : Array
Список последних введенных команд в консоль.
AntConsole
  _lastIndex : int = 0
Индекс текущей команды из списка последних введенных.
AntConsole
  _lineNum : int
Номер последней строки.
AntConsole
  _lockColor : Boolean
Флаг определяющий залочен ли текущий цвет от смены.
AntConsole
  _mask : Sprite
Помошник для визуализации окна консоли.
AntConsole
  _masked : Sprite
Помошник для визуализации окна консоли.
AntConsole
 Inherited_offsetX : int
Смещение по X.
AntWindow
 Inherited_offsetY : int
Смещение по Y.
AntWindow
 Inherited_parent : Sprite
Указатель на родительское окно (AntDebugger).
AntWindow
  _tfConsole : TextField
Текстовое поле для вывода информации.
AntConsole
  _tfInput : TextField
Текстовое поле для ввода команд.
AntConsole
  _tfNumbering : TextField
Текстовое поле для нумерации строк.
AntConsole
 Inherited_tfTitle : TextField
Текстовая метка заголовка окна.
AntWindow
 Inherited_width : int
Размер окна по ширине.
AntWindow
Public Methods
 MethodDefined By
  
AntConsole(aParent:Sprite, aX:Number, aY:Number)
AntConsole
  
beginLog(aColor:Object = null):void
Определяет начало вывода строк в консоль с заданным цветом.
AntConsole
  
clear():void
Очищает окно консоли.
AntConsole
  
endLog():void
Определяет завершение вывода однотипных строк в консоль (сбрасывает цвет).
AntConsole
  
garbageCollector(aHighlightWords:Array = null):void
Вызывает сборщик мусора из класса AntMemory и выводит результат работы в консоль.
AntConsole
  
help():void
Выводит системные команды с их описаниями.
AntConsole
 Inherited
hide():void
Скрывает окно.
AntWindow
  
keyDownHandler(event:KeyboardEvent):void
Обработчик нажатия клавиш.
AntConsole
  
log(aData:*, aColor:Object = null):void
Выводит какую-либо информацию в консоль.
AntConsole
  
registerCommand(aCommandName:String, aFunction:Function, aDesc:String = null):void
Регистрирует новую команду в консоли.
AntConsole
  
registerCommandWithArgs(aCommandName:String, aFunction:Function, aArgs:Array, aDesc:String = null):void
Регистрирует новую команду с аргументами в консоли.
AntConsole
  
Выводит список зарегистрированных команд с их описаниями.
AntConsole
 Inherited
show():void
Отображает окно.
AntWindow
  
systemInfo():void
Выводит некоторую системную информацию.
AntConsole
  
unregisterCommand(aKey:*):void
Удаляет команду или метод из зарегистрированных команд.
AntConsole
  
update():void
Обновление консоли.
AntConsole
Protected Methods
 MethodDefined By
 Inherited
Устанавливает обработчики для работы окна.
AntWindow
  
create():void
[override] Инициализация окна консоли.
AntConsole
  
draw():void
[override] Перерисовка окна консоли.
AntConsole
  
execute():void
Выполнение введенной команды.
AntConsole
  
formatClasses(aValueClasses:Array):Array
Преобразует имена переданных классов в String и вырезает спец оформление.
AntConsole
 Inherited
makeLabel(aX:Number, aY:Number, aTextFormat:TextFormat = null):TextField
Метод помошник для быстрого создания текстовых меток.
AntWindow
  
Перелистывание истории команд от старых к новым.
AntConsole
  
Перелистывание истории комманд от новых к старым.
AntConsole
  
refresh():void
Обновление позиций текстовых полей консоли при выводе новой информации.
AntConsole
 Inherited
Удаляет обработчики для работы окна.
AntWindow
  
scrollDown():void
Прокрутка содержимого консоли вниз.
AntConsole
  
scrollUp():void
Прокрутка содержимого консоли вверх.
AntConsole
  
write():void
Выводит текущую команду в окно консоли.
AntConsole
Public Constants
 ConstantDefined By
  DATA : String = data
[static]
AntConsole
  DEFAULT : String = def
[static] Константы стандартных цветов.
AntConsole
  ERROR : String = error
[static]
AntConsole
 InheritedFONT_NAME : String = system
[static] Имя шрифта использующееся в текстах.
AntWindow
 InheritedFONT_SIZE : int = 8
[static] Размер шрифта использующегося в текстах.
AntWindow
  RESULT : String = result
[static]
AntConsole
Property Detail
_argumentsproperty
protected var _arguments:AntStorage

Хранилище зарегистрированных аргументов для команд.

_backgroundproperty 
protected var _background:Sprite

Помошник для визуализации окна консоли.

_blinkIntervalproperty 
protected var _blinkInterval:Number = 0

Помошник для реализации мигания курсора.

_colorproperty 
protected var _color:uint

Текущий цвет строки.

The default value is 0xFFFFFF.

_commandStrproperty 
protected var _commandStr:String

Текущая команда введенная в консоль.

_cursorVisibleproperty 
protected var _cursorVisible:Boolean = true

Помошник для реализации мигания курсора.

_descriptionsproperty 
protected var _descriptions:AntStorage

Хранилище зарегистрированных описаний для команд.

_fDefaultproperty 
protected var _fDefault:TextFormat

Стандартное форматирование текста.

_fInputproperty 
protected var _fInput:TextFormat

Форматирование текста для строки ввода.

_fNumberingproperty 
protected var _fNumbering:TextFormat

Форматирование текста для нумерации строк.

_functionsproperty 
protected var _functions:AntStorage

Хранилище зарегистрированных методов.

_lastCommandsproperty 
protected var _lastCommands:Array

Список последних введенных команд в консоль.

_lastIndexproperty 
protected var _lastIndex:int = 0

Индекс текущей команды из списка последних введенных.

_lineNumproperty 
protected var _lineNum:int

Номер последней строки.

_lockColorproperty 
protected var _lockColor:Boolean

Флаг определяющий залочен ли текущий цвет от смены.

The default value is false.

_maskproperty 
protected var _mask:Sprite

Помошник для визуализации окна консоли.

_maskedproperty 
protected var _masked:Sprite

Помошник для визуализации окна консоли.

_tfConsoleproperty 
protected var _tfConsole:TextField

Текстовое поле для вывода информации.

_tfInputproperty 
protected var _tfInput:TextField

Текстовое поле для ввода команд.

_tfNumberingproperty 
protected var _tfNumbering:TextField

Текстовое поле для нумерации строк.

Constructor Detail
AntConsole()Constructor
public function AntConsole(aParent:Sprite, aX:Number, aY:Number)

Parameters
aParent:Sprite
 
aX:Number
 
aY:Number
Method Detail
beginLog()method
public function beginLog(aColor:Object = null):void

Определяет начало вывода строк в консоль с заданным цветом.

Parameters

aColor:Object (default = null) — Цвет текста для вывода в консоль. Цвет может быть определен константами типа String: "error", "data", "result", "default" или цветом в формате hex(uint): 0xFFFFFF.

clear()method 
public function clear():void

Очищает окно консоли.

create()method 
override protected function create():void

Инициализация окна консоли.

draw()method 
override protected function draw():void

Перерисовка окна консоли.

endLog()method 
public function endLog():void

Определяет завершение вывода однотипных строк в консоль (сбрасывает цвет).

execute()method 
protected function execute():void

Выполнение введенной команды.

formatClasses()method 
protected function formatClasses(aValueClasses:Array):Array

Преобразует имена переданных классов в String и вырезает спец оформление.

Используется для автоматического определения типа аргументов для зарегистрированных методов при формировании краткой справки зарегистрированных команд.

Parameters

aValueClasses:Array — Массив классов которые необходимо преобразовать в текст.

Returns
Array — Возвращает массив имен классов преобразованных в текст без спец оформления.
garbageCollector()method 
public function garbageCollector(aHighlightWords:Array = null):void

Вызывает сборщик мусора из класса AntMemory и выводит результат работы в консоль.

Parameters

aHighlightWords:Array (default = null)

help()method 
public function help():void

Выводит системные команды с их описаниями.

keyDownHandler()method 
public function keyDownHandler(event:KeyboardEvent):void

Обработчик нажатия клавиш.

Parameters

event:KeyboardEvent

log()method 
public function log(aData:*, aColor:Object = null):void

Выводит какую-либо информацию в консоль.

Примечание: в качестве данных может быть передан любой объект. Если тип объекта не простой, то вызывается его стандартный метод toString().

Parameters

aData:* — Данные которые необходимо вывести. Это могут быть любые данные.
 
aColor:Object (default = null) — Цвет текста для вывода в консоль. Цвет может быть определен константами типа String: "error", "data", "result", "default" или цветом в формате hex(uint): 0xFFFFFF.

nextCommand()method 
protected function nextCommand():void

Перелистывание истории команд от старых к новым.

prevCommand()method 
protected function prevCommand():void

Перелистывание истории комманд от новых к старым.

refresh()method 
protected function refresh():void

Обновление позиций текстовых полей консоли при выводе новой информации.

registerCommand()method 
public function registerCommand(aCommandName:String, aFunction:Function, aDesc:String = null):void

Регистрирует новую команду в консоли.

Parameters

aCommandName:String — Текстовая команда.
 
aFunction:Function — Метод который будет выполняться при активации команды.
 
aDesc:String (default = null) — Краткое текстовое описание команды которое будет отображаться в списке зарегистрированных команд.

registerCommandWithArgs()method 
public function registerCommandWithArgs(aCommandName:String, aFunction:Function, aArgs:Array, aDesc:String = null):void

Регистрирует новую команду с аргументами в консоли.

Parameters

aCommandName:String — Текстовая команда.
 
aFunction:Function — Метод который будет выполняться при активации команды.
 
aArgs:Array — Массив классов определяющий порядок и типы аргументов передаваемые в метод команду.
 
aDesc:String (default = null) — Краткое текстовое описание команды которое будет отображаться в списке зарегистрированных команд.

registeredCommands()method 
public function registeredCommands():void

Выводит список зарегистрированных команд с их описаниями.

scrollDown()method 
protected function scrollDown():void

Прокрутка содержимого консоли вниз.

scrollUp()method 
protected function scrollUp():void

Прокрутка содержимого консоли вверх.

systemInfo()method 
public function systemInfo():void

Выводит некоторую системную информацию.

unregisterCommand()method 
public function unregisterCommand(aKey:*):void

Удаляет команду или метод из зарегистрированных команд.

Parameters

aKey:* — Текстовая команда или метод которые ранее могли быть зарегистрированы в консоле.

update()method 
public function update():void

Обновление консоли.

write()method 
protected function write():void

Выводит текущую команду в окно консоли.

Constant Detail
DATAConstant
public static const DATA:String = data

DEFAULTConstant 
public static const DEFAULT:String = def

Константы стандартных цветов.

ERRORConstant 
public static const ERROR:String = error

RESULTConstant 
public static const RESULT:String = result