Data LST Standards

From PCGen Wiki
Revision as of 04:33, 12 February 2009 by Eddyanthony (talk | contribs)
Jump to: navigation, search

General Object Naming Standards

These are general rules for the naming of classes, feats, races and other objects.

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 (), and a slash (/).

Characters which should never be used in object names are Commas (,), Pipes (|), backslashes (\), colons (:) and semicolons (;).

Two words separated by a dash should both be capitalized.

Within these limits the name should be as close as possible to the published source.

General Variable Naming Standards

There should be only one DEFINE statement per variable.

Variables should always be DEFINEd at 0 and then a BONUS:VAR used to set the value.

Variable names in all capitals are reserved for hard coded or variable defined in the system files.

Variables syntax must start with a letter or a _ and must be composed of only letters, _ and numbers

Each word in the variable should be capitalized for readability.

Examples: TurnUndead, SpecialAbility, UncannyDodgeFlankingLevel.

A separate text document should accompany all data sets explaining what variables have been used in the set and what their purpose is

All variables used in a hidden feat are to be DEFINEd within that hidden feat.

General EQMOD Naming Standards

EQMOD keys are to be in all capital letters and may only contain letters, numbers and underscores ("_").

Each word should be separated by an underscore character for ease in reading.

For purposes of abbreviation the letter limit on the first and second sections of the Key name is 8 and 7.

EQMODs for different item types (Weapon vs. Armor for example) will be done as separate EQMODs

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.