Check that your box contains the following assets:

• [Black Tulip] Candles - Animated Texture Edition v2
• [Black Tulip] Candles - Animated Texture Edition v2 ~CFG~
• [Black Tulip] Proof Of Purchase - Candles [AnimText.Ed] v2
• [Black Tulip] Candles - Animated Texture Edition v2 ~DOC~
• [Black Tulip] Say Color Number ~AUX TOOL~

and these sample assets, necessary to follow the step-by-step guide:

• [Black Tulip] Candles SAMPLE - Start here
• [Black Tulip] Candle Fire
• [Black Tulip] Example Menu for Candles - clickMode = 1
• [Black Tulip] Candles SAMPLE - Finished Sample

If any of these is missing, contact Auryn Beorn for a replacement. Keep in mind that sample assets are never provided in full perms state. They're included to illustrate how to use the script.

• Lights on/off the animated candle textures
• Light on/off for the light points we define
• Light menu options
• Access menu options
• It can work with AVsitter, other scripts we write, or standalone
• New clickMode variable, shows the menu when you want it to
• Light color definition: Define the light colors as you prefer

The configuration notecard has already set up a light color definition and the other variables (clickMode and button), so we're going to make this step by step guide as short and simple as possible. Let's rez the sample object [Black Tulip] Candles SAMPLE - Start here

and think in what we want to achieve from it:

• When we turn the candles on, the animated flames will light, the light points will turn on.
• When we turn the candles off, the animated flames vanish, the light points turn off.
• While it's on, we want a sound clip for candle fire noise
• We want to set up several light points so when we turn the light on/off, the light will emit from those points we've decided.
• We want that this menu shows on touch always.

This is telling us one thing: some prims are special, and they need to be recognized by the script, somehow. This somehow will be by writing things in the corresponding prim description (don't confuse it with the prim name).

First we will decide which prims will have animated flames. As it turns out with this sample, it's all of them, so we have to write something in each of the prim descriptions. So we click on Edit linked, click on the root prim, then click on the General tab, and change the description this way, to the text candleFlame;3;4;4;15;4 :

Now we repeat with all the other prims, until they all have the same description, except the last number. What the description means is something we'll explain in the advanced setup section. The last number, though, it's important that we learn what it means now: It's the face number of the face with the animated flames. The root prim had this as number 4, but the other prims may have a different number, so let's show screenshots for each one of them, with the correct number.

Now we decide which prims are the light points. The ones temporarily tinted in red on the picture.

If we want that these prims are also light points, then we add the # character as a separator in the description, and after it, we add the word light. The whole description is now candleFlame;3;4;4;15;2#light as the pictures show:

In the advanced section we'll see what candleFlame;3;4;4;15;2 means and how to obtain it.

So far, we've set up the following:

• Animated texture prims parameters
• Light sources

The rest of the parameters are set up in the notecard, to help things being simple in your first time using the script. The light colors go at the end because they're the longest part. We can write above those parameters the necessary ones to make the animated fire show and hide. In order to obtain the specific values we want, we use the auxiliary tool that we explain in the next section.

Close the edit window if it still was open, and let's continue.

The auxiliary tool helps us to obtain the values the script expects for the color we want for the light points. It's important to note that all light points will share the same light settings.

To use it, we first create a box, texture it blank so you can see the colors, and then drop the [Black Tulip] Say Color Number ~AUX TOOL~ script. The script is immediately ready to work.

When we do this, we color one of the box faces with the color we want for the light. For example, if we color the face as white, then we click on it to get the color value, we would write a line like this one in the [Black Tulip] Candles - Animated Texture Edition v2 ~CFG~ configuration notecard for this light color:

lightColor = White|<1, 1, 1>

Then we change the color, click on that face, repeat. We may have up to ten different light colors in the configuration notecard, as the one provided shows.

Once we're done with the auxiliary tool, we edit the object and simply delete it. If we're no longer using the box, we'll delete the box as well.

Drop the included [Black Tulip] Candle Fire sample sound in the candles object's contents. Then drop the [Black Tulip] Candles - Animated Texture Edition v2 ~CFG~ configuration notecard. Then change permissions for next owner of the [Black Tulip] Candles - Animated Texture Edition v2 script, and drop it in too. The script starts reading the configuration notecard. Once it's done, your candles are ready to go!

We discuss in the next section all the related notes about the advanced setup, including how to make this script work with AVsitter. Read those notes carefully.

There's a finished candles object included so you can compare with your own setup, in case you run into trouble. It's the [Black Tulip] Candles SAMPLE - Finished Sample object.

The advanced setup of this script involves the following:

• Learning how to set up the animated texture (Description Format)
• Learning the parameter clickMode of the configuration notecard, which allows us, among others, to be able to use this script with AVsitter and others (Notecard Configuration in Detail)
• Learning the button parameter of the configuration notecard (Notecard Configuration in Detail)

No problems described yet.