Open Dev Kit Documentation :: General :: API Node
Root.APINodeNode in the API hierarchy
Functions
- Constructor ( )
- Copy ( Other API Node )
- Equal ( Other API Node ) Boolean
- Get URI ( ) String
- Gets the Uniform Resource Identifier (URI)
- Find Child ( Names String Array, Inherited Boolean ) API Node*
- Finds a child node
- Is A ( Type API Node* ) Boolean
- Checks if the node is of a specified type
- Is Either ( Types API Node* Array ) Boolean
- Checks if the node is either of the specified types
- New ( ) Abstract*
- Creates a new instance of this class
- Call ( Parameters Stream, This Abstract* )
- Executes this function
- Call Bool ( Parameters Stream, This Abstract* ) Boolean
- Executes this function and returns a bool
- Call Array String ( Parameters Stream, This Abstract* ) String Array
- Executes this function and returns a String array
- Call User Variant ( Parameters Stream, This Abstract* ) Variant
- Executes this user-function and returns the value
- Get Property Path ( Property API Node* Array ) String Array
- Gets the property path
- Check Errors ( ) String Array
- Returns list of errors and sets error level
- Get Default Constructor ( Arguments Integer ) API Node*
- Gets the default constructor
- Get Longest Constructor ( ) API Node*
- Gets the longest constructor
- Get Concrete Icon ( Allow Node Type Icon Boolean ) Image*
- Retrieves the concrete icon
- Can Convert Constant String ( Values String ) Boolean
- Returns true when the string can be converted to this enum/flags
- Convert Constant String ( Values String ) Integer
- Returns the value of the string converted to this enum/flags
- Get Enum Constants Aliases ( Enumeration API Node* ) String Array
- Returns aliases of constants within enum/flags
Properties
- Node Type API Node Type
- type of the API node
- Name String
- name of the API node
- Flags API Node Flags
- flags associated with the API node
- Network Flags API Node Network Flags
- flags related to network behavior
- Editor Flags API Node Editor Flags
- flags related to the editor
- Type API Node'
- data type of the API node
- Return Type API Node'
- return type of the API node
- Base Type API Node'
- base type of the API node
- Parent API Node'
- parent node of the API node
- Default String
- default value of the node
- Default Object Variant
- default object associated with the API node
- Children API Node* Array
- children nodes of the API node
- Next API Node*
- next sibling node
- Previous API Node*
- previous sibling node
- Override Destination API Node*
- node that is overriden by this node if flagged
- Alias String
- what will be displayed in place of an API node's 'Name'. If this value is empty, 'Name' will be used instead
- Method Alias String
- what will be displayed in place of an API node's 'Name' when used as a function. If this value is empty, 'Name' will be used instead
- Section String
- section where the API node belongs
- Category String
- category of the API node
- Description String
- description of the API node
- Method Description String
- description specifically when used as a function
- Tick Call Interval Float
- time between tick calls
- Network Function ID Short
- ID of the network function associated with the API node
- Icon Image*
- icon for the the API node
- Visibility API Node Visibility
- visibility of the API node
- Difficulty Difficulty
- difficulty level for the API node
- Clone Source API Node'
- reference to what was cloned from (Source) for the purposes of the script editor's experience
- Clone Destination API Node'
- reference to what was cloned to (Destination) for the purposes of the script editor's experience
- Concrete Virtual API Node'
- root virtual node of this node; or itself if node was not spawned
- Spawn Function API Node*
- function used for spawning
- Branches Script Script*
- script responsible for controlling branches dynamically. The number of branches can be altered based on the arguments passed to the function if it's directly added to a script
- Getter Script Script*
- optional script that determines how the property retrieves its value. It allows to customize the behavior of the property when it's being accessed
- Setter Script Script*
- optional script that determines how this property behaves when its value is being set. It allows to customize the behavior of the property when it's being modified
- Enumeration Script Script*
- script for enumerations
- Function Script Script*
- script for functions
- Generated Functions API Node' Array
- functions that were generated from this node; index is based on generated flag constant index
- Scope Index Integer
- index of default object array when represented as a child of the node
- Is String Boolean
- true if the type is a string
- Is Enum Int Boolean
- true if the type is an integer enum
- Is Integer Boolean
- true if the type is an integer
- Is Float Boolean
- true if the type is a floating point
- Is Intrinsic Boolean
- true if the type is intrinsic; however, String/LocalizedString will return false because they are passed into functions by reference
- Is Class Boolean
- true if the type is class without struct flag
- Is Structure Boolean
- true if the type is class with struct flag
- Is Property Object Variant Typed Boolean
- true if the type is a property object variant typed
- Is Data Member Boolean
- true if the type is a data member
- Has Instance Parameter Boolean
- true if the type has instance parameter
- Has Data Member Boolean
- true if the type has data member
- Plugin Namespace API Node*
- namespace of the plugin
- Plugin Identifier String
- identifier of the plugin
- Concrete Alias String
- concrete alias of the property
- Concrete M Alias String
- method alias of the concrete property
- Concrete Description String
- description of the concrete property
- Concrete M Description String
- method description of the concrete property
- Concrete M Description Verbose String
- verbose method description of the concrete property
- Concrete Section String
- section of the concrete property
- Concrete Category String
- category of the concrete property
- Concrete Difficulty Difficulty
- difficulty level of the concrete property
- Concrete Type Chain API Node* Array
- type inheritance chain without producing cycles
- Constant Value Integer
- integer representation of enum/flags' constant
- Constant Index Integer
- index of constant within enum/flags
If you think anything is missing, please feel free to: submit documentation feedback on this page