Difference between revisions of "PrintFloat"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Generated by Sunjammer's Dragon Age Script Paser)
 
m (remove tag)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Generated}}
 
 
{{dafunction
 
{{dafunction
 
|name=PrintFloat
 
|name=PrintFloat
Line 6: Line 5:
 
|param1name=fFloat
 
|param1name=fFloat
 
|param1desc=The float value to print out to the log
 
|param1desc=The float value to print out to the log
 +
|param1default=
 
|param2type=int
 
|param2type=int
 
|param2name=nWidth
 
|param2name=nWidth
 
|param2desc=The size of the value before the decimal. Must be a value between 0 and 18 inclusive
 
|param2desc=The size of the value before the decimal. Must be a value between 0 and 18 inclusive
 +
|param2default=18
 
|param3type=int
 
|param3type=int
 
|param3name=nDecimals
 
|param3name=nDecimals
 
|param3desc=The number of decimal places. Must be a value between 0 and 9 inclusive
 
|param3desc=The number of decimal places. Must be a value between 0 and 9 inclusive
 +
|param3default=9
 
|param4type=int
 
|param4type=int
 
|param4name=bPrepend
 
|param4name=bPrepend
 
|param4desc=Specifies if the type of value should be prepended on to the log string
 
|param4desc=Specifies if the type of value should be prepended on to the log string
 +
|param4default=FALSE
 
|returntype=void
 
|returntype=void
 
|returndesc=
 
|returndesc=

Latest revision as of 21:55, 11 February 2010

Prints a float to the log file.

void PrintFloat(
float fFloat,
int nWidth = 18,
int nDecimals = 9,
int bPrepend = FALSE
);
Parameters:
fFloat
The float value to print out to the log
nWidth
The size of the value before the decimal. Must be a value between 0 and 18 inclusive
nDecimals
The number of decimal places. Must be a value between 0 and 9 inclusive
bPrepend
Specifies if the type of value should be prepended on to the log string
Returns:

Nothing.

Source:

script.ldf

Description

Prints the float fFloat to the log file based on the nWidth and nDecimal specifications. If bPrepend is TRUE, then 'PRINTFLOAT' will be prepended onto the text outputted to the log file.


See also

PrintInteger, PrintString, PrintObject, PrintVector, PrintToLog