FACT Token - Revision history

Vest: Files are actually called *_datacontrols.lst

2023-07-03T08:17:19Z

Files are actually called *_datacontrols.lst

Tom Parker at 04:06, 23 January 2015

2015-01-23T04:06:57Z

Tom Parker: /* REQUIRED */

2015-01-23T04:02:05Z

‎REQUIRED

Tom Parker at 15:24, 17 January 2015

2015-01-17T15:24:26Z

Tom Parker: /* DATAFORMAT */

2015-01-17T15:23:58Z

‎DATAFORMAT

Tom Parker: /* Data Control LST Contents */

2015-01-17T15:22:57Z

‎Data Control LST Contents

Tom Parker: /* Base Token (FACT) */

2015-01-17T04:00:05Z

‎Base Token (FACT)

Tom Parker: /* First Token (FACTDEF) */

2015-01-17T03:58:45Z

‎First Token (FACTDEF)

Tom Parker at 21:35, 14 January 2015

2015-01-14T21:35:02Z

Tom Parker: /* DATATYPE */

2015-01-14T04:10:15Z

‎DATATYPE

@@ Line 59: / Line 59: @@
   y is the factual value
-An identifier (x above) must have been defined in a FACTDEF line in a DATACONTROL LST file.
+An identifier (x above) must have been defined in a FACTDEF line in a DATACONTROL LST file (*_datacontrols.lst).
 FACT by default overwrites.

@@ Line 251: / Line 251: @@
 "x" matches the same strings used in the output file, which are shown on the [[FreeMarker Facet Output]] page.  In some cases, an additional piece of information is required, for example:
   PREFACT:1,EQUIPMENT.EQUIPPED,COLOR=Red
 =Code Team Awareness=

← Older revision		Revision as of 04:02, 23 January 2015
Line 209:		Line 209:

	As caution to the data team: Use of this forces it across ALL loaded data, NOT JUST DATA FROM THE LOCAL PCC FILE. That likely means this is used sparingly, and only in base sets, otherwise the additional sets would have to .MOD a lot of stuff...		As caution to the data team: Use of this forces it across ALL loaded data, NOT JUST DATA FROM THE LOCAL PCC FILE. That likely means this is used sparingly, and only in base sets, otherwise the additional sets would have to .MOD a lot of stuff...
		+
		+	WARNING: A FACTDEF where the "x" value of the FACTDEF token is "GLOBAL" MUST NOT be Required. Using REQUIRED:YES on a global FACTDEF will cause a load error.

	===DISPLAYNAME===		===DISPLAYNAME===

@@ Line 97: / Line 97: @@
 A Second FACTDEF with matching values here but different DATAFORMAT: will produce an error, since you have two conflicting items with the same identifier.
-Duplicate FACTDEF with matching x, y and DATAFORMAT: are legal (thus allowing it to be present in multiple sources), but other tokens on the line are CUMULATIVE (dupe entries even in different files ACT LIKE A MOD, see DATATYPE for the exception)
+Duplicate FACTDEF with matching x, y and DATAFORMAT: are legal (thus allowing it to be present in multiple sources), but other tokens on the line are CUMULATIVE (dupe entries even in different files ACT LIKE A MOD, see DATAFORMAT for the exception)
 GLOBAL is a legal x value.   Other legal values for x (those followed by * are currently enabled in the demo)
@@ Line 120: / Line 120: @@
 +: If you are going to use Abilities, you need to understand how they are "wrapped" - they are NOT like other objects and cannot be accessed directly, see [[FreeMarker Facet Output]]
-WARNING: Any time a "y" value is used with a specific DATATYPE, it is required that ALL FACTDEF entries with that "y" value (regardless of the "x" value) have the same DATATYPE.  This is due to some internal mechanics of PCGen which shares infrastructure.  We will evaluate loosening up this limitation, but since it may add complexity to PREFACT, it may not be worth it...
+WARNING: Any time a "y" value is used with a specific DATAFORMAT, it is required that ALL FACTDEF entries with that "y" value (regardless of the "x" value) have the same DATAFORMAT.  This is due to some internal mechanics of PCGen which shares infrastructure.  We will evaluate loosening up this limitation, but since it may add complexity to PREFACT, it may not be worth it...
 ===DATAFORMAT===

@@ Line 126: / Line 126: @@
   DATAFORMAT:x
