Difference between revisions of "DynamicColor"

From BZFlagWiki
Jump to: navigation, search
(Code)
(Code)
Line 14: Line 14:
 
The valid parameters for dynamicColor are:
 
The valid parameters for dynamicColor are:
 
{|
 
{|
  [channel] [command] [options]
+
  [channel] [function] [options]
 
|}
 
|}
 
Color Settings:
 
Color Settings:
 
<properties>
 
<properties>
 
channels=red, green, blue, alpha
 
channels=red, green, blue, alpha
commands=limits, sinusoid, clampUp, clampDown, sequence (repeatable, except for "limits" and "sequence")
+
functions=limits, sinusoid, clampUp, clampDown, sequence (repeatable, except for "limits" and "sequence")
 
</properties>
 
</properties>
  
if "sequence" uses clampUps and clampDowns together they will have no effect
+
===Functions===
  
"sequence" can use three states (0, 1, 2).
+
'''sequence''' (Can have three settings)
 +
*0=active clampDown
 +
*1=no clamps
 +
*2=active clampUp
  
*0 = active clampDown
+
if both clampUp and clampDown are active, the value is (min+max)/2, if used with "sequence" they will have no effect
*1 = no clamps
+
*2 = active clampUp
+
  
if both clampUp and clampDown are active, the value is (min+max)/2
+
'''sinusoid''' (starts at the max value)
  
sinusoid function starts at the max value
 
 
the sum of a channel's sinusoids is clamped between 0 and 1
 
the sum of a channel's sinusoids is clamped between 0 and 1
  
Example syntax for use within dynanicColor:
+
Example syntax for use within dynamicColor:
 
   
 
   
* [channel] limits min/max limits
+
* [channel] limits [min limit] [max limit]
* [channel] sinusoid period, offset, weight
+
* [channel] sinusoid [period] [offset] [weight]
* [channel] clampUp period, offset, width
+
* [channel] clampUp [period] [offset] [width]
* [channel] clampDown period, offset, width
+
* [channel] clampDown [period] [offset] [width]
* [channel] sequence period, offset, list of states
+
* [channel] sequence [period] [offset] [list of states...]

Revision as of 06:08, 10 October 2007

Code


      dynamicColor
        name example_dyncol
        red limits 0 1               
        green sinusoid 0.1 0 0.25    
        blue clampUp 0.1 0 0.75      
        alpha clampDown 0.2 0.5 0.5  
        red sequence 0.0 0.0 2 0 1 1 2 0 ... 
      end

The valid parameters for dynamicColor are:

[channel] [function] [options]

Color Settings:

channels red, green, blue, alpha
functions limits, sinusoid, clampUp, clampDown, sequence (repeatable, except for "limits" and "sequence")


Functions

sequence (Can have three settings)

  • 0=active clampDown
  • 1=no clamps
  • 2=active clampUp

if both clampUp and clampDown are active, the value is (min+max)/2, if used with "sequence" they will have no effect

sinusoid (starts at the max value)

the sum of a channel's sinusoids is clamped between 0 and 1

Example syntax for use within dynamicColor:

  • [channel] limits [min limit] [max limit]
  • [channel] sinusoid [period] [offset] [weight]
  • [channel] clampUp [period] [offset] [width]
  • [channel] clampDown [period] [offset] [width]
  • [channel] sequence [period] [offset] [list of states...]