The Gift Unpacker - adrianomesl/script_shack_support GitHub Wiki

The Gift Unpacker is a set of two unpacking scripts designed for two very specific use cases as described in this document under Rez and Unpack and Hold and Unpack.

Preparations

Since version 1.0.1, all the included boxes are shipped without scripts. Before any of these boxes can be used you need to drop the scripts inside them.

The scripts are shipped inside boxes named with the Scripts inside prefix.

  • Scripts inside - Rez Gift Box (rez to open). Contains the rezzable gift box script. Use this scrip in any of the Adrian box model.
  • Scripts inside - Mini Box (rez to open). Contains the mini box script. Use this scrip in any box that is meant to give away. This script requires the presence of the ss-hold-minibox animation. This animation is triggered on the box holder and makes them look as if they are looking inside the box.

Rez and Unpack

You want to give gifts to one or more people, so you organize a gathering at your place and lay out gift boxes for visitors to find them. Each box has a name tag indicating who is the intended recipient. People will come to your place be surprised with a gift waiting for them.

The thing to note about this scenario is that the script is NO-TRANSFERABLE, so you can NOT give the boxes away with this script. You have to rez the box at your place and let recipients come to grab the gifts.

You can use this script on any box: a prim, a simple mesh object or a mesh object with an open and a close state based on faces that show/hide.

Features

Any box having this script inside will:

  • Give all its content to one specific recipient; specified by avatar key.
  • Give a specified amount of money to the recipient as alternative or in addition to the gift.

The script is also capable of hiding/showing specific faces of an object depending on the box being open or closed. On the image below we can see an example of such an object. On the first frame we see the full model whee all the faces are visible. The second frame has the faces corresponding to the open position hidden and, finally, the third frame shows the faces corresponding to the closed position hidden.

HUD texture ready to be applied

Rez and Unpack is designed to work with this kind of objects. In the following section: Configuration, you will learn how to set up the configuration options to make this work.

Configuration

ShowWhenClosed: CSV(<integer>) - Default <empty>. A comma separated list of face numbers that should be visible when the box is in the closed state.

ShowWhenOpen: CSV(<integer>) - Default <empty>. A comma separated list of face numbers that should be visible when the box is in the open state.

GiveMoneyAmount: <integer> - Default 0. An integer number indicating the amount of Lindend Dollars to be paid to the recipient(*1).

Giving money requires debit permission to be granted to the object. If you set an amount greater than zero, you will see a debit permission grant request popup. You must grant the permission for the money to be taken from your balance and given to the recipient.

Setting the recipient

Each gift box is meant to give its content and/or pay money to one specific individual only. For this you need to specify the recipient's UUID in the box's description field, as shown in the image below.

HUD texture ready to be applied

How to obtain an avatar's UUID

Open the avatar's profile and follow the guide shown in the image below from two of the most popular viewers: Linden Lab and Firestorm. Other viewers may present this differently.

HUD texture ready to be applied

Hold and Unpack

You want to put gifts inside a box and give away the gift box itself.

The Hold and Upack gift comes with an animation that puts the wearer of the box in a pose where they are looking at the box in their hands. Touching the box will unpack the gifts it contains.

You can use this script on any box: a prim or a mesh object; just make sure the size of the object is adequate to be held on a hand.

Copy and Transfer

The Hold and Unpack script and the animation that come with it are Copy/Transfer. This means that you can create as many copies of them as you want, put them inside your own hand-held boxes and give them away; BUT: Make sure to set the permissions to Copy only when you put them inside a box These are NOT meant to be given away with transfer permission. We only provide support to Script Shack {sng} direct customers.

Caution

Script Shack {sng} is NOT granting you permission to re-sell the script nor the animation. If you do sell any of these things in any form, you are on your own. Script Shack {sng} won't provide any kind of support under this circumstance**.

What's next?

We are here to help. Use the Contact page to learn how to get support.

Was this page helpful?

If this page was not helpful enough or it's out of date; please let us know; we want to make it better!.

⚠️ **GitHub.com Fallback** ⚠️