ContextValueΒΆ

class ContextValue

A ContextValue node allows routing a Plug value based on the current context

Hierarchy

class ContextValue < class ContextControlNode < class ControlNode < class HostNode < class Node < class SelectableNode

Members

Plugs:

nil Context R The message plug that dependends on all inputs, and on which all outputs depend

Functions:

any value getplugincontext ( Plug plug , string|nil context ) Get the plug value for a specific context
nil setplug ( Plug plug , any value ) Overrides a plug value for the current context, or set the plug default value when no context is active
nil setplugincontext ( Plug plug , any value , string|nil context ) Overrides a plug value for the current context, or set the plug default value when no context is active

Inherited from class HostNode

Plugs:

types.string HostPath RW The data archive to read HostPlugs value when baked

Methods:

nil deleteinheritedattr ( string plugname ) Delete an inherited attribute plug from the node
nil setinheritedattr ( string plugname , [bool|nil] inherited , [ any value ] ) Set the inheritance status of the attribute
nil overrideinheritedattr ( string plugname , any value ) Override the attribute

Inherited from class Node

Plugs:

string Name RW The node name

Methods:

nil onpathchanged ( ) Called by the framework when the name of this node or of one of its parent is modified
any value eval ( Plug plug ) Called by the framework when plug (a node's plug) must be evaluated
boolean state isselected ( ) Tell if the node is selected
Node parent getparent ( ) Get the parent Node of this Node
boolean result isparent ( Node child ) Tells if this node is parent of the potential child
Node parent findparent ( string name ) Find the first parent Node of this Node of a specific class
string path getpath ( ) Returns the node path as a string that can be reused with findchild
Node|Plug child findchild ( string path ) Find a child node or plug using a path
nil move ( Node parent ) Move a node to a new parent
nil delete ( ) Delete a node
nil rename ( string name ) Rename a node
[string|number] name getname ( ) Get the Node name in its parent
Node result getchild ( string name ) Get a child node by its name
boolean result isreference ( ) Tells if a node comes from a reference project
boolean result isreadonly ( ) Is the node read only
Reference reference getreference ( ) Returns the reference node it is connected to
Reference reference gettopreference ( ) Returns the top reference node it is connected to
bool result belongstoreference ( Reference ref ) Tells if the node belongs to the reference, or a sub reference
{Node} result loadfile ( string filename , [ table options ] ) load a file content in this node. Possible options are: overrideclass to enforce a specific class for the root node.
ReferenceBase refnode referencefile ( string name , string refpath , [ table options ] ) reference a file content in this node.
Node result loadtemplate ( string template , string name ) load a template file
bool,string success,error savefile ( string filename ) load a node to a file
string result getstringcopy ( ) Return a copy of the node and its content as a string to be pasted
nil setflags ( ) Set the node flags
bool result ismoveable ( ) Tells if the node can be moved
{Node},string result,error pastestringcopy ( string copy , [ {} options ] ) Paste a string copy into this node
of table getreferences ( [ topref Reference ] ) Returns the references in the document sorted depth first.
nil setflags ( number flags ) Sets the node flags
number result getflags ( ) Gets the node flags
types.bool state getflag ( number flag ) Get a specific plug flag.
nil addflags ( number flags ) Add flags to the node flags
nil removeflags ( number flags ) Remove flags of the node flags
boolean result hasflags ( number flags ) Tests the node flags
boolean editable iseditable ( ) Indicates if the node can be edited by the user in the UI
nil seteditable ( boolean editable ) Change the editable state of the node
boolean indocument isindocument ( ) Tells if the node is inside a document, or is pending in the void

Inherited from class SelectableNode

Plugs:

boolean Selected R True if the node is selected. Don't use this plug directly to select a node, use the Document's modifier select method.

Documentation

nil Context R

The message plug that dependends on all inputs, and on which all outputs depend

any value getplugincontext ( Plug plug , string|nil context )

Get the plug value for a specific context

Arguments:

  • plug The plug to get
  • context The context name, or nil for the default value

Return:

  • value The value of the plug for the given context

nil setplug ( Plug plug , any value )

Overrides a plug value for the current context, or set the plug default value when no context is active

Arguments:

  • plug The plug to override
  • value The value to set in the context

nil setplugincontext ( Plug plug , any value , string|nil context )

Overrides a plug value for the current context, or set the plug default value when no context is active

Arguments:

  • plug The plug to override
  • value The value to set in the context
  • context The context name, or nil for the default value