User Tools

Site Tools


Design Note Parameters

The Editor→Design Note property is used to specify most parameters for a script. The design note is a string that can be a list of parameters, or a single parameter by itself. A parameters is a keyword, followed by an equals sign (=), then an argument. The argument may be surrounded with single or double quotes. Multiple parameters are seperated with a semi-colon (;). If you need to include a semi-colon in an argument, then it must be surrounded by quotes. A quote mark can be included by using the other type of quote mark to surround the argument, or escape the quote mark with a back-slash.

  param='a \'quoted\' argument'
  name="This is a name";number=15


When a script looks for an integer or flag parameter, you can have it read a quest variable. After the equals sign, type a dollar sign ($) and the name of the quest variable. There may not be space between the dollar sign and the variable name.



Some scripts use a parameter for a time value. If this is in the Script→Timing property, then the time is in milliseconds. But where the time is read from the design note, or a string file, then you can add a suffix to have the time interpreted differently. Add the letter s to indicate seconds, or m for minutes. Without a letter, the time is milliseconds.



Color values can be given one of three ways: in HTML form using six hexadecimal digits, as three decimal numbers separated with commas, or as a name.


The color names are black, silver, gray, grey, white, maroon, red, purple, fuchsia, green, lime, olive, yellow, navy, blue, teal, aqua.

Design Notes on Archetypes

Most properties are read on a first-serve basis. First the concrete object is checked, them metaproperties, then archetypes. If design notes were like this, then every each object would require a complete list of parameters required. Instead, parameters are read in a way similar to the Scripts property. All the parameters in the Editor\Design Note properties of the object, metaproperties, and archetypes are combined together.

Like a regular property, the individual parameters are found on a first-serve basis. The script will look for it first on the concrete object, then the metaproperties, then the archetypes. If a parameter is set on the archetype, but you want to ignore it without setting any particular value, then use just an exclamation mark as the parameter value.


This is not the same as giving the parameter an empty value. A script may provide a default value for parameters that are unset, but will do something different if it is set to nothing.

tnhscript/designnote.txt · Last modified: 2010/11/22 19:11 (external edit)