Packageru.antkarlov.anthill
Classpublic class AntButton
InheritanceAntButton Inheritance AntEntity Inheritance AntBasic Inheritance Object

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

Кнопка обыкновенная.

Для визуального представления кнопки используются заранее растеризированные анимации как и для AntActor, но с определенными условиями. Анимация кнопки должна состоять как минимум из двух кадров, каждый из которых должен представлять определенное состояние кнопки: первый кадр - нормальное состояние, второй кадр - подсвеченное состояние при наведении мыши, третий кадр - нажатое состояние. Если нет необходимости подсвечивать кнопку при наведении мыши, то нажатое состояние должно быть вторым кадром.



Public Properties
 PropertyDefined By
 Inheritedacceleration : AntPoint
Ускорение сущности.
AntEntity
 Inheritedactive : Boolean
Определяет активность объекта.
AntBasic
 Inheritedalive : Boolean
Определяет "живой" объект или нет.
AntBasic
 InheritedallowDebugDraw : Boolean
Определяет следует ли для объекта выполнять отладочную отрисовку.
AntBasic
  alpha : Number
Определяет текущую прозрачность.
AntButton
 Inheritedangle : Number
Локальный угол поворота сущности.
AntEntity
 InheritedangularAcceleration : Number
Ускорение вращения сущности.
AntEntity
 InheritedangularDrag : Number
Замедление вращения сущности.
AntEntity
 InheritedangularVelocity : Number
Скорость вращения сущности.
AntEntity
 InheritedautoReviveChildren : Boolean
Флаг определяющий будут воскрешены вложенные сущности при вызове метода revive()
AntEntity
  blend : String
Режим смешивания цветов.
AntButton
 Inheritedbounds : AntRect
Прямоугольник определяющий занимаемую область.
AntEntity
  camera : AntCamera
Указатель на камеру в которую рендерится данная кнопка.
AntButton
 Inheritedcameras : Array
Указатель на массив камер AntG.cameras.
AntBasic
 Inheritedchildren : Array
Массив дочерних сущностей.
AntEntity
  color : uint
Определяет текущий цвет.
AntButton
  currentAnimation : String
[read-only] Возвращает имя текущей анимации кнопки.
AntButton
  defDownCursorAnim : String
[static] Определяет имя анимации пользовательского курсора при нажатии на кнопку по умолчанию.
AntButton
  defOverCursorAnim : String
[static] Определяет имя анимации пользовательского курсора при наведении на кнопку по умолчанию.
AntButton
  defSoundClick : String
[static] Определяет имя звука для всех кнопок который будет воспроизводится при клике на кнопку.
AntButton
  defSoundOut : String
[static] Определяет имя звука для всех кнопок который будет воспроизводится при потери фокуса кнопкой.
AntButton
  defSoundOver : String
[static] Определяет имя звука для всех кнопок который будет воспроизводится при наведении на кнопку.
AntButton
 Inherited_depth : int
Содержит номер объекта если он вложен в другую сущность.
AntEntity
 Inheriteddepth : int
[read-only] Возвращает глубину обработки и рендера для сущности.
AntEntity
 InheritedDEPTH_ID : int = 0
[static] Используется для автоматического рассчета номеров в очереди обработки объектов.
AntEntity
  downCursorAnim : String
Определяет имя анимации пользовательского курсора при нажатии на кнопку.
AntButton
 Inheriteddrag : AntPoint
Замедление сущности.
AntEntity
  eventClick : AntSignal
Событие выполняющееся когда был произведен клик по кнопке (нажатие и отпускание мыши в пределах кнопки).
AntButton
  eventDown : AntSignal
Событие выполняющееся когда кнопка нажата.
AntButton
  eventOut : AntSignal
Событие выполняющееся когда курсор мыши вышел за пределы кнопки.
AntButton
  eventOver : AntSignal
Событие выполняющееся когда на кнопку наведен курсор мыши.
AntButton
  eventUp : AntSignal
