Difference between revisions of "Bool (2da type)"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (moved Bool to Bool (2da type))
m
Line 10: Line 10:
 
Note: the scripting language doesn't have a function for retrieving boolean values from a 2DA, and the behavior of Get2DAInt when retrieving a boolean is untested. It is probably safer to just use an integer for scripting purposes.
 
Note: the scripting language doesn't have a function for retrieving boolean values from a 2DA, and the behavior of Get2DAInt when retrieving a boolean is untested. It is probably safer to just use an integer for scripting purposes.
  
== In scripts ==
+
[[Category: 2da types]]
 
+
The DA scripting language doesn't have an explicit boolean data type. Instead, it uses integer values. A 0 is used to represent "false", and any non-zero integer represents "true". The following constants are defined:
+
 
+
{{Constant table start
+
|sourcefile=script.ldf
+
|sourcemodule=
+
}}
+
{{Constant table row
+
|name=FALSE
+
|type=int
+
|value=0
+
|description=
+
|sourcefile=script.ldf
+
|sourcemodule=
+
}}
+
{{Constant table row
+
|name=TRUE
+
|type=int
+
|value=1
+
|description=
+
|sourcefile=script.ldf
+
|sourcemodule=
+
}}
+
{{Constant table end}}
+
 
+
Note that if you test for a variable's truth value by testing if it's equal to TRUE you may not get the correct result, since TRUE == 1 but not TRUE == 2. You may wish to instead test if your variable is not equal to FALSE.
+
 
+
<!-- == Remarks == -->
+
<!-- This section contains additional comments, observations and known issues. -->
+
 
+
<!-- == Examples == -->
+
<!-- This section contains examples transcluded from the snippet library. -->
+
 
+
<!-- == See also == -->
+
<!-- This section contains links to articles, functions or constant groups. -->
+
 
+
[[Category:Uncategorised constants]]
+
 
+
[[Category:data types]]
+

Revision as of 19:34, 30 July 2009

In 2DAs

The 'bool' (boolean) data type is supported by 2DAs. In the Excel source file a bool value may be represented by one of:

  • a zero or non-zero number
  • Yes or No (case insensitive)
  • words beginning with T or F (such as True! and False!)

NOTE: You cannot use TRUE and FALSE because Excel converts those to a special keyword the binarizer can't parse properly at this time.

Note: the scripting language doesn't have a function for retrieving boolean values from a 2DA, and the behavior of Get2DAInt when retrieving a boolean is untested. It is probably safer to just use an integer for scripting purposes.