NodeBase
- Last UpdatedAug 21, 2023
- 2 minute read
The NodeBase is the root of the node hierarchy. It is an abstract node and cannot be included directly in a script. All its fields are inherited from descending nodes.
These fields are involved in defining recording session behavior.
Platform support
This node is fully supported on XR-Windows, XR-Portable Windows, XR-Portable iOS, XR-Portable Android, and XR-Portable WASM platforms.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
Full support |
Full support |
Full support |
Full support |
Full support |
|
|
|
|
|
|
Extra Params field
The extraParams field can extend the set of information related to a node by using a dictionary.
The dictionary can be populated in two ways.
-
By MWX-related fields.
-
By code-defined fields.
|
Option |
Description |
|---|---|
|
Populated by MWX-related fields |
The fields from the exported MWX always have a mwx_ prefix and are reloaded/refreshed when loading the MWX during scene loading. For this reason, these parameters should be read from code. |
|
Populated by code-defined fields |
The fields can be added to the DSTRING dictionary both at node definition and at runtime through scripting. These fields can be read/write at any time. |
NodeBase fields
These are the fields for NodeBase node.
|
Fields |
Type |
Use |
Default value |
Description |
|---|---|---|---|---|
|
extraParams |
DSTRING |
Optional |
Not set |
This parameter can store a set of key value couples to customize/decorate a node. Parameters in the dictionary can be both retrieved from MWX content or be set by code scripting or XR Studio setting. |
|
name |
SSTRING |
Optional |
Name is used to identify a node. It must be unique. If not set, the name is autogenerated by the system when instancing the node. |
|
|
nodeInfo |
SSTRING |
Optional |
Not set |
Stores a description for the node. |
|
nodeType |
SSTRING |
Internally calculated |
Node type name |
Returns the type of the node. |
|
templateInfo |
SSTRING |
Read only |
Not set |
Contains the template name in case the node has been instantiated from an XR Studio template. |