Packageru.antkarlov.anthill
Classpublic class AntG
InheritanceAntG Inheritance Object

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

Глобальное хранилище с указателями на часто используемые утилитные классы и их методы.



Public Properties
 PropertyDefined By
  _anthill : Anthill
[static] Указатель на экземпляр класса Anthill.
AntG
  anthill : Anthill
[static] [read-only] Возвращает указатель на экземпляр Anthill.
AntG
  beginWatch : Function
[static] Указатель на метод beginWatch() класса AntMonitor используется для блокировки обновления окна монитора при обновлении сразу двух и более значений в мониторе.
AntG
  camera : AntCamera
[static] Указатель на последнюю добавленную камеру.
AntG
  cameras : Array
[static] Массив добавленных камер.
AntG
  debugDraw : Boolean
[static] Флаг включающий отладочную отрисовку.
AntG
  debugger : AntDebugger
[static] Указатель на отладчик.
AntG
  debugMode : Boolean
[static]
AntG
  elapsed : Number
[static] Временной промежуток прошедший между предыдущим и текущим кадром (deltaTime).
AntG
  endWatch : Function
[static] Указатель на метод endWatch() класса AntMonitor используется для снятия блокировки обновления окна монитора при обновлнии сразу двух и более значений в мониторе.
AntG
  fixedElapsed : Boolean
[static] Определяет является ли временной промежуток между кадрами фиксированным.
AntG
  frameRate : uint
[static] Определяет частоту кадров.
AntG
  height : int
[static] Размер окна по высоте.
AntG
  heightHalf : int
[static] Половина высоты окна или центр экрана по Y.
AntG
  keys : AntKeyboard
[static] Указатель на класс для работы с клавиатурой.
AntG
  lockExternalLinks : Boolean
[static] Блокирует переход по внешним ссылкам.
AntG
  log : Function
[static] Указатель на метод log() класса AntConsole для быстрого вывода любой информации в консоль.
AntG
  maxElapsed : Number
[static] Максимально допустимый временной промежуток прошедший между предыдущим и текущим кадром.
AntG
  memory : AntMemory
[static] Указатель на класс следящий за удалением объектов из памяти.
AntG
  mouse : AntMouse
[static] Указатель на класс для работы с мышкой.
AntG
  numOfActive : int
[static] [read-only] Возвращает кол-во объектов для которых были вызваны методы процессинга (exist = true).
AntG
  numOfVisible : int
[static] [read-only] Возвращает кол-во объектов для которых был вызван метод отрисовки (visible = true).
AntG
  numOnScreen : int
[static] [read-only] Возвращает кол-во объектов которые были отрисованы (попали в видимость одной или нескольких камер).
AntG
  plugins : AntPluginManager
[static] Менеджер плагинов.
AntG
  registerCommand : Function
[static] Указатель на метод registerCommand() класса AntConsole для добавления простых пользовательских команд в консоль.
AntG
  registerCommandWithArgs : Function
[static] Указатель на метод registerCommandWithArgs() класса AntConsole для добавления пользовательских команд с поддержкой аргументов в консоль.
AntG
  sounds : AntSoundManager
[static] Указатель на класс для работы со звуками.
AntG
  stage : Stage
[static] Указатель на stage.
AntG
  state : AntState
[static] [read-only] Возвращает указатель на текущее игровое состояние.
AntG
  timeScale : Number
[static] Как быстро протекает время в игровом мире.
AntG
  track : Function
[static] Указатель на метод track() класса AntMemory, для добавления объектов в список слежения.
AntG
  unregisterCommand : Function
[static] Указатель на метод unregisterCommand() класса AntConsole для быстрого удаления зарегистрированных пользовальских команд из консоли.
AntG
  unwatchValue : Function
[static] Указатель на метод unwatchValue() класса AntMonitor используется для удаления записи о значении из "монитора".
AntG
  useSystemCursor : Boolean
