Packageru.antkarlov.anthill
Classpublic class AntEntity
InheritanceAntEntity Inheritance AntBasic Inheritance Object
Implements IBubbleEventHandler
Subclasses AntActor, AntButton, AntLabel, AntTileMap

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

Базовый класс для визуальных объектов которые можно вкладывать друг в друга.



Public Properties
 PropertyDefined By
  acceleration : AntPoint
Ускорение сущности.
AntEntity
 Inheritedactive : Boolean
Определяет активность объекта.
AntBasic
 Inheritedalive : Boolean
Определяет "живой" объект или нет.
AntBasic
 InheritedallowDebugDraw : Boolean
Определяет следует ли для объекта выполнять отладочную отрисовку.
AntBasic
  angle : Number
Локальный угол поворота сущности.
AntEntity
  angularAcceleration : Number
Ускорение вращения сущности.
AntEntity
  angularDrag : Number
Замедление вращения сущности.
AntEntity
  angularVelocity : Number
Скорость вращения сущности.
AntEntity
  autoReviveChildren : Boolean
Флаг определяющий будут воскрешены вложенные сущности при вызове метода revive()
AntEntity
  bounds : AntRect
Прямоугольник определяющий занимаемую область.
AntEntity
 Inheritedcameras : Array
Указатель на массив камер AntG.cameras.
AntBasic
  children : Array
Массив дочерних сущностей.
AntEntity
  _depth : int
Содержит номер объекта если он вложен в другую сущность.
AntEntity
  depth : int
[read-only] Возвращает глубину обработки и рендера для сущности.
AntEntity
  DEPTH_ID : int = 0
[static] Используется для автоматического рассчета номеров в очереди обработки объектов.
AntEntity
  drag : AntPoint
Замедление сущности.
AntEntity
 Inheritedexists : Boolean
Определеяет существование объекта.
AntBasic
  globalAngle : Number
Глобальный угол поворота сущности.
AntEntity
  globalX : Number
Глобальная позиция по X.
AntEntity
  globalY : Number
Глобальная позиция по Y.
AntEntity
  health : Number
Объем жизни сущности.
AntEntity
  height : Number
Размер по высоте.
AntEntity
  isGroup : Boolean
[read-only] Определяет имеются ли в сущности дочерние сущности.
AntEntity
  isScrolled : Boolean
Определяет реагирует ли сущность на позиционирование камеры.
AntEntity
  mask : AntMask
Указатель на маску которая применена к сущности.
AntEntity
  maxAngularVelocity : Number
Максимально допустимая скорость вращения сущности.
AntEntity
  maxVelocity : AntPoint
Максимально допустимая скорость.
AntEntity
  moves : Boolean
Флаг определяющий является ли сущность движемым объектом.
AntEntity
  numChildren : int
Количество дочерних сущностей.
AntEntity
 InheritedNUM_OF_ACTIVE : int = 0
[static] Используется для автоматического подсчета активных объектов.
AntBasic
 InheritedNUM_OF_VISIBLE : int = 0
[static] Используется для автоматического подсчета видимых объектов.
AntBasic
 InheritedNUM_ON_SCREEN : int = 0
[static] Используется для автоматического подсчета количества объектов видимых камерами.
AntBasic
  origin : AntPoint
Осевая точка сущности.
AntEntity
  parent : AntEntity
Указатель на родителя в которую была помещена сущность.
AntEntity
  scaleX : Number
Масштаб сущности по горизонтали.
AntEntity
  scaleY : Number
Масштаб сущности по вертикали.
AntEntity
  scrollFactorX : Number
Определяет коэффициент смещения сущности по горизонтали относительно смещения камеры.
AntEntity
  scrollFactorY : Number
Коэффициент смещения сущности по вертикали относительно смещения камеры.
AntEntity
 Inheritedtag : int
Любое пользовательское значение которое может идентифицировать объект.
AntBasic
 InheriteduserData : Object
Указатель на любые пользовательские данные.
AntBasic
  velocity : AntPoint
Скорость движения сущности.
AntEntity
  vertices : Vector.<AntPoint>
Массив вершин определяющих прямоугольник сущности исходя из положения и размеров с учетом угла поворота.
AntEntity
 Inheritedvisible : Boolean
Определяет видимость объекта.
AntBasic
  width : Number
Размер по ширине.
AntEntity
  x : Number
