Packageru.antkarlov.anthill
Classpublic class AntActor
InheritanceAntActor Inheritance AntEntity Inheritance AntBasic Inheritance Object

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

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



Public Properties
 PropertyDefined By
 Inheritedacceleration : AntPoint
Ускорение сущности.
AntEntity
 Inheritedactive : Boolean
Определяет активность объекта.
AntBasic
 Inheritedalive : Boolean
Определяет "живой" объект или нет.
AntBasic
 InheritedallowDebugDraw : Boolean
Определяет следует ли для объекта выполнять отладочную отрисовку.
AntBasic
  alpha : Number
Определяет прозрачность.
AntActor
 Inheritedangle : Number
Локальный угол поворота сущности.
AntEntity
 InheritedangularAcceleration : Number
Ускорение вращения сущности.
AntEntity
 InheritedangularDrag : Number
Замедление вращения сущности.
AntEntity
 InheritedangularVelocity : Number
Скорость вращения сущности.
AntEntity
  animationSpeed : Number
Скорость воспроизведения анимации.
AntActor
 InheritedautoReviveChildren : Boolean
Флаг определяющий будут воскрешены вложенные сущности при вызове метода revive()
AntEntity
  blend : String
Режим смешивания цветов.
AntActor
 Inheritedbounds : AntRect
Прямоугольник определяющий занимаемую область.
AntEntity
 Inheritedcameras : Array
Указатель на массив камер AntG.cameras.
AntBasic
 Inheritedchildren : Array
Массив дочерних сущностей.
AntEntity
  color : uint
Определяет цвет.
AntActor
  currentAnimation : String
[read-only] Возвращает имя текущей анимации.
AntActor
  currentFrame : Number
Номер текущего кадра с учетом скорости анимации.
AntActor
 Inherited_depth : int
Содержит номер объекта если он вложен в другую сущность.
AntEntity
 Inheriteddepth : int
[read-only] Возвращает глубину обработки и рендера для сущности.
AntEntity
 InheritedDEPTH_ID : int = 0
[static] Используется для автоматического рассчета номеров в очереди обработки объектов.
AntEntity
 Inheriteddrag : AntPoint
Замедление сущности.
AntEntity
  eventComplete : AntSignal
Событие срабатывающее по окончанию проигрывания анимации.
AntActor
 Inheritedexists : Boolean
Определеяет существование объекта.
AntBasic
 InheritedglobalAngle : Number
Глобальный угол поворота сущности.
AntEntity
 InheritedglobalX : Number
Глобальная позиция по X.
AntEntity
 InheritedglobalY : Number
Глобальная позиция по Y.
AntEntity
 Inheritedhealth : Number
Объем жизни сущности.
AntEntity
 Inheritedheight : Number
Размер по высоте.
AntEntity
 InheritedisGroup : Boolean
[read-only] Определяет имеются ли в сущности дочерние сущности.
AntEntity
  isPlaying : Boolean
[read-only] Определяет проигрывается ли анимация.
AntActor
 InheritedisScrolled : Boolean
Определяет реагирует ли сущность на позиционирование камеры.
AntEntity
 Inheritedmask : AntMask
Указатель на маску которая применена к сущности.
AntEntity
 InheritedmaxAngularVelocity : Number
Максимально допустимая скорость вращения сущности.
AntEntity
 InheritedmaxVelocity : AntPoint
Максимально допустимая скорость.
AntEntity
 Inheritedmoves : Boolean
Флаг определяющий является ли сущность движемым объектом.
AntEntity
 InheritednumChildren : int
Количество дочерних сущностей.
AntEntity
 InheritedNUM_OF_ACTIVE : int = 0
[static] Используется для автоматического подсчета активных объектов.
AntBasic
 InheritedNUM_OF_VISIBLE : int = 0
[static] Используется для автоматического подсчета видимых объектов.
AntBasic
 InheritedNUM_ON_SCREEN : int = 0
[static] Используется для автоматического подсчета количества объектов видимых камерами.
AntBasic
 Inheritedorigin : AntPoint
Осевая точка сущности.
AntEntity
 Inheritedparent : AntEntity
Указатель на родителя в которую была помещена сущность.
AntEntity
  quickDraw : Boolean
Позволяет при возможности использовать более быстрые методы отрисовки актера.
AntActor
  repeat : Boolean
Зациклинность воспроизведения анимации.
AntActor
  reverse : Boolean
Проигрывание анимации в обратном порядке.
AntActor
 InheritedscaleX : Number
Масштаб сущности по горизонтали.
AntEntity
 InheritedscaleY : Number