[static] Определяет используется в игре системный курсор или нет.
AntG
  watchValue : Function
[static] Указатель на метод watchValue() класса AntMonitor используется для добавления или обновления значения в "мониторе".
AntG
  waterMark : String = Development Build
[static] Строка всегда отображающася в левом нижнем углу при включенном режиме debugMode.
AntG
  width : int
[static] Размер окна по ширине.
AntG
  widthHalf : int
[static] Половина ширины окна или центр экрана по X.
AntG
Public Methods
 MethodDefined By
  
[static] Добавляет камеру в список для обработки.
AntG
  
createDefaultCamera(aWidth:int = 0, aHeight:int = 0):void
[static] Создает камеру по умолчанию.
AntG
  
getCamera(aIndex:int = -1):AntCamera
[static] Безопасный метод извлечения камеры.
AntG
  
init(aAnthill:Anthill):void
[static] Инициализация глобального хранилища и его переменных.
AntG
  
openUrl(aUrl:String, aTarget:String = _blank):void
[static] Выполняет переход по внешней ссылке.
AntG
  
removeCamera(aCamera:AntCamera, aSplice:Boolean = false):AntCamera
[static] Удаляет камеру из игрового движка.
AntG
  
resetInput():void
[static] Сбрасывает текущее состояние средств пользовательского ввода.
AntG
  
setScreenSize(aWidth:int, aHeight:int):void
[static] Позволяет задать размеры окна вручную.
AntG
  
[static] Переключает игровые состояния.
AntG
  
[static] Обработка классов пользовательского ввода.
AntG
Public Constants
 ConstantDefined By
  LIB_MAINTENANCE : uint = 4
[static] Версия обслуживания.
AntG
  LIB_MAJOR_VERSION : uint = 0
[static] Версия основного релиза.
AntG
  LIB_MINOR_VERSION : uint = 3
[static] Версия второстепенного релиза.
AntG
  LIB_NAME : String = Anthill Alpha
[static] Название фреймворка.
AntG
Property Detail
_anthillproperty
public static var _anthill:Anthill

Указатель на экземпляр класса Anthill.

anthillproperty 
anthill:Anthill  [read-only]

Возвращает указатель на экземпляр Anthill.


Implementation
    public static function get anthill():Anthill
beginWatchproperty 
public static var beginWatch:Function

Указатель на метод beginWatch() класса AntMonitor используется для блокировки обновления окна монитора при обновлении сразу двух и более значений в мониторе.

Пример использования:

         AntG.beginWatch();
         AntG.watchValue("someValue1", value1);
         AntG.watchValue("someValue2", value2);
         AntG.endWatch();
         

cameraproperty 
public static var camera:AntCamera

Указатель на последнюю добавленную камеру. Для безопасного получения указателя на текущую камеру используйте метод: AntG.getCamera();

The default value is null.

camerasproperty 
public static var cameras:Array

Массив добавленных камер.

debugDrawproperty 
public static var debugDraw:Boolean

Флаг включающий отладочную отрисовку.

The default value is false.

debuggerproperty 
public static var debugger:AntDebugger

Указатель на отладчик.

debugModeproperty 
debugMode:Boolean


Implementation
    public static function get debugMode():Boolean
    public static function set debugMode(value:Boolean):void
elapsedproperty 
public static var elapsed:Number

Временной промежуток прошедший между предыдущим и текущим кадром (deltaTime).

The default value is 0.02.

endWatchproperty 
public static var endWatch:Function

Указатель на метод endWatch() класса AntMonitor используется для снятия блокировки обновления окна монитора при обновлнии сразу двух и более значений в мониторе.

fixedElapsedproperty 
public static var fixedElapsed:Boolean

Определяет является ли временной промежуток между кадрами фиксированным.

The default value is false.

frameRateproperty 
frameRate:uint

Определяет частоту кадров.


