AvatarPaint Event-based Script

Avatar Painting Script – Event Version

The FLS_AvatarPaint_Event script lets you apply color tint and random colors to avatar materials dynamically based on triggered events initiated by a player. Here is a breakdown of its properties and features:

Debug Mode: Toggle this option to display success, error, and exception messages in the Sansar Debug Console. It will also show the version of the script you are running upon scene instance init.

Event Name: Specify the name of the event that triggers the effect

Group: Assign an event group for better organization of multiple effects.

AlterEmiss: When enabled, the emissive level value will be forced to 'Emissive Level' (defined below) on avatar's materials that are already using an Emissive Shader when the effect is applied; When false, emissive levels will stay their original levels when effect is applied

Emissive Level: Set the brightness level for the effect -- if the any of avatar's materials already use emissive-enabled shaders the emissive level will be set to this value when AlterEmiss (see above) is enabled.

Paint Color: Define the tint applied to the avatar when the event is triggered. Accepts RGBA value. RGBMode & CleansingMode must be disabled/set to false for this effect to colorize the avatar this color when the event is received, and initiated by them.

RgbMode: Enable this to apply random colors to each avatar material. This mode cannot be combined with Cleansing Mode.

Cleansing Mode: When enabled, this event will restore the avatar's materials to their original colors/tints. Cannot be used simultaneously with RGB Mode -- if both are set to true, the entire effect will become disabled

Effect Speed: Control the speed (in seconds) for the effect to fully apply (colorize, random colorize, cleansing)

Perfect for creators who want to add an interactive visual avatar enhancement to their experiences or games.

Example Use Cases:
* Turn a user into a zombie by turning them dark greens/browns/purples
* Make a user red or blue etc for team based games
* Make a user turn red to show they have died when sending them to a graveyard in an MMO type experience, restore color to original (cleanse) when they respawn

=== How to use this script ===
1) Setup another script to fire off an event that will colorize the avatar, such as an Interaction, Trigger, Sit script that fires off an event when the user does it's thing. Set that other scripts group and EventName it sends to match whatever you set them to on this script

2) Pick your mode for this effect RGBMode or CleansingMode -- if both are set to false, it is assumed you want to paint the avatar a single color (defined in PaintColor variable)

3) If you need to restore the avatar's materials at some point in your game or experience, then you will need to setup another instance of this script with a different event, and simply enable CleansingMode on it

You can uses many instances of this script for different effects as you see fit/need in your experience

NOTE: Some colorize effects cannot be achieved with altering avatar's ColorTint with this script, example: making an avatar completely greyscale or unsaturated, etc

Current Version: 0.1cc