Eden Editor: Waypoint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "Position3D" to "Position3D")
 
(19 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{TOC|side}}
A waypoint defines the destination for a group. Waypoints are ordered sequentially, and only one can be active at any given time.
== Waypoint Types ==
Each waypoint has a specific type, which decides what the group has to do to complete the waypoint. A group led by an AI character will pursue the waypoint automatically, but the player is expected to issue necessary orders when in charge of the group.
You can use any type of waypoint from the '''Waypoints''' list in the asset browser. Because waypoints are added to groups, the existing character, group or any of its waypoints has to be selected in order for new waypoint to be added.
[[File:3den waypoint add.gif|center]]
=== MOVE Waypoint Shortcut ===
Alternatively, you can quickly add a MOVE waypoint by '''holding Shift''' and pressing the '''right mouse button'''.
[[File:3den waypoint addQuick.gif|center]]
== Attaching Waypoints ==
A waypoint can also be attached to an object. Some waypoint types even require it, like DESTROY or GET IN.
To attach a waypoint, drag it to an object. Similarly, you can detach it by dragging it away. Moving the object around will move all the attached waypoints as well.
The attached waypoint is visualized by a different icon outline ([[File:3den waypoint outlineAttached.png.png]] instead of [[File:3den waypoint outline.png]]).
[[File:3den_waypoint_attach.gif|center]]
== Waypoint Completion ==
The waypoint is completed when requirements set by its type are met, but additional conditions can be added. A scripted condition can be set in attributes, but you can also connect the waypoint to one or more [[Eden Editor: Trigger|triggers]] using '''Set Waypoint Activation''' [[Eden Editor: Connecting|connection]]. The waypoint will be completed only once all the connected triggers are active.
[[File:3den waypoint trigger.gif|center]]
Once a waypoint is completed, the group will move to the next one. If there is none, the group will remain where it is.
You can find more about the waypoint in the tooltips of their attributes.
== Attributes ==
== Attributes ==
<onlyinclude>
<onlyinclude>
<!-- Exported from the game by BIS_fnc_3DENExportAttributes. Manual edits may be replaced by future exports. -->
{| class="wikitable sortable"
{| class="wikitable sortable"
! colspan="3" | Info
! colspan="3" | <big>Info</big>
! colspan="2" | [[Eden Editor: Setting Attributes|Development]]
! colspan="2" | <big>[[Eden Editor: Setting Attributes|Development]]</big>
|-
|-
! Name
! Name
! Category
! Category
! class="unsortable" | Description
! class="unsortable" | Description
! Class
! Property
! Control
! Type
|-
|-
| '''Type'''
| '''Type'''
| Waypoint Type
| Type
|  
| Waypoint type defines what the group will do when the waypoint becomes active, and the condition when it becomes completed. Applies mainly to AI-led groups, as players will not be prompted to perform any specific actions, even though the waypoint completion condition is the same.
| <tt>itemClass</tt>
Some waypoints have special attributes, which are only available the next time you access the attribute window.
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Type|Type]]</tt>
| <small>{{hl|itemClass}}</small>
|-
| [[String]]
| '''Variable Name'''
| Waypoint Init
|
| <tt>name</tt>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Edit|Edit]]</tt>
|-
|-
| '''Description'''
| '''Description'''
| Waypoint Init
| Init
|  
| Text visible for the player next to the waypoint icon in the scene.
| <tt>description</tt>
| <small>{{hl|description}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Edit|Edit]]</tt>
| [[String]]
|-
|-
| '''Order'''
| '''Order'''
| Waypoint Init
| Init
| Order in which waypoints follow. When changing order, the waypoint will take position of the selected one, pushing all other further down.
| <small>{{hl|order}}</small>
|  
|  
| <tt>order</tt>
|-
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Combo|Combo]]</tt>
| '''Identified'''
| Init
| System name of the waypoint, used for identification in scripts.
| <small>{{hl|name}}</small>
| [[String]]
|-
|-
| '''Position'''
| '''Position'''
| Waypoint Transformation
| Transformation
|  
| World coordinates in meters. X goes from West to East, Y from South to North and Z is height above terrain.
| <tt>position</tt>
| <small>{{hl|position}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditXYZ|EditXYZ]]</tt>
| [[Position#Introduction|Position3D]]
|-
| '''House Position'''
| Waypoint Transformation
|
| <tt>positionObject</tt>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Combo|Combo]]</tt>
|-
|-
| '''Placement Radius'''
| '''Placement Radius'''
| Waypoint Transformation
| Transformation
|  
| Placement radius in meters. The entity will start at a random position within the radius.
| <tt>placementRadius</tt>
| <small>{{hl|placementRadius}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditShort|EditShort]]</tt>
| [[Number]]
|-
|-
| '''Completion Radius'''
| '''Completion Radius'''
| Waypoint Transformation
| Transformation
|  
| Distance in meters in which a group member has to be in order for the waypoint to be considered completed.
| <tt>completionRadius</tt>
| <small>{{hl|completionRadius}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditShort|EditShort]]</tt>
| [[Number]]
|-
|-
| '''Combat Mode'''
| '''Combat Mode'''
| Waypoint States
| State
|  
| Controls how and when the group will choose to engage enemy targets.
| <tt>combatMode</tt>
Available options:
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#CombatModeWaypoint|CombatModeWaypoint]]</tt>
* '''Unchanged''' - No change compared to the previous state.
* '''Forced Hold Fire''' - The group will never fire under any circumstances.
* '''Do Not Fire Unless Fired Upon, Keep Formation''' - Group members will hold fire unless directly threatened.
* '''Do Not Fire Unless Fired Upon''' - Group members will move into positions from which they can shoot at the enemy, but will hold fire unless directly threatened.
* '''Open Fire, Keep Formation''' - Default combat mode. Group members will fire upon any target in range, while staying in formation. The group leader may order individual members to engage specific targets.
* '''Open Fire''' - Group members will fire at any suitable target in range, leaving the formation to find a suitable shooting position.
 
| <small>{{hl|combatMode}}</small>
| [[String]]
|-
|-
| '''Behaviour'''
| '''Behavior'''
| Waypoint States
| State
|  
| Behavior pattern of the group.
| <tt>behaviour</tt>
Available options:
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#BehaviourWaypoint|BehaviourWaypoint]]</tt>
* '''Unchanged''' - No change compared to the previous state.
* '''Careless''' - The same as 'Safe', except that it will not be switched automatically after spotting a threat. Use with caution, player may perceive AIs in this behavior as defective.
* '''Safe''' - Non-combat behavior. Characters have weapons lowered. Vehicles follow roads and use lights. They automatically switch to 'Aware' upon spotting a threat.
* '''Aware''' - Default behavior. Characters are in ready position. Vehicles prefer roads, do not use lights and their passengers will disembark to counter threats.
* '''Combat''' - Firefight behavior. Characters break formation and take cover. Vehicles ignore roads and do not use lights.
* '''Stealth''' - Characters break formation and move cautiously, preferring cover and going prone. Vehicles prefer roads, but do not use lights.
 
| <small>{{hl|behaviour}}</small>
| [[String]]
|-
|-
| '''Formation'''
| '''Formation'''
| Waypoint States
| State
|  
| Default group formation. Based on the combat mode, group members may ignore the formation in 'Combat' and 'Stealth' modes.
| <tt>formation</tt>
Available options:
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#FormationWaypoint|FormationWaypoint]]</tt>
* '''Unchanged'''
* '''Wedge'''
* '''Vee'''
* '''Line'''
* '''Column'''
* '''File'''
* '''Staggered Col.'''
* '''Echelon L.'''
* '''Echelon R.'''
* '''Diamond'''
 
| <small>{{hl|formation}}</small>
| [[String]]
|-
|-
| '''SpeedMode'''
| '''SpeedMode'''
| Waypoint States
| State
|  
| Default travel speed of the group. In Combat and Stealth behavior modes, group members will try to prioritize this setting.
| <tt>speedMode</tt>
Available options:
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#SpeedModeWaypoint|SpeedModeWaypoint]]</tt>
* '''Unchanged'''
* '''Limited'''
* '''Normal'''
* '''Full'''
 
