ReferenceBaseΒΆ

class ReferenceBase

This class is the base class for referencing mechanisms

Hierarchy

class ReferenceBase < class HostNode < class SelectableNode < class Node

Children classes : class GroupRef , class LightRef , class MaterialRef , class ProceduralRef , class Reference , class ShaderNodeMacroRef

Members

Plugs:

boolean LoadHostReferences WR If true, load the sub host references (references with no prefixes).
boolean Loaded R Tells if the reference is loaded or not. Must not be modified direclty.
string ReferenceActualFileName R The actual path of the referenced file, in case the reference path had to be resolved
string ReferenceFileName R The path of the referenced file
string ReferencePathOverride R The path override, so it possible to load another file instead of the original file

Methods:

#bool result reload ( string filename , [ table|nil options ] ) Reload the reference from disk. Using the filename argument, the method will switch the reference for another one. The edits (modifications done on the reference) are re-applied after the reload.
#bool result unload ( ) For internal use only.

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 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

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.

Inherited from class Node

Plugs:

string Name RW The node name

Methods:

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

Documentation

boolean LoadHostReferences WR

If true, load the sub host references (references with no prefixes).

boolean Loaded R

Tells if the reference is loaded or not. Must not be modified direclty.

string ReferenceActualFileName R

The actual path of the referenced file, in case the reference path had to be resolved

string ReferenceFileName R

The path of the referenced file

string ReferencePathOverride R

The path override, so it possible to load another file instead of the original file

#bool result reload ( string filename , [ table|nil options ] )

Reload the reference from disk. Using the filename argument, the method will switch the reference for another one. The edits (modifications done on the reference) are re-applied after the reload.

Arguments:

  • filename The new reference filename. If None/nil, reload the previous reference file.
  • options Options to merge over the current options. If None/nil, options are left unchanged

Return:

  • result Return true is the reference has been reloaded

#bool result unload ( )

For internal use only.

Return:

  • result Unload a loaded top reference. Return true is the reference has been unloaded