Corona Effect

From TrainzOnline
(Difference between revisions)
Jump to: navigation, search
m
(Explanations and default values)
 
(5 intermediate revisions by 3 users not shown)
Line 17: Line 17:
 
===Explanations and default values===
 
===Explanations and default values===
  
att: Name of attachment point.
+
;att: Name of attachment point.
 +
:*Compulsory (3.4)
  
object-size: size of the corona in meters; default is 0.15.
+
;object-size: Size of the corona in meters.
 +
:*Optional. Default 0.15.
  
max-size-mul:
+
;max-size-mul: ??
 +
:*Optional. Default 2.0.
  
mul-distance:  
+
;mul-distance: ??
 +
:*Optional. Default 60. 
  
min-distance:
+
;min-distance: Closest distance at which the corona disappears.
 +
:*Optional. Default 1.0.
  
max-distance:
+
;max-distance: Farthest distance at which corona will be visible.
 +
:*Optional. Default 315.
  
max-intensity
+
;max-intensity: Maximum visual intensity level.
 +
:*Optional. Default 1.
  
texture-KUID: allows user to specify the a user defined texture for the corona by identifying the KUID of a "[[KIND_Texture | KIND_Texture]]" asset. If the  texture-kuid tag is not present, the corona will use the default yellow/orange texture.  
+
;texture-kuid: Specifies a user-defined texture for the corona by identifying the KUID of a "[[KIND_Texture | KIND_Texture]]" asset.
 +
:*Optional. Default <kuid:-1:6349> (yellow/orange texture)  
  
distance-fade: boolean value
+
;distance-fade: Boolean value; 0 = does not fade with distance, 1 = fades with distance.
 +
:*'''OBSOLETE - Do not use.'''
  
directional: boolean value
+
;directional: Boolean value indicating whether the corona effect has direction. A value of 0 means the corona is omnidirectional; a value of 1 indicates that the corona is directional along the negative z axis.
 +
:*Optional. Default 1.
  
frequency: boolean value
+
;frequency: Frequency of flashing in flashes per second. 0.2 is one flash every 5 seconds; 0.5 is one flash every 2 seconds; 2 is one flash every half second.
 +
:*Optional. Default 2.
  
wave-shift: boolean value
+
;wave-shift: A floating-point value ranging from -1 to 1. This value determines the duty cycle of a flashing corona: that is, the amount of time in the cycle for which the light is on.  Negative values give on times of less than half, positive values give on times of more than half.  Note that this number is not linear.
 +
:*Optional. Default 0 (50% duty cycle).
  
 
[[Category:Config Container]]
 
[[Category:Config Container]]
 +
 +
 +
<!-- mul-distance = distance at which corona will start growing larger; maintains visibility of a light source, mimics signal light behavior
 +
max-size-mul = Essentially, the maximum size of corona at a long distance, it shrinks as you get closer
 +
 +
wave shift = not sure, probably allows occulting (on more than off) or quick flashing (off more than on) -->

Latest revision as of 05:16, 18 April 2023

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

kind "corona"
att ""
object-size 0.15
max-size-mul 2.0
mul-distance 60.0
min-distance 1.0
max-distance 315.0
max-intensity 1.0
texture-KUID <KUID:-1:6349>
distance-fade 1
directional 1
frequency 0
wave-shift 0

[edit] Explanations and default values

att
Name of attachment point.
  • Compulsory (3.4)
object-size
Size of the corona in meters.
  • Optional. Default 0.15.
max-size-mul
 ??
  • Optional. Default 2.0.
mul-distance
 ??
  • Optional. Default 60.
min-distance
Closest distance at which the corona disappears.
  • Optional. Default 1.0.
max-distance
Farthest distance at which corona will be visible.
  • Optional. Default 315.
max-intensity
Maximum visual intensity level.
  • Optional. Default 1.
texture-kuid
Specifies a user-defined texture for the corona by identifying the KUID of a " KIND_Texture" asset.
  • Optional. Default <kuid:-1:6349> (yellow/orange texture)
distance-fade
Boolean value; 0 = does not fade with distance, 1 = fades with distance.
  • OBSOLETE - Do not use.
directional
Boolean value indicating whether the corona effect has direction. A value of 0 means the corona is omnidirectional; a value of 1 indicates that the corona is directional along the negative z axis.
  • Optional. Default 1.
frequency
Frequency of flashing in flashes per second. 0.2 is one flash every 5 seconds; 0.5 is one flash every 2 seconds; 2 is one flash every half second.
  • Optional. Default 2.
wave-shift
A floating-point value ranging from -1 to 1. This value determines the duty cycle of a flashing corona: that is, the amount of time in the cycle for which the light is on. Negative values give on times of less than half, positive values give on times of more than half. Note that this number is not linear.
  • Optional. Default 0 (50% duty cycle).
Personal tools