Prefab Sign Data
This structure stores all data that defines what a sign displays.
Properties
auxiliary : Struct<Color>
The auxiliary Color.
Details
| Flags | RuntimeSync RuntimeParallel |
|---|---|
Display Name |
Auxiliary |
background : Struct<Color>
The background Color.
Details
| Flags | RuntimeSync RuntimeParallel |
|---|---|
Display Name |
Background |
emissive : Float
The emissiveness of the sign.
Details
| Flags | RuntimeSync RuntimeParallel |
|---|---|
Display Name |
Emissive |
foreground : Struct<Color>
The foreground Color.
Details
| Flags | RuntimeSync RuntimeParallel |
|---|---|
Display Name |
Foreground |
layout : Class<Object>
The object that actually displayes the layout
Details
| Flags | RuntimeSync RuntimeParallel |
|---|---|
Display Name |
Layout |
signType : Class<SignType>
The type of sign this prefab fits to.
Details
| Flags | RuntimeSync RuntimeParallel |
|---|---|
Display Name |
Sign Type |
Functions
getIconElement (elementName : String) → value : Int
Gets a icon element with the given element name.
Details
Flags |
RuntimeSync RuntimeParallel MemberFunc |
Display Name |
Get Icon Element |
| Name | Type | Description |
|---|---|---|
Element Name |
String |
The name of the icon element |
| Name | Type | Description |
|---|---|---|
Value |
Int |
The value of the icon element |
getIconElements () → (iconElements : Array<String>, iconElementValues : Array<Int>)
Returns all icon elements and their values.
Details
Flags |
RuntimeSync RuntimeParallel MemberFunc |
Display Name |
Get Icon Elements |
| Name | Type | Description |
|---|---|---|
Icon Elements |
Array<String> |
The element names for all icon elements. |
Icon Element Values |
Array<Int> |
The values for all icon elements. |
getTextElement (elementName : String) → value : Int
Gets a text element with the given element name.
Details
Flags |
RuntimeSync RuntimeParallel MemberFunc |
Display Name |
Get Text Element |
| Name | Type | Description |
|---|---|---|
Element Name |
String |
The name of the text element |
| Name | Type | Description |
|---|---|---|
Value |
Int |
The value of the text element |
getTextElements () → (textElements : Array<String>, textElementValues : Array<String>)
Returns all text elements and their values.
Details
Flags |
RuntimeSync RuntimeParallel MemberFunc |
Display Name |
Get Text Elements |
| Name | Type | Description |
|---|---|---|
Text Elements |
Array<String> |
The element names for all text elements. |
Text Element Values |
Array<String> |
The values for all text elements. |
setIconElement (elementName : String, value : Int)
Sets a icon element with the given element name.
Details
Flags |
RuntimeSync RuntimeParallel MemberFunc |
Display Name |
Set Icon Element |
| Name | Type | Description |
|---|---|---|
Element Name |
String |
The name of the icon element |
Value |
Int |
The value of the icon element |
setIconElements (iconElements : Array<String>, iconElementValues : Array<Int>)
Sets all icon elements and their values.
Details
Flags |
RuntimeSync RuntimeParallel MemberFunc |
Display Name |
Set Icon Elements |
| Name | Type | Description |
|---|---|---|
Icon Elements |
Array<String> |
The element names for all icon elements. |
Icon Element Values |
Array<Int> |
The values for all icon elements. |
setTextElement (elementName : String, value : String)
Sets a text element with the given element name.
Details
Flags |
RuntimeSync RuntimeParallel MemberFunc |
Display Name |
Set Text Element |
| Name | Type | Description |
|---|---|---|
Element Name |
String |
The name of the text element |
Value |
String |
The value of the text element |
setTextElements (textElements : Array<String>, textElementValues : Array<String>)
Sets all text elements and their values.
Details
Flags |
RuntimeSync RuntimeParallel MemberFunc |
Display Name |
Set Text Elements |
| Name | Type | Description |
|---|---|---|
Text Elements |
Array<String> |
The element names for all text elements. |
Text Element Values |
Array<String> |
The values for all text elements. |