Prim Cleaner Tool
You are a builder and you want to clean prims from sticky prim properties?
Sticky prim properties are hover texts, sit texts, sit positions and so on, and to remove them you need to do some scripting.
Enter Prim Cleaner Tool- with PrimShell Cleaner Tool you do that very easily. It can automatically be distributed into all prims of an object and can clean the sticky prim properties via the menu.
- automatic script distribution - puts itself in all prims of an object
- cleans prim properties
- sit position
- sit text
- touch text
- texture animation
- camera settings (when sitting on object)
- hovertext
- particle systems
- remote script access pin
- integrates into the PrimShell Basic and PrimShell products (is actually included into the latter - please check it out)
You should be familiar how to edit SL objects, what root prims are and what the difference between prims and objects are.
Related products:
Bitman's PrimShell
Bitman's PrimShell Basic edition
Bitman's Permissions Checker Tool
Please also have a look at my main store for other scripts and scripted objects!
Bitman Voom
Bitman's Custom Scripting Shop, Neptune (81,220, 27)
Contents
- PrimShell Cleaner Notecard
this notecard
- PShell_Cleaner v06
the main PrimShell script
How to use
First of all, the functionality is only available when a prim contains the Cleaner Tool script. Depending on your use cases it may be necessary to put the Cleaner Tool script in all or only in some prims of an object.
To use the Prim Cleaner Tool, click on the object (resp. root prim) and the main menu will appear. When clicking on the object, the Cleaner Tool will show the prim link number and the side number on that prim that has been clicked. Note that when clicking on a prim with a script that captures the click, the Cleaner Tool will not be notified. Click the root prim in this case.
The following chapters will give an overview over the functionality.
1) Automatic script distribution
2) Cleaner tool functions
A) Integration with PrimShell
B) FAQ
...
2) Cleaner tool
The cleaner tool is a PrimShell tool script. It can be used standalone, but if used with PrimShell it registers and is accessible from the main menu via the "tools.." option.
The clean actions are available from the main menu, which appears after clicking on the object. The cleaner actions allow to clean prim properties that are set from other scripts. The following properties can be cleared:
- anim : texture animations (all sides)
- camera : sit camera offsets
- particles : particle systems
- touchtext : touch text that is displayed in the pie menu
- sittext : sit text that is displayed in the pie menu
- sit : sit target position
- hover : hover text
- pin : remote script access pin
When the action is selected, the prim link number can be selected where the properties are cleaned. Alternatively "all" can be selected to clean the properties on all prims.
Note that properties can only be cleared in prims where the cleaner shell script is in.
A) Integration with PrimShell
The cleaner tool integrates with the PrimShell scripts. The PrimShell scripts, available in my store, are a prim editing solution. You can show and manipulate the inventory of the prims in the object with it.
The cleaner tool integrates as a "PrimShell Tool", which makes it available via the PrimShell menu instead of the standalone menu.
Actually, the Cleaner Tool is already included in the full "PrimShell" product! So if you have this, you don't need the Cleaner Tool. It is, however, NOT included in the "PrimShell Basic" product.
When you drop the cleaner tool into an object with PrimShell, PrimShell asks whether to distribute the cleaner tool. This is done via a different mechanism so the re-rezzing as described above is not necessary!
Also when the PrimShell script removes itself, it also removes the cleaner tool from the object.
B) FAQ
Can PrimShell and Cleaner Tool link messages interfere with my own scripts?
- all PrimShell and Tools link messages start with "ps_", so you can distinguish them from your own messages
I put the Tool into all prims, but clicking on the object only gives my own menu
- you probably click on a prim with an own script that reacts on touch events (i.e. clicks). Then the touch event will not be sent to the root prim. To make sure the Tool menu comes up, click on the root prim. Currently there is no solution for when the root prim is not accessible except adding a "temporary" root prim or relinking the object.
