Sign Type

Parent

Object

Describes the type of a sign.

Properties

dimensions : Struct<Vector2D>

The canvas dimensions of this sign.

Details
Flags ReadOnly RuntimeSync RuntimeParallel ClassProp

Display Name

Dimensions

Functions

getColors () → (foreground : Struct<Color>, background : Struct<Color>, auxiliary : Struct<Color>)

Returns the default foreground/background/auxiliary colors of this sign type.

Details

Flags

RuntimeSync RuntimeParallel ClassFunc

Display Name

Get Colors
Return Values
Name Type Description

Foreground foreground

Struct<Color>

The foreground color

Background background

Struct<Color>

The background color

Auxiliary auxiliary

Struct<Color>

The auxiliary color

getIconElements () → iconElementsDefaultValues : Array<Object<Object>>

Returns a list of element names and their default icon values.

Details

Flags

RuntimeSync RuntimeParallel ClassFunc

Display Name

Get Icon Elements
Return Values
Name Type Description

Icon Elements Default Values iconElementsDefaultValues

Array<Object<Object>>

A list of default values for the icon elements of this type.

getPrefabs () → prefabs : Array<Class<SignPrefab>>

Returns a list of all sign prefabs this sign can use.

Details

Flags

RuntimeSync RuntimeParallel ClassFunc

Display Name

Get Prefabs
Return Values
Name Type Description

Prefabs prefabs

Array<Class<SignPrefab>>

The sign prefabs this sign can use

getTextElements () → textElementsDefaultValues : Array<String>

Returns a list of element names and their default text values.

Details

Flags

RuntimeSync RuntimeParallel ClassFunc

Display Name

Get Text Elements
Return Values
Name Type Description

Text Elements Default Values textElementsDefaultValues

Array<String>

A list of default values for the text elements of this type.