VS:GetLayerAmbientInfo

From Vectorworks Developer
Revision as of 14:32, 12 August 2013 by Root (talk | contribs) (1 revision)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Description

Procedure GetLayerAmbientInfo returns the attribute values for the ambient light object of the referenced layer.

PROCEDURE GetLayerAmbientInfo(
layer :HANDLE;
VAR isOn :BOOLEAN;
VAR brightness :INTEGER);
def vs.GetLayerAmbientInfo(layer):
    return (isOn, brightness)

Parameters

layer HANDLE Handle to layer.
isOn BOOLEAN On-off status of ambient light.
brightness INTEGER Brightness of ambient light.

Remarks

brightness is a percentage value

Version

Availability: from VectorWorks8.0