| <small>{{hl|speedMode}}</small>
| [[String]]
|-
|-
| '''Condition'''
| '''Condition'''
| Waypoint Expression
| Expression
|  
| Repeatedly calculated condition, must return boolean expression. When the waypoint type conditions are met and this expression returns true, the waypoint is completed.
| <tt>condition</tt>
Passed variables are:
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditCodeMulti3|EditCodeMulti3]]</tt>
* this - group leader
* thisList - array with all group members
| <small>{{hl|condition}}</small>
| [[String]]
|-
|-
| '''On Activation'''
| '''On Activation'''
| Waypoint Expression
| Expression
|  
| Expression called when the waypoint is completed.
| <tt>onActivation</tt>
Passed variables are:
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditCodeMulti5|EditCodeMulti5]]</tt>
* this - group leader
* thisList - array with all group members
| <small>{{hl|onActivation}}</small>
| [[String]]
|-
|-
| '''Script'''
| '''Script'''
| Waypoint Expression
| Expression
|  
| Script executed when 'SCRIPTED' waypoint type is selected. The waypoint will be completed once the script is finished.
| <tt>script</tt>
| <small>{{hl|script}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditCode|EditCode]]</tt>
| [[String]]
|-
|-
| '''Map Visibility'''
| '''Map Visibility'''
| Waypoint Visibility
| Visibility
|  
| Make the waypoint visible for the player on the map.
| <tt>show2D</tt>
| <small>{{hl|show2D}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Checkbox|Checkbox]]</tt>
| [[Boolean]]
|-
|-
| '''Scene Visibility'''
| '''Scene Visibility'''
| Waypoint Visibility
| Visibility
|  
| Make the waypoint visible for the player in the scene.
| <tt>show3D</tt>
| <small>{{hl|show3D}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Checkbox|Checkbox]]</tt>
| [[Boolean]]
|-
|-
| '''Timer Values'''
| '''Timer Values'''
| Waypoint Timer
| Timer
|  
| Time in seconds passed between when the waypoint would be considered complete and when it actually completes. Selected randomly in a range from Min to Max, gravitating towards Mid.
| <tt>timeout</tt>
| <small>{{hl|timeout}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Timeout|Timeout]]</tt>
| [[Array]] in format [min, mid, max]
|-
|-
| '''Effect Condition'''
| '''Effect Condition'''
| Waypoint Effects
| Effects
|  
| Condition for effects to be played, must return boolean expression.
| <tt>effectCondition</tt>
| <small>{{hl|effectCondition}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Edit|Edit]]</tt>
| [[String]]
|-
|-
| '''Sound'''
| '''Sound'''
| Waypoint Effects
| Effects
|  
| Sound played upon activation.
| <tt>sound</tt>
| <small>{{hl|sound}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Sound|Sound]]</tt>
| [[String]]
|-
|-
| '''Voice'''
| '''Voice'''
| Waypoint Effects
| Effects
|  
| Sound spoken by the first unit which activated the trigger.
| <tt>voice</tt>
| <small>{{hl|voice}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#SoundVoice|SoundVoice]]</tt>
| [[String]]
|-
|-
| '''Environment'''
| '''Environment'''
| Waypoint Effects
| Effects
|  
| Environment sounds played upon activation.
| <tt>soundEnvironment</tt>
| <small>{{hl|soundEnvironment}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#SoundEnvironment|SoundEnvironment]]</tt>
| [[String]]
|-
|-
| '''Music'''
| '''Music'''
| Waypoint Effects
| Effects
|  
| Music played upon activation. Replaces previously playing music track.
| <tt>music</tt>
| <small>{{hl|music}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Music|Music]]</tt>
| [[String]]
|-
|-
| '''UI Overlay'''
| '''UI Overlay'''
| Waypoint Effects
| Effects
|  
| User interface overlay shown upon activation.
| <tt>title</tt>
| <small>{{hl|title}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#RscTitle|RscTitle]]</tt>
| [[String]]
|}
|}
</onlyinclude>
</onlyinclude>
== See Also ==
*[[Waypoints]]
*[[Waypoint|Data Type Waypoint]]


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

Latest revision as of 16:55, 5 January 2022

A waypoint defines the destination for a group. Waypoints are ordered sequentially, and only one can be active at any given time.

Waypoint Types

Each waypoint has a specific type, which decides what the group has to do to complete the waypoint. A group led by an AI character will pursue the waypoint automatically, but the player is expected to issue necessary orders when in charge of the group.

You can use any type of waypoint from the Waypoints list in the asset browser. Because waypoints are added to groups, the existing character, group or any of its waypoints has to be selected in order for new waypoint to be added.

3den waypoint add.gif


MOVE Waypoint Shortcut

Alternatively, you can quickly add a MOVE waypoint by holding Shift and pressing the right mouse button.

3den waypoint addQuick.gif

Attaching Waypoints

A waypoint can also be attached to an object. Some waypoint types even require it, like DESTROY or GET IN. To attach a waypoint, drag it to an object. Similarly, you can detach it by dragging it away. Moving the object around will move all the attached waypoints as well. The attached waypoint is visualized by a different icon outline (3den waypoint outlineAttached.png.png instead of 3den waypoint outline.png).

3den waypoint attach.gif

Waypoint Completion

