Available translations
loading results
Plugin File
A plugin file is the JSON file that constitutes the plugin. In the context of the plugins hierarchy, a plugin is the definition of a hierarchy.
Content
Plugin files distributed with the system are stored in the corresponding folders on the following path:
\Projects\[ProjectName]\Plugins\ To create a plugin and make it available to the system you need to:
- Take a backup of the hierarchy.
- Place it in the proper folder of the path.
Important: Hierarchies included in the workspace as plugins are not saved at the workspace level. As such, changes made in those hierarchies do not persist. If you wish to modify a plugin and keep working with the modified version in the future, you must either clone or backup the plugin and work on the resulting copy instead.
Configuring
Initial Values
These are the Initial Values for Plugin File configuration:
{
"project": "",
"fileName": "",
"folderName": "",
"nodeType": ""
} Examples
This is a list of properties featured by the Plugin File configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Plugin File Menu
The Plugin File node has the following Node Menu items:
The Configure menu item has the following properties:
- action: Configure
- label: Configure
- iconPathOn: configuration
- iconPathOff: configuration
- actionFunction:
uiObject.configEditor.activate
- actionProject: Foundations
The Add Plugin File Position menu item has the following properties:
- action: Add UI Object
- disableIfPropertyIsDefined: true
- propertyToCheckFor:
pluginFilePosition
- actionFunction:
payload.executeAction
- label: Add Plugin File Position
- relatedUiObject: Plugin File Position
- actionProject: Visual-Scripting
- relatedUiObjectProject: Community-Plugins
The Enable Saving With Workspace menu item has the following properties:
- action: Enable Saving With Workspace
- actionFunction:
payload.executeAction
- label: Enable Saving With Workspace
- workDoneLabel: Enabled
- secondaryAction: Disable Saving With Workspace
- secondaryLabel: Disable Saving With Workspace
- secondaryWorkDoneLabel: Disabled
- secondaryIcon: disable-saving-with-workspace
- booleanProperty:
saveWithWorkspace
- iconPathOn: enable-saving-with-workspace
- iconPathOff: enable-saving-with-workspace
- iconProject: Community-Plugins
- actionProject: Community-Plugins
- relatedUiObjectProject: Community-Plugins
The Save Plugin File menu item has the following properties:
- action: Save Plugin File
- actionFunction:
payload.executeAction
- label: Save Plugin File
- relatedUiObject: Plugin File
- actionProject: Community-Plugins
- relatedUiObjectProject: Community-Plugins
The Delete menu item has the following properties:
- action: Delete UI Object
- actionProject: Visual-Scripting
- askConfirmation: true
- confirmationLabel: Confirm to Delete
- label: Delete
- iconPathOn: delete-entity
- iconPathOff: delete-entity
- actionFunction:
payload.executeAction
Tip: When a menu item is grayed out, it means that Plugin File already has the required child type that the menu item may add, and only that child is allowed for that case.
Plugin File Children
The Plugin File node has the following childrenNodesProperties:
The Plugin File Position node property features the following properties:
- name:
pluginFilePosition
- type: node
- childType: Plugin File Position
- autoAdd: false
Plugin File Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Plugin File with other nodes:
Compatible Types: