August
20
2013

You can add information (like the name of an item or the current game time) to your texts using Text Codes.

A text code starts with a # (and in some cases ends with a # as well, when using indexed data, like items or colors). Some text across ORK Framework also have special text codes, usually starting with a % available, those will be described above the text fields in the editor.

All text codes described here can also be added using the ORK Framework editor in the text areas (when using ORK’s text area – by default enabled).

howto_text_codes1

Text options

##
Displays a # in the text.

#>
The rest of the text will be cut off. When used in dialogues, the rest of the text is displayed on the next page (i.e. after accepting).

#waitX#
When displaying text letter by letter (type text settings in GUI boxes), this text code waits for X seconds before continuing typing the text.
E.g. #wait1# waits for 1 second, #wait0.5# waits for 0.5 seconds.

Text format

You can change the format of the displayed text (color, shadow color, font size, font style and text alignment).

Change text format

#text.colorX#
The text color will use the color with index X.

#text.shadowX#
The shadow color will use the color with index X.

#text.sizeX#
The font size will be set to X.

#text.normal
The font style will be set to Normal.

#text.bold
The font style will be set to Bold.

#text.italic
The font style will be set to Italic.

#text.bolditalic
The font style will be set to Bold and Italic.

#text.left
The text alignment (horizontal) will be set to Left.
The last alignment code in a text line will be used for the whole line!

#text.center
The text alignment (horizontal) will be set to Center.
The last alignment code in a text line will be used for the whole line!

#text.right
The text alignment (horizontal) will be set to Right.
The last alignment code in a text line will be used for the whole line!

#text.top
The text line alignment (vertical) will be set to Top.
The last vertical alignment code in a text line will be used for the whole line!

#text.middle
The text line alignment (vertical) will be set to Middle.
The last vertical alignment code in a text line will be used for the whole line!

#text.bottom
The text line alignment (vertical) will be set to Bottom.
The last vertical alignment code in a text line will be used for the whole line!

Reset to default text format

#!
Resets to the default text format (color, shadow color, font size, font style and text alinment).

#!color
Resets to the default text color.

#!shadow
Resets to the default shadow color.

#!size
Resets to the default font size.

#!style
Resets to the default font style.

#!alignment
Resets to the default text alignment (horiziontal).

#!valignment
Resets to the default text line alignment (vertical).

Reset to last used text format

#<
Resets to the last used text format (color, shadow color, font size, font style and text alinment).

#<color
Resets to the last used text color.

#<shadow
Resets to the last used shadow color.

#<size
Resets to the last used font size.

#<style
Resets to the last used font style.

#<alignment
Resets to the last used text alignment (horiziontal).

#<valignment
Resets to the last used text line alignment (vertical).

Game information

#time
The current game time (time running since starting a new game).

#area.current
The name of the area the player currently is in.

#area.currentdesc
The description of the area the player is currently in.

#area.iconcurrent
The icon of the area the player is currently in.

#area.currenttype
The name of the type of the area the player is currently in.

#area.currenttypedesc
The description of the type of the area the player is currently in.

#area.iconcurrenttype
The icon of the type of the area the player is currently in.

Game variables

#varstringX#
The current string value of the game variable with key X.

#varboolX#
The current bool value of the game variable with key X.

#varfloatX#
The current float value of the game variable with key X.

#varifloatX#
The current float value of the game variable with key X, displayed as integer value.

#varvector3X#
The current string value of the game variable with key X.

Inventory information

#money.inventory
The amount of money the player owns.

#money.name
The name used for money (defined in the inventory settings).

#money.desc
The description used for money (defined in the inventory settings).

#money.icon
The icon used for money (defined in the inventory settings).

#money.type
The name of the item type of money.

#money.typedesc
The description of the item type of money.

#money.typeicon
The icon of the item type of money.

#inventory
The quantity of a selected item, weapon or armor in the player’s inventory.

#equipped
The quantity of a selected weapon or armor currently equipped by the player’s group members.

Indexed data

Indexed data is all kind of data you create using the ORK Framework editor. The index refers to the position of the data in it’s data list (e.g. the first item in the items list has index 0).

Items

#item.nameX#
The name of the item with index X.

#item.descX#
The description of the item with index X.

#item.iconX#
The icon of the item with index X.

#item.typeX#
The type name of the item with index X.

