Method XbpPartHandler():setName() Foundation

Defines or retrieves a numeric ID associated with self.

:setName( [<nNameID>] ) --> nOldNameID | NIL
<nNameID> can be used to assign an optional numeric value to the Xbase Part. This value can later be used to identify the XBP.

This method returns the numeric value previously assigned to the Xbase Part. If no previous value exists, NIL is returned.


The :setName() method associates a unique, numeric value to the Xbase Part. The XBP can later be retrieved from its parent's child list based on this value (using the method :childFromName()). The technique of associating an XBP with a unique number removes the need to reference the child in additional memory variables.


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.