Масштаб сущности по вертикали.
AntEntity
 InheritedscrollFactorX : Number
Определяет коэффициент смещения сущности по горизонтали относительно смещения камеры.
AntEntity
 InheritedscrollFactorY : Number
Коэффициент смещения сущности по вертикали относительно смещения камеры.
AntEntity
  smoothing : Boolean
Сглаживание.
AntActor
 Inheritedtag : int
Любое пользовательское значение которое может идентифицировать объект.
AntBasic
  totalFrames : int
Общее количество кадров для текущей анимации.
AntActor
 InheriteduserData : Object
Указатель на любые пользовательские данные.
AntBasic
 Inheritedvelocity : AntPoint
Скорость движения сущности.
AntEntity
 Inheritedvertices : Vector.<AntPoint>
Массив вершин определяющих прямоугольник сущности исходя из положения и размеров с учетом угла поворота.
AntEntity
 Inheritedvisible : Boolean
Определяет видимость объекта.
AntBasic
 Inheritedwidth : Number
Размер по ширине.
AntEntity
 Inheritedx : Number
Локальная позициия по X.
AntEntity
 Inheritedy : Number
Локальная позиция по Y.
AntEntity
 Inheritedz : int
Аналог атрибута tag в AntBasic.
AntEntity
Protected Properties
 PropertyDefined By
  _alpha : Number
Текущая прозрачность.
AntActor
  _animations : AntStorage
Хранилище указателей на все добавленные анимации.
AntActor
  _buffer : BitmapData
Вспомогательный буфер для рендера анимаций с цветовыми трансформациями.
AntActor
  _color : uint
Текущий цвет.
AntActor
  _colorTransform : ColorTransform
Цветовая трансформация.
AntActor
  _curAnim : AntAnimation
Указатель на текущую анимацию.
AntActor
  _curAnimName : String
Локальное имя текущей анимации.
AntActor
  _flashPoint : Point
Внутренний помошник для отрисовки графического контента.
AntActor
  _flashPointZero : Point
Внутренний помошник для отрисовки графического контента.
AntActor
  _flashRect : Rectangle
Внутренний помошник для отрисовки графического контента.
AntActor
 Inherited_helperPoint : AntPoint
Помошник для работы с вершинами.
AntEntity
  _matrix : Matrix
Внутренний помошник для отрисовки графического контента.
AntActor
 Inherited_oldAngle : Number
Содержит старое значение угла поворота.
AntEntity
 Inherited_oldPosition : AntPoint
Содержит старое значение положения сущности.
AntEntity
 Inherited_oldScale : AntPoint
Содержит старое значение масштабирования.
AntEntity
 Inherited_oldSize : AntPoint
Содержит старое значение размера сущности.
AntEntity
  _pixels : BitmapData
Указатель на битмап кадра в текущей анимации.
AntActor
  _playing : Boolean
Флаг определяющий запущено ли проигрывание анимации.
AntActor
  _prevFrame : int
Номер предыдущего кадра.
AntActor
 Inherited_scrollFactorX : Number
Коэффициент смещения сущности по горизонтали относительно смещения камеры.
AntEntity
 Inherited_scrollFactorY : Number
Коэффициент смещения сущности по вертикали относительно смещения камеры.
AntEntity
 Inherited_sortOrder : int
Помошник для сортировки вложенных сущностей.
AntEntity
 Inherited_sortProperty : String
Помошник для сортировки вложенных сущностей.
AntEntity
Public Methods
 MethodDefined By
  
AntActor
 Inherited
Добавляет дочернюю сущность.
AntEntity
  
addAnimation(aAnim:AntAnimation, aName:String = null, aSwitch:Boolean = true):void
Добавляет новую анимацию.
AntActor
  
addAnimationFromCache(aKey:String, aName:String = null, aSwitch:Boolean = true):void
Добавляет новую анимацию из кэша анимаций.
AntActor
 Inherited
callAll(aFunctionName:String, aArgs:Array = null, aRecurse:Boolean = true):void
Вызывает метод по его имени для всех вложенных объектов.
AntEntity
  
Удаляет все анимации из актера.
AntActor
 Inherited
contains(aEntity:AntEntity):Boolean
Проверяет является ли указанная сущность ребенком текущей.
AntEntity
 Inherited
debugDraw(aCamera:AntCamera):void
[override] Отладочная отрисовка.
AntEntity
  
destroy():void
[override] Используется для уничтожения объекта и освобождения занимаемых им ресурсов.
AntActor
  
draw(aCamera:AntCamera):void
[override] Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.
AntActor
  
