HostNode¶

class HostNode

The base class for all nodes that are exported from a Host software

Hierarchy

class HostNode < class SelectableNode < class Node

Children classes : class Compositing , class Constraint , class ControlFilename , class Curve , class Expression , class Material , class Preferences , class ReferenceBase , class RenderPass , class SceneGraphNode , class SubLocator

Members

types.string

HostPath

RW

The data archive to read HostPlugs value when baked

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

---

Inherited from class SelectableNode

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.

---

Inherited from class Node

string

Name

RW

The node name

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
Reference reference	getreference	( )	Returns the 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 )	load 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 )	Paste a string copy into this node
of table	getreferences	( [ topref Reference ] )	Returns the references in the document sorted depth first.
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

Documentation

types.string HostPath RW

The data archive to read HostPlugs value when baked

---

nil deleteinheritedattr ( string plugname )

Delete an inherited attribute plug from the node

• plugname The attribute plug name

---

nil overrideinheritedattr ( string plugname , any value )

Override the attribute

• plugname The attribute plug name
• value The attribute value

---

nil setinheritedattr ( string plugname , [bool|nil] inherited , [ any value ] )

Set the inheritance status of the attribute

• plugname The attribute plug name
• inherited True or nil if the attribute is to be inherited, false otherwise
• value The attribute value if not inherited, or nil to set to default

---