Content Overview: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "Category:Take On Helicopters: Editing Overview is simple text describing game content in menu list. == Overview.html == ''Main article: Overview.html'' The overview.htm...")
 
m (Text replacement - "{{SideTOC}}" to "{{TOC|side}}")
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Category:Take On Helicopters: Editing]]
{{TOC|side}}
Overview is simple text describing game content in menu list.
Overview is simple text describing game content in menu list.


== Overview.html ==
== Overview.html ==
''Main article: [[Overview.html]]''
''Main article: [[Overview.html]]''


The overview.html contains simple mission description and picture visible in main menu mission selection.
The overview.html contains simple mission description and picture visible in main menu mission selection.


== Config ==
 
{{Versions|
{{ArgTitle|Config|2|{{GVI|tkoh|1.00}}}}
[[Image:TKOH_1.00.gif]]
 
|-4}}
[[Take On Helicopters]] introduces ability to define overviews in config, making overview.html obsolete.
[[Take On Helicopters]] introduces ability to define overviews in config, making overview.html obsolete.


Line 17: Line 18:
Among other advantages of new format are easy maintenance (config supports [[PreProcessor_Commands|macros]] and inheriting) and replacement of HTML [[Control]] with more versatile [[Structured Text]].
Among other advantages of new format are easy maintenance (config supports [[PreProcessor_Commands|macros]] and inheriting) and replacement of HTML [[Control]] with more versatile [[Structured Text]].


It's compatible with:
It is compatible with:
* CfgMissions
* CfgMissions
** Campaigns
** Campaigns
Line 33: Line 34:


=== Params ===
=== Params ===
==== overviewText ====
==== overviewText ====
[[String]], which is converted to [[Structured Text]] in game.
[[String]], which is converted to [[Structured Text]] in game.
overviewText = "This mission is extraodninarly splendid";
<syntaxhighlight lang="cpp">overviewText = "This mission is extraodinarly splendid";</syntaxhighlight>


==== overviewPicture ====
==== overviewPicture ====
Line 41: Line 43:
* 2:1 aspect ratio for ''CfgMissions''
* 2:1 aspect ratio for ''CfgMissions''
* 1:1 aspect ratio for ''CfgWorlds''
* 1:1 aspect ratio for ''CfgWorlds''
overviewPicture = "hsim\missions_h\data\overview_us_core_ca.paa";
<syntaxhighlight lang="cpp">overviewPicture = "hsim\missions_h\data\overview_us_core_ca.paa";</syntaxhighlight>


=== Sample config ===


=== Sample config ===
<syntaxhighlight lang="cpp">
<code>
class CfgMissions
class CfgMissions
{
{
Line 53: Line 55:
{
{
directory = "hsim\missions_h\campaign";
directory = "hsim\missions_h\campaign";
'''overviewText''' = $STR_hsim_overview_us_campaign;
overviewText = $STR_hsim_overview_us_campaign;
'''overviewPicture''' = "hsim\missions_h\data\overview_us_core_ca.paa";
overviewPicture = "hsim\missions_h\data\overview_us_core_ca.paa";
};
};
};
};
Line 62: Line 64:
{
{
directory = "HSim\Missions_H\campaign\missions\Proc_United_States_H.United_States_H";
directory = "HSim\Missions_H\campaign\missions\Proc_United_States_H.United_States_H";
'''overviewText''' = $STR_hsim_overview_missionVisit;
overviewText = $STR_hsim_overview_missionVisit;
'''overviewPicture''' = "hsim\missions_h\data\missionVisit_ca.paa";
overviewPicture = "hsim\missions_h\data\missionVisit_ca.paa";
};
};
};
};
};
};
</code>
</syntaxhighlight>
 
 
[[Category:Take On Helicopters: Editing]]

Revision as of 07:04, 29 December 2020

Overview is simple text describing game content in menu list.


Overview.html

Main article: Overview.html

The overview.html contains simple mission description and picture visible in main menu mission selection.


2

Take On Helicopters introduces ability to define overviews in config, making overview.html obsolete.

Main motivation was to unify overviews in a style, so presentation of community content will look as well as of the official one. This was sometimes difficult before, as overview images were using custom frames or shadows, which community have no access to.

Among other advantages of new format are easy maintenance (config supports macros and inheriting) and replacement of HTML Control with more versatile Structured Text.

It is compatible with:

  • CfgMissions
    • Campaigns
    • Missions
    • TimeTrials
    • Tutorial
  • CfgWorlds

Config overview cannot be used where no config exists, such as missions or campaigns placed directly in Missions or Campaigns folders.

Params

overviewText

String, which is converted to Structured Text in game.

overviewText = "This mission is extraodinarly splendid";

overviewPicture

Path to mission picture. It doesn't need any external preparation and only requirement are:

  • 2:1 aspect ratio for CfgMissions
  • 1:1 aspect ratio for CfgWorlds
overviewPicture = "hsim\missions_h\data\overview_us_core_ca.paa";

Sample config

class CfgMissions
{
	class Campaigns
	{
		class BIS_HSim_US
		{
			directory = "hsim\missions_h\campaign";
			overviewText = $STR_hsim_overview_us_campaign;
			overviewPicture = "hsim\missions_h\data\overview_us_core_ca.paa";
		};
	};
	class Missions
	{
		class Visit
		{
			directory = "HSim\Missions_H\campaign\missions\Proc_United_States_H.United_States_H";
			overviewText = $STR_hsim_overview_missionVisit;
			overviewPicture = "hsim\missions_h\data\missionVisit_ca.paa";
		};
	};
};