Name Effect

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
 
(Some clarification of usage)
 
(3 intermediate revisions by 3 users not shown)
Line 6: Line 6:
 
  value "(same as name)"
 
  value "(same as name)"
 
  font "swiss"
 
  font "swiss"
  font-size 12
+
  fontsize 12
  font-color 1.0,1.0,1.0
+
  fontcolor 0,0,0
 +
 
 +
===Explanations and default values===
 +
 
 +
Kind 'name' effect is used to place a user-defined text string on a mesh.
 +
 
 +
kind: The kind of this effects container.
 +
:Type: Text
 +
:Compulsory. "name"
 +
 
 +
name: A name for this effects container. Used by a script to set the value of the effect.  i.e. the text displayed at the attachment point.
 +
:Type: Text
 +
:Optional. Default "parent".
 +
 
 +
att: The attachment point used for placing this effect.  i.e. something like "a.name0".
 +
:Type: Text
 +
:Compulsory.
 +
 
 +
value: The text to be used for this effect.
 +
:Type: Text
 +
:Optional: Default (same as name)
 +
 
 +
font: The font to be used for this name.
 +
:List item. {"arial", "console", "comic_sans", "courier", "cordia", "century_gothic", "garamond", "helvetica", "impact", "sans_serif", "swiss", "tahoma", "times_new_roman", "verdana"}
 +
:Optional. Default "swiss".
 +
 
 +
fontsize: The font size to be used for this effect.
 +
:Type Float
 +
:Optional. Default 12.
 +
 
 +
fontcolor: The color to be used for this effect.
 +
:Type: RGB triplet
 +
:Optional. Default 0,0,0
 +
 
 +
 
  
 
[[Category:Config Container]]
 
[[Category:Config Container]]

Latest revision as of 15:06, 17 June 2024

The Name effect kind is a "mesh-table" Container effect container. The following tags are supported:

kind "name"
name ""
att ""
value "(same as name)"
font "swiss"
fontsize 12
fontcolor 0,0,0

[edit] Explanations and default values

Kind 'name' effect is used to place a user-defined text string on a mesh.

kind: The kind of this effects container.

Type: Text
Compulsory. "name"

name: A name for this effects container. Used by a script to set the value of the effect. i.e. the text displayed at the attachment point.

Type: Text
Optional. Default "parent".

att: The attachment point used for placing this effect. i.e. something like "a.name0".

Type: Text
Compulsory.

value: The text to be used for this effect.

Type: Text
Optional: Default (same as name)

font: The font to be used for this name.

List item. {"arial", "console", "comic_sans", "courier", "cordia", "century_gothic", "garamond", "helvetica", "impact", "sans_serif", "swiss", "tahoma", "times_new_roman", "verdana"}
Optional. Default "swiss".

fontsize: The font size to be used for this effect.

Type Float
Optional. Default 12.

fontcolor: The color to be used for this effect.

Type: RGB triplet
Optional. Default 0,0,0
Personal tools