The IStringConfig type exposes the following members.

Methods

  NameDescription
Public methodGetString
Used to retrieve a String from the pin at the specified slice.
Public methodSetString
Used to write a String to the pin at the specified slice.
Public methodSetSubType
Used to set the SubType of a String pin, which is a more detailed specification of the String, used by the GUI to guide the user to insert correct Strings. Note though that this does not prevent a user from setting "wrong" Strings on a pin. Ultimately each node is responsible for dealing with all possible inputs correctly. Should only be called once immediately after the pin has been created in IPlugin.SetPluginHost.
Public methodSetSubType2
Alternative version to IStringConfig.SetSubType() with more options.

Properties

  NameDescription
Public propertyIsConnected
Specifies whether the pin is connected in the patch or not.
(Inherited from IPluginIO.)
Public propertyName
The pins name.
(Inherited from IPluginIO.)
Public propertyOrder
The order property helps the node to arrange its pins visually. The higher the order, the more right the pin appears on the node.
(Inherited from IPluginIO.)
Public propertyPinIsChanged
Returns whether any slice of this pin has been changed in the current frame. This information is typically used to determine if further processing is needed or can be ommited.
(Inherited from IPluginConfig.)
Public propertyPluginHost
Gets the plugin host which created this plugin io.
(Inherited from IPluginIO.)
Public propertySliceCount
The pins SliceCount specifies the number of Values (2D Vector, String...) it carries. This is like the length of an array or list.
(Inherited from IPluginConfig.)
Public propertySpreadAsString
Returns a String of the pins concatenated Values. Typcally used internally only to save a pins state to disk.
(Inherited from IPluginConfig.)

See Also