Open Dev Kit Documentation :: General
Root
Types
- Boolean
- Binary boolean (true/false)
- Byte
- Byte whole number (0 to 255)
- Short
- Short whole number (-32768 to +32767)
- Integer
- Whole number (-2147483648 to +2147483647)
- Enum Int
- Enumerated list of integer values
- Long
- Long whole number (-9223372036854775808 to +9223372036854775807)
- Float
- Floating-point decimal number
- Double
- Double precision floating-point decimal number
- String
- Text formed from several characters (UTF-8)
- Localized String
- Text that can be localized
- Abstract
Classes
- API Node
- Node in the API hierarchy
- 2D Vector
- Two-dimensional vector. Consists of an X component and a Y component and can be used to represent positions or directions in 2D space
- 3D Vector
- Three-dimensional vector. Consists of an X component, Y component and a Z component and can be used to represent positions or directions in 3D space
- 4D Vector (Quaternion)
- Four-dimensional vector. Consists of an X, Y, Z and W component. Typically used in computer graphics and mathematics to represent positions, directions, or color values.
- Matrix 4x 4
- Four-by-four matrix. Used for transformations in 3D space
- Rectangle
- Rectangle in 2D space
- Rectangle (Integer)
- Rectangle in 2D space with integer co-ordinates and dimensions
- Matrix Projection Info
- Projection information used in matrix transformations
- Box
- Three-dimensional box defined by its position and dimensions
- Color
- Color in RGBA format
- Color HDR
- High Dynamic Range (HDR) color
- Time
- Representation of a point in time
- Variant Dictionary
- Bool Dictionary
- Int Dictionary
- Float Dictionary
- String Dictionary
- Pointer Dictionary
- Weak Pointer Dictionary
- Variant
- Stream Memory
- Stream File
- Stream Variants
- Callback
- Control for callback functions
- Log
- Provides functionality for logging
- Array
- List of entry items
- Timer
- Control for timer objects, used for tracking time intervals and executing events
- Filesystem
- Provides functions for interacting with the filesystem
- Text
- Math
- Collection of various mathematical operations for calculations and manipulations
- Cursor
- Control for cursor objects
- Script Evaluation
- Control for evaluating scripts
- Structure
- Structure-related functionalities used for comparisons
- Resource
- Control for project resources
- Stylesheet
- Control for stylesheets
- Object Resource
- Abstract resource for structured objects
- Image Parameters
- Parameters for image manipulation
- Image
- Image resource with properties
- Font Parameters
- Defines parameters for font formatting
- Model
- 3D model resource with auxiliary paths and images
- Audio
- Audio resource with various properties
- Raw
- Raw data represented as a resource
- RF Null
- Special format to indicate no format
- RF Internal
- Resource stored purely in the class' object; used by ObjectResource only
- Editor Toolbar Tool
- Tool in the editor toolbar
- Config
- Root Config
- Root configuration class
- System Log Options
- Various options for system logging and debugging settings
- System Info
- Various system-related properties and functions for managing system behavior and information
Enumerations
- Difficulty
- Levels of familiarity or expertise with Open Dev Kit
- API Node Type
- Types of API nodes
- API Node Flags
- API Node options
- API Node Network Flags
- Options for the Network API Node
- API Node Generated Flags
- Options for the Generated API Node
- API Node Editor Flags
- Options for the API Node Editor
- API Node Visibility
- Visibility options for the API Node
- Axes
- Axes in 3D space
- Standard Orientation
- Standard orientations in 3D space
- Script Language
- Script languages
- Direction 4
- 4 cardinal directions
- Mouse Button
- Mouse buttons
- Keyboard Key
- Keyboard keys
- Array Sort Method
- Different methods for sorting arrays
- Standard Transition Curve
- Standard transition curves. Typically used for animations
- Standard Repeating Method
- Standard repeating methods. Typically used for animations
- Resource Format Status
- Status of a resource format operation
- Property Aspect
- Aspects of a property
- Object Resource Move Action
- Actions for moving object resources
- Blending Mode
- Branding Type
- Different types of Open Dev Kit branding
- Branding Label
- Different branding labels
- Branding Alignment
- Different branding alignments
- Build Optimization
Functions
- Comment ( )
- A piece of text that won't be treated as code
- Quit Application ( )
- Closes the application completely
- Crash Application ( )
- Crashes the application for the purposes of testing bug reports
- Return Value ( Value Variant )
- Returns the specified value
- Delay ( Time Time )
- Pauses a script for a set amount of time
- Sub Script ( )
- Reduce clutter by grouping other script nodes
- Repeat Loop ( Number of Times Integer )
- Repeats the script inside for a set amount of times
- Array Loop ( Variable Variant, Array Variant )
- Repeats the script inside for each element in the specified array
- Reverse Array Loop ( Variable Variant, Array Variant )
- Repeats the script inside for each element in the specified array backwards
- Numeric Loop ( Variable Variant, Starting Number Variant, Ending Number Variant, Increment/Decrement Amount Variant )
- Repeats the script inside for a specified range
- Infinite Loop ( )
- Continuously loop until Break action is called
- Do While Loop ( Condition Boolean )
- Continuously loop until condition returns false
- Do Until Loop ( Condition Boolean )
- Continuously loop until condition returns true
- Break Loop ( )
- Used to exit out of a loop
- Switch Branch ( Expression Variant, Values String Array )
- Compares the expression to different values
- Difference Branch ( Value 1 Variant, Value 2 Variant, Difference Variant )
- Checks to see if two values are within the set difference
- Range Branch ( Expression Variant, Minimum Variant, Maximum Variant )
- Checks to see if the expression is between the minimum and maximum values
Properties
- Null Abstract*
- Cursors Cursor Array
- list of cursor objects
- Plugins Plugin* Array
- list of plugins
If you think anything is missing, please feel free to: submit documentation feedback on this page