The waypoint is completed when requirements set by its type are met, but additional conditions can be added. A scripted condition can be set in attributes, but you can also connect the waypoint to one or more triggers using Set Waypoint Activation connection. The waypoint will be completed only once all the connected triggers are active.

3den waypoint trigger.gif


Once a waypoint is completed, the group will move to the next one. If there is none, the group will remain where it is. You can find more about the waypoint in the tooltips of their attributes.

Attributes

Info Development
Name Category Description Property Type
Type Type Waypoint type defines what the group will do when the waypoint becomes active, and the condition when it becomes completed. Applies mainly to AI-led groups, as players will not be prompted to perform any specific actions, even though the waypoint completion condition is the same.

Some waypoints have special attributes, which are only available the next time you access the attribute window.

itemClass String
Description Init Text visible for the player next to the waypoint icon in the scene. description String
Order Init Order in which waypoints follow. When changing order, the waypoint will take position of the selected one, pushing all other further down. order
Identified Init System name of the waypoint, used for identification in scripts. name String
Position Transformation World coordinates in meters. X goes from West to East, Y from South to North and Z is height above terrain. position Position3D
Placement Radius Transformation Placement radius in meters. The entity will start at a random position within the radius. placementRadius Number
Completion Radius Transformation Distance in meters in which a group member has to be in order for the waypoint to be considered completed. completionRadius Number
Combat Mode State Controls how and when the group will choose to engage enemy targets.

Available options:

  • Unchanged - No change compared to the previous state.
  • Forced Hold Fire - The group will never fire under any circumstances.
  • Do Not Fire Unless Fired Upon, Keep Formation - Group members will hold fire unless directly threatened.
  • Do Not Fire Unless Fired Upon - Group members will move into positions from which they can shoot at the enemy, but will hold fire unless directly threatened.
  • Open Fire, Keep Formation - Default combat mode. Group members will fire upon any target in range, while staying in formation. The group leader may order individual members to engage specific targets.
  • Open Fire - Group members will fire at any suitable target in range, leaving the formation to find a suitable shooting position.
combatMode String
Behavior State Behavior pattern of the group.

Available options:

  • Unchanged - No change compared to the previous state.
  • Careless - The same as 'Safe', except that it will not be switched automatically after spotting a threat. Use with caution, player may perceive AIs in this behavior as defective.
  • Safe - Non-combat behavior. Characters have weapons lowered. Vehicles follow roads and use lights. They automatically switch to 'Aware' upon spotting a threat.
  • Aware - Default behavior. Characters are in ready position. Vehicles prefer roads, do not use lights and their passengers will disembark to counter threats.
  • Combat - Firefight behavior. Characters break formation and take cover. Vehicles ignore roads and do not use lights.
  • Stealth - Characters break formation and move cautiously, preferring cover and going prone. Vehicles prefer roads, but do not use lights.
behaviour String
Formation State Default group formation. Based on the combat mode, group members may ignore the formation in 'Combat' and 'Stealth' modes.

Available options:

  • Unchanged
  • Wedge
  • Vee
  • Line
  • Column
  • File
  • Staggered Col.
  • Echelon L.
  • Echelon R.
  • Diamond
formation String
SpeedMode State Default travel speed of the group. In Combat and Stealth behavior modes, group members will try to prioritize this setting.

Available options:

  • Unchanged
  • Limited
  • Normal
  • Full
speedMode String
Condition Expression Repeatedly calculated condition, must return boolean expression. When the waypoint type conditions are met and this expression returns true, the waypoint is completed.

Passed variables are:

  • this - group leader
  • thisList - array with all group members
condition String
On Activation Expression Expression called when the waypoint is completed.

Passed variables are:

  • this - group leader
  • thisList - array with all group members
onActivation String
Script Expression Script executed when 'SCRIPTED' waypoint type is selected. The waypoint will be completed once the script is finished. script String
Map Visibility Visibility Make the waypoint visible for the player on the map. show2D Boolean
Scene Visibility Visibility Make the waypoint visible for the player in the scene. show3D Boolean
Timer Values Timer Time in seconds passed between when the waypoint would be considered complete and when it actually completes. Selected randomly in a range from Min to Max, gravitating towards Mid. timeout Array in format [min, mid, max]
Effect Condition Effects Condition for effects to be played, must return boolean expression. effectCondition String
Sound Effects Sound played upon activation. sound String
Voice Effects Sound spoken by the first unit which activated the trigger. voice String
Environment Effects Environment sounds played upon activation. soundEnvironment String
Music Effects Music played upon activation. Replaces previously playing music track. music String
UI Overlay Effects User interface overlay shown upon activation. title String

See Also