Событие выполняющееся когда кнопка отпущена.
AntButton
 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
 InheritedisScrolled : Boolean
Определяет реагирует ли сущность на позиционирование камеры.
AntEntity
  label : AntLabel
Указатель на текстовую метку кнопки.
AntButton
  labelOffset : AntPoint
Смещение текстовой метки при нажатии.
AntButton
 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
  overCursorAnim : String
Определяет имя анимации пользовательского курсора при наведении на кнопку.
AntButton
 Inheritedparent : AntEntity
Указатель на родителя в которую была помещена сущность.
AntEntity
 InheritedscaleX : Number
Масштаб сущности по горизонтали.
AntEntity
 InheritedscaleY : Number
Масштаб сущности по вертикали.
AntEntity
 InheritedscrollFactorX : Number
Определяет коэффициент смещения сущности по горизонтали относительно смещения камеры.
AntEntity
 InheritedscrollFactorY : Number
Коэффициент смещения сущности по вертикали относительно смещения камеры.
AntEntity
  selected : Boolean
Определяет состояние выбранности кнопки.
AntButton
  smoothing : Boolean
Сглаживание.
AntButton
  soundClick : String
Имя звука который воспроизводится при клике на кнопку.
AntButton
  soundOut : String
Имя звука который воспроизводится при потери фокуса кнопкой.
AntButton
  soundOver : String
Имя звука который воспроизводится при наведении на кнопку.
AntButton
  status : uint
Текущее состояние кнопки.
AntButton
 Inheritedtag : int
Любое пользовательское значение которое может идентифицировать объект.
AntBasic
  text : String
Определяет текст для текстовой метки у кнопки.
AntButton
  toggle : Boolean
Определяет режим чекбокса для кнопки.
AntButton
 InheriteduserData : Object
Указатель на любые пользовательские данные.
AntBasic
  useSystemCursor : Boolean
Определяет возможность использования системных курсоров для кнопок.
AntButton
 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
Текущая прозрачность кнопки.
AntButton
  _animations : AntStorage
Хранилище указателей на все добавленные анимации.
AntButton
  _buffer : BitmapData
Вспомогательный буфер для рендера анимаций с цветовыми трансформациями.
AntButton
  _color : uint
Текущий цвет кнопки.
AntButton
  _colorTransform : ColorTransform
Цветовая трансформация кнопки.
AntButton
  _curAnim : AntAnimation
Указатель на текущую анимацию.
AntButton
  _curAnimName : String
Локальное имя текущей анимации.
AntButton
  _down : Boolean
Определяет нажата ли кнопка.
AntButton
  _flashPoint : Point
AntButton
  _flashPointZero : Point
AntButton
  _flashRect : Rectangle
AntButton
 Inherited_helperPoint : AntPoint
Помошник для работы с вершинами.
AntEntity
  _iChangeCursor : Boolean
Помошники для функционирования кнопки.
AntButton
  _matrix : Matrix
AntButton
 Inherited_oldAngle : Number
Содержит старое значение угла поворота.
AntEntity
 Inherited_oldPosition : AntPoint
Содержит старое значение положения сущности.
AntEntity
 Inherited_oldScale : AntPoint
Содержит старое значение масштабирования.
AntEntity
 Inherited_oldSize : AntPoint
Содержит старое значение размера сущности.
AntEntity
  _over : Boolean
Определяет наведен ли курсор мышки на кнопку.
AntButton
  _pixels : BitmapData
Указатель на битмап кадра в текущей анимации.
AntButton
  _point : AntPoint
AntButton
  _prevFrame : int
Номер предыдущего кадра.
AntButton
 Inherited_scrollFactorX : Number
Коэффициент смещения сущности по горизонтали относительно смещения камеры.
AntEntity
 Inherited_scrollFactorY : Number
Коэффициент смещения сущности по вертикали относительно смещения камеры.
AntEntity
  _selected : Boolean
Определяет является ли кнопка в данный момент выбранной (зажатой).
AntButton
 Inherited_sortOrder : int
