webgme-engine

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: GMENode</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: GMENode</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>GMENode<span class="signature">(_id, logger, state, storeNode)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="GMENode"><span class="type-signature"></span>new GMENode<span class="signature">(_id, logger, state, storeNode)</span><span class="type-signature"></span></h4> <div class="description"> <p>This class provides the API for getting information about a gme node in the model. To get hold of such object use the <a href="Client.html#getNode">getNode</a> function. !!! The documentation of the functions of the class are not complete!!! The functions of this class are aligned with the functions of the <a href="Core.html">Core</a>.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>_id</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>Path of node.</p></td> </tr> <tr> <td class="name"><code>logger</code></td> <td class="type"> <span class="param-type"><a href="GmeLogger.html">GmeLogger</a></span> </td> <td class="description last"><p>logger.</p></td> </tr> <tr> <td class="name"><code>state</code></td> <td class="type"> <span class="param-type"><a href="global.html#object">object</a></span> </td> <td class="description last"><p>state of the client.</p></td> </tr> <tr> <td class="name"><code>storeNode</code></td> <td class="type"> <span class="param-type"><a href="global.html#function">function</a></span> </td> <td class="description last"><p>invoked when storing new nodes.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line5">line 5</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="getAttribute"><span class="type-signature"></span>getAttribute<span class="signature">(name)</span><span class="type-signature"> → {<a href="global.html#object">object</a>|primitive|<a href="global.html#null">null</a>|<a href="global.html#undefined">undefined</a>}</span></h4> <div class="description"> <p>Retrieves the value of the given attribute of the given node.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>the name of the attribute.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line110">line 110</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns the value of the attribute of the node. The value can be an object or any primitive type. If the value is undefined that means the node do not have such attribute defined.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#object">object</a></span> | <span class="param-type">primitive</span> | <span class="param-type"><a href="global.html#null">null</a></span> | <span class="param-type"><a href="global.html#undefined">undefined</a></span> </dd> </dl> <h4 class="name" id="getAttributeMeta"><span class="type-signature"></span>getAttributeMeta<span class="signature">(name)</span><span class="type-signature"> → {<a href="global.html#object">object</a>}</span></h4> <div class="description"> <p>Returns the definition object of an attribute from the META rules of the node.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>the name of the attribute.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line241">line 241</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns the definition object, where type is always defined. For examples see the similar <a href="Core.html#getAttributeMeta">Core</a> definition.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#object">object</a></span> </dd> </dl> <h4 class="name" id="getAttributeNames"><span class="type-signature"></span>getAttributeNames<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Returns the names of the defined attributes of the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line202">line 202</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns an array of the names of the attributes of the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="getBaseId"><span class="type-signature"></span>getBaseId<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4> <div class="description"> <p>Returns the path of the base of the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line72">line 72</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The paths of the base of the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> </dd> </dl> <h4 class="name" id="getBaseTypeId"><span class="type-signature"></span>getBaseTypeId<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>|<a href="global.html#null">null</a>}</span></h4> <div class="description"> <p>Returns the id of the meta-node of the node in question, that is the first base node that is part of the meta. (Aliased getMetaTypeId).</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line266">line 266</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns the id of the first node (including itself) among the inheritance chain that is a META node. It returns null if it does not find such node (ideally the only node with this result is the ROOT).</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> </dd> </dl> <h4 class="name" id="getChildrenIds"><span class="type-signature"></span>getChildrenIds<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Collects the paths of all the children of the given node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line63">line 63</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns an array of the absolute paths of the children.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="getChildrenRelids"><span class="type-signature"></span>getChildrenRelids<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Collects the relative ids of all the children of the given node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line54">line 54</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns an array of the relative ids.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="getGuid"><span class="type-signature"></span>getGuid<span class="signature">()</span><span class="type-signature"> → {Core.GUID}</span></h4> <div class="description"> <p>Get the GUID of a node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line45">line 45</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns the globally unique identifier.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Core.GUID</span> </dd> </dl> <h4 class="name" id="getId"><span class="type-signature"></span>getId<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4> <div class="description"> <p>Returns the path of the given node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line27">line 27</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The path of the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> </dd> </dl> <h4 class="name" id="getInheritorIds"><span class="type-signature"></span>getInheritorIds<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Gathers the paths of instances of the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line101">line 101</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The paths of the instances of the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="getMetaTypeId"><span class="type-signature"></span>getMetaTypeId<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4> <div class="description"> <p>Returns the id of meta-node of the node in question, that is the first base node that is part of the meta. (Aliased getBaseTypeId).</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line253">line 253</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns the id of the first node (including itself) among the inheritance chain that is a META node. It returns null if it does not find such node (ideally the only node with this result is the ROOT).</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> </dd> </dl> <h4 class="name" id="getOwnAttribute"><span class="type-signature"></span>getOwnAttribute<span class="signature">(name)</span><span class="type-signature"> → {<a href="global.html#object">object</a>|primitive|<a href="global.html#null">null</a>|<a href="global.html#undefined">undefined</a>}</span></h4> <div class="description"> <p>Returns the value of the attribute defined for the given node.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>the name of the attribute.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line123">line 123</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns the value of the attribute defined specifically for the node. If undefined then it means that there is no such attribute defined directly for the node, meaning that it either inherits some value or there is no such attribute at all. [The retrieved attribute should not be modified as is - it should be copied first!!]</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#object">object</a></span> | <span class="param-type">primitive</span> | <span class="param-type"><a href="global.html#null">null</a></span> | <span class="param-type"><a href="global.html#undefined">undefined</a></span> </dd> </dl> <h4 class="name" id="getOwnAttributeNames"><span class="type-signature"></span>getOwnAttributeNames<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Returns the names of the attributes of the node that have been first defined for the node and not for its bases.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line221">line 221</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns an array of the names of the own attributes of the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="getOwnPointerId"><span class="type-signature"></span>getOwnPointerId<span class="signature">(name)</span><span class="type-signature"> → {<a href="global.html#string">string</a>|<a href="global.html#null">null</a>|<a href="global.html#undefined">undefined</a>}</span></h4> <div class="description"> <p>Returns the path of the target node of the given pointer defined for this specific node.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>The name of the pointer.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line172">line 172</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The path of the target node. If the response is null, then the pointer is defined but has no target, if undefined, it is not defined.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> | <span class="param-type"><a href="global.html#undefined">undefined</a></span> </dd> </dl> <h4 class="name" id="getOwnPointerNames"><span class="type-signature"></span>getOwnPointerNames<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Returns the list of the names of the pointers that were defined specifically for the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line193">line 193</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns an array of names of pointers defined specifically for the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="getOwnRegistry"><span class="type-signature"></span>getOwnRegistry<span class="signature">(name)</span><span class="type-signature"> → {primitive|<a href="global.html#object">object</a>|<a href="global.html#null">null</a>|<a href="global.html#undefined">undefined</a>}</span></h4> <div class="description"> <p>Returns the value of the registry entry defined for the given node. Please note that this return value should not be mutated!</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>The name of the registry entry.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line148">line 148</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The value of the registry entry.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">primitive</span> | <span class="param-type"><a href="global.html#object">object</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> | <span class="param-type"><a href="global.html#undefined">undefined</a></span> </dd> </dl> <h4 class="name" id="getOwnValidAttributeNames"><span class="type-signature"></span>getOwnValidAttributeNames<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Returns the list of the META defined attribute names of the node that were specifically defined for the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line231">line 231</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns the attribute names that are defined specifically for the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="getParentId"><span class="type-signature"></span>getParentId<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>|<a href="global.html#null">null</a>}</span></h4> <div class="description"> <p>Returns the path of the parent of the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line18">line 18</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The path of the parent.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> </dd> </dl> <h4 class="name" id="getPointerId"><span class="type-signature"></span>getPointerId<span class="signature">(name)</span><span class="type-signature"> → {<a href="global.html#string">string</a>|<a href="global.html#null">null</a>|<a href="global.html#undefined">undefined</a>}</span></h4> <div class="description"> <p>Returns the path of the target node of the given pointer.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>The name of the pointer.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line160">line 160</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The path of the target node. If the response is null, then the pointer is defined but has no target, if undefined, it is not defined.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> | <span class="param-type"><a href="global.html#undefined">undefined</a></span> </dd> </dl> <h4 class="name" id="getPointerNames"><span class="type-signature"></span>getPointerNames<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Retrieves a list of the defined pointer names of the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line184">line 184</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns an array of the names of the pointers of the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="getRegistry"><span class="type-signature"></span>getRegistry<span class="signature">(name)</span><span class="type-signature"> → {primitive|<a href="global.html#object">object</a>|<a href="global.html#null">null</a>|<a href="global.html#undefined">undefined</a>}</span></h4> <div class="description"> <p>Returns the value of the given registry entry.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>The name of the registry entry.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line137">line 137</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The value of the registry entry.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">primitive</span> | <span class="param-type"><a href="global.html#object">object</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> | <span class="param-type"><a href="global.html#undefined">undefined</a></span> </dd> </dl> <h4 class="name" id="getRelid"><span class="type-signature"></span>getRelid<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>|<a href="global.html#null">null</a>|<a href="global.html#undefined">undefined</a>}</span></h4> <div class="description"> <p>Returns the relative id of the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line36">line 36</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The relative id of the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> | <span class="param-type"><a href="global.html#undefined">undefined</a></span> </dd> </dl> <h4 class="name" id="getValidAttributeNames"><span class="type-signature"></span>getValidAttributeNames<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>>}</span></h4> <div class="description"> <p>Returns the list of the META defined attribute names of the node.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line211">line 211</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns all the attribute names that are defined among the META rules of the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#string">string</a>></span> </dd> </dl> <h4 class="name" id="isInstanceOf"><span class="type-signature"></span>isInstanceOf<span class="signature">(baseId)</span><span class="type-signature"> → {bool}</span></h4> <div class="description"> <p>Checks if the node is an instance of the node at base Id.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>baseId</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>Id to the base node we want to check.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line292">line 292</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns true if the base is on the inheritance chain of node. A node is considered to be an instance of itself here.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">bool</span> </dd> </dl> <h4 class="name" id="isTypeOf"><span class="type-signature"></span>isTypeOf<span class="signature">(typeId)</span><span class="type-signature"> → {bool}</span></h4> <div class="description"> <p>Checks if the given node in any way inherits type-node. In addition to checking if the node "isInstanceOf" of type-node, this methods also takes mixins into account.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>typeId</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>Id to the type node we want to check.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line279">line 279</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>The function returns true if the type-node is a base node, or a mixin of any of the base nodes, of the node. Every node is considered to be a type of itself.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">bool</span> </dd> </dl> <h4 class="name" id="isValidNewChild"><span class="type-signature"></span>isValidNewChild<span class="signature">(baseId)</span><span class="type-signature"> → {bool}</span></h4> <div class="description"> <p>Checks if the node can have a child of the given type without causing containment inheritance loop.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>baseId</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>Id to the base node that would be the type of the child.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line303">line 303</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>Returns true if a child of the given type can be created.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">bool</span> </dd> </dl> <h4 class="name" id=".getLibraryRootId"><span class="type-signature">(static) </span>getLibraryRootId<span class="signature">(name)</span><span class="type-signature"> → {<a href="global.html#string">string</a>|<a href="global.html#null">null</a>}</span></h4> <div class="description"> <p>Returns the Id of the root of the library in question.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>the name of the library.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line322">line 322</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>If the library is found then the return value will be the Id of its root, otherwise the function returns null.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> </dd> </dl> <h4 class="name" id=".isValidNewBase"><span class="type-signature">(static) </span>isValidNewBase<span class="signature">(base)</span><span class="type-signature"> → {<a href="global.html#boolean">boolean</a>}</span></h4> <div class="description"> <p>Checks if base can be the new base of node.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>base</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type"><a href="global.html#null">null</a></span> | <span class="param-type"><a href="global.html#undefined">undefined</a></span> </td> <td class="description last"><p>the new base.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="docs_client.getter.doc.js.html">docs/client.getter.doc.js</a>, <a href="docs_client.getter.doc.js.html#line313">line 313</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>True if the supplied base is a valid base for the node.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#boolean">boolean</a></span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="Server_GMEAuth.html">Server:GMEAuth</a></li><li><a href="Server_SafeStorage.html">Server:SafeStorage</a></li><li><a href="Server_UserProject.html">Server:UserProject</a></li><li><a href="module-Core.html">Core</a></li><li><a href="module-Storage.html">Storage</a></li><li><a href="module-crosscuts.html">crosscuts</a></li><li><a href="module-serialization.html">serialization</a></li></ul><h3>Externals</h3><ul><li><a href="external-Promise.html">Promise</a></li></ul><h3>Classes</h3><ul><li><a href="AddOnBase.html">AddOnBase</a></li><li><a href="AddOnUpdateResult.html">AddOnUpdateResult</a></li><li><a href="Artifact.html">Artifact</a></li><li><a href="BlobClient.html">BlobClient</a></li><li><a href="BlobMetadata.html">BlobMetadata</a></li><li><a href="BlobRunPluginClient.html">BlobRunPluginClient</a></li><li><a href="Client.html">Client</a></li><li><a href="Core.html">Core</a></li><li><a href="ExecutorClient.html">ExecutorClient</a></li><li><a href="GMENode.html">GMENode</a></li><li><a href="GmeLogger.html">GmeLogger</a></li><li><a href="InterPluginResult.html">InterPluginResult</a></li><li><a href="JobInfo.html">JobInfo</a></li><li><a href="OutputInfo.html">OutputInfo</a></li><li><a href="PluginBase.html">PluginBase</a></li><li><a href="PluginConfig.html">PluginConfig</a></li><li><a href="PluginMessage.html">PluginMessage</a></li><li><a href="PluginNodeDescription.html">PluginNodeDescription</a></li><li><a href="PluginResult.html">PluginResult</a></li><li><a href="Project.html">Project</a></li><li><a href="ProjectInterface.html">ProjectInterface</a></li><li><a href="Server_GMEAuth-GMEAuth.html">GMEAuth</a></li><li><a href="Server_SafeStorage-SafeStorage.html">SafeStorage</a></li><li><a href="Server_UserProject-UserProject.html">UserProject</a></li><li><a href="WebsocketRouter.html">WebsocketRouter</a></li><li><a href="WebsocketRouterUser.html">WebsocketRouterUser</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:BRANCH_CHANGED">BRANCH_CHANGED</a></li><li><a href="Client.html#event:BRANCH_CLOSED">BRANCH_CLOSED</a></li><li><a href="Client.html#event:BRANCH_OPENED">BRANCH_OPENED</a></li><li><a href="Client.html#event:BRANCH_STATUS_CHANGED">BRANCH_STATUS_CHANGED</a></li><li><a href="Client.html#event:CONNECTED_USERS_CHANGED">CONNECTED_USERS_CHANGED</a></li><li><a href="Client.html#event:NETWORK_STATUS_CHANGED">NETWORK_STATUS_CHANGED</a></li><li><a href="Client.html#event:NOTIFICATION">NOTIFICATION</a></li><li><a href="Client.html#event:PLUGIN_FINISHED">PLUGIN_FINISHED</a></li><li><a href="Client.html#event:PLUGIN_INITIATED">PLUGIN_INITIATED</a></li><li><a href="Client.html#event:PLUGIN_NOTIFICATION">PLUGIN_NOTIFICATION</a></li><li><a href="Client.html#event:PROJECT_CLOSED">PROJECT_CLOSED</a></li><li><a href="Client.html#event:PROJECT_OPENED">PROJECT_OPENED</a></li></ul><h3><a href="global.html">Global</a></h3> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Jun 21 2024 09:43:40 GMT-0400 (Eastern Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>