drawActor(aCamera:AntCamera):void
Отрисовка актера в буффер указанной камеры.
AntActor
 Inherited
getAlive(aClass:Class = null):AntEntity
Извлекает первую попавшуюся существующую и "живую" сущность.
AntEntity
 Inherited
getAvailable(aClass:Class = null):AntEntity
Извлекает первую попавшующся свободную сущность соответствующую указанному классу.
AntEntity
 Inherited
Извлекает дочернюю сущность по её тэгу.
AntEntity
 Inherited
getDead(aClass:Class = null):AntEntity
Извлекает первую попавшуюся "мертвую" сущность.
AntEntity
 Inherited
getExtant(aClass:Class = null):AntEntity
Извлекает первую попавшуюся существующую сущность
AntEntity
 Inherited
getRandom(aClass:Class = null, aExistsOnly:Boolean = true):AntEntity
Извлекает случайную дочернюю сущность.
AntEntity
 Inherited
getScreenPosition(aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint
Вычисляет экранные координаты сущности для указанной камеры.
AntEntity
  
gotoAndPlay(aFrame:Number):void
Переводит текущую анимацию актера на указанный кадр и запускает воспроизведение.
AntActor
  
gotoAndStop(aFrame:Number):void
Переводит текущую анимацию на указанный кадр и останавливает воспроизведение.
AntActor
  
hitTest(aX:Number, aY:Number, aPixelFlag:Boolean = false):Boolean
[override] Проверяет попадает ли указанные координаты в прямоугольник сущности.
AntActor
  
hitTestPoint(aPoint:AntPoint, aPixelFlag:Boolean = false):Boolean
[override] Проверяет попадает ли указанная точка в прямоугольник сущности.
AntActor
 Inherited
hurt(aDamage:Number):Boolean
Наносит урон.
AntEntity
 Inherited
kill():void
[override] Вызывается когда объект необходимо временно "убить" и освободить для повторного использования.
AntEntity
  
nextFrame(aUseSpeed:Boolean = false):void
Выполняет переход к следущему кадру текущей анимации.
AntActor
 Inherited
numDead():int
Определяет количество "мертвых" дочерних сущностей.
AntEntity
 Inherited
numLiving():int
Определяет количество "живых" дочерних сущностей.
AntEntity
 Inherited
onEventBubbled(aEvent:IEvent):Boolean
Обработчик для всплывающего события.
AntEntity
 Inherited
onScreen(aCamera:AntCamera = null):Boolean
Проверяет попадает ли сущность на экран указанной камеры.
AntEntity
  
play():void
Запускает воспроизведение текущией анимации.
AntActor
  
Запускает воспроизведение текущей анимации со случайного кадра.
AntActor
 Inherited
postUpdate():void
Вызывается каждый кадр сразу после вызова метода update();
AntBasic
 Inherited
preUpdate():void
[override] Вызывается каждый кадр перед вызовом метода update().
AntEntity
  
prevFrame(aUseSpeed:Boolean = false):void
Выполняет переход к предыдущему кадру текущей анимации.
AntActor
 Inherited
queryByTag(aTag:int, aResult:Array = null):Array
Извлекает массив дочерних сущностей по их тэгу.
AntEntity
 Inherited
recycle(aClass:Class = null):AntEntity
Переиспользование дочерних сущностей.
AntEntity
 Inherited
remove(aEntity:AntEntity, aSplice:Boolean = false):AntEntity
Удаляет дочернюю сущность.
AntEntity
 Inherited
removeAll(aDestroy:Boolean = true):void
Удаляет все вложенные сущности.
AntEntity
  
removeAnimation(aName:String):void
Удаляет анимацию с указанным именем.
AntActor
 Inherited
replace(aOldEntity:AntEntity, aNewEntity:AntEntity):AntEntity
Заменяет указанную сущность на новую.
AntEntity
 Inherited
reset(aX:Number = 0, aY:Number = 0, aAngle:Number = 0):void
Устанавливает (сбрасывает) позицию и угол.
AntEntity
 Inherited
revive():void
[override] Воскрешает объект после "убийства" для повторного использования.
AntEntity
 Inherited
setAll(aVariableName:String, aValue:Object, aRecurse:Boolean = true):void
Устанавливает значение переменной по её имени для всех вложенных объектов.
AntEntity
 Inherited
sort(aIndex:String = y, aOrder:int):void
Сортировка дочерних сущностей по указанному атрибуту.
AntEntity
  
stop():void
Останавливает воспроизведение текущей анимации.
AntActor
 Inherited
swap(aEntityA:AntEntity, aEntityB:AntEntity):void
Меняет указанные сущности местами.
AntEntity
  
switchAnimation(aName:String):void
Переключение анимации.
AntActor
  
update():void
[override] Вызывается каждый кадр.
AntActor
 Inherited
Обновляет положение и размеры прямоугольника определяющего занимаемую область в игровом мире.
AntEntity
Protected Methods
 MethodDefined By
  
Выполняется когда цикл проигрывания текущей анимации завершен.
AntActor
 Inherited
calcBounds():void
Простой рассчет занимаемого сущностью прямоугольника без учета угла поворота.
AntEntity
  
calcFrame(aFrame:int = 0):void
Перерасчет текущего кадра.
AntActor
 Inherited
drawChildren(aCamera:AntCamera):void
Отрисовка дочерних сущностей.
AntEntity
 Inherited
Инвертирует вершины если необходимо.
AntEntity
 Inherited
locate(aX:Number, aY:Number, aAngle:Number):void
Перерасчитывает глобальное позиционирование сущности согласно родительским координатам и углу.
AntEntity
 Inherited
moveBounds():void
Простой перерассчет занимаемого сущностью прямоугольника при условии что угол и размеры сущности не изменились.
AntEntity
  
Сброс внутренних помошников.
AntActor
 Inherited
Полный перерассчет занимаемого сущностью прямоугольника с учетом угла, размеров и положения.
AntEntity
 Inherited
Сохраняет предыдущие значения положения и угла для оптимизации рассчетов.
AntEntity
 Inherited
sortHandler(aEntity1:AntEntity, aEntity2:AntEntity):int
Помошник для сортировки вложенных сущностей.
AntEntity
  
switchFrame(aFrame:Number):void
Переводит текущую анимацию на указанный кадр.
AntActor
 Inherited
toScreenPosition(aX:Number, aY:Number, aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint
Переводит указанные координаты в экранные.
AntEntity
  
Обновление текущей анимации.
AntActor
 Inherited
Обработка дочерних сущностей.
AntEntity
 Inherited
Рассчет скорости движения и вращения сущности.
AntEntity
Public Constants
 ConstantDefined By
 InheritedASCENDING : int = -1
[static] Константа для определения способа сортировки по возрастанию.
AntEntity
 InheritedDESCENDING : int = 1
[static] Констатна для определения способа сортировки по убыванию.
AntEntity
Property Detail
_alphaproperty
protected var _alpha:Number

Текущая прозрачность.

The default value is 1.

_animationsproperty 
protected var _animations:AntStorage

Хранилище указателей на все добавленные анимации.

_bufferproperty 
protected var _buffer:BitmapData

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

The default value is null.

_colorproperty 
protected var _color:uint

Текущий цвет.

The default value is 0x00FFFFFF.

_colorTransformproperty 
protected var _colorTransform:ColorTransform

Цветовая трансформация. Инициализируется автоматически если задан цвет отличный от 0x00FFFFFF.

The default value is null.

_curAnimproperty 
protected var _curAnim:AntAnimation

Указатель на текущую анимацию.

The default value is null.

_curAnimNameproperty 
protected var _curAnimName:String

Локальное имя текущей анимации.

The default value is null.

_flashPointproperty 
protected var _flashPoint:Point

Внутренний помошник для отрисовки графического контента.

_flashPointZeroproperty 
protected var _flashPointZero:Point

Внутренний помошник для отрисовки графического контента.

_flashRectproperty 
protected var _flashRect:Rectangle

Внутренний помошник для отрисовки графического контента.

_matrixproperty 
protected var _matrix:Matrix

Внутренний помошник для отрисовки графического контента.

_pixelsproperty 
protected var _pixels:BitmapData

Указатель на битмап кадра в текущей анимации.

_playingproperty 
protected var _playing:Boolean

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

The default value is false.

_prevFrameproperty 
protected var _prevFrame:int

Номер предыдущего кадра.

The default value is -1.

alphaproperty 
alpha:Number

Определяет прозрачность.


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
animationSpeedproperty 
public var animationSpeed:Number

Скорость воспроизведения анимации.

The default value is 1.

blendproperty 
public var blend:String

Режим смешивания цветов.

The default value is null.

colorproperty 
color:uint

Определяет цвет.


Implementation
    public function get color():uint
    public function set color(value:uint):void
currentAnimationproperty 
currentAnimation:String  [read-only]

Возвращает имя текущей анимации.


Implementation
    public function get currentAnimation():String
currentFrameproperty 
public var currentFrame:Number

Номер текущего кадра с учетом скорости анимации. Значение может быть дробным.

The default value is 1.

eventCompleteproperty 
public var eventComplete:AntSignal

Событие срабатывающее по окончанию проигрывания анимации. Добавляемый метод должен иметь аргумент типа function onComplete(actor:AntActor):void {}

isPlayingproperty 
isPlaying:Boolean  [read-only]

Определяет проигрывается ли анимация.


Implementation
    public function get isPlaying():Boolean
quickDrawproperty 
public var quickDraw:Boolean

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

The default value is true.

repeatproperty 
public var repeat:Boolean

Зациклинность воспроизведения анимации.

The default value is true.

reverseproperty 
public var reverse:Boolean

Проигрывание анимации в обратном порядке.

The default value is false.

smoothingproperty 
public var smoothing:Boolean

Сглаживание.

The default value is true.

totalFramesproperty 
public var totalFrames:int

Общее количество кадров для текущей анимации.

The default value is 1.

Constructor Detail
AntActor()Constructor
public function AntActor()

Method Detail
addAnimation()method
public function addAnimation(aAnim:AntAnimation, aName:String = null, aSwitch:Boolean = true):void

Добавляет новую анимацию. Если локальное имя анимации не указано, то добавленная анимация будет доступна по глобальному имени.

Parameters

aAnim:AntAnimation — Анимация которую необходимо добавить.
 
aName:String (default = null) — Локальное имя анимации по которому можно будет произвести переключение на эту анимацию.
 
aSwitch:Boolean (default = true) — Переключение на добавленную анимацию.

addAnimationFromCache()method 
public function addAnimationFromCache(aKey:String, aName:String = null, aSwitch:Boolean = true):void

Добавляет новую анимацию из кэша анимаций. Если локальное имя анимации не указано, то добавленная анимация будет доступна по глобальному имени.

Parameters

aKey:String — Имя анимации в кэше которую необходимо добавить.
 
aName:String (default = null) — Локальное имя анимации по которому можно будет произвести переключение на эту анимацию.
 
aSwitch:Boolean (default = true) — Переключение на добавленную анимацию.

animComplete()method 
protected function animComplete():void

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

calcFrame()method 
protected function calcFrame(aFrame:int = 0):void

Перерасчет текущего кадра.

Parameters

aFrame:int (default = 0)

clearAnimations()method 
public function clearAnimations():void

Удаляет все анимации из актера.

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

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

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

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

Parameters

aCamera:AntCamera

drawActor()method 
public function drawActor(aCamera:AntCamera):void

Отрисовка актера в буффер указанной камеры.

Parameters

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

gotoAndPlay()method 
public function gotoAndPlay(aFrame:Number):void

Переводит текущую анимацию актера на указанный кадр и запускает воспроизведение.

Parameters

aFrame:Number — Номер кадра на который необходимо перевести текущую анимацию.

gotoAndStop()method 
public function gotoAndStop(aFrame:Number):void

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

Parameters

aFrame:Number — Номер кадра на который необходимо перевести текущую анимацию.

hitTest()method 
override 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 
override public function hitTestPoint(aPoint:AntPoint, aPixelFlag:Boolean = false):Boolean

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

Parameters

aPoint:AntPoint
 
aPixelFlag:Boolean (default = false)

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

Выполняет переход к следущему кадру текущей анимации.

Parameters

aUseSpeed:Boolean (default = false) — Флаг определяющий следует ли при переходе к следущему кадру использовать скорость анимации.

play()method 
public function play():void

Запускает воспроизведение текущией анимации.

playRandomFrame()method 
public function playRandomFrame():void

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

prevFrame()method 
public function prevFrame(aUseSpeed:Boolean = false):void

Выполняет переход к предыдущему кадру текущей анимации.

Parameters

aUseSpeed:Boolean (default = false) — Флаг определяющий следует ли при переходе к предыдущему кадру использовать скорость анимации.

removeAnimation()method 
public function removeAnimation(aName:String):void

Удаляет анимацию с указанным именем.

Parameters

aName:String — Локальное имя анимации которую необходимо удалить.

resetHelpers()method 
protected function resetHelpers():void

Сброс внутренних помошников.

stop()method 
public function stop():void

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

switchAnimation()method 
public function switchAnimation(aName:String):void

Переключение анимации.

Parameters

aName:String — Локальное имя анимации на которую следует переключится.

switchFrame()method 
protected function switchFrame(aFrame:Number):void

Переводит текущую анимацию на указанный кадр.

Parameters

aFrame:Number — Кадр на который необходимо перевести текущую анимацию.

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

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

updateAnimation()method 
protected function updateAnimation():void

Обновление текущей анимации.