Помошник для сортировки вложенных сущностей.
AntEntity
 Inherited_sortProperty : String
Помошник для сортировки вложенных сущностей.
AntEntity
  _toggle : Boolean
Определяет может ли быть кнопка выбрана (зажата).
AntButton
Public Methods
 MethodDefined By
  
AntButton
 Inherited
Добавляет дочернюю сущность.
AntEntity
  
addAnimation(aAnim:AntAnimation, aName:String = null, aSwitch:Boolean = true):void
Добавляет новую анимацию.
AntButton
  
addAnimationFromCache(aKey:String, aName:String = null, aSwitch:Boolean = true):void
Добавляет новую анимацию из кэша анимаций.
AntButton
 Inherited
callAll(aFunctionName:String, aArgs:Array = null, aRecurse:Boolean = true):void
Вызывает метод по его имени для всех вложенных объектов.
AntEntity
 Inherited
contains(aEntity:AntEntity):Boolean
Проверяет является ли указанная сущность ребенком текущей.
AntEntity
 Inherited
debugDraw(aCamera:AntCamera):void
[override] Отладочная отрисовка.
AntEntity
  
destroy():void
[override] Используется для уничтожения объекта и освобождения занимаемых им ресурсов.
AntButton
  
draw(aCamera:AntCamera):void
[override] Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.
AntButton
 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
  
hitTest(aX:Number, aY:Number, aPixelFlag:Boolean = false):Boolean
[override] Проверяет попадает ли указанные координаты в прямоугольник сущности.
AntButton
  
hitTestPoint(aPoint:AntPoint, aPixelFlag:Boolean = false):Boolean
[override] Проверяет попадает ли указанная точка в прямоугольник сущности.
AntButton
 Inherited
hurt(aDamage:Number):Boolean
Наносит урон.
AntEntity
 Inherited
kill():void
[override] Вызывается когда объект необходимо временно "убить" и освободить для повторного использования.
AntEntity
  
makeButton(aAnimName:String, aText:String = null, aLabel:AntLabel = null, aIsScrolled:Boolean = false):AntButton
[static] Альтернативный конструктор кнопки для быстрого создания кнопки с текстом и без.
AntButton
 Inherited
numDead():int
Определяет количество "мертвых" дочерних сущностей.
AntEntity
 Inherited
numLiving():int
Определяет количество "живых" дочерних сущностей.
AntEntity
 Inherited
onEventBubbled(aEvent:IEvent):Boolean
Обработчик для всплывающего события.
AntEntity
 Inherited
onScreen(aCamera:AntCamera = null):Boolean
Проверяет попадает ли сущность на экран указанной камеры.
AntEntity
 Inherited
postUpdate():void
Вызывается каждый кадр сразу после вызова метода update();
AntBasic
 Inherited
preUpdate():void
[override] Вызывается каждый кадр перед вызовом метода update().
AntEntity
 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
 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
 Inherited
swap(aEntityA:AntEntity, aEntityB:AntEntity):void
Меняет указанные сущности местами.
AntEntity
  
switchAnimation(aName:String):void
Переключение анимации.
AntButton
  
update():void
[override] Вызывается каждый кадр.
AntButton
 Inherited
Обновляет положение и размеры прямоугольника определяющего занимаемую область в игровом мире.
AntEntity
Protected Methods
 MethodDefined By
 Inherited
calcBounds():void
Простой рассчет занимаемого сущностью прямоугольника без учета угла поворота.
AntEntity
  
calcFrame(aFrame:int = 0):void
Перерасчет текущего кадра.
AntButton
  
drawButton(aCamera:AntCamera):void
Отрисовка кнопки в буффер указанной камеры.
AntButton
 Inherited
drawChildren(aCamera:AntCamera):void
Отрисовка дочерних сущностей.
AntEntity
  
getVisibility():Boolean
Проверяет реальную видимость кнопки на экране.
AntButton
  
goto(aFrame:int):void
Переводит состояние кнопки на указанный кадр.
AntButton
 Inherited
