Old CBEffects Parameter Reference

gistfile1.txt

-------------------------------------------------------
CBEffects Parameter Documentation
-------------------------------------------------------

This is the overwhelmingly large .txt file containing all of the parameters you can possibly put in a Data Table for CBEffects.

Includes parameters for CBEffects One, One and One-Fourth, One and One-Half, One and Three-Fourths, One and Four-Fifths, Two, Two and One-Fourth, Two and Two-Fifths, Two and Four-Ninths.

--------------------------------------------------------
--------------------------------------------------------
--------------------------------------------------------
Parameter List for Vents
--------------------------------------------------------
All of the possible parameters for a vent's Data Table.
--------------------------------------------------------

Newest (as of version Two and One-Fourth):
hasColor
iterateAngle
curAngle
divisionDamping


----------------------------
"title"
Type: String
Description: A unique title for the vent, so that you can access it with the “start”, “stop”, “destroy”, and “get” commands.


----------------------------
“x” and “y”
Types: Numbers
Descriptions: X and Y of the vent.


----------------------------
“isActive”
Type: Boolean
Description: Whether the vent starts when startMaster command is called, true means it does start, false means it doesn’t.
Note: Not used very often.


----------------------------
“build”
Type: Function
Description: Function that returns a display object to use as a particle.


----------------------------
“color”
Types: Table, Function
Description (table): Table with nested tables inside of it, each with RGB format.

Description (function): Function that returns anything that can be used as a color.


----------------------------
"iterateColor"
Type: Boolean
Description: Whether colors are chosen randomly from the color table or are iterated through one by one.


----------------------------
"curColor"
Type: Number
Description: The color to start with if iterateColor = true.


----------------------------
"hasColor"
Type: Boolean
Description: Whether to color particles from a vent or not.


----------------------------
“emitDelay”
Type: Number
Description: How long the delay between each emission is.


----------------------------
“perEmit”
Type: Number
Description: How many particles are emitted on each emission.


----------------------------
“emissionNum”
Type: Number
Description: How many times the vent emits particles when started. Set to zero to be infinite.
Note: Do not set both “emissionNum” and “emitDelay” to zero.


----------------------------
"parentGroup"
Type: Table, Corona Display Group
Description: The group that the vent's content group will be inserted into.


----------------------------
“lifeSpan”
Types: Number, Function
Description (number): How long a particle takes to transition to endAlpha and be removed.

Description (function): A function that returns how long the particle takes to transition to endAlpha and be removed.


----------------------------
"contentX" and "contentY"
Types: Numbers
Description: X and Y of the vent's content group.


----------------------------
“alpha”
Type: Number
Description: Alpha the particle will be just before the life transition starts.


----------------------------

“startAlpha”
Type: Number
Description: Alpha the particle is when it is created.


----------------------------
“endAlpha”
Type: Number
Description: Alpha the particle is when it is removed.


----------------------------
“onCreation”
Type: Function
Description: A function called on creation of each particle. The particle, the parent vent, and the parent vent's "content" group are each function arguments.


----------------------------
"onUpdate"
Type: Function
Description: A function called each time ParticlePhysics updates the position of each particle. Basically a function executed on Runtime. The particle, the parent vent, and the parent vent's "content" group are each function arguments.


----------------------------
“onDeath”
Type: Function
Description: A function called on death of each particle. The particle, the parent vent, and the parent vent's "content" group are each function arguments.


----------------------------
“propertyTable”
Type: Table
Description: A table of values that is copied to each particle. When the particle is built, each parameter in the property table is given to it.


----------------------------
“scale”
Type: Number
Description: A number that pre-defined values of the vent are multiplied by to scale the vent.

Note: It doesn't work very well currently - it's still in progress.


----------------------------
“lifeStart”
Types: Number, Function
Description (number): The delay before the particle begins its life span.

Description: (function): A function that returns the delay before the particle begins its life span.


----------------------------
“fadeInTime”
Type: Number
Description: The time it takes a particle to go from startAlpha to alpha and start the life start/life span transition.


----------------------------
“positionType”
Types: String, Function
Description (string): The way CBEffects positions particles onCreation. 
Possible Values: “inRect”, “inRadius”, “alongLine”, “atPoint”, "fromPointList"

Description (function): A function that returns X and Y values to position the particle on creation. Values must be returned separately.


----------------------------
"pointList"
Type: Table
Description: A table of {x, y} values to choose from if positionType = "fromPointList".


----------------------------
"iteratePoint"
Type: Boolean
Description: Whether to choose randomly from the point list or iterate through them if positionType = "fromPointList".


----------------------------
"curPoint"
Type: Number
Description: The point to start with if iteratePoint = true and positionType = "fromPointList".


----------------------------
“posRadius”
Type: Number
Description: The radius the particles will appear inside of for “inRadius” position type.


----------------------------
“posInner”
Type: Number
Description: The radius the particles will appear outside of for “inRadius” position type.
Note: Must be smaller than posRadius.


----------------------------
“point1” and “point2”
Types: Tables
Description: Tables containing two values, X and Y, so that if the position type is “alongLine” particles will appear along a line drawn from point1 to point2.


----------------------------
"lineDensity"
Type: Number
Description: Number of points on the line drawn from point1 to point2. Defaults to the length from point1 to point2.


----------