Personal tools
You are here: Home Users Hawke Robinson News List of Variables for SuiteGM Plugins

List of Variables for SuiteGM Plugins

by Hawke Robinson last modified Nov 13, 2009 03:11 AM

This is just an initial draft. This lists the variables available for creating a new SuiteGM plugin (for adding a game system to the software). This is created by end users filling out a data entry form. This will be constantly revised for a while as we work out the variables needed between many different game system types.

Variable Names for SuiteGmPlugin classes and XML files.

 

Variable Names for:

jfrmDataEntryFormCreateSuiteGmRpgPlugin

 

 

 

Type

Name

UI Component

XML Element

Notes

String

strRpgsCompanyName

jtxtfldRpgsCompanyName

rpgi_company_name

 

String

strRpgsFullName

jtxtfldRpgsName

rpgi_full_name

 

String

strRpgsNickName

jtxtfldRpgsNickName

rpgi_nick_name

 

String

strRpgsVersion

jtxtfldRpgsVersion

rpgi_version

 

String

strRpgsGenre

jtxtfldRpgsGenre

rpgi_genre

 

String

strRpgsSuiteGmPluginAbbrev

jtxtfldRpgsAbbrev

rpgi_plugin_abbrev

 

String

strRpgsSuiteGmPluginVersion

jtxtfldRpgsPluginVersion

rpgi_plugin_version

 

String

filename

jtxtfldRpgsAbbrev

rpgi_filename

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Booleans, usually used to check if a field/feature will (or will not) be used in the plugin.

This table lists the generally “universal” fields that are usually expected to be included.

Type

Name

UI Component

XML Element

Notes

Boolean

boolUseGmName

chkbxUseGmName

use_gm_name

 

Boolean

boolUseCampaignName

chkbxUseCampaignName

use_campaign_name

 

Boolean

boolUseCampaignStartDate

chkbxUseCampaignStartDate

use_campaign_start_date

 

Boolean

boolUsePlayerName

chkbxUsePlayerName

use_player_name

 

Boolean

boolUseCharacterName

chkbxUseCharacterName

use_character_name

 

Boolean

boolUseCharacterHair

chkbxUseCharacterHair

use_character_hair

 

Boolean

boolUseCharacterEyes

chkbxUseCharacterEyes

use_character_eyes

 

Boolean

boolUseCharacterSkin

chkbxUseCharacterSkin

use_character_skin

 

Boolean

boolUseCharacterHeight

chkbxUseCharacterHeight

use_character_height

 

Boolean

boolUseCharacterWeight

chkbxUseCharacterWeight

use_character_weight

 

Boolean

boolUseEmail

chkbxUseEmail

use_email

 

Boolean

boolUsePrintable

chkboxUsePrintable

use_printable

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

This table lists variables specific to gaming mechanics that most game systems include these in one for or another, but it varies. Again, this table is just boolean checks to see IF the fields/functions should be included in the plugin, they do NOT define how these areas are handles.

 

Type

Name

UI Component

XML Element

Notes

Boolean

boolUseRaces

jchkbxUseRace

use_races

 

Boolean

boolUseProfessions

jchkbxUseProfessions

use_professions

 

Boolean

boolUseGender

jchkbxUseGender

use_gender

 

Boolean

boolUseAbilities

jchkbxUseAbilities

use_abilities

stats like Strength, Intelligence, etc.

Bool

boolUseLevels

jchkbxUseLevels

use_levels

System uses class levels (or not for skill-centric systems)

Bool

boolUseSkills

jchkbxUseSkills

use_skills

 

Boolean

boolUseLanguages

jchkbxUseLanguages

use_languages

 

Boolean

boolUseWeapons

jchkbxUseWeapons

use_weapons

 

Boolean

boolUseArmor

jchkbxUseArmor

use_armor

 

Boolean

boolUseMagic

jchkbxUseMagic

use_magic

 

Boolean

boolUseTech

jchkbxUseTech

use_tech

 

Boolean

boolUseHitPoints

jchkbxUseHitPoints

use_hit_points

 

Boolean

boolUseAttackMods

jchkbxUseAttackMods

use_attack_mods

OB, etc

Boolean

boolUseDefenseMods

jchkbxUseDefenseMods

use_defense_mods

DB, etc

Boolean

boolUseResistanceChecks

jchkbxUseResistanceChecks

use_resistance_checks

saving throws, resistance rolls, etc.

Boolean

boolUseDifficultyChecks

jchkbxUseDifficultyChecks

use_difficulty_checks

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

These are some less common, but still frequently used fields, again, this is just the boolean check to see if they are used, details are specified separately.

 

Type

Name

UI Component

XML Element

Notes

Boolean

boolUseCultures

chkbxUseCultures

use_cultures

 

Boolean

boolUseMulticlass

chkbxUseMulticlass

use_multiclass

 

Boolean

boolUseFatigue

chkbxUseFatigue

use_fatigue

 

Boolean

boolUseBackgroundOptions

chkbxUseBackgroundOptions

use_background_options

 

Boolean

boolUseSpells

chkbxUseSpells

use_spells

 

Boolean

boolUseMartialArts

chkbxUseMartialArts

use_martial_arts

 

Boolean

boolUseClothing

chkbxUseClothing

use_clothing

 

Boolean

boolUseFootwear

chkbxUseFootwear

use_footwear

 

Boolean

boolUseArmwear

chkbxUseArmWear

use_armwear

 

Boolean

BoolUseJewelry

chkbxUseJewelry

use_jewelry

 

Boolean

BoolUseHitLocations

chkbxUseHitLocations

use_hit_locations

 

Boolean

boolUseHealthCondition

chkbxUseHealthCondition

use_health_condition

 

Boolean

boolUseHitCriticals

chkbxUseHitCriticals

use_hit_criticals

 

Boolean

boolActionRolls

chkbxUseActionRolls

use_action_rolls

 

Boolean

boolUseActionCriticals

chkbxUseActionCriticals

use_action_criticals

 

Boolean

boolUseSustenance

chkbxUseSustenance

use_sustenance

use food & water

Boolean

boolUseHerbs

chkbxUseHerbs

use_herbs

 

Boolean

boolUseHealing

chkbxUseHealing

use_healing

 

Boolean

boolUseMoney

chkbxUseMoney

use_money

 

 

 

 

 

 

 

 

 

 

 

 

 

 

There are MANY more to be added as game systems get added, and fields need to be added, but this is a good starting foundation.

 

 

 

Variable Names for:

XmlWriterSuiteGmPluginWriter

 

Document Actions