Eden Editor: Object: Difference between revisions
Lou Montana (talk | contribs) m (Text replacement - "{{SideTOC}}" to "{{TOC|side}}") |
Lou Montana (talk | contribs) m (Text replacement - "<tt>([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}") |
||
Line 36: | Line 36: | ||
| Object type. Can be changed only to another type of the same side, | | Object type. Can be changed only to another type of the same side, | ||
e.g., you can change BLUFOR Car to BLUFOR Helicopter, but not to OPFOR Car or a Prop. | e.g., you can change BLUFOR Car to BLUFOR Helicopter, but not to OPFOR Car or a Prop. | ||
| <small> | | <small>{{hl|ItemClass}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 42: | Line 42: | ||
| 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. | | 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. | ||
| <small> | | <small>{{hl|Name}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 48: | Line 48: | ||
| 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. | | 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. | ||
| <small> | | <small>{{hl|Init}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 54: | Line 54: | ||
| Pylons Settings | | Pylons Settings | ||
| | | | ||
| <small> | | <small>{{hl|Pylons}}</small> | ||
| | | | ||
|- | |- | ||
Line 60: | Line 60: | ||
| Transformation | | Transformation | ||
| World coordinates in meters. X goes from West to East, Y from South to North and Z is height above terrain. | | World coordinates in meters. X goes from West to East, Y from South to North and Z is height above terrain. | ||
| <small> | | <small>{{hl|position}}</small> | ||
| [[Position3D]] | | [[Position3D]] | ||
|- | |- | ||
Line 66: | Line 66: | ||
| Transformation | | Transformation | ||
| Local rotation in degrees. X is pitch, Y is roll and Z is yaw. | | Local rotation in degrees. X is pitch, Y is roll and Z is yaw. | ||
| <small> | | <small>{{hl|rotation}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 72: | Line 72: | ||
| Transformation | | Transformation | ||
| Area size in meters. | | Area size in meters. | ||
| <small> | | <small>{{hl|size3}}</small> | ||
| [[Array]] | | [[Array]] | ||
|- | |- | ||
Line 82: | Line 82: | ||
* '''Rectangle''' | * '''Rectangle''' | ||
| <small> | | <small>{{hl|IsRectangle}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 88: | Line 88: | ||
| Transformation | | Transformation | ||
| Placement radius in meters. The entity will start at a random position within the radius. | | Placement radius in meters. The entity will start at a random position within the radius. | ||
| <small> | | <small>{{hl|placementRadius}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 94: | Line 94: | ||
| 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). | | 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). | ||
| <small> | | <small>{{hl|ControlSP}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 100: | Line 100: | ||
| 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. | | When enabled, the character will appear as a slot in the multiplayer scenario lobby and in the list of roles available for team switch. | ||
| <small> | | <small>{{hl|ControlMP}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 106: | Line 106: | ||
| Control | | Control | ||
| Multiplayer role description visible in the multiplayer lobby. When undefined, the object type name will be used by default. | | Multiplayer role description visible in the multiplayer lobby. When undefined, the object type name will be used by default. | ||
| <small> | | <small>{{hl|description}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 118: | Line 118: | ||
* '''Locked for players''' - Anyone except for players can get in | * '''Locked for players''' - Anyone except for players can get in | ||
| <small> | | <small>{{hl|lock}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 124: | Line 124: | ||
| States | | States | ||
| General AI skill. The attribute does not allow for decreasing it below 20%, because AI behavior would be too simplified. | | General AI skill. The attribute does not allow for decreasing it below 20%, because AI behavior would be too simplified. | ||
| <small> | | <small>{{hl|skill}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 130: | Line 130: | ||
| States | | States | ||
| Object health / armor. When close to 0%, the object will be destroyed. | | Object health / armor. When close to 0%, the object will be destroyed. | ||
| <small> | | <small>{{hl|Health}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 136: | Line 136: | ||
| States | | States | ||
| Vehicle fuel. | | Vehicle fuel. | ||
| <small> | | <small>{{hl|fuel}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 142: | Line 142: | ||
| States | | States | ||
| General vehicle ammo state. | | General vehicle ammo state. | ||
| <small> | | <small>{{hl|ammo}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 157: | Line 157: | ||
* '''Colonel''' | * '''Colonel''' | ||
| <small> | | <small>{{hl|rank}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 169: | Line 169: | ||
* '''Stand Up''' | * '''Stand Up''' | ||
| <small> | | <small>{{hl|unitPos}}</small> | ||
| | | | ||
|- | |- | ||
Line 177: | Line 177: | ||
Note: Doesn't work on simple objects and it overwrites basic simulation settings. | Note: Doesn't work on simple objects and it overwrites basic simulation settings. | ||
| <small> | | <small>{{hl|dynamicSimulation}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 183: | Line 183: | ||
| Special States | | Special States | ||
| Controls unit capability to activate dynamically simulated entities. | | Controls unit capability to activate dynamically simulated entities. | ||
| <small> | | <small>{{hl|addToDynSimGrid}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 191: | Line 191: | ||
Note: This option doesn't have any effect on dynamically simulated objects. | Note: This option doesn't have any effect on dynamically simulated objects. | ||
| <small> | | <small>{{hl|enableSimulation}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 199: | Line 199: | ||
Warning: If set, the setting is enforced at the start of the scenario and is irreversible during its runtime! | Warning: If set, the setting is enforced at the start of the scenario and is irreversible during its runtime! | ||
| <small> | | <small>{{hl|objectIsSimple}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 205: | Line 205: | ||
| Special States | | Special States | ||
| Show model and collisions. Even when disabled, the object will be simulated normally (e.g., soldiers will still be able to move and shoot). | | Show model and collisions. Even when disabled, the object will be simulated normally (e.g., soldiers will still be able to move and shoot). | ||
| <small> | | <small>{{hl|hideObject}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 211: | Line 211: | ||
| Special States | | Special States | ||
| Set if the object can receive any damage. When a vehicle is invincible, its crew can still be killed. | | Set if the object can receive any damage. When a vehicle is invincible, its crew can still be killed. | ||
| <small> | | <small>{{hl|allowDamage}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 217: | Line 217: | ||
| Special States | | Special States | ||
| Set whether the character should become tired when moving or not. When disabled for player, the stamina bar will be hidden completely. | | Set whether the character should become tired when moving or not. When disabled for player, the stamina bar will be hidden completely. | ||
| <small> | | <small>{{hl|enableStamina}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 223: | Line 223: | ||
| Special States | | Special States | ||
| Enable revive for this unit. | | Enable revive for this unit. | ||
| <small> | | <small>{{hl|EnableRevive}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 229: | Line 229: | ||
| Special States | | Special States | ||
| Set closed, locked or opened state for object doors. | | Set closed, locked or opened state for object doors. | ||
| <small> | | <small>{{hl|DoorStates}}</small> | ||
| | | | ||
|- | |- | ||
Line 235: | Line 235: | ||
| Identity | | Identity | ||
| Character name, by default automatically generated based on faction. | | Character name, by default automatically generated based on faction. | ||
| <small> | | <small>{{hl|unitName}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 241: | Line 241: | ||
| Identity | | Identity | ||
| Character face. | | Character face. | ||
| <small> | | <small>{{hl|face}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 317: | Line 317: | ||
* '''Korneedler''' | * '''Korneedler''' | ||
</spoiler> | </spoiler> | ||
| <small> | | <small>{{hl|NameSound}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 323: | Line 323: | ||
| Identity | | Identity | ||
| Radio voice used in group communication (e.g., target reporting). | | Radio voice used in group communication (e.g., target reporting). | ||
| <small> | | <small>{{hl|speaker}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 329: | Line 329: | ||
| Identity | | Identity | ||
| Voice pitch. Higher number means higher voice. | | Voice pitch. Higher number means higher voice. | ||
| <small> | | <small>{{hl|pitch}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 335: | Line 335: | ||
| Identity | | Identity | ||
| Left shoulder insignia. Right shoulder insignia is reserved for a squad logo and cannot be changed by the scenario. | | Left shoulder insignia. Right shoulder insignia is reserved for a squad logo and cannot be changed by the scenario. | ||
| <small> | | <small>{{hl|unitInsignia}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 341: | Line 341: | ||
| Presence | | Presence | ||
| Probability of presence evaluated at the scenario start. When it fails, the object is not created at all. | | Probability of presence evaluated at the scenario start. When it fails, the object is not created at all. | ||
| <small> | | <small>{{hl|presence}}</small> | ||
| [[Number]] | | [[Number]] | ||
|- | |- | ||
Line 347: | Line 347: | ||
| Presence | | Presence | ||
| Condition of presence evaluated at the scenario start, must return boolean expression. When false, the object is not created at all. | | Condition of presence evaluated at the scenario start, must return boolean expression. When false, the object is not created at all. | ||
| <small> | | <small>{{hl|presenceCondition}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 353: | Line 353: | ||
| Equipment Storage | | Equipment Storage | ||
| | | | ||
| <small> | | <small>{{hl|ammoBox}}</small> | ||
| [[String]] | | [[String]] | ||
|- | |- | ||
Line 359: | Line 359: | ||
| Electronics & Sensors | | Electronics & Sensors | ||
| Vehicle will broadcast targets tracked by its sensors to any other unit on the same side with Data Link enabled. | | Vehicle will broadcast targets tracked by its sensors to any other unit on the same side with Data Link enabled. | ||
| <small> | | <small>{{hl|ReportRemoteTargets}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 365: | Line 365: | ||
| Electronics & Sensors | | Electronics & Sensors | ||
| Vehicle will receive targeting and positional data from any other broadcasting vehicle on the same side. | | Vehicle will receive targeting and positional data from any other broadcasting vehicle on the same side. | ||
| <small> | | <small>{{hl|ReceiveRemoteTargets}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 371: | Line 371: | ||
| Electronics & Sensors | | Electronics & Sensors | ||
| Vehicle will broadcast its own position to any other unit on the same side with Data Link enabled. | | Vehicle will broadcast its own position to any other unit on the same side with Data Link enabled. | ||
| <small> | | <small>{{hl|ReportOwnPosition}}</small> | ||
| [[Boolean]] | | [[Boolean]] | ||
|- | |- | ||
Line 382: | Line 382: | ||
* '''Off''' - AI will keep Radar silent at all times | * '''Off''' - AI will keep Radar silent at all times | ||
| <small> | | <small>{{hl|RadarUsageAI}}</small> | ||
| [[String]] | | [[String]] | ||
|} | |} |
Revision as of 23:55, 15 November 2021
An object is an entity with physical representation in the world. The player can see it as a model with textures, while the game recognizes its technical properties like the simulation type, collision geometry or damage.
Objects can be divided into three main categories as listed below.
Characters
A Character is a living entity controlled either by a player, or by an AI (Artificial Intelligence; sometimes also known as NPC - Non-Playable Character).
Vehicles
A Vehicle is an object which can have a crew composed of characters. A crewed vehicle has an effective commander, who can issue orders to the rest of the crew. The vehicle also inherits the side of the commander (i.e., BLUFOR pilot will render a helicopter BLUFOR as well).
Props
A Prop is any other object without special functionality, for example, houses, fences or signs. Empty vehicles are not props. Animals are, mainly because they cannot be considered characters.
The object is the entity type you will be editing the most, so make sure to familiarize yourself with all its options.
Attributes
Info | Development | |||
---|---|---|---|---|
Name | Category | Description | Property | Type |
Type | Type | Object type. Can be changed only to another type of the same side,
e.g., you can change BLUFOR Car to BLUFOR Helicopter, but not to OPFOR Car or a Prop. |
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 |
Pylons Settings | Pylons | |||
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 | Number |
Size | Transformation | Area size in meters. | size3 | Array |
Shape | Transformation | Area shape.
Available options:
|
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 |
Lock | States | Vehicle lock. When locked, characters outside of the vehicle will be unable to get in and those already inside will be forbidden from leaving.
Available options:
|
lock | Number |
Skill | States | General AI skill. The attribute does not allow for decreasing it below 20%, because AI behavior would be too simplified. | skill | Number |
Health / Armor | States | Object health / armor. When close to 0%, the object will be destroyed. | Health | Number |
Fuel | States | Vehicle fuel. | fuel | Number |
Ammunition | States | General vehicle ammo state. | ammo | Number |
Rank | States | Character rank. When a group leader is killed, the subordinate with the highest rank will take over.
Available options:
|
rank | String |
Stance | States |
Available options:
|
unitPos | |
Enable Dynamic Simulation | Special States | Entity simulation is enabled only if the player or an enemy unit is nearby.
Note: Doesn't work on simple objects and it overwrites basic simulation settings. |
dynamicSimulation | Number |
Wake-Up Dynamic Simulation | Special States | Controls unit capability to activate dynamically simulated entities. | addToDynSimGrid | Number |
Enable Simulation | Special States | When disabled, the object will freeze and ignore any input or collisions.
Note: This option doesn't have any effect on dynamically simulated objects. |
enableSimulation | Boolean |
Simple Object | Special States | When enabled, the object will behave like a map object (e.g. rocks or trees), which significantly saves performance. This option is available only for objects where it leads to improved performance.
Warning: If set, the setting is enforced at the start of the scenario and is irreversible during its runtime! |
objectIsSimple | Boolean |
Show Model | Special States | Show model and collisions. Even when disabled, the object will be simulated normally (e.g., soldiers will still be able to move and shoot). | hideObject | Boolean |
Enable Damage | Special States | Set if the object can receive any damage. When a vehicle is invincible, its crew can still be killed. | allowDamage | Boolean |
Enable Stamina | Special States | Set whether the character should become tired when moving or not. When disabled for player, the stamina bar will be hidden completely. | enableStamina | Boolean |
Revive Enabled | Special States | Enable revive for this unit. | EnableRevive | Boolean |
Doors States | Special States | Set closed, locked or opened state for object doors. | DoorStates | |
Name | Identity | Character name, by default automatically generated based on faction. | unitName | String |
Face | Identity | Character face. | face | String |
Call Sign | Identity | Call sign used in radio protocol (e.g., leader will order 'Kerry, fall back' instead of generic '2, fall back'). It doesn't affect character's actual name; consider changing it as well so they match together.
Available options:
|
NameSound | String |
Voice | Identity | Radio voice used in group communication (e.g., target reporting). | speaker | String |
Voice Pitch | Identity | Voice pitch. Higher number means higher voice. | pitch | Number |
Insignia | Identity | Left shoulder insignia. Right shoulder insignia is reserved for a squad logo and cannot be changed by the scenario. | unitInsignia | 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 |
Equipment Storage | Equipment Storage | ammoBox | String | |
Data Link Send | Electronics & Sensors | Vehicle will broadcast targets tracked by its sensors to any other unit on the same side with Data Link enabled. | ReportRemoteTargets | Boolean |
Data Link Receive | Electronics & Sensors | Vehicle will receive targeting and positional data from any other broadcasting vehicle on the same side. | ReceiveRemoteTargets | Boolean |
Data Link Position | Electronics & Sensors | Vehicle will broadcast its own position to any other unit on the same side with Data Link enabled. | ReportOwnPosition | Boolean |
Emission Control | Electronics & Sensors | Radar EMCON rules for the AI
Available options:
|
RadarUsageAI | String |