Extensions

enabled static property

enabled:Boolean [read-write]

Scaleform version: 4.0.12

Enables/disables the extensions.

noInvisibleAdvance static property

noInvisibleAdvance:Boolean [read-write]

Scaleform version: 4.0.12

If set to true, this property turns off advancing of all invisible movie clips. This might be used to improve performance of SWFs that contain many hidden movie clips. Note, Flash advances invisible movie clips (it still executes timeline animation, invokes frame’s ActionScript code and so on). Thus, setting this property to true may lead to differences in behavior between Scaleform and Flash.

Note: This property may stop working for some children in the case when the child’s branch is re-parented from another parent with this flag not set, and other way around; it may continue to work for the child’s branch when it is re-parented to the parent with the flag not set. In this case user should set/reset the flag manually for the parent after re-parenting children (and it will be propagated to all its children).

getTopMostEntity() static method

public function getTopMostEntity(x : Number, y : Number, testAll: Boolean) :   DisplayObject

Scaleform version: 4.0.13

Returns a topmost DisplayObject instance that can be found at (x, y) coordinates (stage coordinate space). This method also may differ between characters with button handlers set (e.g., CLICK, MOUSE_DOWN, ROLL_OVER, etc) and without them. This distinction may be useful to filter out characters that have no handlers to handle mouse events.

This method is inverse to MovieClip.hitTest since the hitTest checks if x and y coordinates are inside of the particular object and the getTopMostEntity returns the actual object at the specified x and y coordinates. Thus Extensions.getTopMostEntity(x, y).hitTest(x, y, true) == true.

Parameters testAll : Boolean – Indicates to look only for characters with button handlers (false) or for any character (true). If this parameter is not specified then getTopMostEntity assumes it is true.

x : Number, y : Number – Stage coordinates at which to look for a character.

See Also:

getMouseTopMostEntity

getMouseTopMostEntity() static method

public function getTopMostEntity([testAll : Boolean], [mouseIndex : uint]) : DisplayObject

Scaleform version: 4.0.13

Returns a topmost DisplayObject instance that can be found at the current mouse cursor position. This function is similar to getTopMostEntity, but instead of explicit coordinates it uses mouse coordinates.

mouseIndex : Number – Zero-based mouse index.

See Also:

getTopMostEntity

getMouseCursorType() static method

public function getMouseCursorType([mouseIndex : uint]) : String

Scaleform version: 4.0.13

This static method returns the current mouse cursor type for the specified mouse controller. This method is similar to flash.ui.Mouse.cursor property, the only difference is this method allows to change cursor for multiple mice.

To track and optionally prevent mouse cursor change use MouseCursorEvent.CURSOR_CHANGE extension event.

Parameters

mouseIndex : Number – Zero-based mouse index (zero by default).

Returns

Returns type of the cursor, see flash.ui.MouseCursor static constants, such as: * flash.ui.MouseCursor.ARROW : String = “arrow” * flash.ui.MouseCursor.BUTTON : String = “button” * flash.ui.MouseCursor.HAND : String = “hand” * flash.ui.MouseCursor.IBEAM : String = “ibeam”

See Also:

setMouseCursorType
MouseCursorEvent

setMouseCursorType() static method

public function setMouseCursorType(cursor : String, [mouseIndex : uint]) : void

Scaleform version: 4.0.13

This static method changes the mouse cursor according to the parameter cursor. This method is similar to flash.ui.Mouse.cursor property, the only difference is this method allows to change cursor for multiple mice.

To track and optionally prevent mouse cursor change use MouseCursorEvent.CURSOR_CHANGE extension event.

Parameters

cursor : uint – Type of the cursor, see flash.ui.MouseCursor static constants, such as:

*   flash.ui.MouseCursor.ARROW : String = “arrow”
*   flash.ui.MouseCursor.BUTTON : String = “button”
*   flash.ui.MouseCursor.HAND : String = “hand”
*   flash.ui.MouseCursor.IBEAM : String = “ibeam”
*

mouseIndex : Number – Zero-based mouse index (zero by default).

See Also:

getMouseCursorType
MouseCursorEvent

numControllers static property

numControllers:uint [read]

Scaleform version: 4.0.12

Returns the number of controllers detected in the system.

setEdgeAAMode() static method

public function setEdgeAAMode(dispObj:DisplayObject, mode:uint):void

Scaleform version: 4.0.12

Sets the EdgeAA mode of a specific display object and its children. The following mode values are accepted:

scaleform.gfx.Extensions.EDGEAA_INHERIT = 0;Inherit EdgeAA mode from parent. On by default.
scaleform.gfx.Extensions.EDGEAA_ON = 1;Enable EdgeAA mode for the target display object and its children, unless disabled (see EDGEAA_DISABLE)
scaleform.gfx.Extensions.EDGEAA_OFF = 2;Do not use EdgeAA for the target display object and its children.
scaleform.gfx.Extensions.EDGEAA_DISABLE = 3;Disable EdgeAA for the target display object and its children, overriding an inherited EDGEAA_ON mode value.

Parameters

dispObj : DisplayObject – The target display object to apply the new EdgeAA mode value.

mode : uint – The EdgeAA mode value.

Extensions

Parent topic