# Attributes

## Overview

allow you to read and edit the properties of Forest Pack to create sophisticated new effects.

The list below is also replicated in the Effects editor for easy access.

Read/write Forest Pack item attributes

The attributes below can be both read and edited. These important attributes represent all the aspects of a scattered item that can be controlled using Forest Effects.

Attribute | Description | Returns | Writable |
---|---|---|---|

fpItem.position | Position of Forest Item in local coordinates | Vector | Yes |

fpItem.rotation | Rotation of Forest Item in local coordinates (expressed in radians) | Vector | Yes |

fpItem.xrotaxis | Rotation of Forest Item expressed as a system of 3 vectors (X component) | Vector | Yes |

fpItem.xrotaxis | Rotation of Forest Item expressed as a system of 3 vectors (Y component) | Vector | Yes |

fpItem.xrotaxis | Rotation of Forest Item expressed as a system of 3 vectors (Z component) | Vector | Yes |

fpItem.scale | Scale of Forest Item in local coordinates | Vector | Yes |

fpItem.visible | Set this to zero to hide the item from distribution | Integer | Yes |

fpItem.geomID | Index in the Geometry List, starting at zero | Integer | Yes |

fpItem,tintColor | Tint color (R,G,B) | Vector | Yes |

fpItem.tintMulti | Tint Multiplier (0.0 to 1.0) | Float | Yes |

fpItem.animSample | Animation Sample index (zero based) | Integer | Yes |

fpItem.surfDirection | Direction on Surface (-100 to 100) | Integer | Yes |

fpItem.randTransMin | Random translation minimum range (X,Y,Z) | Vector | Yes |

fpItem.randTransMax | Random translation maximum range (X,Y,Z) | Vector | Yes |

fpItem.randRotMin | Random rotation minimum range (X,Y,Z) | Vector | Yes |

fpItem.randRotMax | Random rotation maximum range (X,Y,Z) | Vector | Yes |

fpItem.randScaleMin | Random scale minimum range (X,Y,Z) | Vector | Yes |

fpItem.randScaleMax | Random scale maximum range (X,Y,Z) | Vector | Yes |

### Read-only Forest Pack item attributes

The attributes below are read only and cannot be edited using Forest Effects. You can however use them to create expressions that manipulate the values of attributes detailed in the list shown above.

Attribute | Description | Returns | Writable |
---|---|---|---|

fpItem.geomColor | Color ID in the Geometry List (R,G,B) | Vector | No |

fpItem.userID | Generic value which can be assigned from Tree Editor | Integer | No |

fpItem.geomProbability | Probability value in the Geometry List | Float | No |

fpItem.distXPixel | X pixel index in the Distribution Map (Generate mode only) | Float | No |

fpItem.distYPixel | Y pixel index in the Distribution Map (Generate mode only) | Float | No |

fpItem.distXTile | X Tile index in the Distribution Map (Generate mode only) | Float | No |

fpItem.distXTile | Y Tile index in the Distribution Map (Generate mode only) | Float | No |

fpItem.distUVW | UVW Coordinates for Distribution Map (using Surfaces only) | Vector | No |

fpItem.distPathPos | Normalized position of item on path (Distribution by Path only) | Real | No |

fpItem.distPathTangent | Tangent vector of path on item position (Distribution by Path only) | Real | No |

fpItem.collisionRadius | Radius of the virtual sphere used for Collisions checking | Float | No |

fpItem.collisionHeight | Height of the virtual sphere used for Collisions checking | Float | No |

fpItem.mirror | 1 if item is mirrored, 0 if not | Integer | No |

fpItem,animOffset | Animation Offset (in ticks, 4800 ticks per second) | Integer | No |

fpItem.animNumSamples | Number of animation samples (as defined in Animation rollout) | Integer | No |

fpItem.surfNormal | Normal to Surface | Vector | No |

fpItem.surfSlope | Slope angle on Surface | Real | No |

fpItem.areaIncDistance | Distance to nearest include area | Real | No |

fpItem.areaIncNearest | Position of the nearest point of include areas (splines only) | Vector | No |

fpItem.areaExcDistance | Distance to nearest exclude area | Real | No |

fpItem.areaExcNearest | Position of the nearest point of exclude areas (splines only) | Vector | No |

fpItem.areaFalloffScale | Scale factor applied to the item due to Areas->Falloff | Vector | No |

fpItem.particleAge | Particle Age in ticks (only for For Particle Flow distributions | Integer | No |

fpItem.particleRotation | Particle rotation defined by incremental rotations in world axes XYZ (in radians) | Vector | No |

fpItem.particleScale | Particle scale (only for Particle Flow distributions) | Vector | No |

fpItem.particleSpeed | Particle Speed (only for Particle Flow distributions) | Vector | No |

fpItem.particleEventID | Numeric ID generated from the Event's name in a PFlow distribution (i.e. 'PF Source 01->Event 02' get ID = 2) | Integer | No |

### Read-only Max attributes

The list below details the attributes of Max that have been exposed if Forest Effects.

Attribute | Description | Returns | Writable |
---|---|---|---|

max.time | Current animation time (in ticks, 4800 ticks per second) | Integer | No |