Implementation
    public static function get frameRate():uint
    public static function set frameRate(value:uint):void
heightproperty 
public static var height:int

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

The default value is stage.stageHeight.

heightHalfproperty 
public static var heightHalf:int

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

The default value is (stage.stageHeight / 2).

keysproperty 
public static var keys:AntKeyboard

Указатель на класс для работы с клавиатурой.

lockExternalLinksproperty 
public static var lockExternalLinks:Boolean

Блокирует переход по внешним ссылкам.

The default value is false.

logproperty 
public static var log:Function

Указатель на метод log() класса AntConsole для быстрого вывода любой информации в консоль.

Пример использования:

AntG.log(someData);

maxElapsedproperty 
public static var maxElapsed:Number

Максимально допустимый временной промежуток прошедший между предыдущим и текущим кадром.

The default value is 0.0333333.

memoryproperty 
public static var memory:AntMemory

Указатель на класс следящий за удалением объектов из памяти.

mouseproperty 
public static var mouse:AntMouse

Указатель на класс для работы с мышкой.

numOfActiveproperty 
numOfActive:int  [read-only]

Возвращает кол-во объектов для которых были вызваны методы процессинга (exist = true).


Implementation
    public static function get numOfActive():int
numOfVisibleproperty 
numOfVisible:int  [read-only]

Возвращает кол-во объектов для которых был вызван метод отрисовки (visible = true).


Implementation
    public static function get numOfVisible():int
numOnScreenproperty 
numOnScreen:int  [read-only]

Возвращает кол-во объектов которые были отрисованы (попали в видимость одной или нескольких камер).

Примичание: если один и тот же объект попадет в видимость двух камер, то такой объект будет посчитан дважды.


Implementation
    public static function get numOnScreen():int
pluginsproperty 
public static var plugins:AntPluginManager

Менеджер плагинов.

registerCommandproperty 
public static var registerCommand:Function

Указатель на метод registerCommand() класса AntConsole для добавления простых пользовательских команд в консоль.

Пример использования:

AntG.registerCommand("test", myMethod, "Тестовый метод.");

registerCommandWithArgsproperty 
public static var registerCommandWithArgs:Function

Указатель на метод registerCommandWithArgs() класса AntConsole для добавления пользовательских команд с поддержкой аргументов в консоль.

Пример использования:

AntG.registerCommandWithArgs("test", myMethod, [ String, int ], "Тестовый метод с аргументами.");

soundsproperty 
public static var sounds:AntSoundManager

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

stageproperty 
public static var stage:Stage

Указатель на stage. Устанавливается автоматически при инициализации.

The default value is null.

stateproperty 
state:AntState  [read-only]

Возвращает указатель на текущее игровое состояние.


Implementation
    public static function get state():AntState
timeScaleproperty 
public static var timeScale:Number

Как быстро протекает время в игровом мире. Изменяя этот параметр можно получить эффект слоу-мо.

The default value is 1.

trackproperty 
public static var track:Function

Указатель на метод track() класса AntMemory, для добавления объектов в список слежения.

Чтобы посмотреть содержимое AntMemory, наберите в консоли команду "-gc", после чего будет принудительно вызван сборщик мусора и выведена информация о всех объектах которые по каким-либо причинам сохранились в AntMemory.

Пример использования:

AntG.track(myObject);

unregisterCommandproperty 
public static var unregisterCommand:Function

Указатель на метод unregisterCommand() класса AntConsole для быстрого удаления зарегистрированных пользовальских команд из консоли.

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

Пример использования:

AntG.unregisterCommand("test");

unwatchValueproperty 
public static var unwatchValue:Function

Указатель на метод unwatchValue() класса AntMonitor используется для удаления записи о значении из "монитора".

Пример использования:

AntG.unwatchValue("valueName");

useSystemCursorproperty 
useSystemCursor:Boolean

Определяет используется в игре системный курсор или нет.


