GetCustomObjectChoice | Objects - Custom |
Declaration:
FUNCTION GetCustomObjectChoice
( objectName :STRING; parameterName :STRING; choiceIndex :INTEGER ) :STRING ; Description:
Function GetCustomObjectChoice returns the choice string of plug-in object parameter displayed as a popup menu or radio group.
Plug-in parameters are displayed in the Object Info palette or the plug-in objects' creation dialog, and may be edited by the user.
Parameters:
objectName Name of the plugin object. parameterName Name of object parameter. choiceIndex Index of choice list item. Result:
Returns associated string of specified choice list item.
GetCustomObjectInfo | Objects - Custom |
Declaration:
FUNCTION GetCustomObjectInfo
( VAR name :STRING; VAR parametric :HANDLE; VAR parametricRecord :HANDLE; VAR wall :HANDLE ) :BOOLEAN ; Description:
Function GetCustomObjectInfo is used within VectorScript plug-in objects (VSOs) to return information about the object.
When specifying parameter names for plug-in objects, always specify the actual name of the variable holding the parameter, not the field or control name.
For example, if you are using a variable PJAMB_DEPTH to store the jamb depth
parameter for your object, you would pass PJAMB_DEPTH as the parameter name.
Parameters:
name Returns the name of the object. parametric Handle to the plugin object. parametricRecord Handle to plugin object parametric record. wall Handle to parent wall(where applicable).
IsNewCustomObject | Objects - Custom |
Declaration:
FUNCTION IsNewCustomObject
( objectName:STRING ) :BOOLEAN ; Description:
Function IsNewCustomObject returns whether the specified plug-in object is a new object, indicating that the object is being regenerated for the first time.
When specifying parameter names for plug-in objects, always specify the actual name of the variable holding the parameter, not the field or control name.
For example, if you are using a variable PJAMB_DEPTH to store the jamb depth
parameter for your object, you would pass PJAMB_DEPTH as the parameter name.
New object status is useful in specifying initialization and setup data, as well as calling initialization specific subroutines. This function should only be called in plug-in objects.
Parameters:
objectName Name of plugin object.
NumCustomObjectChoices | Objects - Custom |
Declaration:
FUNCTION NumCustomObjectChoices
( objectName :STRING; parameterName :STRING ) :INTEGER ; Description:
Function NumCustomObjectChoices returns the number of choice strings for a specified popup menu or radio group parameter in a plug-in object.Parameters:
objectName Name of plugin object. parameterName Name of object parameter.