This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
Content Creation
Content Optimization
Materials
Art Samples
Tutorials

ComponentVariable Class

Header: #include <UnigineComponentSystem.h>

A component parameter is created using any of the following macros. Each macro has the format as indicated in the brackets with the mandatory arguments in bold:

  • PROP_PARAM(type, name, default_value (for all parameters except curves and properties), items (for switch parameters only), title, tooltip, group)
  • PROP_STRUCT(type, name, title, tooltip, group)
  • PROP_ARRAY(type, name, title, tooltip, group)
  • PROP_ARRAY_STRUCT(struct_type, name, title, tooltip, group)

Using the methods of this class, you can address each parameter.

ComponentVariable Class

Members


const PropertyParameterPtr & getParameter ( ) const#

Returns the pointer to the corresponding property parameter.

Return value

Pointer to the property parameter.

int size ( ) #

Returns the number of elements in the array.
Notice
This method is for the array and array structure component parameters.

Return value

Number of elements in the array.

C & operator[] ( int index ) #

Returns the reference to the requested element.
Notice
This method is for the array and array structure component parameters.

Arguments

  • int index - Position of the element to return.

Return value

Reference to the requested element.
Last update: 2021-10-25
Build: ()