#item.typedescX#
The type description of the item with index X.

#item.typeiconX#
The type icon of the item with index X.

#item.inventoryX#
The quantity of the item with index X in the player’s inventory.

Weapons

#weapon.nameX#
The name of the weapon with index X.

#weapon.descX#
The description of the weapon with index X.

#weapon.iconX#
The icon of the weapon with index X.

#weapon.typeX#
The type name of the weapon with index X.

#weapon.typedescX#
The type description of the weapon with index X.

#weapon.typeiconX#
The type icon of the weapon with index X.

#weapon.inventoryX#
The quantity of the weapon with index X in the player’s inventory.

#weapon.equippedX#
The quantity of the weapon with index X in equipped by the player’s group.

Armors

#armor.nameX#
The name of the armor with index X.

#armor.descX#
The description of the armor with index X.

#armor.iconX#
The icon of the armor with index X.

#armor.typeX#
The type name of the armor with index X.

#armor.typedescX#
The type description of the armor with index X.

#armor.typeiconX#
The type icon of the armor with index X.

#armor.inventoryX#
The quantity of the armor with index X in the player’s inventory.

#armor.equippedX#
The quantity of the armor with index X in equipped by the player’s group.

Crafting Recipes

#craftingrecipe.nameX#
The name of the crafting recipe with index (by default for level 1).

#craftingrecipe.descX#
The description of the crafting recipe with index X.

#craftingrecipe.iconX#
The icon of the crafting recipe with index X.

#craftingrecipe.typeX#
The type name of the crafting recipe with index X.

#craftingrecipe.typedescX#
The type description of the crafting recipe with index X.

#craftingrecipe.typeiconX#
The type icon of the crafting recipe with index X.

Logs

#log.nameX#
The name of the log with index (by default for level 1).

#log.descX#
The description of the log with index X.

#log.iconX#
The icon of the log with index X.

#log.typeX#
The type name of the log with index X.

#log.typedescX#
The type description of the log with index X.

#log.typeiconX#
The type icon of the log with index X.

Scene Objects

#sceneobject.nameX#
The name of the scene object with index (by default for level 1).

#sceneobject.descX#
The description of the scene object with index X.

#sceneobject.iconX#
The icon of the scene object with index X.

#sceneobject.typeX#
The type name of the scene object with index X.

#sceneobject.typedescX#
The type description of the scene object with index X.

#sceneobject.typeiconX#
The type icon of the scene object with index X.

Abilities

#ability.nameX#
The name of the ability with index (by default for level 1).

#ability.descX#
The description of the ability with index X.

#ability.iconX#
The icon of the ability with index X.

#ability.typeX#
The type name of the ability with index X.

#ability.typedescX#
The type description of the ability with index X.

#ability.typeiconX#
The type icon of the ability with index X.

Item Types

#itemtype.nameX#
The name of the item type with index X.

#itemtype.descX#
The description of the item type with index X.

#itemtype.iconX#
The icon of the item type with index X.

Crafting Types

#craftingtype.nameX#
The name of the craftig type with index X.

#craftingtype.descX#
The description of the crafting type with index X.

#craftingtype.iconX#
The icon of the crafting type with index X.

Log Types

#logtype.nameX#
The name of the log type with index X.

#logtype.descX#
The description of the log type with index X.

#logtype.iconX#
The icon of the log type with index X.

Scene Object Types

#sceneobjecttype.nameX#
The name of the scene object type with index X.

#sceneobjecttype.descX#
The description of the scene object type with index X.

#sceneobjecttype.iconX#
The icon of the scene object type with index X.

Ability Types

#abilitytype.nameX#
The name of the ability type with index X.

#abilitytype.descX#
The description of the ability type with index X.

#abilitytype.iconX#
The icon of the ability type with index X.

Equipment Parts

#equipmentpart.nameX#
The name of the equipment part with index X.

#equipmentpart.descX#
The description of the equipment part with index X.

#equipmentpart.iconX#
The icon of the equipment part with index X.

Status Values

#statusvlaue.nameX#
The name of the status value with index X.

#statusvlaue.descX#
The description of the status value with index X.

#statusvalue.iconX#
The icon of the status value with index X.

Status Effect

#statuseffect.nameX#
The name of the status effect with index X.

