SetFlare()

Syntax:

SetFlare( Height, Width, Transparency, Colour, Blur )

Parameters:

Height – the height in pixels of the flare. Height must be a positive integer. This parameter is optional and the default is 3.

Width – the width in pixels of the flare. Width must be a positive integer. This parameter is optional and the default is 3.

Transparency – a percentage, showing the level of transparency for the flare. Transparency must be a positive integer between 0 and 100. This parameter is optional and the default is 50.

Colour – the colour of the flare. Colour must be a positive integer indicating a valid RGB value or a variable containing a valid RGB value. This parameter is optional and the default is 0 (i.e. black).

Blur – the blur value in pixels for the flare. Blur must be an integer between 0 and 5. This parameter is optional and the default is 3.

Note:
The RGB value can be calculated using the RGB function.

Remarks:

This function allows you to create the Flare effect for a specified object. There are two methods of using this function:

(i)  Specify an object name – in this method, the Flare effect will be set on the Normal (i.e. default) Object State.

(ii) Specify a new object created with the GetAppearance function – in this method, the Flare effect is set for the Object State of the object specified in the GetAppearance function.

Note:
The Flare effect can be removed using the RemoveFlare function or in the Effects tab of the object’s Properties dialog.

image\Script_Button.jpgExamples