Инвертирует вершины если необходимо.
AntEntity
 Inherited
locate(aX:Number, aY:Number, aAngle:Number):void
Перерасчитывает глобальное позиционирование сущности согласно родительским координатам и углу.
AntEntity
 Inherited
moveBounds():void
Простой перерассчет занимаемого сущностью прямоугольника при условии что угол и размеры сущности не изменились.
AntEntity
  
Обработчик нажатия кнопки мыши.
AntButton
  
onMouseOut():void
Обработчик выхода мышки за пределы кнопки.
AntButton
  
Обработчик наведения мышки на кнопку.
AntButton
  
onMouseUp():void
Обработчик отпускания кнопки мыши.
AntButton
  
Сброс локальных помошников.
AntButton
 Inherited
Полный перерассчет занимаемого сущностью прямоугольника с учетом угла, размеров и положения.
AntEntity
 Inherited
Сохраняет предыдущие значения положения и угла для оптимизации рассчетов.
AntEntity
 Inherited
sortHandler(aEntity1:AntEntity, aEntity2:AntEntity):int
Помошник для сортировки вложенных сущностей.
AntEntity
 Inherited
toScreenPosition(aX:Number, aY:Number, aCamera:AntCamera = null, aResult:AntPoint = null):AntPoint
Переводит указанные координаты в экранные.
AntEntity
  
Обработка логики кнопки.
AntButton
 Inherited
Обработка дочерних сущностей.
AntEntity
  
Обновляет положение текстовой метки.
AntButton
 Inherited
Рассчет скорости движения и вращения сущности.
AntEntity
  
Обновляет визуальное представление кнопки в зависимости от текущего состояния.
AntButton
Public Constants
 ConstantDefined By
 InheritedASCENDING : int = -1
[static] Константа для определения способа сортировки по возрастанию.
AntEntity
 InheritedDESCENDING : int = 1
[static] Констатна для определения способа сортировки по убыванию.
AntEntity
  DOWN : uint = 3
[static]
AntButton
  NORMAL : uint = 1
[static]
AntButton
  OVER : uint = 2
[static]
AntButton
Property Detail
_alphaproperty
protected var _alpha:Number

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

The default value is 1.

_animationsproperty 
protected var _animations:AntStorage

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

The default value is 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.

_downproperty 
protected var _down:Boolean

Определяет нажата ли кнопка.

The default value is false.

_flashPointproperty 
protected var _flashPoint:Point

_flashPointZeroproperty 
protected var _flashPointZero:Point

_flashRectproperty 
protected var _flashRect:Rectangle

_iChangeCursorproperty 
protected var _iChangeCursor:Boolean

Помошники для функционирования кнопки.

_matrixproperty 
protected var _matrix:Matrix

_overproperty 
protected var _over:Boolean

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

The default value is false.

_pixelsproperty 
protected var _pixels:BitmapData

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

_pointproperty 
protected var _point:AntPoint

_prevFrameproperty 
protected var _prevFrame:int

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

The default value is -1.

_selectedproperty 
protected var _selected:Boolean

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

The default value is false.

_toggleproperty 
protected var _toggle:Boolean

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

The default value is false.

alphaproperty 
alpha:Number

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


Implementation
    public function get alpha():Number
    public function set alpha(value:Number):void
blendproperty 
public var blend:String

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

The default value is null.

cameraproperty 
public var camera:AntCamera

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

The default value is AntG.getCamera();.

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
defDownCursorAnimproperty 
public static var defDownCursorAnim:String

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

The default value is null.

defOverCursorAnimproperty 
public static var defOverCursorAnim:String

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

The default value is null.

defSoundClickproperty 
public static var defSoundClick:String

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

The default value is null.

defSoundOutproperty 
public static var defSoundOut:String

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

The default value is null.

defSoundOverproperty 
public static var defSoundOver:String

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

The default value is null.

downCursorAnimproperty 
public var downCursorAnim:String

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

The default value is null.

eventClickproperty 
public var eventClick:AntSignal

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