Implementation
    public static function get useSystemCursor():Boolean
    public static function set useSystemCursor(value:Boolean):void
watchValueproperty 
public static var watchValue:Function

Указатель на метод watchValue() класса AntMonitor используется для добавления или обновления значения в "мониторе".

Пример использования:

AntG.watchValue("valueName", value);

waterMarkproperty 
public static var waterMark:String = Development Build

Строка всегда отображающася в левом нижнем углу при включенном режиме debugMode.

The default value is Development Build.

widthproperty 
public static var width:int

Размер окна по ширине. Определяется автоматически при инициализации.

The default value is stage.stageWidth.

widthHalfproperty 
public static var widthHalf:int

Половина ширины окна или центр экрана по X. Определяется автоматически при инициализации.

The default value is (stage.stageWidth / 2).

Method Detail
addCamera()method
public static function addCamera(aCamera:AntCamera):AntCamera

Добавляет камеру в список для обработки.

Parameters

aCamera:AntCamera — Камера которую необходимо добавить.

Returns
AntCamera — Возвращает указатель на добавленную камеру.
createDefaultCamera()method 
public static function createDefaultCamera(aWidth:int = 0, aHeight:int = 0):void

Создает камеру по умолчанию.

Parameters

aWidth:int (default = 0)
 
aHeight:int (default = 0)

getCamera()method 
public static function getCamera(aIndex:int = -1):AntCamera

Безопасный метод извлечения камеры.

Parameters

aIndex:int (default = -1) — Индекс камеры которую необходимо получить.

Returns
AntCamera — Указатель на камеру.
init()method 
public static function init(aAnthill:Anthill):void

Инициализация глобального хранилища и его переменных. Вызывается автоматически при инициализации игрового движка.

Parameters

aAnthill:Anthill — Указатель на ядро фреймворка.

openUrl()method 
public static function openUrl(aUrl:String, aTarget:String = _blank):void

Выполняет переход по внешней ссылке.

Parameters

aUrl:String — Внешняя ссылка по которой необходимо выполнить переход.
 
aTarget:String (default = _blank) — Атрибут target для ссылки.

removeCamera()method 
public static function removeCamera(aCamera:AntCamera, aSplice:Boolean = false):AntCamera

Удаляет камеру из игрового движка.

Parameters

aCamera:AntCamera — Камера которую необходимо удалить.
 
aSplice:Boolean (default = false) — Если true то элемент массива в котором размещалась камера так же будет удален.

Returns
AntCamera — Возвращает указатель на удаленную камеру.
resetInput()method 
public static function resetInput():void

Сбрасывает текущее состояние средств пользовательского ввода.

setScreenSize()method 
public static function setScreenSize(aWidth:int, aHeight:int):void

Позволяет задать размеры окна вручную.

Примичание: по умолчанию размер экрана определятся исходя из размера stage.stageWidth и stage.stageHeight.

Внимание: изменение размеров экрана никак не влияет на работу с камерами.

Parameters

aWidth:int — Новая ширина экрана.
 
aHeight:int — Новая высота экрана.

switchState()method 
public static function switchState(aState:AntState):AntState

Переключает игровые состояния.

Parameters

aState:AntState — Новое состояние на которое необходимо произвести переключение.

Returns
AntState
updateInput()method 
public static function updateInput():void

Обработка классов пользовательского ввода.

Constant Detail
LIB_MAINTENANCEConstant
public static const LIB_MAINTENANCE:uint = 4

Версия обслуживания.

LIB_MAJOR_VERSIONConstant 
public static const LIB_MAJOR_VERSION:uint = 0

Версия основного релиза.

LIB_MINOR_VERSIONConstant 
public static const LIB_MINOR_VERSION:uint = 3

Версия второстепенного релиза.

LIB_NAMEConstant 
public static const LIB_NAME:String = Anthill Alpha

Название фреймворка.