Локальная позициия по X.
AntEntity
  y : Number
Локальная позиция по Y.
AntEntity
  z : int
Аналог атрибута tag в AntBasic.
AntEntity
Protected Properties
 PropertyDefined By
  _helperPoint : AntPoint
Помошник для работы с вершинами.
AntEntity
  _oldAngle : Number
Содержит старое значение угла поворота.
AntEntity
  _oldPosition : AntPoint
Содержит старое значение положения сущности.
AntEntity
  _oldScale : AntPoint
Содержит старое значение масштабирования.
AntEntity
  _oldSize : AntPoint
Содержит старое значение размера сущности.
AntEntity
  _scrollFactorX : Number
Коэффициент смещения сущности по горизонтали относительно смещения камеры.
AntEntity
  _scrollFactorY : Number
Коэффициент смещения сущности по вертикали относительно смещения камеры.
AntEntity
  _sortOrder : int
Помошник для сортировки вложенных сущностей.
AntEntity
  _sortProperty : String
Помошник для сортировки вложенных сущностей.
AntEntity
Public Methods
 MethodDefined By
  
AntEntity
  
Добавляет дочернюю сущность.
AntEntity
  
callAll(aFunctionName:String, aArgs:Array = null, aRecurse:Boolean = true):void
Вызывает метод по его имени для всех вложенных объектов.
AntEntity
  
contains(aEntity:AntEntity):Boolean
Проверяет является ли указанная сущность ребенком текущей.
AntEntity
  
debugDraw(aCamera:AntCamera):void
[override] Отладочная отрисовка.
AntEntity
  
destroy():void
[override] Используется для уничтожения объекта и освобождения занимаемых им ресурсов.
AntEntity
  
draw(aCamera:AntCamera):void
[override] Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.
AntEntity
  
getAlive(aClass:Class = null):AntEntity
Извлекает первую попавшуюся существующую и "живую" сущность.
AntEntity
  
getAvailable(aClass:Class = null):AntEntity
Извлекает первую попавшующся свободную сущность соответствующую указанному классу.
AntEntity
  
Извлекает дочернюю сущность по её тэгу.
AntEntity
  
getDead(aClass:Class = null):AntEntity
Извлекает первую попавшуюся "мертвую" сущность.
AntEntity
  
getExtant(aClass:Class = null):AntEntity
Извлекает первую попавшуюся существующую сущность
AntEntity
  
getRandom(aClass:Class = null, aExistsOnly:Boolean = true):AntEntity
Извлекает случайную дочернюю сущность.
AntEntity
  