-This token is REQUIRED.  A FACTDEF with no DATAFORMATwill produce an LST load error.
+This token is REQUIRED.  A FACTDEF with no DATAFORMAT will produce an LST load error.
 Note: The "x" Items will be hardcoded.  In addition to "STRING", it is expected that the same items that are valid as the [http://pcgen.org/autobuilds/pcgen-docs/listfilepages/globalfilestagpages/globalfilesother.html#QUALIFY "x" value of QUALIFY] (the existing Global token) would also be legal here.

@@ Line 95: / Line 95: @@
 This token MUST appear as the first token on the line in the file.
-A Second FACTDEF with matching values here but different DATATYPE: will produce an error, since you have two conflicting items with the same identifier.
+A Second FACTDEF with matching values here but different DATAFORMAT: will produce an error, since you have two conflicting items with the same identifier.
-Duplicate FACTDEF with matching x, y and DATATYPE: are legal (thus allowing it to be present in multiple sources), but other tokens on the line are CUMULATIVE (dupe entries even in different files ACT LIKE A MOD, see DATATYPE for the exception)
+Duplicate FACTDEF with matching x, y and DATAFORMAT: are legal (thus allowing it to be present in multiple sources), but other tokens on the line are CUMULATIVE (dupe entries even in different files ACT LIKE A MOD, see DATATYPE for the exception)
 GLOBAL is a legal x value.   Other legal values for x (those followed by * are currently enabled in the demo)
@@ Line 122: / Line 122: @@
 WARNING: Any time a "y" value is used with a specific DATATYPE, it is required that ALL FACTDEF entries with that "y" value (regardless of the "x" value) have the same DATATYPE.  This is due to some internal mechanics of PCGen which shares infrastructure.  We will evaluate loosening up this limitation, but since it may add complexity to PREFACT, it may not be worth it...
-===DATATYPE===
+===DATAFORMAT===
-  DATATYPE:x
+  DATAFORMAT:x
-This token is REQUIRED.  A FACTDEF with no DATATYPE will produce an LST load error.
+This token is REQUIRED.  A FACTDEF with no DATAFORMATwill produce an LST load error.
 Note: The "x" Items will be hardcoded.  In addition to "STRING", it is expected that the same items that are valid as the [http://pcgen.org/autobuilds/pcgen-docs/listfilepages/globalfilestagpages/globalfilesother.html#QUALIFY "x" value of QUALIFY] (the existing Global token) would also be legal here.
-Note: This is an exception to a duplicate FACTDEF: acting as a MOD.  Specifically, A DATATYPE: with a type that does not match a previous value will produce an error, since you have two conflicting FACTs with the same identifier.
+Note: This is an exception to a duplicate FACTDEF: acting as a MOD.  Specifically, A DATAFORMAT: with a type that does not match a previous value will produce an error, since you have two conflicting FACTs with the same identifier.
 Legal Values for x:
@@ Line 156: / Line 156: @@
 For example:
-  FACTDEF:DEITY|Symbol <> DATATYPE:STRING <> VISIBLE:EXPORT
+  FACTDEF:DEITY|Symbol <> DATAFORMAT:STRING <> VISIBLE:EXPORT
 EXPORT or YES would enable the output in Freemarker:
@@ Line 179: / Line 179: @@
 For example:
-  FACTDEF:DEITY|Align <> DATATYPE:ALIGNMENT <> VISIBLE:YES <> SELECTABLE:YES
+  FACTDEF:DEITY|Align <> DATAFORMAT:ALIGNMENT <> VISIBLE:YES <> SELECTABLE:YES
 SELECTABLE:YES enables use in a CHOOSE:
@@ Line 202: / Line 202: @@
 For example:
-  FACTDEF:DEITY|Align <> DATATYPE:ALIGNMENT <> VISIBLE:YES <> REQUIRED:YES
+  FACTDEF:DEITY|Align <> DATAFORMAT:ALIGNMENT <> VISIBLE:YES <> REQUIRED:YES
 This would then trigger an LST load error if a Deity did not have the "ALIGN" Fact assigned.

← Older revision		Revision as of 04:00, 17 January 2015
Line 72:		Line 72:

	.CLEAR will be supported as a "y" value, and it will clear just the fact for the single identifier. If .CLEAR appears as a y value, it MUST be alone, it cannot be chained with a valid FACT.		.CLEAR will be supported as a "y" value, and it will clear just the fact for the single identifier. If .CLEAR appears as a y value, it MUST be alone, it cannot be chained with a valid FACT.
		+
		+	It is important to note that FACT cannot be used in a Campaign (PCC) file. This is because the Campaign files must be loaded to know what the data control files are, and then the data control files define what FACTs are legal. This is a race condition we do not intend to work around. FACT is simply not legal in Campaign files.

	==PCC (Campaign) LST token (DATACONTROL)==		==PCC (Campaign) LST token (DATACONTROL)==

@@ Line 238: / Line 238: @@
   PREFACT:w,x,y=z
   w is a number
-  x is the type (e.g. DIETY)
+  x is the type (e.g. DEITY)
   y is the identifier (e.g. SYMBOL)
   z is the required value
 For example:
-  PREFACT:1,DIETY,SYMBOL=Star
+  PREFACT:1,DEITY,SYMBOL=Star
 "x" matches the same strings used in the output file, which are shown on the [[FreeMarker Facet Output]] page.  In some cases, an additional piece of information is required, for example:

@@ Line 133: / Line 133: @@
 ALIGNMENT
 BOOLEAN
 GRIDPOINT
 NUMBER
 STAT
 STRING