Eden Editor: Marker: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Removed from main category, it's present in a sub category already)
m (Text replacement - "Position3D" to "Position3D")
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<div style="width:640px; margin: 0 auto 0 auto;">
{{TOC|side}}
A marker is an image shown on the player's map. It is visible by each player, and it is visible only on the map, not in the scene.
A marker is an image shown on the player's map. It is visible to every player, and it is visible only on the map, not in the scene.
 


== Icon Markers ==
A marker can be an '''icon'''. It is a single image which has a constant size on the screen when zooming the map in and out. When you set its text, it will be shown on its right side. It is used to mark points of interest, like an enemy base or an insertion point.
A marker can be an '''icon'''. It is a single image which has a constant size on the screen when zooming the map in and out. When you set its text, it will be shown on its right side. It is used to mark points of interest, like an enemy base or an insertion point.
[[File:3den marker icon.jpg|center]]
[[File:3den marker icon.jpg|center]]


 
== Area Markers ==
Markers can also be '''areas'''. Their size is set in meters and is constant in the world space. They are used for marking specific zones, such as an enemy area or border line.
Markers can also be '''areas'''. Their size is set in meters and is constant in the world space. They are used for marking specific zones, such as an enemy area or border line.
Similarly to trigger areas, the marker area can also be edited using area scaling widget.
Similarly to trigger areas, the marker area can also be edited using the [[Eden_Editor:_Transformation_Widget|area scaling widget]]. <!-- TODO: Link that to the correct subsection of the widget page! -->
 


The area is always shown, but by default you cannot interact with it. However, when the marker is selected, you can drag it by its area as well.  
The area is always shown, but by default you cannot interact with it. However, when the marker is selected, you can drag it by its area as well.  
Line 16: Line 15:


Markers are a powerful tool for explaining your intentions to the player with little or no text. Do not forget to use them while designing your scenario.
Markers are a powerful tool for explaining your intentions to the player with little or no text. Do not forget to use them while designing your scenario.
</div>


