Standard Effect Properties

Almost all effects accept the following two properties…

Enabled

Boolean Bindable Default: 1

This property controls if the effect is being applied.

Toggling the enabled property on and off can be used to control colouring, animations etc. that should only apply in certain conditions.

Note that not every function obeys this property - it is often ignored by behaviours that distort or otherwise change your model.

If you wanted a colour to only apply to your model when the 'Mode' of the motor was 'Running' (1), you could use….

<tint coloura="0,1,0,1" enabled="[Mode|1]"/>

See the Tint documentation for more details

AppliesTo

Subcomponent Default: None

This controls which part of the 3D model the effect applies to.

Without this, the effect automatically applies to the asset the script appears on. However, if you'd like a particular component of your model to be animated, you can nominate the path to it here.

For example, an agitator is effectively a 'stirrer' for a tank. There's a stationary motor and housing, then hanging from that there is a long shaft followed by a set of blades. The shaft and blades spin to stir the content of the tank.

The 3D model has the following structure…

Agitator

Shaft

If you wanted the shaft to spin, but not the motor, you could use the following XML…

<spin speed="[Speed]" appliesto="Shaft"/>  

See the Spin documentation for more details