Warning
The scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScipt (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.
Warning
The functionality described in this article is not available in the Community SDK edition.
You should upgrade to- Sim
SDK edition to use it.
You should upgrade to
CigiSymbolShortControl Class
Members
int getSymbolID ( ) #
Returns the Symbol ID specified in the packet. It specifies the symbol to which this packet shall be applied.Return value
Symbol ID parameter value.int getSymbolState ( ) #
Returns the Symbol State specified in the packet.Return value
Symbol State parameter value. The following values are supported:- 0 - Hidden.
- 1 - Visible.
- 2 - Destroyed.
int getAttachState ( ) #
Returns the value of the Attach State parameter specified in the packet. Determines whether the symbol will be attached as a child to a parent symbol.Return value
Attach State parameter value. 1 the symbol is attached as a child; otherwise, 0.int getFlashControl ( ) #
Returns the value of the Flash Control parameter specified in the packet. Defines whether the IG shall continue the symbol’s flash cycle from its present state or restart it from the beginning.Return value
Flash Control parameter value: 0 if Continue; otherwise, 1.int getInheritColor ( ) #
Returns the value of the Inherit Color parameter specified in the packet. Specifies whether this symbol inherits its color from the symbol to which it is attached.Return value
Inherit Color parameter value: 1 if the color is inherited; otherwise, 0.int getSelect1 ( ) #
Returns the value of the Attribute Select 1 parameter specified in the packet. Identifies the attribute whose value is returned by the getData1 function.Return value
Select 1 parameter value. One of the CIGI_SYMBOL_* values.int getSelect2 ( ) #
Returns the value of the Attribute Select 2 parameter specified in the packet. Identifies the attribute whose value is returned by the getData2 function.Return value
Select 2 parameter value. One of the CIGI_SYMBOL_* values.int getData1 ( ) #
Returns the value of the Attribute Value 1 parameter specified in the packet. Specifies the value of the attribute identified by the getAttribute1 function.Return value
Data 1 parameter value.int getData2 ( ) #
Returns the value of the Attribute Value 2 parameter specified in the packet. Specifies the value of the attribute identified by the getAttribute2 function.Return value
Data 2 parameter value.Last update:
2020-07-31
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)