Ideabox variables

From GodWiki
Jump to: navigation, search
For explanation of the ideabox in general, see Ideabox.
Variable in parentheses green.png

When submitting or editing ideas in the Ideabox or ER, if you want to include the heroine or hero's name, pet's name or other text that changes depending on circumstances, you can use these variables. Variables are enclosed in percent signs (e.g., %variable%) and the game will fill in the correct string of text when it encounters one. For example, the current monster being fought will appear in place of %monster%. This list is adapted from the ideabox page, the ER help screens, and editor experience. Where quotation marks “…” are shown around a variable, these are recommended, but not strictly required for the variable to work.

Some variables have shortcuts for ER editors, show here in the form /xx, which will expand to the correct variable name when submitted, including %s. This is especially useful when editing on mobile devices, where putting percents % and underscores _ into the text can be fiddly and frustrating.

Table of Contents
  1. Hero Details
  2. Gender Details
  3. Things Around the Hero
  4. Miscellaneous Variables
  5. Earthly News Variables
  6. Duel Variables
  7. Dungeon Variables
  8. Sail Variables
  9. Quest Variables
  10. Newspaper Variables
  11. If you Need a Variable Not on this List
  12. Where Variables Don't Work

Hero Details

  • %hero_name% — heroine's name (/hn)
  • %motto% — heroine's motto (/mt)
  • %hero_guild% — name of the heroine's guild (/hg)
  • %hero_equipment% — a random piece of the heroine's equipment (/he) (Note: To select a specific piece of equipment, use %v% and specify the equipment type — weapon, shield, etc. — in comments.[1])
  • %hero_random_item% — an item from the heroine's inventory (/hi)
  • %hero_random_skill% — a random skill of the heroine (/hs)
  • %pet_name% — the name of the heroine's pet (/pn)
  • %pet_class% — the species of the heroine's pet (/pc)
  • %random_friend% — the name of some friend-heroine nearby (/rf)
  • %rg% — random generic name of the goddess, e.g. "Almighty" or "Great One" (/rg)

Gender Details

  • {his|her} — hero or heroine gender variation (“The mayor said I looked like a strapping {lad|lass}.”)
  • {his||her} — the gender variation of a second hero or heroine.
