This wiki is archived and useful information is being migrated to the main bzflag.org website

Difference between revisions of "DynamicColor"

From BZFlagWiki
Jump to: navigation, search
(New page: === Code === {| | dynamicColor name example_dyncol red limits 0 1 green sinusoid 0.1 0 0.25 blue clampUp 0.1 0 0.75 ...)
 
m (properties formatting)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
DynamicColor describes how a color channel will be dynamically updated. Mainly, it's a sum of sinusoid.
 +
 
=== Code ===
 
=== Code ===
 +
----
 
{|
 
{|
 
|
 
|
Line 8: Line 11:
 
         blue clampUp 0.1 0 0.75       
 
         blue clampUp 0.1 0 0.75       
 
         alpha clampDown 0.2 0.5 0.5   
 
         alpha clampDown 0.2 0.5 0.5   
−
         red sequence 0.0 0.0 2 0 1 1 2 0 ...  
+
         red sequence 0.1 0.0 2 0 1 1 2 0 ...  
 
       end
 
       end
 
|}
 
|}
 
The valid parameters for dynamicColor are:
 
The valid parameters for dynamicColor are:
−
# min/max limits
+
{|
−
# period, offset, weight
+
[channel] [function] [options]
−
# period, offset, width
+
|}
−
# period, offset, width
+
−
# period, offset, list of states
+
−
 
+
−
<properties>
+
 
Color Settings:
 
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:
 
   
 
   
−
Channels: red, green, blue, alpha
+
* [channel] limits [min limit] [max limit]
−
- Commands: limits, sinusoid, clampUp, clampDown, sequence (repeatable, except "limits" and "sequence")
+
* [channel] sinusoid [period] [offset] [weight]
−
        # except for "limits" and "sequence", the commands are repeatable
+
* [channel] clampUp [period] [offset] [width]
−
        # if "sequence" used then clampUps/clampDowns have no effect
+
* [channel] clampDown [period] [offset] [width]
−
        # sequences can use three states (0, 1, 2).
+
* [channel] sequence [period] [offset] [list of states...]
−
        #  0 - equivalent to an active clampDown
+
−
        #  1 - equivalent to no clamps
+
−
        #  2 - equivalent to an active clampUp
+
−
        # if both clampUp and clampDown are active, the value is (min+max)/2
+
  
−
        # the sinusoid function starts at the max value
+
[[Category:Map Making]]
−
        # the sum of a channel's sinusoids is clamped between 0 and 1
+
[[Category:Map_Objects]]
−
</properties>
+

Latest revision as of 03:08, 28 July 2012

DynamicColor describes how a color channel will be dynamically updated. Mainly, it's a sum of sinusoid.

Code[edit]

      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.1 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[edit]

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...]
Retrieved from "https://wiki.bzflag.org/index.php?title=DynamicColor&oldid=8344"