VS:GetSymBrightMult

From Vectorworks Developer
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Function GetSymBrightMult returns the brightness multiplier of the referenced symbol.

The brightness multiplier is used for symbols that contains lights. This value is a percentage of the symbol definition's light brightness.

FUNCTION GetSymBrightMult(
symbol :HANDLE) : INTEGER;
def vs.GetSymBrightMult(symbol):
    return INTEGER

Parameters

symbol HANDLE Handle to symbol.

Remarks

This function returns the brightness multiplier used for symbols that contains lights. This value is a percentage of the symbol definition's light brightness.

Version

Availability: from VectorWorks8.0