op2_sdk:textdialogbox

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
op2_sdk:textdialogbox [2016/03/28 13:35] – vagabondop2_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 box can be opened when a new colony mission is started to give background story and mission briefings. +The Outpost 2 SDK supports adding custom dialog boxes during single player scenarios. Often dialog boxes are used to provide mission briefings or background story for colony missions. Sierra's odasl library can format dialog boxes to match the Outpost 2 UI theme.
  
-Creating the text dialog box programmatically requires the following steps+Creating an Outpost themed text dialog box requires the following steps:
  
   * Write up the briefing/backstory in rich text format (RTF).   * Write up the briefing/backstory in rich text format (RTF).
   * 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 18: Line 19:
 Typically, the RTF file is saved as briefing.rtf and added to the root directory of the scenario's project. Typically, the RTF file is saved as briefing.rtf and added to the root directory of the scenario's project.
  
-**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.//+**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 49: Line 50:
 To add a resource script file and associated resource header: 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.+  - Right click on your project in the solution explorer. -> Add -> New Item... -> Visual C++ -> Resource -> Resource File (.rc) -> Add. (Using the default filename is fine.)
  
-Resource Scripts by default is 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 in the resource script file. Alternative programs like Resource Hacker can also load Resource Scripts.+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 in the resource script file. Alternative programs like Resource Hacker can also load Resource Scripts.
  
 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. 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.
Line 57: Line 58:
 For more information on TEXTINCLUDE, see: https://msdn.microsoft.com/en-us/library/6t3612sk.aspx. For more information on TEXTINCLUDE, see: https://msdn.microsoft.com/en-us/library/6t3612sk.aspx.
  
-#ifdef //identifier// - If defined directive. Execute the code if the identifier is defined.+**Common Pre-processor Directives:**
  
-#ifndef //identifier// - If not defined directive. Execute the code if the identifier is not defined. +  * #ifdef //identifier// - If defined directive. Execute the code if the identifier is defined. 
- +  * #ifndef //identifier// - If not defined directive. Execute the code if the identifier is not defined. 
-#undef //identifier// - Undefined directive. Removes the definition of an identifier.+  * #undef //identifier// - Undefined directive. Removes the definition of an identifier.
  
 +**Resource Script Sample**
 <code cpp> <code cpp>
 // Microsoft Visual C++ generated resource script. // Microsoft Visual C++ generated resource script.
Line 221: 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, IDB_PIC, IDD_MISSIONINFO, IDC_TEXTAREA, and IDC_PIC. These values are represented in the resource script.
  
 Microsoft Resource Naming and Numbering Conventions can be reviewed here: https://msdn.microsoft.com/en-us/library/t2zechd4.aspx. Microsoft Resource Naming and Numbering Conventions can be reviewed here: https://msdn.microsoft.com/en-us/library/t2zechd4.aspx.
Line 235: 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>
 //{{NO_DEPENDENCIES}} //{{NO_DEPENDENCIES}}
 // Microsoft Visual C++ generated include file. // Microsoft Visual C++ generated include file.
-// Used by RisingFromTheAshes.rc+// Used by Resource.rc
 // //
 #define IDR_MISSIONTEXT                 102 #define IDR_MISSIONTEXT                 102
Line 261: 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 should be called from the beginning of ''InitProc''. You will have to include the Sierra library odasl.h in your project.+Once the resource script and resource header have been included, the briefing screen must be initialized from the code. You will also have to include the Sierra library odasl in your project to ensure the dialog is formatted similar to other Outpost 2 menus.
  
-First, you will require a handle to the DLL instance from DllMain.+  - 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 a reference to the DLL instance from DllMain (HINSTANCE hInst). 
 +  - 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 ''InitiProc''. 
 + 
 +**Defining a handle to the DLL instance from DllMain:**
  
 **DllMain.cpp** **DllMain.cpp**
Line 285: Line 295:
 </code> </code>
  
-**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 365: Line 377:
  - //Go Back to [[op2_sdk:software_development_kit_sdk|Outpost 2 Mapmaking]]//\\  - //Go Back to [[op2_sdk:software_development_kit_sdk|Outpost 2 Mapmaking]]//\\
  - //Go Back to [[outpost_2:outpost_2|Outpost 2 Main page]]//\\  - //Go Back to [[outpost_2:outpost_2|Outpost 2 Main page]]//\\
- - //Go Back to [[http://wiki.outpostuniverse.org/doku.php?id=start|Wiki Home Page]]//+ - //Go Back to [[http://wiki.outpost2.net/doku.php?id=start|Wiki Home Page]]//
  • op2_sdk/textdialogbox.1459172132.txt.gz
  • Last modified: 2016/03/28 13:35
  • by vagabond