Editor Modules – Arma 3 Category

From Bohemia Interactive Community
Jump to navigation Jump to search
(Added the different properties shared by all modules. Most text copied from Mission_Editor:_Units due to similarities.)
m (category)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Arma 3: Editing]]
[[Category:Editor Modules]]
 
== Placing Modules ==
[[File:A3 modules info.jpg|200px|thumb]]
In editor:
# Activate modules mode by pressing F7 or clicking on following icon: [[File:icon editor module.png|32px]]
# Double-click on map to place a module.
# After selecting a desired module, click on ''SHOW INFO'' button to see detailed description.
#: ''Some more advanced modules may be described here on Community Wiki, see the pages in this category.''
 
 
== Adding Modules ==
Arma 3 introduces a module framework, which lets designer to simplify the configuration and chose how the module function will be executed (e.g., globally and for every player who joins later).
 
== Module Properties ==
=== Name ===
The name of a module can be used to refer to the object in script code. Like all variable names, the name must not contain any spaces or reserved characters. You should try to make it something meaningful and avoid conflicts. Note that if a variable exists with an identical name, no warning will be given and the name will refer to the variable first, rather than the named unit. If you copy and paste a named entity, the duplicate will be automatically have an underscore and number appended to it's name to avoid conflicts.
 
=== Initialization ===
Any [[Scripting|script]] code placed in this box will be executed as the mission begins. Script code is extremely powerful and useful - it allows you to create many effects and change aspects of the mission that would not be possible using only the graphical interface of the mission editor. For example, to make a soldier begin the mission unarmed, add "[[removeAllWeapons]] [[this]]" (without the quotation marks) to it's initialization string. Any [[Expression|expressions]] in the initialization field must return [[Nothing|nothing]], or an error message will prevent the unit dialogue from closing.
 
=== Description ===
Unused by modules.
<i>Please confirm</i>
 
=== Probability of Presence ===
Defines how likely it is that the entity will exist each time the mission is played. This can be used to add a bit of randomness to missions. Moving the slider all the way to the right means the object will always be there, all the way to the left means the unit will never appear. Note the ''Condition of Presence'' must also return true if the entity is to appear in the mission.
 
=== Condition of Presence ===
This is a script code condition which must return true in order for the object to appear in the mission. By default this reads "true" which means the object will appear as defined by it's ''Probability of Presence''. For an example, if you wanted a unit to appear only if the mission is being played in Veteran mode, place "![[cadetMode]]" (without quotation marks) in it's Condition of Presence box. A unit with a Condition of Presence that returns false will not exist in the mission, irrespective of its ''Probability of Presence''.
 
=== Placement Radius ===
Changes the object's starting position to a random point within a circle of this radius, in metres. This can be used to add some randomness to your mission. For grouped units, the placement radius is only used by the group leader, and group members with a [[#Special|''Special'']] setting of ''None'' (or ''In Cargo'' for a group without suitable vehicle).
 
<hr/>
 
Read the [[Arma_3_Modules|step by step guide]].

Latest revision as of 14:32, 1 February 2021

Retrieved from "https://community.bistudio.com/wiki?title=Category:Arma_3:_Editor_Modules&oldid=229627"