getScreenPosition(aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint
Вычисляет экранные координаты сущности для указанной камеры.
AntEntity
  
hitTest(aX:Number, aY:Number, aPixelFlag:Boolean = false):Boolean
Проверяет попадает ли указанные координаты в прямоугольник сущности.
AntEntity
  
hitTestPoint(aPoint:AntPoint, aPixelFlag:Boolean = false):Boolean
Проверяет попадает ли указанная точка в прямоугольник сущности.
AntEntity
  
hurt(aDamage:Number):Boolean
Наносит урон.
AntEntity
  
kill():void
[override] Вызывается когда объект необходимо временно "убить" и освободить для повторного использования.
AntEntity
  
numDead():int
Определяет количество "мертвых" дочерних сущностей.
AntEntity
  
numLiving():int
Определяет количество "живых" дочерних сущностей.
AntEntity
  
onEventBubbled(aEvent:IEvent):Boolean
Обработчик для всплывающего события.
AntEntity
  
onScreen(aCamera:AntCamera = null):Boolean
Проверяет попадает ли сущность на экран указанной камеры.
AntEntity
 Inherited
postUpdate():void
Вызывается каждый кадр сразу после вызова метода update();
AntBasic
  
preUpdate():void
[override] Вызывается каждый кадр перед вызовом метода update().
AntEntity
  
queryByTag(aTag:int, aResult:Array = null):Array
Извлекает массив дочерних сущностей по их тэгу.
AntEntity
  
recycle(aClass:Class = null):AntEntity
Переиспользование дочерних сущностей.
AntEntity
  
remove(aEntity:AntEntity, aSplice:Boolean = false):AntEntity
Удаляет дочернюю сущность.
AntEntity
  
removeAll(aDestroy:Boolean = true):void
Удаляет все вложенные сущности.
AntEntity
  
replace(aOldEntity:AntEntity, aNewEntity:AntEntity):AntEntity
Заменяет указанную сущность на новую.
AntEntity
  
reset(aX:Number = 0, aY:Number = 0, aAngle:Number = 0):void
Устанавливает (сбрасывает) позицию и угол.
AntEntity
  
revive():void
[override] Воскрешает объект после "убийства" для повторного использования.
AntEntity
  
setAll(aVariableName:String, aValue:Object, aRecurse:Boolean = true):void
Устанавливает значение переменной по её имени для всех вложенных объектов.
AntEntity
  
sort(aIndex:String = y, aOrder:int):void
Сортировка дочерних сущностей по указанному атрибуту.
AntEntity
  
swap(aEntityA:AntEntity, aEntityB:AntEntity):void
Меняет указанные сущности местами.
AntEntity
  
update():void
[override] Вызывается каждый кадр.
AntEntity
  
Обновляет положение и размеры прямоугольника определяющего занимаемую область в игровом мире.
AntEntity
Protected Methods
 MethodDefined By
  
calcBounds():void
Простой рассчет занимаемого сущностью прямоугольника без учета угла поворота.
AntEntity
  
drawChildren(aCamera:AntCamera):void
Отрисовка дочерних сущностей.
AntEntity
  
Инвертирует вершины если необходимо.
AntEntity
  
locate(aX:Number, aY:Number, aAngle:Number):void
Перерасчитывает глобальное позиционирование сущности согласно родительским координатам и углу.
AntEntity
  
moveBounds():void
Простой перерассчет занимаемого сущностью прямоугольника при условии что угол и размеры сущности не изменились.
AntEntity
  
Полный перерассчет занимаемого сущностью прямоугольника с учетом угла, размеров и положения.
AntEntity
  
Сохраняет предыдущие значения положения и угла для оптимизации рассчетов.
AntEntity
  
sortHandler(aEntity1:AntEntity, aEntity2:AntEntity):int
Помошник для сортировки вложенных сущностей.
AntEntity
  
toScreenPosition(aX:Number, aY:Number, aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint
Переводит указанные координаты в экранные.
AntEntity
  
Обработка дочерних сущностей.
AntEntity
  
Рассчет скорости движения и вращения сущности.
AntEntity
Public Constants
 ConstantDefined By
  ASCENDING : int = -1
[static] Константа для определения способа сортировки по возрастанию.
AntEntity
  DESCENDING : int = 1
[static] Констатна для определения способа сортировки по убыванию.
AntEntity
Property Detail
_depthproperty
public var _depth:int

Содержит номер объекта если он вложен в другую сущность. Номером объекта является его номер в очереди обработки. Номер объекта рассчитывается каждый раз при вызове метода preUpdate().

The default value is -1.

_helperPointproperty 
protected var _helperPoint:AntPoint

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

_oldAngleproperty 
protected var _oldAngle:Number

Содержит старое значение угла поворота. Используется для оптимизации рассчетов.

_oldPositionproperty 
protected var _oldPosition:AntPoint

Содержит старое значение положения сущности. Используется для оптимизации рассчетов.

_oldScaleproperty 
protected var _oldScale:AntPoint

Содержит старое значение масштабирования. Используется для оптимизации рассчетов.

_oldSizeproperty 
protected var _oldSize:AntPoint

Содержит старое значение размера сущности. Используется для оптимизации рассчетов.

_scrollFactorXproperty 
protected var _scrollFactorX:Number

Коэффициент смещения сущности по горизонтали относительно смещения камеры. Используется для расчета положения сущности исходя из положения камеры. Если фактор прокручивания равен 1, то скорость прокручивания будет равна скорости движения камеры.

The default value is 1.

_scrollFactorYproperty 
protected var _scrollFactorY:Number

Коэффициент смещения сущности по вертикали относительно смещения камеры. Используется для расчета положения сущности исходя из положения камеры. Если фактор прокручивания равен 1, то скорость прокручивания будет равна скорости движения камеры.

The default value is 1.

_sortOrderproperty 
protected var _sortOrder:int

Помошник для сортировки вложенных сущностей. Содержит порядок сортировки (по убываюни или по возрастанию).

_sortPropertyproperty 
protected var _sortProperty:String

Помошник для сортировки вложенных сущностей. Содержит имя атрибута по которому производится сортировка.

accelerationproperty 
public var acceleration:AntPoint

Ускорение сущности. Применяется автоматически к скорости если moves=true.

The default value is (0,0).

angleproperty 
public var angle:Number

Локальный угол поворота сущности.

The default value is 0.

angularAccelerationproperty 
public var angularAcceleration:Number

Ускорение вращения сущности. Применяется автоматически к скорости вращения если moves=true.

The default value is 0.

angularDragproperty 
public var angularDrag:Number

Замедление вращения сущности. Применяется автоматически к скорости вращения если moves=true.

The default value is 0.

angularVelocityproperty 
public var angularVelocity:Number

Скорость вращения сущности. Рассчитывается автоматически если moves=true исходя из: angularAcceleration, angularDrag и maxAngularVelocity.

The default value is 0.

autoReviveChildrenproperty 
public var autoReviveChildren:Boolean

Флаг определяющий будут воскрешены вложенные сущности при вызове метода revive()

The default value is false.

boundsproperty 
public var bounds:AntRect

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

childrenproperty 
public var children:Array

Массив дочерних сущностей. Если null то сущность не имеет детей.

The default value is null.

depthproperty 
depth:int  [read-only]

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


Implementation
    public function get depth():int
DEPTH_IDproperty 
public static var DEPTH_ID:int = 0

Используется для автоматического рассчета номеров в очереди обработки объектов.

dragproperty 
public var drag:AntPoint

Замедление сущности. Применяется автоматически к скорости если moves=true.

The default value is (0,0).

globalAngleproperty 
public var globalAngle:Number

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

The default value is 0.

globalXproperty 
public var globalX:Number

Глобальная позиция по X. Рассчитывается автоматически относительно родительской сущности.

The default value is 0.

globalYproperty 
public var globalY:Number

Глобальная позиция по Y. Рассчитывается автоматически относительно родительской сущности.

The default value is 0.

healthproperty 
public var health:Number

Объем жизни сущности. Используйте на свое усмотрение. Для нанесения урона можно использовать метод hurt(aDamage:Number):Boolean.

The default value is 0.

heightproperty 
public var height:Number

Размер по высоте.

The default value is 0.

isGroupproperty 
isGroup:Boolean  [read-only]

Определяет имеются ли в сущности дочерние сущности.


Implementation
    public function get isGroup():Boolean
isScrolledproperty 
isScrolled:Boolean

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


Implementation
    public function get isScrolled():Boolean
    public function set isScrolled(value:Boolean):void
maskproperty 
public var mask:AntMask

Указатель на маску которая применена к сущности.

The default value is null.

maxAngularVelocityproperty 
public var maxAngularVelocity:Number

Максимально допустимая скорость вращения сущности. Применяется автоматически к скорости вращения если moves=true.

The default value is 0.

maxVelocityproperty 
public var maxVelocity:AntPoint

Максимально допустимая скорость. Применяется автоматически к скорости если moves=true.

The default value is (10000,10000).

movesproperty 
public var moves:Boolean

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

The default value is false.

numChildrenproperty 
public var numChildren:int

Количество дочерних сущностей.

The default value is 0.

originproperty 
public var origin:AntPoint

Осевая точка сущности.

The default value is (0,0).

parentproperty 
public var parent:AntEntity

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

The default value is null.

scaleXproperty 
public var scaleX:Number

Масштаб сущности по горизонтали.

The default value is 1.

scaleYproperty 
public var scaleY:Number

Масштаб сущности по вертикали.

The default value is 1.

scrollFactorXproperty 
scrollFactorX:Number

Определяет коэффициент смещения сущности по горизонтали относительно смещения камеры. Используется для расчета положения сущности исходя из положения камеры. Если фактор прокручивания равен 1, то скорость прокручивания будет равна скорости движения камеры.

The default value is 1.


Implementation
    public function get scrollFactorX():Number
    public function set scrollFactorX(value:Number):void
scrollFactorYproperty 
scrollFactorY:Number

Коэффициент смещения сущности по вертикали относительно смещения камеры. Используется для расчета положения сущности исходя из положения камеры. Если фактор прокручивания равен 1, то скорость прокручивания будет равна скорости движения камеры.

The default value is 1.


Implementation
    public function get scrollFactorY():Number
    public function set scrollFactorY(value:Number):void
velocityproperty 
public var velocity:AntPoint

Скорость движения сущности. Рассчитывается автоматически если moves=true исходя из: acceleration, drag и maxVelocity.

The default value is (0,0).

verticesproperty 
public var vertices:Vector.<AntPoint>

Массив вершин определяющих прямоугольник сущности исходя из положения и размеров с учетом угла поворота. Вложенные сущности не влияют на размеры прямоугольника сущности.

widthproperty 
public var width:Number

Размер по ширине.

The default value is 0.

xproperty 
public var x:Number

Локальная позициия по X.

The default value is 0.

yproperty 
public var y:Number

Локальная позиция по Y.

The default value is 0.

zproperty 
public var z:int

Аналог атрибута tag в AntBasic. Рекомендуется использовать для сортировки.

The default value is 0.

Constructor Detail
AntEntity()Constructor
public function AntEntity()

Method Detail
add()method
public function add(aEntity:AntEntity):AntEntity

Добавляет дочернюю сущность.

Parameters

aEntity:AntEntity — Сущность которую необходимо добавить.

Returns
AntEntity — Возвращает указатель на добавленную сущность.
calcBounds()method 
protected function calcBounds():void

Простой рассчет занимаемого сущностью прямоугольника без учета угла поворота.

callAll()method 
public function callAll(aFunctionName:String, aArgs:Array = null, aRecurse:Boolean = true):void

Вызывает метод по его имени для всех вложенных объектов.

Parameters

aFunctionName:String — Имя метода который необходимо вызывать.
 
aArgs:Array (default = null) — Массив аргументов которые могут быть переданы в вызываемый метод.
 
aRecurse:Boolean (default = true) — Флаг определяющий необходмиость вызова метода для вложенных объектов, по умолчанию равен true - это означает, что для всех объектов внутри этой сущности, которые имеют вложения, будет так же вызван метод callAll().

contains()method 
public function contains(aEntity:AntEntity):Boolean

Проверяет является ли указанная сущность ребенком текущей.

Parameters

aEntity:AntEntity — Сущность наличие которой необходимо проверить.

Returns
Boolean — Возвращает true если указанная сущность была ранее добавлена.
debugDraw()method 
override public function debugDraw(aCamera:AntCamera):void

Отладочная отрисовка.

Parameters

aCamera:AntCamera — Указатель на камеру для которой выполняется отдалочная отрисовка.

destroy()method 
override public function destroy():void

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

draw()method 
override public function draw(aCamera:AntCamera):void

Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.

Parameters

aCamera:AntCamera

drawChildren()method 
protected function drawChildren(aCamera:AntCamera):void

Отрисовка дочерних сущностей.

Parameters

aCamera:AntCamera

getAlive()method 
public function getAlive(aClass:Class = null):AntEntity

Извлекает первую попавшуюся существующую и "живую" сущность.

Parameters

aClass:Class (default = null) — Класс сущности которую необходимо получить.

Returns
AntEntity — Вернет null если нет "живых" сущностей указанного класса (если указан).
getAvailable()method 
public function getAvailable(aClass:Class = null):AntEntity

Извлекает первую попавшующся свободную сущность соответствующую указанному классу.

Parameters

aClass:Class (default = null) — Класс сущности которую необходимо получить.

Returns
AntEntity — Вернет null если свободных сущностей нет.
getByTag()method 
public function getByTag(aTag:int):AntEntity

Извлекает дочернюю сущность по её тэгу.

Parameters

aTag:int — Уникальный идентификатор сущности.

Returns
AntEntity — Возвращает null если сущности с указанным тэгом нет во вложении.
getDead()method 
public function getDead(aClass:Class = null):AntEntity

Извлекает первую попавшуюся "мертвую" сущность.

Parameters

aClass:Class (default = null) — Класс сущности которую необходимо получить.

Returns
AntEntity — Вернет null если нет "мертвых" сущностей указанного класса (если указан).
getExtant()method 
public function getExtant(aClass:Class = null):AntEntity

Извлекает первую попавшуюся существующую сущность

Parameters

aClass:Class (default = null) — Класс сущности которую необходимо получить.

Returns
AntEntity — Вернет null если нет существующих сущностей указанного класса (если указан).
getRandom()method 
public function getRandom(aClass:Class = null, aExistsOnly:Boolean = true):AntEntity

Извлекает случайную дочернюю сущность.

Parameters

aClass:Class (default = null) — Класс сущности которую необходимо получить.
 
aExistsOnly:Boolean (default = true) — Флаг определяющий следует ли учитывать при выборе свободные сущности.

Returns
AntEntity — Возвращает случайную сущность указанного класса (если указан).
getScreenPosition()method 
public function getScreenPosition(aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint

Вычисляет экранные координаты сущности для указанной камеры. Если камера не указана то используется камера по умолчанию.

Parameters

aCamera:AntCamera (default = null) — Камера для которой необходимо рассчитать экранные координаты.
 
aResult:AntPoint (default = null) — Указатель на точку куда может быть записан результат.

Returns
AntPoint — Экранные координаты сущности.
hitTest()method 
public function hitTest(aX:Number, aY:Number, aPixelFlag:Boolean = false):Boolean

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

Примечание: В данной реализации при проверки пересечения сущности с точкой флаг aPixelFlag игнорируется так как сущность не имеет графического представления.

Внимание: Для невизуальной сущности прямоугольник не рассчитывается. Данный метод корректно работает только для визуальных объектов.

Parameters

aX:Number — Положение точки по X.
 
aY:Number — Положение точки по Y.
 
aPixelFlag:Boolean (default = false) — Определяет следует ли при проверке учитывать графический образ объекта.

Returns
Boolean — Вернет true если точка находится внутри прямоугольника сущности.
hitTestPoint()method 
public function hitTestPoint(aPoint:AntPoint, aPixelFlag:Boolean = false):Boolean

Проверяет попадает ли указанная точка в прямоугольник сущности.

Parameters

aPoint:AntPoint
 
aPixelFlag:Boolean (default = false)

Returns
Boolean — Возвращает true если точка попадает в прямоугольник кнопки.
hurt()method 
public function hurt(aDamage:Number):Boolean

Наносит урон.

Parameters

aDamage:Number — Размер наносимого урона.

Returns
Boolean — Возвращает true если сущность была убита.
invertVertices()method 
protected function invertVertices():void

Инвертирует вершины если необходимо.

kill()method 
override public function kill():void

Вызывается когда объект необходимо временно "убить" и освободить для повторного использования.

locate()method 
protected function locate(aX:Number, aY:Number, aAngle:Number):void

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

Parameters

aX:Number — Глобальное положение родителя по X.
 
aY:Number — Глобальное положение родителя по Y.
 
aAngle:Number — Глобальный угол родителя.

moveBounds()method 
protected function moveBounds():void

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

numDead()method 
public function numDead():int

Определяет количество "мертвых" дочерних сущностей.

Returns
int — Количество "мертвых" сущностей.
numLiving()method 
public function numLiving():int

Определяет количество "живых" дочерних сущностей.

Returns
int — Количество "живых" сущностей.
onEventBubbled()method 
public function onEventBubbled(aEvent:IEvent):Boolean

Обработчик для всплывающего события.

Используйте данный метод чтобы решить что делать дальше с перехваченным событием.

Parameters

aEvent:IEvent — Событие которое всплыло.

Returns
Boolean — Определяет необходимо ли продолжать всплывание для перехваченного события.
onScreen()method 
public function onScreen(aCamera:AntCamera = null):Boolean

Проверяет попадает ли сущность на экран указанной камеры. Если камера не указана то используется камера по умолчанию.

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

Parameters

aCamera:AntCamera (default = null) — Камера для которой нужно проверить видимость.

Returns
Boolean — Возвращает true если попадает в экран указанной камеры.
preUpdate()method 
override public function preUpdate():void

Вызывается каждый кадр перед вызовом метода update().

queryByTag()method 
public function queryByTag(aTag:int, aResult:Array = null):Array

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

Parameters

aTag:int — Уникальный индентификатор сущности.
 
aResult:Array (default = null) — Массив в который будет помещен результат.

Returns
Array — Массив сущностей соотвествующих уникальному тэгу.
recycle()method 
public function recycle(aClass:Class = null):AntEntity

Переиспользование дочерних сущностей.

Возвращает свободную (!exists) дочернюю сущность соотвествующую указанному классу. Если свободных сущностей нет, то автоматически будет создан и добавлен новый экземпляр указанного класса. Иначе, если класс не указан, то вернет null.

Примечание: Если метод возвращает ранее использованную сущность, то перед её повторным использованием следует убедится что она существует (exists) и при необходимости воскресить методом revive().

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

         var newObj:MyGameObject = defGroup.recycle(MyGameObject) as MyGameObject;
         if (!newObj.exists) {
           --Объект следует воскресить.
           newObj.revive();
         } else {
           --Иначе новый объект.
         }
         

Parameters

aClass:Class (default = null) — Класс объекта который необходимо переработать.

Returns
AntEntity — Возвращает свободный экземпляр указанного класса или новый если свободных нет.
remove()method 
public function remove(aEntity:AntEntity, aSplice:Boolean = false):AntEntity

Удаляет дочернюю сущность.

Parameters

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

Returns
AntEntity — Возвращает указатель на удаленную сущность.
removeAll()method 
public function removeAll(aDestroy:Boolean = true):void

Удаляет все вложенные сущности.

Parameters

aDestroy:Boolean (default = true) — Флаг определяющий следует ли вызвать метод destroy() перед удалением.

replace()method 
public function replace(aOldEntity:AntEntity, aNewEntity:AntEntity):AntEntity

Заменяет указанную сущность на новую.

Parameters

aOldEntity:AntEntity — Сущность которую необходимо заменить.
 
aNewEntity:AntEntity — Сущность на которую необходимо заменить.

Returns
AntEntity — Возвращает указатель на новую сущность.
reset()method 
public function reset(aX:Number = 0, aY:Number = 0, aAngle:Number = 0):void

Устанавливает (сбрасывает) позицию и угол.

Parameters

aX:Number (default = 0) — Новая позиция по X.
 
aY:Number (default = 0) — Новая позиция по Y.
 
aAngle:Number (default = 0) — Новый угол в градусах.

revive()method 
override public function revive():void

Воскрешает объект после "убийства" для повторного использования.

rotateBounds()method 
protected function rotateBounds():void

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

saveOldPosition()method 
protected function saveOldPosition():void

Сохраняет предыдущие значения положения и угла для оптимизации рассчетов.

setAll()method 
public function setAll(aVariableName:String, aValue:Object, aRecurse:Boolean = true):void

Устанавливает значение переменной по её имени для всех вложенных объектов.

Parameters

aVariableName:String — Имя переменной для которой необходимо установить значение.
 
aValue:Object — Значение которое будет установлено.
 
aRecurse:Boolean (default = true) — Флаг определяющий необходимость установки значения для вложенных объектов, по умолчанию равен true - это означает, что для всех объектов внутри этой сущности, которые имеют вложения, будет так же вызыван метод setCall().

sort()method 
public function sort(aIndex:String = y, aOrder:int):void

Сортировка дочерних сущностей по указанному атрибуту.

Parameters

aIndex:String (default = y) — Имя атрибута по которму следует выполнить сортировку.
 
aOrder:int (default = NaN) — Порядок сортировки.

sortHandler()method 
protected function sortHandler(aEntity1:AntEntity, aEntity2:AntEntity):int

Помошник для сортировки вложенных сущностей.

Parameters

aEntity1:AntEntity
 
aEntity2:AntEntity

Returns
int
swap()method 
public function swap(aEntityA:AntEntity, aEntityB:AntEntity):void

Меняет указанные сущности местами.

Parameters

aEntityA:AntEntity — Первая сущность.
 
aEntityB:AntEntity — Вторая сущность.

toScreenPosition()method 
protected function toScreenPosition(aX:Number, aY:Number, aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint

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

Parameters

aX:Number — Координата точки по X.
 
aY:Number — Координата точки по Y.
 
aCamera:AntCamera (default = null) — Камера для которой необходимо рассчитать экранные координаты.
 
aResult:AntPoint (default = null) — Указатель на точку куда может быть записан результат.

Returns
AntPoint — Экранные координаты сущности.
update()method 
override public function update():void

Вызывается каждый кадр.

updateBounds()method 
public function updateBounds():void

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

updateChildren()method 
protected function updateChildren():void

Обработка дочерних сущностей.

updateMotion()method 
protected function updateMotion():void

Рассчет скорости движения и вращения сущности.

Constant Detail
ASCENDINGConstant
public static const ASCENDING:int = -1

Константа для определения способа сортировки по возрастанию.

DESCENDINGConstant 
public static const DESCENDING:int = 1

Констатна для определения способа сортировки по убыванию.