== Attributes ==
== Attributes ==
Line 23: Line 21:
{| class="wikitable sortable"
{| class="wikitable sortable"
! colspan="3" | <big>Info</big>
! colspan="3" | <big>Info</big>
! colspan="2" | <big>[[Eden Editor: Setting Attributes|Development]]</big>
! colspan="3" | <big>[[Eden Editor: Setting Attributes|Development]]</big>
|-
|-
! Name
! Name
Line 30: Line 28:
! Property
! Property
! Type
! Type
! Correspondence
|-
|-
| '''Type'''
| '''Type'''
| Type
| Type
| Icon texture.
| Icon texture.
| <small><tt>itemClass</tt></small>
| <small>{{hl|itemClass}}</small>
| [[String]]
| [[String]]
| [[markerType]]
|-
|-
| '''Variable Name'''
| '''Variable Name'''
| Init
| Init
| Unique system name. Can contain any characters. The name is not case sensitive, so 'someName' and 'SOMENAME' are treated as the same variables.
| Unique system name. Can contain any characters. The name is not case sensitive, so 'someName' and 'SOMENAME' are treated as the same variables.
| <small><tt>markerName</tt></small>
| <small>{{hl|markerName}}</small>
| [[String]]
| [[String]]
| [[createMarker]]
|-
|-
| '''Text'''
| '''Text'''
| Init
| Init
| Text displayed right from the marker.
| Text displayed right from the marker.
| <small><tt>text</tt></small>
| <small>{{hl|text}}</small>
| [[String]]
| [[String]]
| [[markerText]]
|-
|-
| '''Position'''
| '''Position'''
| Transformation
| Transformation
| World coordinates in meters. X goes from West to East and Y from South to North.
| World coordinates in meters. X goes from West to East and Y from South to North.
| <small><tt>position</tt></small>
| <small>{{hl|position}}</small>
| [[Position3D]]
| [[Position#Introduction|Position3D]]
| [[markerPos]]
|-
|-
| '''Size'''
| '''Size'''
| Transformation
| Transformation
| Area size in meters.
| Marker A and B size.
| <small><tt>size2</tt></small>
| <small>{{hl|size2}}</small>
| [[Array]]
| [[Array]]
| [[markerSize]]
|-
|-
| '''Rotation'''
| '''Rotation'''
| Transformation
| Transformation
| Local rotation in degrees. X is pitch, Y is roll and Z is yaw.
| Rotation in degrees.
| <small><tt>rotation</tt></small>
| <small>{{hl|rotation}}</small>
| [[Number]]
| [[Number]]
| [[markerDir]]
|-
|-
| '''Shape'''
| '''Shape'''
| Style
| Style
| Area shape.
| Marker shape. The marker has to be created as shape marker, for this use "" empty string as class name with [[create3DENEntity]], this will create rectangular marker.
Available options:
Available options:
* '''Rectangle'''
* 0 - rectangle
* '''Ellipse'''
* 1 - ellipse


| <small><tt>markerType</tt></small>
| <small>{{hl|markerType}}</small>
| [[String]]
| [[Number]]
| [[markerShape]]
|-
|-
| '''Brush'''
| '''Brush'''
| Style
| Style
| Area fill texture.
| Area fill texture.
| <small><tt>brush</tt></small>
| <small>{{hl|brush}}</small>
| [[String]]
| [[String]]
| [[markerBrush]]
|-
|-
| '''Color'''
| '''Color'''
| Style
| Style
| Marker color. 'Default' is based on the selected marker type.
| Marker color. 'Default' is based on the selected marker type.
| <small><tt>baseColor</tt></small>
| <small>{{hl|baseColor}}</small>
| [[Array]]
| [[Array]]
| [[markerColor]]
|-
|-
| '''Alpha'''
| '''Alpha'''
| Style
| Style
| Transparency. When the icon marker has a shadow, it will be visible behind the transparent icon.
| Transparency. When the icon marker has a shadow, it will be visible behind the transparent icon.
| <small><tt>alpha</tt></small>
| <small>{{hl|alpha}}</small>
| [[Number]]
| [[Number]]
| [[markerAlpha]]
|}
|}
</onlyinclude>
</onlyinclude>


[[Category:Eden Editor: Asset Types|Markers]]
[[Category:Eden Editor: Asset Types|Markers]]

Latest revision as of 16:54, 5 January 2022

A marker is an image shown on the player's map. It is visible to every player, and it is visible only on the map, not in the scene.

Icon Markers

A marker can be an icon. It is a single image which has a constant size on the screen when zooming the map in and out. When you set its text, it will be shown on its right side. It is used to mark points of interest, like an enemy base or an insertion point.

3den marker icon.jpg

Area Markers

Markers can also be areas. Their size is set in meters and is constant in the world space. They are used for marking specific zones, such as an enemy area or border line. Similarly to trigger areas, the marker area can also be edited using the area scaling widget.

The area is always shown, but by default you cannot interact with it. However, when the marker is selected, you can drag it by its area as well.

3den marker area.gif


Markers are a powerful tool for explaining your intentions to the player with little or no text. Do not forget to use them while designing your scenario.

Attributes

Info Development
Name Category Description Property Type Correspondence
Type Type Icon texture. itemClass String markerType
Variable Name Init Unique system name. Can contain any characters. The name is not case sensitive, so 'someName' and 'SOMENAME' are treated as the same variables. markerName String createMarker
Text Init Text displayed right from the marker. text String markerText
Position Transformation World coordinates in meters. X goes from West to East and Y from South to North. position Position3D markerPos
Size Transformation Marker A and B size. size2 Array markerSize
Rotation Transformation Rotation in degrees. rotation Number markerDir
Shape Style Marker shape. The marker has to be created as shape marker, for this use "" empty string as class name with create3DENEntity, this will create rectangular marker.

Available options:

  • 0 - rectangle
  • 1 - ellipse
 markerType Number markerShape
Brush Style Area fill texture. brush String markerBrush
Color Style Marker color. 'Default' is based on the selected marker type. baseColor Array markerColor
Alpha Style Transparency. When the icon marker has a shadow, it will be visible behind the transparent icon. alpha Number markerAlpha
Retrieved from "https://community.bistudio.com/wiki?title=Eden_Editor:_Marker&oldid=296748"