Eden Editor: System: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(→‎Attributes: rotation is array)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{TOC|side}}
A system is a virtual object which can help expand your scenario with a new functionality.
== Modules ==
A '''module''' provides complex functionality which would otherwise have to be scripted. It can usually be configured using custom attributes, and can sometimes be affected by '''synchronization''' connections. For example, many modules are activated only once all the synchronized triggers are active. To see more about the individual modules, explore their attributes.
== Logic Entities ==
A '''logic entity''' is simply a virtual object without any inherent functionality. It is mainly used in cooperation with modules or scripts, for example, to mark positions and their relations.
== Virtual Entities ==
Some '''virtual entities''' are playable. They are used in multiplayer for abstract roles such as a spectator or headless client.
Be sure to investigate all the available systems, especially [[Modules]]. Because each has its own rules, do not forget to also check 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'''
| Logic Type
| Type
|  
|  
| <tt>itemClass</tt>
| <small>{{hl|itemClass}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Type|Type]]</tt>
| [[String]]
|-
|-
| '''Variable Name'''
| '''Variable Name'''
| Logic Init
| Init
|  
| Unique system name. Can contain only letters, numbers and underscore. The name is not case sensitive, so 'someName' and 'SOMENAME' are treated as the same variables.
| <tt>Name</tt>
| <small>{{hl|Name}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Edit|Edit]]</tt>
| [[String]]
|-
|-
| '''Init'''
| '''Init'''
| Logic Init
| Init
|  
| Expression called upon at start. In multiplayer, it is called on every machine and for each player who joins in the progress. The variable 'this' refers to the affected object.
| <tt>Init</tt>
| <small>{{hl|Init}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditMulti3|EditMulti3]]</tt>
| [[String]]
|-
|-
| '''Position'''
| '''Position'''
| Logic 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]]
|-
|-
| '''Rotation'''
| '''Rotation'''
| Logic Transformation
| Transformation
|  
| Local rotation in degrees. X is pitch, Y is roll and Z is yaw.
| <tt>rotation</tt>
| <small>{{hl|rotation}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditXYZ|EditXYZ]]</tt>
| [[Array]]
|-
| '''Size'''
| Transformation
| Area size in meters.
| <small>{{hl|size2}}</small>
| [[Array]]
|-
| '''Size'''
| Transformation
| Area size in meters.
| <small>{{hl|size3}}</small>
| [[Array]]
|-
| '''Shape'''
| Transformation
| Area shape.
Available options:
* '''Ellipse'''
* '''Rectangle'''
 
| <small>{{hl|IsRectangle}}</small>
| [[Boolean]]
|-
|-
| '''Placement Radius'''
| '''Placement Radius'''
| Logic 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#Edit|Edit]]</tt>
| [[Number]]
|-
|-
| '''Singleplayer Control'''
| '''Player'''
| Object Control
| Control
|  
| Player in singleplayer. When enabled, the character will also be available in multiplayer and team switch ('Playable' status cannot be disabled individually in such case).
| <tt>ControlSP</tt>
| <small>{{hl|ControlSP}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#ControlSP|ControlSP]]</tt>
| [[Boolean]]
|-
|-
| '''Multiplayer Control'''
| '''Playable'''
| Object Control
| Control
|  
| When enabled, the character will appear as a slot in the multiplayer scenario lobby and in the list of roles available for team switch.
| <tt>ControlMP</tt>
| <small>{{hl|ControlMP}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#ControlMP|ControlMP]]</tt>
| [[Boolean]]
|-
|-
| '''Role Description'''
| '''Role Description'''
| Object Control
| Control
|  
| Multiplayer role description visible in the multiplayer lobby. When undefined, the object type name will be used by default.
| <tt>description</tt>
| <small>{{hl|description}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Edit|Edit]]</tt>
| [[String]]
|-
|-
| '''Probability of Presence'''
| '''Probability of Presence'''
| Logic Presence
| Presence
|  
| Probability of presence evaluated at the scenario start. When it fails, the object is not created at all.
| <tt>presence</tt>
| <small>{{hl|presence}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#Slider|Slider]]</tt>
| [[Number]]
|-
|-
| '''Condition of Presence'''
| '''Condition of Presence'''
| Logic Presence
| Presence
|  
| Condition of presence evaluated at the scenario start, must return boolean expression. When false, the object is not created at all.
| <tt>presenceCondition</tt>
| <small>{{hl|presenceCondition}}</small>
| <tt>[[Eden_Editor:_Configuring_Attributes:_Controls#EditCode|EditCode]]</tt>
| [[String]]
|}
|}
</onlyinclude>
</onlyinclude>


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

Latest revision as of 16:04, 16 April 2023

A system is a virtual object which can help expand your scenario with a new functionality.

Modules

A module provides complex functionality which would otherwise have to be scripted. It can usually be configured using custom attributes, and can sometimes be affected by synchronization connections. For example, many modules are activated only once all the synchronized triggers are active. To see more about the individual modules, explore their attributes.

Logic Entities

A logic entity is simply a virtual object without any inherent functionality. It is mainly used in cooperation with modules or scripts, for example, to mark positions and their relations.

Virtual Entities

Some virtual entities are playable. They are used in multiplayer for abstract roles such as a spectator or headless client.


Be sure to investigate all the available systems, especially Modules. Because each has its own rules, do not forget to also check their attributes.

Attributes

Info Development
Name Category Description Property Type
Type Type itemClass String
Variable Name Init Unique system name. Can contain only letters, numbers and underscore. The name is not case sensitive, so 'someName' and 'SOMENAME' are treated as the same variables. Name String
Init Init Expression called upon at start. In multiplayer, it is called on every machine and for each player who joins in the progress. The variable 'this' refers to the affected object. Init 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
Rotation Transformation Local rotation in degrees. X is pitch, Y is roll and Z is yaw. rotation Array
Size Transformation Area size in meters. size2 Array
Size Transformation Area size in meters. size3 Array
Shape Transformation Area shape.

Available options:

  • Ellipse
  • Rectangle
 IsRectangle Boolean
Placement Radius Transformation Placement radius in meters. The entity will start at a random position within the radius. placementRadius Number
Player Control Player in singleplayer. When enabled, the character will also be available in multiplayer and team switch ('Playable' status cannot be disabled individually in such case). ControlSP Boolean
Playable Control When enabled, the character will appear as a slot in the multiplayer scenario lobby and in the list of roles available for team switch. ControlMP Boolean
Role Description Control Multiplayer role description visible in the multiplayer lobby. When undefined, the object type name will be used by default. description String
Probability of Presence Presence Probability of presence evaluated at the scenario start. When it fails, the object is not created at all. presence Number
Condition of Presence Presence Condition of presence evaluated at the scenario start, must return boolean expression. When false, the object is not created at all. presenceCondition String
Retrieved from "https://community.bistudio.com/wiki?title=Eden_Editor:_System&oldid=338898"