Construction Interface – Arma 2

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Some wiki formatting)
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[Category:ArmA 2: Editor Modules]]
{{TOC|side}}
'''Construction Interface (CoIn)''' is universal system for base construction primarily made for Warfare 2.


'''Construction Interface (CoIn)''' is universal system for base construction primarily made for Warfare 2.
== Initialisation ==


== Initialization==
=== Paths ===
=== Paths ===
Editor:
Editor:
  Units (F1) > Game Logic > Construction Interface
  Modules (F7) > Construction Interface
 
Data:
Data:
  ca\modules\coin
  ca\modules\coin


=== Startup ===
=== Startup ===
Place CoIn module manager where you want to have base center (you can change this position dynamically during the game). You can place as many construction sites as you want.
Place CoIn module manager where you want to have base center (you can change this position dynamically during the game). You can place as many construction sites as you want.


Line 16: Line 19:




=== Using synchronization (F5) ===
=== Using synchronisation (F5) ===
Units with access to given construction site can now be defined using synchronization (F5) and [[synchronizeObjectsAdd]] command.
 
Units with access to given construction site can now be defined using synchronisation {{Controls|F5}} and [[synchronizeObjectsAdd]] command.
 
=== Optional Parameters ===
 
==== Set Variables to BIS_coin_# with Desired Values ====
* '''BIS_COIN_name = <string>;''' - Name of construction (displayed in action menu and GUI)
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_name", "Base"];</sqf>
:: Default value: <sqf inline>""</sqf> (no name)


=== Optional parameters ===
* '''BIS_COIN_rules = <array> or <side>;''' - Rules which defines which units have access to construction. Can be either list of specific units or whole side.
====Set variables to BIS_coin_# with desired values====
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_rules", [west, guer_commander]];</sqf>
:: Default value: <sqf inline>[]</sqf>


*'''name = <string>;''' - Name of construction (displayed in action menu and GUI)
* '''BIS_COIN_categories = <array>;''' - List of categories
::Example: ''BIS_coin_0 setvariable ["name","Base"];''
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_categories", ["Base","Defence"]];</sqf>
::Default value: "" (no name)
:: Default value: <sqf inline>[]</sqf>


*'''rules = <array> or <side>;''' - Rules which defines which units have access to construction. Can be either list of specific units or whole side.
* '''BIS_COIN_items = <array>;''' - List of items to buy. Preview class (green transparent building) have to be named ''buildingclass_preview''.<br><!--
::Example: ''BIS_coin_0 setvariable ["rules",[west,guer_commander]];''
--> Array contains building class, it' price in array (first element is funds' ID - see below, second is actual price; if only price is set, funds' ID will be 0) and display name
::Default value: []
:: Example: <sqf>
bis_coin_0 setVariable ["BIS_COIN_items",
[
//--- Class, Category, Cost or [fundsID, Cost], (display name)
["USMC_WarfareBBarracks", "Base", 200],
["USMC_WarfareBLightFactory", "Base", [0, 300], "Chocolate factory"]
]
];
</sqf>
:: Default value: <sqf inline>[]</sqf>


*'''categories = <array>;''' - List of categories
* '''BIS_COIN_funds = <string> or <array>;''' - Variable(s) which stores amount of funds.
::Example: ''BIS_coin_0 setvariable ["categories",["Base","Defence"]];''
:: Example 1: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_funds", "money_account"];</sqf>
::Default value: []
:: Example 2: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_funds", ["supply_account", "money_account"]];</sqf>
:: Default value: <sqf inline>0</sqf>


*'''items = <array>;''' - List of items to buy. Preview class (green transparent building) have to be named ''buildingclass_preview''.<br />
* '''BIS_COIN_fundsDescription = <string> or <array>;''' - Variable(s) which stores description of funds types.
Array cointains building class, it' price in array (first element is funds' ID - see below, second is actual price; if only price is set, funds' ID will be 0) and display name
:: Example 1: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_fundsDescription", "CZK"];</sqf>
::Example:  
:: Example 2: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_fundsDescription", ["", "$"]];</sqf>
bis_coin_0 setvariable ["items",
:: Default value: <sqf inline>"$"</sqf>
[
//--- Class, Category, Cost or [fundsID,Cost], (display name)
["USMC_WarfareBBarracks","Base",200],
["USMC_WarfareBLightFactory","Base",[0,300],"Chocolate factory"],
]
];
::Default value: []


