UserPlugΒΆ

class UserPlug

A UserPlug is a Plug that is used to hold user attributes, which are displayed in the User Attributes tab of the node template.

Hierarchy

class UserPlug < class Plug

Members

Inherited from class Plug

Methods:

nil adddependencies ( Plug ... ) Connect outputs plug to this plug
nil adddependency ( Plug output ) Connect an output plug to this plug
nil connect ( Plug output , boolean safe ) Connect an output plug to this plug
nil delete ( ) Delete this plug.
nil disconnect ( Plug output ) Disconnect an output plug from this plug
nil disconnectall ( ) Disconnect a plug from all its connections
nil disconnectcontrol ( ) Disconnect the plug from its input and delete the input if it is a control and it is no longer connected
nil get ( ) Returns the value of a plug. The plug must be readable.
nil getbackdependencies ( ) Retrieve the list of plugs this plug has dependencies on, or nil if none
nil getdependencies ( ) Retrieve the list of plugs this plug is dependent on, or nil if none
types.bool state getflag ( number flag ) Get a specific plug flag.
number flags getflags ( ) Gets the plug flags.
nil getinmotion ( int steps , float time , float start , float stop ) Return an array of values of this plug evaluated in time.
Plug result getinput ( ) Returns the input connection
nil getname ( ) Returns the name of the plug in its parent
nil getnode ( ) Returns the parent node of the plug
{Plug} result getoutputs ( ) Returns the list of output connections
nil getpath ( ) Returns the path of the plug
nil getraw ( ) Returns the raw value of a plug, regardless of its invalidation state.
nil gettype ( ) Get the type associated to the plug
nil hasbackdependencies ( ) Tells if some plugs are dependent on this plug
nil hasdependencies ( ) Tells if the plug is dependent on other plugs
bool result hasoutputs ( ) Tells if the plug is connected in output to some other plugs
nil isanimatable ( ) Tells if the plug value can be animated
boolean result isconnected ( Plug output ) Test if a plug is connected to another
boolean dependent isdependent ( Plug plug ) Returns true if this plug is dependent on other
nil isrefoverriden ( ) Tells if the plug state is overriden from its reference state
boolean result isvalid ( ) Returns the validity status of the plug
nil removealldependencies ( ) Remove all input dependencies of this plug
nil removedependencies ( Plug ... ) Connect an output plug to this plug
nil removedependency ( Plug output ) Connect an output plug to this plug
nil set ( Type value ) Set the value of a plug. The plug must be writable.
nil setflags ( number flags ) Sets the plug flags
nil setvalid ( ) Force the plug valid state, but the plug is not evaluated.
string result tostring ( ) Returns a human readble string of the plug's value
nil touch ( ) Invalidate this plug
nil validate ( ) Force the plug validation by evaluating the plug.

Functions:

nil flushinvalidation ( ) Flush the invalidation counter

Documentation