Data LST Standards - Revision history

LegacyKing at 21:15, 30 January 2015

2015-01-30T21:15:29Z

2015-01-21T18:43:19Z

‎PCC Stuff

2014-09-17T07:43:01Z

‎General Variable Naming Standards

2014-05-18T03:25:49Z

2014-04-23T20:41:07Z

Updating to standards

2013-09-22T22:42:38Z

2012-11-11T01:07:50Z

2012-05-28T20:56:34Z

2011-09-09T12:14:42Z

Added Comments Standard section

2010-10-15T20:37:03Z

‎General Object Naming Standards

@@ Line 77: / Line 77: @@
 Our old Standard was to do variables for Classes in the class file. This is no longer optimal for the existing sets. All Classes that need to use 'CL' will replace 'CL' with '<ClassNameLVL>' and then move the Variable formula to the Ability it applies too.
-===General EQMOD Naming Standards===
+===PROPOSED General EQMOD Naming Standards===
 EQMOD keys 'KEY:EQMOD_NAME' are to be in all capital letters and may only contain letters, numbers and underscores ("_").
@@ Line 100: / Line 124: @@
 ===Special Usages===
 KEY use should follow the following format
@@ Line 297: / Line 329: @@
 [[Pathfinder RPG]]

@@ Line 264: / Line 264: @@
 <nowiki>#</nowiki> Data Files<br>
 ABILITY:>source short name<_abilities.lst<br>
-ABILITY:>source short name<_abilities_classes.lst<br>
+ABILITY:>source short name<_abilities_class.lst<br>
 ABILITY:>source short name<_abilities_companion.lst<br>
 ABILITY:>source short name<_abilities_equipment.lst<br>
@@ Line 272: / Line 272: @@
 BIOSET>source short name<_biosettings.lst<br>
 CLASS:>source short name<_classes.lst<br>
 COMPANIONMOD:>source short name<_companionmods.lst<br>
 DEITY:>source short name<_deities.lst<br>

@@ Line 67: / Line 67: @@
    DeathAttackDC
-There should be at least one, 'DEFINE' per variable and the DEFINE should be set at 0. All adjustments of the Variable will then use a BONUS:VAR statement. Per Code Silverback (James Dempsey): Define is evaluated once in the code, therefore using DEFINE to any value other than 0 can cause issues for characters. The exception we make is CLASS LINE - As this re-evaluates at each level change.
+There should be at least one, 'DEFINE' per variable and the DEFINE should be set at 0. All adjustments of the Variable will then use a BONUS:VAR statement. Per Code Silverback (James Dempsey): Define is evaluated once in the code, therefore using DEFINE to any value other than 0 can cause issues for characters. DEFINE is now required by CODE to be a value of 0, no exceptions.
 Only SYSTEM hard-coded variable names are all capitals. Any Data Team created variables are restricted to Mixed Case only.
@@ Line 76: / Line 76: @@
 Our old Standard was to do variables for Classes in the class file. This is no longer optimal for the existing sets. All Classes that need to use 'CL' will replace 'CL' with '<ClassNameLVL>' and then move the Variable formula to the Ability it applies too.
 ===General EQMOD Naming Standards===

@@ Line 5: / Line 5: @@
 Characters approved for use in object names are: upper and lower case letters, numbers, single spaces in between multiple words (never before or after) and the following glyphs: underscore (_), dash (-), apostrophe ('), parentheses (), slash (/), and a tilde (~).
-Characters which should never be used in object names are Commas (,), Pipes (|), Backslashes (\), Colons (:), Semicolons (;), Periods (.), Brackets ([]), Percent (%), Asterisk (*) and Equals (=).
+The following alpha characters shall not be used in object names: Comma (,), Pipe (|), Backslashe (\), Colon (:), Semicolon (;), Period (.), Bracket ([]), Percent (%), Asterisk (*) and Equals (=).
 Two words separated by a dash should both be capitalized. (Example: Low-Light Vision)

@@ Line 26: / Line 26: @@
 No Weaponprof may be called "DEITYWEAPON".
-No equipment (or eqmod ITYPE) may use the types "ADD" or "REMOVE".
+No equipment (or eqmod ITYPE) may use the types "ADD" or "REMOVE". Further restrictions discovered: 'THROWN', 'RANGED', 'WEAPON'. << Need to clarify with code if we can override this.
@@ Line 33: / Line 33: @@
 Variables syntax should start with a letter and should be composed of only letters, _ and numbers. The standard Convention is to use only letters, capitalizing individual words for readability.
-Examples: TurnUndead, SpecialAbility, UncannyDodgeFlankingLevel.
+Examples: TurnUndead, SpecialAbility, UncannyDodgeFlankingLevel. In Equipment you'll see KEY_NAME in some instances.
-Where it is possible to do so there should be only one DEFINE statement per variable and the DEFINE should be set at 0 with a BONUS:VAR used to adjust the value.
+Where it is possible to do so there should be only one DEFINE statement per variable and the DEFINE should be set at 0 with a BONUS:VAR used to adjust the value. PER CODE (James): Define evaluates once, therefore using DEFINE to any value other than 0 can cause issues.
 Variable names in all capitals are reserved for hard coded variables or variables defined within the system files.
@@ Line 153: / Line 153: @@
 Folder below:
      <folder_name>/<filename>.xxx
 ===Pathfinder Specific===
 [[Pathfinder RPG]]

← Older revision		Revision as of 20:56, 28 May 2012
Line 142:		Line 142:
	** pfcr_abilities.lst		** pfcr_abilities.lst
	** etc.		** etc.
		+
		+	===File Reference===
		+	* Submitted May 28th, 2012
		+
		+	For Conversion Folders - when referencing a folder above the conversion folder ALWAYS use RELATIVE file paths, not absolutes, otherwise your paths will be broken and you'll be forcing fixes as the files transition between NFD, to ALPHA, To the full release folder. The only case this is not PLAUSIBLE is reference to other source books OUTSIDE the sourcebook folder, i.e. you need to reference material in another source book.
		+
		+	One Folder Up:
		+	../<filename>.lst
		+
		+	Folder below:
		+	<folder_name>/<filename>.xxx

@@ Line 12: / Line 12: @@
 EXCEPTION to the Naming Convention, if you use a KEY name, the Name acts as OUTPUTNAME and may use commas. The KEY MUST ADHERE to the General rules for the naming of all objects at ALL times.
 ===Additional Restrictions===
@@ Line 41: / Line 42: @@
 It is good practice to leave comments within the data sets LST code explaining what variables have been used in the set, what their purpose is and how they are to be used.
 ===General EQMOD Naming Standards===
@@ Line 53: / Line 55: @@
 Materials which list different pricing for different item types or sub types (Light Armor vs. Medium Armor for example) will be done as separate EQMODs for each price type.
 ===Special Usages===
@@ Line 68: / Line 71: @@
 ** Example: Archetypes are a Grouping, 'Barbarian Archetype ~ Name of Archetype/Ability'
 ** Example: Poison is an Ability,  'Poison ~ Druid'

← Older revision		Revision as of 20:37, 15 October 2010
Line 11:		Line 11:
	Within these limits the name should be as close as possible to the published source.		Within these limits the name should be as close as possible to the published source.

		+	EXCEPTION to the Naming Convention, if you use a KEY name, the Name acts as OUTPUTNAME and may use commas. The KEY MUST ADHERE to the General rules for the naming of all objects at ALL times.

	===Additional Restrictions===		===Additional Restrictions===