*'''funds = <string> or <array>;''' - Variable(s) which stores amount of funds.
* '''BIS_COIN_areaSize = <array>;''' - Size of construction area (camera can't move outside of this circle and no building can be build there). Format of array is [radius,height]
::Example 1: ''BIS_coin_0 setvariable ["funds","money_account"];''
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_areaSize", [50, 20]];</sqf>
::Example 2: ''BIS_coin_0 setvariable ["funds",["supply_account","money_account"]];''
:: Default value: <sqf inline>[150, 50]</sqf>
::Default value: 0


*'''fundsDescription = <string> or <array>;''' - Variable(s) which stores description of funds types.
* '''BIS_COIN_actionCondition = <string>;''' - String - condition for showing CoIn "Construction" action. If false, action never apperars. Can be changed on fly. Passed arguments: _this, _target.
::Example 1: ''BIS_coin_0 setvariable ["fundsDescription","CZK"];''
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_actionCondition", "(time < 30) && ((damage _this) < 0.5)"];</sqf> - construction actions will be visible only till T 30 and to players not damaged too much
::Example 2: ''BIS_coin_0 setvariable ["fundsDescription",["€","$"]];''
:: Default value: <sqf inline>true</sqf>
::Default value:  "$"
:: '''Note:''' Use with caution, because action is calculated every frame and complex condition on multiple construction sites can take large amount of reserved scripting time.


*'''areasize = <array>;''' - Size of construction area (camera can't move outside of this circle and no building can be build there). Format of array is [radius,height]
* '''BIS_COIN_onStart = <nowiki><code></nowiki>;''' - Code which is executed when CoIn interface is started. Can be used to update CoIn variables just in time. Passed arguments is [logic]
::Example: ''BIS_coin_0 setvariable ["areasize",[50,20]];''
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_onstart", { player globalChat "Starting CoIn view." }];</sqf>
::Default value: [150,50]
:: Default value: <sqf inline>{}</sqf>
:: {{Feature|important|System starts only after code is finished.}}


*'''actionCondition = <string>;''' - String - condition for showing CoIn "Construction" action. If false, action never apperars. Can be changed on fly. Passed arguments: _this, _target.
* '''BIS_COIN_onSelect = <nowiki><code></nowiki>;''' - Code which is executed when some building type is selected from menu. Passed arguments are [logic, class, preview building]
::Example: ''BIS_coin_0 setvariable ["actionCondition","(time < 30) && ((damage _this) < 0.5)"];'' - construction actions will be visible only till T 30 and to players not damaged too much
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_onselect",{globalClass = _this select 0}];</sqf>
::Default value: true
:: Default value: <sqf inline>{}</sqf>
::'''Note:''' Use with caution, because action is calculated every frame and complex condition on multiple construction sites can take large amount of reserved scripting time.


*'''onStart = <nowiki><code></nowiki>;''' - Code which is executed when CoIn interface is started. Can be used to update CoIn variables just in time. Passed arguments is [logic]
* '''BIS_COIN_onPurchase = <nowiki><code></nowiki>;''' - Code which is executed when some building is purchased. Once code is completed, building is constructed. Passed argument is array in format [class,position,direction].
::Example: ''BIS_coin_0 setvariable ["onstart",{player globalchat "Starting CoIn view.}];''
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_onPurchase",{sleep 2}];</sqf> - building appears after two seconds
::Default value: {}
:: Default value: <sqf inline>{}</sqf>
::Note: <span style="color:#DF9300;">Warning! System starts only after code is finished.</span>
:: {{Feature|important|System continues only after code is finished.}}


*'''onSelect = <nowiki><code></nowiki>;''' - Code which is executed when some building type is selected from menu. Passed arguments are [logic, class, preview building]
* '''BIS_COIN_onConstruct = <nowiki><code></nowiki>;''' - Code which is executed when some building is created in the world. Passed argument is array in format [logic, object, class,position,direction].
::Example: ''BIS_coin_0 setvariable ["onselect",{globalClass = _this select 0}];''
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_onconstruct",{sleep 2; deleteVehicle (_this select 1);}];</sqf> - building appears and is deleted after two seconds
::Default value: {}
:: Default value: <sqf inline>{}</sqf>


*'''onPurchase = <nowiki><code></nowiki>;''' - Code which is executed when some building is purchased. Once code is completed, building is constructed. Passed argument is array in format [class,position,direction].
* '''BIS_COIN_onRepair = <nowiki><code></nowiki>;''' - Code which is executed when some building is repaired. Once code is completed, building is repaired. Passed arguments are [logic, object].
::Example: ''BIS_coin_0 setvariable ["onPurchase",{sleep 2}];'' - building appears after two seconds
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_onrepair",{sleep 2}];</sqf> - building is repaired after 2 seconds
::Default value: {}
:: Default value: <sqf inline>{}</sqf> (Building is immediately repaired)
::Note: <span style="color:#DF9300;">Warning! System continues only after code is finished.</span>
:: {{Feature|important|System continues only after code is finished.}} Building can be repaired by pressing User 13 key.


*'''onConstruct = <nowiki><code></nowiki>;''' - Code which is executed when some building is created in the world. Passed argument is array in format [logic, object, class,position,direction].
* '''BIS_COIN_onSell = <nowiki><code></nowiki>;''' - Code which is executed when some building is sold. Once code is completed, building is deleted. Passed argument is [logic, object]
::Example: ''BIS_coin_0 setvariable ["onconstruct",{sleep 2; deleteVehicle (_this select 1);}];'' - building appears and is deleted after two seconds
:: Example: <sqf inline>BIS_coin_0 setVariable ["BIS_COIN_onsell",{sleep 2}];</sqf> - building is deleted after 2 seconds
::Default value: {}
:: Default value: <sqf inline>{}</sqf> (Building is immediately sold)
:: {{Feature|important|System continues only after code is finished.}} Building can be sold by pressing User 14 key.


*'''onRepair = <nowiki><code></nowiki>;''' - Code which is executed when some building is repaired. Once code is completed, building is repaired. Passed arguments are [logic, object].
::Example: ''BIS_coin_0 setvariable ["onrepair",{sleep 2}];'' - building is repaired after 2 seconds
::Default value: {} (Building is immediately repaired)
::Note: <span style="color:#DF9300;">Warning! System continues only after code is finished.</span>


*'''onSell = <nowiki><code></nowiki>;''' - Code which is executed when some building is sold. Once code is completed, building is deleted. Passed argument is [logic, object]
{{GameCategory|arma2|Editor Modules}}
::Example: ''BIS_coin_0 setvariable ["onsell",{sleep 2}];'' - building is deleted after 2 seconds
::Default value: {} (Building is immediately sold)
::Note: <span style="color:#DF9300;">Warning! System continues only after code is finished.</span>

Latest revision as of 23:30, 28 August 2023

Construction Interface (CoIn) is universal system for base construction primarily made for Warfare 2.

Initialisation

Paths

Editor:

Modules (F7) > Construction Interface

Data:

ca\modules\coin

Startup

Place CoIn module manager where you want to have base center (you can change this position dynamically during the game). You can place as many construction sites as you want.

Every logic is automatically named BIS_coin_#, where # is number starting from 0.


Using synchronisation (F5)

Units with access to given construction site can now be defined using synchronisation F5 and synchronizeObjectsAdd command.

Optional Parameters

Set Variables to BIS_coin_# with Desired Values

  • BIS_COIN_name = <string>; - Name of construction (displayed in action menu and GUI)
Example: BIS_coin_0 setVariable ["BIS_COIN_name", "Base"];
Default value: "" (no name)
  • BIS_COIN_rules = <array> or <side>; - Rules which defines which units have access to construction. Can be either list of specific units or whole side.
Example: BIS_coin_0 setVariable ["BIS_COIN_rules", [west, guer_commander]];
Default value: []
  • BIS_COIN_categories = <array>; - List of categories
Example: BIS_coin_0 setVariable ["BIS_COIN_categories", ["Base","Defence"]];
Default value: []
  • BIS_COIN_items = <array>; - List of items to buy. Preview class (green transparent building) have to be named buildingclass_preview.
    Array contains building class, it' price in array (first element is funds' ID - see below, second is actual price; if only price is set, funds' ID will be 0) and display name
Example:
bis_coin_0 setVariable ["BIS_COIN_items", [ //--- Class, Category, Cost or [fundsID, Cost], (display name) ["USMC_WarfareBBarracks", "Base", 200], ["USMC_WarfareBLightFactory", "Base", [0, 300], "Chocolate factory"] ] ];
Default value: []
  • BIS_COIN_funds = <string> or <array>; - Variable(s) which stores amount of funds.
Example 1: BIS_coin_0 setVariable ["BIS_COIN_funds", "money_account"];
Example 2: BIS_coin_0 setVariable ["BIS_COIN_funds", ["supply_account", "money_account"]];
Default value: 0
  • BIS_COIN_fundsDescription = <string> or <array>; - Variable(s) which stores description of funds types.
Example 1: BIS_coin_0 setVariable ["BIS_COIN_fundsDescription", "CZK"];
Example 2: BIS_coin_0 setVariable ["BIS_COIN_fundsDescription", ["€", "$"]];
Default value: "$"
  • BIS_COIN_areaSize = <array>; - Size of construction area (camera can't move outside of this circle and no building can be build there). Format of array is [radius,height]
Example: BIS_coin_0 setVariable ["BIS_COIN_areaSize", [50, 20]];
Default value: [150, 50]
  • BIS_COIN_actionCondition = <string>; - String - condition for showing CoIn "Construction" action. If false, action never apperars. Can be changed on fly. Passed arguments: _this, _target.
Example: BIS_coin_0 setVariable ["BIS_COIN_actionCondition", "(time < 30) && ((damage _this) < 0.5)"]; - construction actions will be visible only till T 30 and to players not damaged too much
Default value: true
Note: Use with caution, because action is calculated every frame and complex condition on multiple construction sites can take large amount of reserved scripting time.
  • BIS_COIN_onStart = <code>; - Code which is executed when CoIn interface is started. Can be used to update CoIn variables just in time. Passed arguments is [logic]
Example: BIS_coin_0 setVariable ["BIS_COIN_onstart", { player globalChat "Starting CoIn view." }];
Default value: {}
System starts only after code is finished.
  • BIS_COIN_onSelect = <code>; - Code which is executed when some building type is selected from menu. Passed arguments are [logic, class, preview building]
Example: BIS_coin_0 setVariable ["BIS_COIN_onselect",{globalClass = _this select 0}];
Default value: {}
  • BIS_COIN_onPurchase = <code>; - Code which is executed when some building is purchased. Once code is completed, building is constructed. Passed argument is array in format [class,position,direction].
Example: BIS_coin_0 setVariable ["BIS_COIN_onPurchase",{sleep 2}]; - building appears after two seconds
Default value: {}
System continues only after code is finished.
  • BIS_COIN_onConstruct = <code>; - Code which is executed when some building is created in the world. Passed argument is array in format [logic, object, class,position,direction].
Example: BIS_coin_0 setVariable ["BIS_COIN_onconstruct",{sleep 2; deleteVehicle (_this select 1);}]; - building appears and is deleted after two seconds
Default value: {}
  • BIS_COIN_onRepair = <code>; - Code which is executed when some building is repaired. Once code is completed, building is repaired. Passed arguments are [logic, object].
Example: BIS_coin_0 setVariable ["BIS_COIN_onrepair",{sleep 2}]; - building is repaired after 2 seconds
Default value: {} (Building is immediately repaired)
System continues only after code is finished.
Building can be repaired by pressing User 13 key.
  • BIS_COIN_onSell = <code>; - Code which is executed when some building is sold. Once code is completed, building is deleted. Passed argument is [logic, object]
Example: BIS_coin_0 setVariable ["BIS_COIN_onsell",{sleep 2}]; - building is deleted after 2 seconds
Default value: {} (Building is immediately sold)
System continues only after code is finished.
Building can be sold by pressing User 14 key.