Object

Functions dealing with objects.

CopyNodeProps
Copies the node properties from one object to another.
GetBipedObjects
Gets all the objects belonging to a biped.
GetInstances
Gets the instances/references of an object.
InstanceNodeProps
Same as copyNodeProps, but instances any controllers on node properties.
IsBipedObject
Returns true if object is part of a biped, else false.
IsInstance
Checks if two objects are instances/references of each other.
ObjectExists
Safely checks if an object exists (ie. isn't undefined or deleted)
SelectAndShow
Checks if objects are hidden/frozen before selecting, and prompts to unhide/unfreeze them if they are.
TrimInvalidObjects
Trims out invalid object from an array of objects.

CopyNodeProps:

Copies the node properties from one object to another.

Returns:

True on success, otherwise false.

Arguments:
<sourceObj>
The source object for the node properties.
<targetObj>
The target object for the node properties.

Back to top...


GetBipedObjects:

Gets all the objects belonging to a biped.
Note: this function will fail if a biped is linked to another biped. Rare.

Returns:

If the passed object is part of a biped, then an array of all the objects associated with that biped will be returned, otherwise an empty array is returned.

Arguments:
<bipObj>
An object that is part of a biped (not necessarily the center of mass object).

Back to top...


GetInstances:

Gets the instances/references of an object.

Returns:

An array of all the instances of the passed object (array doesn't include the passed object).

Arguments:
<obj>
The object to check for instances.

Back to top...


InstanceNodeProps:

Same as copyNodeProps, but instances any controllers on node properties.

Returns:

True on success, otherwise false.

Arguments:
<sourceObj>
The source object for the node properties.
<targetObj>
The target object for the node properties.

Back to top...


IsBipedObject:

Returns true if object is part of a biped, else false

Returns:

Returns true if object is part of a biped, else false

Arguments:
<obj>
The object to check for being a biped object.

Back to top...


IsInstance:

Checks if two objects are instances/references of each other

Returns:

True if the two objects are instances of one another, otherwise false.

Arguments:
<objA>
An object.
<objB>
An object.

Back to top...


ObjectExists:

Safely checks if an object exists (ie. isn't undefined or deleted).

Returns:

True if the object is safe to use/reference, otherwise false.

Arguments:
<obj>
The object to test for validity.

Back to top...


SelectAndShow:

Checks if objects are hidden/frozen before selecting, and prompts to unhide/unfreeze them if they are.

Returns:

OK.

Arguments:
<objArray>
An array of objects to select
[keepSel:false]
If true, the existing selection is added to, otherwise it is cleared.
[prompt:false]
If true, a query box will prompt the user whether the selection should be made.

Back to top...


TrimInvalidObjects:

Trims out invalid object from an array of objects.
Basically run ObjectExists on each object in the array.

Returns:

The trimmed array (the passed in array is also updated).

Arguments:
%<objArray>
An array of objects.

Back to top...