Function Overlay: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{learned|what the function highlight overlay is|what information the function highlight overlay displays|how to configure the function highlight overlay}}
[[File:Editor_overlay_functionhighlight.jpg|thumb|300px|left|Active function overlay, named "Nature Highlight", configured to highlight green and garden [[function]]s.]]
 
The [[Function Overlay]] is an [[overlay]] which is used for indicating where [[building]]s of certain functions exist. When added to a project, it can be activated by selecting the corresponding icon on the [[navigation panel]]. When activated, it displays 2 colors. One color indicates where the specified buildings exist, the other color is used for all other areas.
==What is the function highlight overlay==
 
[[File:Editor_overlay_functionhighlight.jpg|thumb|300px|left|Active function highlight overlay, named "Nature Highlight", configured to highlight green and garden functions.]]
The function highlight overlay is an overlay which is used for indicating where constructions of certain functions exist. When added to a project, it can be activated by selecting the corresponding icon on the minimap. When activated, it displays 2 colors. One color indicates where the specified constructions exist, the other color is used for all other areas.


===Function Color===
===Function Color===
This color indicates constructions of (one of) the specified function(s).
This color indicates buildings of (one of) the specified function(s).


===Background Color===
===Background Color===
This color indicates all areas where no construction of the specified function(s) exist. This can be because there is no construction, or a construction of a different function, in that location.
This color indicates all areas where no building of the specified function(s) exist. This can be because there is no building, or a building of a different function, in that location.
<br clear=all>
<br clear=all>


==Configuring the overlay==
==Configuring the overlay==
[[File:Overlays-right-functionhighlight.jpg|framed|left|The [[Right Panel]] when a function highlight overlay is selected.]]
[[File:Overlays-right-functionhighlight.jpg|framed|left|The [[Right Panel]] when a [[Function Overlay]] is selected.]]
By default, the overlay does not display any relevant information. The properties of this overlay must be configured first, most notably the list of functions to highlight.
By default, the overlay does not display any relevant information. The properties of this overlay must be configured first, most notably the list of functions to highlight.


