Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
op2_sdk:textdialogbox [2016/03/28 02:44] – vagabond | op2_sdk:textdialogbox [2016/12/28 19:03] (current) – vagabond | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== In Game Text Dialog Box ====== | ====== In Game Text Dialog Box ====== | ||
- | A text dialog | + | The Outpost 2 SDK supports adding custom |
- | Creating | + | Creating |
* Write up the briefing/ | * Write up the briefing/ | ||
* Add a resource script (.rc) to the project detailing the design of the dialog box. | * Add a resource script (.rc) to the project detailing the design of the dialog box. | ||
* Add a resource header file (typically resource.h) to the project providing a link between the resource script file and the rest of the source code. | * Add a resource header file (typically resource.h) to the project providing a link between the resource script file and the rest of the source code. | ||
+ | * Include odasl in your project. | ||
* Add code to the scenario that formats and opens the dialog screen through the windows API. | * Add code to the scenario that formats and opens the dialog screen through the windows API. | ||
Line 14: | Line 15: | ||
Rich Text Format documents include metadata such as font and text color which are not available in text (.txt) format. Depending on the program used to open an RTF, the metadata may be hidden. Microsoft Word and Wordpad will default to showing just the text and the effect of the metadata on the text. Notepad or Notepad++ will show all of the metadata. | Rich Text Format documents include metadata such as font and text color which are not available in text (.txt) format. Depending on the program used to open an RTF, the metadata may be hidden. Microsoft Word and Wordpad will default to showing just the text and the effect of the metadata on the text. Notepad or Notepad++ will show all of the metadata. | ||
- | Outpost 2 uses Arial font size 10 for Campaign Mission Briefing Screens. | + | For campaign mission briefing screens, |
- | **Note: | + | Typically, the RTF file is saved as briefing.rtf and added to the root directory of the scenario' |
+ | |||
+ | **Note:** Although Microsoft Word can create and save RTF documents, it is not recommended. Microsoft Word adds large amounts of metadata to the document that is not necessary for Outpost 2, typically increasing a small amount of text from about 3 kb to about 50 kb. This file size increase will carry into the compiled DLL. | ||
**Example RTF file** | **Example RTF file** | ||
Line 43: | Line 46: | ||
===== Adding a Resource Script (.rc) File ===== | ===== Adding a Resource Script (.rc) File ===== | ||
- | Microsoft Visual Studio will autogenerate | + | Resource script files are text documents describing resources associated with an executable or DLL. These include among other things Version Information, |
- | #ifdef // | + | To add a resource script file and associated resource header: |
+ | |||
+ | - Right click on your project in the solution explorer. -> Add -> New Item... -> Visual C++ -> Resource -> Resource File (.rc) -> Add. (Using the default filename | ||
+ | |||
+ | By default resource Scripts are placed in the Resource Files filter in the Solution Explorer. Use the Solution Explorer (or your favorite text editor) to open the file file in text view. You can also access the Resource Script from the Visual Studio Resource View, which defaults to opening on the left side of Visual Studio. The Resource View allows graphical depiction of Dialog Boxes defined | ||
+ | |||
+ | Below is a sample resource script file that provides a dialog box before a scenario is initialized. The dialog box will include the contents of briefing.rtf in a rich text box. | ||
For more information on TEXTINCLUDE, | For more information on TEXTINCLUDE, | ||
+ | **Common Pre-processor Directives: | ||
+ | |||
+ | * #ifdef // | ||
+ | * #ifndef // | ||
+ | * #undef // | ||
+ | |||
+ | **Resource Script Sample** | ||
<code cpp> | <code cpp> | ||
// Microsoft Visual C++ generated resource script. | // Microsoft Visual C++ generated resource script. | ||
Line 59: | Line 75: | ||
// Generated from the TEXTINCLUDE 2 resource. | // Generated from the TEXTINCLUDE 2 resource. | ||
// | // | ||
- | #include "afxres.h" | + | #include "winres.h" |
///////////////////////////////////////////////////////////////////////////// | ///////////////////////////////////////////////////////////////////////////// | ||
Line 120: | Line 136: | ||
2 TEXTINCLUDE | 2 TEXTINCLUDE | ||
BEGIN | BEGIN | ||
- | "# | + | "# |
" | " | ||
END | END | ||
Line 207: | Line 223: | ||
===== Resource.h | ===== Resource.h | ||
+ | |||
+ | Once the Resource Script is added, the project will not successfully compile until all required items are defined in the resource header. Visual Studio will automatically create a resource header when the resource script is created. Typically, 5 items are defined in resource script as shown in the sample below, IDR_MISSIONTEXT, | ||
Microsoft Resource Naming and Numbering Conventions can be reviewed here: https:// | Microsoft Resource Naming and Numbering Conventions can be reviewed here: https:// | ||
Line 221: | Line 239: | ||
**Note:** //0x prefix on a number indicates it is in hexadecimal form.// | **Note:** //0x prefix on a number indicates it is in hexadecimal form.// | ||
+ | **Resource Header Example** | ||
<code cpp> | <code cpp> | ||
// | // | ||
// Microsoft Visual C++ generated include file. | // Microsoft Visual C++ generated include file. | ||
- | // Used by RisingFromTheAshes.rc | + | // Used by Resource.rc |
// | // | ||
#define IDR_MISSIONTEXT | #define IDR_MISSIONTEXT | ||
Line 247: | Line 266: | ||
===== Creating the Dialog Box in Code ===== | ===== Creating the Dialog Box in Code ===== | ||
- | Once the resource script and resource header have been well formed, the briefing screen | + | Once the resource script and resource header have been included, the briefing screen |
- | First, you will require | + | - Add a reference to the Outpost2Dialog project, which can be found with the rest of the APIs. odasl.h and odasl.lib are contained in this project and are required to skin the Dialog Window in the Outpost 2 theme. |
+ | - Create | ||
+ | - Add code to initialize and open the window. Typically this code is placed in it's own cpp file named briefing.cpp. | ||
+ | - Call code to initialize the window from '' | ||
+ | |||
+ | **Defining a handle to the DLL instance from DllMain:** | ||
**DllMain.cpp** | **DllMain.cpp** | ||
Line 271: | Line 295: | ||
</ | </ | ||
- | **briefigin.h** | + | **Code used to initialize window. This also may be written without a header file.** |
+ | |||
+ | **briefing.h** | ||
<code cpp> | <code cpp> | ||
#pragma once | #pragma once | ||
Line 351: | Line 377: | ||
- //Go Back to [[op2_sdk: | - //Go Back to [[op2_sdk: | ||
- //Go Back to [[outpost_2: | - //Go Back to [[outpost_2: | ||
- | - //Go Back to [[http:// | + | - //Go Back to [[http:// |