Eyeon:Script/Reference/Applications/Fuse/Classes/Link/Attributes
From VFXPedia
< Eyeon:Script | Reference | Applications | Fuse | Classes
Attributes: Input
Note: These attributes are used by Links in Fuses.
See Also: Attributes for Input, Object
attribute name |
type |
description |
LINKS_Name |
string |
The full name of this link. |
LINKID_ID |
string |
The script ID of this link. |
LINKID_DataType |
string |
The type of Parameter (e.g. Number, Point, Text, Image) this link accepts. |
LINKID_AddAfterID |
string |
Controls for this input should appear after the input with the specified ID. |
LINK_Main |
integer |
Values of 1 or higher make this input/output visible on the flow view. 1=Background, 2=Foreground, etc. |
Tips for Attributes (edit)
- LINKS_Name and LINKID_ID are the first two string parameters of self:AddInput(...). This differs from the eyeonscript API, where the input's name and script ID can be retrieved via INPS_Name and INPS_ID respectively.
- LINK_ForceSave: this attribute will cause an input to save its value even if it's set to its default. This is most useful for image size sliders that have a dynamic default based on the comp's defaults. They should, of course, keep their values when copied to a comp with different format.
- LINK_DoNotSave: the input won't get saved to the comp file which means it will receive its default value next time you open the composition. It's useful for hidden inputs that your Fuse might use to store some internal values or for sliders that are only supposed to display calculation results instead of receiving user input.
- LINKID_DataType can also be "FuID", which is used for MultiButtonIDControls or ComboIDControls. You handle FuIDs in your Fuse like any other input objects. Calling :GetValue().Value will return the desired ID as a string. One advantage of using the FuID-InputControls over their regular counterparts that return the selected option as a number is the ability to reorder the buttons or entries in your GUI without changing the underlying values. Default values for these inputs are specified by INPID_DefaultID instead of INP_Default.
- LINKID_LegacyID was introduced in Fusion 6.1.4. Will it load values with this ID but save under the new LINKID_ID?
- - It was made available to fuses in 6.1.4 (it has always been available to C++ plugins), and yes it will load inputs with that ID (you can specify multiple IDs, if for some reason you keep changing their ID), and save them under the new/current ID. Stuart 20:20, 5 March 2012 (EST)