#statuseffect.descX#
The description of the status effect with index X.

#statuseffect.iconX#
The icon of the status effect with index X.

Attack Attributes

#atkattr.nameX#
The name of the attack attribute with index X.

#atkattr.subnameX#Y#
The name of the sub-attribute with index Y of attack attribute with index X.

#atkattr.descX#
The description of the attack attribute with index X.

#atkattr.subdescX#Y#
The description of the sub-attribute with index Y of attack attribute with index X.

#atkattr.iconX#
The icon of the defence attribute with index X.

#defattr.subiconX#Y#
The icon of the sub-attribute with index Y of the defence attribute with index X.

Defence Attributes

#defattr.nameX#
The name of the defence attribute with index X.

#defattr.subnameX#Y#
The name of the sub-attribute with index Y of defence attribute with index X.

#defattr.descX#
The description of the defence attribute with index X.

#defattr.subdescX#Y#
The description of the sub-attribute with index Y of defence attribute with index X.

#defattr.iconX#

The icon of the attack attribute with index X.

#atkattr.subiconX#Y#
The icon of the sub-attribute with index Y of the attack attribute with index X.

Classes

#class.nameX#
The name of the class with index X.

#class.descX#
The description of the class with index X.

#class.iconX#
The icon of the class with index X.

Combatants

#combatant.nameX#
The name of the combatant with index X.

#combatant.descX#
The description of the combatant with index X.

#combatant.iconX#
The icon of the combatant with index X.

Factions

#faction.nameX#
The name of the faction with index X.

#faction.descX#
The description of the faction with index X.

#faction.iconX#
The icon of the faction with index X.

#faction.sympathyX#Y#
The sympathy of the faction with index X toward the faction with the index Y.
X and Y mustn’t be the same.

#faction.isympathyX#Y#
The sympathy as int value of the faction with index X toward the faction with the index Y.
X and Y mustn’t be the same.

#faction.benefitX#Y#
The name of the faction benefit the faction with index Y currently has at the faction with the index X.
X and Y mustn’t be the same.

#faction.benefitdescX#Y#
The description of the faction benefit the faction with index Y currently has at the faction with the index X.
X and Y mustn’t be the same.

#faction.iconbenefitX#Y#
The icon of the faction benefit the faction with index Y currently has at the faction with the index X.
X and Y mustn’t be the same.

Faction benefits

#factionbenefit.nameX#
The name of the faction benefit with index X.

#factionbenefit.descX#
The description of the faction benefit with index X.

#factionbenefit.iconX#
The icon of the faction benefit with index X.

Areas

#area.nameX#
The name of the area with index (by default for level 1).

#area.descX#
The description of the area with index X.

#area.iconX#
The icon of the area with index X.

#area.typeX#
The type name of the area with index X.

#area.typedescX#
The type description of the area with index X.

#area.typeiconX#
The type icon of the area with index X.

Area Types

#areatype.nameX#
The name of the area type with index X.

#areatype.descX#
The description of the area type with index X.

#areatype.iconX#
The icon of the area type with index X.

Teleports

#teleport.nameX#
The name of the teleport with index (by default for level 1).

#teleport.descX#
The description of the teleport with index X.

#teleport.iconX#
The icon of the teleport with index X.

#teleport.typeX#
The type name of the teleport with index X.

#teleport.typedescX#
The type description of the teleport with index X.

#teleport.typeiconX#
The type icon of the teleport with index X.

Shops

#shop.nameX#
The name of the shop with index (by default for level 1).

#shop.descX#
The description of the shop with index X.

#shop.iconX#
The icon of the shop with index X.

Game statistics

#*killed.total
The total amount of killed enemies.

#*killed.enemyX#
The amount of killed enemies with index (combatant) X.

#*used.total
The total quantity of used items.

#*used.itemX#
The quantity of used items with index X.

#*created.total
The total quantity of created items, weapons and armors.

#*created.itemX#
The quantity of created items with index X.

#*created.weaponX#
The quantity of created weapons with index X.

#*created.armorX#
The quantity of created armors with index X.

#*battles.total
The total amount of battles the player fought.

#*battles.won
The total amount of battles the player won.

#*battles.lost
The total amount of battles the player lost.

#*battles.escaped
The total amount of battles the player escaped.

#*customX#
The custom statistic with index X.