Value

Value holds a simple or complex type and the corresponding value. These values can be passed to and from the application context to the AS runtime.

The supported types are:

Undefined	The AS undefined value.
Null	The AS null value.
Boolean	The AS Boolean type (C++ bool analogue).
Number	The AS Number type (C++ double analogue).
String	The AS String type. Can be a string managed by the application, or a string from the AS runtime.
StringW	Similar to String, in that it it corresponds to the AS String value, however, it provides a convenient interface for applications that work in a wide char environment.
Object	The AS Object type (and all objects derived from it). A special API interface (ObjectInterface) is provided to manipulate such objects.
Array	A special case of the Object type. An additional API (ObjectInterface) is provided to manipulate AS arrays.
DisplayObject	A special case of the Object type. Corresponds to entities on the stage (MovieClips, Buttons, and TextFields). A custom API (DisplayInfo) is provided to manipulate display properties of such objects.

Regarding strings, the application is expected to manage their lifetimes when Values are assigned const char* or const wchar_t* pointers. Strings returned from the AS runtime are managed by the runtime. To create a string that is managed by the runtime, use the Movie::CreateString() or Movie::CreateStringW() method.

Regarding objects, Values are of type Object (and Array, DisplayObject) are returned by the AS runtime. The application can create instances of the base Object class type, by using the Movie::CreateObject() method. This method also takes a class name that allows users to create instances of specific classes. To create an instance of Array, the Movie::CreateArray() method can be used. Currently, there is no interface to create instances on the stage (of type DisplayObject).

Values are expected to be non-movable, to the tracking mechanism in debug builds. If Values are stored in a dynamic array, use a C++ compliant dynamic array type (such as the STL vector, or the ArrayCPP container). These guarantee that the Values are destroyed and created appropriately on container resize.

Class	Description
DisplayInfo	Structure to modify display properties of a display object.

Enumeration	Description
ValueType	The type of value stored in Value.

Method	Description
AttachMovie	Attaches an instance of a library symbol onto the parent MovieClip.
ClearElements	Removes all elements from an array.
CreateEmptyMovieClip	Creates an empty MovieClip and attaches it onto the parent MovieClip.
DeleteMember	Deletes a member from an object.
GetArraySize	Retrieves the size of an array object.
GetBool	Returns a value of type Boolean.
GetColorTransform	Retrieves the color transformation matrix of the display object.
GetDisplayInfo	Retrieves the display properties of a display object (MovieClips, Buttons and TextFields).
GetDisplayMatrix	Retrieves the display matrix of a display object.
GetElement	Retrieves a specific element from the array by array index.
GetInt	Returns a value of type integer.
GetUInt	Returns a value of type unsigned integer.
GetMatrix3D	Retrieves the transformation matrix of a three-dimensional display object.
GetMember	Retrieves a member of an object.
GetMovie	Retrieves the Movie instance that owns this object.
GetNumber	Returns a value of type number.
GetString	Returns a value of type string.
GetStringW	Returns a value of type wide string.
GetText	Retrieves the raw text of a TextField.
GetTextHTML	Retrieves the HTML code of a TextField.
GetType	Returns type based on which you can interpret the value.
GetUserData	Gets the user data object installed with a VM object held by the GFx::Value.
GetWorldMatrix	Retrieves the world matrix of a display object.
GotoAndPlay	Request the MovieClip referenced by the Value to go to and play a specific frame.
GotoAndStop	Request the MovieClip referenced by the Value to go to and stop at a specific frame.
GetByteArraySize	Retrieves the size of the ActionScript 3 ByteArray.
HasMember	Checks if an object member exists.
Invoke	Calls a method on an object.
GetRawDataPtr	Returns the pointer of the raw data.
InvokeSelf	Calls a closure object. Only supported in ActionScript 3.
IsArray	Determines whether the type is of complex array type or not.
IsBool	Determines whether the type is of Boolean type or not.
IsByteArray	Checks if an ActionScript 3 Object is of ByteArray type.
IsClosure	Determines whether the type is a closure or not. Only supported in ActionScript 3.
IsDisplayObjectActive	Checks if the DisplayObject held by the GFx::Value is on the stage.
IsDisplayObject	Determines whether the type is of display object type or not.
IsNull	Determines whether the type is of null type or not.
GetParent	Returns the parent of the display object.
IsInt	Determines whether the type is of integer type or not.
IsUInt	Determines whether the type is of unsigned integer type or not.
IsNumber	Determines whether the type is of number type or not.
IsNumeric	Determines whether the type is of numeric type or not.
IsInstanceOf	Checks whether this is an instance of the specified class name.
IsObject	Determines whether the type is of complex type (Object, Array, MovieClip, etc) or not.
IsOrphaned	Set if value was referencing managed value and the owner Movie/VM was destroyed.
IsString	Determines whether the type is of string type or not.
IsStringW	Determines whether the type is of wide character string type or not.
IsUndefined	Determines whether the type is of undefined value type or not.
PopBack	Remove an element from the back of an array.
PushBack	Adds an element to the back of an array.
RemoveElement	Removes an element from a specific array index.
RemoveElements	Remove a range of elements from an array.
ReadFromByteArray	Reads bytes from an ActionSCript 3 ByteArray object to a byte buffer.
SetArraySize	Set the size of an array object.
SetBoolean	Sets a Boolean value and type to Boolean.
SetColorTransform	Sets the color transformation matrix of the display object.
SetByteArraySize	Sets the size of the array in bytes.
SetConvertBoolean	Marks a value to be converted to the Boolean type when assigned from within GFx APIs.
SetConvertNumber	Marks a value to be converted to a number type when assigned from within GFx APIs.
SetConvertString	Marks a value to be converted to the character string type when assigned from within GFx APIs.
SetConvertStringW	Marks a value to be converted to the wide character string type when assigned from within GFx APIs.
SetDisplayInfo	Sets the display properties of a display object (MovieClips, Buttons and TextFields).
SetDisplayMatrix	Sets the display matrix of a display object.
SetElement	Set a specific element in the array by array index.
SetInt	Sets a value and type to integer type.
SetUInt	Sets a value and type to unsigned integer type.
SetMatrix3D	Sets the transformation matrix of a three-dimensional display object.
SetMember	Set a member of an object.
SetNull	Sets a value and type to Null.
SetString	Sets a value and type to UTF-8 string type.
SetStringW	Sets a value and type to wide character string type.
SetText	Sets the text of a TextField.
SetTextHTML	Sets HTML text on a TextField.
SetNumber	Sets a value and type to number type.
SetUndefined	Sets a value and type to undefined type.
SetUserData	Sets a user data object with a VM object held by the GFx::Value.
ToString	Converts Value to a string variable.
ToStringW	Converts a value into a wide character string.
Value	Initializes Value object.
VisitElements	Visit the elements of an array.
VisitMembers	Visit the members of an object.
WriteToByteArray	Writes bytes into an ActionScript 3 ByteArray object.

Operator	Description
=	Copies Value object.
==	Determines whether two GFx::Values are equal by comparing their type and values.

GFx_Player.h