In a duel, the second hero{||ine} is the %defender%, and the second god{||||ess} his or hers. In a diary entry, the second heroine is any %random_friend% or %random_hero% in the entry. If no second heroine is specified, the gender will be decided at random. (“%random_friend% said {he||she} likes my new haircut.” “%defender% looked nervously at {his||her} badly dented weapon.” “One of my customers dropped {his||her} wallet. Terrible shame.”)
  • {his|||her} — god or goddess gender variation (“I'm cold, my {Lord|||Lady}!”)
  • {his||||her} — second god or goddess gender variation. (“%defender_god% flexed {his||||her} divine muscles.”) Whom this refers to follows the same system as the gender variation of a second hero or heroine.

Note that the braces do not have to contain the entire word (so “I'm cold, my L{ord|||ady}!” is valid). Nor is it required that both sides of the | character contain letters within the braces (so “Searching for the hero{|ine} on a minimap…” is equally valid as “Searching for the {hero|heroine} on a minimap…”). Lastly, note that the first gender variable will be used for heroes, while the second will be used for heroines.

Useful shortcuts for these special characters for ER editors:

  • Double back slash \\ will be changed into a vertical bar |
  • Double parenthesis (( or )) will be changed into a curly brace { or }

Things Around the Hero

  • %current_quest% — the name of the current quest (/cq)
  • %current_town% — the name of the town where the heroine is now (/ct)
  • %town_name% — on arrival to town (“%town_name% is nearby. Very nice, I need a rest.”) or the town granting a guild mini-quest (/tn)
  • %current_aura% — heroine's current aura (“I sneezed and my aura of %current_aura% disappeared. Just my luck.”)
  • %nearby_town% — the name of a town near the heroine (/nt)
  • %monster% — the monster that the heroine is currently interacting with (/mo)
  • %gold% — gold coins spent/gained by the heroine (/go)
  • %god_phrase% — voice from a goddess, either the heroine's or another
  • %some_tavern% — the name of a random tavern (/ta)
  • %some_territory% — the name of some random location (/st)
  • %artifact% — artifact name with the appropriate article (“Found %artifact% under a pile of dirty clothes!”) (/ar)
  • %artifact_base% — artifact name without an article (“Broke my %artifact_base%.”) (/ab)

Miscellaneous Variables

  • %random_guild% — name of a random guild (/ru)
  • %random_skill% — some random skill (/rs)
  • %random_item% — some random artifact name (/ri)
  • %random_quest% — the name of some random quest (/rq)
  • %random_town% — the name of some random town (/rt)
  • %random_hero% — the name of some random heroine or hero nearby (/rh)
  • %random_monster% — the name of some random monster (/rm)
  • %a_random_monster% — a random monster with the correct article
  • %quest% — on getting a new quest, the quest the heroine is being given
  • %skill% — the skill being used in the entry (/sk)

Earthly News Variables

  • %hp% — hit points gained/lost by someone (/hp)
  • %gold% — gold coins spent/gained by the heroine (/go)

Duel Variables

  • %attacker% — the name of the heroine or boss monster who is attacking in the entry, or the heroine whose goddess is using an influence in the entry. (“%attacker% swung and missed.” “%attacker% was smothered under a layer of fluffy pink healing fuzz.”) (/at)
  • %attacker_godname% — the name of the goddess whose heroine is attacking, or who is using an influence in the entry (/ag)
  • %attacker_motto% — the motto of the attacking heroine
  • %attacker_drop_artifact% — a random item from the attacking heroine's inventory that will be lost this turn
  • %attacker_random_artifact% — a random artifact of the attacking heroine
  • %attacker_random_equipment% — a random piece of the attacking heroine's equipment
  • %defender% — the name of the heroine or boss monster who is defending in the entry, or the heroine whose goddess is not using an influence in the entry (“%defender% almost took an arrow to the knee, but realised at the last minute how annoying that would be.” “%defender% steamed visibly after a precision lightning strike to the hair.”) (/de)
  • %defender_godname% — the name of the goddess whose heroine is defending, or who is not using an influence in the entry
  • %defender_motto% — the motto of the defending heroine
  • %defender_drop_artifact% — a random item from the defending heroine's inventory that will be lost this turn
  • %defender_random_artifact% — a random artifact of the attacking heroine
  • %defender_random_equipment% — a random piece of the defending heroine's equipment
  • %random_opponent% — a randomly selected combatant. You cannot use normal gender variables with this, as {him|her} and {him||her} still refer to %attacker% and %defender% as usual.
  • %winner% — the name of the heroine or boss who wins the fight
  • %loser% — the name of the heroine or boss who loses the fight
  • %random_monster% — the name of some random monster (/rm)
  • %a_random_monster% — a random monster with the correct article
  • %skill% — the skill being used in the entry (/sk)

Dungeon Variables

  • %boss% — the name of a boss-monster (/bo)
  • %dir% — one or more directions (/di)
In a "Heroes move to" entry, this variable is replaced with a compass direction of either north, south, east, or west. In a "Treasure hint" entry, it may also become northwest, southwest, northeast, or southeast. In an "Available directions" entry, this variable may be just one direction (north, south, east, or west) or a list with "and" (e.g., "north, east, and south") if there is more than one exit.

Dungeons also use the following variables when referring to heroes and heroines:

  • %attacker% — name of the heroine active on this turn (the one who got treasure, triggered a trap, etc) (/at)
  • %attacker_motto% — motto of the active heroine
  • %attacker_godname% — goddess of the active heroine (/ag)
  • %random_attacker% — name of a random heroine from the party (gender inflections with {him||her})

Sail Variables

  • %monster% — name of a beastie (/mo)
  • %attacker% — name of the active sailor in the phrase (/at)
  • %attacker_godname% — name of the goddess or god acting in the phrase, or of the active sailor (/ag)
  • %defender% — the second sailor in a battle start, target of a punish, or loser in a battle end (/de)
  • %var% — loot gained, e.g., “a treasure”, “a feminal”, etc.
  • %god_phrase% — God voice
  • %heroes_names% — the names of the sailors commencing their sail

Quest Variables

  • %town_name% — for guild mini-quests, the name of the town where the mini-quest was issued (/tn)

Newspaper Variables

  • %mod_name% — name of the wanted monster (the Monster of the Day)
  • %a_mod_name% — name of the wanted monster with an indefinite article
  • %mod_reward% — reward for the wanted monster
  • %aod_name% — name of the wanted artifact (the Artifact of the Day)
  • %an_aod_name% — name of the wanted artifact with an indefinite article
  • %aod_reward% — reward for the wanted artifact
  • %random_hero% — the name of some random hero (/rh)
  • %random_guild% — a random Godville's guild (/ru)
  • %random_town% — a name of some random town (/rt)
  • %random_quest% — a name of some random quest (/rq)
  • %random_monster% — the name of some random monster (/rm)
  • %a_random_monster% — a random monster with the correct article
  • %random_item% — some random artifact name (/ri)
  • %random_skill% — some random skill (/rs)
  • %random_equip% — some random piece equipment (/he)
  • %some_tavern% — the name of a random tavern (/ta)

If you Need a Variable Not on this List

  • %v% — a generic placeholder variable for something that is not in this list (make sure to describe what your variable does in the comment section) (/vv)

Where Variables Don't Work

None of these variables will work in entries for monsters, artifacts, or equipment. Quest special ending entries can only take hero{|ine} and god{|||dess} gender inflections. Guild mini-quests can use %town_name% for the town granting the quest, but otherwise quest names cannot use any variables.