Extensions New Object

object mmf.newObject ( number fixed )

The newObject function takes a fixed ID of a valid object instance, and returns a specialized table (an object, in programming terms) representing the object instance.  The contents of the table returned will depend on the type of object requested; the MMFI will automatically expose all the fields and methods that can safely be supported by the type of object requested.

Object tables are unique.  If you call newObject on the same ID multiple times, a reference to the same table will be returned each time, even if you lose all references to the table.  If you add additional fields or methods to the table, they will still be there the next time newObject is called for the same ID.

See Object API for more information about objects.

Parameters

fixed The fixed ID of an object currently on the frame 

Return Values

object An object representing an object instance on the frame

Example

-- Assume 1234 is a valid fixed ID for an object
local fixed = 1234
local obj = mmf.newObject(fixed)
 
-- Print the name of the object as defined in the frame editor
print(obj.className)

See also:
     Object API, New Object Class

Copyright 2010 Justin Aquadro