====Name====
====Name====
[[File:Overlays-right-functionhighlight-name.jpg|frame|right|The field for the "name".]]
[[File:Overlays-right-functionhighlight-name.jpg|frame|right|The field for the "name".]]
: ''The name of the overlay. This is the name that will appear as the title overlay, when hovering over the related icon in the minimap. It is also the text in the [[Game Interface#Legend|legend]] of the overlay as description for the "Function Color". You can change this by altering the text in the "Name" field.''<br clear=right>
: ''The name of the overlay. This is the name that will appear as the title overlay, when hovering over the related icon on the [[navigation panel]]. It is also the text in the [[Overlay legend panel]] of the overlay as description for the "Function Color". You can change this by altering the text in the "Name" field.''<br clear=right>


====Function and Background Color====
====Function and Background Color====
[[File:Overlays-right-functionhighlight-color.jpg|frame|right|The fields for the "Function Color" and "Background Color".]]
[[File:Overlays-right-functionhighlight-color.jpg|frame|right|The fields for the "Function Color" and "Background Color".]]
: ''The colors of the overlay. The "Function Color" is the color used to indicate the constructions with the specified functions in the 3D world. The "Background Color" is the color used to color all other areas. You can change this selecting the color field. A panel will appear in which you can specify the desired color.''<br clear=right>
: ''The colors of the overlay. The "Function Color" is the color used to indicate the buildings with the specified functions in the [[3D Visualization]]. The "Background Color" is the color used to color all other areas. You can change this selecting the color field. A panel will appear in which you can specify the desired color.''<br clear=right>


====Functions====
====Functions====
[[File:Overlays-right-functionhighlight-list.jpg|frame|right|The list of functions which the overlay should highlight.]]
[[File:Overlays-right-functionhighlight-list.jpg|frame|right|The list of functions which the overlay should highlight.]]
: ''The functions which this overlay should highlight. Any function not in this list is not highlighted by the overlay. To add a function to the list, select "Add", and select the desired function in the function selection window. To remove a function from the list, select the function you wish to remove from the list, and select "Remove".''<br clear=right>
: ''The functions which this overlay should highlight. Any function not in this list is not highlighted by the overlay. To add a function to the list, select "Add", and select the desired function in the function selection window. To remove a function from the list, select the function you wish to remove from the list, and select "Remove".''<br clear=right>
==Adding and removing a Terrain overlay==
==How-to's==
{{Editor ribbon|header=3D World|bar=Overlays}}
* [[How to add and remove an Overlay]]
 
* [[How to edit an overlay legend|Edit an overlay legend]]
{{Editor steps|title=add a Function Highlight overlay|Select in the editor '3D World' from the ribbon|Select 'Overlays' > 'Edit overlays' from the ribbon bar|Select the Function Highlight overlay from the drop down menu on the bottom of the left panel|Select 'Add' from the bottom of the left panel|Select and configure available Function Highlights on the right panel, to be added to the overlay|The overlay icon will now appear under the mini map}}
 
<gallery>
File:Select3DWorld.jpg|1. Select 3D World
File:SelectEditOverlay.jpg|2. Select Overlays > Edit overlays
File:SelectDropDown.jpg|3. Select Function Highlight overlay from drop down menu on the bottom of the left panel
File:SelectAddOverlay.jpg|4. Select 'Add' from the bottom of the left panel
File:OverlayParameters.jpg|5. Select and configure available terrains on the right panel
File:OverlayIconPresent.jpg|6. The overlay icon will  now appear under the mini map
</gallery>
 
{{Editor steps|title=remove an overlay|Select in the editor '3D World' from the ribbon|Select 'Overlays' > 'Edit overlays' from the ribbon bar|Select the desired overlay from the list of active overlays on the left panel|Select 'remove' from the bottom of the left panel|Confirm the removal in the pop up confirmation message}}
 
<gallery>
File:Select3DWorld.jpg|1. Select 3D World
File:SelectEditOverlay.jpg|2. Select Overlays > Edit overlays
File:SelectOverlay.jpg|3. Select desired overlay from the list of active overlays on the left panel
File:SelectRemoveOverlay.jpg|4. Select 'Remove' from the bottom of the left panel
File:ConfirmRemovalOverlay.jpg|5. Confirm the removal in the pop up confirmation message
</gallery>


''Sometimes it can be convenient to duplicate an already existing overlay. To do so, follow the steps for removal, but select 'Duplicate' in stead of 'Remove'.''
{{Template:Overlay nav}}

Latest revision as of 09:34, 28 September 2023

Active function overlay, named "Nature Highlight", configured to highlight green and garden functions.

The Function Overlay is an overlay which is used for indicating where buildings of certain functions exist. When added to a project, it can be activated by selecting the corresponding icon on the navigation panel. When activated, it displays 2 colors. One color indicates where the specified buildings exist, the other color is used for all other areas.

Function Color

This color indicates buildings of (one of) the specified function(s).

Background Color

This color indicates all areas where no building of the specified function(s) exist. This can be because there is no building, or a building of a different function, in that location.

Configuring the overlay

The Right Panel when a Function Overlay is selected.

By default, the overlay does not display any relevant information. The properties of this overlay must be configured first, most notably the list of functions to highlight.

Name

The field for the "name".
The name of the overlay. This is the name that will appear as the title overlay, when hovering over the related icon on the navigation panel. It is also the text in the Overlay legend panel of the overlay as description for the "Function Color". You can change this by altering the text in the "Name" field.

Function and Background Color

The fields for the "Function Color" and "Background Color".
The colors of the overlay. The "Function Color" is the color used to indicate the buildings with the specified functions in the 3D Visualization. The "Background Color" is the color used to color all other areas. You can change this selecting the color field. A panel will appear in which you can specify the desired color.

Functions

The list of functions which the overlay should highlight.
The functions which this overlay should highlight. Any function not in this list is not highlighted by the overlay. To add a function to the list, select "Add", and select the desired function in the function selection window. To remove a function from the list, select the function you wish to remove from the list, and select "Remove".

How-to's