ORBAT Viewer – Arma 3

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
Line 6: Line 6:
  class 7thInfantry
  class 7thInfantry
  {
  {
  {{codecomment|// Unit ID}}
  id = 7; {{codecomment|// Unit ID}}
  id = 7;
  idType = 0; {{codecomment|// Unit ID type}}
{{codecomment|// Unit ID type}}
  {{codecomment| // 0 - show as ordinal number, e.g. "7th" (default)}}
  {{codecomment|// 0 - show as ordinal number, e.g. "7th" (default)}}
  {{codecomment| // 1 - show as roman numeral, e.g. "VII"}}
  {{codecomment|// 1 - show as roman numeral, e.g. "VII"}}
  {{codecomment| // 2 - show as NATO phonetical alphabet word, e.g. "Golf"}}
  {{codecomment|// 2 - show as NATO phonetical alphabet word, e.g. "Golf"}}
                 {{codecomment| // 3 - show as color, e.g. "Red"}}
                 {{codecomment|//       3 - show as color, e.g. "Red"}}
           
  idType = 0;
  side = "West"; {{codecomment|// Unit side from CfgChainOfCommand >> Sides}}
{{codecomment|// Unit side from CfgChainOfCommand >> Sides}}
  size = "Division"; {{codecomment|// Unit size from CfgChainOfCommand >> Sizes}}
  side = "West";
  type = "HQ"; {{codecomment|// Unit type from CfgChainOfCommand >> Types}}
{{codecomment|// Unit size from CfgChainOfCommand >> Sizes}}
  insignia = "\ca\missions_f\data\orbat\7thInfantry_ca.paa"; {{codecomment|// Unit insignia, displayed in ORBAT background and in tooltip}}
  size = "Division";
  colorInisgnia[] = {0,0,1,1}; {{codecomment|// Insignia image color (white default), can be either RGBA array, or class from CfgMarkerColors}}
{{codecomment|// Unit type from CfgChainOfCommand >> Types}}
  commander = "Armstrong"; {{codecomment|// Name of unit commander. Can be either direct name, or class from CfgWorlds >> GenericNames (random name from the list is then selected)}}
  type = "HQ";
  commanderRank = "GENERAL"; {{codecomment|// Rank of unit commander (by default selected based on unit size)}}
  tags[] = {BIS,USArmy,Kerry,Hutchison,Larkin}; {{codecomment|// Group tags. When opening ORBAT viewer, user can define what tags will be accepted.}}
{{codecomment|// Unit insignia, displayed in ORBAT background and in tooltip}}
  text = "%1 Combat Technology Research %3";
  insignia = "\ca\missions_f\data\orbat\7thInfantry_ca.paa";
{{codecomment|// Insignia image color, white by default}}
{{codecomment|// Can be either RGBA array, or class from CfgMarkerColors}}
  colorInisgnia[] = {0,0,1,1};
{{codecomment|// Name of unit commander}}
{{codecomment|// - can be either direct name, or class from CfgWorlds >> GenericNames (random name from the list is then selected)}}
  commander = "Armstrong";
{{codecomment|// Rank of unit commander (by default selected based on unit size)}}
  commanderRank = "GENERAL";
{{codecomment|// Group tags. When opening ORBAT viewer, user can define what tags will be accepted.}}
  tags[] = {BIS,USArmy,Kerry,Hutchison,Larkin};
{{codecomment|// ALTERNATIVE SETTINGS}}
  {{codecomment|// Custom text and short text, can still use some arguments when defined:}}
  {{codecomment|// Custom text and short text, can still use some arguments when defined:}}
  {{codecomment|// %1 - ID (e.g. "7th")}}
  {{codecomment|// %1 - ID (e.g. "7th")}}
  {{codecomment|// %2 - Type (e.g. "Infantry")}}
  {{codecomment|// %2 - Type (e.g. "Infantry")}}
  {{codecomment|// %3 - Size (e.g. "Division")}}
  {{codecomment|// %3 - Size (e.g. "Division")}}
text = "%1 Combat Technology Research %3";
  textShort = "%1 CTR %3";
  textShort = "%1 CTR %3";
{{codecomment|// Custom texture, will replace icon set by 'type' param.}}
  texture = "\ca\missions_f\data\orbat\customTexture_ca.paa"; {{codecomment|// Custom texture, will replace icon set by 'type' param.}}
  texture = "\ca\missions_f\data\orbat\customTexture_ca.paa";
  color[] = {0,0,1,1}; {{codecomment|// Custom color, will replace color set by 'side' param. Can be either RGBA array, or class from CfgMarkerColors}}
{{codecomment|// Custom color, will replace color set by 'side' param.}}
                description= "All of your text would go here."; {{codecomment|// A brief description of the group or unit.}}
{{codecomment|// Can be either RGBA array, or class from CfgMarkerColors}}
  assets[] = {{B_Heli_Transport_03_F,5},{B_Heli_Light_01_F,3},{B_Heli_Light_01_armed_F,4},B_Heli_Transport_01_camo_F}; {{codecomment|// Will display pictures of all available assets to the unit commander}}
  color[] = {0,0,1,1};
  subordinates[] = {2ndBCT}; {{codecomment|// Subordinates, searched on the same level as this class.}}
 
                {{codecomment|// A brief description of the group or unit.}}
                description= "All of your text would go here.";
                {{codecomment|// Assets, will display a picture of available assets to the unit. Assets can be found here: https://community.bistudio.com/wiki/Arma_3_Assets}}
  assets[] = {{B_Heli_Transport_03_F,5},{B_Heli_Light_01_F,3},{B_Heli_Light_01_armed_F,4},B_Heli_Transport_01_camo_F};
 
  {{codecomment|// Subordinates, searched on the same level as this class.}}
subordinates[] = {2ndBCT};
  
  
                 {{codecomment|// When 'subordinates' are missing, child classes will be used. They can have their own subs - number of tiers is not limited.}}
                 {{codecomment|// When 'subordinates' are missing, child classes will be used. They can have their own subs - number of tiers is not limited.}}

Revision as of 10:59, 13 February 2015

A3 ORBATViewer.jpg

Config

class CfgORBAT
{
	class 7thInfantry
	{
		id = 7; // Unit ID
		idType = 0; // Unit ID type
		 // 0 - show as ordinal number, e.g. "7th" (default)
		 // 1 - show as roman numeral, e.g. "VII"
		 // 2 - show as NATO phonetical alphabet word, e.g. "Golf"
                // 3 - show as color, e.g. "Red"
           
		side = "West"; // Unit side from CfgChainOfCommand >> Sides
		size = "Division"; // Unit size from CfgChainOfCommand >> Sizes
		type = "HQ"; // Unit type from CfgChainOfCommand >> Types
		insignia = "\ca\missions_f\data\orbat\7thInfantry_ca.paa"; // Unit insignia, displayed in ORBAT background and in tooltip
		colorInisgnia[] = {0,0,1,1}; // Insignia image color (white default), can be either RGBA array, or class from CfgMarkerColors
		commander = "Armstrong"; // Name of unit commander. Can be either direct name, or class from CfgWorlds >> GenericNames (random name from the list is then selected)
		commanderRank = "GENERAL"; // Rank of unit commander (by default selected based on unit size)
		tags[] = {BIS,USArmy,Kerry,Hutchison,Larkin}; // Group tags. When opening ORBAT viewer, user can define what tags will be accepted.
		text = "%1 Combat Technology Research %3";
		// Custom text and short text, can still use some arguments when defined:
		// 	%1 - ID (e.g. "7th")
		// 	%2 - Type (e.g. "Infantry")
		// 	%3 - Size (e.g. "Division")
		textShort = "%1 CTR %3";
		texture = "\ca\missions_f\data\orbat\customTexture_ca.paa"; // Custom texture, will replace icon set by 'type' param.
		color[] = {0,0,1,1}; // Custom color, will replace color set by 'side' param. Can be either RGBA array, or class from CfgMarkerColors
                description= "All of your text would go here."; // A brief description of the group or unit.
		assets[] = {{B_Heli_Transport_03_F,5},{B_Heli_Light_01_F,3},{B_Heli_Light_01_armed_F,4},B_Heli_Transport_01_camo_F}; // Will display pictures of all available assets to the unit commander
		subordinates[] = {2ndBCT}; // Subordinates, searched on the same level as this class.
 		
               // When 'subordinates' are missing, child classes will be used. They can have their own subs - number of tiers is not limited.
		class 1stBCT
		{
			id = 1;
			type = "Armored";
			size = "BCT";
			side = "West";
			commander = "NATOMen";
			tags[] = {"BLUFOR", "USArmy","Kerry"};
 		};
	};
	class 2ndBCT
	{
	};
};

Possible values of side attribute:

  • West
  • East
  • Resistance
  • Civilian
  • Unknown

Possible values of size attribute:

  • FireTeam
  • Squad
  • Section
  • Platoon
  • Company
  • Troop
  • Battalion
  • Squadron
  • Regiment
  • Brigade
  • BCT
  • IBCT
  • HBCT
  • Division
  • Corps
  • Army
  • ArmyGroup

Possible values of type attribute:

  • Unknown
  • Infantry
  • MotorizedInfantry
  • MechanizedInfantry
  • Armored
  • Recon
  • Cavalry
  • Airborne
  • Helicopter
  • CombatAviation
  • AttackRecon
  • GeneralSupport
  • Assault
  • AviationSupport
  • Fighter
  • UAV
  • Medical
  • Artillery
  • Mortar
  • HQ
  • Support
  • Maintenance
  • Service
  • Maritime


Possible values of rank attribute:

  • Private
  • Corporal
  • Sergeant
  • Lieutenant
  • Captain
  • Major
  • Colonel

Module Parameters

CfgORBAT Path

The group you want this module to display.

Example: 

missionconfigfile >> "CfgORBAT" >> "unitClassName" >> "subordinateUnitClassName"

CfgORBAT Ceiling

The highest superior unit to display in the ORBAT viewer while this group is selected.

Example: 

missionconfigfile >> "CfgORBAT" >> "unitClassName"

Tags

Max. Tiers

Other

  • To make the ORBAT icon follow a unit during a mission, simply Synchronise (F5) the module to the group leader.
Retrieved from "https://community.bistudio.com/wiki?title=Arma_3:_ORBAT_Viewer&oldid=87728"