Difference between revisions of "Arma 3: Curator"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m
Line 12: Line 12:
  
 
== Costs ==
 
== Costs ==
 +
Mission designer can assign cost to every object curator can interact with. The cost is applied when performing actions like placing, editing or deleting. It affects curator's resources - '''points''' - which are in range from 0 (no points) to 1 (full points; can't be larger than this value). The cost can be both negative and positive, so some actions can actually add points (e.g., deleting).
 +
 +
[[File:arma3 curator points.jpg|800px|thumb|center|Points visualized in the curator interface]]
 +
<br style="clear:both;">
 +
 
=== Manual Assigning ===
 
=== Manual Assigning ===
 
You can assign individual cost for every object in the game using [[Arma_3:_Event_Handlers#CuratorObjectRegistered|CuratorObjectRegistered]] event handler. It's executed when player enters curator interface, so individual values cannot be changed on the fly. However, you can still tweak costs using [[#Action Coefficients|action coefficients]] and available objects by [[#Unlocking Addons|unlocking addons]].
 
You can assign individual cost for every object in the game using [[Arma_3:_Event_Handlers#CuratorObjectRegistered|CuratorObjectRegistered]] event handler. It's executed when player enters curator interface, so individual values cannot be changed on the fly. However, you can still tweak costs using [[#Action Coefficients|action coefficients]] and available objects by [[#Unlocking Addons|unlocking addons]].
Line 56: Line 61:
  
 
=== Action Coefficients ===
 
=== Action Coefficients ===
 +
Once you assigned cost to every object, you can now use it for every action curator can perform.
 +
 +
[[myCurator]] [[setCuratorCoef]] ["place",-0.1];
 +
  
 
== Unlocking Addons ==
 
== Unlocking Addons ==

Revision as of 09:45, 18 February 2014

arma3 curator eye.png

Curator is a technical name for Arma 3 Zeus game master system. Every involved scripting command, event handler or class name contains the name. The reason for it is to have a generic name which can be passed from project to project without any associations.

Setup

The central piece of every curator is Game Master module, otherwise referred to as Curator Logic. It stores every setting, like editing areas, available objects or their costs.

You can find the module in Modules (F7) > Zeus > Game Master

In module arguments, can set the curator unit (either specific unit, player with given UID or server admin) and that's all you need to add game master to your mission. Without any further settings, all objects will be available for free and whole map will be editable.

In every examples on this page, we'll call the module myCurator.

Costs

Mission designer can assign cost to every object curator can interact with. The cost is applied when performing actions like placing, editing or deleting. It affects curator's resources - points - which are in range from 0 (no points) to 1 (full points; can't be larger than this value). The cost can be both negative and positive, so some actions can actually add points (e.g., deleting).

Points visualized in the curator interface


Manual Assigning

You can assign individual cost for every object in the game using CuratorObjectRegistered event handler. It's executed when player enters curator interface, so individual values cannot be changed on the fly. However, you can still tweak costs using action coefficients and available objects by unlocking addons.


myCurator addEventHandler ["CuratorObjectRegistered",{...code here, see below...}];

Arguments passed into the handler are:

Expected returned value is an Array of Arrays of the same size as the input array, with each item belonging to a class with the same array index. Missing or incorrect values will be replaced by default [true,0,0].

  • Input: [string1, string2, string3, ... classN]
  • Output: [array1, array2, array3, ... arrayN]

Example:

  • Input (3 classes): ["B_Soldier_f", "B_MRAP_01_F", "ModuleLightning_F"]
  • Output (3 arrays with settings): [[true,0.1], [true,0.5,0.6], [false,0,0]]


Every item in the array is in the following format:

[show, cost, (costWithCrew)]
  • show: Boolean - true to let the object appear in the CREATE list, false to hide it (costs will still be accepted if an object of the type is already present in the mission and made editable)
  • cost: Number - cost of the object
  • costWithCrew (Optional): Number - cost of the object with crew in it (affects only vehicles). When undefined, normal cost is used.

Example of the whole event handler:

myCurator addEventHandler [
	"CuratorObjectRegistered",
	{
		_classes = _this select 1;
		_costs = [];
		{
			_cost = if (_x isKindOf "Man") then {[true,0.1]} else {[false,0]}; // Show only objects of type "Man", hide everything else
			_costs = _costs + [_cost];
		} forEach _classes; // Go through all classes and assign cost for each of them
		_costs
	}
];

Automated Assigning

Alternatively, you can use scripting functions which will simplify cost settings:

Action Coefficients

Once you assigned cost to every object, you can now use it for every action curator can perform.

myCurator setCuratorCoef ["place",-0.1];


Unlocking Addons

Editable Objects

Editing Areas

Camera Areas