eventDownproperty 
public var eventDown:AntSignal

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

eventOutproperty 
public var eventOut:AntSignal

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

eventOverproperty 
public var eventOver:AntSignal

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

eventUpproperty 
public var eventUp:AntSignal

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

labelproperty 
public var label:AntLabel

Указатель на текстовую метку кнопки.

The default value is null.

labelOffsetproperty 
public var labelOffset:AntPoint

Смещение текстовой метки при нажатии.

The default value is (0,1).

overCursorAnimproperty 
public var overCursorAnim:String

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

The default value is null.

selectedproperty 
selected:Boolean

Определяет состояние выбранности кнопки. Работает только если для кнопки установлен режим чекбокса toggle = true;


Implementation
    public function get selected():Boolean
    public function set selected(value:Boolean):void
smoothingproperty 
public var smoothing:Boolean

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

The default value is true.

soundClickproperty 
public var soundClick:String

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

The default value is null.

soundOutproperty 
public var soundOut:String

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

The default value is null.

soundOverproperty 
public var soundOver:String

Имя звука который воспроизводится при наведении на кнопку.

The default value is null.

statusproperty 
public var status:uint

Текущее состояние кнопки.

The default value is NORMAL.

textproperty 
text:String

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


Implementation
    public function get text():String
    public function set text(value:String):void
toggleproperty 
toggle:Boolean

Определяет режим чекбокса для кнопки.


Implementation
    public function get toggle():Boolean
    public function set toggle(value:Boolean):void
useSystemCursorproperty 
public var useSystemCursor:Boolean

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

The default value is true.

Constructor Detail
AntButton()Constructor
public function AntButton()

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) — Переключение на добавленную анимацию.

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

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

Parameters

aFrame:int (default = 0)

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

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

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

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

Parameters

aCamera:AntCamera

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

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

Parameters

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

getVisibility()method 
protected function getVisibility():Boolean

Проверяет реальную видимость кнопки на экране. Например, кнопка может быть видима, а сущность которая содержит кнопку — скрыта. Проверка выполняется для всей иерархии объектов которые содержат данную кнопку.

Returns
Boolean — Вернет false если кнопка кнопка не видна из-за того что скрыта какая-либо родительская сущность.
goto()method 
protected function goto(aFrame:int):void

Переводит состояние кнопки на указанный кадр.

Parameters

aFrame:int — Кадр на который необходимо перевести состояние кнопки.

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 если точка попадает в прямоугольник кнопки.
makeButton()method 
public static function makeButton(aAnimName:String, aText:String = null, aLabel:AntLabel = null, aIsScrolled:Boolean = false):AntButton

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

Parameters

aAnimName:String — Имя анимации для кнопки в хранилище анимаций.
 
aText:String (default = null) — Текст на кнопке.
 
aLabel:AntLabel (default = null) — Текстовая метка для кнопки.
 
aIsScrolled:Boolean (default = false) — Определяет привязана кнопка в игровому миру или к камере.

Returns
AntButton — Возвращает указатель на новую кнопку.
onMouseDown()method 
protected function onMouseDown():void

Обработчик нажатия кнопки мыши.

onMouseOut()method 
protected function onMouseOut():void

Обработчик выхода мышки за пределы кнопки.

onMouseOver()method 
protected function onMouseOver():void

Обработчик наведения мышки на кнопку.

onMouseUp()method 
protected function onMouseUp():void

Обработчик отпускания кнопки мыши.

resetHelpers()method 
protected function resetHelpers():void

Сброс локальных помошников.

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

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

Parameters

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

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

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

updateButton()method 
protected function updateButton():void

Обработка логики кнопки.

updateLabel()method 
protected function updateLabel():void

Обновляет положение текстовой метки.

updateVisualStatus()method 
protected function updateVisualStatus():void

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

Constant Detail
DOWNConstant
public static const DOWN:uint = 3

NORMALConstant 
public static const NORMAL:uint = 1

OVERConstant 
public static const OVER:uint = 2