Object.addProperty() 575
Constructor for the Object class
Availability
Flash Player 5.
Usage
new Object([value])
Parameters
value
A number, Boolean value, or string to be converted to an object. This parameter
is optional. If you do not specify
value, the constructor creates a new object with no
defined properties.
Returns
Nothing.
Description
Constructor; creates a new Object object.
Object.addProperty()
Availability
Flash Player 6. In external class files, you can use get or set instead of this method.
Usage
myObject.addProperty(prop, getFunc, setFunc)
Parameters
prop
The name of the object property to create.
getFunc The function that is invoked to retrieve the value of the property; this parameter is a
function object.
setFunc The function that is invoked to set the value of the property; this parameter is a
function object. If you pass the value
null for this parameter, the property is read-only.
Returns
Returns a value of true if the property is successfully created; otherwise, returns false.
Description
Method; creates a getter/setter property. When Flash reads a getter/setter property, it invokes the
get function and the function’s return value becomes a value of
prop. When Flash writes a getter/
setter property, it invokes the set function and passes it the new value as a parameter. If a property
with the given name already exists, the new property overwrites it.
A “get” function is a function with no parameters. Its return value can be of any type. Its type can
change between invocations. The return value is treated as the current value of the property.
A “set” function is a function that takes one parameter, which is the new value of the property. For
example, if property
x is assigned by the statement x = 1, the set function is passed the parameter
1 of type number. The return value of the set function is ignored.