Difference between revisions of "PrintToLog"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Generated by Sunjammer's Dragon Age Script Paser)
 
m (Removing surplus whitespae)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Generated with errors}}
 
 
{{dafunction
 
{{dafunction
 
|name=PrintToLog
 
|name=PrintToLog
Line 5: Line 4:
 
|param1type=string
 
|param1type=string
 
|param1name=sMessage
 
|param1name=sMessage
|param1desc=
+
|param1desc=The string entry to print to the log file.
 
|returntype=void
 
|returntype=void
 
|returndesc=
 
|returndesc=
Line 11: Line 10:
 
|sourcemodule=
 
|sourcemodule=
 
}}
 
}}
 
 
== Description ==
 
== Description ==
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
 
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
Prints a timestamped string entry to the log file. Note this will only be visible if Script logging is enabled. To enable, edit \\tag\main\build\bin_release\ECLog.ini and set Script=1 in the [LogTypes] section.
+
Prints an entry to the log file. Note this will only be visible if Script logging is enabled. To enable script logging open the <code><DragonAgeInstallDirectory>\bin_ship\[[ECLog.ini]]</code> file and set <code>Script=1</code> in the <code>[LogTypes]</code> section. If this file doesn't exist, create it.
 
+
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
<!-- This section contains additional comments, observations and known issues. -->
 
 
<!-- == Examples == -->
 
<!-- == Examples == -->
 
<!-- This section contains examples transcluded from the snippet library. -->
 
<!-- This section contains examples transcluded from the snippet library. -->
Line 26: Line 22:
 
[[PrintInteger]], [[PrintFloat]], [[PrintString]], [[PrintObject]], [[PrintVector]]
 
[[PrintInteger]], [[PrintFloat]], [[PrintString]], [[PrintObject]], [[PrintVector]]
 
[[Category: Print & log functions]]
 
[[Category: Print & log functions]]
 +
[[Category:Logging]]

Latest revision as of 00:16, 8 May 2012

Prints a timestamped entry to the log file.

void PrintToLog(
string sMessage
);
Parameters:
sMessage
The string entry to print to the log file.
Returns:

Nothing.

Source:

script.ldf

Description

Prints an entry to the log file. Note this will only be visible if Script logging is enabled. To enable script logging open the <DragonAgeInstallDirectory>\bin_ship\ECLog.ini file and set Script=1 in the [LogTypes] section. If this file doesn't exist, create it.

See also

PrintInteger, PrintFloat, PrintString, PrintObject, PrintVector